/v2/user/analytics/{storeId}/reports/byproduct

Get the report by product

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/reports/filters

Get report filter list for the given store

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/reports/filters/{reportFilterId}

Delete the report filter

• storeId (path, required) — Your store identifier
• reportFilterId (path, required) — Your report filter identifier

/v2/user/analytics/{storeId}/reports/filters/{reportFilterId}

Get the report filter description

• storeId (path, required) — Your store identifier
• reportFilterId (path, required) — Your report filter identifier

/v2/user/analytics/{storeId}/reports/filters/{reportFilterId}

Save the report filter

• storeId (path, required) — Your store identifier
• reportFilterId (path, required) — Your report filter identifier

/v2/user/analytics/{storeId}/rules

Gets the list of rules for a given store

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/rules

Rule creation

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/rules/executions

Get the rules execution history

• storeId (path, required) — Your store identifier
• pageNumber (query, required, page) — The page to retrieve
• pageSize (query, required, limit) — The count of rule history to retrieve

/v2/user/analytics/{storeId}/rules/run

Run all rules for this store

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/rules/{ruleId}

Delete Rule

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}

Gets the rule

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}

Update Rule

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}/disable

Disable rule

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}/enable

Enable rule

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}/movedown

Move the rule down

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}/moveup

Move the rule up

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/rules/{ruleId}/run

Run rule

• storeId (path, required) — Your store identifier
• ruleId (path, required) — Your rule identifier

/v2/user/analytics/{storeId}/tracking/clicks

Get the latest tracked clicks

• storeId (path, required) — Your store identifier
• count (query, limit) — The amount of clicks to retrieve

/v2/user/analytics/{storeId}/tracking/externalorders

Get the latest tracked external orders

• storeId (path, required) — Your store identifier
• count (query, limit) — The amount of external orders to retrieve

/v2/user/analytics/{storeId}/tracking/orders

Get the latest tracked orders

• storeId (path, required) — Your store identifier
• count (query, limit) — The amount of orders to retrieve

/v2/user/analytics/{storeId}/tracking/status

Get the synchronization status of clicks and orders of a store

• storeId (path, required) — Your store identifier

/v2/user/catalogs/

Get the index of the catalog API

/v2/user/catalogs/beezupColumns

Get the BeezUP columns

/v2/user/catalogs/importations

Get the latest catalog importation reporting for all your stores

/v2/user/catalogs/{storeId}

Get the index of the catalog API for this store

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport

Delete Auto Import

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport

Get the auto import configuration

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport/activate

Activate the auto importation of the last successful manual catalog importation.

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport/pause

Pause Auto Import

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport/resume

Resume Auto Import

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport/scheduling/interval

Configure Auto Import Interval

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport/scheduling/schedules

Configure Auto Import Schedules

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/autoImport/start

Start Auto Import Manually

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/catalogColumns

Get catalog column list

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/catalogColumns/{columnId}/rename

Change Catalog Column User Name

• storeId (path, required) — Your store identifier
• columnId (path, required) — The catalog column identifier

/v2/user/catalogs/{storeId}/categories

Get category list

• storeId (path, required) — Your store identifier
• Accept-Encoding (header, required) — Indicates that the client accepts that the response will be compressed to reduce traffic size.

/v2/user/catalogs/{storeId}/customColumns

Get custom column list

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/customColumns/computeExpression

Compute the expression for this catalog.

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/customColumns/{columnId}

Delete custom column

• storeId (path, required) — Your store identifier
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/customColumns/{columnId}

Create or replace a custom column

• storeId (path, required) — Your store identifier
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/customColumns/{columnId}/expression

Get the encrypted custom column expression

• storeId (path, required) — Your store identifier
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/customColumns/{columnId}/expression

Change custom column expression

• storeId (path, required) — Your store identifier
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/customColumns/{columnId}/rename

Change Custom Column User Name

• storeId (path, required) — Your store identifier
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations

Get the latest catalog importation reporting

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/importations/start

Start Manual Import

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/importations/{executionId}

Get the importation status

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/cancel

Cancel importation

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns

Get detected catalog columns during this importation.

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}

Configure catalog column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/channelCatalogs/{channelCatalogId}/exclusionFilters

Configure channel catalog exclusion filters

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/exportations/cache

Get the exportation cache information

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/exportations/cache/clear

Clear the exportation cache

• channelCatalogId (path, required) — The channel catalog identifier

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest

Send harvest request for a single Order

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier

/v2/user/marketplaces/orders/subscriptions/{id}/deactivate

Deactivate a subscription to the orders

• id (path, required)

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history

