Jump to Content

v1.0

Home Dashboard Log In

API Reference

v1.0API Reference

All

Pages

Start typing to search…

Getting Started

AliExpress

Documents
- Get order documents (AliExpress)get
Orders
- Orders (AliExpress)get
- Order (AliExpress)get
Fulfillments
- Fulfillment (AliExpress)post
- Fulfillment (AliExpress)put
Carriers
- Carriers (AliExpress)get
Products
- Products (AliExpress)get
- Product (AliExpress)get
Webhooks

Allegro

Customers
Orders
- Get all orders (Allegro)get
- Get single order (Allegro)get
Fulfillments
- Get order fulfillments (Allegro)get
- Create Order Fulfillment (Allegro)post
Products
Shippings
- Get all shipping methods (Allegro)get
- Get all shipping carriers (Allegro)get
Store
- Get a store (Allegro)get

Amazon

V1
V2

BigCommerce

Addresses (orders only)
- Get order address (BigCommerce)get
Categories
Customers
Locations
- Locations (BigCommerce)get
- Get a single location (BigCommerce)get
Orders
Fulfillments
Packages (destination only)
- Order packages (BigCommerce)get
- Get order addresses (BigCommerce)get
Products
Live shippings rates
Store
- Get store (BigCommerce)get
Webhooks

Bling

Orders
Fulfillments
Products
Webhooks
- Create Webhook (Bling)post
- Get Webhooks (Bling)get

Cdiscount

Orders
- Get all orders (Octopia)get
- Get a single order (Octopia)get
Fulfillments
- Get all order´s fulfillments (Octopia)get
- Fulfillment (Octopia)post
Products
- Get all products (Octopia)get
- Get a single product (Octopia)get
Store
- Get store information (Octopia)get

CS-Cart

Categories
Customers
- Get customer (CS-Cart)get
- Get customers (CS-Cart)get
Orders
Fulfillments
Products
Shippings
- Get a shipping (CS-Cart)get
- Get shippings (CS-Cart)get
Store
- Get store (CS-Cart)get
- Get stores (CS-Cart)get

ClaroShop

Category
- Get all categories (ClaroShop)get
- Category (ClaroShop)get
Orders
- Orders (ClaroShop)get
- Get a order (ClaroShop)get
Fulfillments
- Fulfillment (ClaroShop)post
Products

Ecart

Categories
- Get selected category (Ecart)get
- Get all available categories (Ecart)get
Orders
Fulfillments
Products
Products Variants
Store
- Store (Ecart)get
- All stores (Ecart)get

Ecwid

Carts
Categories
Customers
Orders
Orders Fulfillments
Products
Store
- Store (Ecwid)get

Etsy

Categories
Carriers
- Carriers (Etsy)get
Orders
Fulfillments
- Get Fulfillments (Etsy)get
- Create fulfillment (Etsy)post
Payments
- Get payments (Etsy)get
Policies
- Return policy (Etsy)get
- Return policies (Etsy)get
Products
Shippings
- Get a shipping (Etsy)get
- Get all shippings (Etsy)get
Store

Jumpseller

Categories
Customers
Orders
Fulfillments
Products
Live Shipping Rates
Store
- Get store (Jumpseller)get

Kometia

Categories
Customers
Orders
- Get all orders (Kometia)get
- Get a single order (Kometia)get
Orders Fulfillments
Products

Linio

Categories
- Get all categories (Linio)get
Orders
- Get all orders (Linio)get
- Get order info (Linio)get
Products
Fulfillments
- Create order fulfillment (Linio)post

Liverpool

Orders
- Get order information (Liverpool)get
- Get orders (Liverpool)get
Documents
- Documents (Liverpool)get
Fulfillments Events
- Create fulfillment event (Liverpool)post
Fulfillments
- Fulfillment (Liverpool)post
- Fulfillment (Liverpool)get
Packages
- Packages (Liverpool)get
Products
- Get Products (Liverpool)get
- Get product information (Liverpool)get

Loja

Categories
Customers
Orders
- Get orders (Loja)get
- Get a order (Loja)get
Fulfillments
- Get order fulfillments (Loja)get
- Create order fulfillment (Loja)post
Products
- Get products (Loja)get
- Get a single product (Loja)get

Miravia

Categories
- Get all categories (Miravia)get
Orders
- Get all orders (Miravia)get
- Get a single order (Miravia)get
Fulfillments
- Get fulfilments (Miravia)get
- Create fulfillment (Miravia)post
Packages
- Get packages (Miravia)get
- Create package (Miravia)post
Products
- Get all products (Miravia)get
- Get a single product (Miravia)get

Multivende

Categories
Customers
Locations and Inventory
Orders
- Get orders (Multivende)get
- Update order (Multivende)put
Fulfillments
Documents
- Download zip document (Multivende)get
- Create document (Multivende)post
Payments
- Get payments (Multivende)get
Products
Shippings
- Get shippings (Multivende)get
Store
- Get store information (Multivende)get

Odoo

Orders
- Get all orders (Odoo)get
- Get a single orders (Odoo)get
Fulfillments
Products
- Get all products (Odoo)get
- Get a single product (Odoo)get
Carriers
- Get all available carriers for a fulfillment (Odoo)get

QuickBooks

Customers
Orders
Products
Store
- get Store (QuickBooks)get
Taxes
Webhooks

Shein

Orders
Fulfillments
Products
- Get all productsget
- Get a single productget
Categories
- Get all categoriesget
Webhooks

ShipHero

Orders
Fulfillments
- Get a single order fulfillment (ShipHero)get
- Get all order's fulfillments (ShipHero)get
Products
Refreshtoken
- refreshtoken (ShipHero)post

