BeezUP

BeezUP Merchant API

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…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 schedule the auto importation
  • Search the channels your want to use
  • Configure your channels for your catalogs to export your product information:
  • cost and general settings
  • category and columns mappings
  • your will be able to create and manage your custom column
  • put in place exlusion filters based on simple conditions on your product data
  • override product values
  • get product vision for a channel catalog scope
  • Analyze and optimize your performance of your catalogs on all yours channels with different type of reportings by day, channel, category and by product.
  • Automatize your optimisation by using rules!
  • And of course... Manage your orders harvested from all your marketplaces:
  • Synchronize your orders in an uniformized way
  • Get the available actions and update the order status
  • ...and more!

Authentication credentials

The public API with the base path /v2/public have been put in place to give you an entry point to our system for the user registration, login and lost password. The public API does not require any credentials.
We give you the some public list of values and public channels for our public commercial web site www.beezup.com.

The user API with the base path /v2/user requires a token which is available on this page:
https://go.beezup.com/Account/MyAccount

Things to keep in mind

API Rate Limits

  • The BeezUP REST API is limited to 100 calls/minute.

Media type

The default media type for requests and responses is application/json. Where noted, some operations support other content types. If no additional content type is mentioned for a specific operation, then the media type is application/json.

Required content type

The required and default encoding for the request and responses is UTF8.

Required date time format

All our date time are formatted in ISO 8601 format: 2014-06-24T16:25:00Z.

Base URL

The Base URL of the BeezUP API Order Management REST API conforms to the following template.

https://api.beezup.com

All URLs returned by the BeezUP API are relative to this base URL, and all requests to the REST API must use this base URL template.

You can test our API on https://api-docs.beezup.com/swagger-ui\\
You can contact us on gitter, #BeezUP/API

Endpoints 226

Public - Security - Security

  • POSTLogin/v2/public/security/loginUser Login - The login will give your tokens
  • POSTLost password/v2/public/security/lostpasswordLost password - Your password will be regenerated and sent to your email
  • POSTUser Registration/v2/public/security/registerUser Registration - Create a new user on BeezUP

Public - Channels - Public Channels

  • GETGet public channel index/v2/public/channels/Use this operation to get the correct link to the channels and to the list of values
  • GETThe channel list for one country/v2/public/channels/:countryIsoCode

Public - List of Values - LOV

  • GETGet all list names/v2/public/lov/
  • GETGet the list of values related to this list name/v2/public/lov/:listName

User - List of Values - LOV

  • GETGet all list names/v2/user/lov/
  • GETGet the list of values related to this list name/v2/user/lov/:listName

Customer - Global

  • GETThe index of all operations and LOV/v2/user/customer/

Customer - Account

  • GETGet user account information/v2/user/customer/account
  • POSTActivate the user account/v2/user/customer/account/activate
  • POSTChange user email/v2/user/customer/account/changeEmail
  • POSTChange user password/v2/user/customer/account/changePassword
  • PUTChange company information/v2/user/customer/account/companyInfo
  • GETGet credit card information/v2/user/customer/account/creditCardInfo
  • PUTSave user credit card info/v2/user/customer/account/creditCardInfo
  • PUTSave user personal information/v2/user/customer/account/personalInfo
  • GETGet profile picture information/v2/user/customer/account/profilePictureInfo
  • PUTChange user picture information/v2/user/customer/account/profilePictureInfo
  • POSTResend email activation/v2/user/customer/account/resendEmailActivation

Customer - Security

  • POSTLog out the current user from go2/v2/user/customer/security/logoutLog out the current user from go2
  • GETZendesk token/v2/user/customer/zendeskTokenZendesk token - Generates a JWT token to access BeezUP restricted Help Center in SSO as described here:…

Customer - Stores

  • GETGet store list/v2/user/customer/stores
  • POSTCreate a new store/v2/user/customer/stores
  • GETGet store's information/v2/user/customer/stores/:storeId
  • DELETEDelete a store/v2/user/customer/stores/:storeId
  • PATCHUpdate some store's information./v2/user/customer/stores/:storeIdUpdate some store's information. FYI, you cannot change the country.

