Ecwid

https://docs.ecwid.com
Admin
Ecwid provides robust e-commerce solutions, offering API and development tools for building and...
Tokens:1,204,065
Snippets:8,293
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET customer response example

Source: https://docs.ecwid.com/api-reference/rest-api/customers/get-customer

Example JSON response for the GET customer request, showing all available fields for the customer entity.

```json
{
  "id": 177737165,
  "email": "ec.apps@lightspeedhq.com",
  "registered": "2021-12-21 06:05:58 +0000",
  "updated": "2024-06-04 21:15:10 +0000",
  "customerGroupId": 0,
  "customerGroupName": "General",
  "billingPerson": {
    "name": "Support team",
    "firstName": "Support",
    "lastName": "team"
  },
  "shippingAddresses": [],
  "contacts": [
    {
      "id": 113861381,
      "contact": "ec.apps@lightspeedhq.com",
      "type": "EMAIL",
      "default": true,
      "orderBy": 0,
      "timestamp": "2024-06-04 21:15:10 +0000"
    }
  ],
  "taxExempt": false,
  "taxId": "",
  "taxIdValid": true,
  "b2b_b2c": "b2c",
  "fiscalCode": "",
  "electronicInvoicePecEmail": "",
  "electronicInvoiceSdiCode": "",
  "acceptMarketing": false,
  "stats": {
    "numberOfOrders": 0,
    "salesValue": 0,
    "averageOrderValue": 0
  },
  "privateAdminNotes": "",
  "favorites": []
}
```

--------------------------------

### GET customer request and response example

Source: https://docs.ecwid.com/api-reference/rest-api/customers/get-customer.md

Shows a sample HTTP request to retrieve a customer and the corresponding JSON response with customer details.

```http
GET /api/v3/1003/customers/177737165 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
```

```json
{
  "id": 177737165,
  "email": "ec.apps@lightspeedhq.com",
  "registered": "2021-12-21 06:05:58 +0000",
  "updated": "2024-06-04 21:15:10 +0000",
  "customerGroupId": 0,
  "customerGroupName": "General",
  "billingPerson": {
    "name": "Support team",
    "firstName": "Support",
    "lastName": "team"
  },
  "shippingAddresses": [],
  "contacts": [
    {
      "id": 113861381,
      "contact": "ec.apps@lightspeedhq.com",
      "type": "EMAIL",
      "default": true,
      "orderBy": 0,
      "timestamp": "2024-06-04 21:15:10 +0000"
    }
  ],
  "taxExempt": false,
  "taxId": "",
  "taxIdValid": true,
  "b2b_b2c": "b2c",
  "fiscalCode": "",
  "electronicInvoicePecEmail": "",
  "electronicInvoiceSdiCode": "",
  "acceptMarketing": false,
  "stats": {
    "numberOfOrders": 0,
    "salesValue": 0,
    "averageOrderValue": 0
  },
  "privateAdminNotes": "",
  "favorites": []
}
```

--------------------------------

### Search promotions request and response example

Source: https://docs.ecwid.com/api-reference/rest-api/discounts/promotions/search-promotions.md

Example of a GET request to search promotions and the corresponding JSON response. The request requires the Authorization header with a Bearer token. The response includes promotion details such as id, name, enabled status, discount base, discount type, amount, and triggers.

```http
GET /api/v3/1003/promotions HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
```

```json
{
  "total": 1,
  "count": 1,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "id": 608502,
      "name": "10% off on cart total above €50,00",
      "enabled": true,
      "discountBase": "SUBTOTAL",
      "discountType": "PERCENT",
      "amount": 10,
      "triggers": {
        "subtotal": 50
      }
    }
  ]
}
```

--------------------------------

### Response with payment options

Source: https://docs.ecwid.com/guides/payments/customize-payments/add-payment-instructions-to-the-checkout

Example JSON response from the GET call, showing payment options with their IDs and appClientId values.

```json
[
    {
        "id": "13379-1606718590771",
        "appClientId": ""
    },
    {
        "id": "1272790545-1729232856479",
        "appClientId": "custom-app-15695068-1"
    }
]
```

--------------------------------

### GET discount coupon request and response example

Source: https://docs.ecwid.com/api-reference/rest-api/discounts/discount-coupons/get-discount-coupon.md

Shows a sample HTTP request to retrieve a discount coupon and the corresponding JSON response with coupon details.

```http
GET /api/v3/1003/discount_coupons/162428889 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
```

```json
{
  "id": 162428889,
  "name": "10% OFF",
  "code": "DISC",
  "discountType": "ABS",
  "status": "ACTIVE",
  "discount": 10,
  "launchDate": "2022-07-28 23:00:00 +0000",
  "usesLimit": "UNLIMITED",
  "repeatCustomerOnly": false,
  "applicationLimit": "UNLIMITED",
  "creationDate": "2022-07-29 15:22:35 +0000",
  "updateDate": "2024-05-01 05:26:28 +0000",
  "orderCount": 1
}
```

--------------------------------

