Update order data.

PATCH

/v1/orders/{orderId}

This API request allows you to send a PATCH request to orders endpoint and update order data or order items data in a single order.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

text/plain

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/orders/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "65aac2a2441de72442397b62",
    "shippingAddress": {
        "location": null,
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "123 Maple Street",
        "line2": "",
        "line3": null,
        "city": "Springfield",
        "state": "IL",
        "zip": "62704",
        "countryCode": "US",
        "phone": "555-1234",
        "email": "jane.doe@example.com"
    },
    "billingAddress": {
        "location": null,
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "123 Maple Street",
        "line2": "",
        "line3": null,
        "city": "Springfield",
        "state": "IL",
        "zip": "62704",
        "countryCode": "US",
        "phone": "555-1234",
        "email": "billing@example.com"
    },
    "returnAddress": {
        "location": null,
        "firstName": "John",
        "lastName": "Smith",
        "line1": "456 Oak Street",
        "line2": "Suite 300",
        "line3": null,
        "city": "Shelbyville",
        "state": "IL",
        "zip": "62565",
        "countryCode": "US",
        "phone": "555-6789",
        "email": "return@example.com"
    },
    "location": {
        "longitude": -89.64,
        "latitude": 39.78
    },
    "merchantName": "Springfield Boutique",
    "customerShippingMethod": "Expedited",
    "status": "ReadyForFulfillment",
    "items": [
        {
            "id": "65aac2a2441de72442397b63",
            "sku": "TSHIRT-5000-M-Black",
            "quantity": 1,
            "images": [
                {
                    "url": "https://example.com/tshirt-front.jpg",
                    "thumbnailUrl": "https://example.com/tshirt-thumbnail.jpg",
                    "thumbnailFileId": null,
                    "area": "Front",
                    "printMethod": "DirectToGarment",
                    "ourUrl": null,
                    "ourFileId": null,
                    "ourThumbnailUrl": null,
                    "ourThumbnailFileId": null,
                    "vendorReadyFileId": null
                }
            ],
            "options": [
                {
                    "name": "Size",
                    "value": "Medium"
                },
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "attributes": [
                {
                    "name": "Material",
                    "value": "Cotton"
                }
            ],
            "merchantPrice": {
                "amount": 15,
                "currency": "USD"
            },
            "merchantShippingPrice": {
                "amount": 2.5,
                "currency": "USD"
            },
            "merchantTax": {
                "amount": 1.2,
                "currency": "USD"
            },
            "status": null,
            "statusDesc": null,
            "skipImgManip": false,
            "skipImageValidation": false,
            "skipSkuValidation": false
        }
    ],
    "shipmentsMetadata": [
        {
            "shipmentId": "shipment-123",
            "facilityName": "Main Warehouse",
            "shipmentCreatedDate": "2026-02-25T22:29:29.4851537Z",
            "shortId": "S12345",
            "shipmentExternalId": "EXT-999"
        }
    ],
    "isPollingStopped": true
}'

Response Example

200 - Success Example

{
    "updated": true
}

Modified at 2026-02-27 22:33:53

Retrieve an order by Order ID.

Retrieve an order by Safe ID