Customer - Shares

  • GETGet shares related to this store/v2/user/customer/stores/:storeId/shares
  • POSTShare a store to another user/v2/user/customer/stores/:storeId/shares
  • DELETEDelete a share of a store to another user/v2/user/customer/stores/:storeId/shares/:userId

Customer - Alerts

  • GETGet store's alerts/v2/user/customer/stores/:storeId/alerts
  • POSTSave store alerts/v2/user/customer/stores/:storeId/alertsYou just have to send the alert you want to update, does not need all alerts. (PARTIAL UPDATE ACCEPTED)

Customer - Rights

  • GETGet store's rights/v2/user/customer/stores/:storeId/rights

Customer - Friends

  • GETGet friend information/v2/user/customer/friends/:userId

Customer - Contracts

  • GETGet billing periods conditions/v2/user/customer/billingPeriods
  • GETGet contract list/v2/user/customer/contracts
  • POSTCreate a new contract/v2/user/customer/contractsNow you are ready to create your contract. Before that, please ensure that you check the offer with the same request parameterts. /offers
  • POSTSchedule termination of your current contract at the end of the commitment./v2/user/customer/contracts/current/disableAutoRenewalBy default your contract are automatically renew. By calling this operation you can disable the auto renewal.
  • POSTReactivate your terminated contract./v2/user/customer/contracts/current/reenableAutoRenewalBy calling this operation you can re-enable the auto renewal.
  • DELETEDelete your next contract/v2/user/customer/contracts/next
  • GETGet all standard offers/v2/user/customer/offers
  • POSTGet offer pricing/v2/user/customer/offersGet the offer pricing then you can create your contract with the same request parameters. /v2/user/customer/contracts

Customer - Invoices

  • GETGet all your invoices/v2/user/customer/invoices

Catalogs - Auto

  • GETGet the auto import configuration/v2/user/catalogs/:storeId/autoImport
  • DELETEDelete Auto Import/v2/user/catalogs/:storeId/autoImport
  • POSTActivate the auto importation of the last successful manual catalog importation./v2/user/catalogs/:storeId/autoImport/activateOnce you have made your fist manual catalog importation with success, you can call this operation to import it automatically. No parameter required, we know…
  • POSTPause Auto Import/v2/user/catalogs/:storeId/autoImport/pause
  • POSTResume Auto Import/v2/user/catalogs/:storeId/autoImport/resume
  • POSTConfigure Auto Import Interval/v2/user/catalogs/:storeId/autoImport/scheduling/interval
  • POSTConfigure Auto Import Schedules/v2/user/catalogs/:storeId/autoImport/scheduling/schedules
  • POSTStart Auto Import Manually/v2/user/catalogs/:storeId/autoImport/start

Catalogs - Global

  • GETGet the index of the catalog API/v2/user/catalogs/The operation will give you all the operations you will be able to do and all the LOV used in this API.
  • GETGet the BeezUP columns/v2/user/catalogs/beezupColumnsGet the BeezUP columns, this columns are used for mapping during the manual catalog importation process.

Catalogs - Importation Process

  • GETGet the latest catalog importation reporting for all your stores/v2/user/catalogs/importations
  • GETGet the latest catalog importation reporting/v2/user/catalogs/:storeId/importations
  • POSTStart Manual Import/v2/user/catalogs/:storeId/importations/start
  • GETGet the importation status/v2/user/catalogs/:storeId/importations/:executionId
  • POSTCancel importation/v2/user/catalogs/:storeId/importations/:executionId/cancel
  • POSTCommit Importation/v2/user/catalogs/:storeId/importations/:executionId/commit
  • POSTCommit columns/v2/user/catalogs/:storeId/importations/:executionId/commitColumns
  • POSTConfigure remaining catalog columns/v2/user/catalogs/:storeId/importations/:executionId/configureRemainingCatalogColumnsThis operation should be used after you have mapped the required BeezUP Columns
  • POSTImportation Get Products Report/v2/user/catalogs/:storeId/importations/:executionId/products/list
  • GETImportation Get Report/v2/user/catalogs/:storeId/importations/:executionId/report
  • GETGet technical progression/v2/user/catalogs/:storeId/importations/:executionId/technicalProgression

