# 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 https://go.beezup.com ! The main features are: - Register and manage your account - Cre
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.beezup.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# 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 https://go.beezup.com ! The main features are: - Register and manage your account - Create and manage and share your stores with your friends/co-workers. - Import your product catalog and
| method | path | what the vendor says it does |
|---|---|---|
POST | /orders/v3/batches/changeOrders | Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items pe |
POST | /orders/v3/batches/changeOrders/{changeOrderType} | Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items pe |
POST | /orders/v3/batches/clearMerchantOrderInfos | Send a batch of operations to clear an Order's merchant information (max 100 items per call) The purpose of th |
POST | /orders/v3/batches/setMerchantOrderInfos | Send a batch of operations to set an Order's merchant information (max 100 items per call) The purpose of thi |
POST | /orders/v3/harvest | Send harvest request to all your marketplaces Marketplaces - Orders V3 - Global |
POST | /orders/v3/list/full | Get a paginated list of all Orders with all Order and Order Item(s) properties The purpose of this operation i |
POST | /orders/v3/list/light | Get a paginated list of all Orders without details Marketplaces - Orders V3 - List |
GET | /orders/v3/lov/orderManagementReadyMarketplaceBusinessCode | Get the list of MarketplaceBusinessCode ready for Order Management Marketplaces - Orders V3 - Global |
GET | /orders/v3/status | Get current synchronization status between your marketplaces and BeezUP accounts Marketplaces - Orders V3 - Gl |
POST | /orders/v3/{marketplaceTechnicalCode}/{accountId}/harvest | Send harvest request for an Account Marketplaces - Orders V3 - Order |
GET | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} | Get full Order and Order Item(s) properties Marketplaces - Orders V3 - Order |
POST | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo | Clear an Order's merchant information Marketplaces - Orders V3 - Order |
POST | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest | Send harvest request for a single Order Marketplaces - Orders V3 - Order |
GET | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history | Get an Order's harvest and change history Marketplaces - Orders V3 - Order |
GET | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history/{orderChangeExecutionUUID} | Get the order change reporting This operation will help you to know the status of your order change operation |
POST | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo | Set an Order's merchant information Marketplaces - Orders V3 - Order |
POST | /orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType} | Change your marketplace Order Information (accept, ship, etc.) Marketplaces - Orders V3 - Order |
GET | /v2/public/channels/ | Get public channel index Use this operation to get the correct link to the channels and to the list of values |
GET | /v2/public/channels/{countryIsoCode} | The channel list for one country Public - Channels - Public Channels |
GET | /v2/public/lov/ | Get all list names Public - List of Values - LOV |
GET | /v2/public/lov/{listName} | Get the list of values related to this list name Public - List of Values - LOV |
POST | /v2/public/security/login | Login User Login - The login will give your tokens Public - Security - Security |
POST | /v2/public/security/lostpassword | Lost password Lost password - Your password will be regenerated and sent to your email Public - Security - Sec |
POST | /v2/public/security/register | User Registration User Registration - Create a new user on BeezUP Public - Security - Security |
GET | /v2/user/analytics/ | Get the Analytics API operation index Analytics - Global |
POST | /v2/user/analytics/reports/byday | Get the report by day for a StoreId Get the report by day for a StoreId Analytics - Statistics |
GET | /v2/user/analytics/tracking/status | Get the global synchronization status of clicks and orders Clicks and orders are eventually consistent. \ This |
GET | /v2/user/analytics/{storeId} | Get the Analytics API operation index for one store Analytics - Global |
POST | /v2/user/analytics/{storeId}/optimisations/all/{actionName} | Optimise all products /!\ WARNING /!\ \ Apply the operation on every product related to this request. \ This o |
POST | /v2/user/analytics/{storeId}/optimisations/bycategory/{catalogCategoryId}/{actionName} | Optimise products by category /!\ WARNING /!\ \ This operation will reenable or disable products's category fo |
POST | /v2/user/analytics/{storeId}/optimisations/bychannel/{channelId}/{actionName} | Optimise products by channel /!\ WARNING /!\ \ Apply the operation on every product on this channel. Analytics |
POST | /v2/user/analytics/{storeId}/optimisations/byproduct/{productId}/{actionName} | Optimise product /!\ WARNING /!\ \ This operation will reenable or disable this product for every channel indi |
POST | /v2/user/analytics/{storeId}/optimisations/copy | Copy product optimisations between 2 channels Analytics - Optimisations |
POST | /v2/user/analytics/{storeId}/optimisations/{actionName} | Optimise products by page /!\ WARNING /!\ \ Apply the operation on every product related to this request. \ Th |
POST | /v2/user/analytics/{storeId}/reports/bycategory | Get the report by category Get the report by category Analytics - Statistics |
POST | /v2/user/analytics/{storeId}/reports/bychannel | Get the report by channel Get the report by channel Analytics - Statistics |
POST | /v2/user/analytics/{storeId}/reports/byday | Get the report by day for a StoreId Get the report by day for a StoreId Analytics - Statistics |
POST | /v2/user/analytics/{storeId}/reports/byproduct | Get the report by product Get the report by product Analytics - Statistics |
GET | /v2/user/analytics/{storeId}/reports/filters | Get report filter list for the given store Analytics - Reports |
GET | /v2/user/analytics/{storeId}/reports/filters/{reportFilterId} | Get the report filter description Analytics - Reports |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://api-docs.beezup.com/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.