Registrar Pedido

Registra un nuevo pedido en el formato nativo EMSD.

Authorization

ClientId IntegrationAuth
X-Client-Id<token>

Identificador del cliente integrado, proporcionado por Dinet.

In: header

X-Integration-Auth<token>

Token de integración, proporcionado por Dinet.

In: header

Request Body

application/json

order_numberstring
Requerido

Número de pedido (debe ser único)

Length1 <= length <= 60
Example"ORD-2024-001"
modality_codestring
Requerido

Código de la modalidad

Length1 <= length <= 10
Example"STD"
brand_codestring
Opcional

Código de la marca

Length1 <= length <= 30
Example"B001"
recipient
Requerido

Información del destinatario

origin
Requerido

Información del origen. Identificación del punto de origen — debe enviar uno de estos modos (excluyentes):

  1. point_code — código del local de origen (si se envía, los demás campos de ubicación son ignorados).
  2. ubigeo — código INEI del distrito.
  3. region + province + city — jerarquía completa (los tres campos juntos; jerarquía parcial es inválida).

Si envía ubigeo no envíe la jerarquía, y viceversa.

destination
Requerido

Información del destino. Identificación del punto de destino — debe enviar uno de estos modos (excluyentes):

  1. point_code — código del local de destino (si se envía, los demás campos de ubicación son ignorados).
  2. ubigeo — código INEI del distrito.
  3. region + province + city — jerarquía completa (los tres campos juntos; jerarquía parcial es inválida).

Si envía ubigeo no envíe la jerarquía, y viceversa.

order_document_referencestring
Opcional

Número de documento de referencia

Length1 <= length <= 60
Example"REF-001"
order_source_codestring
Opcional

Código del canal de venta

Length1 <= length <= 20
Example"WEB"
custom_tracking_idstring
Opcional

Número de seguimiento personalizado. Si no se envía, se generará uno automáticamente.

Length1 <= length <= 60
Example"TRACK-001"
order_quantity_packagesinteger
Opcional

Cantidad de paquetes del pedido. Su comportamiento depende de la configuración de la cuenta integrada:

  • Si la cuenta genera sus propios LPNs: debe coincidir exactamente con la cantidad de packages[] que tengan lpn definido.
  • Si DINET genera los LPNs: es obligatorio (define cuántos LPNs emitirá DINET); si además se envía packages[] con datos específicos sin lpn, la cantidad debe coincidir con este valor.
Formatint32
Range1 <= value <= 20
Example2
order_pricenumber
Opcional

Valor declarado del pedido. Opcional, y puede enviarse sin order_currency_code.

Formatdouble
Range0 <= value
Example250
order_currency_codestring
Opcional

Código de moneda del pedido (ISO 4217, 3 letras, case-insensitive). Opcional. Solo puede enviarse junto con order_price: una moneda sin un monto al que acompañar se rechaza.

Match^[A-Za-z]{3}$
Length3 <= length <= 3
Example"PEN"
order_sizestring
Opcional

Categoría de tamaño del paquete

Length1 <= length <= 10
Example"M"
order_deliverystring
Opcional

Fecha estimada de entrega

Formatdate
Example"2024-12-31"
ready_to_dispatchboolean
Opcional

Permite confirmar automáticamente el pedido. Si se omite, se asume false por defecto.

Defaultfalse
Exampletrue
total_weightnumber
Opcional

Peso total del pedido en kilogramos

Formatdouble
Range0 <= value
Example5
total_volumenumber
Opcional

Volumen total del pedido en metros cúbicos

Formatdouble
Range0 <= value
Example0.1
observationsstring
Opcional

Observaciones adicionales del pedido

sender
Opcional

Información del remitente

payment
Opcional

Información de pago. Si se envía payment, amount es obligatorio; el resto de sus campos son opcionales.

packages
Opcional

Lista de paquetes (bultos físicos) del pedido.

Emparejamiento con los artículos: cada paquete se relaciona con los artículos que contiene mediante correlative_id; el paquete y sus artículos comparten el mismo valor. Es un identificador local al request (no es un ID de negocio ni se almacena) y debe ser único entre los packages[].

Un artículo cuyo correlative_id no coincida con ningún paquete —o cuando no se envía packages[]— se agrupa en un paquete aparte. El código LPN de cada paquete (enviado o autogenerado) depende de la configuración de la cuenta; ver el campo lpn.

Ejemplo — el paquete 1 contiene los artículos ART001 y ART002; el artículo ART003 se agrupa en un paquete aparte:

  { "correlative_id": 1, "lpn": "LPN001" }
], "items": [
  { "correlative_id": 1, "code": "ART001", "name": "Smartphone", "quantity": 1 },
  { "correlative_id": 1, "code": "ART002", "name": "Funda",      "quantity": 2 },
  { "correlative_id": 3, "code": "ART003", "name": "Cargador",   "quantity": 1 }
] ```
Items1 <= items
items
Opcional

Lista de artículos del pedido. Cada artículo se asigna a un paquete repitiendo en su correlative_id el valor del package correspondiente en packages[]. Ver el modelo de emparejamiento y el ejemplo en packages.

Items1 <= items

Response Body

application/json

application/json

application/json

application/json

application/json