Catalogs - Importation Catalog Info

  • GETGet detected catalog columns during this importation./v2/user/catalogs/:storeId/importations/:executionId/catalogColumns
  • POSTConfigure catalog column/v2/user/catalogs/:storeId/importations/:executionId/catalogColumns/:columnId
  • POSTIgnore Column/v2/user/catalogs/:storeId/importations/:executionId/catalogColumns/:columnId/ignore
  • POSTMap catalog column to a BeezUP column/v2/user/catalogs/:storeId/importations/:executionId/catalogColumns/:columnId/map
  • POSTReattend Column/v2/user/catalogs/:storeId/importations/:executionId/catalogColumns/:columnId/reattend
  • POSTUnmap catalog column/v2/user/catalogs/:storeId/importations/:executionId/catalogColumns/:columnId/unmap
  • GETGet custom columns currently place in this importation/v2/user/catalogs/:storeId/importations/:executionId/customColumns
  • PUTCreate or replace a custom column/v2/user/catalogs/:storeId/importations/:executionId/customColumns/:columnId
  • DELETEDelete Custom Column/v2/user/catalogs/:storeId/importations/:executionId/customColumns/:columnId
  • GETGet the encrypted custom column expression in this importation/v2/user/catalogs/:storeId/importations/:executionId/customColumns/:columnId/expression
  • POSTMap custom column to a BeezUP column/v2/user/catalogs/:storeId/importations/:executionId/customColumns/:columnId/map
  • POSTUnmap custom column/v2/user/catalogs/:storeId/importations/:executionId/customColumns/:columnId/unmap
  • GETGet the product sample related to this importation with all columns (catalog and custom)/v2/user/catalogs/:storeId/importations/:executionId/productSamples/:productSampleIndex
  • GETGet product sample custom column value related to this importation./v2/user/catalogs/:storeId/importations/:executionId/productSamples/:productSampleIndex/customColumns/:columnId/!\ Use this operation only when you just changed the custom column expression and you want to get a precise the property value. Otherwise use the operation…

Catalogs - Catalog

  • GETGet the index of the catalog API for this store/v2/user/catalogs/:storeIdThe operation will give you all the operations you will be able to do on this store for this API.
  • GETGet catalog column list/v2/user/catalogs/:storeId/catalogColumns
  • POSTChange Catalog Column User Name/v2/user/catalogs/:storeId/catalogColumns/:columnId/rename
  • GETGet category list/v2/user/catalogs/:storeId/categories
  • GETGet custom column list/v2/user/catalogs/:storeId/customColumns
  • POSTCompute the expression for this catalog./v2/user/catalogs/:storeId/customColumns/computeExpression
  • PUTCreate or replace a custom column/v2/user/catalogs/:storeId/customColumns/:columnId
  • DELETEDelete custom column/v2/user/catalogs/:storeId/customColumns/:columnId
  • GETGet the encrypted custom column expression/v2/user/catalogs/:storeId/customColumns/:columnId/expression
  • PUTChange custom column expression/v2/user/catalogs/:storeId/customColumns/:columnId/expression
  • POSTChange Custom Column User Name/v2/user/catalogs/:storeId/customColumns/:columnId/rename
  • GETGet the last input configuration/v2/user/catalogs/:storeId/inputConfiguration
  • GETGet product by Sku/v2/user/catalogs/:storeId/products?sku=string
  • POSTGet product list/v2/user/catalogs/:storeId/products/list
  • GETGet random product list/v2/user/catalogs/:storeId/products/randomWe will return 10 products randomly selected with all product values
  • GETGet product by ProductId/v2/user/catalogs/:storeId/products/:productId

Channels - Channels Global

  • GETList all available channel for this store/v2/user/channels/?storeId=04730364-9826-4ff3-92e4-51fccd02bf10
  • GETGet channel information/v2/user/channels/:channelId
  • GETGet channel categories/v2/user/channels/:channelId/categories
  • POSTGet channel columns/v2/user/channels/:channelId/columns