### Create a project directory and initialize npm

Source: https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/install-crane-to-your-system

Creates a new directory 'my-workspace', changes into it, and initializes a new npm project with default settings.

```bash
mkdir my-workspace && cd my-workspace
npm init -y
```

--------------------------------

### Create a template with example name

Source: https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/deep-dive-into-crane-cli.md

Creates a template named 'my-custom-template' in the 'sections' directory.

```bash
npx @lightspeed/crane@latest init --section my-custom-template
```

--------------------------------

### getTrackingConsent - Get cookie consent status

Source: https://docs.ecwid.com/site-themes/develop-site-themes/headless-api/storefront-js.md

Calls getTrackingConsent() to get the customer's cookie consent status. The example shows a comment with an example result object.

```typescript
const consent = await getTrackingConsent()
// { userResponse: "ACCEPTED", askConsent: true }
```

--------------------------------

### getVisitorLocation - Get visitor location

Source: https://docs.ecwid.com/site-themes/develop-site-themes/headless-api/storefront-js.md

Calls getVisitorLocation() to get the visitor's location based on shipping/billing address or IP. The example shows a comment with an example result object.

```typescript
const location = await getVisitorLocation()
// { countryCode: "US", stateCode: "NE", source: "IP_ADDRESS" }
```

--------------------------------

### Build and preview a Crane application

Source: https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/deep-dive-into-crane-cli.md

Builds the application and starts a preview server to test sections.

```bash
# Build your application
npx @lightspeed/crane@latest build

# Start preview server
npx @lightspeed/crane@latest preview
```

--------------------------------

### Build the application

Source: https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/deep-dive-into-crane-cli.md

Builds your application for deployment, creating 'dist' and 'node_modules' directories with compiled output.

```bash
npx @lightspeed/crane@latest build
```

--------------------------------

### getInitializedWidgets - Get list of loaded widgets

Source: https://docs.ecwid.com/site-themes/develop-site-themes/headless-api/storefront-js.md

Calls getInitializedWidgets() to get a list of Ecwid widgets currently loaded on the page. The example shows a comment with an example array of widget names.

```typescript
const widgets = await getInitializedWidgets()
// ["Minicart", "SearchPanel", "ProductBrowser"]
```

--------------------------------

### Create a section with example name

Source: https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/deep-dive-into-crane-cli.md

Creates a section named 'my-custom-section' in the 'sections' directory.

```bash
npx @lightspeed/crane@latest init --section my-custom-section
```

--------------------------------

### Batch request example (HTTP request and JSON response)

Source: https://docs.ecwid.com/api-reference/rest-api/batch-requests/create-batch-request.md

Example of a batch request to the Ecwid API. The request includes three operations: GET orders, GET profile, and POST product. The response returns a ticket ID for tracking the batch.

```http
POST /api/v3/1003/batch?allowParallelMode=true HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
Content-Type: application/json
Cache-Control: no-cache

[
  {
    "id": "000001",
    "path": "/orders?limit=1&email=ec.apps@lightspeedhq.com",
    "method": "GET",
    "body": ""
  },
  {
    "id": "000002",
    "path": "/profile",
    "method": "GET",
    "body": ""
  },
  {
    "id": "000003",
    "path": "/products",
    "method": "POST",
    "body": {
      "sku": "0012199",
      "quantity": 10,
      "name": "New Product",
      "price": 19.99,
      "compareToPrice": 24.99,
      "isShippingRequired": false,
      "categoryIds": [
        9691094
      ],
      "weight": 10,
      "enabled": true,
      "description": "A <b>new</b> product description",
      "productClassId": 0
    }
  }
]
```

```json
{
  "ticket": "11kl140a2-966f-1a9f-b4e6-fc451bc78570"
}
```

--------------------------------

### Create project folder and install dependencies

Source: https://docs.ecwid.com/site-themes/develop-custom-sections/quickstart-with-custom-sections-without-building-site-themes.md

Creates a project folder, navigates into it, and installs Vite, Vue, Sass, and the Crane CLI packages.

```sh
mkdir my-theme-project
cd my-theme-project
npm install vite vue sass @lightspeed/crane@latest @lightspeed/eslint-config-crane@latest
```

--------------------------------

### GET /api/v3/1003/orders/last - Response example

Source: https://docs.ecwid.com/api-reference/rest-api/orders/get-last-order.md

Example JSON response containing the last order details, including items, taxes, and customer information.

