GET https://app.ecwid.com/api/v3/{storeId}/orders?keywords={keywords}&totalFrom={totalFrom}&totalTo={totalTo}&createdFrom={createdFrom}&createdTo={createdTo}&updatedFrom={updatedFrom}&updatedTo={updatedTo}&couponCode={couponCode}&orderNumber={orderNumber}&vendorOrderNumber={vendorOrderNumber}&customer={customer}&paymentMethod={paymentMethod}&shippingMethod={shippingMethod}&paymentStatus={paymentStatus}&fulfillmentStatus={fulfillmentStatus}&offset={offset}&limit={limit}&token={token}

Q: How to get info about abandoned sales?

To get abandoned sale information, specify INCOMPLETE status for paymentStatus filter when searching for orders.

Order pickup time in the store date format, e.g.: "2017-10-17 05:00:00 +0000"

taxesOnShipping

Array<TaxOnShipping>

Taxes applied to shipping 'as is’. null for old orders, [] for orders with taxes applied to subtotal only. Are not recalculated if order is updated later manually

OrderItem

Field

Type

Description

id

number

Order item ID. Can be used to address the item in the order, e.g. to manage ordered items.

productId

number

Store product ID

categoryId

number

ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn’t belong to any category, 0 is returned

price

number

Price of ordered item in the cart

productPrice

number

Basic product price without options markups, wholesale discounts etc.

weight

number

Product weight

sku

string

Product SKU. If the chosen options match a variation, this will be a variation SKU.

quantity

number

Amount purchased

shortDescription

string

Product description truncated to 120 characters

tax

number

Tax amount applied to the item

shipping

number

Order item shipping cost

quantityInStock

number

The number of products in stock in the store

name

string

Product name

isShippingRequired

boolean

true/false: shows whether the item requires shipping

trackQuantity

boolean

true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications

fixedShippingRateOnly

boolean

true/false: shows whether the fixed shipping rate is set for the product

imageUrl

string

Product image URL

fixedShippingRate

number

Fixed shipping rate for the product

digital

boolean

true/false: shows whether the item has downloadable files attached

productAvailable

boolean

true/false: shows whether the product is available in the store

couponApplied

boolean

true/false: shows whether a discount coupon is applied for this item

selectedOptions

Array<OrderItemOption>

Product options values selected by the customer

taxes

Array<OrderItemTax>

Taxes applied to this order item

files

Array<OrderItemProductFile>

Files attached to the order item

dimensions

<ProductDimensions>

Product dimensions info

couponAmount

number

Coupon discount amount applied to item. Provided if discount applied to order. Is not recalculated if order is updated later manually

discounts

Array<OrderItemDiscounts>

Discounts applied to order item 'as is’. Provided if discounts are applied to order (not including discount coupons) and are not recalculated if order is updated later manually

OrderItemTax

Field

Type

Description

name

string

Tax name

value

number

Tax value in percent

total

number

Tax amount for the item

taxOnDiscountedSubtotal

number

Tax on item subtotal (after applying discounts)

taxOnShipping

number

Tax on item shipping

OrderItemProductFile

Field

Type

Description

productFileId

number

Internal unique file ID

maxDownloads

number

Max allowed number of file downloads. See E-goods article in Ecwid Help center for the details

remainingDownloads

number

Remaining number of download attempts

expire

string

Date/time of the customer download link expiration

name

string

File name

description

string

File description defined by the store administrator

size

number

File size, bytes (64-bit integer)

adminUrl

string

Link to the file. Be careful: the link contains the API access token. Make sure you do not display the link as is in your application and not give it to a customer.

customerUrl

string

File download link that is sent to the customer when the order is paid

OrderItemOption

Field

Type

Description

name

string

Option name

type

string

Option type. One of:

CHOICE (dropdown or radio button)

CHOICES (checkboxes)

TEXT (text input and text area)

DATE (date/time)

FILES (upload file option)

value

string

Selected/entered option value(s) as a string. For the CHOICES type, provides a string with all chosen values (comma-separated). You can use this to simply print out all selected values.

valuesArray

Array

Selected option values as an array. For the CHOICES type, provides an array with the chosen values so you can iterate through them in your app.

files

Array<OrderItemOptionFile>

Attached files (if the option type is FILES)

selections

Array<SelectionInfo>

Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field

Error response body (optional)

Get order details

Get all available information about an order referring to its ID. The order details include: customer email, payment/shipping method, items purchased and more.

Q: How can I request details of several orders at once?

When you know the exact order numbers for orders you need, you can get those order details in one request (batch request). To do that, use the Search orders method: provide the order numbers you have in the orderNumber parameter separating them with a comma.

This way your app will save some time as you will be performing less requests to the Ecwid API and they will be much more efficient.

Q: How to get info about abandoned sales?

To get abandoned sale information, specify INCOMPLETE status for paymentStatus filter when searching for orders.

