Endpoints para Pedido

Esta API ofrece endpoints para obtener, agregar, modificar o eliminar información relacionada con la entidad Pedido. Esta tiene información sobre el cliente, el representante, el producto y su temporada correspondiente.

Características Comunes de los Pedidos

Identificador único: La entidad Pedido consta de un identificador único que sirve para distinguirlo de los demás pedidos y referenciarla con facilidad. Además cuenta con un campo idRemote, que hace referencia al id que puede estar almacenado en la base de datos del ERP del cliente.
Datos del pedido: Típicamente, un pedido tiene información asociada como compañía, cliente, temporada, descuento, lineas y otros detalles.
Compañía: Es necesario almacenar información básica sobre la compañía que recibe el pedido.
Cliente: Debe haber un cliente asociado con cada pedido. El cliente es un socio comercial con el rol de Client.
Agente: Además, un peiddo debe tener un agente asociado. Este es el representante de la empresa que ha realizado la venta. Un agente es un socio comercial con el rol de Representant.
Temporada: Se almacena información sobre la temporada en la que se ha hecho el pedido.
Descuento: La entidad Pedido guarda información sobre los descuentos que se le aplican.
Líneas: Cada línea del pedido se corresponde al producto o servicio solicitado. Las líneas almacenan información sobre la cantidad y precio de cada producto o servicio entregado. Las líneas tienen un estado en el que se especifica si está en stock, si está enviado o no, o si ha sido eliminado.

Importancia en la API

Nuestra API proporciona endpoints específicos para gestionar y manipular pedidos dentro del sistema. Estos endpoints permiten operaciones como la creación, actualización, recuperación y eliminación de información de pedidos de manera estructurada y segura.

Endpoints

GET/Order/getOrder

Recuperar una lista paginada con los pedidos existentes en la base de datos.

Descripción

Permite obtener una lista con los pedidos organizada según los parámetros de paginación. Además incluye información como la compañía, el cliente, el representante, la temporada, el descuento correspondiente y detalles adicionales.

Parámetros

Nombre	Descripción	Tipo	Valor por defecto
`page`	Número de página	Integer	1
`pageSize`	Elementos por página	Integer	10

Respuestas

JSON

