Search for orders based on various criteria and filters.

GET

/v1/orders

This endpoint allows to you search through the orders in our system and return the information that matches your search criteria.

Note that you can use any combination of search parameters to retrieve the order information.

Request

Query Params

Responses

🟢200OK

text/plain

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dev.ordermesh.io/v1/orders?id&externalId&status&merchantIds&merchantName&customerName&createdStartDate&createdEndDate&updated&currency&customerTotal&searchAll&page&pageSize&sortBy&sortAsc&isReprint&isTest&isSample&isPollingStopped&shipmentId&shipmentShortId&shipmentExternalId&facilityNames&shipmentCreatedStartDate&shipmentCreatedEndDate&orderStatuses'

Response Example

200 - Success Example

{
    "orders": [
        {
            "isReprint": false,
            "facilityNames": [
                "Facility A",
                "Facility B"
            ],
            "shipmentCreatedDates": [
                "2024-01-22T02:26:56.56+00:00",
                "2024-01-23T02:26:56.56+00:00"
            ],
            "shipmentIds": [
                "shipment1",
                "shipment2"
            ],
            "id": "65add270441de72442397b6e",
            "shortId": "O04790082",
            "shippingAddress": {
                "location": null,
                "firstName": "Emily",
                "lastName": "Williams",
                "line1": "475 Oak Avenue",
                "line2": "Suite 2B",
                "line3": null,
                "city": "Pleasantville",
                "state": "NJ",
                "zip": "08232",
                "countryCode": "US",
                "phone": "609-555-0123",
                "email": "emily.w@example.com"
            },
            "billingAddress": {
                "location": null,
                "firstName": "Emily",
                "lastName": "Williams",
                "line1": "475 Oak Avenue",
                "line2": "Suite 2B",
                "line3": null,
                "city": "Pleasantville",
                "state": "NJ",
                "zip": "08232",
                "countryCode": "US",
                "phone": "609-555-0123",
                "email": "billing@example.com"
            },
            "returnAddress": null,
            "externalId": "75a452bf-d245-45da-9f65-a4d7957d8893",
            "safeId": "0f438c56-5ebe-4090-8d90-e0bba7cbb52c",
            "languageCode": "en",
            "customerTotal": {
                "currency": "USD",
                "amount": 30
            },
            "customerItemTotal": {
                "currency": "USD",
                "amount": 20
            },
            "customerTotalShipping": {
                "currency": "USD",
                "amount": 5
            },
            "customerTotalTaxes": {
                "currency": "USD",
                "amount": 5
            },
            "customerTotalDiscountAndPromotions": {
                "currency": "USD",
                "amount": 0
            },
            "customerPaymentMethods": [
                {
                    "method": "Debit Card",
                    "subMethod": "Visa",
                    "cardFirst4": "1234",
                    "cardLast4": "1234",
                    "billingInfo": {
                        "fullName": "Emily Williams",
                        "address": {
                            "location": null,
                            "firstName": "Emily",
                            "lastName": "Williams",
                            "line1": "475 Oak Avenue",
                            "line2": "Suite 2B",
                            "line3": null,
                            "city": "Pleasantville",
                            "state": "NJ",
                            "zip": "08232",
                            "countryCode": "US",
                            "phone": "609-555-0123",
                            "email": ""
                        }
                    },
                    "customerTransactions": [
                        {
                            "total": {
                                "currency": "USD",
                                "amount": 30
                            },
                            "transactionDate": "01/22/2024 02:26:56",
                            "transactionId": "TX12345678",
                            "authorizationCode": "AUTH7890"
                        }
                    ]
                }
            ],
            "status": "Open",
            "billingStatus": null,
            "merchantId": "46bae16f-3ccd-4afa-90d2-706551acbed7",
            "merchantName": "Test Merchant",
            "customerShippingMethod": "Standard",
            "isTest": true,
            "isSample": false,
            "createdAt": "2024-01-22T02:26:56.56+00:00",
            "updatedAt": null,
            "cancelledAt": null,
            "meta": {
                "additionalProp1": "Test"
            },
            "allowExternalOrderIdDuplication": null,
            "isPollingStopped": null,
            "automaticProcessing": null
        }
    ],
    "total": 0
}

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

Create a New Order.

Create multiple orders