Account Request URL
-Base Endpoint
-
Orders
Retrieve a list of orders
orders
limit, offset, status, created_at_from, created_at_to, updated_at_from, updated_at_to, customer_id, order_number, source_order_id, supplier_order_id, tracking_number
Orders
Create a new order
orders
supplier_order_id, order_number, source_order_id, line_items
Orders
Retrieve a single order
orders/{id}
limit, offset, status, created_at_from, created_at_to, updated_at_from, updated_at_to, customer_id, order_number, source_order_id, supplier_order_id, tracking_number
Orders
Update an existing order
orders/{id}
supplier_order_id, order_number, source_order_id, line_items
Orders
Delete an existing order
orders/{id}
Order_Notes
Retrieve a list of order notes
orders/{order_id}/notes
limit, offset, created_at_from, created_at_to, updated_at_from, updated_at_to, author_id, body
Order_Notes
Create a new order note
orders/{order_id}/notes
author_id, body
Order_Notes
Retrieve a single order note
orders/{order_id}/notes/{id}
limit, offset, created_at_from, created_at_to, updated_at_from, updated_at_to, author_id, body
Order_Notes
Update an existing order note
orders/{order_id}/notes/{id}
author_id, body
Order_Notes
Delete an existing order note
orders/{order_id}/notes/{id}
Products
Retrieve a list of products
products
limit, offset, name, sku, description, brand, supplier_id, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Products
Create a new product
products
name, sku, description, brand, supplier_id, status
Products
Retrieve a single product
products/{id}
limit, offset, name, sku, description, brand, supplier_id, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Products
Update an existing product
products/{id}
name, sku, description, brand, supplier_id, status
Products
Delete an existing product
products/{id}
Product_Images
Retrieve a list of product images
products/{product_id}/images
limit, offset, created_at_from, created_at_to, updated_at_from, updated_at_to
Product_Images
Create a new product image
products/{product_id}/images
image
Product_Images
Retrieve a single product image
products/{product_id}/images/{id}
limit, offset, created_at_from, created_at_to, updated_at_from, updated_at_to
Product_Images
Update an existing product image
products/{product_id}/images/{id}
image
Product_Images
Delete an existing product image
products/{product_id}/images/{id}
Categories
Retrieve a list of categories
categories
limit, offset, name, parent_id, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Categories
Create a new category
categories
name, parent_id, status
Categories
Retrieve a single category
categories/{id}
limit, offset, name, parent_id, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Categories
Update an existing category
categories/{id}
name, parent_id, status
Categories
Delete an existing category
categories/{id}
Suppliers
Retrieve a list of suppliers
suppliers
limit, offset, name, email, phone, website, address, city, state, country, zip, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Suppliers
Create a new supplier
suppliers
name, email, phone, website, address, city, state, country, zip, status
Suppliers
Retrieve a single supplier
suppliers/{id}
limit, offset, name, email, phone, website, address, city, state, country, zip, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Suppliers
Update an existing supplier
suppliers/{id}
name, email, phone, website, address, city, state, country, zip, status
Suppliers
Delete an existing supplier
suppliers/{id}
Customers
Retrieve a list of customers
customers
limit, offset, first_name, last_name, email, phone, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Customers
Create a new customer
customers
first_name, last_name, email, phone, status
Customers
Retrieve a single customer
customers/{id}
limit, offset, first_name, last_name, email, phone, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Customers
Update an existing customer
customers/{id}
first_name, last_name, email, phone, status
Customers
Delete an existing customer
customers/{id}
Customer_Addresses
Retrieve a list of customer addresses
customers/{customer_id}/addresses
limit, offset, type, address1, address2, city, state, country, zip, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Customer_Addresses
Create a new customer address
customers/{customer_id}/addresses
type, address1, address2, city, state, country, zip, status
Customer_Addresses
Retrieve a single customer address
customers/{customer_id}/addresses/{id}
limit, offset, type, address1, address2, city, state, country, zip, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Customer_Addresses
Update an existing customer address
customers/{customer_id}/addresses/{id}
type, address1, address2, city, state, country, zip, status
Customer_Addresses
Delete an existing customer address
customers/{customer_id}/addresses/{id}
Refunds
Retrieve a list of refunds
refunds
limit, offset, order_id, amount, currency, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Refunds
Create a new refund
refunds
order_id, amount, currency, status
Refunds
Retrieve a single refund
refunds/{id}
limit, offset, order_id, amount, currency, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Refunds
Update an existing refund
refunds/{id}
order_id, amount, currency, status
Refunds
Delete an existing refund
refunds/{id}
Dispute
Retrieve a list of disputes
disputes
limit, offset, order_id, amount, currency, reason, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Dispute
Create a new dispute
disputes
order_id, amount, currency, reason, status
Dispute
Retrieve a single dispute
disputes/{id}
limit, offset, order_id, amount, currency, reason, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Dispute
Update an existing dispute
disputes/{id}
order_id, amount, currency, reason, status
Dispute
Delete an existing dispute
disputes/{id}
Events
Retrieve a list of events
events
limit, offset, resource, action, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Events
Retrieve a single event
events/{id}
limit, offset, resource, action, status, created_at_from, created_at_to, updated_at_from, updated_at_to
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.