{
  "data": [
    {
      "id": "string",
      "idRemote": "string",
      "company": {
        "id": "string",
        "idRemote": "string",
        "companyName": "string"
      },
      "client": {
        "id": "string",
        "idRemote": "string",
        "contactName": "string"
      },
      "agent": "string",
      "status": "string",
      "season": {
        "id": "string",
        "idRemote": "string",
        "description": "string"
      },
      "shippingAddress": "string",
      "billingAddress": "string",
      "discount": [
        {
          "id": "string",
          "idRemote": "string",
          "discountType": {
            "id": "string",
            "name": "string",
            "code": "string",
            "description": "string"
          },
          "sequence": 0,
          "discount": 0,
          "amountDiscount": 0,
          "isLine": true,
          "isHeader": true
        }
      ],
      "lines": [
        {
          "id": "string",
          "idRemote": "string",
          "lineStatus": "string",
          "discount": [
            {
              "idRemote": "string",
              "discount": 0,
              "amountDiscount": 0
            }
          ],
          "observations": "string",
          "deliveryDate": "string",
          "lineAmount": 0,
          "quantity": 0,
          "quantityServed": 0,
          "quantityFromStock": 0,
          "lineDetail": [
            {
              "id": "string",
              "idRemote": "string",
              "productId": "string",
              "quantity": 0,
              "price": 0,
              "retailPrice": 0
            }
          ]
        }
      ],
      "dateOrder": "string",
      "dateModified": "string",
      "dateDelivery": "string",
      "observation": "string",
      "grossAmount": 0,
      "baseAmount": 0,
      "shippingAmount": 0,
      "taxAmount": 0,
      "taxrecAmount": 0,
      "totalAmount": 0,
      "totalQuantity": 0,
      "quantityServed": 0,
      "quantityPending": 0,
      "shipper": "string",
      "origin": "string",
      "isSale": true,
      "active": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "totalItems": 0,
    "itemsPerPage": 0,
    "currentPage": 0,
    "totalPages": 0,
    "nextPageUrl": "string"
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <idRemote>string</idRemote>
      <company>
        <id>string</id>
        <idRemote>string</idRemote>
        <companyName>string</companyName>
      </company>
      <client>
        <id>string</id>
        <idRemote>string</idRemote>
        <contactName>string</contactName>
      </client>
      <agent>string</agent>
      <status>string</status>
      <season>
        <id>string</id>
        <idRemote>string</idRemote>
        <description>string</description>
      </season>
      <shippingAddress>string</shippingAddress>
      <billingAddress>string</billingAddress>
      <discount>
        <id>string</id>
        <idRemote>string</idRemote>
        <discountType>
          <id>string</id>
          <name>string</name>
          <code>string</code>
          <description>string</description>
        </discountType>
        <sequence>0</sequence>
        <discount>0</discount>
        <amountDiscount>0</amountDiscount>
        <isLine>true</isLine>
        <isHeader>true</isHeader>
      </discount>
      <lines>
        <id>string</id>
        <idRemote>string</idRemote>
        <lineStatus>string</lineStatus>
        <discount>
          <idRemote>string</idRemote>
          <discount>0</discount>
          <amountDiscount>0</amountDiscount>
        </discount>
        <observations>string</observations>
        <deliveryDate>string</deliveryDate>
        <lineAmount>0</lineAmount>
        <quantity>0</quantity>
        <quantityServed>0</quantityServed>
        <quantityFromStock>0</quantityFromStock>
        <lineDetail>
          <id>string</id>
          <idRemote>string</idRemote>
          <product>string</product>
          <quantity>0</quantity>
          <price>0</price>
          <retailPrice>0</retailPrice>
        </lineDetail>
      </lines>
      <dateOrder>string</dateOrder>
      <dateModified>string</dateModified>
      <dateDelivery>string</dateDelivery>
      <observation>string</observation>
      <grossAmount>0</grossAmount>
      <baseAmount>0</baseAmount>
      <shippingAmount>0</shippingAmount>
      <taxAmount>0</taxAmount>
      <taxrecAmount>0</taxrecAmount>
      <totalAmount>0</totalAmount>
      <totalQuantity>0</totalQuantity>
      <quantityServed>0</quantityServed>
      <quantityPending>0</quantityPending>
      <shipper>string</shipper>
      <origin>string</origin>
      <isSale>true</isSale>
      <active>true</active>
      <createdAt>string</createdAt>
      <updatedAt>string</updatedAt>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>  

👉Prueba este endpoint🌱

GET/Order/getOrder/Status

Recupera una lista paginada con los identificadores y descripción de los estados disponibles para los pedidos.

Descripción

Se muestran de manera paginada los identificadores local y remoto junto con la descripción del estado. Se puede modificar la paginación a través de estos parámetros:

Parámetros

Nombre	Descripción	Tipo	Valor por defecto
`page`	Número de página	Integer	1
`pageSize`	Elementos por página	Integer	10

Respuestas

JSON

  {
  "data": [
      {
      "id": "string",
      "idRemote": "string",
      "description": true
      }
  ],
  "pagination": {
      "totalItems": 0,
      "itemsPerPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "nextPageUrl": "string"
  }
  }

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <idRemote>string</idRemote>
      <description>true</description>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>

👉Prueba este endpoint🌱

GET/Order/getOrder/Line/Status

Recupera una lista paginada con los identificadores y descripción de los estados disponibles para las líneas de los pedidos.

Descripción

Se muestran de manera paginada los identificadores local y remoto junto con la descripción del estado. Se puede modificar la paginación a través de estos parámetros:

Parámetros

Nombre	Descripción	Tipo	Valor por defecto
`page`	Número de página	Integer	1
`pageSize`	Elementos por página	Integer	10

Respuestas

JSON

  {
  "data": [
      {
      "id": "string",
      "idRemote": "string",
      "description": true
      }
  ],
  "pagination": {
      "totalItems": 0,
      "itemsPerPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "nextPageUrl": "string"
  }
  }

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <idRemote>string</idRemote>
      <description>true</description>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>

👉Prueba este endpoint🌱

GET/Order/updatedFrom

Recuperar una lista paginada con los pedidos existentes desde la fecha especificada en los parámetros.

Descripción

Permite obtener una lista con los pedidos existentes a partir de la fecha especificada. En caso de no existir ningún pedido, se devuelve una lista vacía.

Parámetros

Nombre	Descripción	Tipo	Valor por defecto
`date`	Última modificación	String	1999-01-01 01:00:00
`page`	Número de página	Integer	1
`pageSize`	Elementos por página	Integer	10

Respuestas

JSON

{
  "data": [
    {
      "id": "string",
      "idRemote": "string",
      "company": {
        "id": "string",
        "idRemote": "string",
        "companyName": "string"
      },
      "client": {
        "id": "string",
        "idRemote": "string",
        "contactName": "string"
      },
      "agent": "string",
      "status": "string",
      "season": {
        "id": "string",
        "idRemote": "string",
        "description": "string"
      },
      "shippingAddress": "string",
      "billingAddress": "string",
      "discount": [
        {
          "id": "string",
          "idRemote": "string",
          "discountType": {
            "id": "string",
            "name": "string",
            "code": "string",
            "description": "string"
          },
          "sequence": 0,
          "discount": 0,
          "amountDiscount": 0,
          "isLine": true,
          "isHeader": true
        }
      ],
      "lines": [
        {
          "id": "string",
          "idRemote": "string",
          "lineStatus": "string",
          "discount": [
            {
              "idRemote": "string",
              "discount": 0,
              "amountDiscount": 0
            }
          ],
          "observations": "string",
          "deliveryDate": "string",
          "lineAmount": 0,
          "quantity": 0,
          "quantityServed": 0,
          "quantityFromStock": 0,
          "lineDetail": [
            {
              "id": "string",
              "idRemote": "string",
              "productId": "string",
              "quantity": 0,
              "price": 0,
              "retailPrice": 0
            }
          ]
        }
      ],
      "dateOrder": "string",
      "dateModified": "string",
      "dateDelivery": "string",
      "observation": "string",
      "grossAmount": 0,
      "baseAmount": 0,
      "shippingAmount": 0,
      "taxAmount": 0,
      "taxrecAmount": 0,
      "totalAmount": 0,
      "totalQuantity": 0,
      "quantityServed": 0,
      "quantityPending": 0,
      "shipper": "string",
      "origin": "string",
      "isSale": true,
      "active": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "totalItems": 0,
    "itemsPerPage": 0,
    "currentPage": 0,
    "totalPages": 0,
    "nextPageUrl": "string"
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <idRemote>string</idRemote>
      <company>
        <id>string</id>
        <idRemote>string</idRemote>
        <companyName>string</companyName>
      </company>
      <client>
        <id>string</id>
        <idRemote>string</idRemote>
        <contactName>string</contactName>
      </client>
      <agent>string</agent>
      <status>string</status>
      <season>
        <id>string</id>
        <idRemote>string</idRemote>
        <description>string</description>
      </season>
      <shippingAddress>string</shippingAddress>
      <billingAddress>string</billingAddress>
      <discount>
        <id>string</id>
        <idRemote>string</idRemote>
        <discountType>
          <id>string</id>
          <name>string</name>
          <code>string</code>
          <description>string</description>
        </discountType>
        <sequence>0</sequence>
        <discount>0</discount>
        <amountDiscount>0</amountDiscount>
        <isLine>true</isLine>
        <isHeader>true</isHeader>
      </discount>
      <lines>
        <id>string</id>
        <idRemote>string</idRemote>
        <lineStatus>string</lineStatus>
        <discount>
          <idRemote>string</idRemote>
          <discount>0</discount>
          <amountDiscount>0</amountDiscount>
        </discount>
        <observations>string</observations>
        <deliveryDate>string</deliveryDate>
        <lineAmount>0</lineAmount>
        <quantity>0</quantity>
        <quantityServed>0</quantityServed>
        <quantityFromStock>0</quantityFromStock>
        <lineDetail>
          <id>string</id>
          <idRemote>string</idRemote>
          <product>string</product>
          <quantity>0</quantity>
          <price>0</price>
          <retailPrice>0</retailPrice>
        </lineDetail>
      </lines>
      <dateOrder>string</dateOrder>
      <dateModified>string</dateModified>
      <dateDelivery>string</dateDelivery>
      <observation>string</observation>
      <grossAmount>0</grossAmount>
      <baseAmount>0</baseAmount>
      <shippingAmount>0</shippingAmount>
      <taxAmount>0</taxAmount>
      <taxrecAmount>0</taxrecAmount>
      <totalAmount>0</totalAmount>
      <totalQuantity>0</totalQuantity>
      <quantityServed>0</quantityServed>
      <quantityPending>0</quantityPending>
      <shipper>string</shipper>
      <origin>string</origin>
      <isSale>true</isSale>
      <active>true</active>
      <createdAt>string</createdAt>
      <updatedAt>string</updatedAt>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>  

👉Prueba este endpoint🌱

POST/Order/create

Registro de Pedidos en la API: Uso del Método POST

Actualmente, nuestro método POST en la API está diseñado para manejar exclusivamente el formato JSON. Para registrar pedidos de manera efectiva, es crucial seguir un proceso que garantice la integridad de los datos y la funcionalidad adecuada del sistema.

Proceso de Registro:

Creación de Compañía: Antes de registrar un pedido, es necesario asegurarse de que exista una Compañía asociada. Esto es importante ya que los usuarios pueden tener varias compañías. 👉Registrar Compañía🌱
Creación de Cliente: Es necesario asegurarse de que exista un Cliente asociado y que tiene el rol Client. Además, este cliente debe pertenecer a la misma compañía que realiza el pedido. En caso de adjuntar un cliente erróneo, la respuesta devolverá un error. 👉Registrar Cliente🌱
Creación de Agente: Es crucial que se asegure de que el Socio Comercial que va a asignar al pedido en el parámetro agentId tiene el rol Representant y pertenece a la misma Compañía que el que realiza el pedido. En caso de adjuntar un agente erróneo, la respuesta devolverá un error.
👉Crear un Representante🌱
Creación de Temporada: Antes de registrar un pedido, es necesario asegurarse de que el B2B se utilice para moda, este caso se crea una entidad Temporada. Si no se utiliza para moda no es necesario tener la Temporada. 👉Registrar Temporada🌱
Direcciones de envío y facturación Para poder registrar un nuevo pedido en el sistema debe introducir tanto la dirección de envío como de facturación correspondientes. Estas direcciones deben estar registradas como direcciones para el Socio Comercial cliente ordenante del pedido. Estas direcciones deben constar en el sistema con el rol adecuado. Por ejemplo, para la dirección de envío, debe ser una Localización con el campo shippingAddress configurado como true. Puede configurar las localizaciones en el momento de creación de un nuevo Socio Comercial o a través de los endpoints de Localizaciones. 👉 Creación de nuevo Socio Comercial 🌱 👉 Endpoints para Localizaciones 🌱
Estado del Pedido: La referencia al Estado del pedido debe existir en el sistema. Para ver los estados disponibles para los Pedidos puede utilizar el endpoint descrito al principio de esta documentación.
Descuentos: Los descuentos no son un parámetro obligatorio. Para introducir en el sistema un pedido sin descuentos, basta con adjuntar un array vacío. Puede establecer un id para cada descuento. Este id se corresponden con el id remoto que quiera darle usted. El sistema creará automáticamente un id local para cada nuevo descuento que cree de esta forma.
Líneas: Un pedido está formada por líneas. Cada linea incluye información sobre el producto o servicio que se envía al cliente. Por esto, el Producto asociado con cada línea a través del parámetro productId debe existir en el sistema. Además cada línea se relaciona con un Estado (lineStatusId). A través de la creación de líneas puede asignar un id a cada una, el cual se corresponde con el idRemote. El sistema creará un id local automáticamente. De la misma manera, se pueden asociar descuentos con cada línea del Producto. El proceso de creación de descuentos para cada línea es similar al proceso anterior de creación de descuentos para un pedido.

Parámetros obligatorios:

Nombre	Descripción	Tipo
`idRemote`	Identificador del nuevo Pedido	String
`reference`	Referencia del nuevo Pedido	String
`companyId`	Identificador de la Compañía a la que pertenece el nuevo Pedido.	String
`clientId`	Identificador del Socio Comercial con rol cliente al que va dirigido el nuevo Pedido	String
`agentId`	Identificador del Socio Comercial con rol agente que ha realizado el nuevo Pedido	String
`statusId`	Identificador del estado del Pedido	String
`dateOrder`	Fecha en la que se ha creado el nuevo Pedido	String
`grossAmount`	Importe bruto del nuevo Pedido	Decimal
`baseAmount`	Importe base del nuevo Pedido	Decimal
`shippingAmount`	Importe de los gastos de envío del nuevo Pedido	Decimal
`taxAmount`	Importe de los impuestos del nuevo Pedido	Decimal
`totalAmount`	Importe total del nuevo Pedido	Decimal
`totalQuantity`	Cantidad total de productos en el nuevo Pedido	Decimal
`quantityServed`	Cantidad entregada del nuevo Pedido	Decimal
`quantityPending`	Cantidad pendiente de entrega en el nuevo Pedido	Decimal
`shippingAddressId`	Identificador de la Localización para envío del nuevo Pedido	String
`billingAddressId`	Identificador de la Localización para facturación del nuevo Pedido	String

Si quieres añadir Descuentos al Pedido debes tener en cuenta que todos los parámetros son obligatorios.

Parámetros obligatorios para Líneas:

Si vas a añadir un Pedido con Líneas, debes tener en cuenta que los siguientes parámetros son obligatorios:

Nombre	Descripción	Tipo
`idRemote`	Identificador para la Línea del Pedido	String
`lineStatusId`	Identificador del Estado de la Línea del Pedido	String
`lineDetail`	Lista de con los Detalles de la Línea	Array

Parámetros obligatorios para Detalle de Línea:

Dentro del Detalle de la línea, los siguientes parámetros son obligatorios:

Nombre	Descripción	Tipo
`idRemote`	Identificador para el Detalle de Línea del Pedido	String
`productId`	Id del Producto objeto de venta del Pedido	String

Cuerpo completo de la solicitud:

[
  {
    "idRemote": "string",
    "companyId": "string",
    "clientId": "string",
    "agentId": "string",
    "statusId": "string",
    "seasonId": "string",
    "shippingAddressId": "string",
    "billingAddressId": "string",
    "discount": [
      {
        "idRemote": "string",
        "discountTypeId": "string",
        "sequence": 0,
        "discount": 0,
        "amountDiscount": 0,
        "isHeader": true
      }
    ],
    "lines": [
      {
        "idRemote": "string",
        "lineStatusId": "string",
        "discount": [
          {
            "idRemote": "string",
            "discount": 0,
            "amountDiscount": 0
          }
        ],
        "observations": "string",
        "deliveryDate": "string",
        "lineAmount": 0,
        "quantity": 0,
        "quantityServed": 0,
        "quantityFromStock": 0,
        "lineDetail": [
          {
            "idRemote": "string",
            "productId": "string",
            "quantity": 0,
            "price": 0,
            "retailPrice": 0
          }
        ]
      }
    ],
    "dateOrder": "string",
    "dateModified": "string",
    "dateDelivery": "string",
    "observation": "string",
    "grossAmount": 0,
    "baseAmount": 0,
    "shippingAmount": 0,
    "taxAmount": 0,
    "taxrecAmount": 0,
    "totalAmount": 0,
    "totalQuantity": 0,
    "quantityServed": 0,
    "quantityPending": 0,
    "shipper": "string",
    "isSale": true
  }
]

Es posible añadir varios Pedidos a través de la misma solicitud separándolos con comas dentro del array en el cuerpo de la solicitud.

Respuestas

Para evitar sobrecargar el servidor, este endpoint envía un mensaje a un consumidor encargado de procesar la petición. Se puede verificar el estado de la solicitud enviada a través de la url adjunta en la respuesta. Una respuesta correctamente enviada al consumidor debe parecerse a esta:

{
    "code": 201,
    "message": "Order message created successfully and dispatched to the queue.",
    "statusUrl": "http://host/api/database/v1/message/status/66bf382938941"
}  

El campo statusUrl nos redirige a una respuesta más detallada sobre el estado de la petición. Una solicitud correctamente procesada por el consumidor tiene el siguiente aspecto:

{
  "data": [
      {
        "status": "completed",
        "errorMessage": null
      }
  ],
  "pagination": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "currentPage": 1,
      "totalPages": 1,
      "nextPageUrl": null
  }
}

En caso de producirse cualquier error durante el procesado del mensaje, la respuesta tendrá un aspecto similar a este:

{
  "code": 400,
  "error": "Invalid order data format, a required parameter is missing"
}

👉Prueba este endpoint🌱

PUT/Order/update/{id}

Actualización de un pedido existente.

Descripción

Este endpoint permite a los clientes actualizar los datos de un pedido existente en la base de datos utilizando el parámetro id de un Pedido existente en el sistema. A través de este endpoint puede actualizar datos del Pedido, o de sus Líneas y Descuentos. Así mismo, este endpoint permite añadir nuevas líneas o descuentos a un Pedido existente.

Si deseas actualizar un Descuento o línea ya existente en el Pedido objeto de actualización, simplemente adjunta su identificador en el atributo idRemote en el cuerpo de la solicitud. El sistema creará un nuevo Descuento o Línea si no encuentra este atributo en el cuerpo de la solicitud.

Parámetros

Nombre	Descripción	Tipo
`id`	Identificador del pedido	String

No es necesario incluir toda la estructura JSON, solo debes incluir los atributos que quieras modificar.

Cuerpo de la petición

El cuerpo de la solicitud para actualizar todos los atributos de un Pedido debe parecerse a esto:

{
  "companyId": "string",
  "clientId": "string",
  "agentId": "string",
  "statusId": "string",
  "seasonId": "string",
  "shippingAddressId": "string",
  "billingAddressId": "string",
  "discount": [
    {
      "idRemote": "string",
      "discountTypeId": "string",
      "sequence": 0,
      "discount": 0,
      "amountDiscount": 0,
      "isHeader": true
    }
  ],
  "lines": [
    {
      "idRemote": "string",
      "lineStatusId": "string",
      "discount": [
        {
          "idRemote": "string",
          "discount": 0,
          "amountDiscount": 0
        }
      ],
      "observations": "string",
      "deliveryDate": "string",
      "lineAmount": 0,
      "quantity": 0,
      "quantityServed": 0,
      "quantityFromStock": 0,
      "lineDetail": [
        {
          "idRemote": "string",
          "productId": "string",
          "quantity": 0,
          "price": 0,
          "retailPrice": 0
        }
      ]
    }
  ],
  "dateOrder": "string",
  "dateModified": "string",
  "dateDelivery": "string",
  "observation": "string",
  "grossAmount": 0,
  "baseAmount": 0,
  "shippingAmount": 0,
  "taxAmount": 0,
  "taxrecAmount": 0,
  "totalAmount": 0,
  "totalQuantity": 0,
  "quantityServed": 0,
  "quantityPending": 0,
  "shipper": "string",
  "isSale": true
}

👉Prueba este endpoint🌱

DELETEOrder/delete/{id}

Eliminar un pedido.

Descripción

El método DELETE elimina un pedido de la base de datos a través del identificador facilitado en los parámetros. Este campo id puede ser tanto el identificador generado por la base de datos del B2B como el idRemote que usted nos proporciona al registrar los pedidos. Al eliminar un Pedido también se eliminan todas las líneas y descuentos asociadas. Una vez eliminado, el Pedido se registra en el Historial de Eliminados.

⚠️No se podrá eliminar un Pedido que tenga líneas asociadas con un Albarán.

Parámetros

Nombre	Descripción	Tipo
`id`	Identificador del pedido	String

👉Prueba este endpoint🌱

Posibles errores en la respuesta

Error	Código	Respuesta
Este error ocurre cuando no se puede establecer una conexión con la base de datos. Es un problema interno del servidor.	500	`{"code": 500,"error": "Database connection failed."}`
Este error ocurre cuando no puede insertar o actualizar y en la dbs de pruebas.	500	`{"code": 500,"error": "Invalid connection name, you cannot insert in default"}`
Este error indica que falta un parametro.	400	`{"code": 400,"error": "Parameter $parameter is required"}`
Este error indica que no está autorizado.	401	`{"code": 401,"error": "Unauthorized."}`
Este error indica que no ha sido posible encontrar el registro.	404	`{"code": 404,"error": "No entity found for Order with $id."}`
Este error ocurre cuando intenta insertar un registro que ya existe	409	`{"code": 409,"error": "Duplicate entry"}`
Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	`{"code": 429,"error": "Too Many Requests"}`

Endpoints para Pedido

Características Comunes de los Pedidos​

Importancia en la API​

Endpoints​

GET/Order/getOrder​

Descripción​

Parámetros​

Respuestas​

JSON​

XML​

GET/Order/getOrder/Status​

Descripción​

Parámetros​

Respuestas​

JSON​

XML​

GET/Order/getOrder/Line/Status​

Descripción​

Parámetros​

Respuestas​

JSON​

XML​

GET/Order/updatedFrom​

Descripción​

Parámetros​

Respuestas​

JSON​

XML​

POST/Order/create​

Registro de Pedidos en la API: Uso del Método POST​

Proceso de Registro:​

Parámetros obligatorios:​

Parámetros obligatorios para Líneas:​

Parámetros obligatorios para Detalle de Línea:​

Cuerpo completo de la solicitud:​

Respuestas​

PUT/Order/update/{id}​

Descripción​

Parámetros​

Cuerpo de la petición​

DELETEOrder/delete/{id}​

Descripción​

Parámetros​

Posibles errores en la respuesta​

Características Comunes de los Pedidos

Importancia en la API

Endpoints

GET/Order/getOrder

Descripción

Parámetros

Respuestas

JSON

XML

GET/Order/getOrder/Status

Descripción

Parámetros

Respuestas

JSON

XML

GET/Order/getOrder/Line/Status

Descripción

Parámetros

Respuestas

JSON

XML

GET/Order/updatedFrom

Descripción

Parámetros

Respuestas

JSON

XML

POST/Order/create

Registro de Pedidos en la API: Uso del Método POST

Proceso de Registro:

Parámetros obligatorios:

Parámetros obligatorios para Líneas:

Parámetros obligatorios para Detalle de Línea:

Cuerpo completo de la solicitud:

Respuestas

PUT/Order/update/{id}

Descripción

Parámetros

Cuerpo de la petición

DELETEOrder/delete/{id}

Descripción

Parámetros

Posibles errores en la respuesta