Channel Catalogs - Global

  • GETList all your current channel catalogs/v2/user/channelCatalogs/?storeId=04730364-9826-4ff3-92e4-51fccd02bf10
  • POSTAdd a new channel catalog/v2/user/channelCatalogs/
  • GETGet channel catalog filter operators/v2/user/channelCatalogs/filterOperators
  • GETGet the channel catalog information/v2/user/channelCatalogs/:channelCatalogId
  • DELETEDelete the channel catalog/v2/user/channelCatalogs/:channelCatalogId

Channel Catalogs - Settings

  • POSTDisable a channel catalog/v2/user/channelCatalogs/:channelCatalogId/disable
  • POSTEnable a channel catalog/v2/user/channelCatalogs/:channelCatalogId/enable
  • PUTConfigure channel catalog cost settings/v2/user/channelCatalogs/:channelCatalogId/settings/cost
  • PUTConfigure channel catalog general settings/v2/user/channelCatalogs/:channelCatalogId/settings/general

Channel Catalogs - Column Mappings

  • PUTConfigure channel catalog column mappings/v2/user/channelCatalogs/:channelCatalogId/columnMappings

Channel Catalogs - Categories

  • GETGet channel catalog categories/v2/user/channelCatalogs/:channelCatalogId/categories
  • POSTConfigure channel catalog category/v2/user/channelCatalogs/:channelCatalogId/categories/configure
  • POSTDisable a channel catalog category mapping/v2/user/channelCatalogs/:channelCatalogId/categories/disableMapping
  • POSTReenable a channel catalog category mapping/v2/user/channelCatalogs/:channelCatalogId/categories/reenableMapping

Channel Catalogs - Exclusion Filters

  • GETGet channel catalog exclusion filters/v2/user/channelCatalogs/:channelCatalogId/exclusionFilters
  • PUTConfigure channel catalog exclusion filters/v2/user/channelCatalogs/:channelCatalogId/exclusionFilters

Channel Catalogs - Products

  • POSTGet channel catalog products related to these channel catalogs/v2/user/channelCatalogs/products
  • POSTGet channel catalog product information list/v2/user/channelCatalogs/:channelCatalogId/products
  • GETGet channel catalog products' counters/v2/user/channelCatalogs/:channelCatalogId/products/counters
  • POSTExport channel catalog product information list/v2/user/channelCatalogs/:channelCatalogId/products/export?format=xlsx
  • GETGet channel catalog product information/v2/user/channelCatalogs/:channelCatalogId/products/:productId

Channel Catalogs - Products Overrides

  • PUTOverride channel catalog product values/v2/user/channelCatalogs/:channelCatalogId/products/:productId/overrides
  • GETGet channel catalog product value override compatibilities status/v2/user/channelCatalogs/:channelCatalogId/products/:productId/overrides/copy
  • POSTCopy channel catalog product value override/v2/user/channelCatalogs/:channelCatalogId/products/:productId/overrides/copy
  • DELETEDelete a specific channel catalog product value override/v2/user/channelCatalogs/:channelCatalogId/products/:productId/overrides/:channelColumnId

Channel Catalogs - Products Optimisation

  • POSTDisable channel catalog product/v2/user/channelCatalogs/:channelCatalogId/products/:productId/disableBy default a all your catalog products are exposed to the channel. You can disable a product by using this operation. /!\ In case of massive optimisation we…
  • POSTReenable channel catalog product/v2/user/channelCatalogs/:channelCatalogId/products/:productId/reenableBy default a all your catalog products are exposed to the channel. You can reenable a product by using this operation. /!\ In case of massive optimisation we…

Channel Catalogs - Exportations

  • GETGet the exportation cache information/v2/user/channelCatalogs/:channelCatalogId/exportations/cache
  • POSTClear the exportation cache/v2/user/channelCatalogs/:channelCatalogId/exportations/cache/clear
  • GETGet the exportation history/v2/user/channelCatalogs/:channelCatalogId/exportations/history?pageNumber=1&pageSize=25

Marketplaces - Channel catalogs - Global

  • GETGet your marketplace channel catalog list/v2/user/marketplaces/channelcatalogs/?storeId=04730364-9826-4ff3-92e4-51fccd02bf10

