Retrieve order item by Order Item ID

GET

/v1/orders/{orderId}/orderItems/{itemId}

This endpoint allows you to retrieve information about an order item using the Order Item ID.

Request

Path Params

Responses

🟢200OK

text/plain

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dev.ordermesh.io/v1/orders//orderItems/'

Response Example

200 - Success Example

{
    "orderItem": {
        "id": "65aac2a2441de72442397b63",
        "shortId": "I05790100",
        "externalId": "EXT123456",
        "sku": "MERCH-TSHIRT-BLACK-M",
        "originalSKU": "Apparel-Tshirt-Gildan-5000-M-Black-Mens",
        "quantity": 2,
        "status": "Open",
        "statusDesc": null,
        "createdAt": "2024-01-19T18:42:42.086+00:00",
        "updatedAt": "2024-01-19T18:42:50.083+00:00",
        "processedAt": "2024-01-20T09:00:00+00:00",
        "cancelledAt": null,
        "images": [
            {
                "url": "https://example.com/tshirt-front.jpg",
                "thumbnailUrl": "https://example.com/tshirt-thumbnail.jpg",
                "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"
            }
        ],
        "customerSubtotal": {
            "currency": "USD",
            "amount": 24
        },
        "customerPrice": {
            "currency": "USD",
            "amount": 12
        },
        "customerShippingPrice": {
            "currency": "USD",
            "amount": 5
        },
        "customerTaxes": {
            "currency": "USD",
            "amount": 2
        },
        "merchantPrice": {
            "currency": "USD",
            "amount": 10
        },
        "merchantShippingPrice": {
            "currency": "USD",
            "amount": 4
        },
        "merchantTax": {
            "currency": "USD",
            "amount": 1.8
        },
        "merchantSubTotal": {
            "currency": "USD",
            "amount": 20
        },
        "merchantItemTotal": {
            "currency": "USD",
            "amount": 25.8
        },
        "clientAttributes": {
            "DesignId": "D1001",
            "ProductionBatch": "B2002"
        },
        "meta": {
            "SpecialInstructions": "Handle with care"
        },
        "isSample": true,
        "skipImgManip": false,
        "skipImageValidation": false,
        "skipSkuValidation": false,
        "fulfillmentReady": null,
        "refundData": {
            "refunds": [
                {
                    "transactionId": "f0348f808fj4",
                    "isShippingRefund": true,
                    "amount": 4,
                    "reason": "Never arrived"
                },
                {
                    "transactionId": "f0348f808fj4",
                    "isShippingRefund": false,
                    "amount": 10,
                    "reason": "Poor quality."
                }
            ],
            "remainingShippingBalance": 3,
            "remainingPriceBalance": 20
        }
    }
}

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

Retrieve an order by Safe ID

Update an item within an order.