File


Method API Description
GET v1/Files/{fileId}

Get a specified File object.
GET v1/Files/{fileId}/Stream

No documentation available.

VoipCalls


Method API Description
GET v1/Shops/{shopId}/VoipCalls

Get a list with all available VoipCalls, for given shop.
GET v1/VoipCalls/{VoipCallId}

Get detailed information about an VoipCall.

EMails


Method API Description
GET v1/Shops/{shopId}/Emails

Get a list with all available EMails, for given shop.
GET v1/EMails/{mailId}

Get detailed information about an EMail.
GET v1/Shops/{shopId}/EMailboxes

Get all EMailboxes which are available.
POST v1/Shops/{shopId}/SendMail

Sends the email. If the selected template contains a recipient, it will be used instead of the order contact.
GET v1/Shops/{shopId}/EmailTemplates

Gets the email templates of a Shop.
GET v1/ShopOwners/{shopOwnerId}/EmailTemplates

Gets the email templates of a Shop Owner.
GET v1/EmailTemplates

Gets the global email templates.
GET v1/Mail/Rate/{token}/{rating}

No documentation available.

Shipments


Method API Description
GET v1/ShippingTypes

Get a list with all available Shipping Types.
GET v1/Shops/{shopId}/Shipments

Get a list with all available Shipments, for given shop.
GET v1/ShopOwners/{shopOwnerId}/CarrierAccounts

Get a list with all CarrierAccounts.

ShopOwners


Method API Description
GET v1/ShopOwners

Get a list with all available ShopOwners for the logged in user.
GET v1/ShopOwners/{shopOwnerId}

Get detailed information about a ShopOwner.
POST v1/ShopOwners

Add a new ShopOwner.
PUT v1/ShopOwners

Update an existing ShopOwner.
GET v1/ShopOwners/{shopOwnerId}/ShopGroups

Get all ShopGroups for the ShopOwner.
GET v1/ShopGroups/{shopGroupId}

Get detailed information about a ShopGroup.
POST v1/ShopGroups

Add a new ShopGroup for a ShopOwner.
PUT v1/ShopGroups

Update an existing ShopGroup.
DELETE v1/ShopGroups/{shopGroupId}

Delete given ShopGroup.

Warehouses


Method API Description
GET v1/Warehouses

Get a list with all available Warehouses for the logged in user.
GET v1/Warehouses/{warehouseId}

Get detailed information about a Warehouse.
POST v1/Warehouses

Add a new Warehouse.
PUT v1/Warehouses

Update an existing Warehouse.
DELETE v1/Warehouses/{warehouseId}

Delete given Warehouse.
GET v1/Warehouses/{warehouseId}/Stock

Get a list with all product stock available in the Warehouse, grouped by ProductCode.
GET v1/Warehouses/{warehouseId}/StockPerLocation

Get a list with all location product stock available in the Warehouse, grouped by ProductCode.
GET v1/Warehouses/{warehouseId}/Locations

Get all locations in the Warehouse.
GET v1/Warehouses/Locations/{warehouseLocationId}

Get detailed information about a WarehouseLocation.
POST v1/Warehouses/Locations

Add a new WarehouseLocation for a Warehouse.
PUT v1/Warehouses/Locations

Update an existing WarehouseLocation.
DELETE v1/Warehouses/Locations/{warehouseLocationId}

Delete given WarehouseLocation. Keep in mind that a location can only be deleted when there is no stock available.
GET v1/Warehouses/Locations/{warehouseLocationId}/Stock

Get a list with all product stock available in the WarehouseLocation.
PUT v1/Warehouses/{warehouseId}/Product/QtyAvailable

Update the Product Quantity available in the Warehouse.

Suppliers


Method API Description
GET v1/ShopOwners/{shopOwnerId}/Suppliers

Get a list with all Suppliers for specified Shop owner.
GET v1/Suppliers

Get a list with all Suppliers available for the logged in user.
GET v1/Suppliers/{id}

Get detailed information about a Supplier.
POST v1/Suppliers

Add a new Supplier.
PUT v1/Suppliers

Update an existing Supplier.
DELETE v1/Suppliers/{id}

Delete given Supplier.
GET v1/Suppliers/{id}/Products

