Orders Service

Deprecation Notice:

Stores Orders API has been replaced with eCommerce Orders API and will be removed on September 4, 2024.

Learn more about migrating from Wix Stores to Wix eCommerce.

About This API

Stores Orders API allows third party apps to create and manage orders for Wix store owners.

Use this API to:

  1. Query the orders in the store
  2. Get a specific order
  3. Get notifications (via webhook) about new orders
  4. Create and update orders

Order Types

  • Shipping orders: Order and shipment of any selection of products from the store's catalog.

  • Pickup orders: Order of any selection of products from the store's catalog for user pickup.

  • Point of Sale (POS) orders: Sale consisting only of price and partial billing information, of products not included in the store's catalog.

Did this help?

Filter and Sort

Query Language

Endpoints that allow querying follow these format guidelines.

Fields That Allow Filtering

FieldOperatorsSorting Allowed
dateCreated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
lastUpdated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
paymentStatus$eq,$ne,$hasSome
archived$eq,$ne
number$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
fulfillmentStatus$eq,$ne,$hasSome
id$eq,$ne,$hasSome
lineItems.productId$eq,$ne,$hasSome,$hasAll
lineItems.name$eq,$ne,$hasSome,$hasAll
billingInfo.address.fullName$eq,$ne,$hasSome,$contains,$startsWith
buyerInfo.id$eq,$ne,$hasSome
channelInfo.type$eq,$ne,$hasSome
enteredBy.id$eq,$ne,$hasSome
channelInfo.externalOrderId$eq,$ne,$hasSome

** Note that "HasSome" is same as the operator "IN" in SQL

Examples

Get all paid orders

