beezup-merchant-api — quality + safety report

---
name: beezup-merchant-api
description: "BeezUP Merchant API skill. Use when working with BeezUP Merchant for public, user, orders. Covers 249 endpoints."
version: 1.0.0
generator: lapsh
---

# BeezUP Merchant API
API version: 2.0

## Auth
ApiKey Ocp-Apim-Subscription-Key in header

## Base URL
https://api.beezup.com

## Setup
1. Set your API key in the appropriate header
2. GET /v2/public/channels/ -- verify access
3. POST /v2/public/security/login -- create first login

## Endpoints

249 endpoints across 3 groups. See references/api-spec.lap for full details.

### public
| Method | Path | Description |
|--------|------|-------------|
| POST | /v2/public/security/login | Login |
| POST | /v2/public/security/login/mfa | Login |
| POST | /v2/public/security/register | User Registration |
| POST | /v2/public/security/lostpassword | Lost password |
| GET | /v2/public/channels/ | Get public channel index |
| GET | /v2/public/channels/{countryIsoCode} | The channel list for one country |
| GET | /v2/public/lov/ | Get all list names |
| GET | /v2/public/lov/{listName} | Get the list of values related to this list name |

### user
| Method | Path | Description |
|--------|------|-------------|
| GET | /v2/user/lov/ | Get all list names |
| GET | /v2/user/lov/{listName} | Get the list of values related to this list name |
| GET | /v2/user/customer/ | The index of all operations and LOV |
| GET | /v2/user/customer/account | Get user account information |
| POST | /v2/user/customer/account/resendEmailActivation | Resend email activation |
| POST | /v2/user/customer/account/activate | Activate the user account |
| PUT | /v2/user/customer/account/personalInfo | Save user personal information |
| PUT | /v2/user/customer/account/companyInfo | Change company information |
| GET | /v2/user/customer/account/profilePictureInfo | Get profile picture information |
| PUT | /v2/user/customer/account/profilePictureInfo | Change user picture information |
| GET | /v2/user/customer/account/creditCardInfo | Get credit card information |
| PUT | /v2/user/customer/account/creditCardInfo | Save user credit card info |
| POST | /v2/user/customer/account/changeEmail | Change user email |
| POST | /v2/user/customer/account/changePassword | Change user password |
| POST | /v2/user/customer/security/logout | Log out the current user from go2 |
| GET | /v2/user/customer/zendeskToken | Zendesk token |
| GET | /v2/user/customer/stores | Get store list |
| POST | /v2/user/customer/stores | Create a new store |
| GET | /v2/user/customer/stores/{storeId} | Get store's information |
| PATCH | /v2/user/customer/stores/{storeId} | Update some store's information. |
| DELETE | /v2/user/customer/stores/{storeId} | Delete a store |
| GET | /v2/user/customer/stores/{storeId}/rights | Get store's rights |
| GET | /v2/user/customer/stores/{storeId}/alerts | Get store's alerts |
| POST | /v2/user/customer/stores/{storeId}/alerts | Save store alerts |
| GET | /v2/user/customer/stores/{storeId}/shares | Get shares related to this store |
| POST | /v2/user/customer/stores/{storeId}/shares | Share a store to another user |
| DELETE | /v2/user/customer/stores/{storeId}/shares/{userId} | Delete a share of a store to another user |
| GET | /v2/user/customer/friends/{userId} | Get friend information |
| GET | /v2/user/customer/billingPeriods | Get billing periods conditions |
| GET | /v2/user/customer/offers | Get all standard offers |
| POST | /v2/user/customer/offers | Get offer pricing |
| GET | /v2/user/customer/contracts | Get contract list |
| POST | /v2/user/customer/contracts | Create a new contract |
| POST | /v2/user/customer/contracts/current/disableAutoRenewal | Schedule termination of your current contract at the end of the commitment. |
| POST | /v2/user/customer/contracts/current/reenableAutoRenewal | Reactivate your terminated contract. |
| DELETE | /v2/user/customer/contracts/next | Delete your next contract |
| GET | /v2/user/customer/invoices | Get all your invoices |
| GET | /v2/user/catalogs/ | Get the index of the catalog API |
| GET | /v2/user/catalogs/beezupColumns | Get the BeezUP columns |
| GET | /v2/user/catalogs/{storeId} | Get the index of the catalog API for this store |
| GET | /v2/user/catalogs/{storeId}/inputConfiguration | Get the last input configuration |
| GET | /v2/user/catalogs/{storeId}/catalogColumns | Get catalog column list |
| POST | /v2/user/catalogs/{storeId}/catalogColumns/{columnId}/rename | Change Catalog Column User Name |
| GET | /v2/user/catalogs/{storeId}/customColumns | Get custom column list |
| PUT | /v2/user/catalogs/{storeId}/customColumns/{columnId} | Create or replace a custom column |
| DELETE | /v2/user/catalogs/{storeId}/customColumns/{columnId} | Delete custom column |
| POST | /v2/user/catalogs/{storeId}/customColumns/{columnId}/rename | Change Custom Column User Name |
| GET | /v2/user/catalogs/{storeId}/customColumns/{columnId}/expression | Get the encrypted custom column expression |
| PUT | /v2/user/catalogs/{storeId}/customColumns/{columnId}/expression | Change custom column expression |
| POST | /v2/user/catalogs/{storeId}/customColumns/computeExpression | Compute the expression for this catalog. |
| GET | /v2/user/catalogs/{storeId}/categories | Get category list |
| POST | /v2/user/catalogs/{storeId}/products/list | Get product list |
| GET | /v2/user/catalogs/{storeId}/products/random | Get random product list |
| GET | /v2/user/catalogs/{storeId}/products/{productId} | Get product by ProductId |
| GET | /v2/user/catalogs/{storeId}/products | Get product by Sku |
| POST | /v2/user/catalogs/{storeId}/products/batches/{actionType} | Push product batches |
| GET | /v2/user/catalogs/{storeId}/importations/{batchId}/getReportUrl | Get Reporting By BatchId |
| GET | /v2/user/catalogs/{storeId}/beezUPColumns | Get the BeezUPColumns' Mapping of a Store |
| PATCH | /v2/user/catalogs/{storeId}/beezUPColumns | Patch the BeezUPColumns' Mapping of a Store. |
| PUT | /v2/user/catalogs/{storeId}/beezUPColumns | Replace the BeezUPColumns' Mapping of a Store. |
| PUT | /v2/user/catalogs/{storeId}/beezUPColumns/{beezUPColumnName} | Replace the BeezUPColumns' Mapping of a Store. |
| DELETE | /v2/user/catalogs/{storeId}/beezUPColumns/{beezUPColumnName} | Delete the BeezUPColumn' Mapping of a Store. |
| GET | /v2/user/catalogs/importations | Get the latest catalog importation reporting for all your stores |
| GET | /v2/user/catalogs/{storeId}/importations | Get the latest catalog importation reporting |
| POST | /v2/user/catalogs/{storeId}/importations/start | Start Manual Import |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId} | Get the importation status |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/cancel | Cancel importation |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/technicalProgression | Get technical progression |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/configureRemainingCatalogColumns | Configure remaining catalog columns |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/commitColumns | Commit columns |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/commit | Commit Importation |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex} | Get the product sample related to this importation with all columns (catalog and custom) |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex}/customColumns/{columnId} | Get product sample custom column value related to this importation. |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns | Get detected catalog columns during this importation. |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId} | Configure catalog column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/ignore | Ignore Column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/reattend | Reattend Column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/map | Map catalog column to a BeezUP column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/unmap | Unmap catalog column |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/customColumns | Get custom columns currently place in this importation |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/expression | Get the encrypted custom column expression in this importation |
| PUT | /v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} | Create or replace a custom column |
| DELETE | /v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} | Delete Custom Column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/map | Map custom column to a BeezUP column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/unmap | Unmap custom column |
| POST | /v2/user/catalogs/{storeId}/importations/{executionId}/products/list | Importation Get Products Report |
| GET | /v2/user/catalogs/{storeId}/importations/{executionId}/report | Importation Get Report |
| POST | /v2/user/catalogs/{storeId}/autoImport/activate | Activate the auto importation of the last successful manual catalog importation. |
| GET | /v2/user/catalogs/{storeId}/autoImport | Get the auto import configuration |
| DELETE | /v2/user/catalogs/{storeId}/autoImport | Delete Auto Import |
| POST | /v2/user/catalogs/{storeId}/autoImport/start | Start Auto Import Manually |
| POST | /v2/user/catalogs/{storeId}/autoImport/pause | Pause Auto Import |
| POST | /v2/user/catalogs/{storeId}/autoImport/resume | Resume Auto Import |
| POST | /v2/user/catalogs/{storeId}/autoImport/scheduling/interval | Configure Auto Import Interval |
| POST | /v2/user/catalogs/{storeId}/autoImport/scheduling/schedules | Configure Auto Import Schedules |
| GET | /v2/user/catalogs/{storeId}/replication/to | [PREVIEW] [Mocked] Get Store's Replicated To Configuration |
| PUT | /v2/user/catalogs/{storeId}/replication/to | [PREVIEW] [Mocked] Put Store's Replicated To Configuration |
| PATCH | /v2/user/catalogs/{storeId}/replication/to | [PREVIEW] [Mocked] Patch Store's Replicated To Configuration |
| GET | /v2/user/catalogs/{storeId}/replication/from | [PREVIEW] [Mocked] Get Store's Replicated From Configuration |
| GET | /v2/user/catalogs/{storeId}/replication/logs | [PREVIEW] [Mocked] Get Replication Logs - Can be filtered by ExecutionId |
| GET | /v2/user/channels/ | List all available channel for this store |
| GET | /v2/user/channels/{channelId} | Get channel information |
| GET | /v2/user/channels/{channelId}/categories | Get channel categories |
| POST | /v2/user/channels/{channelId}/columns | Get channel columns |
| GET | /v2/user/channelCatalogs/ | List all your current channel catalogs |
| POST | /v2/user/channelCatalogs/ | Add a new channel catalog |
| GET | /v2/user/channelCatalogs/{channelCatalogId} | Get the channel catalog information |
| DELETE | /v2/user/channelCatalogs/{channelCatalogId} | Delete the channel catalog |
| GET | /v2/user/channelCatalogs/filterOperators | Get channel catalog filter operators |
| POST | /v2/user/channelCatalogs/{channelCatalogId}/enable | Enable a channel catalog |
| POST | /v2/user/channelCatalogs/{channelCatalogId}/disable | Disable a channel catalog |
| PUT | /v2/user/channelCatalogs/{channelCatalogId}/settings/general | Configure channel catalog general settings |
| PUT | /v2/user/channelCatalogs/{channelCatalogId}/settings/cost | Configure channel catalog cost settings |
| PUT | /v2/user/channelCatalogs/{channelCatalogId}/columnMappings | Configure channel catalog column mappings |
| GET | /v2/user/channelCatalogs/{channelCatalogId}/categories | G

… (truncated)