Skip to main content

Endpoint

method
string
default:"POST"
POST
endpoint
string
/encomienda/createEncomienda

Request Body

Sender Information

remitente_id
integer
Sender’s customer ID
remitente_documento
string
Sender’s identification document number
remitente_direccion
string
Sender’s address
remitente_contacto_nombre
string
Sender’s contact person name
remitente_contacto_celular
string
Sender’s contact phone number
remitente_id_distrito_a_domicilio
integer
District ID for sender’s address (required if pickup type is home delivery)

Recipient Information

destinatario_id
integer
Recipient’s customer ID
destinatario_documento
string
Recipient’s identification document number
destinatario_contacto_nombre
string
Recipient’s contact person name
destinatario_contacto_celular
string
Recipient’s contact phone number
destinatario_direccion
string
Recipient’s delivery address
destinatario_id_distrito_a_domicilio
integer
District ID for recipient’s address (required if delivery type is home delivery)

Package Details

tipo_entrega
string
required
Delivery type (e.g., “Domicilio”, “Agencia”)
tipo_envio
string
required
Shipping type
id_agencia_destino
integer
Destination branch/agency ID
fecha_entrega
string
Expected delivery date
costo_total
string
required
Total shipping cost
cantidad
string
required
Number of packages/items
kilos
string
required
Weight in kilograms
observacion
string
Additional observations or notes
tipo_pago
string
required
Payment type
guia_remitente
string
Sender’s reference/tracking number

Payment Information (conditional)

banco
string
Bank name (required if payment type is deposit)
nro_operacion
string
Operation/transaction number (required if payment type is deposit)

Response

success
boolean
Indicates if the package was created successfully
message
string
Response message

Request Example

{
  "tipo_entrega": "Domicilio",
  "tipo_envio": "Express",
  "id_agencia_destino": 5,
  "remitente_id": 123,
  "remitente_documento": "12345678",
  "remitente_direccion": "Av. Principal 123",
  "remitente_contacto_nombre": "Juan Pérez",
  "remitente_contacto_celular": "987654321",
  "remitente_id_distrito_a_domicilio": 15,
  "destinatario_id": 456,
  "destinatario_documento": "87654321",
  "destinatario_contacto_nombre": "María García",
  "destinatario_contacto_celular": "912345678",
  "destinatario_direccion": "Jr. Los Olivos 456",
  "destinatario_id_distrito_a_domicilio": 20,
  "fecha_entrega": "2026-03-10",
  "costo_total": "50.00",
  "cantidad": "2",
  "kilos": "5.5",
  "observacion": "Fragile items",
  "tipo_pago": "Efectivo",
  "guia_remitente": "GUIDE-2026-001"
}

Response Example

{
  "success": true,
  "message": "Encomienda creada exitosamente"
}

Notes

  • The remitente_id_distrito_a_domicilio field is required only when the pickup type (tipo_entrega) involves home pickup
  • The destinatario_id_distrito_a_domicilio field is required only when the delivery type (tipo_entrega) involves home delivery
  • When tipo_pago is set to “Deposito”, both banco and nro_operacion fields are required
  • All monetary values should be provided as strings with decimal notation

Build docs developers (and LLMs) love