Get an Order's harvest and change history

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier

/v2/user/analytics/{storeId}/optimisations/bycategory/{catalogCategoryId}/{actionName}

Optimise products by category

• storeId (path, required) — Your store identifier
• catalogCategoryId (path, required) — The category identifier concerned by this optimisation
• actionName (path, required)

/v2/user/analytics/{storeId}/optimisations/bychannel/{channelId}/{actionName}

Optimise products by channel

• storeId (path, required) — Your store identifier
• channelId (path, required) — The channel identifier concerned by this optimisation
• actionName (path, required)

/v2/user/analytics/{storeId}/optimisations/byproduct/{productId}/{actionName}

Optimise product

• storeId (path, required) — Your store identifier
• productId (path, required) — The product identifier concerned by this optimisation
• actionName (path, required)

/v2/user/analytics/{storeId}/optimisations/copy

Copy product optimisations between 2 channels

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/optimisations/{actionName}

Optimise products by page

• storeId (path, required) — Your store identifier
• actionName (path, required)

/v2/user/analytics/{storeId}/reports/bycategory

Get the report by category

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/reports/bychannel

Get the report by channel

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/reports/byday

Get the report by day for a StoreId

• storeId (path, required) — Your store identifier

/orders/v3/batches/changeOrders

Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)

• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/orders/v3/batches/changeOrders/{changeOrderType}

Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)

• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
• changeOrderType (path, required) — The Order change type

/orders/v3/batches/clearMerchantOrderInfos

Send a batch of operations to clear an Order's merchant information (max 100 items per call)

• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/orders/v3/batches/setMerchantOrderInfos

Send a batch of operations to set an Order's merchant information (max 100 items per call)

• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/orders/v3/harvest

Send harvest request to all your marketplaces

• storeId (query) — The StoreId to filter by

/orders/v3/list/full

Get a paginated list of all Orders with all Order and Order Item(s) properties

• Accept-Encoding (header, required) — Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size

/orders/v3/list/light

Get a paginated list of all Orders without details

/orders/v3/lov/orderManagementReadyMarketplaceBusinessCode

Get the list of MarketplaceBusinessCode ready for Order Management

• Accept-Language (header) — Indicates that the client accepts the following languages.
• storeIds (query) — StoredIds to filter

/orders/v3/status

Get current synchronization status between your marketplaces and BeezUP accounts

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
• storeIds (query) — StoredIds to filter

/orders/v3/{marketplaceTechnicalCode}/{accountId}/harvest

Send harvest request for an Account

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• marketplaceOrderId (query)
• beezUPOrderId (query)

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}

Get full Order and Order Item(s) properties

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}

Get the meta information about the order (ETag, Last-Modified)

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo

Clear an Order's merchant information

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history/{orderChangeExecutionUUID}

Get the order change reporting

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• orderChangeExecutionUUID (path, required) — The order change execution id

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo

Set an Order's merchant information

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType}

Change your marketplace Order Information (accept, ship, etc.)

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• changeOrderType (path, required) — The Order change type
• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/v2/public/channels/

Get public channel index

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/public/channels/{countryIsoCode}

The channel list for one country

• countryIsoCode (path, required) — The country iso code alpha 3 based on this: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Decoding_table \ To know which country are available you have to use the operation: GetChannelsByCountry
• Accept-Encoding (header, required) — Allows the client to indicate whether it accepts a compressed encoding to reduce traffic size.
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/public/lov/

Get all list names

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/public/lov/{listName}

Get the list of values related to this list name

• listName (path, required) — The list of value name your want to get
• Accept-Language (header) — Indicates that the client accepts the following languages.
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/public/security/login

Login

/v2/public/security/lostpassword

Lost password

/v2/public/security/register

User Registration

/v2/user/analytics/

Get the Analytics API operation index

/v2/user/analytics/reports/byday

Get the report by day for a StoreId

/v2/user/analytics/tracking/status

Get the global synchronization status of clicks and orders

/v2/user/analytics/{storeId}

Get the Analytics API operation index for one store

• storeId (path, required) — Your store identifier

/v2/user/analytics/{storeId}/optimisations/all/{actionName}

Optimise all products

• storeId (path, required) — Your store identifier
• actionName (path, required)

/v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/ignore

Ignore Column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/map

Map catalog column to a BeezUP column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The catalog column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/reattend

Reattend Column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/unmap

Unmap catalog column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The catalog column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/commit

Commit Importation

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/commitColumns

Commit columns

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/configureRemainingCatalogColumns

Configure remaining catalog columns

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/customColumns

Get custom columns currently place in this importation

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}

