The eCommerce Orders API allows apps or site owners to customize management of the order lifecycle, including viewing, updating, and canceling. In the dashboard, business staff can create new orders, view and edit existing orders, track fulfillment, and manage the payments cycle.
An order holds information about purchased items, price and tax summaries, shipping and billing information, any applied discounts, and the status of payment and fulfillment.
With the eCommerce Orders API you can:
If you are migrating from the Stores Orders API, please refer to the following conversion tables:
This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.
Some eCommerce functionality is accessible by using an order's ID and passing it to other eCommerce APIs. Here are a few examples:
When an order is made on an external system, you may want to record it and its payment details on your app.
To record an external order:
id
from the Create Order API's response.id
, along with the external order's payments details, to Add Payments. This will add a record of the payment associated with the order.The following table shows field support for filters and sorting for the Order object:
Field | Supported Filtering | Sortable |
---|---|---|
id | $eq , $ne , $in , $nin | |
number | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
status | $eq , $ne , $in , $nin | Sortable |
archived | $eq , $ne , $in , $exists , $startsWith | |
createdDate | $eq , $ne , $lt , $lte , $gte , $gt , $nin | Sortable |
updatedDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
lineItems.productName.original | $eq , $ne , $in , $nin , $hasSome , $hasAll | |
lineItems.catalogReference.appId | $eq , $ne , $in , $nin , $hasSome , $hasAll | |
lineItems.catalogReference.catalogItemId | $eq , $ne , $in , $nin , $hasSome , $hasAll | |
subscriptionInfo.id | $eq , $ne , $in , $nin | |
buyerInfo.email | $eq , $ne , $in , $exists , $startsWith | Sortable |
buyerInfo.contactId | $eq , $ne , $in , $nin | |
buyerInfo.memberId | $eq , $ne , $in , $nin | |
paymentStatus | $eq , $ne , $in , $nin | Sortable |
fulfillmentStatus | $eq , $ne , $in , $nin | Sortable |
priceSummary.total.amount | $eq , $ne , $gt , $lt , $gte , $lte | |
billingInfo.contactDetails.fullName | $eq , $ne , $in , $exists , $startsWith | |
shippingInfo.title | $eq , $ne , $in , $nin | |
shippingInfo.logistics.deliveryTime | $eq , $ne , $in , $exists , $startsWith | |
shippingInfo.region.name | $eq , $ne , $in , $nin | |
deliveryTimeSlotFromDate (See notes) | $eq , $ne , $in , $exists , $startsWith | |
deliveryTimeSlotToDate (See notes) | $eq , $ne , $in , $exists , $startsWith | |
createdBy.userId | $eq , $ne , $in , $nin | |
channelInfo.type | $eq , $ne , $in , $nin | |
channelInfo.externalOrderId | $eq , $ne , $in , $nin | |
seenByAHuman | $eq , $ne , $in , $exists , $startsWith | |
checkoutId | $eq , $ne , $in , $nin | |
paymentMethods (See notes) | $eq , $ne , $in , $nin , $hasSome , $hasAll | |
fulfillmentStatuses (See notes) | $eq , $ne , $in , $nin , $hasSome , $hasAll |
Notes:
deliveryTimeSlotFromDate
- shorthand for the shippingInfo.logistics.deliveryTimeSlot.from
field.deliveryTimeSlotToDate
- shorthand for the shippingInfo.logistics.deliveryTimeSlot.to
field.paymentMethods
- aggregate of the orderTransactions.payments.regularPaymentDetails.paymentMethod
field from the Order Transactions API.fulfillmentStatuses
- shorthand for the fulfillmentStatusesAggregate
field.Related content: API Query Language, Search Orders
To help with migration to the eCommerce Orders API, refer to the table below for field changes between the Stores order object and the eCommerce order object.
Note that some fields are accessible via other eCommerce APIs like Order Transactions or Order Fulfillments. In these cases, the way to access the info is described in the third column.
The address object used in the eCommerce APIs is slightly different to the one used in the Stores APIs. For more details, refer to the address object conversion table.
The eCommerce Order Updated event fires when a Stores order and/or an eCommerce order is updated. For more details on webhooks, refer to the Webhook Conversion Table below.
Fields marked with an asterisk (*) signify little to no change in semantics or access.
Stores Order Object | eCommerce Order Object | Notes |
---|---|---|
id * | id | |
number * | number | |
dateCreated | createdDate | |
buyerInfo.id | buyerInfo.contactId & buyerInfo.memberId | |
buyerInfo.id and buyerInfo.identityType: "MEMBER" | buyerInfo.memberId | |
buyerInfo.id and buyerInfo.identityType: "CONTACT" | buyerInfo.contactId | |
buyerInfo.firstName | billingInfo.contactDetails.firstName | |
buyerInfo.lastName | billingInfo.contactDetails.lastName | |
buyerInfo.phone | billingInfo.contactDetails.phone | |
buyerInfo.email * | buyerInfo.email | |
currency * | currency | |
weightUnit * | weightUnit | |
totals.subtotal | priceSummary.subtotal.amount | |
totals.shipping | priceSummary.shipping.amount | |
totals.tax | priceSummary.tax.amount | |
totals.discount | priceSummary.discount.amount | |
totals.total | priceSummary.total.amount | |
totals.weight | An order's total weight is equal to (lineItems[0].physicalProperties.weight X lineItems[0].quantity) + (lineItems[1].physicalProperties.weight X lineItems[1].quantity) and so on. | |
totals.quantity | An order's total line item quantity is equal to lineItems[0].quantity + lineItems[1].quantity + lineItems[2].quantity and so on. | |
totals.refund | balanceSummary.refunded.amount | |
totals.giftCard | orderTransactions.payments[i].amount when orderTransactions.payments[i].giftcardPaymentDetails has value. Available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
billingInfo.paymentMethod | orderTransactions.payments[i].regularPaymentDetails.paymentMethod , available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
billingInfo.paymentProviderTransactionId | orderTransactions.payments[i].regularPaymentDetails.providerTransactionId , available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
billingInfo.paymentGatewayTransactionId | orderTransactions.payments[i].regularPaymentDetails.gatewayTransactionId , available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
billingInfo.paidDate | orderTransactions.payments[i].createdDate , available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
billingInfo.refundableByPaymentProvider = true | orderTransactions.payments[i].refundDisabled = false , available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
billingInfo.address * | billingInfo.address | Address object conversion table. |
shippingInfo.code * | shippingInfo.code | |
shippingInfo.deliverByDate | shippingInfo.logistics.deliverByDate | |
shippingInfo.deliveryOption | shippingInfo.title | |
shippingInfo.shippingRegion | shippingInfo.region.name | |
shippingInfo.shippingDetails.address | shippingInfo.logistics.shippingDestination.address | Address object conversion table. |
shippingInfo.shipmentDetails.discount | shippingInfo.cost.discount.amount | |
shippingInfo.shipmentDetails.tax | shippingInfo.cost.taxDetails.totalTax.amount | |
shippingInfo.shipmentDetails.priceData.taxIncludedInPrice | taxIncludedInPrices | |
shippingInfo.shipmentDetails.priceData.price | shippingInfo.cost.totalPriceAfterTax.amount | |
shippingInfo.pickupDetails.pickupAddress | shippingInfo.logistics.pickupDetails.address | Address object conversion table. |
shippingInfo.pickupDetails.pickupInstructions | shippingInfo.logistics.instructions | |
shippingInfo.estimatedDeliveryTime | shippingInfo.logistics.deliveryTime | |
buyerNote * | buyerNote | |
archived * | archived | |
paymentStatus * | paymentStatus | |
paymentStatus: PENDING | status: INITIALIZED | |
fulfillmentStatus * | fulfillmentStatus | For more info, pass an order ID to the List Fulfillments For Single Order endpoint. |
fulfillmentStatus: CANCELED | status: CANCELED | |
lineItems[i].index | lineItems[i].id | While the lineItems[i].index in Stores Orders was an int32 type, the eCommerce Order's lineItems[i].id field is of type GUID. |
lineItems[i].quantity * | lineItems[i].quantity | |
lineItems[i].name | lineItems[i].productName.original | |
lineItems[i].translatedName | lineItems[i].productName.translated | |
lineItems[i].productId | lineItems[i].catalogReference.catalogItemId | The catalogReference object links between eCommerce APIs and catalogs like Wix Stores. Learn more about eCommerce integration for Wix Stores. |
lineItems[i].lineItemType: "PHYSICAL" | lineItems[i].itemType.preset: "PHYSICAL" | |
lineItems[i].lineItemType: "DIGITAL" | lineItems[i].itemType.preset: "DIGITAL" | |
lineItems[i].lineItemType: "CUSTOM_AMOUNT_ITEM" | lineItems[i].itemType.custom and lineItems[i].catalogReference is empty. | |
lineItems[i].options | lineItems[i].descriptionLines | |
lineItems[i].customTextFields | lineItems[i].catalogReference.options | Within the catalogReference.options look for the customTextFields key. |
lineItems[i].weight | lineItems[i].physicalProperties.weight | |
lineItems[i].mediaItem.url | lineItems[i].image.url | |
lineItems[i].mediaItem.height | lineItems[i].image.height | |
lineItems[i].mediaItem.width | lineItems[i].image.width | |
lineItems[i].mediaItem.id | lineItems[i].image.id | |
lineItems[i].mediaItem.altText | lineItems[i].image.altText | |
lineItems[i].sku | lineItems[i].physicalProperties.sku | |
lineItems[i].notes | lineItems[i].descriptionLines[i].plainText.original | |
lineItems[i].variantId | lineItems[i].catalogReference.options | The catalogReference object links between eCommerce APIs and catalogs like Wix Stores. Learn more about eCommerce integration for Wix Stores. |
lineItems[i].fulfillerId * | lineItems[i].fulfillerId | |
lineItems[i].discount | lineItems[i].totalDiscount.amount | |
lineItems[i].tax | lineItems[i].taxDetails.totalTax.amount | |
lineItems[i].priceData.taxIncludedInPrice | taxIncludedInPrices | |
lineItems[i].priceData.price | lineItems[i].price.amount | |
lineItems[i].priceData.totalPrice | lineItems[i].totalPriceAfterTax.amount | |
activities[i].type * | activities[i].type | |
activities[i].TRACKING_LINK_WAS_SET | activities[i].TRACKING_LINK_SET | |
activities[i].INVOICE_WAS_SET | activities[i].INVOICE_ADDED | |
activities[i].INVOICE_WAS_SENT | activities[i].INVOICE_SENT | |
activities[i].author | activities[i].authorEmail | |
activities[i].message | activities[i].merchantComment.message | If activities.type = "MERCHANT_COMMENT" |
activities[i].timestamp | activities[i].createdDate | |
invoiceInfo | Not available in eCommerce order object. | Currently, this information is held in the Stores order object. |
fulfillments | Not available in eCommerce order object. | For more info, pass an order ID to the List Fulfillments For Single Order endpoint. |
discount.appliedCoupon.couponId | appliedDiscounts[i].coupon.id | Search the appliedDiscounts array for the coupon field; couponId is coupon.id |
discount.appliedCoupon.name | appliedDiscounts[i].coupon.name | Search the appliedDiscounts array for the coupon field; name is coupon.name |
discount.appliedCoupon.code | appliedDiscounts[i].coupon.code | Search the appliedDiscounts array for the coupon field; code is coupon.code |
customField.value | customFields[i].value.stringValue | Note: customFields is an array |
customField.title | customFields[i].title | |
customField.translatedTitle | customFields[i].translatedTitle | |
cartId | Not returned in the eCommerce order object. | Replaced by checkoutId |
buyerLanguage * | buyerLanguage | |
channelInfo.type * | channelInfo.type | |
channelInfo.externalOrderId * | channelInfo.externalOrderId | |
channelInfo.externalOrderUrl * | channelInfo.externalOrderUrl | |
enteredBy.id and enteredBy.identityType: "MEMBER" | createdBy.memberId | |
enteredBy.id and enteredBy.identityType: "USER" | createdBy.userId | |
enteredBy.id and enteredBy.identityType: "APP" | createdBy.appId | |
enteredBy.id and enteredBy.identityType: "CONTACT" | createdBy.visitorId | Previously, for a buyer that is not logged in, CONTACT type and ID were returned. in the eCommerce API, visitorId is returned. Note: the ID itself will also be different. |
lastUpdated | updatedDate | |
numericId | - | Removed due to added cursor paging functionality |
refunds | orderTransactions.refunds , available via Order Transactions. | Pass the order ID to the List Transactions For Single Order endpoint to retrieve this info. |
*Fields marked with an asterisk signify little to no change in semantics or access.
The following table shows Stores Orders webhooks and their equivalents in the eCommerce Orders API that are triggered at the same time:
Stores Orders API | eCommerce Orders API |
---|---|
Order Paid Webhook | Payment Status Updated Webhook sent with order.paymentStatus = PAID |
Order Created Webhook | Order Approved Webhook |
Order Canceled Webhook | Order Canceled Webhook |
Order Refunded Webhook | Order Transactions Updated Webhook |
We've also updated the structure of the webhook/event payload. The event's order ID is now provided both at the top level as entityId
and as order.id
within the payload itself. The table below describes where to find the order ID or order entity in the new webhook payloads:
Stores Webhooks | eCommerce Webhooks |
---|---|
Order ID - order.id / orderId | All order webhook payloads - entityId |
Order Created - the payload itself is the order | Order Approved - actionEvent.body.order |
Order Paid/Canceled/Refunded - order | Order Canceled/Approved - actionEvent.body.order |
- | Order Updated - updatedEvent.currentEntity |
The eCommerce APIs use a different address
object. Notably, fields related to contact information have been moved
to an adjacent contactDetails
object (for example, in order.shippingInfo
).
To help with conversion and migration, refer to the table below to check which fields have changed and how.
Note: in the eCommerce API, the buyer's email is only held in the buyerInfo
field in the eCommerce Order object.
Previous Address Object | eCommerce Address Field Location | Change |
---|---|---|
address.city | address.city | |
address.email | buyerInfo.email | |
address.zipCode | address.postalCode | Field name |
address.country | address.country | |
address.addressLine1 | address.addressLine | Field name |
address.addressLine2 | address.addressLine2 | |
address.street | address.streetAddress | Field name |
address.subdivision | address.subdivision | |
address.fullName.firstName | contactDetails.firstName | Moved to contactDetails object |
address.fullName.lastName | contactDetails.lastName | Moved to contactDetails object |
address.phone | contactDetails.phone | Moved to contactDetails object |
address.company | contactDetails.company | Moved to contactDetails object |
address.vatId | contactDetails.vatId | Moved to contactDetails object |
Notes:
We’re introducing a new Wix eCommerce Orders API that enables business owners to meet new customer needs and provide better customer service. This will eventually replace the existing Stores Orders API. This quick guide will help you to make sure your app is ready for the migration.
The structure of the eCommerce Order object is different from the Stores Order object. You can learn more about these structural changes here.
The webhook payload structure has also changed. To facilitate your move to these webhooks, have a look at the webhook conversion table.
Customers occasionally make mistakes when placing an order, or they might simply want to make a change to an existing order. This could include adding items, updating prices, revising customer details, and more.
The new eCommerce service includes functionality that lets users edit existing orders. This will be known as Draft Orders when using our REST APIs, and as Edit Order in the dashboard.
When an existing order is edited, the Order Updated Webhook is triggered. This webhook returns the whole order object in the eCommerce order structure, but you can still pass the edited order’s ID to the Stores Orders endpoints if you’d like to fetch the order in the Stores structure.
If a Wix user edits an existing order, depending on your app type you might need your app to be aware of the change. Here are some examples:
Edit Order is not yet available publicly, but if you’d like to test the feature yourself and understand any implications it may have for your app, follow these steps:
petri-ovr
and fill out the following fields:specs.stores.OrderEditPageComponent#true
.wix.com
Note:
All orders, including changes committed by Edit Order, are still available in the Stores Orders APIs and webhooks. However, we highly recommend planning your transition to eCommerce Orders and Edit Order/Draft Orders, as the Stores Orders API will be deprecated in the coming months.
Create and manage eCommerce orders
Order ID.
Order number displayed in the site owner's dashboard (auto-generated).
Date and time the order was created in ISO-8601 format.
Date and time the order was last updated in ISO-8601 format.
Order line items.
Buyer information.
Order payment status.
Order fulfillment status.
Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.
Weight measurement unit - defaults to site's weight unit.
Currency used for the pricing of this order in ISO-4217 format.
Whether tax is included in line item prices.
Site language in which original values are shown.
Order price summary.
Billing address and contact details.
Shipping info and selected shipping option details.
Buyer note left by the customer.
Order status.
Whether order is archived.
Tax summary.
Deprecated. Use taxInfo
instead.
This field will be removed on September 30, 2024.
Tax information.
Applied discounts.
Order activities.
Order attribution source.
ID of the order's initiator.
Information about the sales channel that submitted this order.
Whether a human has seen the order. Set when an order is clicked on in the dashboard.
Checkout ID.
Custom fields.
Balance summary.
Additional fees applied to the order.
Custom field data for the order object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
Order recipient address and contact details.
This field may differ from the address in shippingInfo.logistics
when:
Date and time the order was originally purchased in ISO-8601 format. Used for migration from external systems.
{
"order": {
"id": "5e402679-69e4-4329-9cc1-25d607cdfaca",
"number": "10033",
"createdDate": "2024-11-11T12:00:41.492Z",
"updatedDate": "2024-11-11T12:00:41.492Z",
"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-11T12:00:41.492Z"
}
}
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.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the order to retrieve.
The requested order.
Gets an order with Wix Stores products.
curl -X GET \
'https://www.wixapis.com/ecom/v1/orders/58c9a790-27b7-463f-a865-c7cb494f7c29' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{
"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"
}
}
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
ordercursorPaging.limit
is 100
filter: {"status": {"$ne": "INITIALIZED"}}
- other order statuses can be queried, but orders with status: "INITIALIZED"
are never returnedFor 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.
You can only call this method when authenticated as a Wix app or Wix user identity.
Search options.
List of orders.
Details on the paged set of results returned.
Searches for orders filtered by payment and fulfillment statuses; sorted by name in descending order
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
}
}
}'
{
"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
}
}
Creates an order.
Notes:
lineItems[i].itemType.preset: DIGITAL
- then lineItems[i].digitalFile
must be provided.lineItems[i].id
is passed, it must be either a valid GUID, or empty.You can only call this method when authenticated as a Wix app or Wix user identity.
Order info.
Newly created order.
Creates an order with Wix Stores and Wix Bookings items.
curl -X POST \
'https://www.wixapis.com/ecom/v1/orders' \
-H 'Content-type: application/json' \
-H 'Authorization: <AUTH>' \
--data-binary '{
"order": {
"buyerInfo": {
"contactId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c",
"email": "johndoe@gmail.com",
"memberId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c"
},
"priceSummary": {
"subtotal": {
"amount": "28.00",
"formattedAmount": "$28.00"
},
"shipping": {
"amount": "5",
"formattedAmount": "$5.00"
},
"tax": {
"amount": "0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"total": {
"amount": "32.00",
"formattedAmount": "$32.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": "4a43a709-d4a0-e07e-33e6-9c8618796577",
"title": "Standard 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"
}
},
"region": {
"name": "Region 4"
}
},
"status": "APPROVED",
"lineItems": [
{
"id": "da4004fd-2ee3-48fa-bb7d-7624f1005348",
"productName": {
"original": "Ethiopian Yirgacheffe"
},
"catalogReference": {
"catalogItemId": "93162737-1553-9cd6-6581-b1555bc150bf",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"variantId": "3051f244-bb16-40c3-bd91-64fe27fbfbd1"
}
},
"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 us to print on the custom label?",
"translated": "What would you like us to print on the custom label?"
},
"plainText": {
"original": "",
"translated": ""
}
}
],
"image": {
"id": "4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg",
"url": "https://static.wixstatic.com/media/4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg/v1/fit/w_1500,h_1000,q_90/file.jpg",
"height": 1000,
"width": 1500
},
"physicalProperties": {
"sku": "",
"shippable": true
},
"itemType": {
"preset": "PHYSICAL"
},
"price": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"taxDetails": {
"taxRate": "0",
"totalTax": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"totalPriceBeforeTax": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"totalPriceAfterTax": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"lineItemPrice": {
"amount": "18.00",
"formattedAmount": "$18.00"
}
},
{
"id": "99479044-23e6-4dbb-9644-9104e4d99ee2",
"productName": {
"original": "Barista masterclass"
},
"catalogReference": {
"catalogItemId": "8c449785-80ab-48ba-8d35-5d123a7a25b8",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"options": {}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"descriptionLines": [],
"item_type": {
"preset": "SERVICE"
},
"price": {
"amount": "10",
"formattedAmount": "$10.00"
},
"taxDetails": {
"taxRate": "0",
"totalTax": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"totalPriceBeforeTax": {
"amount": "10",
"formattedAmount": "$10.00"
},
"totalPriceAfterTax": {
"amount": "10",
"formattedAmount": "$10.00"
},
"paymentOption": "FULL_PAYMENT_OFFLINE",
"locations": [],
"lineItemPrice": {
"amount": "10",
"formattedAmount": "$10.00"
}
}
],
"archived": false,
"appliedDiscounts": [
{
"discountType": "GLOBAL",
"lineItemIds": [],
"merchantDiscount": {
"amount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"description": "Nice customer"
},
"id": "7dcf2c6d-7fda-4733-b997-fe83b087083b"
}
],
"createdBy": {
"userId": "4a5954f0-8c60-4975-8210-c995c00f6077"
},
"channelInfo": {
"type": "BACKOFFICE_MERCHANT"
},
"paymentStatus": "NOT_PAID",
"seenByAHuman": true,
"balanceSummary": {
"balance": {
"amount": "32.00",
"formattedAmount": "$32.00"
}
},
"weightUnit": "LB",
"currency": "USD",
"taxIncludedInPrices": false,
"buyerLanguage": "en"
}
}'
{
"order": {
"id": "6da768ad-3c9f-444a-9465-7ae0b89fd305",
"number": "10107",
"createdDate": "2024-01-04T13:57:09.968Z",
"updatedDate": "2024-01-04T13:57:09.968Z",
"lineItems": [
{
"id": "da4004fd-2ee3-48fa-bb7d-7624f1005348",
"productName": {
"original": "Ethiopian Yirgacheffe"
},
"catalogReference": {
"catalogItemId": "93162737-1553-9cd6-6581-b1555bc150bf",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"variantId": "3051f244-bb16-40c3-bd91-64fe27fbfbd1"
}
},
"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"
}
},
{
"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": "4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg",
"url": "https://static.wixstatic.com/media/4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg/v1/fit/w_1500,h_1000,q_90/file.jpg",
"height": 1000,
"width": 1500
},
"physicalProperties": {
"sku": "",
"shippable": true
},
"itemType": {
"preset": "PHYSICAL"
},
"price": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"totalPriceBeforeTax": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"totalPriceAfterTax": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"taxDetails": {
"taxRate": "0",
"totalTax": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"locations": [],
"lineItemPrice": {
"amount": "18.00",
"formattedAmount": "$18.00"
}
},
{
"id": "99479044-23e6-4dbb-9644-9104e4d99ee2",
"productName": {
"original": "Barista masterclass"
},
"catalogReference": {
"catalogItemId": "8c449785-80ab-48ba-8d35-5d123a7a25b8",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"options": {}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"descriptionLines": [],
"itemType": {
"preset": "SERVICE"
},
"price": {
"amount": "10",
"formattedAmount": "$10.00"
},
"totalPriceBeforeTax": {
"amount": "10",
"formattedAmount": "$10.00"
},
"totalPriceAfterTax": {
"amount": "10",
"formattedAmount": "$10.00"
},
"paymentOption": "FULL_PAYMENT_OFFLINE",
"taxDetails": {
"taxRate": "0",
"totalTax": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"locations": [],
"lineItemPrice": {
"amount": "10",
"formattedAmount": "$10.00"
}
}
],
"buyerInfo": {
"contactId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c",
"email": "johndoe@gmail.com",
"memberId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c"
},
"paymentStatus": "NOT_PAID",
"fulfillmentStatus": "PARTIALLY_FULFILLED",
"buyerLanguage": "en",
"weightUnit": "LB",
"currency": "USD",
"taxIncludedInPrices": false,
"priceSummary": {
"subtotal": {
"amount": "28.00",
"formattedAmount": "$28.00"
},
"shipping": {
"amount": "5",
"formattedAmount": "$5.00"
},
"tax": {
"amount": "0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"total": {
"amount": "32.00",
"formattedAmount": "$32.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": "4a43a709-d4a0-e07e-33e6-9c8618796577",
"title": "Standard 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"
}
},
"region": {
"name": "Region 4"
}
},
"status": "APPROVED",
"archived": false,
"appliedDiscounts": [
{
"discountType": "GLOBAL",
"lineItemIds": [],
"merchantDiscount": {
"amount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"description": "Nice customer"
},
"id": "7dcf2c6d-7fda-4733-b997-fe83b087083b"
}
],
"activities": [
{
"id": "8b010b96-5272-4d40-862a-ad579a90a074",
"createdDate": "2024-01-04T12:02:10.501Z",
"type": "ORDER_PLACED"
}
],
"attributionSource": "UNSPECIFIED",
"createdBy": {
"userId": "4a5954f0-8c60-4975-8210-c995c00f6077"
},
"channelInfo": {
"type": "BACKOFFICE_MERCHANT"
},
"seenByAHuman": true,
"customFields": [],
"balanceSummary": {
"balance": {
"amount": "32.00",
"formattedAmount": "$32.00"
}
},
"additionalFees": []
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Updates an order's properties.
Currently, only the following fields can be updated:
order.buyerInfo.email
order.buyerLanguage
order.weightUnit
order.billingInfo.address
order.billingInfo.contactDetails
order.archived
order.attributionSource
order.seenByAHuman
order.recipientInfo.address
order.recipientInfo.contactDetails
order.shippingInfo.logistics.shippingDestination.address
order.shippingInfo.logistics.shippingDestination.contactDetails
order.extendedFields
To update a field's value, include the new value in the order
object in the body params.
To remove a field's value, pass null
.
Note: Removing buyerInfo
or contactDetails
results in an error.
To update an order's payment status, use Update Payment Status.
You can only call this method when authenticated as a Wix app or Wix user identity.
Order ID.
Order to be updated.
Newly created order.
Updates buyer's email.
curl -X PATCH \
'https://www.wixapis.com/ecom/v1/orders/6da768ad-3c9f-444a-9465-7ae0b89fd305' \
-H 'Content-type: application/json' \
-H 'Authorization: <AUTH>' \
--data-binary '{
"order": {
"buyerInfo": {
"email": "a-new-buyerInfo-email@gmail.com"
}
}
}'
{
"order": {
"id": "6da768ad-3c9f-444a-9465-7ae0b89fd305",
"number": "10107",
"createdDate": "2024-01-04T13:57:09.968Z",
"updatedDate": "2024-01-17T15:06:43.658Z",
"lineItems": [
{
"id": "da4004fd-2ee3-48fa-bb7d-7624f1005348",
"productName": {
"original": "Ethiopian Yirgacheffe"
},
"catalogReference": {
"catalogItemId": "93162737-1553-9cd6-6581-b1555bc150bf",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"variantId": "3051f244-bb16-40c3-bd91-64fe27fbfbd1"
}
},
"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"
}
},
{
"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": "4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg",
"url": "https://static.wixstatic.com/media/4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg/v1/fit/w_1500,h_1000,q_90/file.jpg",
"height": 1000,
"width": 1500
},
"physicalProperties": {
"sku": "",
"shippable": true
},
"itemType": {
"preset": "PHYSICAL"
},
"price": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"totalPriceBeforeTax": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"totalPriceAfterTax": {
"amount": "18.00",
"formattedAmount": "$18.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"taxDetails": {
"taxRate": "0",
"totalTax": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"locations": [],
"lineItemPrice": {
"amount": "18.00",
"formattedAmount": "$18.00"
}
},
{
"id": "99479044-23e6-4dbb-9644-9104e4d99ee2",
"productName": {
"original": "Barista masterclass"
},
"catalogReference": {
"catalogItemId": "8c449785-80ab-48ba-8d35-5d123a7a25b8",
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"options": {}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"descriptionLines": [],
"itemType": {
"preset": "SERVICE"
},
"price": {
"amount": "10",
"formattedAmount": "$10.00"
},
"totalPriceBeforeTax": {
"amount": "10",
"formattedAmount": "$10.00"
},
"totalPriceAfterTax": {
"amount": "10",
"formattedAmount": "$10.00"
},
"paymentOption": "FULL_PAYMENT_OFFLINE",
"taxDetails": {
"taxRate": "0",
"totalTax": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"locations": [],
"lineItemPrice": {
"amount": "10",
"formattedAmount": "$10.00"
}
}
],
"buyerInfo": {
"contactId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c",
"email": "a-new-buyerInfo-email@gmail.com",
"memberId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c"
},
"paymentStatus": "NOT_PAID",
"fulfillmentStatus": "PARTIALLY_FULFILLED",
"buyerLanguage": "en",
"weightUnit": "LB",
"currency": "USD",
"taxIncludedInPrices": false,
"priceSummary": {
"subtotal": {
"amount": "28.00",
"formattedAmount": "$28.00"
},
"shipping": {
"amount": "5",
"formattedAmount": "$5.00"
},
"tax": {
"amount": "0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"total": {
"amount": "32.00",
"formattedAmount": "$32.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": "4a43a709-d4a0-e07e-33e6-9c8618796577",
"title": "Standard 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"
}
},
"region": {
"name": "Region 4"
}
},
"status": "APPROVED",
"archived": false,
"appliedDiscounts": [
{
"discountType": "GLOBAL",
"lineItemIds": [],
"merchantDiscount": {
"amount": {
"amount": "1",
"formattedAmount": "$1.00"
},
"description": "Nice customer"
},
"id": "7dcf2c6d-7fda-4733-b997-fe83b087083b"
}
],
"activities": [
{
"id": "8b010b96-5272-4d40-862a-ad579a90a074",
"createdDate": "2024-01-04T12:02:10.501Z",
"type": "ORDER_PLACED"
}
],
"attributionSource": "UNSPECIFIED",
"createdBy": {
"userId": "4a5954f0-8c60-4975-8210-c995c00f6077"
},
"channelInfo": {
"type": "BACKOFFICE_MERCHANT"
},
"seenByAHuman": true,
"customFields": [],
"balanceSummary": {
"balance": {
"amount": "32.00",
"formattedAmount": "$32.00"
},
"paid": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"refunded": {
"amount": "0.00",
"formattedAmount": "$0.00"
}
},
"additionalFees": [],
"recipientInfo": {
"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": ""
}
}
}
}
There are 2 errors with this status code:
See the entire list and learn more about Wix errors.
Updates properties of up to 100 orders.
Currently, only the following fields can be updated:
order.buyerInfo.email
order.buyerLanguage
order.weightUnit
order.billingInfo.address
order.billingInfo.contactDetails
order.archived
order.attributionSource
order.seenByAHuman
order.recipientInfo.address
order.recipientInfo.contactDetails
order.shippingInfo.logistics.shippingDestination.address
order.shippingInfo.logistics.shippingDestination.contactDetails
order.extendedFields
To update a field's value, include the new value in the order
object in the body params.
To remove a field's value, pass null
.
Note: Removing (passing null
to) buyerInfo
or contactDetails
results in an error.
To update an order's payment status, use Update Payment Status.
You can only call this method when authenticated as a Wix app or Wix user identity.
Orders to update.
Whether to return the full order entities.
Default: false
Bulk action results.
Bulk action metadata.
Bulk updates archived
status for 2 orders.
curl -X POST \
'https://www.wixapis.com/ecom/v1/bulk/orders/update' \
-H 'Content-type: application/json' \
-H 'Authorization: <AUTH>' \
--data-binary '{
"orders": [
{
"order": {
"id": "efc0f204-d83a-4391-b576-e9cf816f6bc9",
"archived": true
}
},
{
"order": {
"id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff",
"archived": true
}
}
],
"returnEntity": false
}'
{
"results": [
{
"itemMetadata": {
"id": "efc0f204-d83a-4391-b576-e9cf816f6bc9",
"originalIndex": 0,
"success": true
}
},
{
"itemMetadata": {
"id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff",
"originalIndex": 1,
"success": true
}
}
],
"bulkActionMetadata": {
"totalSuccesses": 2,
"totalFailures": 0,
"undetailedFailures": 0
}
}
Cancels an order. The order.status
field changes to CANCELED
.
You can only call this method when authenticated as a Wix app or Wix user identity.
Order ID.
Whether to send an order canceled email to the buyer.
Custom note to be added to the email (optional).
Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory.
Canceled order.
Cancels an order, sends order cancellation email with custom message, and restocks all items
curl -X POST \
'https://www.wixapis.com/ecom/v1/orders/7001d34b-11a6-4a34-8746-dc8ababeca42/cancel' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
--data-binary '{
"sendOrderCanceledEmail": true,
"customMessage": "Canceled due to incorrect quantity ordered",
"restockAllItems": true
}'
{
"order": {
"id": "7001d34b-11a6-4a34-8746-dc8ababeca42",
"number": "10012",
"createdDate": "2023-03-07T10:24:03.380Z",
"updatedDate": "2023-09-10T11:19:33.792Z",
"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": "Brown"
},
"variantId": "2f430d69-9b75-4874-bfbd-c5f6fa5aff3d"
}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"descriptionLines": [
{
"name": {
"original": "Color",
"translated": "Color"
},
"colorInfo": {
"original": "Brown",
"translated": "Brown"
}
}
],
"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"
},
"refundQuantity": 0,
"restockQuantity": 1,
"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": "Large",
"Color": "Black"
},
"variantId": "63f56c6d-8dcb-491c-8e06-0220b3cd89f2"
}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"descriptionLines": [
{
"name": {
"original": "Size",
"translated": "Size"
},
"plainText": {
"original": "Large",
"translated": "Large"
}
},
{
"name": {
"original": "Color",
"translated": "Color"
},
"colorInfo": {
"original": "Black",
"translated": "Black"
}
}
],
"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"
},
"refundQuantity": 0,
"restockQuantity": 1,
"price": {
"amount": "35.00",
"formattedAmount": "$35.00"
},
"priceBeforeDiscounts": {
"amount": "35.00",
"formattedAmount": "$35.00"
},
"totalPriceBeforeTax": {
"amount": "35.00",
"formattedAmount": "$35.00"
},
"totalPriceAfterTax": {
"amount": "35.00",
"formattedAmount": "$35.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"taxDetails": {
"taxableAmount": {
"amount": "35.00",
"formattedAmount": "$35.00"
},
"taxRate": "0.0",
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
}
},
{
"id": "00000000-0000-0000-0000-000000000003",
"productName": {
"original": "Shirt",
"translated": "Shirt"
},
"catalogReference": {
"catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"options": {},
"variantId": "00000000-0000-0000-0000-000000000000"
}
},
"quantity": 1,
"totalDiscount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"descriptionLines": [],
"image": {
"id": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg",
"url": "https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg",
"height": 1000,
"width": 1000
},
"physicalProperties": {
"sku": "364115376135191",
"shippable": true
},
"itemType": {
"preset": "PHYSICAL"
},
"refundQuantity": 0,
"restockQuantity": 1,
"price": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"priceBeforeDiscounts": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"totalPriceBeforeTax": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"totalPriceAfterTax": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"taxDetails": {
"taxableAmount": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"taxRate": "0.0",
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
}
}
],
"buyerInfo": {
"contactId": "24de6f0b-60ce-4faa-9138-2e39f1415615",
"email": "example@email.com",
"visitorId": "887f5d8c-133d-413b-b8e7-097e58128bee"
},
"paymentStatus": "PARTIALLY_PAID",
"fulfillmentStatus": "NOT_FULFILLED",
"buyerLanguage": "en",
"weightUnit": "KG",
"currency": "USD",
"taxIncludedInPrices": false,
"priceSummary": {
"subtotal": {
"amount": "130.00",
"formattedAmount": "$130.00"
},
"shipping": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"total": {
"amount": "130.00",
"formattedAmount": "$130.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"
}
},
"buyerNote": "Happy Birthday!",
"status": "CANCELED",
"archived": false,
"taxSummary": {
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
},
"appliedDiscounts": [
{
"discountType": "SPECIFIC_ITEMS",
"lineItemIds": ["00000000-0000-0000-0000-000000000003"],
"coupon": {
"id": "fbb94b06-7447-4161-9c48-59bfcdc39e77",
"code": "SUMMERSALE10",
"name": "SUMMERSALE10",
"amount": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
}
}
],
"activities": [
{
"createdDate": "2023-03-07T10:24:03.380Z",
"type": "ORDER_PLACED"
},
{
"createdDate": "2023-03-07T10:24:56.406Z",
"type": "TRACKING_NUMBER_ADDED"
},
{
"createdDate": "2023-03-07T10:24:56.406Z",
"type": "TRACKING_LINK_ADDED"
},
{
"createdDate": "2023-03-07T10:25:22.889Z",
"type": "ORDER_PARTIALLY_PAID"
},
{
"createdDate": "2023-03-07T11:51:48.321Z",
"type": "TRACKING_NUMBER_ADDED"
},
{
"createdDate": "2023-03-07T11:51:48.321Z",
"type": "TRACKING_LINK_ADDED"
},
{
"createdDate": "2023-09-10T11:19:33.792Z",
"type": "ORDER_CANCELED"
}
],
"attributionSource": "UNSPECIFIED",
"createdBy": {
"visitorId": "887f5d8c-133d-413b-b8e7-097e58128bee"
},
"channelInfo": {
"type": "WEB"
},
"seenByAHuman": true,
"checkoutId": "d118aa97-1bcb-462e-9265-3603f6e07df6",
"customFields": [],
"cartId": "1e61e838-d3a0-4ab7-8348-b37d1d954919",
"payNow": {
"subtotal": {
"amount": "130.00",
"formattedAmount": "$130.00"
},
"shipping": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"total": {
"amount": "130.00",
"formattedAmount": "$130.00"
}
},
"balanceSummary": {
"balance": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"paid": {
"amount": "120.0",
"formattedAmount": "$120.00"
},
"refunded": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"additionalFees": []
}
}
There are 3 errors with this status code:
See the entire list and learn more about Wix errors.
Triggered when an order's payment status is updated to "PAID"
.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.order
.
Event name. Expected payment_status_updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.ecom.v1.order_payment_status_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "03756f6a-62c6-4f85-8356-b171adb7e4f3",
"slug": "payment_status_updated",
"entityId": "880fa895-dfd5-4d50-a2d4-971b03fd4b86",
"entityFqdn": "wix.ecom.v1.order",
"eventTime": "2022-12-21T13:37:43.471496Z",
"actionEvent": {
"body": {
"order": {
"number": "10002",
"additionalFees": [],
"cartId": "866a0cf8-d7ec-4ec5-b20f-08cf33d8ad74",
"lineItems": [
{
"physicalProperties": {
"sku": "364115376135191",
"shippable": true
},
"quantity": 1,
"paymentOption": "FULL_PAYMENT_ONLINE",
"image": {
"id": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg",
"url": "https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg",
"height": 1000,
"width": 1000
},
"price": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"totalPriceBeforeTax": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"totalPriceAfterTax": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"priceBeforeDiscounts": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"totalDiscount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"id": "00000000-0000-0000-0000-000000000001",
"itemType": {
"preset": "PHYSICAL"
},
"taxDetails": {
"taxableAmount": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"taxRate": "0.0",
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
},
"productName": {
"original": "Shirt",
"translated": "Shirt"
},
"descriptionLines": [],
"catalogReference": {
"catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"options": {},
"variantId": "00000000-0000-0000-0000-000000000000"
}
},
"refundQuantity": 0
}
],
"paymentStatus": "PAID",
"archived": false,
"seenByAHuman": true,
"shippingInfo": {
"code": "ed5bbce2-9533-dff4-7db0-13702fd139c5",
"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"
}
},
"logistics": {
"deliveryTime": "",
"shippingDestination": {
"address": {
"city": "New York",
"countryFullname": "United States",
"subdivisionFullname": "New York",
"addressLine": "525 5th Avenue",
"country": "US",
"postalCode": "10173",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555"
}
}
},
"carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc",
"region": {
"name": "USA shipping"
},
"title": "Standard US Shipping"
},
"activities": [
{
"createdDate": "2022-12-21T13:30:36.798Z",
"type": "ORDER_PLACED"
}
],
"appliedDiscounts": [
{
"discountType": "SPECIFIC_ITEMS",
"lineItemIds": ["00000000-0000-0000-0000-000000000001"],
"coupon": {
"id": "fbb94b06-7447-4161-9c48-59bfcdc39e77",
"code": "SUMMERSALE10",
"name": "SUMMERSALE10",
"amount": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
}
}
],
"customFields": [],
"taxIncludedInPrices": false,
"attributionSource": "UNSPECIFIED",
"weightUnit": "KG",
"priceSummary": {
"totalAdditionalFees": {
"amount": "0",
"formattedAmount": "$0.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"total": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"subtotal": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"discount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"shipping": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
},
"id": "880fa895-dfd5-4d50-a2d4-971b03fd4b86",
"status": "APPROVED",
"billingInfo": {
"address": {
"city": "New York",
"countryFullname": "United States",
"subdivisionFullname": "New York",
"addressLine": "525 5th Avenue",
"country": "US",
"postalCode": "10173",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555"
}
},
"buyerInfo": {
"contactId": "24de6f0b-60ce-4faa-9138-2e39f1415615",
"email": "janedoe@gmail.com",
"visitorId": "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
},
"payNow": {
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"total": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"subtotal": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"discount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"shipping": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
},
"createdBy": {
"visitorId": "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
},
"taxSummary": {
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
},
"currency": "USD",
"balanceSummary": {
"balance": {
"amount": "0.00",
"formattedAmount": "$0.00"
}
},
"updatedDate": "2022-12-21T13:37:43.380Z",
"checkoutId": "6f1204d5-3923-4709-869e-51680a1b5530",
"buyerLanguage": "en",
"channelInfo": {
"type": "WEB"
},
"fulfillmentStatus": "NOT_FULFILLED",
"createdDate": "2022-12-21T13:30:36.798Z"
},
"previousPaymentStatus": "NOT_PAID"
}
},
"triggeredByAnonymizeRequest": false
}
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.order
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.ecom.v1.order_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "096a8672-f3bc-47fa-b092-0f7fe6780fef",
"entityFqdn": "wix.ecom.v1.order",
"slug": "updated",
"entityId": "d0b4b995-9138-4455-a8cf-fc2333cc9a37",
"updatedEvent": {
"currentEntity": {
"id": "d0b4b995-9138-4455-a8cf-fc2333cc9a37",
"number": "16056",
"createdDate": "2023-09-20T08:55:57.558Z",
"updatedDate": "2023-09-20T08:56:16.685Z",
"lineItems": [
{
"id": "00000000-0000-0000-0000-000000000001",
"productName": {
"original": "The Craft Pottery Painting Gift Voucher",
"translated": "The Craft Pottery Painting Gift Voucher"
},
"catalogReference": {
"catalogItemId": "e488929a-5927-4b55-97de-06ad02489e7c",
"appId": "d80111c5-a0f4-47a8-b63a-65b54d774a27",
"options": {
"currency": "GBP",
"quantity": 1.0,
"variantId": "1",
"giftingInfo": {
"recipientInfo": {
"email": "janedoe@gmail.com",
"lastName": "",
"firstName": "Jane"
},
"greetingMessage": "Happy Birthday Jane! We love you!! 🤍🤍"
}
}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "£0.00"
},
"descriptionLines": [
{
"name": {
"original": "",
"translated": ""
},
"plainText": {
"original": "25",
"translated": "25"
}
},
{
"name": {
"original": "",
"translated": ""
},
"plainText": {
"original": "Amira ",
"translated": "Amira "
}
},
{
"name": {
"original": "",
"translated": ""
},
"plainText": {
"original": "janedoe@gmail.com",
"translated": "janedoe@gmail.com"
}
},
{
"name": {
"original": "",
"translated": ""
},
"plainText": {
"original": "Happy Birthday Amira! We love you!! 🤍🤍",
"translated": "Happy Birthday Amira! We love you!! 🤍🤍"
}
}
],
"image": {
"id": "e90a2a_c3de803545f340df9dd4aa88a72e0718~mv2.png",
"url": "https://static.wixstatic.com/media/e90a2a_c3de803545f340df9dd4aa88a72e0718~mv2.png/v1/fit/w_600,h_600,q_90/file.png",
"height": 600,
"width": 1050
},
"physicalProperties": {
"shippable": false
},
"itemType": {
"preset": "GIFT_CARD"
},
"refundQuantity": 0,
"price": {
"amount": "25",
"formattedAmount": "£25.00"
},
"priceBeforeDiscounts": {
"amount": "25",
"formattedAmount": "£25.00"
},
"totalPriceBeforeTax": {
"amount": "25",
"formattedAmount": "£25.00"
},
"totalPriceAfterTax": {
"amount": "25.0",
"formattedAmount": "£25.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"taxDetails": {
"taxableAmount": {
"amount": "25",
"formattedAmount": "£25.00"
},
"taxRate": "0.0",
"totalTax": {
"amount": "0.0",
"formattedAmount": "£0.00"
}
}
}
],
"buyerInfo": {
"contactId": "7dcf17a6-825a-466e-a78e-c4abea0217db",
"email": "janedoe@gmail.com",
"visitorId": "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
},
"paymentStatus": "PAID",
"fulfillmentStatus": "NOT_FULFILLED",
"buyerLanguage": "en",
"weightUnit": "KG",
"currency": "GBP",
"taxIncludedInPrices": false,
"priceSummary": {
"subtotal": {
"amount": "25.0",
"formattedAmount": "£25.00"
},
"shipping": {
"amount": "0",
"formattedAmount": "£0.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "£0.00"
},
"discount": {
"amount": "0",
"formattedAmount": "£0.00"
},
"total": {
"amount": "25.0",
"formattedAmount": "£25.00"
},
"totalAdditionalFees": {
"amount": "0",
"formattedAmount": "£0.00"
}
},
"billingInfo": {
"address": {
"city": "New York",
"countryFullname": "United States",
"subdivisionFullname": "New York",
"addressLine": "525 5th Avenue",
"country": "US",
"postalCode": "10173",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555"
}
},
"status": "APPROVED",
"archived": false,
"taxSummary": {
"totalTax": {
"amount": "0.0",
"formattedAmount": "£0.00"
},
"manualTaxRate": "0"
},
"appliedDiscounts": [],
"activities": [
{
"createdDate": "2023-09-20T08:55:57.558Z",
"type": "ORDER_PLACED"
}
],
"attributionSource": "UNSPECIFIED",
"createdBy": {
"visitorId": "81fdda65-32bd-4252-9156-9c2319a7a5aa"
},
"channelInfo": {
"type": "WEB"
},
"seenByAHuman": false,
"checkoutId": "5c87d9cb-a84c-41e2-b2cd-d46d6403d57d",
"customFields": [],
"cartId": "",
"payNow": {
"subtotal": {
"amount": "25.0",
"formattedAmount": "£25.00"
},
"shipping": {
"amount": "0",
"formattedAmount": "£0.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "£0.00"
},
"discount": {
"amount": "0",
"formattedAmount": "£0.00"
},
"total": {
"amount": "25.0",
"formattedAmount": "£25.00"
}
},
"balanceSummary": {
"balance": {
"amount": "0.0",
"formattedAmount": "£0.00"
},
"paid": {
"amount": "25.0",
"formattedAmount": "£25.00"
},
"refunded": {
"amount": "0",
"formattedAmount": "£0.00"
}
},
"additionalFees": []
}
},
"eventTime": "2023-09-20T08:56:16.746967Z",
"triggeredByAnonymizeRequest": false
}
Triggered when an order is created and its status is updated to "APPROVED"
.
Learn more about eCommerce webhook payload structure.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.order
.
Event name. Expected approved
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.ecom.v1.order_approved",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "162075ea-7271-411b-b555-de545e8e6f38",
"entityFqdn": "wix.ecom.v1.order",
"slug": "approved",
"entityId": "e994ac9d-26b0-4f81-8047-00a2e964d6bf",
"actionEvent": {
"body": {
"order": {
"id": "e994ac9d-26b0-4f81-8047-00a2e964d6bf",
"number": "10002",
"createdDate": "2024-01-28T05:32:47.346Z",
"updatedDate": "2024-01-28T14:16:58.520Z",
"lineItems": [
{
"id": "00000000-0000-0000-0000-000000000001",
"productName": {
"original": "MENU PREBIOTIC",
"translated": "MENU PREBIOTICO"
},
"catalogReference": {
"catalogItemId": "58620c7f-6bd5-ec74-c139-3bf17ff10151",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"options": {},
"variantId": "00000000-0000-0000-0000-000000000000"
}
},
"quantity": 1,
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"descriptionLines": [],
"image": {
"id": "a409be_82ef75d567d645d6adc4df0a8f415cff~mv2.png",
"url": "https://static.wixstatic.com/media/a409be_82ef75d567d645d6adc4df0a8f415cff~mv2.png/v1/fit/w_1080,h_1080,q_90/file.png",
"height": 1080,
"width": 1080
},
"physicalProperties": {
"sku": "",
"shippable": false
},
"itemType": {
"preset": "DIGITAL"
},
"price": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"priceBeforeDiscounts": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"totalPriceBeforeTax": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"totalPriceAfterTax": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"paymentOption": "FULL_PAYMENT_ONLINE",
"taxDetails": {
"taxableAmount": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"taxRate": "0",
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
},
"digitalFile": {
"fileId": "a409be_3f0ebf7df29c4d7cabbfc0cd81693b2b.pdf",
"expirationDate": "2024-02-27T05:32:47.346Z"
},
"locations": [],
"lineItemPrice": {
"amount": "249.00",
"formattedAmount": "$249.00"
}
}
],
"buyerInfo": {
"contactId": "24de6f0b-60ce-4faa-9138-2e39f1415615",
"email": "janedoe@example.com",
"visitorId": "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
},
"paymentStatus": "PAID",
"fulfillmentStatus": "FULFILLED",
"buyerLanguage": "en",
"weightUnit": "KG",
"currency": "MXN",
"taxIncludedInPrices": false,
"siteLanguage": "en",
"priceSummary": {
"subtotal": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"shipping": {
"amount": "0",
"formattedAmount": "$0.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"total": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"totalAdditionalFees": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"billingInfo": {
"address": {
"city": "New York",
"countryFullname": "United States",
"subdivisionFullname": "New York",
"addressLine": "525 5th Avenue",
"country": "US",
"postalCode": "10173",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555"
}
},
"status": "APPROVED",
"archived": false,
"taxSummary": {
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"manualTaxRate": "0"
},
"appliedDiscounts": [],
"activities": [
{
"id": "9b530b37-c34c-4364-8fa7-c83410ebadbd",
"createdDate": "2024-01-28T05:32:47.346Z",
"type": "ORDER_PLACED"
},
{
"id": "d8ea672c-04fb-45a6-8f31-0c7705ba4941",
"createdDate": "2024-01-28T14:16:58.306Z",
"type": "ORDER_PAID"
}
],
"attributionSource": "UNSPECIFIED",
"createdBy": {},
"channelInfo": {
"type": "WEB"
},
"checkoutId": "885e30c9-720b-419e-a42b-af2497de56fa",
"customFields": [],
"cartId": "86db2e7c-be00-49de-8204-c9375f9fc553",
"payNow": {
"subtotal": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"shipping": {
"amount": "0",
"formattedAmount": "$0.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"discount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"total": {
"amount": "249.00",
"formattedAmount": "$249.00"
},
"totalAdditionalFees": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"balanceSummary": {
"balance": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"paid": {
"amount": "249.0",
"formattedAmount": "$249.00"
},
"refunded": {
"amount": "0",
"formattedAmount": "$0.00"
}
},
"additionalFees": [],
"purchaseFlowId": "2e6a8926-2997-4294-b871-7176cfbc3566"
}
}
},
"eventTime": "2024-01-28T14:16:58.826960306Z",
"triggeredByAnonymizeRequest": false
}
Triggered when an order is canceled. Learn more about eCommerce webhook payload structure.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.order
.
Event name. Expected canceled
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.ecom.v1.order_canceled",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "e63c782f-ba2c-4bde-a17f-d0ba6df1b608",
"slug": "canceled",
"entityId": "880fa895-dfd5-4d50-a2d4-971b03fd4b86",
"entityFqdn": "wix.ecom.v1.order",
"eventTime": "2022-12-21T13:49:24.655445Z",
"actionEvent": {
"body": {
"order": {
"number": "10002",
"additionalFees": [],
"cartId": "866a0cf8-d7ec-4ec5-b20f-08cf33d8ad74",
"lineItems": [
{
"physicalProperties": {
"sku": "364115376135191",
"shippable": true
},
"quantity": 1,
"paymentOption": "FULL_PAYMENT_ONLINE",
"image": {
"id": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg",
"url": "https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg",
"height": 1000,
"width": 1000
},
"price": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"totalPriceBeforeTax": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"totalPriceAfterTax": {
"amount": "0.00",
"formattedAmount": "$0.00"
},
"priceBeforeDiscounts": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"totalDiscount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"id": "00000000-0000-0000-0000-000000000001",
"itemType": {
"preset": "PHYSICAL"
},
"taxDetails": {
"taxableAmount": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"taxRate": "0.0",
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
},
"productName": {
"original": "Shirt",
"translated": "Shirt"
},
"descriptionLines": [],
"catalogReference": {
"catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"options": {},
"variantId": "00000000-0000-0000-0000-000000000000"
}
},
"refundQuantity": 0
}
],
"paymentStatus": "PAID",
"archived": false,
"seenByAHuman": true,
"shippingInfo": {
"code": "ed5bbce2-9533-dff4-7db0-13702fd139c5",
"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"
}
},
"logistics": {
"deliveryTime": "",
"shippingDestination": {
"address": {
"city": "New York",
"countryFullname": "United States",
"subdivisionFullname": "New York",
"addressLine": "525 5th Avenue",
"country": "US",
"postalCode": "10173",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555"
}
}
},
"carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc",
"region": {
"name": "USA shipping"
},
"title": "Standard US Shipping"
},
"activities": [
{
"createdDate": "2022-12-21T13:30:36.798Z",
"type": "ORDER_PLACED"
},
{
"createdDate": "2022-12-21T13:37:43.545Z",
"type": "ORDER_PAID"
},
{
"createdDate": "2022-12-21T13:40:53.582Z",
"type": "ORDER_FULFILLED"
},
{
"createdDate": "2022-12-21T13:47:35.833Z",
"type": "ORDER_NOT_FULFILLED"
},
{
"createdDate": "2022-12-21T13:49:24.613Z",
"type": "ORDER_CANCELED"
}
],
"appliedDiscounts": [
{
"discountType": "SPECIFIC_ITEMS",
"lineItemIds": ["00000000-0000-0000-0000-000000000001"],
"coupon": {
"id": "fbb94b06-7447-4161-9c48-59bfcdc39e77",
"code": "SUMMERSALE10",
"name": "SUMMERSALE10",
"amount": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
}
}
],
"customFields": [],
"taxIncludedInPrices": false,
"attributionSource": "UNSPECIFIED",
"weightUnit": "KG",
"priceSummary": {
"totalAdditionalFees": {
"amount": "0",
"formattedAmount": "$0.00"
},
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"total": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"subtotal": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"discount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"shipping": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
},
"id": "880fa895-dfd5-4d50-a2d4-971b03fd4b86",
"status": "CANCELED",
"billingInfo": {
"address": {
"city": "New York",
"countryFullname": "United States",
"subdivisionFullname": "New York",
"addressLine": "525 5th Avenue",
"country": "US",
"postalCode": "10173",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555"
}
},
"buyerInfo": {
"contactId": "24de6f0b-60ce-4faa-9138-2e39f1415615",
"email": "janedoe@gmail.com",
"visitorId": "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
},
"payNow": {
"tax": {
"amount": "0.0",
"formattedAmount": "$0.00"
},
"total": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"subtotal": {
"amount": "10.00",
"formattedAmount": "$10.00"
},
"discount": {
"amount": "10.0",
"formattedAmount": "$10.00"
},
"shipping": {
"amount": "10.0",
"formattedAmount": "$10.00"
}
},
"createdBy": {
"visitorId": "4c7ce95c-9fb3-417d-9f02-b41e82b841f7"
},
"taxSummary": {
"totalTax": {
"amount": "0.0",
"formattedAmount": "$0.00"
}
},
"currency": "USD",
"balanceSummary": {
"balance": {
"amount": "0.00",
"formattedAmount": "$0.00"
}
},
"updatedDate": "2022-12-21T13:49:24.613Z",
"checkoutId": "6f1204d5-3923-4709-869e-51680a1b5530",
"buyerLanguage": "en",
"channelInfo": {
"type": "WEB"
},
"fulfillmentStatus": "NOT_FULFILLED",
"createdDate": "2022-12-21T13:30:36.798Z"
},
"restockAllItems": false,
"sendOrderCanceledEmail": false,
"customMessage": "Ordered by mistake"
}
},
"triggeredByAnonymizeRequest": false
}
Triggered when an order is created. Learn more about webhook payload structure.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.order
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.ecom.v1.order_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "89db87be-f1b9-40a4-9bd4-cc4ef0804824",
"entityFqdn": "wix.ecom.v1.order",
"slug": "created",
"entityId": "a4738c5d-98d6-45e4-bc88-4e5940acacfd",
"createdEvent": {
"entity": {
"number": "10133",
"additionalFees": [],
"lineItems": [
{
"physicalProperties": {
"sku": "",
"shippable": true
},
"quantity": 1,
"paymentOption": "FULL_PAYMENT_ONLINE",
"image": {
"id": "nsplsh_3653676645776b41303259~mv2.jpg",
"url": "https://static.wixstatic.com/media/nsplsh_3653676645776b41303259~mv2.jpg",
"height": 5626,
"width": 8440
},
"price": {
"amount": "36.00",
"formattedAmount": "$36.00"
},
"totalPriceBeforeTax": {
"amount": "36.00",
"formattedAmount": "$36.00"
},
"totalPriceAfterTax": {
"amount": "37.36",
"formattedAmount": "$37.36"
},
"totalDiscount": {
"amount": "0",
"formattedAmount": "$0.00"
},
"id": "77514cbe-cafa-4ef6-ae47-4f4e86271a5c",
"itemType": {
"preset": "PHYSICAL"
},
"taxDetails": {
"taxRate": "0.04",
"totalTax": {
"amount": "1.36",
"formattedAmount": "$1.36"
}
},
"productName": {
"original": "Ethiopian Yirgacheffe"
},
"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": ""
}
}
],
"catalogReference": {
"catalogItemId": "4d93fb7e-e612-612f-5c27-81b35b503ad7",
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
"options": {
"options": {
"Weight": "500g",
"Ground for": "Stovetop"
}
}
}
}
],
"paymentStatus": "NOT_PAID",
"archived": false,
"shippingInfo": {
"code": "a0fde0a4-6f4e-3716-64be-c0acbde1696a",
"cost": {
"price": {
"amount": "5",
"formattedAmount": "$5.00"
},
"totalPriceBeforeTax": {
"amount": "5",
"formattedAmount": "$5.00"
},
"totalPriceAfterTax": {
"amount": "5",
"formattedAmount": "$5.00"
}
},
"logistics": {
"deliveryTime": "3 - 5 business days",
"shippingDestination": {
"address": {
"city": "New York",
"countryFullname": "United States",
"addressLine": "235 West 23rd Street, 3rd floor",
"country": "US",
"postalCode": "10011",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555",
"company": ""
}
}
},
"carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc",
"region": {
"name": "Region 3"
},
"title": "U.S Shipping"
},
"activities": [
{
"id": "d01387d3-f89a-453d-8870-03d3f652cba2",
"createdDate": "2023-12-05T10:48:58.226Z",
"type": "ORDER_PLACED"
}
],
"appliedDiscounts": [
{
"discountType": "GLOBAL",
"lineItemIds": [],
"merchantDiscount": {
"amount": {
"amount": "2",
"formattedAmount": "$2.00"
},
"description": "Nice customer"
},
"id": "1d4b2e8f-d9b4-423d-8fcb-d5b046a41dba"
}
],
"customFields": [],
"taxIncludedInPrices": false,
"attributionSource": "UNSPECIFIED",
"weightUnit": "LB",
"priceSummary": {
"totalAdditionalFees": {
"amount": "0",
"formattedAmount": "$0.00"
},
"tax": {
"amount": "1.56",
"formattedAmount": "$1.56"
},
"total": {
"amount": "40.56",
"formattedAmount": "$40.56"
},
"subtotal": {
"amount": "36.00",
"formattedAmount": "$36.00"
},
"discount": {
"amount": "2",
"formattedAmount": "$2.00"
},
"shipping": {
"amount": "5.0",
"formattedAmount": "$5.00"
}
},
"id": "a4738c5d-98d6-45e4-bc88-4e5940acacfd",
"status": "APPROVED",
"billingInfo": {
"address": {
"city": "New York",
"countryFullname": "United States",
"addressLine": "235 West 23rd Street, 3rd floor",
"country": "US",
"postalCode": "10011",
"subdivision": "US-NY"
},
"contactDetails": {
"firstName": "Jane",
"lastName": "Doe",
"phone": "0555555555",
"company": ""
}
},
"buyerInfo": {
"contactId": "f61f30cd-7474-47b7-95a2-339c0fcacbd3",
"email": "janedoe@gmail.com",
"memberId": "f61f30cd-7474-47b7-95a2-339c0fcacbd3"
},
"createdBy": {
"userId": "4a5954f0-8c60-4975-8210-c995c00f6077"
},
"currency": "USD",
"balanceSummary": {
"balance": {
"amount": "40.56",
"formattedAmount": "$40.56"
}
},
"updatedDate": "2023-12-05T10:48:58.241Z",
"buyerLanguage": "en",
"channelInfo": {
"type": "BACKOFFICE_MERCHANT"
},
"fulfillmentStatus": "NOT_FULFILLED",
"createdDate": "2023-12-05T10:48:58.241Z"
}
},
"eventTime": "2023-12-05T10:48:58.278491Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "1"
}