Get details of a specific shipment by Shipment ID.

GET

/v1/{shipmentId}

This endpoint allows you to retrieve detailed information about a specific shipment with all the packages using just the shipment ID.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Returns the shipment with the provided shipment id.

Body

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.stg.ordermesh.io/shipment/v1/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "id": "a1f0a9cc-f66c-447f-b770-9b4884e9f02d",
    "merchantId": "1",
    "merchantName": "Merchant test",
    "vendorId": "2",
    "facilityId": "3",
    "facilityName": "Facility test",
    "vendorName": "Vendor test",
    "orderId": "order 0",
    "shortId": "S1234567890",
    "orderExternalId": "9",
    "merchantOrderId": null,
    "safeId": "example-a1f0a9cc-f66c-447f-b770-9b4884e9f02d",
    "customerId": "4",
    "customerShippingAddressId": 5,
    "merchantPaymentId": "6",
    "shippingCountryCodeISO": 236,
    "shippingCountryCode": "US",
    "shipmentStatus": 1,
    "isRejectedByVendor": null,
    "shippingMethod": null,
    "isPollingStopped": false,
    "currencyCode": "USD",
    "languageCodeISO": 40,
    "languageCode": "US",
    "transactionalCostModel": "transactional",
    "createdDate": "2022-04-03T12:00:00",
    "orderCreatedDate": "2022-04-02T12:00:00",
    "lastModifiedDate": "2022-04-01T12:00:00",
    "merchantOrderTotal": 123,
    "merchantPackageTotal": 22,
    "merchantTaxTotal": 55,
    "merchantShippingTotal": 33,
    "packageTotal": 321,
    "taxTotal": 55,
    "shippingTotal": 12,
    "total": 32,
    "costTotal": 43,
    "costTaxTotal": 77,
    "costShippingTotal": 42,
    "costShippingTaxTotal": 93,
    "packages": [
        {
            "id": "5ee0fab1-942a-4c16-91cc-ec209de922b5",
            "shortId": "P1234567890",
            "shipmentId": "a1f0a9cc-f66c-447f-b770-9b4884e9f02d",
            "carrierName": "Carrier test",
            "carrierMethodName": "Method test",
            "shippedDate": "2022-04-02T15:20:00",
            "fulfilledDate": "2022-04-02T13:05:00",
            "carrierTrackingNumber": "12321",
            "carrierLink": "https://www.tracking.asd/qwe123",
            "carrierAccount": true,
            "orderItemIDs": [
                "a1f0a9cc-f66c-447f-b770-9b4884e9f02d"
            ],
            "packageOrderItems": [],
            "packingSlipId": null
        }
    ],
    "orderItemIDs": [
        "a1f0a9cc-f66c-447f-b770-9b4884e9f02d"
    ],
    "orderItems": [
        {
            "id": "a1f0a9cc-f66c-447f-b770-9b4884e9f02d",
            "sku": "Sku-test",
            "vendorSku": "VendorSku-test",
            "variantId": "1",
            "vendorProductId": "1",
            "quantity": 1,
            "merchantPrice": {
                "currency": "USD",
                "amount": 10,
                "tax": 5
            },
            "price": {
                "currency": "USD",
                "amount": 10,
                "tax": 5
            },
            "shortId": "I21832079",
            "status": 1,
            "images": [
                {
                    "area": "Front",
                    "ourUrl": "https://files.example.com/image.png",
                    "ourFileId": "01KFNYM7GYPKTJ6ADP6WSMMH90",
                    "ourThumbnailUrl": null,
                    "ourThumbnailFileId": null,
                    "vendorReadyFileId": "01KCS3G3ZYMVW76YWTWCCH7GT6"
                }
            ],
            "isSample": false
        }
    ],
    "selectedShippingMapping": {
        "carrierName": "UPS",
        "type": "Detailed",
        "shippingMethods": [
            {
                "shippingMethodName": null,
                "shipmentMethod": "Standard",
                "vendorShippingMethod": null,
                "shipToCountries": null,
                "carrierShippingServiceMethods": [
                    {
                        "serviceMethodsAllowed": [
                            "Ground"
                        ],
                        "countryCodesToApply": [
                            "US"
                        ],
                        "vendorMapping": {
                            "carrierCode": "UPS",
                            "serviceCode": "Ground"
                        }
                    }
                ]
            }
        ]
    },
    "shippingAddress": {
        "firstName": "John",
        "lastName": "Doe",
        "line1": "123 Main St",
        "line2": "Suite 100",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "countryCode": "US",
        "phone": "555-123-4567",
        "email": "john@example.com"
    },
    "orderShortId": "O20051638",
    "reprint": {
        "originalOrderId": "698ce35e531578b54a3a09ee",
        "reasonId": "fcb29be3-64b8-41b0-a0ab-c7a39bb38d0e"
    }
}

Modified at 2026-05-27 12:49:10

Generates a packing slip for a specific shipment by Shipment ID.

Update details of a specific shipment by Shipment ID.