Tools (228)

Extracted live via the executor SDK.

• analyticsGlobal.analyticsIndex

  Get the Analytics API operation index

• analyticsGlobal.analyticsStoreIndex

  Get the Analytics API operation index for one store

• analyticsOptimisations.copyOptimisation

  Copy product optimisations between 2 channels

• analyticsOptimisations.optimise

  /!\ WARNING /!\
  Apply the operation on every product related to this request.
  This operation is used at the bottom of the analytics page result.

• analyticsOptimisations.optimiseAll

  /!\ WARNING /!\
  Apply the operation on every product related to this request.
  This operation is used at the bottom of the analytics page result.

• analyticsOptimisations.optimiseByCategory

  /!\ WARNING /!\
  This operation will reenable or disable products's category for every channel indicated in the body.

• analyticsOptimisations.optimiseByChannel

  /!\ WARNING /!\
  Apply the operation on every product on this channel.

• analyticsOptimisations.optimiseByProduct

  /!\ WARNING /!\
  This operation will reenable or disable this product for every channel indicated in the body.

• analyticsReports.deleteReportFilter

  Delete the report filter

• analyticsReports.getReportFilter

  Get the report filter description

• analyticsReports.getReportFilters

  Get report filter list for the given store

• analyticsReports.saveReportFilter

  Save the report filter

• analyticsRules.createRule

  Rule creation

• analyticsRules.deleteRule

  Delete Rule

• analyticsRules.disableRule

  Disable rule

• analyticsRules.enableRule

  Enable rule

• analyticsRules.getRule

  Gets the rule

• analyticsRules.getRules

  Gets the list of rules for a given store

• analyticsRules.getRulesExecutions

  Get the rules execution history

• analyticsRules.moveDownRule

  Move the rule down

• analyticsRules.moveUpRule

  Move the rule up

• analyticsRules.runRule

  Run rule

• analyticsRules.runRules

  Run all rules for this store

• analyticsRules.updateRule

  Update Rule

• analyticsStatistics.getStoreReportByCategory

  Get the report by category

• analyticsStatistics.getStoreReportByChannel

  Get the report by channel

• analyticsStatistics.getStoreReportByDay

  Get the report by day for a StoreId

• analyticsStatistics.getStoreReportByDayPerStore

  Get the report by day for a StoreId

• analyticsStatistics.getStoreReportByProduct

  Get the report by product

• analyticsTracking.getStoreTrackedClicks

  Get the latest tracked clicks

• analyticsTracking.getStoreTrackedExternalOrders

  Get the latest tracked external orders

• analyticsTracking.getStoreTrackedOrders

  Get the latest tracked orders

• analyticsTracking.getStoreTrackingStatus

  Clicks and orders are eventually consistent.
  This operation gets the current state of projections for a store.

• analyticsTracking.getTrackingStatus

  Clicks and orders are eventually consistent.
  This operation gets the current global state of projections.

• catalogsAuto.autoConfigureAutoImportInterval

  Configure Auto Import Interval

• catalogsAuto.autoDeleteAutoImport

  Delete Auto Import

• catalogsAuto.autoGetAutoImportConfiguration

  Get the auto import configuration

• catalogsAuto.autoPauseAutoImport

  Pause Auto Import

• catalogsAuto.autoResumeAutoImport

  Resume Auto Import

• catalogsAuto.autoScheduleAutoImport

  Configure Auto Import Schedules

• catalogsAuto.autoStartAutoImport

  Start Auto Import Manually

• catalogsAuto.importationActivateAutoImport

  Once you have made your fist manual catalog importation with success, you can call this operation to import it automatically. No parameter required, we know which one it is.

• catalogsCatalog.catalogChangeCatalogColumnUserName

  Change Catalog Column User Name

• catalogsCatalog.catalogChangeCustomColumnExpression

  Change custom column expression

• catalogsCatalog.catalogChangeCustomColumnUserName

  Change Custom Column User Name

• catalogsCatalog.catalogComputeExpression

  Compute the expression for this catalog.

• catalogsCatalog.catalogDeleteCustomColumn

  Delete custom column

• catalogsCatalog.catalogGetCatalogColumns

  Get catalog column list

• catalogsCatalog.catalogGetCategories

  Get category list

• catalogsCatalog.catalogGetCustomColumnExpression

  Get the encrypted custom column expression

• catalogsCatalog.catalogGetCustomColumns

  Get custom column list

