Registrar Devolución

Registra una nueva devolución 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"RET-2024-001"

modality_codestring

Requerido

Código de la modalidad

Length1 <= length <= 10

Example"LI"

brand_codestring

Opcional

Código de la marca

Length1 <= length <= 30

Example"B001"

sender

Requerido

Información del remitente. En una devolución el remitente es obligatorio y sus campos name, document y phone deben estar presentes.

recipient

Opcional

Información del destinatario

origin

Requerido

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

point_code — código del local de origen (si se envía, los demás campos de ubicación son ignorados).
ubigeo — código INEI del distrito.
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):

point_code — código del local de destino (si se envía, los demás campos de ubicación son ignorados).
ubigeo — código INEI del distrito.
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

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

Items1 <= items

items

Opcional

Lista de artículos/items

Items1 <= items

Response Body

`application/json`

Request Body

JSONRequest

{
  "order_number": "RET-2024-001",
  "modality_code": "LI",
  "brand_code": "B001",
  "sender": {
    "name": "John Doe",
    "document": "12345678",
    "phone": "+1234567890",
    "email": "sender@example.com"
  },
  "origin": {
    "point_code": "WH-LIMA-01",
    "address": "123 Main Street",
    "address_number": 123,
    "reference": "Departamento 2B",
    "country_code": "PE",
    "latitude": -12.0464,
    "longitude": -77.0428
  },
  "destination": {
    "address": "123 Main Street",
    "address_number": 123,
    "reference": "Departamento 2B",
    "country_code": "PE",
    "ubigeo": "150101",
    "latitude": -12.0464,
    "longitude": -77.0428
  },
  "order_document_reference": "REF-001",
  "order_source_code": "WEB",
  "custom_tracking_id": "TRACK-001",
  "order_quantity_packages": 2,
  "order_price": 250,
  "order_currency_code": "PEN",
  "order_size": "M",
  "order_delivery": "2024-12-31",
  "ready_to_dispatch": true,
  "total_weight": 5,
  "total_volume": 0.1,
  "observations": "Sin observaciones",
  "payment": {
    "payment_type": "CASH",
    "currency": "PEN",
    "amount": 150.5
  },
  "packages": [
    {
      "correlative_id": 1,
      "lpn": "LPN001",
      "packaging_code": "CJA01",
      "weight": 2.5,
      "volume": 0.015,
      "height": 10,
      "width": 20,
      "length": 30,
      "description": "Artículos electrónicos"
    }
  ],
  "items": [
    {
      "correlative_id": 1,
      "code": "ITEM001",
      "name": "Smartphone",
      "unit_measure_code": "UNI",
      "quantity": 2,
      "weight": 0.5,
      "volume": 0.001
    }
  ]
}

Response

JSONExample

{
  "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "order_id": "01KTSQVR7P5MZSBT3E8WER7ED7",
    "tracking": {
      "code": "90001-YJ0H00NQMOOWSQ",
      "url": "https://tracking-qa.dinetecommerce.pe/seguimiento/90001-YJ0H00NQMOOWSQ/JUAN%20PEREZ",
      "tag": "JVBERi0xLjQK..."
    }
  }
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`