Get a Shipment

Get Shipment

GET https://wms.eshopbox.com/api/order/shipment/{externalShipmentId}

This endpoint allows you to get a shipment.

Path Parameters

Name	Type	Description
externalShipmentId	string	Unique number of shipment in a channel.

Headers

Name	Type	Description
Authentication	string	Bearer token to access the api.

200 Shipment successfully retrieved.

{
    "customerOrderNumber": "OD119208447831346000",
    "vendorOrderNumber": "11920832654052201",
    "externalShipmentID": "300884672-5-87",
    "externalWarehouseID": "W4585",
    "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
    "defaultWarehouseCode": "2022",
    "orderDate": "2020-03-18 15:52:38",
    "portal_id": 12,
    "paymentType": "COD",
    "expectedShipDate": null,
    "externalManifestNumber": null,
    "channelManifestNumber": null,
    "order_id": 1576882,
    "channel_id": 271,
    "warehouse_id": 21,
    "channel_account_id": null,
    "account_id": 6,
    "region": "Local",
    "picklistCode": null,
    "invoiceNumber": "SESI1687",
    "boxType": "UNKNOWN",
    "isPriorityShipment": "0",
    "isGift": "0",
    "invoice_url": "",
    "invoiceDate": "2020-03-19 00:00:00",
    "label_url": "https://pyck-res-bucket.s3.amazonaws.com:443/DELHIVERY/2020-03-18/2098310486496.pdf",
    "labels": "",
    "shippingInfo": [],
    "boxAdditionalRecommendation": [],
    "dimension_length": "10",
    "dimension_width": "20",
    "dimension_height": "12",
    "weight": "1231",
    "trackingID": "2098310486496",
    "packageID": "",
    "barcode": "",
    "courierName": "Delhivery",
    "created_at": "2020-03-18 21:22:57",
    "updated_at": "2020-03-19 01:54:20",
    "status": "intransit",
    "remarks": "shipment picked up from client location",
    "customerName": "sam",
    "customerContactNumber": "9999999999",
    "email": "[e-mail]",
    "channelSlug": "blackberrys",
    "status_updated_at": "2020-03-19 14:50:29",
    "status_log": {
        "intransit": "2020-03-19 14:50:29",
        "dispatched": "2020-03-19 06:30:34",
        "packed": "2020-03-19 01:54:23",
        "created": "2020-03-18 21:22:57"
    },
    "orderExternalCreatedAt": "2020-03-18 21:22:52",
    "shippingAddress": {
        "customerName": "sam",
        "addressLine1": "sector 47",
        "addressLine2": "gurgaon",
        "city": "gurgaon",
        "state": "HARYANA",
        "postalCode": "122018",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "9999999999",
        "email": "[e-mail]"
    },
    "id": 1583574,
    "isCOD": "1",
    "track_payload": {
        "clickPostTrackData": {
            "status": "In Transit",
            "clickpost_status_description": "InTransit",
            "waybill": "2098310486496",
            "account_code": "Delhivery Surface",
            "location": "Gurgaon_Bilaspur_P (Haryana)",
            "clickpost_status_code": 5,
            "remark": "Shipment Picked Up from Client Location",
            "cp_id": 4,
            "timestamp": "2020-03-19T13:48:28Z",
            "additional": {
                "latest_status": {
                    "clickpost_status_bucket_description": "In transit",
                    "clickpost_status_description": "InTransit",
                    "reference_number": "BLCK103443-271-49",
                    "clickpost_status_bucket": 3,
                    "status": "In Transit",
                    "location": "Gurgaon_Bilaspur_P (Haryana)",
                    "clickpost_status_code": 5,
                    "remark": "Shipment Picked Up from Client Location",
                    "timestamp": "2020-03-19T13:48:28Z"
                },
                "destination_hub_inscan_ts": null,
                "courier_partner_edd": null,
                "is_rvp": false
            }
        }
    },
    "packed_date": "2020-03-19 01:54:23",
    "items": [
        {
            "lineItemSequenceNumber": 1,
            "orderItemID": "11920832654052201",
            "itemID": "DB9U03FMGWZ",
            "sku": "123_S",
            "asin": "",
            "productName": "Print On Oxford Base Phoenix Fit Shirt",
            "quantity": 1,
            "customerPrice": 1995,
            "lineItemTotal": 1995,
            "invoiceTotal": 1995,
            "discount": 0,
            "taxRate": 0,
            "taxAmount": 0,
            "giftMessage": "",
            "giftLabelContent": "",
            "lineItemOrderStatus": "",
            "orderItemIDs": [
                "BLCK103443-3781063"
            ],
            "productImageUrl": "https://cdn.schema.io/blackberrys-india/5df8c057737b791c70e34ffe/fa9e12ed14879752286edcc0ea6e0a79",
            "productAdditionalInfo": {
                "size": "40",
                "color": "Blue"
            },
            "expectedDeliveryDate": "2020-03-19",
            "shippingCharges": 0,
            "productUrl": "www.blackberrys.com/products/id/print-on-oxford-base-phoenix-fit-shirt-bbaplbb140117",
            "originalOrderItemId": null
        },
        {
            "lineItemSequenceNumber": 2,
            "orderItemID": "11920832654052201",
            "itemID": "DB9U03FMGWZ",
            "sku": "123_S",
            "asin": "",
            "productName": " Cotton Pink Slim Fit   Shirt ",
            "quantity": 1,
            "customerPrice": 1197,
            "lineItemTotal": 1197,
            "invoiceTotal": 1197,
            "discount": 0,
            "taxRate": 0,
            "taxAmount": 0,
            "giftMessage": "",
            "giftLabelContent": "",
            "lineItemOrderStatus": "",
            "orderItemIDs": [
                "BLCK103443-3781064"
            ],
            "productImageUrl": "https://cdn.schema.io/blackberrys-india/5d5ccd4882af047b9e8c02af/ccdd7cb057fb979e0a4612a8e5ae9c56",
            "productAdditionalInfo": {
                "size": "40",
                "color": "Pink"
            },
            "expectedDeliveryDate": "2020-03-19",
            "shippingCharges": 0,
            "productUrl": "www.blackberrys.com/products/id/cotton-pink-slim-fit-shirt-bbaplbb140355",
            "originalOrderItemId": null
        },
        {
            "lineItemSequenceNumber": 3,
            "orderItemID": "11920832654052201",
            "itemID": "DB9U03FMGWZ",
            "sku": "123_S",
            "asin": "",
            "productName": "Check Slim Fit Shirt",
            "quantity": 1,
            "customerPrice": 1559,
            "lineItemTotal": 1559,
            "invoiceTotal": 1559,
            "discount": 0,
            "taxRate": 0,
            "taxAmount": 0,
            "giftMessage": "",
            "giftLabelContent": "",
            "lineItemOrderStatus": "",
            "orderItemIDs": [
                "BLCK103443-3781065"
            ],
            "productImageUrl": "https://cdn.schema.io/blackberrys-india/5df9e1c3f010c04ce3f7dfdc/84996fc467236afa69fe8eee90068b17",
            "productAdditionalInfo": {
                "size": "40",
                "color": "Yellow"
            },
            "expectedDeliveryDate": "2020-03-19",
            "shippingCharges": 0,
            "productUrl": "www.blackberrys.com/products/id/check-slim-fit-shirt-bbaplbb159812",
            "originalOrderItemId": null
        }
    ]
}

curl -X GET https://wms.eshopbox.com/api/shipment/{externalShipmentId} \
-H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{}