Get a list with all Products available by the Supplier.

ProductSelections


Method API Description
GET v1/Shops/{shopId}/ProductSelections

Get a list with all available Product selections for given shop.
GET v1/Shops/{shopId}/DefaultProductSelection

Get the default Product selection for given shop
GET v1/ProductSelections/{productSelectionId}/ProductSelectionProducts

Get a list with all Products in given Product selection.
GET v1/Shops/{shopId}/ActiveProductSelectionProducts

Get a list with all Products which are available for given Shop.
GET v1/ProductSelectionProducts/{id}

Get detailed information about a Product in the ProductSelection.
POST v1/ProductSelections/{productSelectionId}/ProductSelectionProducts

Add a new Product to the Product selection.
PUT v1/ProductSelectionProducts

Update an existing Product from a Product selection.
DELETE v1/ProductSelectionProducts/{id}

Remove given Product from the Product selection.

VATTariffs


Method API Description
GET v1/Shops/{shopId}/VATTariffs

Get a list with all VAT tariffs which are available for given Shop.

Payments


Method API Description
GET v1/Shops/{shopId}/PaymentTypes

Get a list with all available PaymentTypes for given shop.
DELETE v1/Payments/{paymentId}

Delete given Payment.

Orders


Method API Description
GET v1/Shops/{shopId}/Orders

Get a list with all available Orders, for given shop.
POST v1/Shops/{shopId}/Orders

Add a new Order .
PUT v1/Orders

Update an existing Order.
DELETE v1/Orders/{orderId}

Delete given Order.
GET v1/Orders/{orderId}

Get detailed information about an Order.
GET v1/Shops/{shopId}/Orders/{orderCode}

Get detailed information about an Order.
GET v1/Shops/{shopId}/OrdersByExternalOrderKey/{externalOrderKey}

Get detailed information about an Order.
GET v1/Orders/{orderId}/Rows

Get a list with all order rows for a given order.
POST v1/Orders/{orderId}/Rows

Adds the specified order row.
PUT v1/Orders/{orderId}/Rows

Update an existing order row.
DELETE v1/Orders/{orderId}/Rows/{orderRowId}

Delete given order row.
GET v1/Orders/{orderId}/OrderComments

Get a list with all order comments of a given order.
POST v1/Orders/{orderId}/OrderComments

Adds the specified order identifier.
GET v1/Orders/{orderId}/Payments

Get a list with all payments for a given order.
POST v1/Orders/{orderId}/Payments

Adds the specified payment.
PUT v1/Orders/{orderId}/Payments

Update an existing Payment.
PUT v1/Orders/{orderId}/MainStatus/{statusId}

Update the Main Order status.
PUT v1/Orders/{orderId}/FulfilmentStatus/{statusId}

Update the Fulfillment Order status.
PUT v1/Orders/{orderId}/ShipmentStatus/{statusId}

Update the Shipment Order status.
PUT v1/Orders/{orderId}/StockStatus/{statusId}

Update the Stock Order status.
PUT v1/Orders/{orderId}/PaymentStatus/{statusId}

Update the Payment Order status.
PUT v1/Orders/{orderId}/CustomStatus/{statusId}

Update the Custom Order status.
GET v1/Shops/{shopId}/OrderStatuses

Get a list with all available Orders Statuses, for given shop.
GET v1/BaseOrderStatuses

Get a list with the base order statuses.
GET v1/OrderStatusTypes

Get a list with the Order Status types.
GET v1/Orders/{orderId}/Shipments

Get a list with all shipments for a given order.
POST v1/Orders/{orderId}/Shipments

Adds the specified shipment.
PUT v1/Orders/{orderId}/Shipments

Update an existing Shipment.

Countries


Method API Description
GET v1/Countries

Get a list with all available Countries.

ExchangeRates


Method API Description
GET v1/ExchangeRates

Get a list with all available Exchange Rates.

Currencies


Method API Description
GET v1/Currencies

Get a list with all available Currencies.

UOM


Method API Description
GET v1/Uoms

Get a list with all available UOMs.

Cultures


Method API Description
GET v1/Cultures

Get a list with all available Cultures.

ProductGroups


