Vat

Provides access to the VAT repository.

APIDescriptionRemarks
GET API/Vat/{vatId}

Get a specific VAT definition.

Returns a collection with a single item rather than just the item itself.

GET API/Vat

Get all VAT definitions.

Product

Provides access to the product repository

APIDescriptionRemarks
GET API/Product/{productId}?productIdType={productIdType}&include={include}

Get a specific product.

POST API/Product/Query?include={include}

Query products.

POST API/Product/Query/{page}?include={include}

Query products with pagination. The ProductQuery.BatchId property is mandatory when fetching a page other than the first page. If no BatchId is provided for the first page, a new batch is created and the BatchId can be found in the Envelope`1.PageResult field.

POST API/Product?include={include}

Create a new product.

PUT API/Product/{productId}?productIdType={productIdType}&include={include}

Updates a product.

POST API/Product/{productId}/Category?productIdType={productIdType}

Adds a category relation to a product.

PUT API/Product/{productId}/Category?productIdType={productIdType}

Adds a category relation to a product.

POST API/Product/MonitorAvailability

No documentation available.

GET API/Product/Item/{itemId}?productItemIdType={productItemIdType}

Get a specific product item.

GET API/Product/Items

Get all product items.

GET API/Product/Items/{page}

Get all product items with pagination.

POST API/Product/{productId}/Item?productIdType={productIdType}

Create a new product item.

PUT API/Product/Items?productItemIdType={productItemIdType}

Updates product items in batch

PUT API/Product/Item/{itemId}?productItemIdType={productItemIdType}

Updates a product item.

PUT API/Product/Stock?productItemIdType={productItemIdType}

Update stock values for multiple product items.

POST API/Product/Stock/Query

Query stock.

POST API/Product/{productId}/Image/{imageName}?isPrimaryImage={isPrimaryImage}&productIdType={productIdType}

Adds an image relation to a product.

PUT API/Product/{productId}/Image/{imageName}?isPrimaryImage={isPrimaryImage}&productIdType={productIdType}

Adds an image relation to a product.

GET API/Product/Feeds

Gets a list of all feeds.

GET API/Product/RelationTypes

Gets a list of product relation types.

PUT API/Product/{productId}/Related/{relationTypeId}?productIdType={productIdType}

Add related products to a product using a fixed relation type.

PUT API/Product/{productId}/Related?productIdType={productIdType}

Add related products to a product.

DELETE API/Product/{productId}/Related/{relationTypeId}?productIdType={productIdType}

Remove related products from a product using a fixed relation type.

DELETE API/Product/{productId}/Related?productIdType={productIdType}

Remove related products from a product.

Variant

Provides access to the variant repository.

APIDescriptionRemarks
GET API/Variant/Labels

Get all valid variant labels.

GET API/Variant/{productId}/VariantGroup?productIdType={productIdType}&include={include}

Get the variant group for the provided id.

POST API/Variant/{productId}/VariantGroup?productIdType={productIdType}&include={include}

Create a new group for the provided product id.

PUT API/Variant/{productId1}/{productId2}?productIdType={productIdType}&include={include}

Adds a product to an existing group.

PUT API/VariantGroup/{groupId}/{productId}?productIdType={productIdType}&include={include}

Adds a product to an existing group.

PUT API/Variant/{productId}?productIdType={productIdType}

Adds the variant details for the product with the provided ID.

DELETE API/Variant/{productId}?productIdType={productIdType}&include={include}

Remove a product from its variant group.

DELETE API/Variant/{productId}/VariantGroup?productIdType={productIdType}

Delete an entire variant group.

DELETE API/VariantGroup/{groupId}

Delete an entire variant group.

GET API/VariantGroup/{groupId}?include={include}

Get a specific variant group.

PUT API/VariantGroup/{groupId}?include={include}

Updates the settings of a group

POST API/VariantGroup?include={include}

Create a new variant group.

Market

Provides access to the market repository.

APIDescriptionRemarks
GET API/Market/List

Gets a list of all markets.

GET API/Market/{marketId}?marketIdType={marketIdType}

Get a specific market.

POST API/Market/{marketId}/404

Update the amount of 404-hits for URLs.

Payment

APIDescriptionRemarks
POST API/Payment/Query

No documentation available.

Supplier

Provides access to the supplier repository.

APIDescriptionRemarks
GET API/Supplier/{id}

Get a specific supplier.

POST API/Supplier/Query

Query suppliers.

POST API/Supplier

Create a new supplier.

PUT API/Supplier/{id}

Updates a supplier.

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.

User

Provides access to the user repository

APIDescriptionRemarks
POST API/User/Query

Get a specific user profile.

POST API/User

No documentation available.

PUT API/User

No documentation available.

DELETE API/User

No documentation available.

PageArea

APIDescriptionRemarks
POST API/PageArea/GetAll

Gets a list of all page area families, including nested data.

GET API/PageAreaFamily/List

Gets a list of all page area families, including nested data.

GET API/PageAreaFamily/{familyId}

Get a specific page area family.

GET API/PageArea/{name}

Get a specific page area.

POST API/PageAreaFamily

Create or update a page area family.

POST API/PageArea

Create or update a page area.

ProductParameter

Product parameter management.

APIDescriptionRemarks
GET API/ProductParameter/{id}

Get a specific product parameter.

POST API/ProductParameter

Create a new product parameter.

PUT API/ProductParameter/{id}

Updates a product parameter.

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.

GET API/ProductParameter/Group/{id}

Get a specific product parameter group.

POST API/ProductParameter/Group

Create a new product parameter group.

PUT API/ProductParameter/Group/{id}

Update a product parameter group.

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.

GET API/ProductParameter/Value/{id}?predefinedValueId={predefinedValueId}

Get a specific product parameter value.

POST API/ProductParameter/Value

Create or update a new product parameter value.

PUT API/ProductParameter/Value

Create or update a new product parameter value.

PUT API/ProductParameter/Values

Update multiple product parameter values.

POST API/ProductParameter/Values

Replace multiple product parameter values.

GET API/ProductParameter/PredefinedValue/{id}

Get a specific predefined value for a product parameter.

POST API/ProductParameter/PredefinedValue

Create a new predefined value for a product parameter.

Category

Category management.

APIDescriptionRemarks
GET API/Category/{id}

Get a specific category.

POST API/Category/Query

Query categories.

No response envelope.

POST API/Category

Create a new category.

PUT API/Category/{id}

Update a category.

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.

Order

Provides access to the order repository.

APIDescriptionRemarks
POST API/Order/Query

Query the order repository.

POST API/Order/Id

Create a new order id.

POST API/Order

Post a new order.

GET API/Order/{id}/{include}?combineProductContainerRows={combineProductContainerRows}

Get an instance of a order.

PUT API/Order/{id}?externalOrderStatus={externalOrderStatus}

Updates externalOrderStatus

DELETE API/Order/{id}?operation={operation}

Deletes or deactivates an order.

GET API/Order/Statuses

Get a list of available order statuses.

POST API/Order/{id}/SetStatus/{status}/{transactionId}/{secondaryTransactionId}

Update order status.

POST API/Order/{id}/Status/{status}/{transactionId}/{secondaryTransactionId}

Update order status.

POST API/Order/PaymentDetail/{paymentDetailId}/SetAsPayed

Set Payment Detail as payed.

GET API/Order/Capture/{captureId}

Get Capture by Id.

POST API/Order/Capture/SetAsProcessed

Set a capture as processed (= captured).

POST API/Order/ValidateCreation

Validates order data for order creation.

GET API/Order/Refund/{refundId}

Get Refund by Id.

POST API/Order/Refund/SetAsProcessed

Set a refund as processed (= settled).

POST API/Order/{id}/Comment

Adds a comment to the order. This add to (not replace) any previous comments.

POST API/Order/{id}/TransactionData

Updates transaction data on an order

PriceList

Provides access to the price list repository.

APIDescriptionRemarks
GET API/PriceList/List

Get all price list definitions.

- Prices on campaign price lists (id: xxxxxx2) can not be updated. Any such entries will be ignored. - ID for Ordinary, Sale and Campaign price lists starts from 1000000. The ID is calculated by this formula, Market ID * 1000000 + Type of price list (Ordinary=0, Sale=1, Capaign=2) So : Ordinary price list for market with ID 1 has ID = 1000000 Sale price list for market with ID 1 has ID = 1000001 Campaign price list for market with ID 1 has ID = 1000002 Ordinary price list for market with ID 2 has ID = 2000000 And so on ...

PUT API/PriceList/Price?productIdType={productIdType}&pricesIncVat={pricesIncVat}

Updates price list prices.

- Prices on campaign price lists (id: xxxxxx2) can not be updated. Any such entries will be ignored. - ID for Ordinary, Sale and Campaign price lists starts from 1000000. The ID is calculated by this formula, Market ID * 1000000 + Type of price list (Ordinary=0, Sale=1, Capaign=2) So : Ordinary price list for market with ID 1 has ID = 1000000 Sale price list for market with ID 1 has ID = 1000001 Campaign price list for market with ID 1 has ID = 1000002 Ordinary price list for market with ID 2 has ID = 2000000 And so on ...

Brand

Provides access to the brand repository.

APIDescriptionRemarks
GET API/Brand/{id}

Get a specific brand.

POST API/Brand/Query

Query brands.

POST API/Brand

Create a new brand.

PUT API/Brand/{id}

Updates a brand.

Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data.