Shopify

Orders
Billing
Categories
Cupons
Customers
Locations
Metafields
Fulfillments
Orders Returns
Packages
Products
Store
Webhooks
Services

Shoplazza

Customers
- Get customers (Shoplazza)get
- Get a customer (Shoplazza)get
Orders
Fulfillments
Products
Store
- Get store (Shoplazza)get

SquareSpace

Orders
Fulfillments
- Order fulfillment (SquareSpace)post
Products
Products Variants
Store
- Store information (SquareSpace)get

Temu

Locations
- Get locations (Temu)get
Orders
- Get Orders (Temu)get
- Get single Order (Temu)get
Fulfillments
Products
Carriers
- Get carriers (Temu)get
Store
- Get store id (Temu)get

TikTok

Categories
- Get a category (TikTok)get
- Get categories (TikTok)get
Inventories
- Get inventories (TikTok)get
- Update inventory (TikTok)put
Locations
- Get locations (TikTok)get
Orders
Fulfillments
Packages
- Get packages (TikTok)get
- Get package (TikTok)get
Products
Services
- Carriers
  - Get carriers (allowed for ecommerce) (TikTok)get
Stores
- Get stores (TikTok)get
Webhooks

Tiny

Customers
Orders
Fulfillments
Products
Carriers
- Get Carriers (Tiny)get
Shippings
- Get Shippings (Tiny)get

Tray

Store
- Get Store (Tray)get
Categories
Cupons
Orders
Fulfillments
- Get Fulfillments (Tray)get
- Post Fulfillment (Tray)post
Products
Services
- Carriers
  - Get all Carriers (Tray)get
  - Crear Single Carrier Service (Tray)post
- Get Product Variant (Tray)get
Webhooks

VendHq

Categories
- Get all categories (VendHq)get
- Get single category (VendHq)get
Customers
Orders
Products

Verskis

Orders

Vtex

Categories
- Get single category (Vtex)get
- Get all categories (Vtex)get
Orders
Fulfillments
- Fulfillment (Vtex)post
Payments
Products
- Get single product (Vtex)get
- Get all products (Vtex)get

Walmart

Orders
Fulfillments
- Gets all order's fulfillments (Walmart)get
- Create Fulfillment (Walmart)post
Products
Webhooks

Weebly

Categories
Orders
- Get all orders (Weebly)get
Get selected order (Weebly)get
Fulfillments
- Get all fulfillments (Weebly)get
- Get selected fulfillment (Weebly)get
Products

Wix

Orders
Fulfillments
Products
Refreshtoken
- Refreshtoken (Wix)post

Yampi

Categories
Customers
Orders
- Get orders (Yampi)get
- Get a order (Yampi)get
Orders Fulfillments
Fulfillments Events
Products
Live shipping rates
- Create carrier service (Yampi)post
- Delete carrier service (Yampi)del
Webhooks

Magento 1

Categories
- Get selected category (Magento 1)get
Customers
- Get all costumers (Magento 1)get
- Get a single costumer (Magento 1)get
Orders
- Get all orders (Magento 1)get
- Get a single order (Magento 1)get
Products
- Get all products (Magento 1)get
- Get a single product (Magento 1)get

Magento 2

Categories
Customers
Orders
Fulfillments
Products

Mercado Libre

Categories
- Get all categories (Mercado Libre)get
- Get selected category (Mercado Libre)get
Locations
Orders
Documents
- Fulfillment Label Download (Mercado Libre)get
Fulfillments
Fulfillment Events
- Create fulfillment event (Mercado Libre)post
Messages
Products
Refreshtoken
- Refreshtoken (Mercado Libre)post
Shippings
- Get shippings (Mercado Libre)get
Store
- Get store information (Mercado Libre)get
Webhooks

SalesForce Enterprise

Customers
Orders
Products
Refreshtoken
- RefreshToken (SalesForce Enterprise)post

Tienda Nube

Products
Categories
Customers
Orders
Services
Fulfillment Events
Webhooks
Packages ((Multi-Locations required))
- Packages order (Tienda Nube)get
New Locations (Tienda Nube gradual release in process)
- Get a location (Tienda Nube)get
Fulfillments ((Multi-Locations required))

Zoho Inventory

Customers
Orders
Orders Fulfillments
Orders Fulfillments Events
- Create fulfillment event (Zoho Inventory)post
Packages
Products
Refreshtoken
- Refreshtoken (Zoho Inventory)post

WooCommerce

Categories
Cupons
Customers
Orders
Fulfillments
Products
Shippings
- Get a shippings (WooCommerce)get
- Get all shippings (WooCommerce)get
Shippings Zones
Store
- Get store (WooCommerce)get
Webhooks

Ebay

Orders
- Get orders (Ebay)get
- Get a single order (Ebay)get
Fulfillments
Products
Product Variants
Products Listings
Policies
Categories
Locations

Nopcommerce

Categories
Customers
Orders
Fulfillments
Products

PrestaShop

Addresses
- Get an address (PrestaShop)get
- Get addresses (PrestaShop)get
Carts
Categories
Customers
Orders
Fulfillments
Products
Shippings
- Get Shipping (PrestaShop)get
Webhooks
- Create Webhook (PrestaShop)post

Opencart

Carts
- Product (Opencart)get
Orders
Fulfillments
- Fulfillment (Opencart)post
Products
- Products (Opencart)get
- Get product (Opencart)get
Refreshtoken
- Refreshtoken (Opencart)post

Powered by

Delete Metafield Values for orders (Shopify)

delete

https://api.ecartapi.com/api/v2/metafields/orders/{orderId}

Language

Credentials

Header

Click Try It! to start a request and see the response here!