Order pickup time in the store date format, e.g.: "2017-10-17 05:00:00 +0000"

OrderItem

Field

Type

Description

id

number

Order item ID. Can be used to address the item in the order, e.g. to manage ordered items.

productId

number

Store product ID

categoryId

number

ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn’t belong to any category, 0 is returned

price

number

Price of ordered item in the cart

productPrice

number

Basic product price without options markups, wholesale discounts etc.

weight

number

Product weight

sku

string

Product SKU. If the chosen options match a variation, this will be a variation SKU.

quantity

number

Amount purchased

shortDescription

string

Product description truncated to 120 characters

tax

number

Tax amount applied to the item

shipping

number

Order item shipping cost

quantityInStock

number

The number of products in stock in the store

name

string

Product name

isShippingRequired

boolean

true/false: shows whether the item requires shipping

trackQuantity

boolean

true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications

fixedShippingRateOnly

boolean

true/false: shows whether the fixed shipping rate is set for the product

imageUrl

string

Product image URL

fixedShippingRate

number

Fixed shipping rate for the product

digital

boolean

true/false: shows whether the item has downloadable files attached

productAvailable

boolean

true/false: shows whether the product is available in the store

couponApplied

boolean

true/false: shows whether a discount coupon is applied for this item

selectedOptions

Array<OrderItemOption>

Product options values selected by the customer

taxes

Array<OrderItemTax>

Taxes applied to this order item

files

Array<OrderItemProductFile>

Files attached to the order item

dimensions

<ProductDimensions>

Product dimensions info

couponAmount

number

Coupon discount amount applied to item. Provided if discount applied to order. Is not recalculated if order is updated later manually

discounts

Array<OrderItemDiscounts>

Discounts applied to order item 'as is’. Provided if discounts are applied to order (not including discount coupons) and are not recalculated if order is updated later manually

taxesOnShipping

Array<TaxOnShipping>

Taxes applied to shipping. null for old orders, [] for orders with taxes applied to subtotal only. Are not recalculated if order is updated later manually

OrderItemTax

Field

Type

Description

name

string

Tax name

value

number

Tax value in percent

total

number

Tax amount for the item

taxOnDiscountedSubtotal

number

Tax on item subtotal (after applying discounts)

taxOnShipping

number

Tax on item shipping

OrderItemProductFile

Field

Type

Description

productFileId

number

Internal unique file ID

maxDownloads

number

Max allowed number of file downloads. See E-goods article in Ecwid Help center for the details

remainingDownloads

number

Remaining number of download attempts

expire

string

Date/time of the customer download link expiration

name

string

File name

description

string

File description defined by the store administrator

size

number

File size, bytes (64-bit integer)

adminUrl

string

Link to the file. Be careful: the link contains the API access token. Make sure you do not display the link as is in your application and not give it to a customer.

customerUrl

string

File download link that is sent to the customer when the order is paid

OrderItemOption

Field

Type

Description

name

string

Option name

type

string

Option type. One of:

CHOICE (dropdown or radio button)

CHOICES (checkboxes)

TEXT (text input and text area)

DATE (date/time)

FILES (upload file option)

value

string

Selected/entered option value(s) as a string. For the CHOICES type, provides a string with all chosen values (comma-separated). You can use this to simply print out all selected values.

valuesArray

Array

Selected option values as an array. For the CHOICES type, provides an array with the chosen values so you can iterate through them in your app.

files

Array<OrderItemOptionFile>

Attached files (if the option type is FILES)

selections

Array<SelectionInfo>

Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field

HTTP codes

Method not allowed. Can occur when using PUT/POST/DELETE HTTP request methods instead of GET

415

Unsupported content-type: expected application/json or text/json

422

Cannot generate an invoice for unfinished order

500

Cannot retrieve the order info because of an error on the server

Error response body (optional)

Field

Type

Description

errorMessage

string

Error message

Update order

This request allows you to update existing orders in an Ecwid store. When updating order information, you can omit unchanged fields – they will be ignored so the resulting order will keep the corresponding information unchanged.

However, please mind that if you want to update the ordered items, you should submit all the items in the request. The omitted items will be removed. This is done this way to let you remove some purchased items from the order.

Message from the payment processor if any. It is present and visible in order details only if order status is not paid. When order becomes paid, paymentMessage is cleared

externalTransactionId

string

Transaction ID / invoice number of the order in the payment system (e.g. PayPal transaction ID)

affiliateId

string

Affiliate ID

creditCardStatus

<CreditCardStatus>

The status of credit card payment

privateAdminNotes

string

Private note about the order from store owner

pickupTime

string

Order pickup time in the store date format, e.g.: "2017-10-17 05:00:00 +0000"

taxesOnShipping

Array<TaxOnShipping>

Taxes applied to shipping. null for old orders, [] for orders with taxes applied to subtotal only. Are not recalculated if order is updated later manually

OrderItem

Field

Type

Description

id

number

Order item ID.