• catalogsCatalog.catalogGetProductByProductId

  Get product by ProductId

• catalogsCatalog.catalogGetProductBySku

  Get product by Sku

• catalogsCatalog.catalogGetProducts

  Get product list

• catalogsCatalog.catalogGetRandomProducts

  We will return 10 products randomly selected with all product values

• catalogsCatalog.catalogSaveCustomColumn

  Create or replace a custom column

• catalogsCatalog.catalogStoreIndex

  The operation will give you all the operations you will be able to do on this store for this API.

• catalogsCatalog.importationGetManualUpdateLastInputConfig

  Get the last input configuration

• catalogsGlobal.catalogGetBeezUpColumns

  Get the BeezUP columns, this columns are used for mapping during the manual catalog importation process.

• catalogsGlobal.catalogIndex

  The operation will give you all the operations you will be able to do and all the LOV used in this API.

• catalogsImportationCatalogInfo.importationConfigureCatalogColumn

  Configure catalog column

• catalogsImportationCatalogInfo.importationDeleteCustomColumn

  Delete Custom Column

• catalogsImportationCatalogInfo.importationGetCustomColumnExpression

  Get the encrypted custom column expression in this importation

• catalogsImportationCatalogInfo.importationGetCustomColumns

  Get custom columns currently place in this importation

• catalogsImportationCatalogInfo.importationGetDetectedCatalogColumns

  Get detected catalog columns during this importation.

• catalogsImportationCatalogInfo.importationGetProductSample

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

• catalogsImportationCatalogInfo.importationGetProductSampleCustomColumnValue

  /!\ 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 Importation_GetProductSample which will give you all property values

• catalogsImportationCatalogInfo.importationIgnoreColumn

  Ignore Column

• catalogsImportationCatalogInfo.importationMapCatalogColumn

  Map catalog column to a BeezUP column

• catalogsImportationCatalogInfo.importationMapCustomColumn

  Map custom column to a BeezUP column

• catalogsImportationCatalogInfo.importationReattendColumn

  Reattend Column

• catalogsImportationCatalogInfo.importationSaveCustomColumn

  Create or replace a custom column

• catalogsImportationCatalogInfo.importationUnmapCatalogColumn

  Unmap catalog column

• catalogsImportationCatalogInfo.importationUnmapCustomColumn

  Unmap custom column

• catalogsImportationProcess.importationCancel

  Cancel importation

• catalogsImportationProcess.importationCommit

  Commit Importation

• catalogsImportationProcess.importationCommitColumns

  Commit columns

• catalogsImportationProcess.importationConfigureRemainingCatalogColumns

  This operation should be used after you have mapped the required BeezUP Columns

• catalogsImportationProcess.importationGetImportationMonitoring

  Get the importation status

• catalogsImportationProcess.importationGetProductsReport

  Importation Get Products Report

• catalogsImportationProcess.importationGetReport

  Importation Get Report

• catalogsImportationProcess.importationGetReportings

  Get the latest catalog importation reporting

• catalogsImportationProcess.importationGetReportingsAllStores

  Get the latest catalog importation reporting for all your stores

• catalogsImportationProcess.importationStartManualUpdate

  Start Manual Import

• catalogsImportationProcess.importationTechnicalProgression

  Get technical progression

• channelCatalogsCategories.configureChannelCatalogCategory

  Configure channel catalog category

• channelCatalogsCategories.disableChannelCatalogCategoryMapping

  Disable a channel catalog category mapping

• channelCatalogsCategories.getChannelCatalogCategories

  Get channel catalog categories

• channelCatalogsCategories.reenableChannelCatalogCategoryMapping

  Reenable a channel catalog category mapping

• channelCatalogsColumnMappings.configureChannelCatalogColumnMappings

  Configure channel catalog column mappings

• channelCatalogsExclusionFilters.configureChannelCatalogExclusionFilters

  Configure channel catalog exclusion filters

• channelCatalogsExclusionFilters.getChannelCatalogExclusionFilters

  Get channel catalog exclusion filters

• channelCatalogsExportations.clearChannelCatalogExportationCache

  Clear the exportation cache

• channelCatalogsExportations.getChannelCatalogExportationCacheInfo

  Get the exportation cache information

• channelCatalogsExportations.getChannelCatalogExportationHistory

  Get the exportation history

• channelCatalogsGlobal.addChannelCatalog

  Add a new channel catalog

• channelCatalogsGlobal.deleteChannelCatalog

  Delete the channel catalog

