Search orders

get https://app.ecwid.com/api/v3/{storeId}/orders

Headers

Name	Type	Description
Authorization	string	oAuth token with mandatory `Bearer` before it. Example: `Bearer e*s0`, where `e*s0` should be replaced with your oAuth token.

Query parameters

Name	Type	Description
ids	string	A Unique order identifier. It also includes prefix and suffix defined by store admin in Ecwid admin panel > Settings > General > Cart & checkout. Example: MYSTORE-X8UYE. It's shown to merchants and customers in UI (format can be different for old stores). Use it to get one or multiple orders. Alternatively, check the Get order endpoint.
offset	number	Offset from the beginning of the returned items list (for paging)
subscriptionId	number	A subscription identifier. If a store has subscriptions, they are available at Ecwid admin panel > My Sales > Subscriptions. Learn more about Recurring subscriptions
limit	number	Maximum number of returned items. Maximum allowed value: `100`. Default value: `100`
keywords	string	Search term. Ecwid will look for this term in: order number, external transaction id, vendor order number, customer billing and shipping address, customer email, shipping tracking code, item SKUs, item names, item selected options, affiliate Id, private admin notes. If your keywords contain special characters, it may make sense to URL encode them before making a request
couponCode	string	The code of coupon applied to order
totalFrom	number	Minimum product price
totalTo	number	Maximum product price
email	string	Customer email used to place the order
customerId	number	Customer ID used to place the order
createdFrom	number	Order placement date/time (lower bound). Supported formats: UNIX timestamp or date/time Examples: `1447804800` or `2023-01-15 19:27:50`
createdTo	number	Order placement date/time (upper bound). Supported formats: UNIX timestamp or date/time Examples: `1447804800` or `2023-01-15 19:27:50`
updatedFrom	number	Order last update date/time (lower bound). Supported formats: UNIX timestamp or date/time Examples: `1447804800` or `2023-01-15 19:27:50`
updatedTo	number	Order last update date/time (upper bound). Supported formats: UNIX timestamp or date/time Examples: `1447804800` or `2023-01-15 19:27:50`
pickupTimeFrom	number	Order pickup date/time (lower bound). Supported formats: UNIX timestamp
pickupTimeTo	number	Order pickup date/time (upper bound). Supported formats: UNIX timestamp
paymentMethod	string	Payment method used by customer
shippingMethod	string	Shipping method chosen by customer
paymentStatus	string	Comma separated list of order payment statuses to search. Supported values: `AWAITING_PAYMENT`, `PAID`, `CANCELLED`, `REFUNDED`, `PARTIALLY_REFUNDED`, `INCOMPLETE`, `CUSTOM_PAYMENT_STATUS_1`, `CUSTOM_PAYMENT_STATUS_2`, `CUSTOM_PAYMENT_STATUS_3`.
fulfillmentStatus	string	Comma separated list of order fulfilment statuses to search. Supported values: `AWAITING_PROCESSING`, `PROCESSING`, `SHIPPED`, `DELIVERED`, `WILL_NOT_DELIVER`, `RETURNED`, `READY_FOR_PICKUP`, `OUT_FOR_DELIVERY`, `CUSTOM_FULFILLMENT_STATUS_1`, `CUSTOM_FULFILLMENT_STATUS_2`, `CUSTOM_FULFILLMENT_STATUS_3`.
acceptMarketing	boolean	`true` if customer has accepted email marketing. `false` otherwise
refererId	string	Filter order results by `refererId` field in order details
productId	number	Comma-separated list of productIds. Use it to find orders with specific products by their IDs
containsPreorderItems	boolean	`true` to filter orders containing pre-ordered products, `false` otherwise

Q: How to get info about abandoned sales?

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

Also, check the carts endpoint methods for accessing abandoned carts

Q: How to get all orders from a store?

Use the offset parameter to get all orders in a store.

For example, if a store has 452 orders, you would need to call the /orders endpoint 5 times with different offset parameter values:

