The Shipment Object
The Shipment Object is the backbone of the Shipping API. It represents a grouping of items that are transported together from a starting point to a final destination. This can include one or multiple parcels.
The type of shipment can be classified as either FORWARD or REVERSE. A FORWARD shipment indicates the movement of items from a merchant to a customer, while a REVERSE shipment is the opposite, representing the return of items from a customer to a merchant.
Each shipment is given two distinct identification codes, one generated by Carriyo called theShipment ID and the other, a Partner Shipment Reference which is provided by the merchant themselves.| shipment_id | string Unique identifier for the shipment |
| entity_type | string The type of the shipment is either FORWARD or REVERSE |
| merchant | string ID of the merchant that created this shipment |
object (References Object) References for a shipment, provided by the merchant. | |
object (Carrier Account Object) Carrier account chosen for the shipment. | |
object (Payment Object) Payment details including the total value of the shipment and any pending Cash on Delivery amount. | |
object (Collection Object) Collection details chosen for the shipment, such as scheduled collection date. | |
object (Delivery Object) Delivery details chosen for the shipment, such as chosen delivery type and scheduled delivery date. | |
object (Location Object) Either a free-form address or a predefined location. | |
object (Location Object) Either a free-form address or a predefined location. | |
Array of objects (Item Object) List of individual items or SKUs in a shipment. | |
object (Freight request) List of packages of type pallet or carton in a B2B shipment. | |
object (Customs) Customs declaration details such as total declared value. | |
Array of objects (Parcel Object) List of parcels in a B2C shipment. | |
object (Post Shipping Info) Booking details such as tracking number, labels etc. | |
| custom_attributes | object Additional custom attributes provided by the merchant. |
| order_date | string <date-time> The date the customer order was received by the merchant |
| order_type | string The type of the order. The possible values can be one of the order types predefined by the merchant. |
| creation_date | string <date-time> The date the shipment was created in Carriyo |
| update_date | string <date-time> The date the shipment was last updated in Carriyo |
| confirmation_date | string <date-time> The date the shipment was confirmed for booking |
| estimated_process_date | string <date-time> The date the shipment is expected to be processed in ISO 8601 format. Example: 2022-03-01T17:07:05.000Z |
| promised_delivery_date | string <date-time> The promised delivery date for the shipment in ISO 8601 format. Example: 2022-03-01T17:07:05.000Z |
| original_promised_delivery_date | string <date-time> The original promised delivery date for the shipment in ISO 8601 format (if the promise is updated). Example: 2022-03-01T17:07:05.000Z |
object (estimated-shipping-cost) The estimated cost of the shipping based either on the costing profile you have configured for the carrier or carrier costing API response | |
| language | string Two letter ISO 639-1 code. Example: en |
| return_request_id | string ID of the Return request that initiated the reverse shipment |