```json
{
    "id": "K8XTQ",
    "internalId": 516483487,
    "refundedAmount": 0,
    "subtotal": 10,
    "subtotalWithoutTax": 9.09,
    "total": 10,
    "totalWithoutTax": 9.09,
    "giftCardRedemption": 0,
    "totalBeforeGiftCardRedemption": 10,
    "giftCardDoubleSpending": false,
    "email": "ec.apps@lightspeedhq.com",
    "paymentMethod": "Offline",
    "tax": 0.91,
    "customerTaxExempt": false,
    "customerTaxId": "",
    "customerTaxIdValid": false,
    "b2b_b2c": "b2c",
    "reversedTaxApplied": false,
    "customerRequestedInvoice": false,
    "customerFiscalCode": "",
    "electronicInvoicePecEmail": "",
    "electronicInvoiceSdiCode": "",
    "ipAddress": "80.241.251.10",
    "couponDiscount": 0,
    "paymentStatus": "PAID",
    "fulfillmentStatus": "DELIVERED",
    "orderNumber": 516483487,
    "vendorOrderNumber": "K8XTQ",
    "publicUid": "K8XTQ",
    "refererUrl": "https://store1003.company.site/products/",
    "orderComments": "",
    "volumeDiscount": 0,
    "customerId": 270919557,
    "membershipBasedDiscount": 0,
    "totalAndMembershipBasedDiscount": 0,
    "customDiscount": [],
    "customSurcharges": [],
    "discount": 0,
    "usdTotal": 11.067309160854485,
    "globalReferer": "https://my.ecwid.com/",
    "createDate": "2024-09-04 07:22:09 +0000",
    "updateDate": "2024-09-04 07:26:24 +0000",
    "createTimestamp": 1725434529,
    "updateTimestamp": 1725434784,
    "items": [
        {
            "id": 1828115520,
            "productId": 692730761,
            "categoryId": 0,
            "price": 10,
            "priceWithoutTax": 9.09,
            "productPrice": 10,
            "sku": "123123",
            "quantity": 1,
            "shortDescription": "",
            "shortDescriptionTranslated": {
                "cs": "",
                "en": ""
            },
            "tax": 0.91,
            "shipping": 0,
            "quantityInStock": 0,
            "name": "Toys",
            "nameTranslated": {
                "cs": "",
                "en": "Toys"
            },
            "isShippingRequired": false,
            "trackQuantity": false,
            "fixedShippingRateOnly": false,
            "imageUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591921.jpg",
            "smallThumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591920.jpg",
            "hdThumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591922.jpg",
            "fixedShippingRate": 0,
            "digital": true,
            "productAvailable": true,
            "couponApplied": false,
            "files": [
                {
                    "productFileId": 96178524,
                    "maxDownloads": 0,
                    "remainingDownloads": 0,
                    "expire": "2024-09-07 07:23:43 +0000",
                    "name": "images.jpeg",
                    "description": "",
                    "size": 12006,
                    "adminUrl": "https://app.ecwid.com/api/v3/1003/products/692730761/files/96178524",
                    "customerUrl": "https://app.ecwid.com/download/1003/71248dca454148b792e5975c87793a872aec44b184c246d7b953ee2e08990703/images.jpeg"
                }
            ],
            "taxes": [
                {
                    "name": "10% Tax",
                    "value": 10,
                    "total": 0.91,
                    "taxOnDiscountedSubtotal": 0.91,
                    "taxOnShipping": 0,
                    "includeInPrice": true,
                    "sourceTaxRateId": 947976181,
                    "sourceTaxRateType": "MANUAL",
                    "taxClassName": "Standard rate",
                    "taxClassCode": "default"
                }
            ],
            "dimensions": {
                "length": 0,
                "width": 0,
                "height": 0
            },
            "discounts": [],
            "discountsAllowed": true,
            "taxable": true,
            "giftCard": false,
            "recurringTaxIds": [],
            "isCustomerSetPrice": false,
            "attributes": []
        }
    ],
    "refunds": [],
    "billingPerson": {
        "name": "API Team",
        "firstName": "Support",
        "lastName": "Team",
        "companyName": "Ecwid API Team",
        "street": "Anhalter Strasse 98",
        "city": "Niederhausen An Der Appel"
    }
}
```

--------------------------------

### Create Product Response Example

Source: https://docs.ecwid.com/api-reference/rest-api/products/create-product

Example response from the create product request, returning the new product's ID.

```json
{
  "id": 39766764
}
```

--------------------------------

### GET customer request example

Source: https://docs.ecwid.com/api-reference/rest-api/customers/get-customer

Example HTTP request to retrieve a customer with ID 177737165 from store 1003. Requires Authorization header with Bearer token.

```http
GET /api/v3/1003/customers/177737165 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
```

--------------------------------

### GET /api/v3/1003/products/692730761 response

Source: https://docs.ecwid.com/api-reference/rest-api/products/get-product

Example JSON response for the get product request, containing full product details such as id, name, price, images, and shipping settings.