Marketplaces - Channel catalogs - Publications

  • GETFetch the publication history for an account, sorted by descending start date/v2/user/marketplaces/channelcatalogs/publications/:marketplaceTechnicalCode/:accountId/history?channelCatalogId=string&count=10&publicationTypes=PublishProducts
  • POST[PREVIEW] Launch a publication of the catalog to the marketplace/v2/user/marketplaces/channelcatalogs/publications/:marketplaceTechnicalCode/:accountId/publish

Marketplaces - Channel catalogs - Settings

  • GETGet the marketplace properties for a channel catalog/v2/user/marketplaces/channelcatalogs/:channelCatalogId/properties?redirectionPageUrl=https://example.com
  • GETGet the marketplace settings for a channel catalog/v2/user/marketplaces/channelcatalogs/:channelCatalogId/settings
  • POSTSave new marketplace settings for a channel catalog/v2/user/marketplaces/channelcatalogs/:channelCatalogId/settingsAllow you to configure your marketplace settings. Partial update accepted.

Marketplaces - Orders - Global

  • GET[DEPRECATED] Get all actions you can do on the order API/v2/user/marketplaces/orders/Deprecated.
  • POST[DEPRECATED] Send harvest request to all your marketplaces/v2/user/marketplaces/orders/harvest?storeId=04730364-9826-4ff3-92e4-51fccd02bf10Deprecated.
  • GET[DEPRECATED] Get current synchronization status between your marketplaces and BeezUP accounts/v2/user/marketplaces/orders/status?storeId=04730364-9826-4ff3-92e4-51fccd02bf10Deprecated. Use /orders/v3

Marketplaces - Orders - AutoTransitions

  • GETGet list of configured automatic Order status transitions/v2/user/marketplaces/orders/automaticTransitions?storeId=04730364-9826-4ff3-92e4-51fccd02bf10
  • POSTConfigure new or existing automatic Order status transition/v2/user/marketplaces/orders/automaticTransitions

Marketplaces - Orders - List

  • POST[DEPRECATED] Get a paginated list of all Orders with all Order and Order Item(s) properties/v2/user/marketplaces/orders/list/fullDeprecated. DEPRECATED - Use /orders/v3 instead The purpose of this operation is to reduce the amount of request to the API.\ \ Previous implmentation of this…
  • POST[DEPRECATED] Get a paginated list of all Orders without details/v2/user/marketplaces/orders/list/lightDeprecated. Use /orders/v3 instead

Marketplaces - Orders - Order

  • GET[DEPRECATED] DEPRECATED - Get full Order and Order Item(s) properties/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderIdDeprecated. DEPRECATED - Use /orders/v3 instead
  • HEAD[DEPRECATED] DEPRECATED - Get the meta information about the order (ETag, Last-Modified)/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderIdDeprecated. DEPRECATED - Use /orders/v3 instead The purpose of this operation is to reduce the bandwith usage by getting just the meta information about the…
  • POST[DEPRECATED] Clear an Order's merchant information/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/clearMerchantOrderInfoDeprecated.
  • POST[DEPRECATED] Send harvest request for a single Order/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/harvestDeprecated.
  • GET[DEPRECATED] Get an Order's harvest and change history/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/historyDeprecated.
  • POST[DEPRECATED] Set an Order's merchant information/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/setMerchantOrderInfoDeprecated.
  • POST[DEPRECATED] Change your marketplace Order Information (accept, ship, etc.)/v2/user/marketplaces/orders/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/:changeOrderType?userName=string&testMode=falseDeprecated.

Marketplaces - Orders - Batches

  • POST[DEPRECATED] Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)/v2/user/marketplaces/orders/batches/changeOrders/:changeOrderType?userName=string&testMode=falseDeprecated. The purpose of this operation is to reduce the amount of request to the API. Max 100 items per call.
  • POST[DEPRECATED] Send a batch of operations to clear an Order's merchant information (max 100 items per call)/v2/user/marketplaces/orders/batches/clearMerchantOrderInfosDeprecated. The purpose of this operation is to reduce the amount of request to the API.
  • POST[DEPRECATED] Send a batch of operations to set an Order's merchant information (max 100 items per call)/v2/user/marketplaces/orders/batches/setMerchantOrderInfosDeprecated. The purpose of this operation is to reduce the amount of request to the API.

