6.0.0 • Published 5 years ago

@datafire/beezup v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/beezup

Client library for BeezUP Merchant API

Installation and Usage

npm install --save @datafire/beezup
let beezup = require('@datafire/beezup').create({
  api_key: ""
});

.then(data => {
  console.log(data);
});

Description

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

Actions

ChangeOrderListV3

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

beezup.ChangeOrderListV3({
  "changeOrderType": "",
  "userName": "",
  "body": {
    "changeOrders": []
  }
}, context)

Input

  • input object
    • changeOrderType required string: The Order change type
    • userName required string: Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
    • testMode boolean: If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
    • body required changeOrderListRequest

Output

ClearMerchantOrderInfoListV3

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

beezup.ClearMerchantOrderInfoListV3({
  "body": {
    "orders": []
  }
}, context)

Input

Output

SetMerchantOrderInfoListV3

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

beezup.SetMerchantOrderInfoListV3({
  "body": {
    "order_MerchantECommerceSoftwareName": "",
    "order_MerchantECommerceSoftwareVersion": "",
    "orders": []
  }
}, context)

Input

Output

GetOrderExportationsV3

Get a paginated list of Order report exportations

beezup.GetOrderExportationsV3({
  "pageNumber": 0,
  "pageSize": 0,
  "storeId": ""
}, context)

Input

  • input object
    • pageNumber required integer: The page number you want to get
    • pageSize required integer: The entry count you want to get
    • storeId required string: The store identifier to regroup the order exportations
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

ExportOrdersV3

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

beezup.ExportOrdersV3({
  "body": {
    "storeId": "",
    "orderListRequestWithoutPagination": {
      "beginPeriodUtcDate": "",
      "endPeriodUtcDate": ""
    }
  }
}, context)

Input

Output

Output schema unknown

HarvestAllV3

Send harvest request to all your marketplaces

beezup.HarvestAllV3({}, context)

Input

  • input object
    • storeId string: The StoreId to filter by

Output

Output schema unknown

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.

beezup.GetOrderListFullV3({
  "Accept-Encoding": "",
  "body": null
}, context)

Input

  • input object
    • Accept-Encoding required string: Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size
    • body required orderListRequest

Output

GetOrderListLightV3

Get a paginated list of all Orders without details

beezup.GetOrderListLightV3({
  "body": null
}, context)

Input

Output

GetOrderManagementReadyMarketplaceBusinessCode

Get the list of MarketplaceBusinessCode ready for Order Management

beezup.GetOrderManagementReadyMarketplaceBusinessCode({}, context)

Input

  • input object
    • Accept-Language array: Indicates that the client accepts the following languages.
    • storeIds array: StoredIds to filter

Output

GetMarketplaceAccountsSynchronizationV3

Get current synchronization status between your marketplaces and BeezUP accounts

beezup.GetMarketplaceAccountsSynchronizationV3({}, context)

Input

  • input object
    • If-None-Match string: ETag value to identify the last known version of requested resource.\
    • storeIds array: StoredIds to filter

Output

GetOrderV3

Get full Order and Order Item(s) properties

beezup.GetOrderV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

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

beezup.HeadOrderV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

Output schema unknown

ClearMerchantOrderInfoV3

Clear an Order's merchant information

beezup.ClearMerchantOrderInfoV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier

Output

Output schema unknown

HarvestOrderV3

Send harvest request for a single Order

beezup.HarvestOrderV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier

Output

Output schema unknown

GetOrderHistoryV3

Get an Order's harvest and change history

beezup.GetOrderHistoryV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier

Output

GetOrderChangeReportingV3

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

beezup.GetOrderChangeReportingV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": "",
  "orderChangeExecutionUUID": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier
    • orderChangeExecutionUUID required string: The order change execution id

Output

SetMerchantOrderInfoV3

Set an Order's merchant information

beezup.SetMerchantOrderInfoV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": "",
  "body": {
    "order_MerchantOrderId": "",
    "order_MerchantECommerceSoftwareName": "",
    "order_MerchantECommerceSoftwareVersion": ""
  }
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier
    • body required setMerchantOrderInfoRequest

Output

Output schema unknown

ChangeOrderV3

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