offset=0 // 0-100 orders
offset=100 // 100-200 orders
offset=200 // 200-300 orders
offset=300 // 300-400 orders
offset=400 // 400-452 orders

As a result, you will get all 452 orders after these 5 consecutive requests.

Q: How to find customer emails I can use for promotions?

Use the acceptMarketing filter when searching for orders / customers or when getting order / customer details.

If it is set to true or null, you can use their email for promotions in your app or customization. If it's set to false – you cannot send promotional emails to that person.

Response

Response example (JSON)

A JSON object of type 'SearchResult' with the following fields:

SearchResult

Field	Type	Description
total	number	The total number of found items (might be more than the number of returned items)
count	number	The total number of the items returned in this batch
offset	number	Offset from the beginning of the returned items list (for paging)
limit	number	Maximum number of returned items. Maximum allowed value: `100`. Default value: `10`
items	Array <OrderEntry>	The items list

OrderEntry

Field	Type	Description
id	string	Unique ID for each order with prefix and suffix defined by admin e.g. MYSTORE-X8UYE and shown to customers and in UI (format can be different for old stores). Used for identifying a specific order.
refundedAmount	number	A sum of all refunds made to order (for Chase by WePay only)
subtotal	number	Order subtotal. Includes the sum of all products' cost in the order (item's `price` x `quantity`)
subtotalWithoutTax	number	Order subtotal without applied taxes
total	number	Order total cost. Includes shipping, taxes, discounts, etc.
totalWithoutTax	number	Order total cost excluding taxes
giftCardRedemption	number	The amount that was deducted from the used Gift Card
totalBeforeGiftCardRedemption	number	The total before the Gift Card was applied
giftCardDoubleSpending	boolean	If `true`, then the gift card had been already redeemed by a concurrent operation and became negative after processing this order. We advise to review orders relating to this gift card and cancel one of them (most probably this one) as necessary
email	string	Customer email address
paymentModule	string	Payment processor name
paymentMethod	string	Payment method name
tax	number	Tax total for order. Sum of all tax in order items, unless they were modified after order was placed
customerTaxExempt	boolean	`true` if customer is tax exempt, `false` otherwise. Learn more
customerTaxId	string	Customer tax ID
customerTaxIdValid	boolean	`true` if customer tax ID is valid, `false` otherwise
reversedTaxApplied	boolean	`true` if order tax was set to 0 because customer specified their valid tax ID in checkout process. `false` otherwise
b2b_b2c	string	Order type: business-to-business (`b2b`) or business-to-consumer (`b2c`)
customerRequestedInvoice	boolean	`true` if customer requested an invoice, `false` otherwise
customerFiscalCode	string	Fiscale code of a customer
electronicInvoicePecEmail	string	PEC email for invoices
electronicInvoiceSdiCode	string	SDI code for invoices
ipAddress	string	Customer IP
couponDiscount	number	Discount applied to order using a coupon
paymentStatus	string	Payment status. Supported values: `AWAITING_PAYMENT`, `PAID`, `CANCELLED`, `REFUNDED`, `PARTIALLY_REFUNDED`, `INCOMPLETE`, `CUSTOM_PAYMENT_STATUS_1`, `CUSTOM_PAYMENT_STATUS_2`, `CUSTOM_PAYMENT_STATUS_3`.
fulfillmentStatus	string	Fulfilment status. Supported values: `AWAITING_PROCESSING`, `PROCESSING`, `SHIPPED`, `DELIVERED`, `WILL_NOT_DELIVER`, `RETURNED`, `READY_FOR_PICKUP`, `OUT_FOR_DELIVERY`, `CUSTOM_FULFILLMENT_STATUS_1`, `CUSTOM_FULFILLMENT_STATUS_2`, `CUSTOM_FULFILLMENT_STATUS_3`.
orderNumber (deprecated)	number	An order number that was used previously. It's deprecated now and you should use 'id' instead.
vendorOrderNumber (deprecated)	string	Order ID with prefix and suffix defined by admin. It's deprecated. Use the `id` field instead.
refererUrl	string	URL of the page when order was placed (without hash (#) part)
orderComments	string	Customer's order comments, specified at checkout
volumeDiscount	number	Sum of discounts based on subtotal. Is included into the `discount` field
customerId	number	Unique customer internal ID (if the order is placed by a registered user)
membershipBasedDiscount	number	Sum of discounts based on customer group. Is included into the `discount` field
totalAndMembershipBasedDiscount	number	The sum of discount based on subtotal AND customer group. Is included into the `discount` field
customSurcharges	Array<customSurchargesInfo>	Information about applied surcharges
discount	number	The sum of all applied discounts except for the coupon discount. To get the total order discount, take the sum of `couponDiscount` and `discount` field values. Total order discount is a sum of all discounts applied to items (both regular discount and discount coupons) unless they were modified after order was placed
usdTotal	number	Order total in USD
discountInfo	Array <DiscountInfo>	Information about applied discounts (coupons are not included)
globalReferer	string	URL that the customer came to the store from
createDate	date	The date/time of order placement, e.g `2014-06-06 18:57:19 +0000`
updateDate	date	The date/time of the last order change, e.g `2014-06-06 18:57:19 +0000`
createTimestamp	number	The date of order placement in UNIX timestamp or date/time, e.g `1427268654`
updateTimestamp	number	The date of the last order change in UNIX timestamp or date/time, e.g `1427268654`
customerGroupId	number	Customer group ID
customerGroup	string	The name of group (membership) the customer belongs to
discountCoupon	<DiscountCouponInfo>	Information about applied coupon
items	Array <OrderItem>	Order items
refunds	Array <RefundsInfo>	Description of all refunds made to order (for Ecwid Payments only)
billingPerson	<PersonInfo>	Name and billing address of the customer. Can be omitted, if this form is disabled by merchant in Ecwid Control Panel > Settings > General > Cart > Ask for a billing address during checkout
shippingPerson	<PersonInfo>	Name and address of the person entered in shipping information
shippingOption	<ShippingOptionInfo>	Information about selected shipping option
handlingFee	<HandlingFeeInfo>	Handling fee details
predictedPackages	<PredictedPackage>	Predicted information about the package to ship items in to customer
shipments	<Shipments>	Shipment information provided to the purchased shipping label.
additionalInfo	Map <string,string>	Additional order information if any (reserved for future use)
paymentParams	Map <string,string>	Additional payment parameters entered by customer on checkout, e.g. `PO number` in "Purchase order" payments
extraFields	<ExtraFieldsInfo>	Information about the values of the order's extra fields.
orderExtraFields	<OrderExtraFieldsInfo>	Additional optional information about the order's extra fields. Along with the value of the field, it contains technical information, such as id, type, etc. of the field. Total storage of extra fields cannot exceed 8Kb. See Order extra fields
hidden	boolean	Determines if the order is hidden (removed from the list). Applies to unsfinished orders only.
trackingNumber	string	Shipping tracking code
paymentMessage	string	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 'as is'. `null` for old orders, `[]` for orders with taxes applied to subtotal only. Are not recalculated if order is updated later manually. Is calculated like: `(shippingRate + handlingFee)*(taxValue/100)`
acceptMarketing	boolean	`true` if customer has accepted email marketing and you can use their email for promotions (`null` too). If value is `false`, you can't use this email for promotions
refererId	string	Referer identifier. Can be set in storefront via JS or by creating / updating an order with REST API
disableAllCustomerNotifications	boolean	`true` if no email notifications are sent to customer. If `false` or empty, then email notifications are sent to customer according to store mail notification settings. This field does not influence admin email notifications.
externalFulfillment	boolean	Set `true` if order is fulfilled in an external system; Ecwid will hide fulfillment status change feature and ability to set tracking number within Ecwid Control Panel in order details. Set `false` to manage order fulfillment within Ecwid Control Panel
utmData	Array<utmData>	UTM parameters tracked for the order. See more details in Help Center
externalOrderId	string	Corresponding order number in an external system where order is fulfilled. Use together with the `externalFulfillment` field
invoices	Array<Invoices>	Invoices created for the order (read-only)
pricesIncludeTax	boolean	`true` if the tax rate is included in order price. More details: Taxes in Ecwid
utmDataSets	Array<utmDataSets>	UTM parameters tracked for the order. See more details in Help Center. Advanced `utmData` field. Not displayed in the response if a public token is used.

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
subscriptionId	number	A subscription identifier. If a store has subscriptions, they are available at Ecwid admin panel > My Sales > Subscriptions. Learn more about Recurring subscriptions
recurringChargeSettings	<RecurringChargeSettings>	Information about subscription charge intervals
categoryId	number	ID of the category this product belongs to or was added from. If the product was clicked on the store front (featured products) page and added to the cart, categoryID will return `0`. If the product was added to the cart via the Buy Now button on the featured products page, categoryID will return `-1`.
price	number	Price of ordered item in the cart
priceWithoutTax	number	Price of ordered item in the cart without applied tax
productPrice	number	Basic product price without options markups, wholesale discounts etc.
costPrice	number	Purchase price of the product in the specific order (the price at which the seller bought it from the supplier). A positive number, 0 by default. The field is not shown in the UI and can be used for reports and profit calculations
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
shortDescriptionTranslated	<Translations>	Available translations for product short description
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
nameTranslated	<Translations>	Available translations for 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
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
combinationId	number	The ID of a chosen combination
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. Is calculated like: `(shippingRate + handlingFee)*(taxValue/100)`
isCustomerSetPrice	boolean	`true` if price for the ordered product was set up by a customer ("Pay What You Want" feature is enabled). `false` otherwise.
isPreorder	boolean	`true` if the product is pre-ordered because it was out of stock. Learn more about Accepting pre-orders. Otherwise the field is not returned.

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
includeInPrice	boolean	DEPRECATED - refer to `pricesIncludeTax` field. `true` if the tax rate is included in product prices. More details: Taxes in Ecwid
taxType	string	Type of detailed tax for USA. Possible values: `STATE`, `COUNTY`, `CITY`, `SPECIAL_DISTRICT`

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, radio button or size) `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

OrderItemOptionFile

Field	Type	Description
id	number	File ID
name	string	File name
size	number	File size in bytes
url	string	File URL

SelectionInfo

Field	Type	Description
selectionTitle	string	Selection title, as set by merchant
selectionModifier	number	Selection price modifier amount. Value is negative for negative modifiers
selectionModifierType	string	Price modifier type: `"PERCENT"` or `"ABSOLUTE"`

RecurringChargeSettings

Field	Type	Description
recurringInterval	string	Subscription charge interval. Supported values: `day`, `week`, `month`, `year`
recurringIntervalCount	number	Charge interval count (e.g. `3` - once per 3 months)
subscriptionPriceWithSignUpFee	number	The cost of the product for the first subscription order.
signUpFee	number	The size of the markup that is imposed on the first order.

Translations

Field	Type	Description
<ISO_LANG_CODE>	string	Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings

ProductDimensions

Field	Type	Description
length	number	Length of a product
width	number	Width of a product
height	number	Height of a product

PersonInfo

Field	Type	Description
name	string	Full name
companyName	string	Company name
street	string	Address line 1 and address line 2, separated by '\n'
city	string	City
countryCode	string	Two-letter country code
countryName	string	Country name
postalCode	string	Postal/ZIP code
stateOrProvinceCode	string	State code, e.g. `NY`
stateOrProvinceName	string	State/province name
phone	string	Phone number

customSurchargesInfo

Field	Type	Description
id	string	Surcharge id. If not specified default value: `Custom Surcharge`
value	number	Surcharge value
type	string	Surcharges type: `ABSOLUTE` or `PERCENT`
total	number	Total value of surcharges
totalWithoutTax	number	Total value of surcharges without taxes
description	string	Surcharge description
descriptionTranslated	string	Surcharge description in the translation
taxable	boolean	Controls tax application for the surcharge
taxes	Array<Taxes>	The list of applied taxes

OrderItemDiscounts

Field	Type	Description
discountInfo	<OrderItemDiscountInfo>	Info about discounts applied to item
total	number	Total order item discount value for this discount

OrderItemDiscountInfo

Field	Type	Description
value	number	Discount value
type	string	Discount type: `ABS` or `PERCENT`
base	string	Discount base, one of `ON_TOTAL`, `ON_MEMBERSHIP`, `ON_TOTAL_AND_MEMBERSHIP`, `CUSTOM`
orderTotal	number	Minimum order subtotal the discount applies to

DiscountCouponInfo

Field	Type	Description
name	string	Coupon title in store control panel
code	string	Coupon code
discountType	string	Discount type: `ABS`, `PERCENT`, `SHIPPING`, `ABS_AND_SHIPPING`, `PERCENT_AND_SHIPPING`
status	string	Discount coupon state: `ACTIVE`, `PAUSED`, `EXPIRED` or `USEDUP`
discount	number	Discount amount
launchDate	string	The date of coupon launch, e.g. `2014-06-06 08:00:00 +0000`
expirationDate	string	Coupon expiration date, e.g. `2014-06-06 08:00:00 +0000`
totalLimit	number	The minimum order subtotal the coupon applies to
usesLimit	string	Number of uses limitation: `UNLIMITED`, `ONCEPERCUSTOMER`, `SINGLE`
applicationLimit	string	Application limit for discount coupons. Possible values: `"UNLIMITED"`, `"NEW_CUSTOMER_ONLY"`, `"REPEAT_CUSTOMER_ONLY"`
creationDate	string	Coupon creation date
orderCount	number	Number of uses
catalogLimit	<DiscountCouponCatalogLimit>	Products and categories the coupon can be applied to

DiscountCouponCatalogLimit

Field	Type	Description
products	Array <number>	The list of product IDs the coupon can be applied to
categories	Array <number>	The list of category IDs the coupon can be applied to

ShippingOptionInfo

Field	Type	Description
shippingCarrierName	string	Optional. Is present for orders made with carriers, e.g. `USPS` or shipping applications.
shippingMethodName	string	Shipping option name
shippingMethodId	string	Shipping method ID
shippingRate	number	Rate
shippingRateWithoutTax	number	Rate without tax
estimatedTransitTime	string	Delivery time estimation. Possible formats: number "5", several days estimate "4-9" (is equal to the `description` field in the `Get shipping options` request)
isPickup	boolean	`true` for pickup methods, `false` otherwise
pickupInstruction	string	Instruction for customer on how to receive their products
fulfillmentType	string	Contains one of the values: `shipping`, `pickup`, `delivery`

HandlingFeeInfo

Field	Type	Description
name	string	Handling fee name set by store admin. E.g. `Wrapping`
value	number	Handling fee value
description	string	Handling fee description for customer

PredictedPackage

Name	Type	Description
height	number	Height of a predicted package
width	number	Width of a predicted package
length	number	Length of a predicted package
weight	number	Total weight of a predicted package
declaredValue	number	Declared value of a predicted package (subtotal of items in package)

Shipments

Field	Type	Description
id	string	ID of the purchased shipping label
created	date	The date/time of shipping label purchase, e.g `2020-04-23 19:13:43 +0000`
shipTo	<PersonInfo>	Name and address of the person entered in shipping information
shipFrom	<ShippingOrigin>	Shipping origin address. If matches company address, company address is returned
parcel	<PackageInfo>	Information about the selected package to ship items to customer
shippingService	<ShippingService>	Selected shipping service
tracking	<Tracking>	Tracking details provided by shipping service
shippingLabel	<ShippingLabel>	Shipping label details

PackageInfo

Field	Type	Description
weight	number	Total weight of a package
weightUnit	string	Contains one of the values: `CARAT`, `GRAM`, `OUNCE`, `POUND`, `KILOGRAM`
width	number	Width of a package
height	number	Height of a package
length	number	Length of a package
dimensionUnit	string	Contains one of the values: `MM`, `CM`, `IN`, `YD`

ShippingService

Field	Type	Description
carrier	string	Carrier used for shipping the order. Contains one of the values: `USPS`, `UPS`, `FEDEX`, `CANADA_POST`, `AUSTRALIA_POST`
carrierName	string	Name of shipping option in store settings
carrierServiceName	string	Specific carrier method name
carrierServiceCode	string	Specific carrier method code

Tracking

Field	Type	Description
tracking_number	string	Tracking number provided by shipping service
tracking_url	string	Link for tracking delivery status information
estimatedDays	number	Estimated delivery time in days

ShippingLabel

Field	Type	Description
label_url	string	URL to download shipping label

DiscountInfo

Field	Type	Description
value	number	Discount value
type	string	Discount type: `ABS` or `PERCENT`
base	string	Discount base, one of `ON_TOTAL`, `ON_MEMBERSHIP`, `ON_TOTAL_AND_MEMBERSHIP`, `CUSTOM`
orderTotal	number	Minimum order subtotal the discount applies to
description	string	Description of a discount (for discounts with base == `CUSTOM`)

CreditCardStatus

Field	Type	Description
avsMessage	string	Address verification status returned by the payment system.
cvvMessage	string	Credit card verification status returned by the payment system.

ExtraFieldsInfo

Field	Type	Description
ecwid_order_delivery_time_interval_end	date	End of the delivery date interval.
ecwid_order_delivery_time_display_format	string	Format of the delivery date chosen:`DATE` or `DATETIME`.
ecwid_order_delivery_time_interval_start	date	Start of the delivery date interval.

OrderExtraFieldsInfo

Field	Type	Description
id	string	Your custom name saved for the order extra field
value	string	Extra field value. Length cannot exceed 255 characters
customerInputType	string	One of: `""`,`"TEXT"`, `"SELECT"`, `"DATETIME"`
title	string	Extra field title. Displayed for customer at checkout if field is visible
orderDetailsDisplaySection	string	One of: `shipping_info` , `billing_info`, `customer_info`, `order_comments`. Empty string for hidden fields.
orderBy	string	Extra field position. Use it to sort fields within the same `orderDetailsDisplaySection`

RefundsInfo

Field	Type	Description
date	date	The date/time of a refund, e.g `2014-06-06 18:57:19 +0000`
source	string	What action triggered refund. Possible values: `"CP"` - changed my merchant in Ecwid CP, `"API"` - changed by another app, `"External"` - refund made from payment processor website
reason	string	A text reason for a refund. 256 characters max
amount	number	Amount of this specific refund (not total amount refunded for order. see `redundedAmount` field)

utmData

Field	Type	Description
source	string	Traffic source - indicated where customers come from
campaign	string	Indicates a specific advertising campaign
medium	string	Type of traffic - indicates the method for bringing customers

utmDataSets

Field	Type	Description
timestamp	number	The time of saving dataset into the local storage
source	string	Traffic source - indicated where customers come from
medium	string	Type of traffic - indicates the method for bringing customers
campaign	string	Indicates a specific advertising campaign

Invoices

Field	Type	Description
internalId	number	Internal ID of the invoice
id	string	Public invoice ID showed in the invoice
created	string	Date and time of invoice creation in UTC
link	string	Download link for invoice in PDF format
type	string	Invoice type. Supported values `"SALE"` (regular), `"FULL_CANCEL"` (refund)

TaxOnShipping

Field	Type	Description
name	string	Tax name
value	number	Tax value in store settings, applied to destination zone
total	number	Tax total applied to shipping

Errors

Error response example:

HTTP/1.1 500 Server Error
Content-Type application/json; charset=utf-8

In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description

HTTP codes

HTTP Status	Description
400	Request parameters are malformed
402	The store is suspended
403	Access token doesn't have `read_orders` scope
415	Unsupported content-type: expected `application/json` or `text/json`
500	Cannot retrieve the order info because of an error on the server

Error response body (optional)

Field	Type	Description
errorMessage	string	Error message