Copy
curl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{"query":{"filter":"{\"paymentStatus\": \"PAID\"}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Get all orders, sorted by creation time

Copy
curl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{"query":{"sort":"[{\"dateCreated\": \"asc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Get orders updated within a specific timeframe

Copy
curl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{"query": {"filter": "{\"$and\": [{\"lastUpdated\":{\"$lte\":1588110826000}}, {\"lastUpdated\":{\"$gte\":1585518845000}}]}", "sort": "[{\"number\":\"asc\"}]" }}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Get orders by IDs

Copy
curl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{"query":{"filter":"{\"id\": {\"$hasSome\": [\"ORDER_ID_1\",\"ORDER_ID_2\"]}}"}}' -H 'Content-Type: application/json' -H 'Authorization: xxx'
Did this help?

Edit Order/Draft Orders API Migration Guide

Notes:

  • This migration is relevant for all apps that currently use the Stores Orders API.
  • The Stores Orders API will soon be deprecated in favor of the eCommerce Orders API.

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.

New object and webhook structures

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.

Users can now edit orders

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.

Impact examples

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:

  • A user changes the quantity of a product item in an existing order. As a result, the number of items to be shipped has changed.
  • A user changes the shipping address in an existing order.
  • A user adds a new item to an existing order. As a result, the amount to be paid changes.
  • A user changes the price of an item in an existing order. As a result, the total payable amount of the order, as well as the payment status can change.

How to add the new Order Updated webhook

  1. Go to your app in the Wix Developers Center.
  2. Go to the Webhooks tab in the side menu.
  3. Click + Add Webhook.
  4. Select an API Category > Wix eCommerce
  5. Find and select the Order Updated Webhook
  6. Add a Callback URL.
  7. Click Save.

How to test the impact on your app

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:

  1. Install the EditThisCookie Chrome extension.
  2. Click + to add a new cookie, select petri-ovr and fill out the following fields:
  • Value: specs.stores.OrderEditPageComponent#true
  • Domain: .wix.com
  • Secure: Check the box
  • HttpOnly: Check the box

editorder

  1. Create a new Wix website with Wix Stores installed (testing this change only works on new sites).
  2. Refresh the Orders page.
  3. Navigate to an unfulfilled order in the dashboard.
  4. Click on the More Actions button in the top right corner.
  5. Click on Edit Order.

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.

Did this help?

Orders Object


Properties
idstringRead-onlyformat GUID

Order ID (auto-generated upon order creation).


numberintegerRead-only

Order number displayed in the owner's store (auto-generated).


dateCreatedstringRead-onlyformat date-time

Order creation date and time.


buyerInfoBuyerInfo

Buyer information.


currencystringformat CURRENCY

Currency used for the pricing of this order in ISO-4217 format.


weightUnitstring

Weight unit used in this store.


totalsTotals

Totals for order's line items.


billingInfoBillingInfo

Billing information.


shippingInfoShippingInfo

Shipping information.


buyerNotestringmaxLength 1000

A note added by the buyer.


readbooleanRead-onlydeprecated

Deprecated.


archivedbooleanRead-only

Whether or not the order was archived.


paymentStatusstring

Current status of the payment.


fulfillmentStatusstringRead-only

Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).


lineItemsArray <LineItem>minItems 1maxItems 300

Line items ordered.


activitiesArray <Activity>Read-only

Log of updates related to the order.


invoiceInfoInvoiceInfo

Invoice information.


fulfillmentsArray <Fulfillment>Read-only

Order fulfillment information.


discountDiscount

Discount information.


customFieldCustomField

Custom field information.


cartIdstringformat GUID

Shopping cart ID.


buyerLanguagestringmaxLength 10

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.


channelInfoChannelInfo

Information about the sales channel that submitted this order.


enteredByEnteredByRead-only

Identity of the order's initiator.


lastUpdatedstringRead-onlyformat date-time

Date and time of latest update.


subscriptionInfoSubscriptionInfo

Subscription information.


numericIdnumberRead-only

Order’s unique numeric ID. Primarily used for sorting and filtering when crawling all orders.


refundsArray <Refund>Read-only

Refund information.

Did this help?

POST

Create Order


Deprecated

This method has been replaced with Create Order, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Create Order and will be removed on September 4, 2024.

Creates a new order.

Notes:

  • Only orders with the paymentStatus parameter set as "PAID" or "NOT_PAID" will show up in the site owner's Stores Orders tab in their dashboard.
  • The billingInfo.paymentProviderTransactionId and billingInfo.paymentMethod parameters can only be passed when paymentStatus is PAID.
  • The billingInfo.address parameter is required unless channelInfo.type: "POS".
  • The shippingInfo.shipmentDetails.address parameter is required unless one of the following is true:
    • The shippingInfo.pickupDetails is passed instead
    • channelInfo.type: "POS"
    • All order items are of type digital - lineItems.lineItemType: "DIGITAL".
  • When passing lineItems.variantId, lineItems.options is required.
  • When passing lineItems.productId, lineItem.lineItemType is limited to "PHYSICAL".
  • When not passing lineItems.productId, lineItem.lineItemType is limited to "CUSTOM_AMOUNT_ITEM".
Authentication

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

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v2/orders

Body Params
orderOrderRequired
Response Object
orderOrder
Request
cURL
curl 'https://www.wixapis.com/stores/v2/orders' \ --data-binary '{ "order": { "totals": { "subtotal": "10", "total": "10" }, "billingInfo": { "address": { "email": "Ivanushka@example.com" } }, "shippingInfo": { "shipmentDetails": { "address": { "email": "Ivanushka@example.com" } } }, "paymentStatus": "PAID", "lineItems": [ { "quantity": 1, "name": "my product", "priceData": { "price": "10" } } ], "channelInfo": { "type": "WEB" } } }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "order": { "totals": { "subtotal": "7", "total": "10" }, "billingInfo": { "address": { "email": "tomj5@example.com" } }, "paymentStatus": "PAID", "lineItems": [ { "quantity": 1, "price": "5", "name": "my product" } ], "channelInfo": { "type": "WEB" } } }
Did this help?

PATCH

Update Order Email


Deprecated

This method has been replaced with Update Order, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Update Order and will be removed on September 4, 2024.

Updates the email address of a specified order's billing info. If shipping was selected as the delivery method, shipping info email will also be updated.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/stores/v2/orders/{orderId}/updateEmail

Path Params
orderIdstringRequired

Order ID.

Body Params
emailstringmaxLength 100format EMAIL

New email address for billing and shipping info.

Response Object
orderOrder

Updated order data.

Update Order Email Example 1
Request
cURL
curl -X PATCH 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateEmail' \ --data-binary '{ "orderId":"4b070345-5813-49b6-b0ad-2125e5ca5b50", "email":"JohnSmith@example.com" }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "jsonrpc": "2.0", "id": 4, "result": { "order": { "id": "4b070345-5813-49b6-b0ad-2125e5ca5b50", "number": 10124, "dateCreated": "2020-08-26T11:43:42.028Z", "buyerInfo": { "id": "ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09", "type": "MEMBER", "identityType": "MEMBER", "firstName": "Naor", "lastName": "Lipa", "phone": "545442147", "email": "Ivanushka@example.com" }, "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "248.0", "shipping": "15.0", "tax": "6.79", "discount": "0.0", "total": "269.79", "weight": "1000.0", "quantity": 3 }, "billingInfo": { "paymentMethod": "Stripe", "externalTransactionId": "pi_1HKN2aEQJH0qyaWeKASeZehh", "paymentProviderTransactionId": "pi_1HKN2aEQJH0qyaWeKASeZehh", "paymentGatewayTransactionId": "3b2a27a0-7723-4e67-bbc0-f10fc749f16b", "address": { "fullName": { "firstName": "Naor", "lastName": "Lipa" }, "country": "IN", "subdivision": "IN-WB", "city": "Kolkata", "zipCode": "700091", "phone": "545442147", "email": "Ivanushka@example.com", "addressLine1": "SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India" }, "paidDate": "2020-08-26T11:43:45.563Z" }, "shippingInfo": { "deliveryOption": "standard", "estimatedDeliveryTime": "10-20", "shippingRegion": "Region 3", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0.0", "tax": "0.39", "priceData": { "price": "15.0" } } }, "read": true, "paymentStatus": "PAID", "lineItems": [ { "index": 1, "quantity": 2, "price": "84.0", "name": "Women's hoodies Black Pink kpop", "translatedName": "Women's hoodies Black Pink kpop", "productId": "cecada02-47c2-4f4c-b15a-4258a2fa758b", "totalPrice": "168.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "Gray" }, { "option": "Size", "selection": "L" } ], "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg", "width": 800, "height": 800, "mediaId": "9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg", "id": "9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg" }, "sku": "14:691;5:361385-32954066607", "variantId": "00000000-0000-005f-0005-a48308e4493f", "fulfillerId": "f4ef9627-612a-4b63-b8bd-edb7831dcc92", "discount": "0.0", "tax": "0.0", "taxGroupId": "1cabe02f-1a30-4952-920f-36977f3259ef", "priceData": { "price": "84.0", "totalPrice": "168.0" } }, { "index": 2, "quantity": 1, "price": "80.0", "name": "Boring turtle", "translatedName": "Boring turtle", "productId": "762c3bc6-c4f8-fb4d-456e-24beb6f052aa", "totalPrice": "80.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "White" } ], "weight": "1000.0", "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg", "width": 6016, "height": 4016, "mediaId": "nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg", "id": "nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg" }, "variantId": "00000000-0000-0000-0000-000000000000", "fulfillerId": "0dae62fd-c36e-48db-a151-1f4b3d924d62", "discount": "0.0", "tax": "6.4", "priceData": { "price": "80.0", "totalPrice": "80.0" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-08-26T11:43:42.028Z" }, { "type": "ORDER_PAID", "timestamp": "2020-08-26T11:43:45.563Z" }, { "type": "INVOICE_WAS_SET", "timestamp": "2020-08-30T08:28:35.633Z" }, { "type": "EMAIL_EDITED", "timestamp": "2020-09-01T16:19:33.386Z" } ], "invoiceInfo": { "id": "93518b17-b10a-45ca-87fe-a1e9c02b402a", "source": "WIX" }, "cartId": "7e27f5a6-ebab-449f-8a40-d88f8a65f683", "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09", "identityType": "MEMBER" }, "lastUpdated": "2020-09-01T16:19:33.386Z", "numericId": "10124" } } }
Did this help?

PUT

Update Order Shipping Address


Deprecated

This method has been replaced with Update Order, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Update Order and will be removed on September 4, 2024.

Updates the shipping address of a specified order.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PUT
https://www.wixapis.com/stores/v2/orders/{orderId}/updateShippingAddress

Path Params
orderIdstringRequired

Order ID.

Body Params
shippingAddressShippingAddress

New order shipping address.

Response Object
orderOrder

Updated order data.

Update Order Shipping Address Example 1
Request
cURL
curl -X PUT 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateShippingAddress' \ --data-binary '{ "orderId":"4b070345-5813-49b6-b0ad-2125e5ca5b50", "shippingAddress":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555" } }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "jsonrpc": "2.0", "id": 2, "result": { "order": { "id": "4b070345-5813-49b6-b0ad-2125e5ca5b50", "number": 10124, "dateCreated": "2020-08-26T11:43:42.028Z", "buyerInfo": { "id": "ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09", "type": "MEMBER", "identityType": "MEMBER", "firstName": "Naor", "lastName": "Lipa", "phone": "545442147", "email": "Ivanushka@example.com" }, "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "248.0", "shipping": "15.0", "tax": "6.79", "discount": "0.0", "total": "269.79", "weight": "1000.0", "quantity": 3 }, "billingInfo": { "paymentMethod": "Stripe", "externalTransactionId": "pi_1HKN2aEQJH0qyaWeKASeZehh", "paymentProviderTransactionId": "pi_1HKN2aEQJH0qyaWeKASeZehh", "paymentGatewayTransactionId": "3b2a27a0-7723-4e67-bbc0-f10fc749f16b", "address": { "fullName": { "firstName": "Naor", "lastName": "Lipa" }, "country": "IN", "subdivision": "IN-WB", "city": "Kolkata", "zipCode": "700091", "phone": "545442147", "email": "Ivanushka@example.com", "addressLine1": "SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India" }, "paidDate": "2020-08-26T11:43:45.563Z" }, "shippingInfo": { "deliveryOption": "standard", "estimatedDeliveryTime": "10-20", "shippingRegion": "Region 3", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0.0", "tax": "0.39", "priceData": { "price": "15.0" } } }, "read": true, "paymentStatus": "PAID", "lineItems": [ { "index": 1, "quantity": 2, "price": "84.0", "name": "Women's hoodies Black Pink kpop", "translatedName": "Women's hoodies Black Pink kpop", "productId": "cecada02-47c2-4f4c-b15a-4258a2fa758b", "totalPrice": "168.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "Gray" }, { "option": "Size", "selection": "L" } ], "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg", "width": 800, "height": 800, "mediaId": "9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg", "id": "9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg" }, "sku": "14:691;5:361385-32954066607", "variantId": "00000000-0000-005f-0005-a48308e4493f", "fulfillerId": "f4ef9627-612a-4b63-b8bd-edb7831dcc92", "discount": "0.0", "tax": "0.0", "taxGroupId": "1cabe02f-1a30-4952-920f-36977f3259ef", "priceData": { "price": "84.0", "totalPrice": "168.0" } }, { "index": 2, "quantity": 1, "price": "80.0", "name": "Boring turtle", "translatedName": "Boring turtle", "productId": "762c3bc6-c4f8-fb4d-456e-24beb6f052aa", "totalPrice": "80.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "White" } ], "weight": "1000.0", "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg", "width": 6016, "height": 4016, "mediaId": "nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg", "id": "nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg" }, "variantId": "00000000-0000-0000-0000-000000000000", "fulfillerId": "0dae62fd-c36e-48db-a151-1f4b3d924d62", "discount": "0.0", "tax": "6.4", "priceData": { "price": "80.0", "totalPrice": "80.0" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-08-26T11:43:42.028Z" }, { "type": "ORDER_PAID", "timestamp": "2020-08-26T11:43:45.563Z" }, { "type": "INVOICE_WAS_SET", "timestamp": "2020-08-30T08:28:35.633Z" }, { "type": "SHIPPING_ADDRESS_EDITED", "timestamp": "2020-09-01T08:38:45.823Z" } ], "invoiceInfo": { "id": "93518b17-b10a-45ca-87fe-a1e9c02b402a", "source": "WIX" }, "cartId": "7e27f5a6-ebab-449f-8a40-d88f8a65f683", "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09", "identityType": "MEMBER" }, "lastUpdated": "2020-09-01T16:19:33.386Z", "numericId": "10124" } } }
Did this help?