```json
{
  "id": 692730761,
  "sku": "123123",
  "thumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591923.jpg",
  "unlimited": true,
  "inStock": true,
  "name": "Toys",
  "nameTranslated": {
    "cs": "",
    "en": "Toys"
  },
  "price": 10,
  "priceInProductList": 10,
  "defaultDisplayedPrice": 10,
  "defaultDisplayedPriceFormatted": "€10,00",
  "tax": {
    "taxable": true,
    "defaultLocationIncludedTaxRate": 10,
    "enabledManualTaxes": [
      947976181
    ],
    "taxClassCode": "default"
  },
  "lowestPrice": 10,
  "defaultDisplayedLowestPrice": 10,
  "defaultDisplayedLowestPriceFormatted": "€10,00",
  "lowestPriceSettings": {
    "lowestPriceEnabled": true
  },
  "isShippingRequired": false,
  "hasFreeShipping": false,
  "url": "https://store1003.company.site/products/toys-692730761",
  "autogeneratedSlug": "toys-692730761",
  "customSlug": "",
  "created": "2024-09-04 07:20:11 +0000",
  "updated": "2024-09-04 07:20:12 +0000",
  "createTimestamp": 1725434411,
  "updateTimestamp": 1725434412,
  "productClassId": 0,
  "enabled": true,
  "options": [],
  "warningLimit": 1,
  "fixedShippingRateOnly": false,
  "fixedShippingRate": 0,
  "shipping": {
    "type": "GLOBAL_METHODS",
    "methodMarkup": 0,
    "flatRate": 0,
    "disabledMethods": [],
    "enabledMethods": []
  },
  "defaultCombinationId": 0,
  "imageUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591921.jpg",
  "smallThumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591920.jpg",
  "hdThumbnailUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591922.jpg",
  "originalImageUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591919.jpg",
  "originalImage": {
    "url": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591919.jpg",
    "width": 225,
    "height": 225
  },
  "borderInfo": {
    "dominatingColor": {
      "red": 255,
      "green": 255,
      "blue": 255,
      "alpha": 255
    },
    "homogeneity": true
  },
  "description": "",
  "descriptionTranslated": {
    "cs": "",
    "en": ""
  },
  "galleryImages": [],
  "media": {
    "images": [
      {
        "id": "0",
        "isMain": true,
        "orderBy": 0,
        "image160pxUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591920.jpg",
        "image400pxUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591923.jpg",
        "image800pxUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591922.jpg",
        "image1500pxUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591921.jpg",
        "imageOriginalUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/1003/4519591919.jpg",
        "alt": {
          "translated": {}
        }
      }
    ],
    "videos": []
  },
  "categoryIds": [],
  "categories": [],
  "defaultCategoryId": 0,
  "seoTitle": "Toys",
  "seoTitleTranslated": {
    "cs": "",
    "en": "Toys"
  },
  "seoDescription": "",
  "seoDescriptionTranslated": {
    "cs": "",
    "en": ""
  },
  "favorites": {
    "count": 0,
    "displayedCount": "0"
  },
  "attributes": [],
  "files": [
    {
      "id": 96178524,
      "name": "image.jpeg",
      "description": "",
      "size": 12006,
      "adminUrl": "https://app.ecwid.com/api/v3/1003/products/692730761/files/96178524"
    }
  ],
  "relatedProducts": {
    "productIds": [],
    "relatedCategory": {
      "enabled": false,
      "categoryId": 0,
      "productCount": 5
    }
  },
  "combinations": [],
  "dimensions": {
    "length": 0,
    "width": 0,
    "height": 0
  },
  "shippingPreparationTime": {},
  "showDeliveryTimeInStorefront": false,
  "volume": 0,
  "showOnFrontpage": 11,
  "isSampleProduct": false,
  "googleItemCondition": "NEW",
  "isGiftCard": false,
  "discountsAllowed": true,
  "nameYourPriceEnabled": false,
  "subscriptionSettings": {
    "subscriptionAllowed": false,
    "oneTimePurchaseAllowed": true,
    "recurringChargeSettings": [
      {
        "recurringInterval": "MONTH",
        "recurringIntervalCount": 1
      }
    ]
  },
  "googleProductCategory": 412,
  "googleProductCategoryName": "Food, Beverages & Tobacco",
  "productCondition": "NEW",
  "outOfStockVisibilityBehaviour": "SHOW"
}
```

--------------------------------

### Build and preview commands for local testing

Source: https://docs.ecwid.com/site-themes/develop-site-themes/dev-recommendations/build-validation-and-deployment.md

Run build and preview to test the theme locally. Preview should cover all page types, not just the home page.

```bash
npm run build
npm run preview
```

--------------------------------

### GET /api/v3/{storeId}/reviews Request Example

Source: https://docs.ecwid.com/api-reference/rest-api/products/product-reviews/search-product-reviews

Example HTTP request to search product reviews. Requires the Authorization header with a Bearer token and the read_reviews access scope.

```http
GET /api/v3/1003/reviews HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
```

--------------------------------

### Apply configuration with JavaScript code

Source: https://docs.ecwid.com/storefronts/store-configuration-settings/overview

Use this JavaScript snippet to set up configuration settings dynamically. It requires a custom application with a self-hosted JS file, as described in the Quickstart guide. The code initializes the Ecwid config object and includes a placeholder for your configurations.

```javascript
Ecwid.OnAPILoaded.add(function() {
    window.ec = window.ec || Object();
    window.ec.config = window.ec.config || Object();
    
    // configs
};
```

--------------------------------

### Full order response JSON example

Source: https://docs.ecwid.com/api-reference/rest-api/orders/get-order.md

Example of a complete order object returned by the Get Order endpoint, including fields such as 'countryName', 'postalCode', 'invoices', 'loyalty', and 'customerUserAgent'.

```json
{
    "countryName": "Spain",
    "postalCode": "08003",
    "stateOrProvinceCode": "AL",
    "stateOrProvinceName": "Alava",
    "phone": "0123456789"
},
"predictedPackage": [],
"shippingLabelAvailableForShipment": false,
"shipments": [],
"additionalInfo": {
    "google_customer_id": "1904890913.1707375888"
},
"paymentParams": {},
"extraFields": {},
"ticket": -455011247,
"hidden": false,
"taxesOnShipping": [],
"disableAllCustomerNotifications": false,
"externalFulfillment": false,
"utmDataSets": [],
"invoices": [
    {
        "internalId": 117352011,
        "id": "27",
        "created": "2024-09-04 07:22:09 +0000",
        "link": "https://app.ecwid.com/download_tax_invoice?ownerid=1003&invoice_id=117352011&access_key=z7clyftZJZj",
        "type": "SALE"
    }
],
"pricesIncludeTax": true,
"loyalty": {
    "customerEnabled": false,
    "earned": 0,
    "balance": 0
},
"customerUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
}
```

--------------------------------

### Options object example

Source: https://docs.ecwid.com/storefronts/manage-cart-and-checkout/add-product-to-the-cart.md

Example of the options object format for the product argument, mapping option names to values.

```json
"options": {  
    "Size": "M",  
    "Print_number": "9"  
}
```

--------------------------------

### Preview locally

Source: https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/deep-dive-into-crane-cli.md

Starts a local development server. Opens a preview URL in your terminal and supports hot reload; no need to restart after subsequent builds.

```bash
npx @lightspeed/crane@latest preview
```

--------------------------------

### GET /api/v3/{storeId}/reviews Response Example

Source: https://docs.ecwid.com/api-reference/rest-api/products/product-reviews/search-product-reviews

Example JSON response containing review items with fields such as id, status, rating, review text, reviewer info, and timestamps.

```json
{
  "total": 2,
  "count": 2,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "id": 712737671,
      "status": "published",
      "customerId": 8108179152,
      "productId": 123456,
      "orderId": "2D31G",
      "rating": 5,
      "review": "Just what I need",
      "reviewerInfo": {
        "name": "Abraham Smith",
        "email": "example_customer@example.com",
        "city": "New York",
        "orders": 2
      },
      "createDate": "2025-02-26 13:37:46 +0000",
      "updateDate": "2025-02-27 04:40:33 +0000",
      "createTimestamp": 1740562666,
      "updateTimestamp": 1740616833
    },
    {
      "id": 812738127,
      "status": "published",
      "customerId": 239921001,
      "productId": 123456,
      "orderId": "HI88G",
      "rating": 5,
      "review": "A really good product. Definitely worth buying!",
      "reviewerInfo": {
        "name": "John Doe",
        "email": "ec.apps@lightspeedhq.com",
        "city": "New York",
        "orders": 1
      },
      "createDate": "2024-12-02 10:00:00 +0000",
      "updateDate": "2024-12-02 10:00:00 +0000",
      "createTimestamp": 1733119200,
      "updateTimestamp": 1733119200
    }
  ]
}
```

--------------------------------

### Start local preview server with verbose logging

Source: https://docs.ecwid.com/site-themes/develop-site-themes/local-preview

Use the --verbose flag to enable additional debug logs that can help troubleshoot issues during local development.

```bash
npx @lightspeed/crane@latest preview --verbose
```

--------------------------------

### getStorefrontLang - Get storefront language

Source: https://docs.ecwid.com/site-themes/develop-site-themes/headless-api/storefront-js.md

Calls getStorefrontLang() to get the current storefront language in ISO 639-1 format. The example shows a comment with the expected result '"en"'.

```typescript
const lang = await getStorefrontLang()
// "en"
```

--------------------------------

### Response with promotion and coupon

Source: https://docs.ecwid.com/guides/orders/get-order-details/discounts-in-order-details.md

Example response showing discount details when a promotion and a coupon are applied to the order.

```json
{
    "volumeDiscount": 9,
    "membershipBasedDiscount": 0,
    "totalAndMembershipBasedDiscount": 0,
    "couponDiscount": 10,
    "customDiscount": [],
    "discount": 9,
    "discountInfo": [
        {
            "value": 10,
            "type": "PERCENT",
            "base": "ON_TOTAL",
            "orderTotal": 50,
            "description": "10% off on cart total above €50,00",
            "appliesToItems": [],
            "appliesToOrderItems": [],
            "triggeredByOrderItems": []
        }
    ],
    "discountCoupon": {
        "id": 224223294,
        "name": "Test Coupon #2",
        "code": "DISC2",
        "discountType": "PERCENT",
        "status": "ACTIVE",
        "discount": 10,
        "launchDate": "2024-09-01 23:00:00 +0000",
        "usesLimit": "UNLIMITED",
        "repeatCustomerOnly": false,
        "applicationLimit": "UNLIMITED",
        "creationDate": "2024-09-02 08:32:37 +0000",
        "updateDate": "2024-09-02 08:26:35 +0000",
        "orderCount": 0
    },
    "items": 
}
```