Marketplaces - Orders - Exports

  • GETGet a paginated list of Order report exportations/v2/user/marketplaces/orders/exportations?pageNumber=1&pageSize=25&storeId=string
  • POSTRequest a new Order report exportation to be generated/v2/user/marketplaces/orders/exportationsA new file will be generated containing a summary of all the Orders matching the requested filter settings.

Marketplaces - Orders V3 - Global

  • POSTSend harvest request to all your marketplaces/orders/v3/harvest?storeId=04730364-9826-4ff3-92e4-51fccd02bf10
  • GETGetOrderManagementReadyMarketplaceBusinessCode/orders/v3/lov/orderManagementReadyMarketplaceBusinessCode?storeIds=stringGet the list of MarketplaceBusinessCode ready for Order Management
  • GETGetMarketplaceAccountsSynchronizationV3/orders/v3/status?storeIds=stringGet current synchronization status between your marketplaces and BeezUP accounts

Marketplaces - Orders V3 - List

  • POSTGet a paginated list of all Orders with all Order and Order Item(s) properties/orders/v3/list/fullThe purpose of this operation is to reduce the amount of request to the API.\ \ Previous implmentation of this feature only returned a partial (light) version…
  • POSTGet a paginated list of all Orders without details/orders/v3/list/light

Marketplaces - Orders V3 - Order

  • POSTSend harvest request for an Account/orders/v3/:marketplaceTechnicalCode/:accountId/harvest?marketplaceOrderId=string&beezUPOrderId=string
  • GETGet full Order and Order Item(s) properties/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId
  • HEADGet the meta information about the order (ETag, Last-Modified)/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderIdThe purpose of this operation is to reduce the bandwith usage by getting just the meta information about the order (ETag, Last-Modified) with the body. This…
  • POSTClear an Order's merchant information/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/clearMerchantOrderInfo?testMode=false
  • POSTSend harvest request for a single Order/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/harvest
  • GETGet an Order's harvest and change history/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/history
  • GETGet the order change reporting/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/history/:orderChangeExecutionUUIDThis operation will help you to know the status of your order change operation
  • POSTSet an Order's merchant information/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/setMerchantOrderInfo?testMode=false
  • POSTChange your marketplace Order Information (accept, ship, etc.)/orders/v3/:marketplaceTechnicalCode/:accountId/:beezUPOrderId/:changeOrderType?userName=string&testMode=false

Marketplaces - Orders V3 - Batches

  • POSTSend a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)/orders/v3/batches/changeOrders?userName=string&testMode=falseThe purpose of this operation is to reduce the amount of request to the API. Max 100 items per call.
  • POSTSend a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)/orders/v3/batches/changeOrders/:changeOrderType?userName=string&testMode=falseThe purpose of this operation is to reduce the amount of request to the API. Max 100 items per call.
  • POSTSend a batch of operations to clear an Order's merchant information (max 100 items per call)/orders/v3/batches/clearMerchantOrderInfos?testMode=falseThe purpose of this operation is to reduce the amount of request to the API.
  • POSTSend a batch of operations to set an Order's merchant information (max 100 items per call)/orders/v3/batches/setMerchantOrderInfos?testMode=falseThe purpose of this operation is to reduce the amount of request to the API.

