CreateOrderGroup

Creación de pedido

CreateOrderGroupOperation

Este endpoint permite crear pedidos a partir de códigos de referencia (ReferenceCode) de productos, dirección de entrega, sucursal, unidad de negocio, entre otros.

¡Código copiado al portapapeles!
📦 Request
📝 Response
📋 Códigos de error
Campos del payload de solicitud (Request)
Field Data Type Required Description
Identification string Sí Documento de identificación del cliente o comprador.
CustomerAddressReferenceCode string Sí Código de referencia de la dirección de entrega del cliente.
BranchOfficeReferenceCode string Sí Código de referencia, o nombre, de la sucursal o bodega desde la cual se atenderá el pedido.
BusinessUnitReferenceCode string Sí Código de referencia de la unidad de negocio.
BusinessModel string Sí Modelo de negocio del pedido: "B2B" o "B2C".
Notes string No Notas/observaciones del pedido (ej. instrucciones de entrega).
ItemCollection[].ProductReferenceCode string Sí Código de referencia del producto solicitado.
ItemCollection[].Quantity int Sí Cantidad solicitada del producto. El valor mínimo es 1.

Ejemplo de solicitud (Request)

{
"Data": {
"Token": {
"Id": "TokenAsignado"
},
"Operation": {
"Name": "CreateOrderGroupOperation",
"GroupName": "Trade",
"Version": "2.0",
"Payload": "{\"Identification\":\"10456789012\",\"CustomerAddressReferenceCode\":\"ADDR-LIM-00456\",\"BranchOfficeReferenceCode\":\"BOF-PE-LIMA-01\",\"BusinessUnitReferenceCode\":\"BU-PERU-001\",\"BusinessModel\":\"B2B\",\"Notes\":\"Entregar en la portería del edificio\",\"ItemCollection\":[{\"ProductReferenceCode\":\"PROD-000789\",\"Quantity\":3},{\"ProductReferenceCode\":\"PROD-000912\",\"Quantity\":1}]}"
}
}
}
Parámetros por defecto: Solo se soportará el método de pago "Contra entrega (Efectivo)" y el horario de entrega por defecto que se tenga en plataforma, por ejemplo, "Al día siguiente.".

Respuesta exitosa

{
"Successful": true,
"Message": null,
"UserMessage": null,
"ErrorCode": "",
"ExceptionMessage": null,
"Entity": {
"Code": 1058493,
"Id": "9f8e7d6c-5b4a-3c2d-1e0f-abcdef123456",
"OrderStatus": "PaymentInProgress",
"PaymentTransactionMessage": null
}
}

Respuesta de error: producto no encontrado

{
"Successful": false,
"UserMessage": "No fue posible encontrar el producto con código de referencia 'PROD-000912'",
"ErrorCode": "PRODUCT_REFERENCE_NOT_FOUND",
"Entity": null
}
Códigos de error posibles
Código de error Motivo
CUSTOMER_NOT_FOUND Identification no corresponde a ningún cliente o usuario registrado.
CUSTOMER_ADDRESS_NOT_FOUND CustomerAddressReferenceCode no corresponde a ninguna dirección registrada para el cliente.
BRANCH_OFFICE_NOT_FOUND BranchOfficeReferenceCode no corresponde a ninguna sucursal o bodega válida.
BUSINESS_UNIT_NOT_FOUND BusinessUnitReferenceCode no corresponde a ninguna unidad de negocio válida.
NO_ITEMS_PROVIDED No se envió ningún producto en ItemCollection.
PRODUCT_REFERENCE_NOT_FOUND Algún ProductReferenceCode de ItemCollection no fue encontrado para la sucursal o unidad de negocio indicada.