GET

Get Order


Deprecated

This method has been replaced with Get Order, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Get Order and will be removed on September 4, 2024.

Returns an order with the provided ID.

Authentication

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

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/stores/v2/orders/{id}

Path Params
idstringRequired

Requested order ID

Response Object
orderOrder

Order data

Get Order Example 1
Request
cURL
curl 'https://www.wixapis.com/stores/v2/orders/7001d34b-11a6-4a34-8746-dc8ababeca42' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "order": { "id": "7001d34b-11a6-4a34-8746-dc8ababeca42", "number": 10012, "dateCreated": "2023-03-07T10:24:03.380Z", "buyerInfo": { "id": "24de6f0b-60ce-4faa-9138-2e39f1415615", "type": "CONTACT", "identityType": "CONTACT", "firstName": "Jane", "lastName": "Doe", "phone": "0555555555", "email": "janedoe@gmail.com", "contactId": "24de6f0b-60ce-4faa-9138-2e39f1415615" }, "currency": "USD", "weightUnit": "KG", "totals": { "subtotal": "130.00", "shipping": "10.0", "tax": "0.0", "discount": "10.0", "total": "130.00", "weight": "0", "quantity": 3 }, "billingInfo": { "paymentMethod": "In Person", "paymentGatewayTransactionId": "620fb6cf-c11f-4b29-8a37-d1bb550a5912", "address": { "fullName": { "firstName": "Jane", "lastName": "Doe" }, "country": "US", "subdivision": "US-NY", "city": "New York", "zipCode": "10173", "phone": "0555555555", "email": "janedoe@gmail.com", "addressLine1": "525 5th Avenue" }, "refundableByPaymentProvider": true }, "shippingInfo": { "deliveryOption": "Standard US Shipping", "shippingRegion": "USA shipping", "code": "ed5bbce2-9533-dff4-7db0-13702fd139c5", "shipmentDetails": { "address": { "fullName": { "firstName": "Jane", "lastName": "Doe" }, "country": "US", "subdivision": "US-NY", "city": "New York", "zipCode": "10173", "phone": "0555555555", "email": "janedoe@gmail.com", "addressLine1": "525 5th Avenue" }, "trackingInfo": { "trackingNumber": "43255", "shippingProvider": "FEDEX", "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255" }, "discount": "0", "tax": "0.0", "priceData": { "taxIncludedInPrice": false, "price": "10" } } }, "buyerNote": "Happy Birthday!", "read": true, "archived": false, "paymentStatus": "PARTIALLY_PAID", "fulfillmentStatus": "PARTIALLY_FULFILLED", "lineItems": [ { "index": 1, "quantity": 1, "price": "85.00", "name": "Shoe", "translatedName": "Shoe", "productId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e", "totalPrice": "85.00", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "Brown" } ], "customTextFields": [], "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg", "width": 1000, "height": 1000, "mediaId": "3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg", "id": "3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg" }, "sku": "364215376135191", "variantId": "2f430d69-9b75-4874-bfbd-c5f6fa5aff3d", "discount": "0", "tax": "0.0", "taxIncludedInPrice": false, "priceData": { "taxIncludedInPrice": false, "price": "85.00", "totalPrice": "85.00" }, "refundedQuantity": 0 }, { "index": 2, "quantity": 1, "price": "35.00", "name": "Watch", "translatedName": "Watch", "productId": "1a2d7e83-4bef-31d5-09e1-3326ee271c09", "totalPrice": "35.00", "lineItemType": "PHYSICAL", "options": [ { "option": "Size", "selection": "Large" }, { "option": "Color", "selection": "Black" } ], "customTextFields": [], "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg", "width": 1000, "height": 1000, "mediaId": "3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg", "id": "3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg" }, "sku": "217537123517253", "variantId": "63f56c6d-8dcb-491c-8e06-0220b3cd89f2", "discount": "0", "tax": "0.0", "taxIncludedInPrice": false, "priceData": { "taxIncludedInPrice": false, "price": "35.00", "totalPrice": "35.00" }, "refundedQuantity": 0 }, { "index": 3, "quantity": 1, "price": "10.00", "name": "Shirt", "translatedName": "Shirt", "productId": "c8539b66-7a44-fe18-affc-afec4be8562a", "totalPrice": "10.00", "lineItemType": "PHYSICAL", "options": [], "customTextFields": [], "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg", "width": 1000, "height": 1000, "mediaId": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg", "id": "3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg" }, "sku": "364115376135191", "variantId": "00000000-0000-0000-0000-000000000000", "discount": "10.0", "tax": "0.0", "taxIncludedInPrice": false, "priceData": { "taxIncludedInPrice": false, "price": "10.00", "totalPrice": "10.00" }, "refundedQuantity": 0 } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2023-03-07T10:24:03.380Z" }, { "type": "TRACKING_NUMBER_ADDED", "timestamp": "2023-03-07T10:24:56.406Z" }, { "type": "TRACKING_LINK_WAS_SET", "timestamp": "2023-03-07T10:24:56.406Z" }, { "type": "ORDER_PARTIALLY_PAID", "timestamp": "2023-03-07T10:25:22.889Z" } ], "fulfillments": [ { "id": "47451ae1-7325-4ef6-a0d8-fb91ffa88e2e", "dateCreated": "2023-03-07T10:24:56.406Z", "lineItems": [ { "index": 1, "quantity": 1 }, { "index": 2, "quantity": 1 } ], "trackingInfo": { "trackingNumber": "43255", "shippingProvider": "fedex", "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255" } } ], "discount": { "value": "10.0", "appliedCoupon": { "couponId": "fbb94b06-7447-4161-9c48-59bfcdc39e77", "name": "SUMMERSALE10", "code": "SUMMERSALE10" } }, "cartId": "1e61e838-d3a0-4ab7-8348-b37d1d954919", "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "24de6f0b-60ce-4faa-9138-2e39f1415615", "identityType": "CONTACT" }, "lastUpdated": "2023-03-07T10:25:22.889Z", "numericId": "10012", "refunds": [], "checkoutId": "d118aa97-1bcb-462e-9265-3603f6e07df6", "isInternalOrderCreate": false } }
Did this help?

