Shipments
A shipment represents the one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one shipments for an order.
Attributes
Sample Json
Attributes | Type | Description |
id | integer | system generated unique id for a shipment |
customerOrderNumber | string | order number for which a shipment is created |
externalShipmentID | string | unique number of shipment in a channel |
externalWarehouseID | string | warehouse reference number of a shipment |
externalChannelID | string | sales channel name of client |
orderDate | string | order created Date Time e.g: 2020-03-12 00:00:00 |
paymentType | string | Payment Method of order |
expectedShipDate | string | expected date on which order should be shipped from facility e.g: 2020-03-13 00:00:00 |
externalManifestNumber | string | manifest number assigned for the shipment |
channelManifestNumber | string | manifested number assigned by vendor for a shipment |
order_id | integer | system generated id of an order |
channel_id | integer | id of a sales channel |
warehouse_id | integer | id of warehouse |
account_id | integer | account id of a channel |
channelSlug | string | unique slug of a channel |
region | string | region of shipment |
invoiceNumber | string | invoice number of a shipment (generated at the time of packed ) |
invoice_url | string | invoice url of a shipment |
invoiceDate | string | date time on which the invoice has been generated |
label_url | string | label url of a shipment |
dimension_length | string | length of a shipment |
dimension_width | string | width of a shipment |
dimension_height | string | height of a shipment |
weight | string | weight if a shipment |
trackingID | string | tracking id generated for a shipment |
courierName | string | courier name belongs to the trackind id |
status | string | latest status of shipment |
remarks | string | latest remark on shipment |
status_updated_at | string | latest status updated date time |
customerName | string | billing customer name |
customerContactNumber | string | billing contact name |
email | string | billing email id of a customer |
status_log | object | status object of a shipment |
status_log.status | string | statuses of a shipment |
shippingAddress | object | shipping address object |
shippingAddress.customerName | string | shippingAddress customer Name |
shippingAddress.addressLine1 | string | shipping address line first |
shippingAddress.addressLine2 | string | shipping address line second |
shippingAddress.city | string | shipping address city |
shippingAddress.state | string | shipping address state |
shippingAddress.postalCode | string | shipping postal code |
shippingAddress.countryCode | string | shipping country code |
shippingAddress.countryName | string | shipping country name |
shippingAddress.contactPhone | string | shipping address contact number |
shippingAddress.email | string | shipping address email ID |
isCOD | string | Type of order Enum : 0 , 1(1 if order is cod,0 if order is prepaid) |
track_payload | object | latest track payload object of a shipment |
track_payload.clickPostTrackData | object | shipment track data object |
clickPostTrackData.timestamp | string | |
clickPostTrackData.account_code | string | courier account code |
clickPostTrackData.status | string | status from courier o shipment |
clickPostTrackData.waybill | string | tracking number of shipment |
clickPostTrackData.cp_id | integer | courier partner id of courier |
clickPostTrackData.clickpost_status_description | string | message discription from courier on a status |
clickPostTrackData.remark | string | remark of status |
clickPostTrackData.clickpost_status_code | integer | status code of a status on shipment |
clickPostTrackData.additional | object | addtional detail object |
additional.is_rvp | boolean | true if shipment is reverse, o if shipment is forward |
additional.destination_hub_inscan_ts | string | |
additional.courier_partner_edd | string | |
additional.latest_status | object | current status of courier |
timestamp | string | time stamp on which latest status happens |
status | string | status of courier, can be same as latest_status |
remark | string | remark of a status |
clickpost_status_bucket | string | |
reference_number | string | shipment number ,It is same as externalChannelID |
clickpost_status_description | string | description of status |
clickpost_status_bucket_description | string | |
clickpost_status_code | string | status code of a status |
location | string | current location of a shipment |
packed_date | string | shipment packed date (yyyy-mm-dd h:m:s) |
items | array[object] | items object |
created_at | string | create timestamp of shipment |
updated_at | string | update timestamp of shipment |
{
"id": 1576963,
"customerOrderNumber": "OD119208447831346000",
"vendorOrderNumber": "11920832654052201",
"externalShipmentID": "300884672-5-87",
"externalWarehouseID": "W4585",
"externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
"defaultWarehouseCode": "2022",
"orderDate": "2020-03-16 18:24:35",
"portal_id": 16,
"paymentType": "CashOnDelivery",
"expectedShipDate": null,
"externalManifestNumber": null,
"channelManifestNumber": null,
"order_id": 1569986,
"channel_id": 5,
"warehouse_id": 3,
"channel_account_id": null,
"account_id": 3,
"region": "National",
"picklistCode": null,
"invoiceNumber": "CL/19-20/83882",
"boxType": "UNKNOWN",
"isPriorityShipment": "0",
"isGift": "0",
"invoice_url": "",
"invoiceDate": "2020-03-17 00:00:00",
"label_url": "https://pyck-res-bucket.s3.amazonaws.com:443/DELHIVERY/2020-03-17/2098310484853.pdf",
"labels": "",
"shippingInfo": [],
"boxAdditionalRecommendation": [],
"dimension_length": "279",
"dimension_width": "200",
"dimension_height": "110",
"weight": "672",
"trackingID": "2098310484853",
"packageID": "",
"barcode": "",
"courierName": "Delhivery",
"created_at": "2020-03-16 18:30:38",
"updated_at": "2020-03-17 14:15:45",
"status": "intransit",
"remarks": "bagged at pc",
"customerName": "abc",
"customerContactNumber": "9999999999",
"email": "[email protected]",
"channelSlug": "Kapas Kraft",
"status_updated_at": "2020-03-17 20:54:24",
"status_log": {
"intransit": "2020-03-17 20:54:24",
"dispatched": "2020-03-17 14:30:20",
"packed": "2020-03-17 14:15:48",
"created": "2020-03-16 18:30:38"
},
"orderExternalCreatedAt": "2020-03-16 18:30:34",
"shippingAddress": {
"customerName": "ABC",
"addressLine1": "Test,santram dery road ,Na",
"addressLine2": "",
"city": "Kheda",
"state": "Gujarat",
"postalCode": "387002",
"countryCode": "IN",
"countryName": "India",
"contactPhone": "9999999999",
"email": "[email protected]"
},
"isCOD": "1",
"track_payload": {
"clickPostTrackData": {
"timestamp": "2020-03-19T11:16:00Z",
"account_code": "Delhivery Surface",
"status": "In Transit",
"waybill": "2098310484853",
"cp_id": 4,
"clickpost_status_description": "InTransit",
"remark": "Bagged at PC",
"clickpost_status_code": 5,
"location": "Vadodara_Dasranth_I (Gujarat)",
"additional": {
"is_rvp": false,
"destination_hub_inscan_ts": null,
"courier_partner_edd": null,
"latest_status": {
"timestamp": "2020-03-19T11:16:00Z",
"status": "In Transit",
"remark": "Bagged at PC",
"clickpost_status_bucket": 3,
"reference_number": "300884672-5-87",
"clickpost_status_description": "InTransit",
"clickpost_status_bucket_description": "In transit",
"clickpost_status_code": 5,
"location": "Vadodara_Dasranth_I (Gujarat)"
}
}
}
},
"packed_date": "2020-03-17 14:15:48",
"items": [
{
"lineItemSequenceNumber": 117102,
"orderItemID": "300884672-3752974",
"itemID": "5050407362787",
"sku": "1234_S",
"asin": "91261231487090",
"productName": "Becken Plain",
"quantity": 1,
"customerPrice": 2999,
"lineItemTotal": 2999,
"invoiceTotal": 2999,
"discount": 0,
"taxRate": 0,
"taxAmount": 0,
"giftMessage": "",
"giftLabelContent": "",
"lineItemOrderStatus": "",
"orderItemIDs": [
"300884672-3752974"
],
"productImageUrl": null,
"productAdditionalInfo": null,
"expectedDeliveryDate": "2020-03-18",
"shippingCharges": 0,
"productUrl": null,
"originalOrderItemId": null
}
]
}
The
Items ObjectAttributes | type | description |
items[].lineItemSequenceNumber | integer | incremental id of each item in a order |
items[].orderItemID | string | unique generated id by eshopbox |
items[].itemID | string | variant id of item (seller SKU code) |
items[].sku | string | sku of item |
items[].productName | string | name of the item |
items[].quantity | integer | quantity of the item |
items[].customerPrice | number | unit price of item |
items[].lineItemTotal | number | total price of item |
items[].invoiceTotal | number | total price of item |
items[].discount | number | discount on item |
items[].taxRate | number | tax rate on item |
items[].taxAmount | number | tax amount on item |
items[].productImageUrl | string | product image url of item |
items[].productAdditionalInfo | object | additional info of item |
items[].productAdditionalInfo.color | string | color of item |
items[].productAdditionalInfo.size | string | size of item |
items[].shippingCharges | number | shipping charges of item |
items[].productUrl | string | product url of item |
The
productAdditionInfo ObjectAttributes | Type | Description |
productAdditionalInfo.color | string | Color of the item |
productAdditionalInfo.size | string | Size of the item |
Attribute | Description |
0 | created order must be Prepaid |
1 | created order must be COD |
Last modified 2yr ago