Delete Custom Column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}

Create or replace a custom column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/expression

Get the encrypted custom column expression in this importation

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/map

Map custom column to a BeezUP column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/unmap

Unmap custom column

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex}

Get the product sample related to this importation with all columns (catalog and custom)

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• productSampleIndex (path, required) — Index of the product sample. Starting from 0 to 99.

/v2/user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex}/customColumns/{columnId}

Get product sample custom column value related to this importation.

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation
• productSampleIndex (path, required) — Index of the product sample. Starting from 0 to 99.
• columnId (path, required) — The custom column identifier

/v2/user/catalogs/{storeId}/importations/{executionId}/products/list

Importation Get Products Report

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/report

Importation Get Report

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/importations/{executionId}/technicalProgression

Get technical progression

• storeId (path, required) — Your store identifier
• executionId (path, required) — The execution identifier of you catalog importation

/v2/user/catalogs/{storeId}/inputConfiguration

Get the last input configuration

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/products

Get product by Sku

• storeId (path, required) — Your store identifier
• sku (query, required) — The product sku you want to get

/v2/user/catalogs/{storeId}/products/list

Get product list

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/products/random

Get random product list

• storeId (path, required) — Your store identifier

/v2/user/catalogs/{storeId}/products/{productId}

Get product by ProductId

• storeId (path, required) — Your store identifier
• productId (path, required) — The product identifier you want to get

/v2/user/channelCatalogs/

List all your current channel catalogs

• storeId (query) — The store identifier

/v2/user/channelCatalogs/

Add a new channel catalog

/v2/user/channelCatalogs/filterOperators

Get channel catalog filter operators

/v2/user/channelCatalogs/products

Get channel catalog products related to these channel catalogs

/v2/user/channelCatalogs/{channelCatalogId}

Delete the channel catalog

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}

Get the channel catalog information

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/categories

Get channel catalog categories

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/categories/configure

Configure channel catalog category

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/categories/disableMapping

Disable a channel catalog category mapping

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/categories/reenableMapping

Reenable a channel catalog category mapping

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/columnMappings

Configure channel catalog column mappings

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/disable

Disable a channel catalog

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/enable

Enable a channel catalog

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/exclusionFilters

Get channel catalog exclusion filters

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/exportations/history

Get the exportation history

• channelCatalogId (path, required) — The channel catalog identifier
• pageNumber (query, required, page) — The page number you want to get
• pageSize (query, required, limit) — The entry count you want to get

/v2/user/channelCatalogs/{channelCatalogId}/products

Get channel catalog product information list

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/counters

Get channel catalog products' counters

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/export

Export channel catalog product information list

• channelCatalogId (path, required) — The channel catalog identifier
• format (query, required) — The file type of the exportation

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}

Get channel catalog product information

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}/disable

Disable channel catalog product

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides

Override channel catalog product values

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/copy

Get channel catalog product value override compatibilities status

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/copy

Copy channel catalog product value override

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/{channelColumnId}

Delete a specific channel catalog product value override

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier
• channelColumnId (path, required) — The channel column identifier

/v2/user/channelCatalogs/{channelCatalogId}/products/{productId}/reenable

Reenable channel catalog product

• channelCatalogId (path, required) — The channel catalog identifier
• productId (path, required) — The product identifier

/v2/user/channelCatalogs/{channelCatalogId}/settings/cost

Configure channel catalog cost settings

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channelCatalogs/{channelCatalogId}/settings/general

Configure channel catalog general settings

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/channels/

List all available channel for this store

• storeId (query, required) — The store identifier

/v2/user/channels/{channelId}

Get channel information

• channelId (path, required) — The channel identifier

/v2/user/channels/{channelId}/categories

Get channel categories

• channelId (path, required) — The channel identifier
• Accept-Encoding (header, required) — Indicates that the client accepts that the response will be compressed to reduce traffic size.

/v2/user/channels/{channelId}/columns

Get channel columns

• channelId (path, required) — The channel identifier
• Accept-Encoding (header, required) — Indicates that the client accepts that the response will be compressed to reduce traffic size.

/v2/user/customer/

The index of all operations and LOV

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/account

Get user account information

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/account/activate

Activate the user account

/v2/user/customer/account/changeEmail

Change user email

/v2/user/customer/account/changePassword

Change user password

/v2/user/customer/account/companyInfo

Change company information

/v2/user/customer/account/creditCardInfo

Get credit card information

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/account/creditCardInfo

Save user credit card info

/v2/user/customer/account/personalInfo

Save user personal information

/v2/user/customer/account/profilePictureInfo

Get profile picture information

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/account/profilePictureInfo

Change user picture information

/v2/user/customer/account/resendEmailActivation

Resend email activation

/v2/user/customer/billingPeriods

Get billing periods conditions

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/contracts

Get contract list

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/contracts

Create a new contract

/v2/user/customer/contracts/current/disableAutoRenewal

Schedule termination of your current contract at the end of the commitment.

/v2/user/customer/contracts/current/reenableAutoRenewal

Reactivate your terminated contract.

/v2/user/customer/contracts/next

Delete your next contract

/v2/user/customer/friends/{userId}

Get friend information

• userId (path, required) — Your friend user id
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/invoices

Get all your invoices

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/offers

Get all standard offers

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/offers

Get offer pricing

/v2/user/customer/security/logout

Log out the current user from go2

/v2/user/customer/stores

Get store list

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/stores

Create a new store

/v2/user/customer/stores/{storeId}

Delete a store

• storeId (path, required) — Your store identifier

/v2/user/customer/stores/{storeId}

Get store's information

• storeId (path, required) — Your store identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/stores/{storeId}

Update some store's information.

• storeId (path, required) — Your store identifier

/v2/user/customer/stores/{storeId}/alerts

Get store's alerts

• storeId (path, required) — Your store identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/stores/{storeId}/alerts

Save store alerts

• storeId (path, required) — Your store identifier

/v2/user/customer/stores/{storeId}/rights

Get store's rights

• storeId (path, required) — Your store identifier

/v2/user/customer/stores/{storeId}/shares

Get shares related to this store

• storeId (path, required) — Your store identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/customer/stores/{storeId}/shares

Share a store to another user

• storeId (path, required) — Your store identifier

/v2/user/customer/stores/{storeId}/shares/{userId}

Delete a share of a store to another user

• storeId (path, required) — Your store identifier
• userId (path, required) — The friend user id

/v2/user/customer/zendeskToken

Zendesk token

/v2/user/legacyTracking/channelCatalogs/

List all your current channel catalogs configured to use legacy tracking format

• storeId (query) — The store identifier

/v2/user/legacyTracking/channelCatalogs/{channelCatalogId}

Get the channel catalog configured to use legacy tracking format information

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/legacyTracking/channelCatalogs/{channelCatalogId}/migrate

Migrate a channel catalog to current tracking format

• channelCatalogId (path, required) — The channel catalog identifier

/v2/user/lov/

Get all list names

/v2/user/marketplaces/orders/subscriptions/{id}/reporting

Get the push reporting related to this subscription

• id (path, required)
• pageNumber (query, page)
• pageSize (query, limit)

/v2/user/lov/{listName}

Get the list of values related to this list name

• listName (path, required) — The list of value name your want to get
• Accept-Language (header) — Indicates that the client accepts the following languages.
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/channelcatalogs/

Get your marketplace channel catalog list

• storeId (query) — The StoreId to filter by

/v2/user/marketplaces/channelcatalogs/publications/{marketplaceTechnicalCode}/{accountId}/history

Fetch the publication history for an account, sorted by descending start date

• marketplaceTechnicalCode (path, required) — Marketplace Technical Code to query (required)
• accountId (path, required) — Account Id to query (required)
• channelCatalogId (query) — Channel Catalog Id by which to filter (optional)
• count (query, limit) — Amount of entries to fetch (optional, default set to 10)
• publicationTypes (query, required) — Publication types by which to filter (optional)

/v2/user/marketplaces/channelcatalogs/publications/{marketplaceTechnicalCode}/{accountId}/publish

[PREVIEW] Launch a publication of the catalog to the marketplace

• marketplaceTechnicalCode (path, required) — Marketplace Technical Code to query (required)
• accountId (path, required) — Account Id to query (required)

/v2/user/marketplaces/channelcatalogs/{channelCatalogId}/properties

Get the marketplace properties for a channel catalog

• channelCatalogId (path, required)
• redirectionPageUrl (query, required)
• Accept-Language (header) — Indicates that the client accepts the following languages.

/v2/user/marketplaces/channelcatalogs/{channelCatalogId}/settings

Get the marketplace settings for a channel catalog

• channelCatalogId (path, required) — Channel Catalog Id to query (required)

/v2/user/marketplaces/channelcatalogs/{channelCatalogId}/settings

Save new marketplace settings for a channel catalog

• channelCatalogId (path, required) — Channel Catalog Id to query

/v2/user/marketplaces/orders/

[DEPRECATED] Get all actions you can do on the order API

• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/automaticTransitions

Get list of configured automatic Order status transitions

• storeId (query) — The StoreId to filter by
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/automaticTransitions

Configure new or existing automatic Order status transition

/v2/user/marketplaces/orders/batches/changeOrders/{changeOrderType}

[DEPRECATED] Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)

• changeOrderType (path, required) — The Order change type
• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.

/v2/user/marketplaces/orders/batches/clearMerchantOrderInfos

[DEPRECATED] Send a batch of operations to clear an Order's merchant information (max 100 items per call)

/v2/user/marketplaces/orders/batches/setMerchantOrderInfos

[DEPRECATED] Send a batch of operations to set an Order's merchant information (max 100 items per call)

/v2/user/marketplaces/orders/subscriptions/{id}/retry

Force retry push orders immediatly

• id (path, required)

/v2/user/marketplaces/orders/exportations

Get a paginated list of Order report exportations

• pageNumber (query, required, page) — The page number you want to get
• pageSize (query, required, limit) — The entry count you want to get
• storeId (query, required) — The store identifier to regroup the order exportations
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/exportations

Request a new Order report exportation to be generated

/v2/user/marketplaces/orders/harvest

[DEPRECATED] Send harvest request to all your marketplaces

• storeId (query) — The StoreId to filter by

/v2/user/marketplaces/orders/invoices/generate

Generate an Order Invoice batch

• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.

/v2/user/marketplaces/orders/invoices/getPdfInvoice

Returns the PDF version of the invoice

/v2/user/marketplaces/orders/invoices/settings/design

Get Order Invoice design settings

/v2/user/marketplaces/orders/invoices/settings/design

Save Order Invoice design settings

/v2/user/marketplaces/orders/invoices/settings/design/preview

View a preview an Order Invoice using custom design settings

• Accept-Encoding (header, required) — Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size

/v2/user/marketplaces/orders/invoices/settings/general

Get Order Invoice general settings

/v2/user/marketplaces/orders/invoices/settings/general

Save Order Invoice general settings

/v2/user/marketplaces/orders/invoices/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderUUID}/generate

Generate an Order Invoice

• marketplaceTechnicalCode (path, required) — The Marketplace Technical Code
• accountId (path, required) — The Account Identifier
• beezUPOrderUUID (path, required) — The BeezUP Order UUID
• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.

/v2/user/marketplaces/orders/invoices/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderUUID}/preview

View a preview an Order Invoice

• marketplaceTechnicalCode (path, required) — The Marketplace Technical Code
• accountId (path, required) — The Account Identifier
• beezUPOrderUUID (path, required) — The BeezUP Order UUID
• Accept-Encoding (header, required) — Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size

/v2/user/marketplaces/orders/list/full

[DEPRECATED] Get a paginated list of all Orders with all Order and Order Item(s) properties

• Accept-Encoding (header, required) — Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size

/v2/user/marketplaces/orders/list/light

[DEPRECATED] Get a paginated list of all Orders without details

/v2/user/marketplaces/orders/status

[DEPRECATED] Get current synchronization status between your marketplaces and BeezUP accounts

• storeId (query) — The StoreId to filter by
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/subscriptions/

Get the subscription list

/v2/user/marketplaces/orders/subscriptions/{id}

Delete a subscription to the orders

• id (path, required)

/v2/user/marketplaces/orders/subscriptions/{id}

Get a subscription to the orders

• id (path, required)

/v2/user/marketplaces/orders/subscriptions/{id}

Creates a subscription to the orders

• id (path, required)

/v2/user/marketplaces/orders/subscriptions/{id}/activate

Activate a subscription to the orders

• id (path, required)

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}

[DEPRECATED] DEPRECATED - Get full Order and Order Item(s) properties

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}

[DEPRECATED] DEPRECATED - Get the meta information about the order (ETag, Last-Modified)

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo

[DEPRECATED] Clear an Order's merchant information

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest

[DEPRECATED] Send harvest request for a single Order

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history

[DEPRECATED] Get an Order's harvest and change history

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• If-None-Match (header) — ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo

[DEPRECATED] Set an Order's merchant information

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier

/v2/user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType}

[DEPRECATED] Change your marketplace Order Information (accept, ship, etc.)

• marketplaceTechnicalCode (path, required) — The marketplace technical code
• accountId (path, required)
• beezUPOrderId (path, required) — The BeezUP Order identifier
• changeOrderType (path, required) — The Order change type
• userName (query, required) — Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
• testMode (query) — If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
• If-Match (header, required) — ETag value to identify the last known version of requested resource.\ To ensure that you are making a change on the lastest version of the resource.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3