GET

Get Order


Retrieves an order with the provided ID.

To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to List Transactions For Single Order.

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
GET
https://www.wixapis.com/ecom/v1/orders/{id}

Path Params
idstringRequired

ID of the order to retrieve.

Response Object
orderOrder

The requested order.

Get Order

Gets an order with Wix Stores products.

Request
cURL
curl -X GET \ 'https://www.wixapis.com/ecom/v1/orders/58c9a790-27b7-463f-a865-c7cb494f7c29' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "order": { "id": "0d6b8d5a-e660-4d07-ab8d-5ae6604d071a", "number": "10034", "createdDate": "2024-11-12T07:31:39.688Z", "updatedDate": "2024-11-12T07:31:42.617Z", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000001", "productName": { "original": "Shoe", "translated": "Shoe" }, "catalogReference": { "catalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Color": "Black" }, "variantId": "e62fee23-7878-437a-bf0e-292f17d11cb5" } }, "quantity": 1, "totalDiscount": { "amount": "0", "formattedAmount": "$0.00" }, "descriptionLines": [ { "name": { "original": "Color", "translated": "Color" }, "colorInfo": { "original": "Black", "translated": "Black" } } ], "image": { "id": "3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg", "url": "https://static.wixstatic.com/media/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg", "height": 1000, "width": 1000 }, "physicalProperties": { "sku": "364215376135191", "shippable": true }, "itemType": { "preset": "PHYSICAL" }, "fulfillerId": "28aab679-b512-4335-b4f8-ceef5ff52a80", "refundQuantity": 0, "price": { "amount": "85.00", "formattedAmount": "$85.00" }, "priceBeforeDiscounts": { "amount": "85.00", "formattedAmount": "$85.00" }, "totalPriceBeforeTax": { "amount": "85.00", "formattedAmount": "$85.00" }, "totalPriceAfterTax": { "amount": "85.00", "formattedAmount": "$85.00" }, "paymentOption": "FULL_PAYMENT_ONLINE", "taxDetails": { "taxableAmount": { "amount": "85.00", "formattedAmount": "$85.00" }, "taxRate": "0.0", "totalTax": { "amount": "0.0", "formattedAmount": "$0.00" } } }, { "id": "00000000-0000-0000-0000-000000000002", "productName": { "original": "Watch", "translated": "Watch" }, "catalogReference": { "catalogItemId": "1a2d7e83-4bef-31d5-09e1-3326ee271c09", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium", "Color": "Grey" }, "variantId": "132b84e8-aab8-47a1-a1f6-2c47557b64a4" } }, "quantity": 1, "totalDiscount": { "amount": "0", "formattedAmount": "$0.00" }, "descriptionLines": [ { "name": { "original": "Size", "translated": "Size" }, "plainText": { "original": "Medium", "translated": "Medium" } }, { "name": { "original": "Color", "translated": "Color" }, "colorInfo": { "original": "Grey", "translated": "Grey" } } ], "image": { "id": "3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg", "url": "https://static.wixstatic.com/media/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg", "height": 1000, "width": 1000 }, "physicalProperties": { "sku": "217537123517253", "shippable": true }, "itemType": { "preset": "PHYSICAL" }, "fulfillerId": "28aab679-b512-4335-b4f8-ceef5ff52a80", "refundQuantity": 0, "price": { "amount": "30.00", "formattedAmount": "$30.00" }, "priceBeforeDiscounts": { "amount": "30.00", "formattedAmount": "$30.00" }, "totalPriceBeforeTax": { "amount": "30.00", "formattedAmount": "$30.00" }, "totalPriceAfterTax": { "amount": "30.00", "formattedAmount": "$30.00" }, "paymentOption": "FULL_PAYMENT_ONLINE", "taxDetails": { "taxableAmount": { "amount": "30.00", "formattedAmount": "$30.00" }, "taxRate": "0.0", "totalTax": { "amount": "0.0", "formattedAmount": "$0.00" } } } ], "buyerInfo": { "contactId": "24de6f0b-60ce-4faa-9138-2e39f1415615", "email": "example@example.com", "visitorId": "887f5d8c-133d-413b-b8e7-097e58128bee" }, "paymentStatus": "PARTIALLY_PAID", "fulfillmentStatus": "PARTIALLY_FULFILLED", "buyerLanguage": "en", "weightUnit": "KG", "currency": "USD", "taxIncludedInPrices": false, "priceSummary": { "subtotal": { "amount": "115.00", "formattedAmount": "$115.00" }, "shipping": { "amount": "10.0", "formattedAmount": "$10.00" }, "tax": { "amount": "0.0", "formattedAmount": "$0.00" }, "discount": { "amount": "0", "formattedAmount": "$0.00" }, "total": { "amount": "125.00", "formattedAmount": "$125.00" }, "totalAdditionalFees": { "amount": "0", "formattedAmount": "$0.00" } }, "billingInfo": { "address": { "country": "US", "subdivision": "US-NY", "city": "New York", "postalCode": "10173", "addressLine": "525 5th Avenue", "countryFullname": "United States", "subdivisionFullname": "New York" }, "contactDetails": { "firstName": "Jane", "lastName": "Doe", "phone": "0555555555" } }, "shippingInfo": { "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc", "code": "ed5bbce2-9533-dff4-7db0-13702fd139c5", "title": "Standard US Shipping", "logistics": { "deliveryTime": "", "shippingDestination": { "address": { "country": "US", "subdivision": "US-NY", "city": "New York", "postalCode": "10173", "addressLine": "525 5th Avenue", "countryFullname": "United States", "subdivisionFullname": "New York" }, "contactDetails": { "firstName": "Jane", "lastName": "Doe", "phone": "0555555555" } } }, "cost": { "price": { "amount": "10", "formattedAmount": "$10.00" }, "totalPriceBeforeTax": { "amount": "10", "formattedAmount": "$10.00" }, "totalPriceAfterTax": { "amount": "10.0", "formattedAmount": "$10.00" }, "taxDetails": { "taxRate": "0.0", "totalTax": { "amount": "0.0", "formattedAmount": "$0.00" } }, "discount": { "amount": "0", "formattedAmount": "$0.00" } }, "region": { "name": "USA shipping" } }, "status": "APPROVED", "archived": false, "taxSummary": { "totalTax": { "amount": "0.0", "formattedAmount": "$0.00" } }, "appliedDiscounts": [], "activities": [ { "createdDate": "2023-02-22T15:34:23.776Z", "type": "ORDER_PLACED" }, { "createdDate": "2023-03-07T10:16:07.508Z", "type": "TRACKING_NUMBER_ADDED" }, { "createdDate": "2023-03-07T10:16:07.508Z", "type": "TRACKING_LINK_ADDED" }, { "createdDate": "2023-03-07T10:16:34.043Z", "type": "ORDER_PARTIALLY_PAID" } ], "attributionSource": "UNSPECIFIED", "createdBy": { "visitorId": "887f5d8c-133d-413b-b8e7-097e58128bee" }, "channelInfo": { "type": "WEB" }, "seenByAHuman": true, "checkoutId": "a344eee7-26d6-4fb4-b78b-eedac185ea34", "customFields": [], "cartId": "6592eadd-3e80-489e-a9f4-93ad6447a6b8", "payNow": { "subtotal": { "amount": "115.00", "formattedAmount": "$115.00" }, "shipping": { "amount": "10.0", "formattedAmount": "$10.00" }, "tax": { "amount": "0.0", "formattedAmount": "$0.00" }, "discount": { "amount": "0", "formattedAmount": "$0.00" }, "total": { "amount": "125.00", "formattedAmount": "$125.00" } }, "balanceSummary": { "balance": { "amount": "40.00", "formattedAmount": "$40.00" }, "paid": { "amount": "85.0", "formattedAmount": "$85.00" }, "refunded": { "amount": "0", "formattedAmount": "$0.00" } }, "additionalFees": [], "purchasedDate": "2024-11-12T07:31:39.688Z" } }
Errors

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

Did this help?