beezup.ChangeOrderV3({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "beezUPOrderId": "",
  "changeOrderType": "",
  "userName": "",
  "If-Match": ""
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The marketplace technical code
    • accountId required integer
    • beezUPOrderId required string: The BeezUP Order identifier
    • changeOrderType required string: The Order change type
    • userName required string: Sometimes the user in the e-commerce application is not the same as user associated with the current subscription key. We recommend providing your application's user login.
    • testMode boolean: If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
    • If-Match required string: ETag value to identify the last known version of requested resource.\
    • body changeOrderRequest

Output

Output schema unknown

GetChannelsIndex

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

beezup.GetChannelsIndex({}, context)

Input

  • input object
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

GetChannels

The channel list for one country

beezup.GetChannels({
  "countryIsoCode": "",
  "Accept-Encoding": []
}, context)

Input

  • input object
    • countryIsoCode required string: The country iso code alpha 3 based on this: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Decoding_table \
    • Accept-Encoding required array: Allows the client to indicate whether it accepts a compressed encoding to reduce traffic size.
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

GetPublicLovIndex

Get all list names

beezup.GetPublicLovIndex({}, context)

Input

  • input object
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

GetPublicListOfValues

Get the list of values related to this list name

beezup.GetPublicListOfValues({
  "listName": ""
}, context)

Input

  • input object
    • listName required string: The list of value name your want to get
    • Accept-Language array: Indicates that the client accepts the following languages.
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

Login

User Login - The login will give your tokens

beezup.Login({
  "body": {
    "login": "",
    "password": ""
  }
}, context)

Input

Output

LostPassword

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

beezup.LostPassword({
  "body": ""
}, context)

Input

Output

Output schema unknown

Register

User Registration - Create a new user on BeezUP

beezup.Register({
  "body": {
    "email": "",
    "password": ""
  }
}, context)

Input

Output

Output schema unknown

AnalyticsIndex

Get the Analytics API operation index

beezup.AnalyticsIndex(null, context)

Input

This action has no parameters

Output

GetTrackingStatus

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

beezup.GetTrackingStatus(null, context)

Input

This action has no parameters

Output

AnalyticsStoreIndex

Get the Analytics API operation index for one store

beezup.AnalyticsStoreIndex({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

OptimiseAll

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

beezup.OptimiseAll({
  "storeId": "",
  "actionName": "",
  "body": null
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • actionName required string (values: reenable, disable)
    • body required optimiseAllRequest

Output

Output schema unknown

OptimiseByCategory

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

beezup.OptimiseByCategory({
  "storeId": "",
  "catalogCategoryId": "",
  "actionName": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • catalogCategoryId required string: The category identifier concerned by this optimisation
    • actionName required string (values: reenable, disable)
    • body array
      • items string

Output

Output schema unknown

OptimiseByChannel

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

beezup.OptimiseByChannel({
  "storeId": "",
  "channelId": "",
  "actionName": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • channelId required string: The channel identifier concerned by this optimisation
    • actionName required string (values: reenable, disable)

Output

Output schema unknown

OptimiseByProduct

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

beezup.OptimiseByProduct({
  "storeId": "",
  "productId": "",
  "actionName": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • productId required string: The product identifier concerned by this optimisation
    • actionName required string (values: reenable, disable)
    • body array
      • items string

Output

Output schema unknown

CopyOptimisation

Copy product optimisations between 2 channels

beezup.CopyOptimisation({
  "storeId": "",
  "body": {
    "channelIdSource": "",
    "channelIdTarget": "",
    "keepExistingOptimisation": true
  }
}, context)

Input

Output

Optimise

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

beezup.Optimise({
  "storeId": "",
  "actionName": "",
  "body": null
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • actionName required string (values: reenable, disable)
    • body required optimiseRequest

Output

Output schema unknown

GetStoreReportByCategory

Get the report by category

beezup.GetStoreReportByCategory({
  "storeId": "",
  "body": null
}, context)

Input

Output

GetStoreReportByChannel

Get the report by channel

beezup.GetStoreReportByChannel({
  "storeId": "",
  "body": null
}, context)

Input

Output

GetStoreReportByDay

Get the report by day

beezup.GetStoreReportByDay({
  "storeId": "",
  "body": {
    "beginPeriodUtcDate": "",
    "endPeriodUtcDate": ""
  }
}, context)

Input

  • input object

Output

GetStoreReportByProduct

Get the report by product

beezup.GetStoreReportByProduct({
  "storeId": "",
  "body": null
}, context)

Input

Output

GetReportFilters

Get report filter list for the given store

beezup.GetReportFilters({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

DeleteReportFilter

Delete the report filter

beezup.DeleteReportFilter({
  "storeId": "",
  "reportFilterId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • reportFilterId required string: Your report filter identifier

Output

Output schema unknown

GetReportFilter

Get the report filter description

beezup.GetReportFilter({
  "storeId": "",
  "reportFilterId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • reportFilterId required string: Your report filter identifier

Output

SaveReportFilter

Save the report filter

beezup.SaveReportFilter({
  "storeId": "",
  "reportFilterId": "",
  "body": {
    "reportFilterName": "",
    "parameters": null
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • reportFilterId required string: Your report filter identifier
    • body required saveReportFilterRequest

Output

Output schema unknown

GetRules

Gets the list of rules for a given store

beezup.GetRules({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

CreateRule

Rule creation

beezup.CreateRule({
  "storeId": "",
  "body": {
    "optimisationActionName": "",
    "ruleName": "",
    "reportFilterId": ""
  }
}, context)

Input

  • input object

Output

Output schema unknown

GetRulesExecutions

Get the rules execution history

beezup.GetRulesExecutions({
  "storeId": "",
  "pageNumber": 0,
  "pageSize": 0
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • pageNumber required integer: The page to retrieve
    • pageSize required integer: The count of rule history to retrieve

Output

RunRules

Run all rules for this store

beezup.RunRules({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Output schema unknown

DeleteRule

Delete Rule

beezup.DeleteRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

Output schema unknown

GetRule

Gets the rule

beezup.GetRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

UpdateRule

Update Rule

beezup.UpdateRule({
  "storeId": "",
  "ruleId": "",
  "body": {
    "ruleName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier
    • body required updateRuleRequest

Output

Output schema unknown

DisableRule

Disable rule

beezup.DisableRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

Output schema unknown

EnableRule

Enable rule

beezup.EnableRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

Output schema unknown

MoveDownRule

Move the rule down

beezup.MoveDownRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

Output schema unknown

MoveUpRule

Move the rule up

beezup.MoveUpRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

Output schema unknown

RunRule

Run rule

beezup.RunRule({
  "storeId": "",
  "ruleId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • ruleId required string: Your rule identifier

Output

Output schema unknown

GetStoreTrackedClicks

Get the latest tracked clicks

beezup.GetStoreTrackedClicks({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • count integer: The amount of clicks to retrieve

Output

GetStoreTrackedExternalOrders

Get the latest tracked external orders

beezup.GetStoreTrackedExternalOrders({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • count integer: The amount of external orders to retrieve

Output

GetStoreTrackedOrders

Get the latest tracked orders

beezup.GetStoreTrackedOrders({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • count integer: The amount of orders to retrieve

Output

GetStoreTrackingStatus

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

beezup.GetStoreTrackingStatus({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

CatalogIndex

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

beezup.CatalogIndex(null, context)

Input

This action has no parameters

Output

Catalog_GetBeezUPColumns

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

beezup.Catalog_GetBeezUPColumns(null, context)

Input

This action has no parameters

Output

Importation_GetReportingForAllStores

Get the latest catalog importation reporting for all stores

beezup.Importation_GetReportingForAllStores(null, context)

Input

This action has no parameters

Output

  • output object: The key of the dictionary will be the store id

CatalogStoreIndex

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

beezup.CatalogStoreIndex({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Auto_DeleteAutoImport

Delete Auto Import

beezup.Auto_DeleteAutoImport({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Output schema unknown

Auto_GetAutoImportConfiguration

Get the auto import configuration

beezup.Auto_GetAutoImportConfiguration({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Importation_ActivateAutoImport

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.

beezup.Importation_ActivateAutoImport({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Output schema unknown

Auto_PauseAutoImport

Pause Auto Import

beezup.Auto_PauseAutoImport({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Output schema unknown

Auto_ResumeAutoImport

Resume Auto Import

beezup.Auto_ResumeAutoImport({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Output schema unknown

Auto_ConfigureAutoImportInterval

Configure Auto Import Interval

beezup.Auto_ConfigureAutoImportInterval({
  "storeId": "",
  "body": {
    "interval": ""
  }
}, context)

Input

Output

Output schema unknown

Auto_ScheduleAutoImport

Configure Auto Import Schedules

beezup.Auto_ScheduleAutoImport({
  "storeId": "",
  "body": {
    "schedules": []
  }
}, context)

Input

Output

Output schema unknown

Auto_StartAutoImport

Start Auto Import Manually

beezup.Auto_StartAutoImport({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Catalog_GetCatalogColumns

Get catalog column list

beezup.Catalog_GetCatalogColumns({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Catalog_ChangeCatalogColumnUserName

Change Catalog Column User Name

beezup.Catalog_ChangeCatalogColumnUserName({
  "storeId": "",
  "columnId": "",
  "body": {
    "userColumName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • columnId required string: The catalog column identifier
    • body required changeUserColumnNameRequest

Output

Output schema unknown

Catalog_GetCategories

Get category list

beezup.Catalog_GetCategories({
  "storeId": "",
  "Accept-Encoding": []
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • Accept-Encoding required array: Indicates that the client accepts that the response will be compressed to reduce traffic size.

Output

Catalog_GetCustomColumns

Get custom column list

beezup.Catalog_GetCustomColumns({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Catalog_ComputeExpression

Compute the expression for this catalog.

beezup.Catalog_ComputeExpression({
  "storeId": "",
  "body": {
    "productValues": {},
    "encryptedExpression": ""
  }
}, context)

Input

Output

  • output string

Catalog_DeleteCustomColumn

Delete custom column

beezup.Catalog_DeleteCustomColumn({
  "storeId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • columnId required string: The custom column identifier

Output

Output schema unknown

Catalog_SaveCustomColumn

Create or replace a custom column

beezup.Catalog_SaveCustomColumn({
  "storeId": "",
  "columnId": "",
  "body": {
    "userColumnName": "",
    "encryptedExpression": "",
    "encryptedBlocklyExpression": "",
    "displayGroupName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • columnId required string: The custom column identifier
    • body required createCustomColumnRequest

Output

Output schema unknown

Catalog_GetCustomColumnExpression

Get the encrypted custom column expression

beezup.Catalog_GetCustomColumnExpression({
  "storeId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • columnId required string: The custom column identifier

Output

  • output string

Catalog_ChangeCustomColumnExpression

Change custom column expression

beezup.Catalog_ChangeCustomColumnExpression({
  "storeId": "",
  "columnId": "",
  "body": {
    "encryptedExpression": "",
    "encryptedBlocklyExpression": ""
  }
}, context)

Input

Output

Output schema unknown

Catalog_ChangeCustomColumnUserName

Change Custom Column User Name

beezup.Catalog_ChangeCustomColumnUserName({
  "storeId": "",
  "columnId": "",
  "body": {
    "userColumName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • columnId required string: The custom column identifier
    • body required changeUserColumnNameRequest

Output

Output schema unknown

Importation_GetReportings

Get the latest catalog importation reporting

beezup.Importation_GetReportings({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Importation_StartManualUpdate

Start Manual Import

beezup.Importation_StartManualUpdate({
  "storeId": "",
  "body": {
    "input": {
      "files": []
    }
  }
}, context)

Input

Output

Importation_GetImportationMonitoring

Get the importation status

beezup.Importation_GetImportationMonitoring({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Importation_Cancel

Cancel importation

beezup.Importation_Cancel({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Output schema unknown

Importation_GetDetectedCatalogColumns

Get detected catalog columns during this importation.

beezup.Importation_GetDetectedCatalogColumns({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Importation_ConfigureCatalogColumn

Configure catalog column

beezup.Importation_ConfigureCatalogColumn({
  "storeId": "",
  "executionId": "",
  "columnId": "",
  "body": {
    "catalogColumn": {
      "id": "",
      "catalogColumnName": "",
      "userColumName": "",
      "configuration": {
        "columnImportance": "",
        "columnDataType": ""
      },
      "links": {}
    }
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier
    • body required configureCatalogColumnCatalogRequest

Output

Output schema unknown

Importation_IgnoreColumn

Ignore Column

beezup.Importation_IgnoreColumn({
  "storeId": "",
  "executionId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier

Output

Output schema unknown

Importation_MapCatalogColumn

Map catalog column to a BeezUP column

beezup.Importation_MapCatalogColumn({
  "storeId": "",
  "executionId": "",
  "columnId": "",
  "body": {
    "beezUPColumnName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The catalog column identifier
    • body required mapBeezUPColumnRequest

Output

Output schema unknown

Importation_ReattendColumn

Reattend Column

beezup.Importation_ReattendColumn({
  "storeId": "",
  "executionId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier

Output

Output schema unknown

Importation_UnmapCatalogColumn

Unmap catalog column

beezup.Importation_UnmapCatalogColumn({
  "storeId": "",
  "executionId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The catalog column identifier

Output

Output schema unknown

Importation_Commit

Commit Importation

beezup.Importation_Commit({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Output schema unknown

Importation_CommitColumns

Commit columns

beezup.Importation_CommitColumns({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Output schema unknown

Importation_ConfigureRemainingCatalogColumns

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

beezup.Importation_ConfigureRemainingCatalogColumns({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Output schema unknown

Importation_GetCustomColumns

Get custom columns currently place in this importation

beezup.Importation_GetCustomColumns({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Importation_DeleteCustomColumn

Delete Custom Column

beezup.Importation_DeleteCustomColumn({
  "storeId": "",
  "executionId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier

Output

Output schema unknown

Importation_SaveCustomColumn

Create or replace a custom column

beezup.Importation_SaveCustomColumn({
  "storeId": "",
  "executionId": "",
  "columnId": "",
  "body": {
    "encryptedExpression": "",
    "encryptedBlocklyExpression": "",
    "userColumName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier
    • body required changeCustomColumnRequest

Output

Output schema unknown

Importation_GetCustomColumnExpression

Get the encrypted custom column expression in this importation

beezup.Importation_GetCustomColumnExpression({
  "storeId": "",
  "executionId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier

Output

  • output string

Importation_MapCustomColumn

Map custom column to a BeezUP column

beezup.Importation_MapCustomColumn({
  "storeId": "",
  "executionId": "",
  "columnId": "",
  "body": {
    "beezUPColumnName": ""
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier
    • body required mapBeezUPColumnRequest

Output

Output schema unknown

Importation_UnmapCustomColumn

Unmap custom column

beezup.Importation_UnmapCustomColumn({
  "storeId": "",
  "executionId": "",
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • columnId required string: The custom column identifier

Output

Output schema unknown

Importation_GetProductSample

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

beezup.Importation_GetProductSample({
  "storeId": "",
  "executionId": "",
  "productSampleIndex": 0
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • productSampleIndex required integer: Index of the product sample. Starting from 0 to 99.

Output

Importation_GetProductSampleCustomColumnValue

/!\ 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

beezup.Importation_GetProductSampleCustomColumnValue({
  "storeId": "",
  "executionId": "",
  "productSampleIndex": 0,
  "columnId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • productSampleIndex required integer: Index of the product sample. Starting from 0 to 99.
    • columnId required string: The custom column identifier

Output

  • output string

Importation_GetProductsReport

Importation Get Products Report

beezup.Importation_GetProductsReport({
  "storeId": "",
  "executionId": "",
  "body": {
    "pageNumber": 0,
    "pageSize": 0
  }
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation
    • body required getImportationProductsReportRequest

Output

Importation_GetReport

Importation Get Report

beezup.Importation_GetReport({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Importation_TechnicalProgression

Get technical progression

beezup.Importation_TechnicalProgression({
  "storeId": "",
  "executionId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • executionId required string: The execution identifier of you catalog importation

Output

Importation_GetManualUpdateLastInputConfig

Get the last input configuration

beezup.Importation_GetManualUpdateLastInputConfig({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Catalog_GetProductBySku

Get product by Sku

beezup.Catalog_GetProductBySku({
  "storeId": "",
  "sku": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • sku required string: The product sku you want to get

Output

Catalog_GetProducts

Get product list

beezup.Catalog_GetProducts({
  "storeId": "",
  "body": {
    "pageNumber": 0,
    "pageSize": 0
  }
}, context)

Input

  • input object

Output

Catalog_GetRandomProducts

We will return 10 products randomly selected with all product values

beezup.Catalog_GetRandomProducts({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier

Output

Catalog_GetProductByProductId

Get product by ProductId

beezup.Catalog_GetProductByProductId({
  "storeId": "",
  "productId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • productId required string: The product identifier you want to get

Output

GetChannelCatalogs

List all your current channel catalogs

beezup.GetChannelCatalogs({}, context)

Input

  • input object
    • storeId string: The store identifier

Output

AddChannelCatalog

Add a new channel catalog

beezup.AddChannelCatalog({
  "body": {
    "channelId": "",
    "storeId": ""
  }
}, context)

Input

Output

GetChannelCatalogExclusionFilterOperators

Get channel catalog exclusion filter operators

beezup.GetChannelCatalogExclusionFilterOperators(null, context)

Input

This action has no parameters

Output

GetChannelCatalogProductByChannelCatalog

Get channel catalog products related to these channel catalogs

beezup.GetChannelCatalogProductByChannelCatalog({
  "body": {
    "storeId": "",
    "productId": "",
    "channelCatalogIds": []
  }
}, context)

Input

Output

DeleteChannelCatalog

Delete the channel catalog

beezup.DeleteChannelCatalog({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

Output schema unknown

GetChannelCatalog

Get the channel catalog information

beezup.GetChannelCatalog({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

GetChannelCatalogCategories

Get channel catalog categories

beezup.GetChannelCatalogCategories({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

ConfigureChannelCatalogCategory

Configure channel catalog category

beezup.ConfigureChannelCatalogCategory({
  "channelCatalogId": "",
  "body": {
    "overrideSubCategoryMappings": true,
    "channelCatalogCategories": []
  }
}, context)

Input

Output

Output schema unknown

DisableChannelCatalogCategoryMapping

Disable a channel catalog category mapping

beezup.DisableChannelCatalogCategoryMapping({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

Output schema unknown

ReenableChannelCatalogCategoryMapping

Reenable a channel catalog category mapping

beezup.ReenableChannelCatalogCategoryMapping({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

Output schema unknown

ConfigureChannelCatalogColumnMappings

Configure channel catalog column mappings

beezup.ConfigureChannelCatalogColumnMappings({
  "channelCatalogId": "",
  "body": []
}, context)

Input

Output

Output schema unknown

DisableChannelCatalog

Disable a channel catalog

beezup.DisableChannelCatalog({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

Output schema unknown

EnableChannelCatalog

Enable a channel catalog

beezup.EnableChannelCatalog({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

Output schema unknown

GetChannelCatalogExclusionFilters

Get channel catalog exclusion filters

beezup.GetChannelCatalogExclusionFilters({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

ConfigureChannelCatalogExclusionFilters

Configure channel catalog exclusion filters

beezup.ConfigureChannelCatalogExclusionFilters({
  "channelCatalogId": "",
  "body": []
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • body required exclusionFilters

Output

Output schema unknown

GetChannelCatalogExportationCacheInfo

Get the exportation cache information

beezup.GetChannelCatalogExportationCacheInfo({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

ClearChannelCatalogExportationCache

Clear the exportation cache

beezup.ClearChannelCatalogExportationCache({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

Output schema unknown

GetChannelCatalogExportationHistory

Get the exportation history

beezup.GetChannelCatalogExportationHistory({
  "channelCatalogId": "",
  "pageNumber": 0,
  "pageSize": 0
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • pageNumber required integer: The page number you want to get
    • pageSize required integer: The entry count you want to get

Output

GetChannelCatalogProductInfoList

Get channel catalog product information list

beezup.GetChannelCatalogProductInfoList({
  "channelCatalogId": "",
  "body": {
    "pageNumber": 0,
    "pageSize": 0,
    "criteria": {
      "logic": ""
    }
  }
}, context)

Input

Output

GetChannelCatalogProductsCounters

Get channel catalog products' counters

beezup.GetChannelCatalogProductsCounters({
  "channelCatalogId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier

Output

ExportChannelCatalogProductInfoList

Export channel catalog product information list

beezup.ExportChannelCatalogProductInfoList({
  "channelCatalogId": "",
  "format": "",
  "body": {
    "pageNumber": 0,
    "pageSize": 0,
    "criteria": {
      "logic": ""
    }
  }
}, context)

Input

  • input object

Output

GetChannelCatalogProductInfo

Get channel catalog product information

beezup.GetChannelCatalogProductInfo({
  "channelCatalogId": "",
  "productId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier

Output

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

beezup.DisableChannelCatalogProduct({
  "channelCatalogId": "",
  "productId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier

Output

Output schema unknown

OverrideChannelCatalogProductValues

Override channel catalog product values

beezup.OverrideChannelCatalogProductValues({
  "channelCatalogId": "",
  "productId": "",
  "body": {}
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier
    • body required productOverrides

Output

Output schema unknown

GetChannelCatalogProductValueOverrideCopy

Get channel catalog product value override compatibilities status

beezup.GetChannelCatalogProductValueOverrideCopy({
  "channelCatalogId": "",
  "productId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier

Output

Output schema unknown

ConfigureChannelCatalogProductValueOverrideCopy

Copy channel catalog product value override

beezup.ConfigureChannelCatalogProductValueOverrideCopy({
  "channelCatalogId": "",
  "productId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier

Output

Output schema unknown

DeleteChannelCatalogProductValueOverride

Delete a specific channel catalog product value override

beezup.DeleteChannelCatalogProductValueOverride({
  "channelCatalogId": "",
  "productId": "",
  "channelColumnId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier
    • channelColumnId required string: The channel column identifier

Output

Output schema unknown

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

beezup.ReenableChannelCatalogProduct({
  "channelCatalogId": "",
  "productId": ""
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • productId required string: The product identifier

Output

Output schema unknown

ConfigureChannelCatalogCostSettings

Configure channel catalog cost settings

beezup.ConfigureChannelCatalogCostSettings({
  "channelCatalogId": "",
  "body": {
    "costType": ""
  }
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • body required costSettings

Output

Output schema unknown

ConfigureChannelCatalogGeneralSettings

Configure channel catalog general settings

beezup.ConfigureChannelCatalogGeneralSettings({
  "channelCatalogId": "",
  "body": {
    "acceptToPublishInfo": true,
    "doNotExportOutOfStockProducts": true,
    "activeBeezUPTracking": true
  }
}, context)

Input

  • input object
    • channelCatalogId required string: The channel catalog identifier
    • body required generalSettings

Output

Output schema unknown

GetAvailableChannels

List all available channel for this store

beezup.GetAvailableChannels({
  "storeId": ""
}, context)

Input

  • input object
    • storeId required string: The store identifier

Output

GetChannelInfo

Get channel information

beezup.GetChannelInfo({
  "channelId": ""
}, context)

Input

  • input object
    • channelId required string: The channel identifier

Output

GetChannelCategories

Get channel categories

beezup.GetChannelCategories({
  "channelId": "",
  "Accept-Encoding": []
}, context)

Input

  • input object
    • channelId required string: The channel identifier
    • Accept-Encoding required array: Indicates that the client accepts that the response will be compressed to reduce traffic size.

Output

GetChannelColumns

Get channel columns

beezup.GetChannelColumns({
  "channelId": "",
  "Accept-Encoding": []
}, context)

Input

  • input object
    • channelId required string: The channel identifier
    • Accept-Encoding required array: Indicates that the client accepts that the response will be compressed to reduce traffic size.
    • body array

Output

GetCustomerIndex

The index of all operations and LOV

beezup.GetCustomerIndex({}, context)

Input

  • input object
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

GetUserAccountInfo

Get user account information

beezup.GetUserAccountInfo({}, context)

Input

  • input object
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

ActivateUserAccount

Activate the user account

beezup.ActivateUserAccount({
  "body": ""
}, context)

Input

  • input object
    • body required string

Output

Output schema unknown

ChangeEmail

Change user email

beezup.ChangeEmail({
  "body": {
    "newEmail": ""
  }
}, context)

Input

Output

Output schema unknown

ChangePassword

Change user password

beezup.ChangePassword({
  "body": {
    "oldPassword": "",
    "newPassword": ""
  }
}, context)

Input

Output

Output schema unknown

SaveCompanyInfo

Change company information

beezup.SaveCompanyInfo({
  "body": {
    "company": "",
    "address": "",
    "postalCode": "",
    "city": "",
    "countryIsoCodeAlpha3": ""
  }
}, context)

Input

Output

Output schema unknown

GetCreditCardInfo

Get credit card information

beezup.GetCreditCardInfo({}, context)

Input

  • input object
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

SaveCreditCardInfo

Save user credit card info

beezup.SaveCreditCardInfo({
  "body": {
    "cardNumber": "",
    "cardVerificationCode": "",
    "expirationMonth": 0,
    "expirationYear": 0
  }
}, context)

Input

Output

Output schema unknown

SavePersonalInfo

Save user personal information

beezup.SavePersonalInfo({
  "body": {
    "firstName": "",
    "lastName": "",
    "phoneNumber": "",
    "beezUPTimeZoneId": 0
  }
}, context)

Input

Output

Output schema unknown

GetProfilePictureInfo

Get profile picture information

beezup.GetProfilePictureInfo({}, context)

Input

  • input object
datafire
@infinitebrahmanuniverse/nolb-_datafire_b@everything-registry/sub-chunk-221
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago