Sign in

v1

latestOpenAPI 3.0.32026-07-242666111.1 KB
orders

Return a order given an encoded order id. The order id must be MongoDB identifier

get/api/v3/orders/{id}

Path parameters

idstring required

Response

idstring required
accountobject required
billIdinteger required
transactionIdinteger required
channelIdinteger required
draftboolean

Indicates if an order is not yet finalized. The order is only processed when is confirmed. By default it's false.

deactivatedboolean required
createdAtstring date-time required
expiresAtstring date-time required
migratedBy'stream' | 'batch' required

Example response

{
  "shipments": [
    {
      "sender": {
        "phone": "+525547596221"
      },
      "recipient": {
        "phone": "+525547596221"
      }
    }
  ]
}