Update a specific shipment package.

PATCH

/v1/{shipmentId}/package/{packageId}

This endpoint allows you to update a specific shipment package with tracking information using the shipment ID and package ID.

Request

Path Params

Body Params application/json

Examples

Responses

🟢204No Content

Returns success when the package is updated.

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.dev.ordermesh.io/v1//package/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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,
    "packageOrderItems": [
        {
            "orderItemId": "1",
            "quantity": 2
        },
        {
            "orderItemId": "2",
            "quantity": 1
        }
    ]
}'

Response Example

400 - Success Example

{
    "errorCode": "ValidationError",
    "requestId": "224b67bd-02e2-4b0c-9eef-2559e51d1866",
    "errors": [
        {
            "errorMessage": "'Title' must not be empty.",
            "propertyName": "'Title'",
            "attemptedValue": null
        }
    ]
}

Modified at 2026-03-02 17:34:25

Get shipment details by Order Item ID.

Cancel shipment.