Method API Description
GET v1/ShopGroups/{shopGroupId}/ProductGroups

Get a list with all available Product groups, for given shop group.
GET v1/ProductGroups/{id}

Get detailed information about a Product group.
POST v1/ProductGroups

Add a new Product group.
PUT v1/ProductGroups

Update an existing Product group.
DELETE v1/ProductGroups/{id}

Delete given Product group. The children of the Product group will also be deleted.
GET v1/ProductGroups/{id}/Image

Get the Product group image.
DELETE v1/ProductGroups/{id}/Image

Delete the Product group image.
POST v1/ProductGroups/{id}/Image

Post a new image for given Product group.
GET v1/ProductGroups/{productGroupId}/Products

Get a list with all Products in given ProductGroup.

Customers


Method API Description
GET v1/ShopOwners/{shopOwnerId}/Customers

Get a list with all Customers for specified Shop owner.
GET v1/ShopOwners/{shopOwnerId}/Customers/CustomerCode/{customerCode}

Get a list with all Customers for specified Shopowner and specific CustomerCode. The id of the Shopowner.
GET v1/Customers

Get a list with all Customers available for the logged in user.
GET v1/Customers/{id}

Get detailed information about a Customer.
POST v1/Customers

Add a new Customer.
PUT v1/Customers

Update an existing Customer.
DELETE v1/Customers/{id}

Delete given Customer.
POST v1/Customers/{id}/Shops/{shopId}

Add a new shop - customer relation.

Shops


Method API Description
GET v1/Shops

Get a list with all available Shops for the logged in user.
GET v1/ShopGroups/{shopGroupId}/Shops

Get a list with all available Shops, for given shop group.
GET v1/Shops/{shopId}

Get detailed information about a Shop.
POST v1/Shops

Add a new Shop for a ShopOwner.
PUT v1/Shops

Update an existing Shop.
DELETE v1/Shops/{shopId}

Delete given Shop.
GET v1/Shops/ShopStatus

Get a list with all available Shops for the logged in user. The status info contains info about last mail/order synchronization.
GET v1/Shops/LastOrderSyncTimestamp

Gets the last order synchronize timestamps.
PUT v1/Shops/{shopId}/Product/ForeignPriceIncVAT

Update the Product price for a Shop. The price is in the default Shop currency, and is specified including VAT. An existing Product must be specified.

Products


Method API Description
GET v1/ShopGroup/{shopGroupId}/Products

Get a list with all available Products, for given shop group.
GET v1/ShopGroup/{shopGroupId}/Products/{productCode}

Get detailed information about a product, based on the unique ProductCode (SKU).
GET v1/Products/{productId}

Get detailed information about a product.
POST v1/Products

Add a new Product.
PUT v1/Products

Update an existing Product.
DELETE v1/Products/{productId}

Delete given Product.
GET v1/Products/{productId}/Image/{imageFileId}

Get the specified Product image.
DELETE v1/Products/{productId}/Image/{imageFileId}

Delete the Product image.
POST v1/Products/{productId}/Image

Post a image for given Product. Specify a valid image Id to update an existing product image. Set the image Id to 0 to create a new one. There can be only one product image with Sequence=0, this is the main prdouct image.
GET v1/Products/{productId}/StockPerLocation

Get a list with all available stock per WarehouseLocation.
POST v1/Products/{productId}/UpdateStock

Update the stock QTY for given product.
POST v1/Products/{productId}/MoveStock

Move stock from one location to an other location for given product.
GET v1/ShopOwners/{shopOwnerId}/ProductPropertyDefinitions

Get all Product Property definitions.
GET v1/Products/{productId}/Properties

Get all Product Properties.
PUT v1/Products/{productId}/Properties

Update a Product Property.
DELETE v1/Products/{productId}/Properties

Delete a specific Product Property.
GET v1/Products/{productId}/Suppliers

Get a list with all Suppliers who supply given product.
GET v1/PurchaseProduct/{purchaseProductId}

Get detailed information about a PurchaseProduct.
PUT v1/PurchaseProduct

Update an existing PurchaseProduct.
DELETE v1/PurchaseProduct/{purchaseProductId}

Remove given PurchaseProduct.