# BeezUP Merchant API API

> BeezUP Merchant API API on Apizie: 210 endpoints (Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items…, Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items…, Send a batch of operations to clear an Order's merchant information (max 100 items per call), Send a batch of operations to set an Order's merchant information (max 100 items per call), …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/ecommerce:beezup/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:beezup`
- Category: E-commerce
- Status: byok
- Source: https://beezup.com
- Page: https://www.apizie.tech/api/ecommerce/beezup
- OpenAPI: https://www.apizie.tech/api/ecommerce/beezup/openapi.json

# The REST API of BeezUP system ## Overview The REST APIs provide programmatic access to read and write BeezUP data. Basically, with this API you will be able to do everything like you were with your browser on…

## Endpoints

### Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items…
`POST https://www.apizie.tech/v1/ecommerce:beezup/change-order-list-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userName | string | yes | Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend… |
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |
| body | object | yes | JSON request body |

### Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items…
`POST https://www.apizie.tech/v1/ecommerce:beezup/change-order-list-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userName | string | yes | Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend… |
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |
| changeOrderType | string | yes | The Order change type |
| body | object | yes | JSON request body |

### Send a batch of operations to clear an Order's merchant information (max 100 items per call)
`POST https://www.apizie.tech/v1/ecommerce:beezup/clear-merchant-order-info-list-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |
| body | object | yes | JSON request body |

### Send a batch of operations to set an Order's merchant information (max 100 items per call)
`POST https://www.apizie.tech/v1/ecommerce:beezup/set-merchant-order-info-list-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |
| body | object | yes | JSON request body |

### Send harvest request to all your marketplaces
`POST https://www.apizie.tech/v1/ecommerce:beezup/harvest-all-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | no | The StoreId to filter by |

### Get a paginated list of all Orders with all Order and Order Item(s) properties
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-order-list-full-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accept-Encoding | string | yes | Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size |
| body | object | yes | JSON request body |

### Get a paginated list of all Orders without details
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-order-list-light-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the list of MarketplaceBusinessCode ready for Order Management
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-order-management-ready-marketplace-business-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accept-Language | array | no | Indicates that the client accepts the following languages. |
| storeIds | array | no | StoredIds to filter |

### Get current synchronization status between your marketplaces and BeezUP accounts
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-marketplace-accounts-synchronization-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you… |
| storeIds | array | no | StoredIds to filter |

### Send harvest request for an Account
`POST https://www.apizie.tech/v1/ecommerce:beezup/harvest-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| marketplaceOrderId | string | no |  |
| beezUPOrderId | string | no |  |

### Get full Order and Order Item(s) properties
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-order-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |
| If-None-Match | string | no | ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you… |

### Clear an Order's merchant information
`POST https://www.apizie.tech/v1/ecommerce:beezup/clear-merchant-order-info-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |

### Send harvest request for a single Order
`POST https://www.apizie.tech/v1/ecommerce:beezup/harvest-order-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |

### Get an Order's harvest and change history
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-order-history-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |

### Get the order change reporting
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-order-change-reporting-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |
| orderChangeExecutionUUID | string | yes | The order change execution id |

### Set an Order's merchant information
`POST https://www.apizie.tech/v1/ecommerce:beezup/set-merchant-order-info-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |
| body | object | yes | JSON request body |

### Change your marketplace Order Information (accept, ship, etc.)
`POST https://www.apizie.tech/v1/ecommerce:beezup/change-order-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marketplaceTechnicalCode | string | yes | The marketplace technical code |
| accountId | integer | yes |  |
| beezUPOrderId | string | yes | The BeezUP Order identifier |
| changeOrderType | string | yes | The Order change type |
| userName | string | yes | Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend… |
| testMode | boolean | no | If true, the operation will be not be sent to marketplace. But the validation will be taken in account. |
| body | object | no | JSON request body |

### Get public channel index
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-channels-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you… |

### The channel list for one country
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| countryIsoCode | string | yes | 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… |
| Accept-Encoding | array | yes | Allows the client to indicate whether it accepts a compressed encoding to reduce traffic size. |
| If-None-Match | string | no | ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you… |

### Get all list names
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-public-lov-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you… |

### Get the list of values related to this list name
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-public-list-of-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| listName | string | yes | The list of value name your want to get |
| Accept-Language | array | no | Indicates that the client accepts the following languages. |
| If-None-Match | string | no | ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you… |

### Login
`POST https://www.apizie.tech/v1/ecommerce:beezup/login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Lost password
`POST https://www.apizie.tech/v1/ecommerce:beezup/lost-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### User Registration
`POST https://www.apizie.tech/v1/ecommerce:beezup/register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the Analytics API operation index
`GET https://www.apizie.tech/v1/ecommerce:beezup/analytics-index` (byok)

### Get the report by day for a StoreId
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-store-report-by-day-per-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the global synchronization status of clicks and orders
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-tracking-status` (byok)

### Get the Analytics API operation index for one store
`GET https://www.apizie.tech/v1/ecommerce:beezup/analytics-store-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Optimise all products
`POST https://www.apizie.tech/v1/ecommerce:beezup/optimise-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| actionName | string | yes |  |
| body | object | yes | JSON request body |

### Optimise products by category
`POST https://www.apizie.tech/v1/ecommerce:beezup/optimise-by-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| catalogCategoryId | string | yes | The category identifier concerned by this optimisation |
| actionName | string | yes |  |
| body | object | no | JSON request body |

### Optimise products by channel
`POST https://www.apizie.tech/v1/ecommerce:beezup/optimise-by-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| channelId | string | yes | The channel identifier concerned by this optimisation |
| actionName | string | yes |  |

### Optimise product
`POST https://www.apizie.tech/v1/ecommerce:beezup/optimise-by-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| productId | string | yes | The product identifier concerned by this optimisation |
| actionName | string | yes |  |
| body | object | no | JSON request body |

### Copy product optimisations between 2 channels
`POST https://www.apizie.tech/v1/ecommerce:beezup/copy-optimisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Optimise products by page
`POST https://www.apizie.tech/v1/ecommerce:beezup/optimise` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| actionName | string | yes |  |
| body | object | yes | JSON request body |

### Get the report by category
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-store-report-by-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get the report by channel
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-store-report-by-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get the report by day for a StoreId
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-store-report-by-day` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get the report by product
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-store-report-by-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get report filter list for the given store
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-report-filters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Get the report filter description
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-report-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| reportFilterId | string | yes | Your report filter identifier |

### Save the report filter
`POST https://www.apizie.tech/v1/ecommerce:beezup/save-report-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| reportFilterId | string | yes | Your report filter identifier |
| body | object | yes | JSON request body |

### Delete the report filter
`POST https://www.apizie.tech/v1/ecommerce:beezup/delete-report-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| reportFilterId | string | yes | Your report filter identifier |

### Gets the list of rules for a given store
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Rule creation
`POST https://www.apizie.tech/v1/ecommerce:beezup/create-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get the rules execution history
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-rules-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| pageNumber | integer | yes | The page to retrieve |
| pageSize | integer | yes | The count of rule history to retrieve |

### Run all rules for this store
`POST https://www.apizie.tech/v1/ecommerce:beezup/run-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Gets the rule
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Update Rule
`POST https://www.apizie.tech/v1/ecommerce:beezup/update-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |
| body | object | yes | JSON request body |

### Delete Rule
`POST https://www.apizie.tech/v1/ecommerce:beezup/delete-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Disable rule
`POST https://www.apizie.tech/v1/ecommerce:beezup/disable-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Enable rule
`POST https://www.apizie.tech/v1/ecommerce:beezup/enable-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Move the rule down
`POST https://www.apizie.tech/v1/ecommerce:beezup/move-down-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Move the rule up
`POST https://www.apizie.tech/v1/ecommerce:beezup/move-up-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Run rule
`POST https://www.apizie.tech/v1/ecommerce:beezup/run-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| ruleId | string | yes | Your rule identifier |

### Get the latest tracked clicks
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-store-tracked-clicks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| count | integer | no | The amount of clicks to retrieve |

### Get the latest tracked external orders
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-store-tracked-external-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| count | integer | no | The amount of external orders to retrieve |

### Get the latest tracked orders
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-store-tracked-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| count | integer | no | The amount of orders to retrieve |

### Get the synchronization status of clicks and orders of a store
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-store-tracking-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Get the index of the catalog API
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-index` (byok)

### Get the BeezUP columns
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-beez-upcolumns` (byok)

### Get the latest catalog importation reporting for all your stores
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-reportings-all-stores` (byok)

### Get the index of the catalog API for this store
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-store-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Get the auto import configuration
`GET https://www.apizie.tech/v1/ecommerce:beezup/auto-get-auto-import-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Delete Auto Import
`POST https://www.apizie.tech/v1/ecommerce:beezup/auto-delete-auto-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Activate the auto importation of the last successful manual catalog importation.
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-activate-auto-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Pause Auto Import
`POST https://www.apizie.tech/v1/ecommerce:beezup/auto-pause-auto-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Resume Auto Import
`POST https://www.apizie.tech/v1/ecommerce:beezup/auto-resume-auto-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Configure Auto Import Interval
`POST https://www.apizie.tech/v1/ecommerce:beezup/auto-configure-auto-import-interval` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Configure Auto Import Schedules
`POST https://www.apizie.tech/v1/ecommerce:beezup/auto-schedule-auto-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Start Auto Import Manually
`POST https://www.apizie.tech/v1/ecommerce:beezup/auto-start-auto-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Get catalog column list
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-catalog-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Change Catalog Column User Name
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-change-catalog-column-user-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| columnId | string | yes | The catalog column identifier |
| body | object | yes | JSON request body |

### Get category list
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| Accept-Encoding | array | yes | Indicates that the client accepts that the response will be compressed to reduce traffic size. |

### Get custom column list
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-custom-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Compute the expression for this catalog.
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-compute-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Create or replace a custom column
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-save-custom-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| columnId | string | yes | The custom column identifier |
| body | object | yes | JSON request body |

### Delete custom column
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-delete-custom-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| columnId | string | yes | The custom column identifier |

### Get the encrypted custom column expression
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-custom-column-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| columnId | string | yes | The custom column identifier |

### Change custom column expression
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-change-custom-column-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| columnId | string | yes | The custom column identifier |
| body | object | yes | JSON request body |

### Change Custom Column User Name
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-change-custom-column-user-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| columnId | string | yes | The custom column identifier |
| body | object | yes | JSON request body |

### Get the latest catalog importation reporting
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-reportings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Start Manual Import
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-start-manual-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get the importation status
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-importation-monitoring` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Cancel importation
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Get detected catalog columns during this importation.
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-detected-catalog-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Configure catalog column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-configure-catalog-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |
| body | object | yes | JSON request body |

### Ignore Column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-ignore-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |

### Map catalog column to a BeezUP column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-map-catalog-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The catalog column identifier |
| body | object | yes | JSON request body |

### Reattend Column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-reattend-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |

### Unmap catalog column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-unmap-catalog-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The catalog column identifier |

### Commit Importation
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-commit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Commit columns
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-commit-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Configure remaining catalog columns
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-configure-remaining-catalog-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Get custom columns currently place in this importation
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-custom-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Create or replace a custom column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-save-custom-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |
| body | object | yes | JSON request body |

### Delete Custom Column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-delete-custom-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |

### Get the encrypted custom column expression in this importation
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-custom-column-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |

### Map custom column to a BeezUP column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-map-custom-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |
| body | object | yes | JSON request body |

### Unmap custom column
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-unmap-custom-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| columnId | string | yes | The custom column identifier |

### Get the product sample related to this importation with all columns (catalog and custom)
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-product-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| productSampleIndex | integer | yes | Index of the product sample. Starting from 0 to 99. |

### Get product sample custom column value related to this importation.
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-product-sample-custom-column-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| productSampleIndex | integer | yes | Index of the product sample. Starting from 0 to 99. |
| columnId | string | yes | The custom column identifier |

### Importation Get Products Report
`POST https://www.apizie.tech/v1/ecommerce:beezup/importation-get-products-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |
| body | object | yes | JSON request body |

### Importation Get Report
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Get technical progression
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-technical-progression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| executionId | string | yes | The execution identifier of you catalog importation |

### Get the last input configuration
`GET https://www.apizie.tech/v1/ecommerce:beezup/importation-get-manual-update-last-input-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Get product by Sku
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-product-by-sku` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| sku | string | yes | The product sku you want to get |

### Get product list
`POST https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| body | object | yes | JSON request body |

### Get random product list
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-random-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |

### Get product by ProductId
`GET https://www.apizie.tech/v1/ecommerce:beezup/catalog-get-product-by-product-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | yes | Your store identifier |
| productId | string | yes | The product identifier you want to get |

### List all your current channel catalogs
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-channel-catalogs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storeId | string | no | The store identifier |

### Add a new channel catalog
`POST https://www.apizie.tech/v1/ecommerce:beezup/add-channel-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get channel catalog filter operators
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-channel-catalog-filter-operators` (byok)

### Get channel catalog products related to these channel catalogs
`POST https://www.apizie.tech/v1/ecommerce:beezup/get-channel-catalog-product-by-channel-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the channel catalog information
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-channel-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |

### Delete the channel catalog
`POST https://www.apizie.tech/v1/ecommerce:beezup/delete-channel-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |

### Get channel catalog categories
`GET https://www.apizie.tech/v1/ecommerce:beezup/get-channel-catalog-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |

### Configure channel catalog category
`POST https://www.apizie.tech/v1/ecommerce:beezup/configure-channel-catalog-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |
| body | object | yes | JSON request body |

### Disable a channel catalog category mapping
`POST https://www.apizie.tech/v1/ecommerce:beezup/disable-channel-catalog-category-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |

### Reenable a channel catalog category mapping
`POST https://www.apizie.tech/v1/ecommerce:beezup/reenable-channel-catalog-category-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |

### Configure channel catalog column mappings
`POST https://www.apizie.tech/v1/ecommerce:beezup/configure-channel-catalog-column-mappings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelCatalogId | string | yes | The channel catalog identifier |
| body | object | yes | JSON request body |

…and 90 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/ecommerce:beezup/change-order-list-v3" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the BeezUP Merchant API API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/ecommerce:beezup/change-order-list-v3 with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the BeezUP Merchant API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. BeezUP Merchant API itself also needs your own key from beezup.com.

### Can AI agents use the BeezUP Merchant API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:beezup.

### What is the status of the BeezUP Merchant API API?
Needs your own provider key (bring your own key)