• channelCatalogsGlobal.getChannelCatalog

  Get the channel catalog information

• channelCatalogsGlobal.getChannelCatalogFilterOperators

  Get channel catalog filter operators

• channelCatalogsGlobal.getChannelCatalogs

  List all your current channel catalogs

• channelCatalogsLegacyTrackingGlobal.getLegacyTrackingChannelCatalog

  Get the channel catalog configured to use legacy tracking format information

• channelCatalogsLegacyTrackingGlobal.getLegacyTrackingChannelCatalogs

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

• channelCatalogsLegacyTrackingGlobal.migrateLegacyTrackingChannelCatalog

  Migrate a channel catalog to current tracking format

• channelCatalogsProducts.exportChannelCatalogProductInfoList

  Export channel catalog product information list

• channelCatalogsProducts.getChannelCatalogProductByChannelCatalog

  Get channel catalog products related to these channel catalogs

• channelCatalogsProducts.getChannelCatalogProductInfo

  Get channel catalog product information

• channelCatalogsProducts.getChannelCatalogProductInfoList

  Get channel catalog product information list

• channelCatalogsProducts.getChannelCatalogProductsCounters

  Get channel catalog products' counters

• channelCatalogsProductsOptimisation.disableChannelCatalogProduct

  By 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 recommand you to use the analytics api

• channelCatalogsProductsOptimisation.reenableChannelCatalogProduct

  By 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 recommand you to use the analytics api

• channelCatalogsProductsOverrides.configureChannelCatalogProductValueOverrideCopy

  Copy channel catalog product value override

• channelCatalogsProductsOverrides.deleteChannelCatalogProductValueOverride

  Delete a specific channel catalog product value override

• channelCatalogsProductsOverrides.getChannelCatalogProductValueOverrideCopy

  Get channel catalog product value override compatibilities status

• channelCatalogsProductsOverrides.overrideChannelCatalogProductValues

  Override channel catalog product values

• channelCatalogsSettings.configureChannelCatalogCostSettings

  Configure channel catalog cost settings

• channelCatalogsSettings.configureChannelCatalogGeneralSettings

  Configure channel catalog general settings

• channelCatalogsSettings.disableChannelCatalog

  Disable a channel catalog

• channelCatalogsSettings.enableChannelCatalog

  Enable a channel catalog

• channelsChannelsGlobal.getAvailableChannels

  List all available channel for this store

• channelsChannelsGlobal.getChannelCategories

  Get channel categories

• channelsChannelsGlobal.getChannelColumns

  Get channel columns

• channelsChannelsGlobal.getChannelInfo

  Get channel information

• customerAccount.activateUserAccount

  Activate the user account

• customerAccount.changeEmail

  Change user email

• customerAccount.changePassword

  Change user password

• customerAccount.getCreditCardInfo

  Get credit card information

• customerAccount.getProfilePictureInfo

  Get profile picture information

• customerAccount.getUserAccountInfo

  Get user account information

• customerAccount.resendEmailActivation

  Resend email activation

• customerAccount.saveCompanyInfo

  Change company information

• customerAccount.saveCreditCardInfo

  Save user credit card info

• customerAccount.savePersonalInfo

  Save user personal information

• customerAccount.saveProfilePictureInfo

  Change user picture information

• customerAlerts.getStoreAlerts

  Get store's alerts

• customerAlerts.saveStoreAlerts

  You just have to send the alert you want to update, does not need all alerts. (PARTIAL UPDATE ACCEPTED)

• customerContracts.createContract

  Now you are ready to create your contract. Before that, please ensure that you check the offer with the same request parameterts. /offers

• customerContracts.deleteNextContract

  Delete your next contract

• customerContracts.getBillingPeriods

  Get billing periods conditions

• customerContracts.getContracts

  Get contract list

• customerContracts.getOffer

  Get the offer pricing then you can create your contract with the same request parameters. /v2/user/customer/contracts

• customerContracts.getStandardOffers

  Get all standard offers

• customerContracts.reactivateCurrentContract

  By calling this operation you can re-enable the auto renewal.

• customerContracts.terminateCurrentContract

  By default your contract are automatically renew. By calling this operation you can disable the auto renewal.

• customerFriends.getFriendInfo

  Get friend information

• customerGlobal.getCustomerIndex

  The index of all operations and LOV

• customerInvoices.getInvoices

  Get all your invoices

• customerRights.getRights

  Get store's rights