--------------------------------

### Get abandoned cart response

Source: https://docs.ecwid.com/api-reference/rest-api/orders/abandoned-carts/get-abandoned-cart

Example JSON response from the Get abandoned cart endpoint, containing cart details such as totals, customer information, discounts, items, and custom surcharges.

```json
{
  "cartId": "6626E60A-A6F9-4CD5-8230-43D5F162E0CD",
  "tax": 1.79,
  "subtotal": 29.95,
  "total": 37.39,
  "usdTotal": 37.39,
  "paymentMethod": "Purchase order",
  "refererUrl": "http://mysuperstore.ecwid.com/",
  "globalReferer": "",
  "createDate": "2014-09-20 19:59:43 +0000",
  "updateDate": "2014-09-21 00:00:12 +0000",
  "createTimestamp": 1427268654,
  "updateTimestamp": 1427272209,
  "hidden": false,
  "orderComments": "Test order comments",
  "email": "ec.apps@lightspeedhq.com",
  "ipAddress": "83.217.8.241",
  "customerId": 15319410,
  "customerGroupId": 12345,
  "customerGroup": "Gold",
  "customerTaxExempt": false,
  "customerTaxId": "",
  "customerTaxIdValid": false,
  "reversedTaxApplied": false,
  "membershipBasedDiscount": 0,
  "totalAndMembershipBasedDiscount": 2.85,
  "customSurcharges": [
    {
      "id": "tips",
      "value": 10,
      "type": "ABSOLUTE",
      "total": 10,
      "totalWithoutTax": 10,
      "description": "Tips",
      "descriptionTranslated": "Tips",
      "taxable": false,
      "taxes": [
        {
          "name": "VAT",
          "value": 21,
          "total": 1.7
        }
      ],
    }
  ],
  "couponDiscount": 1.5,
  "discount": 2.85,
  "volumeDiscount": 0,
  "discountCoupon": {
    "name": "Coupon # 3",
    "code": "5PERCENTOFF",
    "discountType": "PERCENT",
    "status": "ACTIVE",
    "discount": 5,
    "launchDate": "2014-06-06 00:00:00 +0000",
    "usesLimit": "UNLIMITED",
    "applicationLimit": "NEW_CUSTOMER_ONLY",
    "creationDate": "2014-09-20 19:58:49 +0000",
    "orderCount": 0
  },
  "discountInfo": [
    {
      "value": 10,
      "type": "PERCENT",
      "base": "ON_TOTAL_AND_MEMBERSHIP",
      "orderTotal": 15
    },
    {
      "value": 2,
      "type": "ABSOLUTE",
      "base": "CUSTOM",
      "description": "Buy more than 3 cherries and get $2 off!"
    }
  ],
  "items": [
    {
      "id": 40989227,
      "productId": 37208342,
      "categoryId": 9691094,
      "price": 5.99,
      "productPrice": 5.99,
      "weight": 0.32,
      "sku": "00004",
      "quantity": 5,
      "shortDescription": "Cherry\nThe word cherry refers to a fleshy fruit (drupe) that contains a single stony seed. The cherry belongs to the fa...",
      "tax": 1.79,
      "shipping": 10,
      "quantityInStock": 1981,
      "name": "Cherry",
      "isShippingRequired": true,
      "trackQuantity": true,
      "fixedShippingRateOnly": false,
      "imageUrl": "http://app.ecwid.com/default-store/00006-sq.jpg",
      "fixedShippingRate": 1,
      "digital": true,
      "couponApplied": false,
      "files": [
        {
          "productFileId": 7215101,
          "maxDownloads": 0,
          "remainingDownloads": 0,
          "expire": "2014-10-26 20:34:34 +0000",
          "name": "myfile.jpg",
          "description": "Sunflower",
          "size": 54492,
          "adminUrl": "https://app.ecwid.com/api/v3/4870020/products/37208340/files/7215101?token=123123123",
          "customerUrl": "http://mysuperstore.ecwid.com/download/4870020/a2678e7d1d1c557c202c3e4/image.jpg"
        }
      ],
      "selectedOptions": [
        {
          "name": "Size",
          "value": "Big",
          "valuesArray": [
            "Big"
          ],
          "selections": [
            {
              "selectionTitle": "Big",
              "selectionModifier": 4,
              "selectionModifierType": "PERCENT"
            }
          ],
          "type": "CHOICE"
        },
        {
          "name": "Attach a file",
          "type": "FILES",
          "files": [
            {
              "id": 5973037,
              "name": "test_image.jpg",
              "size": 54492,
              "url": "https://app.ecwid.com/orderfile/4870020/5973037/54492/test_image.jpg"
            }
          ]
        },
        {
          "name": "Choose date",
          "value": "2014-09-10",
          "type": "DATE"
        },
        {
          "name": "Any text",
          "value": "Test text",
          "type": "TEXT"
        }
      ],
      "taxes": [
        {
          "name": "Tax X",
          "value": 7,
          "total": 1.79,
          "taxOnDiscountedSubtotal": 1.79,
          "taxOnShipping": 0,
          "includeInPrice": false
        }
      ],
      "dimensions": {
      }
    }
  ]
}
```