Marketplaces - Orders - Subscriptions - Subscriptions

  • GETGet the subscription list/v2/user/marketplaces/orders/subscriptions/
  • GETGet a subscription to the orders/v2/user/marketplaces/orders/subscriptions/:id
  • POSTCreates a subscription to the orders/v2/user/marketplaces/orders/subscriptions/:idPlease take a look at this sequence diagram to understand the subscription process to follow here
  • DELETEDelete a subscription to the orders/v2/user/marketplaces/orders/subscriptions/:id
  • POSTActivate a subscription to the orders/v2/user/marketplaces/orders/subscriptions/:id/activateAt this moment, BeezUP will ensure that your callback url is respecting this specification:…
  • POSTDeactivate a subscription to the orders/v2/user/marketplaces/orders/subscriptions/:id/deactivate
  • GETGet the push reporting related to this subscription/v2/user/marketplaces/orders/subscriptions/:id/reporting?pageNumber=1&pageSize=1
  • POSTForce retry push orders immediatly/v2/user/marketplaces/orders/subscriptions/:id/retryIn case your subscription consumption is unavailable and your subscription is still active you can ask to retry immediatly to push orders instead of waiting…

Analytics - Global

  • GETGet the Analytics API operation index/v2/user/analytics/
  • GETGet the Analytics API operation index for one store/v2/user/analytics/:storeId

Analytics - Tracking

  • GETGet the global synchronization status of clicks and orders/v2/user/analytics/tracking/statusClicks and orders are eventually consistent. \ This operation gets the current global state of projections.
  • GETGet the latest tracked clicks/v2/user/analytics/:storeId/tracking/clicks?count=100
  • GETGet the latest tracked external orders/v2/user/analytics/:storeId/tracking/externalorders?count=100
  • GETGet the latest tracked orders/v2/user/analytics/:storeId/tracking/orders?count=100
  • GETGet the synchronization status of clicks and orders of a store/v2/user/analytics/:storeId/tracking/statusClicks and orders are eventually consistent. \ This operation gets the current state of projections for a store.

Analytics - Statistics

  • POSTGet the report by day for a StoreId/v2/user/analytics/reports/bydayGet the report by day for a StoreId
  • POSTGet the report by category/v2/user/analytics/:storeId/reports/bycategoryGet the report by category
  • POSTGet the report by channel/v2/user/analytics/:storeId/reports/bychannelGet the report by channel
  • POSTGet the report by day for a StoreId/v2/user/analytics/:storeId/reports/bydayGet the report by day for a StoreId
  • POSTGet the report by product/v2/user/analytics/:storeId/reports/byproductGet the report by product

Analytics - Optimisations

  • POSTOptimise all products/v2/user/analytics/:storeId/optimisations/all/:actionName/!\ WARNING /!\ \ Apply the operation on every product related to this request. \ This operation is used at the bottom of the analytics page result.
  • POSTOptimise products by category/v2/user/analytics/:storeId/optimisations/bycategory/:catalogCategoryId/:actionName/!\ WARNING /!\ \ This operation will reenable or disable products's category for every channel indicated in the body.
  • POSTOptimise products by channel/v2/user/analytics/:storeId/optimisations/bychannel/:channelId/:actionName/!\ WARNING /!\ \ Apply the operation on every product on this channel.
  • POSTOptimise product/v2/user/analytics/:storeId/optimisations/byproduct/:productId/:actionName/!\ WARNING /!\ \ This operation will reenable or disable this product for every channel indicated in the body.
  • POSTCopy product optimisations between 2 channels/v2/user/analytics/:storeId/optimisations/copy
  • POSTOptimise products by page/v2/user/analytics/:storeId/optimisations/:actionName/!\ WARNING /!\ \ Apply the operation on every product related to this request. \ This operation is used at the bottom of the analytics page result.

Analytics - Reports

  • GETGet report filter list for the given store/v2/user/analytics/:storeId/reports/filters
  • GETGet the report filter description/v2/user/analytics/:storeId/reports/filters/:reportFilterId
  • PUTSave the report filter/v2/user/analytics/:storeId/reports/filters/:reportFilterId
  • DELETEDelete the report filter/v2/user/analytics/:storeId/reports/filters/:reportFilterId

