Get all Inward Consignments
Last updated
Last updated
GET
https://{{workspace}}.myeshopbox.com/api/v1/consignments
This endpoint allows you to get a list of the inward consignment.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
{
"total":100,
"page":1,
"per_page":2,
"data":[
{
"id": "7630",
"consignmentNumber": "CON/45/873",
"refConsigmentNumber": "675986",
"fromPartyId": "5",
"refFromPartyID": "PW60",
"fromPartyName": "Kapas Kraft Fashion Limited",
"toPartyId": "72",
"toPartyName": "Eshopbox Gurgaon(Sohana)",
"refToPartyID": "ESBFLPLT",
"type": "INWARD",
"status": "SCHEDULED",
"warehouseId": "7",
"warehouseName": "Kapas Kraft Apparels Limited 1006",
"externalWarehouseId": "2022",
"document": [
{
"document_type": "inv",
"document_number": "45243",
"document_url": "https://cdn.filestackcontent.com/45243"
}
],
"schedule": {
"scheduledArrivalDate": "2020-03-23T00:03:00.000Z",
"scheduledArivalFrom": "10:00:00",
"scheduledArivalTo": "11:00:00",
"receivedOn": "2020-03-19 17:46:40.0",
"completedOn": null,
"cancelledOn": null
},
"itemSummary": {
"consignmentQty": "45",
"receivedQty": 20,
"pendingQty": "45",
"qcAcceptedQty": 20,
"qcRejectedQty": 1,
"shortageQty": "0",
"unexpectedQty": "0",
"boxQty": 1,
"rejectedImagesUrl": [
"https://storage.cloud.google.com/rejected.appspot.com/345.jpg"
],
"acknowledgmentSlipUrl": [
"https://storage.cloud.google.com/acknowlwdgement.appspot.com/1234567.pdf"
],
"damagedQty": null
},
"trackingDetails": {
"transportBy": "Client",
"courierName": XC-AIR,
"trackingNumber": null,
"vehiclePlateNumber": HR-26 5234,
"sealID": 5490
},
"uploadDetails": {
"successCount": 3,
"failureCount": 0
},
"remarks": null,
"estimatedCompletionDate": "2020-03-20T00:00:00.000Z",
"failureReason": null,
"requestReschedule": null,
"slaStatus": null,
"failImageUrl": "https://storage.googleapis.com/failImage.appspot.com/fail417.zip",
"numberOfAvailableBoxes": 0,
"numberOfDamagedBoxes": 0,
"createdOn": "2020-03-18T14:32:57.000Z",
"updatedOn": "2020-03-23T13:54:06.000Z"
},
{
"id": "7630",
"consignmentNumber": "CON/45/874",
"refConsigmentNumber": "409577",
"fromPartyId": "5",
"refFromPartyID": "PW60",
"fromPartyName": "Kapas Kraft Fashion Limited",
"toPartyId": "72",
"toPartyName": "Eshopbox Gurgaon(Sohana)",
"refToPartyID": "ESBFLPLT",
"type": "INWARD",
"status": "SCHEDULED",
"warehouseId": "7",
"warehouseName": "Kapas Kraft Apparels Limited 1006",
"externalWarehouseId": "2022",
"document": [
{
"document_type": "inv",
"document_number": "539648",
"document_url": "https://cdn.filestackcontent.com/539648"
}
],
"schedule": {
"scheduledArrivalDate": "2020-03-23T00:03:00.000Z",
"scheduledArivalFrom": "10:00:00",
"scheduledArivalTo": "11:00:00",
"receivedOn": "2020-03-19 17:46:40.0",
"completedOn": null,
"cancelledOn": null
},
"itemSummary": {
"consignmentQty": "45",
"receivedQty": 20,
"pendingQty": "45",
"qcAcceptedQty": 20,
"qcRejectedQty": 1,
"shortageQty": "0",
"unexpectedQty": "0",
"boxQty": 1,
"rejectedImagesUrl": [
"https://storage.cloud.google.com/rejected.appspot.com/345.jpg"
],
"acknowledgmentSlipUrl": [
"https://storage.cloud.google.com/acknowlwdgement.appspot.com/1234567.pdf"
],
"damagedQty": null
},
"trackingDetails": {
"transportBy": "Client",
"courierName": XC-AIR,
"trackingNumber": null,
"vehiclePlateNumber": HR-26 5234,
"sealID": 5490
},
"uploadDetails": {
"successCount": 3,
"failureCount": 0
},
"remarks": null,
"estimatedCompletionDate": "2020-03-20T00:00:00.000Z",
"failureReason": null,
"requestReschedule": null,
"slaStatus": null,
"failImageUrl": "https://storage.googleapis.com/failImage.appspot.com/fail417.zip",
"numberOfAvailableBoxes": 0,
"numberOfDamagedBoxes": 0,
"createdOn": "2020-03-18T14:32:57.000Z",
"updatedOn": "2020-03-23T13:54:06.000Z"
}
]
}
curl -X GET https://{{workspace}}.myeshopbox.com/api/v1/consignments \
-H "Authorization: Bearer XXXX"
sort_order
string
sort_order
either desc
or asc
sort_by
string
Sort the attribute
page
integer
The number of pages used to offset the results
per_page
integer
The number of items to be return per page
Authentication
string
The Bearer token which allows to grant access to the API