--------------------------------

### GET /api/v3/1003/profile response

Source: https://docs.ecwid.com/api-reference/rest-api/store-profile/get-store-profile

Example JSON response containing generalInfo and account details for the store profile.

```json
{
    "generalInfo": {
        "storeId": 1003,
        "storeUrl": "https://store1003.company.site/products",
        "websitePlatform": "instantsite",
        "profileId": "p3855016",
        "starterSite": {
            "ecwidSubdomain": "demostore",
            "generatedUrl": "https://store1003.company.site",
            "storeLogoUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/1107529597.jpg",
            "ecwidSubdomainSuffix": "company.site",
            "slugsWithoutIdsEnabled": true
        }
    },
    "account": {
        "accountName": "API Team Store",
        "accountNickName": "Support team",
        "accountEmail": "ec.apps@lightspeedhq.com",
        "whiteLabel": false,
        "brandName": "Ecwid",
        "supportEmail": "support@ecwid.com",
        "suspended": false,
        "itunesSubscriptionsAvailable": false,
        "googlePlaySubscriptionsAvailable": true,
        "trackStorefrontStats": true,
        "availableFeatures": [
            "AFFILIATE",
            "BULK_INVOICE_PRINTING",
            "BULK_PRICES",
            "CDN",
            "COMBINATIONS",
            "COMPARE_TO_PRICE",
            "CSV_EXPORT",
            "CUSTOM_NOTIFICATIONS",
            "CUSTOMER_GROUPS",
            "DESTINATION_ZONES_LIMIT",
            "DISCOUNT_COUPONS",
            "DISCOUNTS",
            "EBAY_AMAZON_THIRD_PARTY",
            "GOOGLE_SHOPPING",
            "EDIT_INVOICE",
            "EGOODS",
            "EGOODS_LIMITS",
            "FACEBOOK_STORE",
            "FB_SYNC_PRODUCTS",
            "TRACKING_PIXELS",
            "AUTO_FACEBOOK_ADS",
            "GOOGLE_REMARKETING",
            "INVENTORY_TRACKING",
            "LOCAL_PICKUP",
            "MARKETPLACES",
            "ORDER_AMOUNT_LIMITS",
            "PREMIUM",
            "API",
            "SHIPMENT_TRACKING",
            "CUSTOM_DOMAIN",
            "CUSTOM_DOMAIN_STARTER_SITE",
            "HIDE_POWERED_BY_ECWID_BADGE_INSTANTSITE",
            "LINKUP_HIDE_BRANDING",
            "LINKUP_ACTIVATE_ANALYTICS",
            "STORE_STATS",
            "XERO",
            "PRODUCT_FILTERS",
            "FAVORITES",
            "HIDE_POWERED_BY_ECWID_NOTIFICATIONS",
            "VEND",
            "SQUARE_PAYMENTS",
            "HANDLING_FEE",
            "CHECKOUT",
            "ORDER_EDITOR",
            "PRIVATE_ADMIN_NOTES",
            "STRIPE_PAYMENTS",
            "STRIPE_STORED_CREDIT_CARD",
            "MOBILE",
            "ECWID_LIVE_CHAT",
            "ECWID_LIVE_CHAT_TRIAL",
            "AUTOMATIC_TAXES_US",
            "AUTOMATIC_TAXES_REST_OF_THE_WORLD",
            "VK_MARKET",
            "PRODUCT_DIMENSIONS",
            "PRINT_SHIPPING_LABELS",
            "SEO_FIELDS",
            "TAX_EXEMPT_CUSTOMERS",
            "CUSTOMER_TAX_ID",
            "FB_MESSENGER",
            "AUTO_ABANDONED_SALES_RECOVERY",
            "LEGACY_ABANDONED_SALES_VIEW",
            "MULTIADMIN",
            "SCHEDULED_PICKUP_OR_DELIVERY",
            "INSTAGRAM_SHOPPING",
            "STARTERSITE_SITEMAP",
            "INSTANT_SITE_VERIFICATION_CODE",
            "INSTANT_SITE_VERIFICATION_CODE_API",
            "INSTANT_SITE_CUSTOM_JS_CODE",
            "EXPORT_CONTACTS",
            "SHIPPING_PER_PRODUCT",
            "PRINTFUL",
            "CLOVER_PAY",
            "MULTILINGUAL_STORE",
            "GIFT_CARDS",
            "AUTO_YANDEX_ADS",
            "TRIGGERED_EMAILS",
            "MAILCHIMP",
            "WHOLESALE2B",
            "STOREFRONT_LABEL_EDITOR",
            "SET_DELIVERY_REGION_ON_MAP",
            "TIPS",
            "INSTANT_SITE_SALE_FEATURE",
            "WEBSITES_SALE_FEATURE",
            "BUY_BUTTONS_SALE_FEATURE",
            "WORDPRESS_SALE_FEATURE",
            "JOOMLA_SALE_FEATURE",
            "WIX_SALE_FEATURE",
            "WEEBLY_SALE_FEATURE",
            "SQUARESPACE_SALE_FEATURE",
            "RAPID_WEAVER_SALE_FEATURE",
            "PRODUCT_SUBTITLES_FEATURE",
            "PRODUCT_RIBBONS_FEATURE",
            "NAME_YOUR_PRICE_FEATURE",
            "TAX_INVOICES_FEATURE",
            "RECURRING_SUBSCRIPTION_FEATURE",
            "TIKTOK_SHOPS",
            "CHECKOUT_CUSTOM_FIELDS",
            "PRODUCT_DELIVERY_TIME_FEATURE",
            "COST_PRICE_FEATURE"
        ]
    }
}
```

