Create a New Order.

POST

/v1/orders

This endpoint allows you to create new orders in the system.

Request

Body Params application/json

Examples

Responses

🟢201Created

text/plain

Created

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dev.ordermesh.io/v1/orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "safeId": "UniqueSafeID12345",
    "merchantId": "b234ee56-7890-4f12-a123-4567890abcde",
    "shippingAddress": {
        "firstName": "John",
        "lastName": "Doe",
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "line3": null,
        "city": "Anytown",
        "state": "CA",
        "zip": "90210",
        "countryCode": "US",
        "phone": "555-1234",
        "email": "john.doe@example.com"
    },
    "billingAddress": {
        "firstName": "Jane",
        "lastName": "Smith",
        "line1": "456 Oak St",
        "line2": "",
        "line3": null,
        "city": "Othertown",
        "state": "NY",
        "zip": "10001",
        "countryCode": "US",
        "phone": "555-5678",
        "email": "jane.smith@example.com"
    },
    "returnAddress": {
        "firstName": "James",
        "lastName": "Brown",
        "line1": "789 Elm St",
        "line2": "Suite 101",
        "line3": null,
        "city": "New City",
        "state": "TX",
        "zip": "73301",
        "countryCode": "US",
        "phone": "555-9876",
        "email": "james.brown@example.com"
    },
    "externalId": "ORDER123456",
    "languageCode": "EN",
    "isTest": true,
    "isSample": true,
    "client": {
        "source": "Webstore",
        "details": "Chrome browser on Windows",
        "version": "1.0",
        "ip": "192.168.1.1"
    },
    "meta": {
        "customerNote": "Please deliver between 9 AM and 5 PM.",
        "giftWrap": "true",
        "promoCode": "SUMMER2024"
    },
    "currencyCode": "USD",
    "customerShippingMethod": "Expedited",
    "customerTotal": 200.5,
    "customerItemTotal": null,
    "customerTotalShipping": 15,
    "customerTotalTaxes": 10,
    "customerTotalDiscountAndPromotions": 5.5,
    "customerPaymentMethods": [
        {
            "method": "CreditCard",
            "subMethod": "Visa",
            "cardFirst4": "4111",
            "cardLast4": "1111",
            "billingInfo": {
                "fullName": "John Doe",
                "address": {
                    "location": {
                        "longitude": -118.243683,
                        "latitude": 34.052235
                    },
                    "firstName": "John",
                    "lastName": "Doe",
                    "line1": "123 Main St",
                    "line2": "Apt 4B",
                    "line3": null,
                    "city": "Anytown",
                    "state": "CA",
                    "zip": "90210",
                    "countryCode": "US",
                    "phone": "555-1234",
                    "email": "john.doe@example.com"
                }
            },
            "customerTransactions": [
                {
                    "total": 200.5,
                    "currencyCode": "USD",
                    "transactionDate": "2024-07-16",
                    "transactionId": "TX12345678",
                    "authorizationCode": "AUTH7890"
                }
            ]
        }
    ],
    "items": [
        {
            "sku": "Accent_Mug-11oz-Blue",
            "quantity": 2,
            "images": [
                {
                    "url": "https://example.com/mug-front.jpg",
                    "thumbnailUrl": "https://example.com/mug-thumbnail.jpg",
                    "area": "Default",
                    "printMethod": null,
                    "ourPrintFileId": null,
                    "ourPrintFileUrl": null
                }
            ],
            "options": [
                {
                    "name": "Size",
                    "value": "11 oz"
                }
            ],
            "customerSubtotal": 20,
            "customerPrice": 10,
            "customerShippingPrice": 5,
            "customerTaxes": 3,
            "customerDiscountsOrPromotions": 1.5,
            "clientAttributes": {
                "occasion": "Birthday gift",
                "urgency": "high"
            },
            "meta": {
                "designId": "D123456"
            },
            "isSample": true,
            "externalId": "PROD7890123",
            "skipImgManip": false,
            "skipSkuValidation": false,
            "skipImageValidation": false,
            "fulfillmentReady": false
        },
        {
            "sku": "bella-3001cvc-solid_red_blend-s",
            "quantity": 2,
            "images": [
                {
                    "url": "https://example.com/t-shirt-front.jpg",
                    "thumbnailUrl": "https://example.com/t-shirt-front-thumbnail.jpg",
                    "area": "Front",
                    "printMethod": "DirectToGarment",
                    "ourPrintFileId": null,
                    "ourPrintFileUrl": null
                },
                {
                    "url": "https://example.com/t-shirt-back.jpg",
                    "thumbnailUrl": "https://example.com/t-shirt-back-thumbnail.jpg",
                    "area": "Back",
                    "printMethod": "DirectToGarment",
                    "ourPrintFileId": null,
                    "ourPrintFileUrl": null
                },
                {
                    "url": "https://example.com/t-shirt-label.jpg",
                    "thumbnailUrl": "https://example.com/t-shirt-label-thumbnail.jpg",
                    "area": "Neck Label",
                    "printMethod": "HeatPressNecktags",
                    "ourPrintFileId": null,
                    "ourPrintFileUrl": null
                }
            ],
            "options": [
                {
                    "name": "Size",
                    "value": "Small"
                },
                {
                    "name": "Color",
                    "value": "Red"
                }
            ],
            "customerSubtotal": 40,
            "customerPrice": 20,
            "customerShippingPrice": 5,
            "customerTaxes": 3,
            "customerDiscountsOrPromotions": 1.5,
            "clientAttributes": {
                "occasion": "Birthday gift",
                "urgency": "high"
            },
            "meta": {
                "designId": "D78910"
            },
            "isSample": true,
            "externalId": "PROD0090127",
            "skipImgManip": false,
            "skipSkuValidation": false,
            "skipImageValidation": false,
            "fulfillmentReady": false
        },
        {
            "sku": "Envelope_A6_Pointed_Blank",
            "quantity": 10,
            "images": [],
            "options": [
                {
                    "name": "type",
                    "value": "Pointed"
                }
            ],
            "customerSubtotal": 15.21,
            "customerPrice": 15.21,
            "customerShippingPrice": 10.49,
            "customerTaxes": 0,
            "customerDiscountsOrPromotions": 0,
            "clientAttributes": {
                "occasion": "OrderMesh Test"
            },
            "meta": {
                "designId": "D123456",
                "artist": "ArtistName"
            },
            "isSample": false,
            "externalId": "worfl90123",
            "skipImgManip": null,
            "skipSkuValidation": null,
            "skipImageValidation": null,
            "fulfillmentReady": true
        }
    ],
    "allowExternalOrderIdDuplication": false,
    "reprint": null,
    "automaticProcessing": true
}'

Response Example

201 - Success Example

{
    "orderId": "65af821050280f170333e831"
}

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

Search for order items based on various criteria and filters

Search for orders based on various criteria and filters.