POST

Query Orders


Deprecated

This method has been replaced with Search Orders, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Search Orders and will be removed on September 4, 2024.

Returns a list of up to 100 orders, given the provided paging, sorting and filters. See Stores Pagination for more information. Hidden orders are not returned.

Authentication

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

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v2/orders/query

Body Params
queryQuery

Query

Response Object
ordersArray <Order>

Order data


metadataMetadata

Paging metadata


totalResultsinteger

Total results

Query Orders Example 1
Request
cURL
curl 'https://www.wixapis.com/stores/v2/orders/query' \ --data-binary '{ "query": { "filter": "{\"paymentStatus\": \"PAID\"}", "paging": { "limit": 1 }, "sort": "[{\"number\": \"desc\"}]" } }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "orders": [ { "id": "265c7d98-a7c3-48c4-89cd-bbdc00921eab", "number": 10108, "dateCreated": "2021-05-25T13:51:01.718Z", "buyerInfo": { "id": "f61f30cd-7474-47b7-95a2-339c0fcacbd3", "type": "CONTACT", "identityType": "CONTACT", "firstName": "Jane", "lastName": "Doe", "phone": "+1234567890", "email": "janedoe@gmail.com", "contactId": "f61f30cd-7474-47b7-95a2-339c0fcacbd3" }, "currency": "USD", "weightUnit": "KG", "totals": { "subtotal": "216.25", "shipping": "2.0", "tax": "8.22", "discount": "10.81", "total": "215.66", "weight": "1.5", "quantity": 5 }, "billingInfo": { "paymentMethod": "offline", "paymentGatewayTransactionId": "5c08a09b-867b-49bf-afeb-db59548419e0", "address": { "fullName": { "firstName": "Jane", "lastName": "Doe" }, "country": "US", "subdivision": "US-NY", "city": "New York", "zipCode": "10011", "phone": "+1234567890", "email": "janedoe@gmail.com", "addressLine1": "235 West 23rd Street", "addressLine2": "3rd floor" }, "paidDate": "2021-05-25T13:55:55.130Z" }, "shippingInfo": { "deliveryOption": "U.S Shipping", "estimatedDeliveryTime": "3 - 5 business days", "shippingRegion": "Region 3", "code": "a0fde0a4-6f4e-3716-64be-c0acbde1696a", "shipmentDetails": { "address": { "fullName": { "firstName": "Jane", "lastName": "Doe" }, "country": "US", "subdivision": "US-NY", "city": "New York", "zipCode": "10011", "phone": "+1234567890", "email": "janedoe@gmail.com", "addressLine1": "235 West 23rd Street", "addressLine2": "3rd floor" }, "trackingInfo": { "trackingNumber": "12345", "shippingProvider": "UPS", "trackingLink": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345" }, "discount": "0.0", "tax": "0.0", "priceData": { "taxIncludedInPrice": false, "price": "2.0" } } }, "read": true, "archived": false, "paymentStatus": "PAID", "fulfillmentStatus": "FULFILLED", "lineItems": [ { "index": 1, "quantity": 2, "price": "35.0", "name": "Indonesian Blend", "translatedName": "Indonesian Blend", "productId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a", "totalPrice": "70.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Weight", "selection": "250g" }, { "option": "Ground for", "selection": "Stovetop" } ], "customTextFields": [ { "title": "What would you like written on the custom label?", "value": "Hope you enjoy the coffee! :)" } ], "mediaItem": { "mediaType": "IMAGE", "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", "width": 2977, "height": 3951, "mediaId": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg", "id": "nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg" }, "variantId": "00000000-0000-0020-0005-ad9cdc10d3b8", "discount": "3.5", "tax": "2.66", "taxIncludedInPrice": false, "priceData": { "taxIncludedInPrice": false, "price": "35.0", "totalPrice": "70.0" }, "refundedQuantity": 0 }, { "index": 2, "quantity": 3, "price": "48.75", "name": "Brazilian Arabica", "translatedName": "Brazilian Arabica", "productId": "0614129c-8777-9f3b-4dfe-b80a54df10d5", "totalPrice": "146.25", "lineItemType": "PHYSICAL", "options": [ { "option": "Weight", "selection": "500g" }, { "option": "Ground for", "selection": "Filter" } ], "customTextFields": [ { "title": "What would you like written on the custom label?", "value": "This is great for the filter method." } ], "weight": "0.5", "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg", "width": 4517, "height": 2992, "mediaId": "nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg", "id": "nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg" }, "variantId": "00000000-0000-0040-0005-a316f7c67df7", "fulfillerId": "85e29287-a5bf-4c25-b303-a2ddc9d975e2", "discount": "7.31", "tax": "5.56", "taxIncludedInPrice": false, "priceData": { "taxIncludedInPrice": false, "price": "48.75", "totalPrice": "146.25" }, "refundedQuantity": 0 } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2021-05-25T13:51:01.718Z" }, { "type": "TRACKING_NUMBER_ADDED", "timestamp": "2021-05-25T13:55:26.458Z" }, { "type": "TRACKING_NUMBER_ADDED", "timestamp": "2021-05-25T13:55:47.605Z" }, { "type": "ORDER_PAID", "timestamp": "2021-05-25T13:55:55.130Z" } ], "fulfillments": [ { "id": "80f939c8-cdc4-44fe-a058-b54d506af170", "dateCreated": "2021-05-25T13:55:26.458Z", "lineItems": [ { "index": 1, "quantity": 2 } ], "trackingInfo": { "trackingNumber": "12345", "shippingProvider": "ups", "trackingLink": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345" } }, { "id": "eb9138ff-1490-4dbc-b053-743240b9ab8f", "dateCreated": "2021-05-25T13:55:47.605Z", "lineItems": [ { "index": 2, "quantity": 3 } ], "trackingInfo": { "trackingNumber": "12345", "shippingProvider": "ups", "trackingLink": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345" } } ], "discount": { "value": "10.81", "appliedCoupon": { "couponId": "4294c3d3-1604-41b8-9ba5-119bb17d2d7d", "name": "5 percent - summer sale", "code": "SUMMERSALE5" } }, "cartId": "d56e7d15-0f07-4723-9069-c90c5cdec230", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "f61f30cd-7474-47b7-95a2-339c0fcacbd3", "identityType": "CONTACT" }, "lastUpdated": "2021-05-25T13:55:55.130Z", "numericId": "10108", "refunds": [], "isInternalOrderCreate": false } ], "metadata": { "items": 1, "offset": 0 }, "totalResults": 77 }
Did this help?