--------------------------------

### Create Product Request Example

Source: https://docs.ecwid.com/api-reference/rest-api/products/create-product

Example HTTP request to create a product. Requires the create_catalog access scope and an Authorization header with a bearer token.

```http
POST /api/v3/1003/products HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
Content-Type: application/json
Cache-Control: no-cache

{
  "sku": "000012199",
  "quantity": 10,
  "name": "New Product",
  "price": 10,
  "compareToPrice": 15,
  "costPrice": 8,
  "isShippingRequired": false,
  "categoryIds": [
    9691094
  ],
  "weight": 10,
  "enabled": true,
  "description": "A <b>new</b> product description",
  "productClassId": 0,
  "volume": 500,
  "volumeUnit": "ml",
  "fixedShippingRateOnly": false,
  "fixedShippingRate": 1.2,
  "tax": {
    "enabledManualTaxes": [
      1117939042
    ],
    "taxable": true
  },  
  "options": [
    {
      "type": "RADIO",
      "name": "Size",
      "choices": [
        {
          "text": "Small",
          "priceModifier": 0,
          "priceModifierType": "ABSOLUTE"
        },
        {
          "text": "Large",
          "priceModifier": 15,
          "priceModifierType": "ABSOLUTE"
        }
      ],
        "defaultChoice": 0,
        "required": true
    }
  ],
  "shipping": {
    "type": "SELECTED_METHODS",
    "methodMarkup": 0,
    "flatRate": 0,
    "disabledMethods": [
      "1396442138-1534946367952"
    ],
    "enabledMethods": []
  }
}
```

--------------------------------

### App installed webhook JSON

Source: https://docs.ecwid.com/webhook-automations/learn-ecwid-webhooks/event-data-in-webhooks.md

Example payload for the application.installed event, with entityId duplicating store ID.

```json
{
  "eventId":"80aece08-40e8-4145-8764-6c2f0d38678",
  "eventCreated":1234567,
  "storeId":1003,
  "entityId":"1003", // duplicates store ID
  "eventType":"application.installed"
}
```

--------------------------------

### Get Last Order - Full Response JSON

Source: https://docs.ecwid.com/api-reference/rest-api/orders/get-last-order.md

Example of the full JSON response object returned by the 'Get Last Order' endpoint, including order details, shipping, payment, invoices, and customer information.

```json
{
    "countryCode": "ES",
    "countryName": "Spain",
    "postalCode": "08003",
    "stateOrProvinceCode": "AL",
    "stateOrProvinceName": "Alava",
    "phone": "0123456789"
},
"predictedPackage": [],
"shippingLabelAvailableForShipment": false,
"shipments": [],
"additionalInfo": {
    "google_customer_id": "1904890913.1707375888"
},
"paymentParams": {},
"extraFields": {},
"ticket": -455011247,
"hidden": false,
"taxesOnShipping": [],
"disableAllCustomerNotifications": false,
"externalFulfillment": false,
"utmDataSets": [],
"invoices": [
    {
        "internalId": 117352011,
        "id": "27",
        "created": "2024-09-04 07:22:09 +0000",
        "link": "https://app.ecwid.com/download_tax_invoice?ownerid=1003&invoice_id=117352011&access_key=z7clyftZJZj",
        "type": "SALE"
    }
],
"pricesIncludeTax": true,
"loyalty": {
    "customerEnabled": false,
    "earned": 0,
    "balance": 0
},
"customerUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
}
```

--------------------------------

### Ecwid.Customer.get request example

Source: https://docs.ecwid.com/storefronts/manage-customers-on-the-storefront/get-logged-in-customers-details.md

Calls Ecwid.Customer.get with a callback that logs the customer's email. The output is example@example.com.

```javascript
Ecwid.Customer.get(function(customer) { 
  console.log(customer.email);
});

// prints
// example@example.com
```
Tokens:
Raw