Body Envelope

Every response is contained in an envelope. That is, each response has a predictable set of keys with which you can expect to interact.


The meta key helps communicate extra information regarding a response to the developer.

KeyTypeOptional?DescriptionExample
codeNumberUp to a 5-digit code that represents the status of the request200 4104
messageStringHuman-readable description of the specific meta codeThe request was successfully processed by Postmen.
detailsError[]Detailed error information to indicate the error in the request. It only exists in error responses.[]
retryablebooleanTo indicate if the request is retryable.false
KeyTypeDescriptionExample
pathStringError path of the requestdata.shipment.ship_from.country
infoStringHuman-readable description of the specific errordata.shipment.ship_from.country is a required property
preparing...
preparing...

The data key is the meat of the response. It may be a list of results, but either way, this is where you'll find the data you requested.

Here is the example for GET /couriers

preparing...