v1

latestOpenAPI 3.0.32026-07-242666111.1 KB

Orders

Create multibox orders

Create multibox orders. N child shipments will be created plus the master shipment. The number of child shipments is determined by the packages field, and by default, always 1 master shipment is created.

post/api/v1/orders/multibox

Request body

apikeystring

API key for authentication

deliveryType'taylormade' | 'sameday' | 'nextday' | 'nxd' | 'spt' | 'tlm' | 'smd'

Type of delivery

packageSize'xs' | 's' | 'm' | 'l' | 'xl'

Size of the package

notesstring

Additional notes

packagesinteger

Number of packages

cashOnDeliveryboolean

Whether cash on delivery is enabled

amountCashnumber float

Amount for cash on delivery

SecurePackageboolean

Whether secure package is enabled

amountSecurenumber float

Amount for secure package

receivedIdstring

Identifier for the received order

Example request

{
  "apikey": "15b6d64efc25c4755633332233443308f39c5931",
  "deliveryType": "nextday",
  "packageSize": "l",
  "notes": " s/r",
  "packages": 1,
  "receivedId": "orders/microservice.local.05.03.24",
  "origin": {
    "sender": "Food House",
    "nameSender": "Food",
    "lastNameSender": "House",
    "emailSender": "correo@h.com",
    "phoneSender": "11111111",
    "addressOrigin": "AV. JESUS REYES HEROLES NO. 6 ESQ.",
    "numberOrigin": "AV. MARAVILLAS COL. EL ROSARIO CEYLAN",
    "codePostalOrigin": "54092",
    "country": "MEX"
  },
  "destination": {
    "receiver": "David Ludueña",
    "nameReceiver": "David",
    "lastNameReceiver": "Ludueña",
    "phoneReceiver": "11111111",
    "addressDestination": "Calle Prol. Melchor, Miguel de la Madrid, Iztapalapa, 09698 Ciudad de México, CDMX",
    "numberDestination": "s/r",
    "codePostalDestination": "09698",
    "country": "MEX"
  }
}

Response

Success

codeinteger

trace_idstring

Example response

{
  "code": 201,
  "trace_id": "72aea272-ce53-41fe-b03f-413e77356c5b"
}