• customerSecurity.logout

  Log out the current user from go2

• customerSecurity.zendeskToken

  Zendesk token - Generates a JWT token to access BeezUP restricted Help Center in SSO as described here: https://support.zendesk.com/hc/en-us/articles/222874768-Using-restricted-Help-Center-content-with-the-Web-Widget

• customerShares.deleteStoreShare

  Delete a share of a store to another user

• customerShares.getStoreShares

  Get shares related to this store

• customerShares.shareStore

  Share a store to another user

• customerStores.createStore

  Create a new store

• customerStores.deleteStore

  Delete a store

• customerStores.getStore

  Get store's information

• customerStores.getStores

  Get store list

• customerStores.updateStore

  Update some store's information. FYI, you cannot change the country.

• marketplacesChannelCatalogsGlobal.getMarketplaceChannelCatalogs

  Get your marketplace channel catalog list

• marketplacesChannelCatalogsPublications.getPublications

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

• marketplacesChannelCatalogsPublications.publishCatalogToMarketplace

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

• marketplacesChannelCatalogsSettings.getChannelCatalogMarketplaceProperties

  Get the marketplace properties for a channel catalog

• marketplacesChannelCatalogsSettings.getChannelCatalogMarketplaceSettings

  Get the marketplace settings for a channel catalog

• marketplacesChannelCatalogsSettings.setChannelCatalogMarketplaceSettings

  Allow you to configure your marketplace settings. Partial update accepted.

• marketplacesOrdersAutoTransitions.configureAutomaticTransitions

  Configure new or existing automatic Order status transition

• marketplacesOrdersAutoTransitions.getAutomaticTransitions

  Get list of configured automatic Order status transitions

• marketplacesOrdersBatches.changeOrderList

  The purpose of this operation is to reduce the amount of request to the API. Max 100 items per call.

• marketplacesOrdersBatches.clearMerchantOrderInfoList

  The purpose of this operation is to reduce the amount of request to the API.

• marketplacesOrdersBatches.setMerchantOrderInfoList

  The purpose of this operation is to reduce the amount of request to the API.

• marketplacesOrdersExports.exportOrders

  A new file will be generated containing a summary of all the Orders matching the requested filter settings.

• marketplacesOrdersExports.getOrderExportations

  Get a paginated list of Order report exportations

• marketplacesOrdersGlobal.getMarketplaceAccountsSynchronization

  Use /orders/v3

• marketplacesOrdersGlobal.getOrderIndex

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

• marketplacesOrdersGlobal.harvestAll

  [DEPRECATED] Send harvest request to all your marketplaces

• marketplacesOrdersList.getOrderListFull

  DEPRECATED - Use /orders/v3 instead The 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 of the Orders. The purpose of this API is to reduce the number of incoming requests by returning the complete (full) Order and Order Item(s) properties.

• marketplacesOrdersList.getOrderListLight

  Use /orders/v3 instead

• marketplacesOrdersOrder.changeOrder

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

• marketplacesOrdersOrder.clearMerchantOrderInfo

  [DEPRECATED] Clear an Order's merchant information

• marketplacesOrdersOrder.getOrder

  DEPRECATED - Use /orders/v3 instead

• marketplacesOrdersOrder.getOrderHistory

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

• marketplacesOrdersOrder.harvestOrder

  [DEPRECATED] Send harvest request for a single Order

• marketplacesOrdersOrder.headOrder

  DEPRECATED - Use /orders/v3 instead The 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 could be useful

• marketplacesOrdersOrder.setMerchantOrderInfo

  [DEPRECATED] Set an Order's merchant information

• marketplacesOrdersSubscriptionsSubscriptions.activateSubscription

  At this moment, BeezUP will ensure that your callback url is respecting this specification:

  • https://app.swaggerhub.com/apis/BeezUP/public_marketplaces_orders_subscriptions_consumer-dev/1.0#/Subscriptions/Verification

  After that we will send you the orders related to your subscription, respecting this specification:

  • https://app.swaggerhub.com/apis/BeezUP/public_marketplaces_orders_subscriptions_consumer-dev/1.0#/Subscriptions/PushOrders
• marketplacesOrdersSubscriptionsSubscriptions.createSubscription

  Please take a look at this sequence diagram to understand the subscription process to follow here

• marketplacesOrdersSubscriptionsSubscriptions.deactivateSubscription

  Deactivate a subscription to the orders

• marketplacesOrdersSubscriptionsSubscriptions.deleteSubscription

  Delete a subscription to the orders