Analytics - Rules

  • GETGets the list of rules for a given store/v2/user/analytics/:storeId/rules
  • POSTRule creation/v2/user/analytics/:storeId/rules
  • GETGet the rules execution history/v2/user/analytics/:storeId/rules/executions?pageNumber=1&pageSize=10
  • POSTRun all rules for this store/v2/user/analytics/:storeId/rules/run
  • GETGets the rule/v2/user/analytics/:storeId/rules/:ruleId
  • DELETEDelete Rule/v2/user/analytics/:storeId/rules/:ruleId
  • PATCHUpdate Rule/v2/user/analytics/:storeId/rules/:ruleId
  • POSTDisable rule/v2/user/analytics/:storeId/rules/:ruleId/disable
  • POSTEnable rule/v2/user/analytics/:storeId/rules/:ruleId/enable
  • POSTMove the rule down/v2/user/analytics/:storeId/rules/:ruleId/movedown
  • POSTMove the rule up/v2/user/analytics/:storeId/rules/:ruleId/moveup
  • POSTRun rule/v2/user/analytics/:storeId/rules/:ruleId/run

Channel Catalogs - Legacy Tracking - Global

  • GETList all your current channel catalogs configured to use legacy tracking format/v2/user/legacyTracking/channelCatalogs/?storeId=04730364-9826-4ff3-92e4-51fccd02bf10
  • GETGet the channel catalog configured to use legacy tracking format information/v2/user/legacyTracking/channelCatalogs/:channelCatalogId
  • POSTMigrate a channel catalog to current tracking format/v2/user/legacyTracking/channelCatalogs/:channelCatalogId/migrate

OM Invoice - API - Settings

  • GETGet Order Invoice design settings/v2/user/marketplaces/orders/invoices/settings/design
  • PUTSave Order Invoice design settings/v2/user/marketplaces/orders/invoices/settings/design
  • POSTView a preview an Order Invoice using custom design settings/v2/user/marketplaces/orders/invoices/settings/design/preview
  • GETGet Order Invoice general settings/v2/user/marketplaces/orders/invoices/settings/general
  • PUTSave Order Invoice general settings/v2/user/marketplaces/orders/invoices/settings/general

OM Invoice - API - Generation

  • POSTGenerate an Order Invoice batch/v2/user/marketplaces/orders/invoices/generate?userName=string
  • POSTReturns the PDF version of the invoice/v2/user/marketplaces/orders/invoices/getPdfInvoice
  • POSTGenerate an Order Invoice/v2/user/marketplaces/orders/invoices/:marketplaceTechnicalCode/:accountId/:beezUPOrderUUID/generate?userName=string
  • POSTView a preview an Order Invoice/v2/user/marketplaces/orders/invoices/:marketplaceTechnicalCode/:accountId/:beezUPOrderUUID/preview

API details

Base URL
https://api.beezup.com
Authentication
An API key in the Ocp-Apim-Subscription-Key header
Operations
226 operations on 195 pathsPOST 106GET 90PUT 15DELETE 11HEAD 2PATCH 2
15 marked deprecated
Main resources
Catalogs - Catalog 16Catalogs - Importation Catalog Info 14Analytics - Rules 12Catalogs - Importation Process 11Customer - Account 11Marketplaces - Orders V3 - Order 9Catalogs - Auto 8Customer - Contracts 8Marketplaces - Orders - Subscriptions - Subscriptions 8Marketplaces - Orders - Order 7
Response formats
application/json */* application/pdf
Description format
OpenAPI 3.0.0, API version 2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BeezUP Merchant API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BeezUP Merchant API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Login” (POST /v2/public/security/login), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BeezUP Merchant API?

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… It is listed under E-commerce and has 226 endpoints.

Who publishes the BeezUP Merchant API?

It is listed from BeezUP's public API description (an OpenAPI document), not published by BeezUP on Swastik Codes. Anyone who controls beezup.com can claim the profile by adding a DNS TXT record.

What is the base URL of the BeezUP Merchant API?

Requests go to https://api.beezup.com. Endpoint paths are added to this base URL.

How do I authenticate with the BeezUP Merchant API?

With an API key in the Ocp-Apim-Subscription-Key header.

How many endpoints does the BeezUP Merchant API have?

226 operations on 195 paths (106 POST, 90 GET, 15 PUT, 11 DELETE, 2 HEAD, 2 PATCH). The largest groups are Catalogs - Catalog, Catalogs - Importation Catalog Info, Analytics - Rules, Catalogs - Importation Process.

Is forking the BeezUP Merchant API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.