POST

Search Orders


Retrieves a list of orders, given the provided paging, filtering, and sorting.

Search Orders runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100
  • filter: {"status": {"$ne": "INITIALIZED"}} - other order statuses can be queried, but orders with status: "INITIALIZED" are never returned

For field support for filters and sorting, see Orders: Supported Filters and Sorting.

To learn about working with Search endpoints, see API Query Language, and Sorting and Paging.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/orders/search

Body Params
searchSearch

Search options.

Response Object
ordersArray <Order>

List of orders.


metadataMetadata

Details on the paged set of results returned.

Searches for orders filtered by payment and fulfillment statuses; sorted by name in descending order

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/orders/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "search": { "filter": { "paymentStatus": "PAID", "fulfillmentStatus": "FULFILLED" }, "sort": [ { "fieldName": "billingInfo.contactDetails.fullName", "order": "DESC" } ], "cursorPaging": { "limit": 2 } } }'
Response
JSON
{ "orders": [ { "id": "6f759095-0701-4075-9908-c9c31ff013e1", "number": "10126", "createdDate": "2023-11-10T08:28:58.917Z", "updatedDate": "2023-11-10T08:53:44.343Z", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000001", "productName": { "original": "Indonesian Blend" }, "catalogReference": { "catalogItemId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "variantId": "00000000-0000-003f-0005-ad9cdc10d3b8" } }, "quantity": 1, "totalDiscount": { "amount": "0", "formattedAmount": "$0.00" }, "descriptionLines": [ { "name": { "original": "Weight", "translated": "Weight" }, "plainText": { "original": "500g", "translated": "500g" } }, { "name": { "original": "Ground for", "translated": "Ground for" }, "plainText": { "original": "Stovetop", "translated": "Stovetop" } }, { "name": { "original": "What would you like written on the custom label?", "translated": "What would you like written on the custom label?" }, "plainText": { "original": "", "translated": "" } } ], "image": { "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg", "url": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg", "height": 3951, "width": 2977 }, "physicalProperties": { "weight": 1, "sku": "002", "shippable": true }, "itemType": { "preset": "PHYSICAL" }, "refundQuantity": 0, "price": { "amount": "55.00", "formattedAmount": "$55.00" }, "priceBeforeDiscounts": { "amount": "55.00", "formattedAmount": "$55.00" }, "totalPriceBeforeTax": { "amount": "55.00", "formattedAmount": "$55.00" }, "totalPriceAfterTax": { "amount": "57.16", "formattedAmount": "$57.16" }, "paymentOption": "FULL_PAYMENT_ONLINE", "taxDetails": { "taxRate": "0.04", "totalTax": { "amount": "2.16", "formattedAmount": "$2.16" } } }, { "id": "00000000-0000-0000-0000-000000000002", "productName": { "original": "Special wrapping" }, "quantity": 1, "descriptionLines": [ { "name": { "original": "Note", "translated": "Note" }, "plainText": { "original": "", "translated": "" } } ], "image": { "id": "", "url": "", "height": 0, "width": 0 }, "price": { "amount": "2", "formattedAmount": "$2.00" }, "totalPriceBeforeTax": { "amount": "2", "formattedAmount": "$2.00" }, "totalPriceAfterTax": { "amount": "2", "formattedAmount": "$2.00" }, "paymentOption": "FULL_PAYMENT_ONLINE" } ], "buyerInfo": { "contactId": "eb22e6c3-ac13-4829-af78-a4ab69320dc5", "email": "johndoe@gmail.com", "memberId": "eb22e6c3-ac13-4829-af78-a4ab69320dc5" }, "paymentStatus": "PAID", "fulfillmentStatus": "FULFILLED", "buyerLanguage": "en", "weightUnit": "LB", "currency": "USD", "taxIncludedInPrices": false, "priceSummary": { "subtotal": { "amount": "57.00", "formattedAmount": "$57.00" }, "shipping": { "amount": "5.0", "formattedAmount": "$5.00" }, "tax": { "amount": "2.24", "formattedAmount": "$2.24" }, "discount": { "amount": "1", "formattedAmount": "$1.00" }, "total": { "amount": "63.24", "formattedAmount": "$63.24" }, "totalAdditionalFees": { "amount": "0", "formattedAmount": "$0.00" } }, "billingInfo": { "address": { "country": "US", "subdivision": "US-NY", "city": "New York", "postalCode": "10173", "addressLine": "525 5th Ave", "countryFullname": "United States", "subdivisionFullname": "New York" }, "contactDetails": { "firstName": "John", "lastName": "Doe", "phone": "0555555555", "company": "" } }, "shippingInfo": { "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc", "code": "a0fde0a4-6f4e-3716-64be-c0acbde1696a", "title": "U.S Shipping", "logistics": { "deliveryTime": "3 - 5 business days", "shippingDestination": { "address": { "country": "US", "subdivision": "US-NY", "city": "New York", "postalCode": "10173", "addressLine": "525 5th Ave", "countryFullname": "United States", "subdivisionFullname": "New York" }, "contactDetails": { "firstName": "John", "lastName": "Doe", "phone": "0555555555", "company": "" } } }, "cost": { "price": { "amount": "5", "formattedAmount": "$5.00" }, "totalPriceBeforeTax": { "amount": "5", "formattedAmount": "$5.00" }, "totalPriceAfterTax": { "amount": "5", "formattedAmount": "$5.00" }, "taxDetails": { "taxRate": "0", "totalTax": { "amount": "0", "formattedAmount": "$0.00" } }, "discount": { "amount": "0", "formattedAmount": "$0.00" } }, "region": { "name": "Region 3" } }, "status": "APPROVED", "archived": false, "taxSummary": { "totalTax": { "amount": "2.24", "formattedAmount": "$2.24" } }, "appliedDiscounts": [ { "discountType": "GLOBAL", "lineItemIds": [], "merchantDiscount": { "amount": { "amount": "1", "formattedAmount": "$1.00" }, "description": "Nice customer" } } ], "activities": [ { "createdDate": "2023-11-10T08:28:58.917Z", "type": "ORDER_PLACED" }, { "createdDate": "2023-11-10T08:53:15.209Z", "type": "ORDER_PAID" }, { "createdDate": "2023-11-10T08:53:28.800Z", "type": "ORDER_FULFILLED" }, { "createdDate": "2023-11-10T08:53:42.637Z", "type": "TRACKING_NUMBER_ADDED" }, { "createdDate": "2023-11-10T08:53:42.637Z", "type": "TRACKING_LINK_ADDED" }, { "createdDate": "2023-11-10T08:53:44.343Z", "type": "SHIPPING_CONFIRMATION_EMAIL_SENT" } ], "attributionSource": "UNSPECIFIED", "createdBy": { "userId": "4a5954f0-8c60-4975-8210-c995c00f6077" }, "channelInfo": { "type": "BACKOFFICE_MERCHANT" }, "seenByAHuman": true, "customFields": [], "cartId": "", "balanceSummary": { "balance": { "amount": "0.00", "formattedAmount": "$0.00" }, "paid": { "amount": "63.24", "formattedAmount": "$63.24" }, "refunded": { "amount": "0", "formattedAmount": "$0.00" } }, "additionalFees": [] }, { "id": "5b5cfd4a-814c-4beb-b364-5ab65d13f296", "number": "10125", "createdDate": "2023-11-10T08:22:33.705Z", "updatedDate": "2023-11-10T08:52:26.704Z", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000001", "productName": { "original": "Ethiopian Yirgacheffe", "translated": "Ethiopian Yirgacheffe" }, "catalogReference": { "catalogItemId": "4d93fb7e-e612-612f-5c27-81b35b503ad7", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Weight": "500g", "Ground for": "Stovetop" }, "variantId": "00000000-0000-0000-0000-000000000000", "customTextFields": { "What would you like us to print on the custom label?": "Hope you enjoy the coffee! :)" } } }, "quantity": 1, "totalDiscount": { "amount": "2.0", "formattedAmount": "$2.00" }, "descriptionLines": [ { "name": { "original": "Weight", "translated": "Weight" }, "plainText": { "original": "500g", "translated": "500g" } }, { "name": { "original": "Ground for", "translated": "Ground for" }, "plainText": { "original": "Stovetop", "translated": "Stovetop" } }, { "name": { "original": "What would you like us to print on the custom label?", "translated": "What would you like us to print on the custom label?" }, "plainText": { "original": "", "translated": "" } } ], "image": { "id": "nsplsh_3653676645776b41303259~mv2.jpg", "url": "https://static.wixstatic.com/media/nsplsh_3653676645776b41303259~mv2.jpg/v1/fit/w_8440,h_5626,q_90/file.jpg", "height": 5626, "width": 8440 }, "physicalProperties": { "shippable": true }, "itemType": { "preset": "PHYSICAL" }, "refundQuantity": 0, "price": { "amount": "36.00", "formattedAmount": "$36.00" }, "priceBeforeDiscounts": { "amount": "36.00", "formattedAmount": "$36.00" }, "totalPriceBeforeTax": { "amount": "34.00", "formattedAmount": "$34.00" }, "totalPriceAfterTax": { "amount": "35.36", "formattedAmount": "$35.36" }, "paymentOption": "FULL_PAYMENT_ONLINE", "taxDetails": { "taxableAmount": { "amount": "34.0", "formattedAmount": "$34.00" }, "taxRate": "0.04", "totalTax": { "amount": "1.36", "formattedAmount": "$1.36" } } }, { "id": "00000000-0000-0000-0000-000000000002", "productName": { "original": "Indonesian Blend (no variants)", "translated": "Indonesian Blend (no variants)" }, "catalogReference": { "catalogItemId": "c329246b-d521-feb4-85f5-539ca992d73a", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": {}, "variantId": "00000000-0000-0000-0000-000000000000", "customTextFields": { "What would you like us to print on the custom label?": "This is great for filter coffee" } } }, "quantity": 1, "totalDiscount": { "amount": "0", "formattedAmount": "$0.00" }, "descriptionLines": [ { "name": { "original": "What would you like written on the custom label?", "translated": "What would you like written on the custom label?" }, "plainText": { "original": "This is great for filter coffee.", "translated": "This is great for filter coffee." } } ], "image": { "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg", "url": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg", "height": 3951, "width": 2977 }, "physicalProperties": { "shippable": true }, "itemType": { "preset": "PHYSICAL" }, "refundQuantity": 0, "price": { "amount": "35.00", "formattedAmount": "$35.00" }, "priceBeforeDiscounts": { "amount": "35.00", "formattedAmount": "$35.00" }, "totalPriceBeforeTax": { "amount": "35.00", "formattedAmount": "$35.00" }, "totalPriceAfterTax": { "amount": "36.40", "formattedAmount": "$36.40" }, "paymentOption": "FULL_PAYMENT_ONLINE", "taxDetails": { "taxableAmount": { "amount": "35.00", "formattedAmount": "$35.00" }, "taxRate": "0.04", "totalTax": { "amount": "1.4", "formattedAmount": "$1.40" } } } ], "buyerInfo": { "contactId": "eb22e6c3-ac13-4829-af78-a4ab69320dc5", "email": "johndoe@gmail.com", "visitorId": "97eb5dd7-f805-4e19-8194-285b519b9676" }, "paymentStatus": "PAID", "fulfillmentStatus": "FULFILLED", "buyerLanguage": "en", "weightUnit": "LB", "currency": "USD", "taxIncludedInPrices": false, "priceSummary": { "subtotal": { "amount": "71.00", "formattedAmount": "$71.00" }, "shipping": { "amount": "5.0", "formattedAmount": "$5.00" }, "tax": { "amount": "2.76", "formattedAmount": "$2.76" }, "discount": { "amount": "2.0", "formattedAmount": "$2.00" }, "total": { "amount": "76.76", "formattedAmount": "$76.76" }, "totalAdditionalFees": { "amount": "0", "formattedAmount": "$0.00" } }, "billingInfo": { "address": { "country": "US", "subdivision": "US-NY", "city": "New York", "postalCode": "10173", "addressLine": "525 5th Ave", "countryFullname": "United States", "subdivisionFullname": "New York" }, "contactDetails": { "firstName": "John", "lastName": "Doe", "phone": "0555555555" } }, "shippingInfo": { "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc", "code": "a0fde0a4-6f4e-3716-64be-c0acbde1696a", "title": "U.S Shipping", "logistics": { "deliveryTime": "3 - 5 business days", "shippingDestination": { "address": { "country": "US", "subdivision": "US-NY", "city": "New York", "postalCode": "10173", "addressLine": "525 5th Ave", "countryFullname": "United States", "subdivisionFullname": "New York" }, "contactDetails": { "firstName": "John", "lastName": "Doe", "phone": "3800000000" } } }, "cost": { "price": { "amount": "5", "formattedAmount": "$5.00" }, "totalPriceBeforeTax": { "amount": "5", "formattedAmount": "$5.00" }, "totalPriceAfterTax": { "amount": "5.0", "formattedAmount": "$5.00" }, "taxDetails": { "taxRate": "0.0", "totalTax": { "amount": "0.0", "formattedAmount": "$0.00" } }, "discount": { "amount": "0", "formattedAmount": "$0.00" } }, "region": { "name": "Region 3" } }, "status": "APPROVED", "archived": false, "taxSummary": { "totalTax": { "amount": "2.76", "formattedAmount": "$2.76" }, "manualTaxRate": "0.04" }, "appliedDiscounts": [ { "discountType": "SPECIFIC_ITEMS", "lineItemIds": ["00000000-0000-0000-0000-000000000001"], "coupon": { "id": "454f30aa-e6bc-4897-9e96-063e3746d232", "code": "PROMO2023", "name": "PROMO2023", "amount": { "amount": "2.0", "formattedAmount": "$2.00" } } } ], "activities": [ { "createdDate": "2023-11-10T08:22:33.705Z", "type": "ORDER_PLACED" }, { "createdDate": "2023-11-10T08:22:40.458Z", "type": "ORDER_PAID" }, { "createdDate": "2023-11-10T08:52:22.044Z", "type": "TRACKING_NUMBER_ADDED" }, { "createdDate": "2023-11-10T08:52:22.044Z", "type": "TRACKING_LINK_ADDED" }, { "createdDate": "2023-11-10T08:52:26.704Z", "type": "SHIPPING_CONFIRMATION_EMAIL_SENT" } ], "attributionSource": "UNSPECIFIED", "createdBy": { "visitorId": "97eb5dd7-f805-4e19-8194-285b519b9676" }, "channelInfo": { "type": "WEB" }, "seenByAHuman": true, "checkoutId": "9fb34efc-89d0-4788-976a-220d798d476f", "customFields": [], "cartId": "2697e98f-8aa0-4de6-9fea-3ee04e17829b", "payNow": { "subtotal": { "amount": "71.00", "formattedAmount": "$71.00" }, "shipping": { "amount": "5.0", "formattedAmount": "$5.00" }, "tax": { "amount": "2.76", "formattedAmount": "$2.76" }, "discount": { "amount": "2.0", "formattedAmount": "$2.00" }, "total": { "amount": "76.76", "formattedAmount": "$76.76" } }, "balanceSummary": { "balance": { "amount": "0.00", "formattedAmount": "$0.00" }, "paid": { "amount": "76.76", "formattedAmount": "$76.76" }, "refunded": { "amount": "0", "formattedAmount": "$0.00" } }, "additionalFees": [] } ], "metadata": { "count": 2, "cursors": { "next": "74bb42d4afd5d41e98b120b7ea54538c4ee3ea34.EqQBCgxjdXN0b21lck5hbWUakwEakAEwSmRwdjhDcXVQWTBVQ0ZUdGRnaFh1Y293cTB6WmFwMkhPVXVofE4wVDlBNlB0Zk1vQ05XREV3SzlndGJkaUVydmlUenZTcHk5UXxZSUZhV0pxZlFsUnBseVJYZHR2UjEwWFF5SkxCdFZuZll2aXQycklCRXI4QXVOWXZYOTNRcjB0SmV2MFdaN1ZiM3MwPT0SCRoFGgMxLjAgARIOGgoaCDIwOTQ5MTQ1IAEi2gEK1wEKBCRhbmQSzgEyywEKoAEqnQEKmgEKBCRhbmQSkQEyjgEKJiokCiIKDXBheW1lbnRTdGF0dXMSESoPCg0KAyRlcRIGGgRQQUlECmQqYgpgCgQkYW5kElgyVgovKi0KKwoRZnVsZmlsbG1lbnRTdGF0dXMSFioUChIKAyRlcRILGglGVUxGSUxMRUQKIyohCh8KBnN0YXR1cxIVKhMKEQoDJG5lEgoaCENBTkNFTEVECiYqJAoiCgZzdGF0dXMSGCoWChQKAyRuZRINGgtJTklUSUFMSVpFRCoECgJlbjABOgBQAloTcHJpdmF0ZS9lY29tL29yZGVycw" }, "hasNext": true } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?