Update Inbound Order

Sandbox

https://sandbox.trynavigate.co/api/v1

PUT

/inbound/{id}

Use this endpoint to update an inbound order.
The unique work order identifier
of the inbound order to fetch must be passed in
the request URL. The value of this parameter
must be picked from the response of the
Get Inbound Orders API endpoint.

An order can be updated only before it has been
shipped - once shipped, order details cannot be
modified. Additionally, the origin and destination
address cannot be updated once the order has been
created because doing so would change the order
completely.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Success.

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://sandbox.trynavigate.co/api/v1/inbound/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fromLocationId": 540819,
    "toLocationId": 180273,
    "products": [
        {
            "sku": "B00551Q3CS",
            "lotNumber": 1234,
            "expiryDate": "2025-07-23T00:00:00.000Z",
            "cartonUnit": 2,
            "totalCartons": 2,
            "productQuantity": 4
        }
    ],
    "sellerSpecInstruction": "string",
    "prepSpecInstruction": "string",
    "shipDate": "2025-07-23T00:00:00.000Z",
    "carrierName": "UPS",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "packageType": "Drum",
    "packageQuantity": 1,
    "measurementSystem": 1,
    "dimensions": [
        {
            "packageLength": 1,
            "packageWidth": 1,
            "packageHeight": 1,
            "packageWeight": 1,
            "packageDescription": "Package description."
        }
    ],
    "estimatedArrivalDate": "2025-08-07T00:00:00.000Z",
    "modeOfTransport": "COURIER",
    "requiredShippingService": true,
    "inspectionLevel": "PARTIAL",
    "carrier": "string",
    "poNumber": "string",
    "requestType": 0
}'

Response Example

200 - Example 1

{
    "order": {
        "id": 202508381593,
        "originAddressId": 180273,
        "fromName": "AMZ Prep",
        "fromAddress": "1 Summerlea Road, YYZ2, Brampton, Ontario - L6T4V2 , Canada",
        "fromAddressLine1": "1 Summerlea Road",
        "fromCity": "Brampton",
        "fromStateCode": "ON",
        "fromCountryCode": "CA",
        "fromMail": "yyz2@amzprep.com",
        "fromPhoneNumber": "9876543210",
        "fromLocationInstruction": "string",
        "toName": "string",
        "toAddress": "Canada",
        "toStateCode": "string",
        "toMail": "string",
        "toPhoneNumber": "string",
        "toLocationInstruction": "string",
        "merchantName": "ACME Inc.",
        "createdDateTime": "2025-08-25T08:19:41.213583",
        "shipmentDate": "2025-08-25T08:19:41.213583",
        "shipmentIds": "string",
        "status": "PREP_GENERATED",
        "updatedDateTime": "2025-08-25T08:19:51.93878"
    }
}

Modified at 2025-11-20 12:06:10

Get Inbound Order Details

Cancel Inbound Order