quantity

number

Amount purchased

name

string

Product name

productId

number

Store product ID

categoryId

number

ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn’t belong to any category, 0 is returned

price

number

Price of ordered item in the cart

productPrice

number

Basic product price without options markups, wholesale discounts etc.

weight

number

Product weight

sku

string

Product/variation SKU

shortDescription

string

Product description truncated to 120 characters

tax

number

Tax amount applied to the item

shipping

number

Order item shipping cost

quantityInStock

number

The number of products in stock in the store

isShippingRequired

boolean

true/false: shows whether the item requires shipping

trackQuantity

boolean

true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications

fixedShippingRateOnly

boolean

true/false: shows whether the fixed shipping rate is set for the product

fixedShippingRate

number

Fixed shipping rate for the product

digital

boolean

true/false: shows whether the item has downloadable files attached

productAvailable

boolean

true/false: shows whether the product is available in the store

couponApplied

boolean

true/false: shows whether a discount coupon is applied for this item

selectedOptions

Array<OrderItemOption>

Product options values selected by the customer

taxes

Array<OrderItemTax>

Taxes applied to this order item

OrderItemTax

Field

Type

Description

name

string

Tax name

value

number

Tax value in percent

total

number

Tax amount for the item

OrderItemOption

Field

Type

Description

name

string

Option name

type

string

Option type. One of:

CHOICE (dropdown or radio button)

CHOICES (checkboxes)

TEXT (text input and text area)

DATE (date/time)

FILES (upload file option)

value

string

Selected/entered value by customer. Multiple values separated by comma in a single string

files

Array<OrderItemOptionFile>

Attached files (if the option type is FILES)

selections

Array<SelectionInfo>

Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field

Message from the payment processor if any. It is present and visible in order details only if order status is not paid. When order becomes paid, paymentMessage is cleared

externalTransactionId

string

Transaction ID / invoice number of the order in the payment system (e.g. PayPal transaction ID)

affiliateId

string

Affiliate ID

creditCardStatus

<CreditCardStatus>

The status of credit card payment

privateAdminNotes

string

Private note about the order from store owner. Ignored when creating orders with public token

pickupTime

string

Order pickup time in the store date format, e.g.: "2017-10-17 05:00:00 +0000"

OrderItem

Field

Type

Description

name

string

Product name

quantity

number

Amount purchased

productId

number

Store product ID

categoryId

number

ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn’t belong to any category, 0 is returned

price

number

Price of ordered item in the cart

productPrice

number

Basic product price without options markups, wholesale discounts etc.

weight

number

Product weight

sku

string

Product SKU

shortDescription

string

Product description truncated to 120 characters

tax

number

Tax amount applied to the item

shipping

number

Order item shipping cost

quantityInStock

number

The number of products in stock in the store

isShippingRequired

boolean

true/false: shows whether the item requires shipping

trackQuantity

boolean

true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications

fixedShippingRateOnly

boolean

true/false: shows whether the fixed shipping rate is set for the product

fixedShippingRate

number

Fixed shipping rate for the product

digital

boolean

true/false: shows whether the item has downloadable files attached

productAvailable

boolean

true/false: shows whether the product is available in the store

couponApplied

boolean

true/false: shows whether a discount coupon is applied for this item

selectedOptions

Array<OrderItemOption>

Product options values selected by the customer

taxes

Array<OrderItemTax>

Taxes applied to this order item

dimensions

<ProductDimensions>

Product dimensions info

OrderItemTax

Field

Type

Description

name

string

Tax name

value

number

Tax value in percent

total

number

Tax amount for the item

OrderItemOption

Field

Type

Description

name

string

Option name

type

string

Option type. One of:

CHOICE (dropdown or radio button)

CHOICES (checkboxes)

TEXT (text input and text area)

DATE (date/time)

FILES (upload file option)

value

string

Selected/entered value by customer. Multiple values separated by comma in a single string

files

Array<OrderItemOptionFile>

Attached files (if the option type is FILES)

selections

Array<SelectionInfo>

Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field

Error response body (optional)

Field

Type

Description

errorMessage

string

Error message

Upload item option file

Using this method, you can attach a file to an order item (implying that the order item has a 'file upload’ option). Request parameters specify which order, item and option should be updated. Request body is the file itself (binary data). Maximum allowed file size is 100Mb.

Order number. Make sure to use the orderNumber value here and not the vendorOrderNumber

itemId

number

Order item ID

optionName

string

Item product option name, e.g. Upload your photo

fileName

string

Uploaded file name

token

string

oAuth token

externalUrl

string

External file URL available for public download. If specified, Ecwid will ignore any binary file data sent in a request

When uploading an item option file, the image itself needs to be sent in the body of your request in a form of binary data. The file that you wish to upload needs to be prepared for that format and then sent to Ecwid API endpoint.

Alternatively, you can specify an externalURL to your file as a request parameter and Ecwid will download it from there.