Shipment Request
This payload is being used to perform operations on a shipment.
Merchant is mandatory for the most of Carriyo APIs. If it is not specified, the default merchant configured for a tenant will be used.
Should contain carrier account ID and/or carrier account name. Carrier ID takes precedence.
Tenant provided references for a shipment. The partner_shipment_reference
is not mandatory but is expected to be unique. If partner_shipment_reference
is not passed, then the partner_order_reference
is used as the partner_shipment_reference
. The partner_shipment_reference
is useful to provide a tenant defined reference for each shipment if a single order has multiple shipments.
For the reverse-shipment payment_mode
and pending_amount
are not required and will be set to PRE_PAID
and 0
accordingly.
Pickup request must contain all the neccessary information about the sender: their name, phone number, email, address, city and country. These properties will be given from the corresponding partner location, if either of following fields are specified instead: partner_location_id
, partner_location_name
, partner_location_code
.
Dropoff request must contain all the neccessary information about the receiver: their name, phone number, email, address, city and country. These properties will be given from the corresponding partner location, if either of following fields are specified instead: partner_location_id
, partner_location_name
, partner_location_code
.
Merchant defined custom attributes in the form of a map:
{"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
Must be a date in ISO 8601 format. Example: 2020-09-03T17:07:05.000Z
Must be a two letter ISO 639-1 code. Example: en