REST API calls

Base URL: https://app.ecwid.com/api/v3/{storeId}

Full list of endpoints and calls below.

Store profile, checkout extra fields, shipping options, payment options

Endpoint | Supported HTTP calls

/profile

GET PUT

/profile/staffScopes

GET

/profile/order_statuses

GET

/profile/order_status/{statusId}

GET PUT

/profile/extrafields

GET POST

/profile/extrafields/{key}

GET PUT DELETE

/profile/logo

POST DELETE

/profile/invoicelogo

POST DELETE

/profile/emaillogo

POST DELETE

/profile/shippingOptions

GET POST

/profile/shippingOptions/{shippingOptionId}

PUT DELETE

/profile/paymentOptions

GET POST

/profile/paymentOptions/{paymentOptionId}

GET PUT DELETE

Store stats, deleted items history, store reports

GET /reports/{reportType}

GET /latest-stats

Orders

GET POST /orders

GET /orders/last

GET /orders/deleted

GET PUT DELETE /orders/{orderId}

GET /orders/{orderId}/repeatURL

GET /orders/{orderId}/invoice-pdf

GET /orders/{orderId}/invoices

GET POST /orders/{orderId}/extraFields

PUT DELETE /orders/{orderId}/extraFields/{extraFieldId}

POST /order/calculate

POST /orders/{orderId}/invoices/create-invoice

Abandoned carts

GET /carts

GET PUT /carts/{cartId}

POST /carts/{cartId}/place

Recurring subscriptions

GET /subscriptions

GET PUT /subscriptions/{subscriptionId}

Products, product variations, brands, classes, swatches

GET POST DELETE /products

GET PUT DELETE /products/{productId}

GET PUT DELETE products/{productId}/gallery/video/{galleryVideoId}

GET POST DELETE /products/{productId}/combinations

GET PUT DELETE /products/{productId}/combinations/{combinationId}

GET PUT /products/sort

GET /products/deleted

PUT /products/{productId}/inventory

PUT /products/{productId}/combinations/{combinationId}/inventory

PUT /products/{productId}/media

POST /products/filters

POST DELETE /products/{productId}/files

GET PUT DELETE /products/{productId}/files/{fileId}

POST DELETE /products/{productId}/image

POST /products/{productId}/image/async

POST DELETE /products/{productId}/video

POST DELETE /products/{productId}/gallery

POST /products/{productId}/gallery/async

POST /products/{productId}/gallery/video

POST DELETE /products/{productId}/combinations/{combinationId}/image

POST /products/{productId}/combinations/{combinationId}/image/async

DELETE /products/{productId}/gallery/{galleryImageId}

GET POST /classes

GET PUT DELETE /classes/{classId}

GET /brands

GET /swatches

Product reviews

GET /reviews

GET /reviews/filters_data

GET /reviews/deleted

PUT DELETE /reviews/{reviewId}

PUT /reviews/mass_update

Categories

GET POST /categories

GET /categoriesByPath

GET PUT DELETE /categories/{categoryId}

GET PUT /categories/sort

POST DELETE /categories/{categoryId}/image

POST /categories/{categoryId}/image/async

POST /categories/{categoryId}/assignProducts

POST /categories/{categoryId}/unassignProducts

Customers, customer groups, customer extra fields

GET POST /customers

GET PUT DELETE /customers/{customerId}

GET POST /customers/{customerId}/contacts

GET PUT DELETE /customers/{customerId}/contacts/{contactId}

GET POST /store_extrafields/customers

GET PUT DELETE /store_extrafields/customers/{extrafield_key}

GET POST /customer_groups

GET PUT DELETE /customer_groups/{groupId}

GET /customers/deleted

Promotions, discount coupons

Endpoint | Supported HTTP calls

/promotions

GET POST

/promotions/{promotionId}

PUT DELETE

/discount_coupons/

GET POST

/discount_coupons/{discountCouponId}

GET PUT DELETE

/coupons/deleted

GET

Domains

GET PUT /domains

GET /domains/search

POST /domains/purchase

POST /domains/send_domain_verification_email

POST /domains/reset_domain_password

Dictionaries

GET /countries

GET /currencies

GET /currencyByCountry

GET /states

GET /taxClasses

Staff accounts

GET POST /staff

GET PUT DELETE /staff/{staffAccountId}

Last updated

Was this helpful?