Introduction
Authentication
Banners
get
Retrieve a list of banner groups
post
Create a banner group
get
Retrieve a banner group
patch
Modify a banner group
del
Delete a banner group
get
Retrieve a list of banners.
post
Create a banner
get
Retrieve a banner
patch
Modify a banner
del
Delete a banner
get
Retrieve a banner designated by its banner code
patch
Modify a banner designated by its banner code
del
Delete a banner designated by its banner code
Brands
get
Retrieve a list of brands
get
Retrieve a brand
patch
Modify a brand
del
Delete a brand
Campaigns
get
Retrieve a list of campaigns
get
Retrieve a campaign
patch
Modify a campaign
patch
Change campaign prices
del
Delete campaign prices
Categories
get
Retrieve a list of categories
get
Retrieve a category
patch
Modify a product category
del
Delete a product category
get
Retrieve a category by its external ID
patch
Modify a category designated by its external ID
get
Retrieve a list of a category's subcategories
get
Retrieve a list of a category's visibilities
patch
Modify a category's visibilities.
get
Retrieve a list of a category's product links
Customers
get
Retrieve a list of customer groups
post
Create a customer group
get
Retrieve a customer group
patch
Modify a customer group
del
Delete a customer group
get
Retrieve a list of a customer group's customer links
post
Attach a customer to a customer group
del
Remove a customer from a customer group
get
Retrieve a list of customers
post
Create a new customer account
get
Retrieve a customer
patch
Modify a customer's details
del
Delete a customer account
get
Retrieve a customer's shipping addresses
get
Retrieve a customer designated by their email address
del
Delete a customer account designated by their email address
get
Retrieve a customer by their external ID
del
Delete a customer account designated by their external ID
Email Subscribers
get
Retrieve a list of email subscribers
post
Add a new subscriber to your mailing list
del
Remove a subscriber from the store's mailing list
Gift Cards
get
Retrieve a list of gift cards
post
Create a new gift card
get
Retrieve a gift card
patch
Modify a gift card
Images
get
Retrieve a list of images
post
Submit a new product image
get
Retrieve an image using its ID
get
Retrieve an image using its filename
Info Pages
get
Retrieve a list of info pages
post
Create a new info page
get
Retrieve an info page
patch
Modify an info page
del
Delete an info page
get
Retrieve an info page
News
get
Retrieve a list of news posts
post
Create a news post
patch
Modify a news post
del
Delete a news post
Orders
get
Retrieve a list of orders
post
Create a new order
get
Retrieve an order
get
Retrieve an order using its external ID
post
Run quick processing for an order
post
Cancel an order
post
Archive an order
post
Post a new comment (private or public) for the order
get
Retrieve a payment transaction
post
Activate the payment
post
Cancel a payment
post
Mark the payment as paid
post
Mark the payment as unpaid
get
Retrieve a list shipments
get
Retrieve a shipment
post
Mark shipment as delivered
post
Register shipment to access its shipping label and tracking code (if available)
get
Retrieve a shipment's shipping label
get
Retrieve a shipment's dispatch note
Payment Methods
get
Retrieve a list of payment methods.
get
Retrieve a payment method
patch
Modify a payment method
Processing Lists
get
Retrieve a list of processing lists
del
Delete a processing list
post
Complete a processing list
Product Attributes
get
Retrieve a list of product attributes
post
Create a new product attribute
get
Retrieve a product attribute
patch
Modify a product attribute
del
Delete a product attribute
post
Add a new value to a product attribute
patch
Modify a product attribute value
del
Delete a product attribute's value
Products
get
Retrieve a list of products
post
Create a new product
get
Retrieve a product
patch
Modify a product
del
Delete a product
get
Retrieve a list of a product's variations
post
Create a new variation for a product
get
Retrieve a product variation
patch
Modify a product variation
del
Delete a product's variation
patch
Modify a product variation's features
get
Retrieve a list of a product's customization options
post
Create a new customization option for a product
get
Retrieve a specific customization option of a product
patch
Modify a product option
del
Delete a product's customization option
get
Retrieve a list of gift cards
post
Add a new choice to a product's customization option
get
Retrieve a choice of a product customization option
patch
Modify a product option choice
del
Delete a choice of a product's customization option
patch
Modify a product's features or attach new features to the product
get
Retrieve a product's category links
post
Attach a product to a category
del
Remove a product from a category
get
Retrieve a product's image links
post
Add a new image for a product
del
Detach an image designated by the filename from a product
del
Detach an image designated by its ID from a product
get
Retrieve a list of a product's visibilities in different store versions
patch
Modify a product's visibilities in different store versions
get
Retrieve a list of a product's translations
patch
Modify a product's translations
get
Retrieve a product using its product code
get
Retrieve a product using its supplier code
Shipping Methods
get
Retrieve a list of shipping methods
get
Retrieve a shipping method
patch
Modify a shipping method
get
Retrieve a shipping method's costs
SMS Subscribers
get
Retrieve a list of SMS marketing subscribers
post
Add new SMS subsciber
get
Retrieve an SMS subscriber
del
Unsubscribe an SMS subscriber
Stock
get
Retrieve a list of stock items
get
Retrieve a product's stock item using the product code
patch
Modify a stock item
post
Update the balance of the stock item
get
Retrieve a list of stock changes
get
Retrieve a list of stock locations
get
Get stock location
put
Create stock location
del
Delete stock location
get
List stock quantities by product code
patch
Update stock quantities by product code
del
Delete the entire stock quantity of a product in the specified stock location
Suppliers
get
Retrieve a list of suppliers
post
Create a new supplier
get
Retrieve a supplier