POST

Create Fulfillment


Deprecated

This method has been replaced with Create Fulfillment, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Create Fulfillment and will be removed on September 4, 2024.

Creates a fulfillment (a subset of an order, with line items that are being shipped together) based on the body parameters passed with the request. If the site owner has requested it, calling this request will trigger an email to the customer (based on the Wix store settings).

Authentication

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

Permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v2/orders/{orderId}/fulfillments

Path Params
orderIdstringRequired

Order ID (to which the fulfillment will be related).

Body Params
fulfillmentFulfillmentRequired

Fulfillment info.

Response Object
idstringformat GUID

Fulfillment ID.


orderOrder

Updated order data.

Create Fulfillment Example 1
Request
cURL
curl 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments' \ --data-binary '{ "fulfillment": { "lineItems": [ { "index": 1, "quantity": 1 } ], "trackingInfo": { "shippingProvider": "fedex", "trackingNumber": "1234", "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234" } } }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "id":"0175f0e8-f877-40a9-b980-0d336c64c726", "order":{ "id":"fedb19f5-bd4c-4bfc-b2d1-212538319611", "number":10096, "dateCreated":"2020-03-18T16:47:59.222Z", "buyerInfo":{ "id":"e9a69747-6816-42fb-87bf-4cd60a408b4e", "type":"CONTACT", "identityType":"CONTACT", "firstName":"John", "lastName":"Smith", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "currency":"USD", "weightUnit":"LB", "totals":{ "subtotal":"10", "shipping":"3", "tax":"3", "discount":"1", "total":"15", "weight":"30", "quantity":2 }, "billingInfo":{ "paymentMethod":"PayPal", "externalTransactionId":"tx_1806", "paymentProviderTransactionId":"tx_1806", "address":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "paidDate":"2020-03-18T16:47:59.244Z" }, "shippingInfo":{ "deliveryOption":"Express", "estimatedDeliveryTime":"Today", "shipmentDetails":{ "address":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "trackingInfo":{ "trackingNumber":"1234", "shippingProvider":"FEDEX", "trackingLink":"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234" }, "discount":"0", "tax":"1", "priceData":{ "taxIncludedInPrice":false, "price":"3" } } }, "read":false, "archived":false, "paymentStatus":"PAID", "fulfillmentStatus":"PARTIALLY_FULFILLED", "lineItems":[ { "index":1, "quantity":2, "price":"5", "name":"my product", "productId":"a1f9d337-f831-4529-31e6-67db8fd4e1aa", "totalPrice":"10", "lineItemType":"PHYSICAL", "options":[
Did this help?

PUT

Update Fulfillment


Deprecated

This method has been replaced with Update Fulfillment, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Update Fulfillment and will be removed on September 4, 2024.

Updates an existing fulfillment.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PUT
https://www.wixapis.com/stores/v2/orders/{orderId}/fulfillments/{fulfillmentId}

Path Params
orderIdstringRequired

Order ID.


fulfillmentIdstringRequired

Fulfillment ID

Body Params
fulfillmentTrackingInfoFulfillmentTrackingInfo

Updated tracking info.

Response Object
orderOrder

Updated order data.

Update Fulfillment Example 1
Request
cURL
curl -X PUT 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/5945017a-bf19-414e-ae67-af3d2dbc66ff' \ --data-binary '{ "fulfillmentTrackingInfo": { "shippingProvider": "fedex", "trackingNumber": "123" } }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "order":{ "id":"fedb19f5-bd4c-4bfc-b2d1-212538319611", "number":10096, "dateCreated":"2020-03-18T16:47:59.222Z", "buyerInfo":{ "id":"e9a69747-6816-42fb-87bf-4cd60a408b4e", "type":"CONTACT", "identityType":"CONTACT", "firstName":"John", "lastName":"Smith", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "currency":"USD", "weightUnit":"LB", "totals":{ "subtotal":"10", "shipping":"3", "tax":"3", "discount":"1", "total":"15", "weight":"30", "quantity":2 }, "billingInfo":{ "paymentMethod":"PayPal", "externalTransactionId":"tx_1806", "paymentProviderTransactionId":"tx_1806", "address":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "paidDate":"2020-03-18T16:47:59.244Z" }, "shippingInfo":{ "deliveryOption":"Express", "estimatedDeliveryTime":"Today", "shipmentDetails":{ "address":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "trackingInfo":{ "trackingNumber":"123", "shippingProvider":"FEDEX", "trackingLink":"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123" }, "discount":"0", "tax":"1", "priceData":{ "taxIncludedInPrice":false, "price":"3" } } }, "read":false, "archived":false, "paymentStatus":"PAID", "fulfillmentStatus":"PARTIALLY_FULFILLED", "lineItems":[ { "index":1, "quantity":2, "price":"5", "name":"my product", "productId":"a1f9d337-f831-4529-31e6-67db8fd4e1aa", "totalPrice":"10", "lineItemType":"PHYSICAL", "options":[
Did this help?

DELETE

Delete Fulfillment


Deprecated

This method has been replaced with Delete Fulfillment, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Delete Fulfillment and will be removed on September 4, 2024.

Deletes an existing fulfillment.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/stores/v2/orders/{orderId}/fulfillments/{fulfillmentId}

Path Params
orderIdstringRequired

Order ID.


fulfillmentIdstringRequired

Fulfillment ID.

Response Object
orderOrder

Updated order data.

Delete Fulfillment Example 1
Request
cURL
curl -X DELETE 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/0175f0e8-f877-40a9-b980-0d336c64c726' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "order":{ "id":"fedb19f5-bd4c-4bfc-b2d1-212538319611", "number":10096, "dateCreated":"2020-03-18T16:47:59.222Z", "buyerInfo":{ "id":"e9a69747-6816-42fb-87bf-4cd60a408b4e", "type":"CONTACT", "identityType":"CONTACT", "firstName":"John", "lastName":"Smith", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "currency":"USD", "weightUnit":"LB", "totals":{ "subtotal":"10", "shipping":"3", "tax":"3", "discount":"1", "total":"15", "weight":"30", "quantity":2 }, "billingInfo":{ "paymentMethod":"PayPal", "externalTransactionId":"tx_1806", "paymentProviderTransactionId":"tx_1806", "address":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "paidDate":"2020-03-18T16:47:59.244Z" }, "shippingInfo":{ "deliveryOption":"Express", "estimatedDeliveryTime":"Today", "shipmentDetails":{ "address":{ "fullName":{ "firstName":"John", "lastName":"Smith" }, "country":"US", "city":"New York", "zipCode":"92544", "phone":"+972 555234555", "email":"Ivanushka@example.com" }, "discount":"0", "tax":"1", "priceData":{ "taxIncludedInPrice":false, "price":"3" } } }, "read":false, "archived":false, "paymentStatus":"PAID", "fulfillmentStatus":"NOT_FULFILLED", "lineItems":[ { "index":1, "quantity":2, "price":"5", "name":"my product", "productId":"a1f9d337-f831-4529-31e6-67db8fd4e1aa", "totalPrice":"10", "lineItemType":"PHYSICAL", "options":[
Did this help?

Order Created


Deprecation Notice:

This webhook has been replaced with eCommerce Order Approved Event and will be removed on September 4, 2024.

Triggered when an order is created.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderIdstringformat GUID

Order ID (auto generated upon order creation)


numberinteger

ID displayed in the owner's store (auto generated)


dateCreatedstringformat date-time

Order creation date


buyerInfoBuyerInfo

Customer information


currencystringmaxLength 3

Currency used for pricing in this store


weightUnitstring

Weight unit used in this store


totalsTotals

Totals for order's line items


readboolean

Whether the order was read by the store owner


archivedboolean

Order archive status


paymentStatusstring

Order payment status


fulfillmentStatusstring

Order fulfillment status

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.stores.v2.orders_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 } } }

Order Created
JSON
{ "orderId": "afc47c2d-4fbf-450d-9f20-478e54b46b89", "number": "10001", "dateCreated": "2019-08-28T08:30:42.074Z", "buyerInfo": { "id": "d52512dc-131f-4062-abf3-a653552bbbd2", "type": "CONTACT", "identityType": "CONTACT", "firstName": "Eric", "lastName": "Ben", "phone": "055223399", "email": "test123@wix.com" }, "currency": "USD", "weightUnit": "KG", "totals": { "subtotal": "1", "shipping": "2", "tax": "3", "discount": "0", "total": "5", "weight": "0", "quantity": 2 }, "read": true, "paymentStatus": "PAID", "fulfillmentStatus": "FULFILLED" }
Did this help?

Order Paid


Deprecation Notice:

This webhook has been replaced with eCommerce Order Payment Status Updated Event and will be removed on September 4, 2024.

Triggered when an order is paid.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderOrder

Paid order data.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "OrderPaid", "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 } } }

Order Paid
JSON
{ "order": { "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611", "number": 10096, "dateCreated": "2020-03-18T16:47:59.222Z", "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "10", "shipping": "3", "tax": "3", "discount": "1", "total": "15", "weight": "30", "quantity": 2 }, "billingInfo": { "paymentMethod": "PayPal", "externalTransactionId": "tx_1806", "paymentProviderTransactionId": "tx_1806", "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "paidDate": "2020-03-18T16:47:59.244Z" }, "shippingInfo": { "deliveryOption": "Express", "estimatedDeliveryTime": "Today", "shippingRegion": "East coast", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "3" } } }, "read": false, "archived": false, "paymentStatus": "PAID", "fulfillmentStatus": "NOT_FULFILLED", "lineItems": [ { "index": 1, "quantity": 2, "name": "my product", "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa", "lineItemType": "PHYSICAL", "options": [], "customTextFields": [], "weight": "15", "sku": "12345678", "discount": "1", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "5", "totalPrice": "10" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-03-18T16:47:59.222Z" }, { "type": "ORDER_PAID", "timestamp": "2020-03-18T16:47:59.244Z" } ], "fulfillments": [], "discount": { "value": "1" }, "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "e85274cf-047a-4989-baff-dac5e0c3971d", "identityType": "USER" }, "lastUpdated": "2020-03-18T16:47:59.244Z" } }
Did this help?

Order Canceled


Deprecation Notice:

This webhook has been replaced with eCommerce Order Canceled Event and will be removed on September 4, 2024.

Triggered when an order is canceled.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderOrderRead-only

Canceled order data.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "OrderCanceled", "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 } } }

Order Canceled
JSON
{ "order": { "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611", "number": 10096, "dateCreated": "2020-03-18T16:47:59.222Z", "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "10", "shipping": "3", "tax": "3", "discount": "1", "total": "15", "weight": "30", "quantity": 2 }, "billingInfo": { "paymentMethod": "PayPal", "externalTransactionId": "tx_1806", "paymentProviderTransactionId": "tx_1806", "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "paidDate": "2020-03-18T16:47:59.244Z" }, "shippingInfo": { "deliveryOption": "Express", "estimatedDeliveryTime": "Today", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "3" } } }, "read": false, "archived": false, "paymentStatus": "PAID", "fulfillmentStatus": "CANCELED", "lineItems": [ { "index": 1, "quantity": 2, "name": "my product", "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa", "lineItemType": "PHYSICAL", "options": [], "customTextFields": [], "weight": "15", "sku": "12345678", "discount": "1", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "5", "totalPrice": "10" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-03-18T16:47:59.222Z" }, { "type": "ORDER_PAID", "timestamp": "2020-03-18T16:47:59.244Z" } ], "fulfillments": [], "discount": { "value": "1" }, "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "e85274cf-047a-4989-baff-dac5e0c3971d", "identityType": "USER" }, "lastUpdated": "2020-03-18T16:47:59.244Z" } }
Did this help?

Order Refunded


Deprecation Notice:

This webhook has been replaced with eCommerce Order Transactions Updated Event and will be removed on September 4, 2024.

Triggered when an order is refunded.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
refundIdstringRead-only

Refund ID.


orderOrderRead-only

Refunded order data.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "OrderRefunded", "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 } } }

Order Refunded
JSON
{ "refundId": "2a7ca480-e02b-73f2-e015-800174c576e9", "order": { "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611", "number": 10096, "dateCreated": "2020-03-18T16:47:59.222Z", "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "10", "shipping": "3", "tax": "3", "discount": "1", "total": "15", "weight": "30", "quantity": 2, "refund": "15" }, "billingInfo": { "paymentMethod": "PayPal", "externalTransactionId": "tx_1806", "paymentProviderTransactionId": "tx_1806", "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "paidDate": "2020-03-18T16:47:59.244Z" }, "shippingInfo": { "deliveryOption": "Express", "estimatedDeliveryTime": "Today", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "3" } } }, "read": false, "archived": false, "paymentStatus": "FULLY_REFUNDED", "fulfillmentStatus": "CANCELED", "lineItems": [ { "index": 1, "quantity": 2, "name": "my product", "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa", "lineItemType": "PHYSICAL", "options": [], "customTextFields": [], "weight": "15", "sku": "12345678", "discount": "1", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "5", "totalPrice": "10" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-03-18T16:47:59.222Z" }, { "type": "ORDER_PAID", "timestamp": "2020-03-18T16:47:59.244Z" } ], "fulfillments": [], "discount": { "value": "1" }, "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "e85274cf-047a-4989-baff-dac5e0c3971d", "identityType": "USER" }, "lastUpdated": "2020-03-18T16:47:59.244Z", "refunds": [ { "dateCreated": "2020-09-01T12:30:56.208Z", "amount": "21.0", "paymentProviderTransactionId": "re_1HMYdXEQJH0qyaWeD0fm1qmN", "id": "2a7ca480-e02b-73f2-e015-800174c576e9", "externalRefund": false } ] } }
Did this help?

Fulfillment Created


Deprecation Notice:

This webhook has been replaced with eCommerce Order With Fulfillments Updated Event and will be removed on September 4, 2024.

Triggered when a tracking number is added to a fulfillment.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderIdstringformat GUID

Order ID (auto generated upon order creation).


fulfillmentIdstringformat GUID

ID of the newly created fulfillment.


dateCreatedstringformat date-time

Fulfillment creation date and time.


buyerInfoBuyerInfo

Buyer information.


fulfillmentStatusstring

Order fulfillment status.


trackingInfoTrackingInfo

Fulfillment tracking information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "FulfillmentCreated", "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 } } }

Fulfillment Created
JSON
{ "orderId": "8234d6e7-d92f-4c0d-b973-8fadec29fa47", "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50", "dateCreated": "2019-12-10T15:03:30.800Z", "buyerInfo": { "id": "aa3159c6-5d5c-4b1c-bcf1-6b0d9e5a3897", "type": "CONTACT", "identityType": "CONTACT", "firstName": "John", "lastName": "Israeli", "phone": "0123456789", "email": "John.Israeli123@hotmail.com" }, "fulfillmentStatus": "FULFILLED", "trackingInfo": { "trackingNumber": "1234-5678-9101-1121-3141-51", "shippingProvider": "usps", "trackingLink": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51" } }
Did this help?

Fulfillment Updated


Deprecation Notice:

This webhook has been replaced with eCommerce Order With Fulfillments Updated Event and will be removed on September 4, 2024.

Triggered when a fulfillment is updated.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderIdstringformat GUID

Order ID (auto generated upon order creation).


fulfillmentIdstringformat GUID

ID of the updated fulfillment.


trackingInfoTrackingInfo

Fulfillment tracking information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "FulfillmentUpdated", "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 } } }

Fulfillment Updated
JSON
{ "orderId": "8234d6e7-d92f-4c0d-b973-8fadec29fa47", "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50", "trackingInfo": { "trackingNumber": "1234-5678-9101-1121-3141-51", "shippingProvider": "usps", "trackingLink": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51" } }
Did this help?

Fulfillment Deleted


Deprecation Notice:

This webhook has been replaced with eCommerce Order With Fulfillments Updated Event and will be removed on September 4, 2024.

Triggered when a fulfillment is deleted.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderIdstringformat GUID

Order ID (auto generated upon order creation).


fulfillmentIdstringformat GUID

ID of the deleted fulfillment.


fulfillmentStatusstring

Order fulfillment status.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "FulfillmentDeleted", "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 } } }

Fulfillment Deleted
JSON
{ "orderId": "8234d6e7-d92f-4c0d-b973-8fadec29fa47", "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50", "fulfillmentStatus": "NOT_FULFILLED" }
Did this help?