• marketplacesOrdersSubscriptionsSubscriptions.getSubscription

  Get a subscription to the orders

• marketplacesOrdersSubscriptionsSubscriptions.getSubscriptionList

  Get the subscription list

• marketplacesOrdersSubscriptionsSubscriptions.getSubscriptionPushReporting

  Get the push reporting related to this subscription

• marketplacesOrdersSubscriptionsSubscriptions.retryPushOrders

  In case your subscription consumption is unavailable and your subscription is still active you can ask to retry immediatly to push orders instead of waiting the next scheduled retry date

• marketplacesOrdersV3Batches.changeOrderListV2

  The purpose of this operation is to reduce the amount of request to the API. Max 100 items per call.

• marketplacesOrdersV3Batches.changeOrderListV3

  The purpose of this operation is to reduce the amount of request to the API. Max 100 items per call.

• marketplacesOrdersV3Batches.clearMerchantOrderInfoListV3

  The purpose of this operation is to reduce the amount of request to the API.

• marketplacesOrdersV3Batches.setMerchantOrderInfoListV3

  The purpose of this operation is to reduce the amount of request to the API.

• marketplacesOrdersV3Global.getMarketplaceAccountsSynchronizationV3

  Get current synchronization status between your marketplaces and BeezUP accounts

• marketplacesOrdersV3Global.getOrderManagementReadyMarketplaceBusinessCode

  Get the list of MarketplaceBusinessCode ready for Order Management

• marketplacesOrdersV3Global.harvestAllV3

  Send harvest request to all your marketplaces

• marketplacesOrdersV3List.getOrderListFullV3

  The 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 of the Orders. The purpose of this API is to reduce the number of incoming requests by returning the complete (full) Order and Order Item(s) properties.

• marketplacesOrdersV3List.getOrderListLightV3

  Get a paginated list of all Orders without details

• marketplacesOrdersV3Order.changeOrderV3

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

• marketplacesOrdersV3Order.clearMerchantOrderInfoV3

  Clear an Order's merchant information

• marketplacesOrdersV3Order.getOrderChangeReportingV3

  This operation will help you to know the status of your order change operation

• marketplacesOrdersV3Order.getOrderHistoryV3

  Get an Order's harvest and change history

• marketplacesOrdersV3Order.getOrderV3

  Get full Order and Order Item(s) properties

• marketplacesOrdersV3Order.harvestAccount

  Send harvest request for an Account

• marketplacesOrdersV3Order.harvestOrderV3

  Send harvest request for a single Order

• marketplacesOrdersV3Order.headOrderV3

  The 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 could be useful

• marketplacesOrdersV3Order.setMerchantOrderInfoV3

  Set an Order's merchant information

• omInvoiceApiGeneration.generateBatchOrderInvoice

  Generate an Order Invoice batch

• omInvoiceApiGeneration.generateOrderInvoice

  Generate an Order Invoice

• omInvoiceApiGeneration.getOrderInvoicePdf

  Returns the PDF version of the invoice

• omInvoiceApiGeneration.getOrderInvoicePreview

  View a preview an Order Invoice

• omInvoiceApiSettings.getOrderInvoiceDesignSettings

  Get Order Invoice design settings

• omInvoiceApiSettings.getOrderInvoiceDesignSettingsPreview

  View a preview an Order Invoice using custom design settings

• omInvoiceApiSettings.getOrderInvoiceGeneralSettings

  Get Order Invoice general settings

• omInvoiceApiSettings.saveOrderInvoiceDesignSettings

  Save Order Invoice design settings

• omInvoiceApiSettings.saveOrderInvoiceGeneralSettings

  Save Order Invoice general settings

• publicChannelsPublicChannels.getChannels

  The channel list for one country

• publicChannelsPublicChannels.getChannelsIndex

  Use this operation to get the correct link to the channels and to the list of values

• publicListOfValuesLov.getPublicListOfValues

  Get the list of values related to this list name

• publicListOfValuesLov.getPublicLovIndex

  Get all list names

• publicSecuritySecurity.login

  User Login - The login will give your tokens

• publicSecuritySecurity.lostPassword

  Lost password - Your password will be regenerated and sent to your email

• publicSecuritySecurity.register

  User Registration - Create a new user on BeezUP

• userListOfValuesLov.getUserListOfValues

  Get the list of values related to this list name

• userListOfValuesLov.getUserLovIndex

  Get all list names

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools