get https://app.ecwid.com/api/v3//orders
Request and response example
Request:
curl --location 'https://app.ecwid.com/api/v3/1003/orders' \
--header 'Authorization: Bearer secret_ab***cd'
Response:
{
"total": 23,
"count": 1,
"offset": 0,
"limit": 1,
"items": [
{
"id": "EBJFT",
"internalId": 492512057,
"refundedAmount": 0,
"subtotal": 500,
"subtotalWithoutTax": 500,
"total": 600,
"totalWithoutTax": 590,
"giftCardRedemption": 0,
"totalBeforeGiftCardRedemption": 600,
"giftCardDoubleSpending": false,
"email": "",
"tax": 10,
"customerTaxExempt": false,
"customerTaxIdValid": true,
"b2b_b2c": "b2c",
"reversedTaxApplied": false,
"customerRequestedInvoice": false,
"customerFiscalCode": "",
"electronicInvoicePecEmail": "",
"electronicInvoiceSdiCode": "",
"couponDiscount": 10,
"paymentStatus": "PAID",
"fulfillmentStatus": "SHIPPED",
"orderNumber": 492512057,
"vendorOrderNumber": "EBJFT",
"publicUid": "EBJFT",
"volumeDiscount": 0,
"membershipBasedDiscount": 0,
"totalAndMembershipBasedDiscount": 0,
"customSurcharges": [],
"discount": 0,
"usdTotal": 642.404477130936,
"createDate": "2024-05-01 05:26:28 +0000",
"updateDate": "2024-05-01 05:26:28 +0000",
"createTimestamp": 1714541188,
"updateTimestamp": 1714541188,
"discountCoupon": {
"id": 215189589,
"name": "Test Coupon",
"code": "DISC",
"discountType": "ABS",
"status": "ACTIVE",
"discount": 10,
"launchDate": "2024-04-30 23:00:00 +0000",
"usesLimit": "UNLIMITED",
"repeatCustomerOnly": false,
"applicationLimit": "UNLIMITED",
"creationDate": "2024-05-01 05:26:28 +0000",
"updateDate": "2024-05-01 05:26:28 +0000",
"orderCount": 0
},
"items": [
{
"id": 1741253497,
"productId": 439710255,
"price": 500,
"priceWithoutTax": 500,
"productPrice": 0,
"sku": "000001",
"quantity": 1,
"shortDescriptionTranslated": {
"ru": "",
"en": ""
},
"tax": 0,
"shipping": 0,
"quantityInStock": 0,
"name": "Pizza",
"nameTranslated": {
"ru": "",
"en": "Pizza"
},
"isShippingRequired": true,
"weight": 0,
"trackQuantity": false,
"fixedShippingRateOnly": false,
"imageUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/2870741131.jpg",
"smallThumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/2870741133.jpg",
"hdThumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/2870741134.jpg",
"fixedShippingRate": 0,
"digital": false,
"productAvailable": true,
"couponApplied": false,
"files": [
{
"productFileId": 92603033,
"maxDownloads": 0,
"remainingDownloads": 0,
"expire": "2024-05-04 05:26:28 +0000",
"name": "header.png",
"description": "",
"size": 99304,
"adminUrl": "https://app.ecwid.com/api/v3/15695068/products/439710255/files/92603033",
"customerUrl": "https://app.ecwid.com/download/15695068/d23f0e4ae9368716687f51b9d53820e2/header.png"
},
{
"productFileId": 92603034,
"maxDownloads": 0,
"remainingDownloads": 0,
"expire": "2024-05-04 05:26:28 +0000",
"name": "logo.png",
"description": "",
"size": 9487,
"adminUrl": "https://app.ecwid.com/api/v3/15695068/products/439710255/files/92603034",
"customerUrl": "https://app.ecwid.com/download/15695068/dac5865171876f936e90391236228a94/logo.png"
},
{
"productFileId": 92603035,
"maxDownloads": 0,
"remainingDownloads": 0,
"expire": "2024-05-04 05:26:28 +0000",
"name": "screen1.png",
"description": "",
"size": 56497,
"adminUrl": "https://app.ecwid.com/api/v3/15695068/products/439710255/files/92603035",
"customerUrl": "https://app.ecwid.com/download/15695068/6cb52be701b4181b733d42dfe1306e18/screen1.png"
}
],
"taxable": true,
"isCustomerSetPrice": false,
"attributes": []
}
],
"refunds": [],
"shippingOption": {
"shippingMethodId": "customShippingId",
"shippingMethodName": "Shipping",
"shippingRate": 110,
"shippingRateWithoutTax": 110,
"isPickup": false,
"fulfillmentType": "SHIPPING",
"isShippingLimit": false
},
"predictedPackage": [],
"shippingLabelAvailableForShipment": false,
"shipments": [],
"additionalInfo": {
},
"paymentParams": {
},
"extraFields": {
},
"ticket": -160802399,
"hidden": false,
"taxesOnShipping": [
{
"name": "Custom tax",
"value": 10,
"total": 10
}
],
"disableAllCustomerNotifications": false,
"externalFulfillment": false,
"utmDataSets": [],
"invoices": [],
"pricesIncludeTax": false
}
]
}
Access scopes
Requires the following access scope: read_orders
Path params
| Param | Type | Description |
|---|---|---|
| storeId | number | Ecwid store ID. |
Query params
All query params are optional.
| Param | Type | Description |
|---|---|---|
| ids | string | Order identifier. Works with order ID, internal order ID, order prefixes, and suffixes. Supports multiple values like: EG4H2,J77J8,SALE-G01ZG |
| offset | number | Results offset from the beginning of the returned items list. Usually used to receive more than 100 orders in several requests with multiple of a hundred, like 100, 200, 300, etc. |
| limit | number | Maximum number of returned items. Maximum allowed and default value: 100. |
| keywords | string | Search term for order ID, external transaction ID, billing and shipping address, customer email, shipping tracking code, item SKUs, names, selected options, private admin notes. Encde special characters to URI. |
| string | Search term for customer email. | |
| customerId | number | Search term for customer ID. |
| productId | number | Search term for IDs of products in order. Supports multiple values separated by comma, for example: 10031004,86427531. |
| totalFrom | number | Minimum order total. |
| totalTo | number | Maximum order total. |
| createdFrom | number/string | Order placement date/time (lower bound). Supported formats: UNIX timestamp, date/time. Examples: 1447804800, 2023-01-15 19:27:50 |
| createdTo | number/string | Order placement date/time (upper bound). Supported formats: UNIX timestamp, date/time. Examples: 1447804800, 2023-01-15 19:27:50 |
| updatedFrom | number/string | Order latest update date/time (lower bound). Supported formats: UNIX timestamp, date/time. Examples: 1447804800, 2023-01-15 19:27:50 |
| updatedTo | number/string | Order latest update date/time (upper bound). Supported formats: UNIX timestamp, date/time. Examples: 1447804800, 2023-01-15 19:27:50 |
| pickupTimeFrom | number/string | Order pickup date/time (lower bound). Supported formats: UNIX timestamp, date/time. Examples: 1447804800, 2023-01-15 19:27:50 |
| pickupTimeTo | number/string | Order pickup date/time (upper bound). Supported formats: UNIX timestamp, date/time. Examples: 1447804800, 2023-01-15 19:27:50 |
| shippingMethod | string | Shipping method name selected on the checkout. |
| fulfillmentStatus | string | Order shipping status. Supports multiple values separated by comma. 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. |
| paymentMethod | string | Payment method name selected on the checkout. |
| paymentStatus | string | Order payment status. Supports multiple values separated by comma. Supported values: AWAITING_PAYMENT, PAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, INCOMPLETE, CUSTOM_PAYMENT_STATUS_1, CUSTOM_PAYMENT_STATUS_2, CUSTOM_PAYMENT_STATUS_3. |
| acceptMarketing | boolean | Set true to find orders where customer has accepted email marketing. |
| containsPreorderItems | boolean | Set true to find orders with pre-order products. |
| couponCode | string | Search term for discount coupon code applied to order. |
| subscriptionId | number | Search term for ID of subscription used in order. |
| refererId | number | Referer identifier. |
| responseFields | string | Limit JSON response by specific fields. If specified, all missing fields will be removed from the response body. Example: ?responseFields=total,items(id,email,total) |
Example of using responseFields param:
curl --location 'https://app.ecwid.com/api/v3/1003/orders?responseFields=total,items(id,email,total)' \
--header 'Authorization: Bearer secret_ab***cd'
{
"total": 3,
"items": [
{
"id": "K8XTQ",
"email": "[email protected]",
"total": 10
},
{
"id": "1HOTQ",
"email": "[email protected]",
"total": 101
},
{
"id": "CYQLB",
"email": "[email protected]",
"total": 109.1
}
]
}
Headers
The Authorization header with a secret access token is required.
| Header | Format | Description |
|---|---|---|
| Authorization | Bearer secret_ab***cd | Access token of the application. |
Response
A JSON object with the following fields:
| 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 orderItems | List of orders. |
orderItems
| 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). |
| subtotal | number | Cost of all products in the order (item's price x quantity) before any cost modifiers are applied. |
| subtotalWithoutTax | number | Order subtotal without taxes included in price (GROSS) when pricesIncludeTax is true. |
| total | number | Order total cost with all cost modifiers: shipping, taxes, fees, and discounts. |
| totalWithoutTax | number | Order total without taxes. Calculates as total - tax. |
| refundedAmount | number | A sum of all refunds made to order. |
| giftCardRedemption | number | Amount deducted from the Gift Card balance and applied to order total. |
| totalBeforeGiftCardRedemption | number | Order total before the Gift Card was applied. |
| string | Customer email address. | |
| paymentModule | string | Payment processor name. |
| paymentMethod | string | Payment method name. |
| tax | number | Tax total for the order. Sum of all tax in order items, unless they were modified after order was placed |
| customerTaxExempt | boolean | true if the 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 the customer. |
| electronicInvoicePecEmail | string | PEC email for invoices. |
| electronicInvoiceSdiCode | string | SDI code for invoices. |
| ipAddress | string | Customer IP address. |
| 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 | Fulfillment 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 | number | DEPRECATED Use the id field instead. |
| vendorOrderNumber | string | 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 applied advanced discounts based on subtotal. Included in the discount field. |
| membershipBasedDiscount | number | Sum of applied advanced discounts based on customer group. Included in the discount field. |
| totalAndMembershipBasedDiscount | number | Sum of applied advanced discounts based on both subtotal and customer group. Included in the discount field. |
| discount | number | Sum of all applied advanced discounts. Does not include discount coupons. Total order discount is the sum of the couponDiscount and discount fields. |
| couponDiscount | number | Discount value from applied discount coupon, e.g. 10.Total order discount is the sum of the couponDiscount and discount fields. |
| discountInfo | Array discountInfo | Detailed information about applied advanced discounts. |
| discountCoupon | Object discountCoupon | Detailed information about applied discount coupons. |
| customerId | number | Unique customer internal ID (if a registered user places the order). |
| customSurcharges | Array customSurcharges | Information about applied surcharges. |
| usdTotal | number | Order total in USD |
| 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 | Customer group name. |
| items | Array items | Detailed information about products in the order. |
| refunds | Array refunds | Details about refunds made to order. |
| shippingPerson | Object shippingPerson | Name and address of the person entered in shipping information |
| billingPerson | Object shippingPerson | Name and billing address of the customer. Can be omitted, if this form is disabled by the merchant in Ecwid Control Panel > Settings > General > Cart > Ask for a billing address during checkout |
| shippingOption | Object shippingOption | Information about selected shipping option. |
| handlingFee | Object handlingFee | Handling fee details. |
| predictedPackages | Object predictedPackages | Total dimensions and weight of the single shipping package for the order. |
| shippingLabelAvailableForShipment | boolean | Defines if buying of shipping label is available for a shipment. |
| shipments | Array shipments | Shipment information is provided to the purchased shipping label. |
| additionalInfo | Object | Internal order information. |
| paymentParams | Object | Internal payment parameters. |
| extraFields | Object extraFields | Information about the values of the order's extra fields. |
| orderExtraFields | Array orderExtraFields | 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 | Object 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 taxesOnShipping | 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 | Tax invoices generated 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. |
| lang | string | Order's language (optional). If this field has a value matching one of the active store translations, all customer emails for the order will use this language. Get a list of active store languages here |
| customerUserAgent | string | Information about the customer's device and platform used to place an order. Uses User-Agent browser header format. If device and browser are unrecognized, Ecwid won't return the field. |
items
| 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 | Object 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 | Object 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 | Object 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 selectedOptions | Product options values selected by the customer |
| taxes | Array taxes | Taxes applied to this order item |
| combinationId | number | The ID of a chosen combination |
| files | Array files | Files attached to the order item |
| dimensions | Object dimensions | 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 discounts | Advanced discounts applied to the specific product in the order. |
| taxesOnShipping | Array taxesOnShipping | 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. |
| attributes | object attributes | Details about product attributes. |
attributes
| Field | Type | Description |
|---|---|---|
| name | string | Name of the product attribute. |
| value | string | Attribute value. |
taxes
| Field | Type | Description |
|---|---|---|
| name | string | Tax name |
| name | string | Tax name |
| value | number | Tax value in percent |
| total | number | Tax amount for the item |
| taxOnDiscountedSubtotal | number | Specific tax amount on product subtotal (price) after applying all discounts |
| taxOnShipping | number | Tax on item shipping |
| includeInPrice | boolean | DEPRECATED - refer to pricesIncludeTax field. true if the tax rate is included in product prices (GROSS), false otherwise (NET). More details: Taxes in Ecwid |
| sourceTaxRateId | number | Tax rate ID. For manual taxes the value is copied from tax ID, for all other cases the value is 0 |
| sourceTaxRateType | string | Type of tax rate, possible values are AUTO, MANUAL, CUSTOM (if tax is changed via API), LEGACY |
| taxType | string | Type of detailed tax for USA. Possible values: STATE, COUNTY, CITY, SPECIAL_DISTRICT |
| taxClassCode | string | Tax classification code applied to product. See: Tax classes by country |
| taxClassName | string | (EN) Name of the tax classification code applied to product. See: Tax classes by country |
files
| 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 |
selectedOptions
| Field | Type | Description |
|---|---|---|
| name | string | Option name |
| type | string | Option type. One of:CHOICE: dropdown, radio button, or size.CHOICES: checkbox.TEXT: text input or text area.DATE: date/time selector.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 filesAttached | Attached files (if the option type is FILES) |
| selections | Array selections | Details of selected product options. If sent in update order request, other fields will be regenerated based on information in this field |
filesAttached
| Field | Type | Description |
|---|---|---|
| id | number | File ID |
| name | string | File name |
| size | number | File size in bytes |
| url | string | File URL |
selections
| 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
Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. Example:
{
"en": "Sample text",
"nl": "Voorbeeldtekst"
}
Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings.
dimensions
| Field | Type | Description |
|---|---|---|
| length | number | Length of a product |
| width | number | Width of a product |
| height | number | Height of a product |
shippingPerson
| 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 |
customSurcharges
| 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 |
discounts
| Field | Type | Description |
|---|---|---|
| discountInfo | Object discountInfo | Info about discounts applied to item |
| total | number | Total order item discount value for this discount |
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 to apply the advanced discount. |
| description | string | Advanced discount description. |
| appliesToItems | Array of numbers | List of product IDs advanced discount is applied to, e.g. [123456, 234567]. |
discountCoupon
| Field | Type | Description |
|---|---|---|
| id | number | Discount coupon ID. |
| name | string | Name of the discount coupon visible in Ecwid admin. |
| code | string | Discount 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 value applied to the order total. |
| 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 | Discount coupon creation date. |
| updateDate | string | Date of the last discount coupon update. |
| orderCount | number | Amount of orders where the discount coupon was used previously. |
| catalogLimit | Object catalogLimit | Products and categories the coupon can be applied to |
catalogLimit
| Field | Type | Description |
|---|---|---|
| products | Array of numbers | The list of product IDs the coupon can be applied to |
| categories | Array of numbers | The list of category IDs the coupon can be applied to |
shippingOption
| 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 |
handlingFee
| 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 |
predictedPackages
| 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 | Object shippingPerson | Name and address of the person entered in shipping information |
| shipFrom | Object shipFrom | Shipping origin address. If matches company address, company address is returned |
| parcel | Object parcel | Information about the selected package to ship items to customer |
| shippingService | Object shippingService | Selected shipping service |
| tracking | Object tracking | Tracking details provided by shipping service |
| shippingLabel | Object shippingLabel | Shipping label details |
shipFrom
| Field | Type | Description |
|---|---|---|
| companyName | string | The company name displayed on the invoice |
| string | Company (store administrator) email | |
| street | string | Company address. 1 or 2 lines separated by a new line character |
| city | string | Company city |
| countryCode | string | A two-letter ISO code of the country |
| postalCode | string | Postal code or ZIP code |
| stateOrProvinceCode | string | State code (e.g. NY) or a region name |
| phone | string | Company phone number |
parcel
| 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. |
extraFields
| 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. |
orderExtraFields
| 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 |
refunds
| 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) |
taxesOnShipping
| 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 |