❤
npm
Sign UpSign In

@datafire/beezup

6.0.0 • Public • Published

@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
    • channelCatalogId required string: The channel catalog identifier
    • format required string (values: xlsx, csv): The file type of the exportation
    • body required getChannelCatalogProductInfoListRequest

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
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

SaveProfilePictureInfo

Change user picture information

beezup.SaveProfilePictureInfo({
  "body": {
    "profilePictureSelected": ""
  }
}, context)

Input

Output

Output schema unknown

ResendEmailActivation

Resend email activation

beezup.ResendEmailActivation(null, context)

Input

This action has no parameters

Output

Output schema unknown

GetBillingPeriods

Get billing periods conditions

beezup.GetBillingPeriods({}, context)

Input

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

Output

GetContracts

Get contract list

beezup.GetContracts({}, context)

Input

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

Output

CreateContract

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

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

Input

Output

TerminateCurrentContract

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

beezup.TerminateCurrentContract({
  "body": {
    "contractTerminationReasonType": 0
  }
}, context)

Input

Output

Output schema unknown

ReactivateCurrentContract

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

beezup.ReactivateCurrentContract(null, context)

Input

This action has no parameters

Output

Output schema unknown

DeleteNextContract

Delete your next contract

beezup.DeleteNextContract(null, context)

Input

This action has no parameters

Output

Output schema unknown

GetFriendInfo

Get friend information

beezup.GetFriendInfo({
  "userId": ""
}, context)

Input

  • input object
    • userId required string: Your friend user id
    • If-None-Match string: ETag value to identify the last known version of requested resource.\

Output

GetInvoices

Get all your invoices

beezup.GetInvoices({}, context)

Input

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

Output

GetStandardOffers

Get all standard offers

beezup.GetStandardOffers({}, context)

Input

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

Output

GetOffer

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

beezup.GetOffer({
  "body": {
    "offerId": 0,
    "storeCount": 0,
    "billingPeriodInMonth": 0
  }
}, context)

Input

Output

Logout

Log out the current user from go2

beezup.Logout(null, context)

Input

This action has no parameters

Output

Output schema unknown

GetStores

Get store list

beezup.GetStores({}, context)

Input

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

Output

CreateStore

Create a new store

beezup.CreateStore({
  "body": {
    "name": "",
    "url": "",
    "countryIsoCodeAlpha3": "",
    "sectors": []
  }
}, context)

Input

Output

DeleteStore

Delete a store

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

Input

  • input object
    • storeId required string: Your store identifier

Output

Output schema unknown

GetStore

Get store's information

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

Input

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

Output

UpdateStore

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

beezup.UpdateStore({
  "storeId": "",
  "body": {
    "name": "",
    "url": "",
    "sectors": []
  }
}, context)

Input

  • input object

Output

Output schema unknown

GetStoreAlerts

Get store's alerts

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

Input

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

Output

SaveStoreAlerts

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

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

Input

Output

Output schema unknown

GetRights

Get store's rights

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

Input

  • input object
    • storeId required string: Your store identifier

Output

GetStoreShares

Get shares related to this store

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

Input

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

Output

ShareStore

Share a store to another user

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

Input

  • input object
    • storeId required string: Your store identifier
    • body required friendEmail

Output

Output schema unknown

DeleteStoreShare

Delete a share of a store to another user

beezup.DeleteStoreShare({
  "storeId": "",
  "userId": ""
}, context)

Input

  • input object
    • storeId required string: Your store identifier
    • userId required string: The friend user id

Output

Output schema unknown

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

beezup.ZendeskToken(null, context)

Input

This action has no parameters

Output

GetUserLovIndex

Get all list names

beezup.GetUserLovIndex(null, context)

Input

This action has no parameters

Output

GetUserListOfValues

Get the list of values related to this list name

beezup.GetUserListOfValues({
  "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

GetMarketplaceChannelCatalogs

Get your marketplace channel catalog list

beezup.GetMarketplaceChannelCatalogs({}, context)

Input

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

Output

GetPublications

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

beezup.GetPublications({
  "marketplaceTechnicalCode": "",
  "accountId": 0,
  "publicationTypes": []
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: Marketplace Technical Code to query (required)
    • accountId required integer: Account Id to query (required)
    • channelCatalogId string: Channel Catalog Id by which to filter (optional)
    • count integer: Amount of entries to fetch (optional, default set to 10)
    • publicationTypes required array: Publication types by which to filter (optional)

Output

GetChannelCatalogMarketplaceProperties

Get the marketplace properties for a channel catalog

beezup.GetChannelCatalogMarketplaceProperties({
  "channelCatalogId": "",
  "redirectionPageUrl": ""
}, context)

Input

  • input object
    • channelCatalogId required string
    • redirectionPageUrl required string
    • Accept-Language array: Indicates that the client accepts the following languages.

Output

GetChannelCatalogMarketplaceSettings

Get the marketplace settings for a channel catalog

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

Input

  • input object
    • channelCatalogId required string: Channel Catalog Id to query (required)

Output

SetChannelCatalogMarketplaceSettings

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

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

Input

Output

Output schema unknown

GetOrderIndex

Get all actions you can do on the order API

beezup.GetOrderIndex({}, context)

Input

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

Output

GetAutomaticTransitions

Get list of configured automatic Order status transitions

beezup.GetAutomaticTransitions({}, context)

Input

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

Output

ConfigureAutomaticTransitions

Configure new or existing automatic Order status transition

beezup.ConfigureAutomaticTransitions({
  "body": {
    "automaticTransitions": []
  }
}, context)

Input

Output

Output schema unknown

ChangeOrderList

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

beezup.ChangeOrderList({
  "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

ClearMerchantOrderInfoList

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

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

Input

Output

SetMerchantOrderInfoList

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

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

Input

Output

GetOrderExportations

Get a paginated list of Order report exportations

beezup.GetOrderExportations({
  "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

ExportOrders

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

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

Input

Output

Output schema unknown

HarvestAll

Send harvest request to all your marketplaces

beezup.HarvestAll({}, context)

Input

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

Output

Output schema unknown

GetOrderInvoicePdf

Returns the PDF version of the invoice

beezup.GetOrderInvoicePdf({
  "body": {
    "orderInvoiceUri": ""
  }
}, context)

Input

Output

  • output string

GetOrderInvoiceDesignSettings

Get Order Invoice design settings

beezup.GetOrderInvoiceDesignSettings(null, context)

Input

This action has no parameters

Output

SaveOrderInvoiceDesignSettings

Save Order Invoice design settings

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

Input

Output

Output schema unknown

GetOrderInvoiceDesignSettingsPreview

View a preview an Order Invoice using custom design settings

beezup.GetOrderInvoiceDesignSettingsPreview({
  "Accept-Encoding": "",
  "body": {}
}, 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 orderInvoiceDesignSettings

Output

GetOrderInvoiceGeneralSettings

Get Order Invoice general settings

beezup.GetOrderInvoiceGeneralSettings(null, context)

Input

This action has no parameters

Output

SaveOrderInvoiceGeneralSettings

Save Order Invoice general settings

beezup.SaveOrderInvoiceGeneralSettings({
  "body": {
    "cultureName": "",
    "productVATPercent": 0,
    "shippingVATPercent": 0,
    "invoicePrefix": "",
    "invoiceStartingSequenceNumber": 0
  }
}, context)

Input

Output

Output schema unknown

GenerateOrderInvoice

Generate an Order Invoice

beezup.GenerateOrderInvoice({
  "marketplaceTechnicalCode": "",
  "accountId": "",
  "beezUPOrderUUID": "",
  "userName": "",
  "body": {}
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The Marketplace Technical Code
    • accountId required string: The Account Identifier
    • beezUPOrderUUID required string: The BeezUP Order UUID
    • 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.
    • body required generateOrderInvoiceRequest

Output

Output schema unknown

GetOrderInvoicePreview

View a preview an Order Invoice

beezup.GetOrderInvoicePreview({
  "marketplaceTechnicalCode": "",
  "accountId": "",
  "beezUPOrderUUID": "",
  "Accept-Encoding": "",
  "body": {}
}, context)

Input

  • input object
    • marketplaceTechnicalCode required string: The Marketplace Technical Code
    • accountId required string: The Account Identifier
    • beezUPOrderUUID required string: The BeezUP Order UUID
    • Accept-Encoding required string: Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size
    • body required previewOrderInvoiceRequest

Output

GetOrderListFull

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.GetOrderListFull({
  "Accept-Encoding": [],
  "body": null
}, context)

Input

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

Output

GetOrderListLight

Get a paginated list of all Orders without details

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

Input

Output

GetMarketplaceAccountsSynchronization

Get current synchronization status between your marketplaces and BeezUP accounts

beezup.GetMarketplaceAccountsSynchronization({}, context)

Input

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

Output

GetSubscriptionList

Get the subscription list

beezup.GetSubscriptionList(null, context)

Input

This action has no parameters

Output

DeleteSubscription

Delete a subscription to the orders

beezup.DeleteSubscription({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

GetSubscription

Get a subscription to the orders

beezup.GetSubscription({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

CreateSubscription

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

beezup.CreateSubscription({
  "id": "",
  "body": {
    "targetUrl": "",
    "name": "",
    "merchantApplicationName": "",
    "merchantApplicationVersion": ""
  }
}, context)

Input

Output

Output schema unknown

ActivateSubscription

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

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

beezup.ActivateSubscription({
  "id": ""
}, context)

Input

Output

Output schema unknown

DeactivateSubscription

Deactivate a subscription to the orders

beezup.DeactivateSubscription({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

GetSubscriptionPushReporting

Get the push reporting related to this subscription

beezup.GetSubscriptionPushReporting({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • pageNumber integer
    • pageSize integer

Output

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

beezup.RetryPushOrders({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

GetOrder

Get full Order and Order Item(s) properties

beezup.GetOrder({
  "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

HeadOrder

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.HeadOrder({
  "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

ClearMerchantOrderInfo

Clear an Order's merchant information

beezup.ClearMerchantOrderInfo({
  "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

HarvestOrder

Send harvest request for a single Order

beezup.HarvestOrder({
  "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

GetOrderHistory

Get an Order's harvest and change history

beezup.GetOrderHistory({
  "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

SetMerchantOrderInfo

Set an Order's merchant information

beezup.SetMerchantOrderInfo({
  "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

ChangeOrder

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

beezup.ChangeOrder({
  "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

Definitions

BeezUP.Common.AdditionalProductFilters

  • BeezUP.Common.AdditionalProductFilters object: Describe a filter on a product's column.

BeezUP.Common.AdditionalProductFiltersValue

BeezUP.Common.ApiSettingsStatus

  • BeezUP.Common.ApiSettingsStatus string (values: warning, success, failed)

BeezUP.Common.BeezUPColumnName

  • BeezUP.Common.BeezUPColumnName string: The BeezUP column name

BeezUP.Common.CatalogCategoryFilter

  • BeezUP.Common.CatalogCategoryFilter object
    • categoryPath array: Indicates on which catalog category path you want to make the filter
      • items string

BeezUP.Common.CatalogCategoryId

  • BeezUP.Common.CatalogCategoryId string: The catalog category identifier

BeezUP.Common.CatalogCategoryPath

  • BeezUP.Common.CatalogCategoryPath array: The catalog category path
    • items string

BeezUP.Common.CatalogColumnId

  • BeezUP.Common.CatalogColumnId string: The catalog column identifier (catalog or custom column)

BeezUP.Common.CatalogColumnUserName

  • BeezUP.Common.CatalogColumnUserName string: The catalog column named by the user (catalog or custom column)

BeezUP.Common.ChannelBasicInfo

BeezUP.Common.ChannelCatalogId

  • BeezUP.Common.ChannelCatalogId string: The channel catalog identifier

BeezUP.Common.ChannelCategoryFilter

  • BeezUP.Common.ChannelCategoryFilter object
    • categoryPath array: Indicates on which channel category path you want to make the filter
      • items string

BeezUP.Common.ChannelCategoryId

  • BeezUP.Common.ChannelCategoryId string

BeezUP.Common.ChannelCategoryPath

  • BeezUP.Common.ChannelCategoryPath array: The channel category path
    • items string

BeezUP.Common.ChannelColumnId

  • BeezUP.Common.ChannelColumnId string: The channel column identifier

BeezUP.Common.ChannelColumnName

  • BeezUP.Common.ChannelColumnName string: The channel column name

BeezUP.Common.ChannelId

  • BeezUP.Common.ChannelId string: The channel identifier

BeezUP.Common.ChannelName

  • BeezUP.Common.ChannelName string: The channel name

BeezUP.Common.ColumnDataType

  • BeezUP.Common.ColumnDataType string (values: String, Url, Text, Decimal, DateTime, Int, SpecialInt, InStock, Unknown, ImageUrl): Data type of the column, will be used for parsing and for consolidation proces

BeezUP.Common.ColumnImportance

  • BeezUP.Common.ColumnImportance string (values: Required, Recommended, Optional): Importance of the column

BeezUP.Common.CountryIsoCodeAlpha3

BeezUP.Common.CurrencyCode

  • BeezUP.Common.CurrencyCode string: The currency code (ISO 4217)

BeezUP.Common.DocUrl

  • BeezUP.Common.DocUrl string: The documentation related to this operation.

BeezUP.Common.Email

  • BeezUP.Common.Email string: The email

BeezUP.Common.ErrorResponseMessage

BeezUP.Common.ErrorSummary

  • BeezUP.Common.ErrorSummary object
    • errorArguments object
    • errorCode string
    • errorGuid string
    • errorMessage string
    • exceptionDetail BeezUP.Common.ExceptionDetail
    • objectName string
    • propertyName string
    • propertyValue string
    • source string
    • technicalErrorMessage string
    • utcDate string

BeezUP.Common.ExceptionDetail

  • BeezUP.Common.ExceptionDetail object
    • helpLink string
    • message string
    • stackTrace string
    • type string

BeezUP.Common.Href

  • BeezUP.Common.Href string: Indicate the relative uri for this link

BeezUP.Common.HttpMethod

  • BeezUP.Common.HttpMethod string (values: GET, POST, PATCH, DELETE, PUT, HEAD): Indicate the http method to use on this link

BeezUP.Common.HttpUrl

BeezUP.Common.InfoSummaries

BeezUP.Common.InfoSummary

  • BeezUP.Common.InfoSummary object
    • informationArguments object
    • informationCode string
    • informationMessage string
    • objectName string
    • propertyName string
    • propertyValue string

BeezUP.Common.LOVLink3

  • BeezUP.Common.LOVLink3 object: Describe the way you have to follow to get access to the LOV

BeezUP.Common.Link3

  • BeezUP.Common.Link3 object
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

BeezUP.Common.LinkParameter3

  • BeezUP.Common.LinkParameter3 object
    • description string: description of the parameter
    • in required BeezUP.Common.ParameterIn
    • label string: The label corresponding to the link parameter. This label is automatically translated based on the Accept-Language http header.
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: If true, you MUST indicate a value from the list of values otherwise it's a freetext
    • properties object: If the parameter is an object with flexible properties (additionProperties/dictionary), we will describe the properties of the object.
    • required boolean
    • schema string: schema of the parameter
    • type BeezUP.Common.ParameterType
    • value object: The value of the parameter. It can be an integer a string or an object.

BeezUP.Common.LinkParameterProperty3

  • BeezUP.Common.LinkParameterProperty3 object
    • description string: description of the parameter
    • label string: The label corresponding to the link parameter property. This label is automatically translated based on the Accept-Language http header.
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: If true, you MUST use indicate a value from the list of values otherwise it's a freetext
    • required boolean
    • schema string: schema of the parameter
    • type required BeezUP.Common.ParameterType
    • value object: The value of the parameter. It can be an integer a string or an object.

BeezUP.Common.ListOfValueItem

  • BeezUP.Common.ListOfValueItem object: This object is used by LOV apis
    • codeIdentifier required string
    • intIdentifier required integer
    • position integer
    • translationText string

BeezUP.Common.MarketplaceAccountId

  • BeezUP.Common.MarketplaceAccountId integer: The marketplace account identifier in BeezUP. This account identifier is based on your api settings.

BeezUP.Common.MarketplaceBusinessCode

  • BeezUP.Common.MarketplaceBusinessCode string: In an marketplace technical code like CDiscount you can have several marketplaces like GO SPORT, etc. We identify them by a business code.

BeezUP.Common.MarketplaceTechnicalCode

  • BeezUP.Common.MarketplaceTechnicalCode string: The technical code of the marketplace.

BeezUP.Common.OperationId

  • BeezUP.Common.OperationId string: The operationId to call.

BeezUP.Common.PageNumber

  • BeezUP.Common.PageNumber integer: Indicates the page number

BeezUP.Common.PageSize

  • BeezUP.Common.PageSize integer: Indicate the item count per page

BeezUP.Common.PaginationResult

  • BeezUP.Common.PaginationResult object
    • entryCount required integer: The entry count currently returned
    • links required BeezUP.Common.PaginationResultLinks
    • pageCount required integer: The page count
    • totalEntryCount required integer: The total entry count

BeezUP.Common.PaginationResultLinks

BeezUP.Common.ParameterIn

  • BeezUP.Common.ParameterIn string (values: path, header, query, body): * path: if the parameter must be pass in the path uri

BeezUP.Common.ParameterType

  • BeezUP.Common.ParameterType string (values: string, integer, number, boolean, object, array, date, date-time): The value type of the parameter

BeezUP.Common.ProductBasicInfo

  • BeezUP.Common.ProductBasicInfo object: The basic information related to a product
    • productExists required boolean: Indicates if the product still exists in your catalog
    • productId required string: The product identifier
    • productImageUrl string: The product image Url
    • productSku required string: The product SKU
    • productTitle required string: The product tile

BeezUP.Common.ProductColumnFilterOperatorName

  • BeezUP.Common.ProductColumnFilterOperatorName string: Indicate the operator you want to make on the columnId

BeezUP.Common.ProductFilters

BeezUP.Common.ProductId

  • BeezUP.Common.ProductId string: The product identifier

BeezUP.Common.StoreId

  • BeezUP.Common.StoreId string: The store identifier

BeezUP.Common.SuccessSummary

  • BeezUP.Common.SuccessSummary object
    • objectName string
    • propertyName string
    • propertyValue string
    • successArguments object
    • successCode string
    • successMessage string

BeezUP.Common.UserErrorMessage

  • BeezUP.Common.UserErrorMessage object
    • arguments array: a dictionary string/object
      • items object
        • name required string: The key of the parameter
        • value required object: The value of the parameter. Depending to the type.
    • code required string: the error code. The error code can be a pattern containing the argument's name
    • cultureName string: If the error is translated, the culture name will be indicated
    • docUrl BeezUP.Common.DocUrl
    • message required string: The error message

BeezUP.Common.UserId

  • BeezUP.Common.UserId string: The user identifier

BeezUP.Common.WarningSummary

  • BeezUP.Common.WarningSummary object
    • technicalErrorMessage string
    • warningArguments object
    • warningCode string
    • warningMessage string

LOVLink3

  • LOVLink3 object: Describe the way you have to follow to get access to the LOV
    • href required string: Indicate the uri to the list of value
    • method httpMethod

accountId

  • accountId integer: The marketplace account identifier in BeezUP. This account identifier is based on your api settings.

accountInfo

accountInfoLinks

accountPublications

accountPublicationsLinks

accountStatus

  • accountStatus string (values: Active, SystemBlocked, UserBlocked, NotActivated): The account status

accountSynchronization

accountSynchronizationList

accountingEmails

activateSubscriptionRequest

  • activateSubscriptionRequest object
    • recoverBeginPeriodOrderLastModificationUtcDate string: If set, the date must be in the past the subscription will recover existing orders using the begin period order last modification date. If not set then you will receive new/updated orders in real-time.
    • recoverEndPeriodOrderLastModificationUtcDate string: If end period set, first the date must be in the past, the subscription will recover existing orders using the begin and the end period order last modification date.

addChannelCatalogRequest

additionalAnalyticsProductColumnFilters

  • additionalAnalyticsProductColumnFilters object: Describes a filter on a product's column.

address

  • address string: Your address

alertEnabled

  • alertEnabled boolean: Is the alert enable ?

alertId

  • alertId integer: Alert identifier

alertName

  • alertName string: The alert name

alertPropertyId

  • alertPropertyId integer: The property identifier of the alert

alertPropertyValue

  • alertPropertyValue string: The property value

analyticsIndex

analyticsIndexLinks

analyticsIndexLovLinks

analyticsProductColumnFilter

analyticsProductColumnFilterOperatorName

  • analyticsProductColumnFilterOperatorName string: Indicate the operator you want to apply on the columnId

analyticsProductColumnFilters

analyticsStoreIndex

analyticsStoreIndexLinks

apiCredential

  • apiCredential object: Your api credential
    • primaryToken string: The primary token to be used in the next call in the user scope API
    • productName string: The product name related to this credential
    • secondaryToken string: The secondary token. Could be usefull if you want to share your access with someone else.

apiCredentials

  • apiCredentials object
    • credentials array: Your API credential list

autoImportConfiguration

  • autoImportConfiguration object
    • duplicateProductConfiguration required duplicateProductValueConfiguration
    • input required inputConfiguration
    • inputConfiguredByUserId required BeezUP.Common.UserId
    • pauseStatusChangedByUserId BeezUP.Common.UserId
    • pauseStatusChangedUtcDate string: Indicate when the pause status has changed in UTC date.
    • paused required boolean: Indicate if the auto import is in pause or not.
    • scheduledByUserId BeezUP.Common.UserId
    • schedulingLocalTimeZoneName string: Indicate the time zone name of the scheduling. If the scheduling type is "Schedule"
    • schedulingType required schedulingType
    • schedulingValue required array: Indicate the scheduling value. If the scheduling type is Interval then the value will be a duration otherwise the values will be the time.
      • items string

autoImportConfigurationLinks

automaticTransition

automaticTransitionInfo

automaticTransitionInfoLinks

automaticTransitionInfoList

automaticTransitionInfoListLinks

batchOrderOperationResponse

  • batchOrderOperationResponse object: The response given by the batch operation

beezUPColumnConfiguration

beezUPMarketplaceAccountId

  • beezUPMarketplaceAccountId integer: The marketplace account identifier in BeezUP. This account identifier is based on your api settings.

beezUPMarketplaceBusinessCode

  • beezUPMarketplaceBusinessCode string: In an marketplace technical code like CDiscount you can have several marketplaces like GO SPORT, etc. We identify them by a business code.

beezUPMarketplaceTechnicalCode

  • beezUPMarketplaceTechnicalCode string: The technical code of the marketplace.

beezUPOrderId

  • beezUPOrderId string: The BeezUP Order identifier

beezUPOrderStatus

  • beezUPOrderStatus string: BeezUP order status. Unified for all marketplaces.

beezUPTimeZoneId

  • beezUPTimeZoneId integer: The time zone identifier based on the list of values /v2/user/lov/BeezUPTimeZone

billingPeriod

  • billingPeriod object
    • billingPeriodInMonth required integer: The billing period in month
    • discountPercentage required number: The discount percentage related to this billing period

billingPeriodInMonth

  • billingPeriodInMonth integer: Can be null. The billing period in month based on /billingPeriods

billingPeriodList

billingPeriodListLinks

bonusInfo

  • bonusInfo object
    • amount required number
    • bonusType required bonusType

bonusType

  • bonusType string (values: OnlinePaymentMethodBonus, PreviousInvoiceProrataBonus, PreviousContractBonus)

businessOperationType

  • businessOperationType string

canBeTruncated

  • canBeTruncated boolean: If the size of the value is greater than the limit we can truncate the value instead of failing...

cardNumber

  • cardNumber string: Card number

cardVerificationCode

  • cardVerificationCode string: Card Verification Code

catalogColumn

catalogColumnLinks

catalogColumnList

  • catalogColumnList object

catalogColumnName

  • catalogColumnName string: The catalog column name

catalogIndex

catalogIndexLOVLinks

catalogIndexLinks

catalogStoreIndex

catalogStoreIndexLinks

catalogStoreIndexList

  • catalogStoreIndexList object
    • links object: The key is the store identifier.

catalogStoreStatus

  • catalogStoreStatus string (values: OK, Failed, Outdated): Indicates the status of the catalog store.

category

  • category object: The catalog category

categoryList

  • categoryList object: The object which contains the category list
    • categories required array: The category list

categoryMappingState

  • categoryMappingState object: The category mapping state of the channel catalog
    • categorizedWithoutCostProductCount integer: Indicates the categorized product count without cost defined on the category
    • status categoryMappingStatus
    • uncategorizedProductCount integer: Indicates the uncategorized product count

categoryMappingStatus

  • categoryMappingStatus string (values: warning, success, failed)

changeCustomColumnExpressionRequest

changeCustomColumnRequest

changeEmailRequest

changeOrderListRequest

  • changeOrderListRequest object: Contains all change order operations you want to make. (max 100 items per call)

changeOrderListRequestItem

changeOrderReporting

  • changeOrderReporting object: The reporting related to a change order operation
    • changeOrderType businessOperationType
    • creationUtcDate string: The creation UTC date of the execution
    • details object
    • errorMessage string: The error message during the execution
    • executionUUID executionUUID
    • ipAddress string: The IP address who request this operation
    • lastUpdateUtcDate string: The last update UTC date of the execution
    • processingStatus string: The processing status of the execution
    • sourceType sourceType
    • sourceUserId BeezUP.Common.UserId
    • sourceUserName string
    • testMode boolean: This operation was a test

changeOrderRequest

  • changeOrderRequest object: All properties with the prefix order_ are translated in the list of values /user/lov#OrderMetaInfoPosted

changePasswordRequest

  • changePasswordRequest object
    • newPassword required string: Your new password. Which must respect the same constraints as the user registeration
    • oldPassword required string: Your current password

changeUserColumnNameRequest

  • changeUserColumnNameRequest object: The message request for the change user column name

channelCatalog

channelCatalogCategoryConfiguration

  • channelCatalogCategoryConfiguration object: Represent a mapping between a catalog category path and a channel category path.

channelCatalogCategoryConfigurationInfo

channelCatalogCategoryConfigurationList

channelCatalogCategoryCostValue

  • channelCatalogCategoryCostValue number: In case of CPC_ByCategory or CPA_ByCategory cost type, you have to indicate the cost value.

channelCatalogCategoryMappingInfoLinks

channelCatalogCategoryMappingSettings

  • channelCatalogCategoryMappingSettings object
    • categoryMappingDisabledByMerchant boolean: Optional parameter. Indicates that you have decided to do not map your categories with the channel's categories.

channelCatalogCategoryMappingsLinks

channelCatalogColumnMapping

channelCatalogColumnMappingList

channelCatalogColumnMappingListWithName

channelCatalogColumnMappingWithName

channelCatalogExportCacheInfo

  • channelCatalogExportCacheInfo object
    • cacheStatus required string: The cache status
    • expirationUtcDate string: The expiration UTC date of the cache
    • feedUrl string: The feed url
    • lastContentChangeUtcDate string: The last content change UTC date
    • lastUpdateUtcDate string: The last update UTC date of the cache

channelCatalogExportCacheInfoResponse

channelCatalogExportCacheInfoResponseLinks

channelCatalogExportationHistory

channelCatalogExportationHistoryLinks

channelCatalogExportationReporting

  • channelCatalogExportationReporting object
    • cacheStatus string: The cache status during the exportation
    • clientIpAddress required string: The IP address of the client who requests this exportation
    • clientUserAgent required string: The http header User-Agent sent by the client who requests this operation
    • exportationDuration string: The exportation duration. \
    • exportationUtcDate required string: The exportation UTC date
    • exportedProductCount integer: The exportated product count during this exportation

channelCatalogLinks

channelCatalogList

channelCatalogListLinks

channelCatalogListLovLinks

channelCatalogMarketplaceBooleanProperty

  • channelCatalogMarketplaceBooleanProperty
    • info BeezUP.Common.InfoSummaries
    • description string: Indicate the description of the property
    • discriminatorType required channelCatalogMarketplacePropertyDiscriminatorType
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: Indicates if the property value must be in the list of value.
    • maxItems integer: Indicates the maximum item count of the property value
    • maxLength integer: Indicates the maximum size of the property value
    • minItems integer: Indicates the minimum item count of the property value.
    • minLength integer: Indicates the minimum size of the property value
    • name required channelCatalogMarketplacePropertyName
    • offerIdRequired integer: Indicates the offer identifier required to configure this property.
    • pattern string: Channel catalog marketplace setting value format validation regular expression
    • position required integer: Indicate the position of the property in the display group
    • readOnly required boolean: Indicate if the value cannot be changed. This is used for example for ebay token that should not be changed.
    • required required boolean: Indicate if the property is required or not
    • type required type
    • visible required boolean: Indicates if this property should be displayed in the configuration page.
    • _default boolean: Indicate the default values of the property

channelCatalogMarketplaceBooleanSetting

channelCatalogMarketplaceIntegerProperty

  • channelCatalogMarketplaceIntegerProperty
    • info BeezUP.Common.InfoSummaries
    • description string: Indicate the description of the property
    • discriminatorType required channelCatalogMarketplacePropertyDiscriminatorType
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: Indicates if the property value must be in the list of value.
    • maxItems integer: Indicates the maximum item count of the property value
    • maxLength integer: Indicates the maximum size of the property value
    • minItems integer: Indicates the minimum item count of the property value.
    • minLength integer: Indicates the minimum size of the property value
    • name required channelCatalogMarketplacePropertyName
    • offerIdRequired integer: Indicates the offer identifier required to configure this property.
    • pattern string: Channel catalog marketplace setting value format validation regular expression
    • position required integer: Indicate the position of the property in the display group
    • readOnly required boolean: Indicate if the value cannot be changed. This is used for example for ebay token that should not be changed.
    • required required boolean: Indicate if the property is required or not
    • type required type
    • visible required boolean: Indicates if this property should be displayed in the configuration page.
    • _default array: Indicate the default values of the property
      • items integer

channelCatalogMarketplaceIntegerSetting

channelCatalogMarketplaceNumberProperty

  • channelCatalogMarketplaceNumberProperty
    • info BeezUP.Common.InfoSummaries
    • description string: Indicate the description of the property
    • discriminatorType required channelCatalogMarketplacePropertyDiscriminatorType
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: Indicates if the property value must be in the list of value.
    • maxItems integer: Indicates the maximum item count of the property value
    • maxLength integer: Indicates the maximum size of the property value
    • minItems integer: Indicates the minimum item count of the property value.
    • minLength integer: Indicates the minimum size of the property value
    • name required channelCatalogMarketplacePropertyName
    • offerIdRequired integer: Indicates the offer identifier required to configure this property.
    • pattern string: Channel catalog marketplace setting value format validation regular expression
    • position required integer: Indicate the position of the property in the display group
    • readOnly required boolean: Indicate if the value cannot be changed. This is used for example for ebay token that should not be changed.
    • required required boolean: Indicate if the property is required or not
    • type required type
    • visible required boolean: Indicates if this property should be displayed in the configuration page.
    • _default array: Indicate the default values of the property
      • items number

channelCatalogMarketplaceNumberSetting

channelCatalogMarketplaceProperties

channelCatalogMarketplacePropertiesLinks

channelCatalogMarketplaceProperty

  • channelCatalogMarketplaceProperty object: Model for fetching a channel catalog marketplace property
    • info BeezUP.Common.InfoSummaries
    • description string: Indicate the description of the property
    • discriminatorType required channelCatalogMarketplacePropertyDiscriminatorType
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: Indicates if the property value must be in the list of value.
    • maxItems integer: Indicates the maximum item count of the property value
    • maxLength integer: Indicates the maximum size of the property value
    • minItems integer: Indicates the minimum item count of the property value.
    • minLength integer: Indicates the minimum size of the property value
    • name required channelCatalogMarketplacePropertyName
    • offerIdRequired integer: Indicates the offer identifier required to configure this property.
    • pattern string: Channel catalog marketplace setting value format validation regular expression
    • position required integer: Indicate the position of the property in the display group
    • readOnly required boolean: Indicate if the value cannot be changed. This is used for example for ebay token that should not be changed.
    • required required boolean: Indicate if the property is required or not
    • type required type
    • visible required boolean: Indicates if this property should be displayed in the configuration page.

channelCatalogMarketplacePropertyDiscriminatorType

  • channelCatalogMarketplacePropertyDiscriminatorType string (values: channelCatalogMarketplaceStringProperty, channelCatalogMarketplaceIntegerProperty, channelCatalogMarketplaceBooleanProperty, channelCatalogMarketplaceNumberProperty)

channelCatalogMarketplacePropertyGroup

  • channelCatalogMarketplacePropertyGroup object
    • name required string: Indicate the code identifier of the group
    • position required integer: Indicate the position of the group
    • properties required array

channelCatalogMarketplacePropertyName

  • channelCatalogMarketplacePropertyName string: Channel catalog marketplace property name

channelCatalogMarketplaceSetting

channelCatalogMarketplaceSettingArray

channelCatalogMarketplaceSettingDiscriminatorType

  • channelCatalogMarketplaceSettingDiscriminatorType string (values: channelCatalogMarketplaceStringSetting, channelCatalogMarketplaceIntegerSetting, channelCatalogMarketplaceBooleanSetting, channelCatalogMarketplaceNumberSetting)

channelCatalogMarketplaceSettings

channelCatalogMarketplaceSettingsLinks

channelCatalogMarketplaceStringProperty

  • channelCatalogMarketplaceStringProperty
    • info BeezUP.Common.InfoSummaries
    • description string: Indicate the description of the property
    • discriminatorType required channelCatalogMarketplacePropertyDiscriminatorType
    • lovLink BeezUP.Common.LOVLink3
    • lovRequired boolean: Indicates if the property value must be in the list of value.
    • maxItems integer: Indicates the maximum item count of the property value
    • maxLength integer: Indicates the maximum size of the property value
    • minItems integer: Indicates the minimum item count of the property value.
    • minLength integer: Indicates the minimum size of the property value
    • name required channelCatalogMarketplacePropertyName
    • offerIdRequired integer: Indicates the offer identifier required to configure this property.
    • pattern string: Channel catalog marketplace setting value format validation regular expression
    • position required integer: Indicate the position of the property in the display group
    • readOnly required boolean: Indicate if the value cannot be changed. This is used for example for ebay token that should not be changed.
    • required required boolean: Indicate if the property is required or not
    • type required type
    • visible required boolean: Indicates if this property should be displayed in the configuration page.
    • _default array: Indicate the default values of the property
      • items string

channelCatalogMarketplaceStringSetting

channelCatalogProductByChannelCatalogRequest

channelCatalogProductByChannelCatalogResponse

  • channelCatalogProductByChannelCatalogResponse object
    • channelCatalogs object: The channel catalog product by channel catalog. The key is the channel catalog identifier

channelCatalogProductInfo

  • channelCatalogProductInfo
    • productExists required boolean: Indicates if the product still exists in your catalog
    • productId required string: The product identifier
    • productImageUrl string: The product image Url
    • productSku required string: The product SKU
    • productTitle required string: The product tile
    • disabled required boolean: Indicates if the product has been disabled or not
    • excluded required boolean: Indicates if the product has been excluded by a exclusion filter
    • excludedBy array
    • links required channelCatalogProductInfoLinks
    • overrides required productOverridesWithCatalogValues
    • uncategorized required boolean: Indicates if the product's category has been NOT mapped to a channel category

channelCatalogProductInfoLinks

channelCatalogProductInfoList

channelCatalogProductInfoListLinks

channelCatalogProductsCounters

  • channelCatalogProductsCounters object: The channel catalog products counters. For each counter you will have a count.
    • disabledProductCountExcludingUncategorizedAndExcluded integer: Disabled product count EXCLUDING uncategorized products AND excluded products on existing products.
    • disabledProductCountIncludingUncategorizedAndExcluded integer: Disabled product count INCLUDING uncategorized products AND excluded products on existing products.
    • excludedProductCountExcludingUncategorized integer: Excluded product count EXCLUDING uncategorized products on existing products.
    • excludedProductCountIncludingUncategorized integer: Excluded product count INCLUDING uncategorized products on existing products.
    • existingProductCount integer: Imported product count currently in your catalog.
    • uncategorizedProductCount integer: Product count WITHOUT category mapped on existing products.

channelCatalogState

channelCategory

channelCategoryChannelCode

  • channelCategoryChannelCode string: The channel category channel code identifier

channelCategoryColumnOverride

channelCategoryColumnOverrides

  • channelCategoryColumnOverrides object: The channel category column overrides

channelCategoryDefaultCost

  • channelCategoryDefaultCost number: The default cost on this channel category

channelCategoryLevel

  • channelCategoryLevel integer: The channel category level starting from 1

channelCategorySettings

  • channelCategorySettings object
    • mappingLeafRequired boolean: Indicates if the category mapping is required on category path leaf or not
    • mappingRequired boolean: Indicates if the category mapping is required, otherwise you can map the categories but it will not block the publication of your catalog

channelColumn

channelColumnConfiguration

channelColumnDescription

  • channelColumnDescription string: The channel column description

channelColumnRestrictedValues

  • channelColumnRestrictedValues object: The restricted values. The key will be the restricted value identifier (format:guid) and the value will be the restriced value

channelColumnShowInMapping

  • channelColumnShowInMapping boolean: Indicates if this column must shown in the mapping page or not

channelCostSettings

  • channelCostSettings object: Indicate the default configuration of the cost on this channel.
    • costType required costType
    • globalCostValue number: In case of global cost type, you have to indicate the cost value.

channelFirstLevelCategory

channelHeader

channelHeaderLinks

channelInfo

  • channelInfo object
    • homeUrl required string: The channel home url
    • logoUrl required string: The channel logo url
    • name required string: The channel name
    • sectors array: The sector list related to a channel
      • items string
    • types required array: The type list related to a channel
      • items string

channelInfoList

channelRootCategory

  • channelRootCategory object: Get channel first level category list

city

  • city string: Your address city

clearMerchantOrderInfoListRequest

  • clearMerchantOrderInfoListRequest object

clickIncludedAndAdditionalClickPrice

  • clickIncludedAndAdditionalClickPrice object
    • additionalClickPrice number: The additional click price
    • clickIncluded integer: The click included

clickIncludedAndVariablePrice

  • clickIncludedAndVariablePrice object
    • clickIncluded integer: Click included
    • variablePrice number: The pricing applied for this range

columnConfiguration

columnCultureName

  • columnCultureName string: If non null, culture used to parse the value to the storage type of this column\r\n will be used for parsing and for consolidation proces

columnFormat

  • columnFormat string: If non null, format used to parse the value to the storage type of this column\r\n will be used for parsing and for consolidation proces

columnId

  • columnId string: The catalog column identifier

columnMappingStatus

  • columnMappingStatus string (values: warning, success, failed)

company

  • company string: Your company name

companyInfo

compareOptions

  • compareOptions string (values: None, IgnoreCase, IgnoreNonSpace, IgnoreSymbols, OrdinalIgnoreCase, StringSort, Ordinal): Indicate how the product sku are compared for the duplication check.

compressionFormatStrategy

  • compressionFormatStrategy string (values: None, Zip, TarGz, Gzip, Bzip2, Rar): Indicate the compression type

computeExpressionRequest

  • computeExpressionRequest object: The request message to compute an expression based on the provided product values

configureAutoImportIntervalRequest

  • configureAutoImportIntervalRequest object: The message request to configure the auto import interval
    • interval required string: Indicate the interval in time span. (i.e. "04:00:00" for every 4 hours)

configureAutomaticTransitionRequest

  • configureAutomaticTransitionRequest object

configureCatalogColumnCatalogRequest

  • configureCatalogColumnCatalogRequest object: The request to configure a catalog column

configureCategoryRequest

  • configureCategoryRequest object: The request message to make a mapping between catalog category path and a channel category path
    • channelCatalogCategories required array
    • overrideSubCategoryMappings required boolean: Great feature! In case of mapping to parent channel category, you can ask to override the mapping of all sub channel category to this catalog category path

consumptionAvailabilityStatus

  • consumptionAvailabilityStatus string (values: Available, Degraded, Unavailable): The subscription consumption status

contractBillingPeriodInfo

  • contractBillingPeriodInfo object: Describe the billing period information related to the offer.
    • amountBillingPeriodDiscount number: The amount discounted related to the billing period
    • billingPeriodInMonth billingPeriodInMonth
    • billingPeriodPercentDiscount number: The discount percent related to the billing period

contractBonusInfo

  • contractBonusInfo object: Describe the bonus information related to your current contract.

contractClickInfo

  • contractClickInfo object: Describe the click information related to the offer.
    • additionalClickPrice number: The addition click price in the offer
    • clickIncluded integer: The click included in the offer
    • initialOfferClickIncluded integer: The click included in your current contract

contractCommitmentInfo

  • contractCommitmentInfo object: Describe the commitment information related to the offer.
    • commercialCreatorUserId string: The commercial that is responsible of the creation of your account
    • commercialUserId string: Your current commercial user id
    • commitmentCalculatedFinishDate string: The commitment end date related to the offer
    • commitmentPeriodInMonth integer: The commitment period in month related to the offer
    • contractType integer: Internal usage: Old offer type. Your contract type
    • couponOfferCode couponOfferCode
    • currentContractId string: Your current contract id
    • currentContractTerminationDate string: The current contract termination date
    • currentCustomerPaymentMethod paymentMethod
    • fixedAndVariableClickInfo fixedAndVariableClickModelInfo
    • isCustomerWantsToTerminateHisContract boolean: If true, this means you want to leave us and that's sad... :'-(
    • isModelMustBeTransmittedInNewContract boolean: Internal usage: Old offer type. Is the current contract model needs to be converted into a new contract type
    • minBillingPeriodInMonths integer: The minimum billing period in month authorized for this offer.
    • model string: Interal usage: Old offer type. The model description
    • newContractStartDate string: The start date related to the offer
    • offerId offerId
    • offerName string: The offer Name
    • paymentDelayInDays integer: The payment delay in days related to the offer
    • paymentMethodAuthorized paymentMethod
    • requestedPaymentMethod paymentMethod
    • trialPeriodFinishDate string: The trial period end date related to the offer
    • trialPeriodInMonth integer: The trial period in month related to the offer
    • variableModelInfo variableModelInfo

contractDiscountInfo

  • contractDiscountInfo object: Describe the discount information related to the offer.
    • amountCodePromoDiscount number: The discount amount
    • amountCodePromoDiscountPerMonth number: The amount discounted per month
    • couponDiscountCode string: The discount code
    • couponDiscountId integer: Internal use: The discount id
    • customerHasActualDiscount boolean: Do you have currently a discount on your contract ?
    • discountDurationInMonth integer: Duration of the discount in month
    • isCouponDiscountLinkedToCouponOffer boolean: Is this discount is related to a coupon offer
    • percentDiscount number: Percentage of the discount
    • promotionalCodeValidity promotionalCodeValidity

contractId

  • contractId string: Your contract identifier

contractInfo

  • contractInfo object: Describe the conditions of a contract
    • additionalClickPrice number: Additional click price
    • billingPeriodInMonth integer: The billing period in month
    • billingPeriodPercentDiscount number: The percent discount related to the billing period
    • clickIncluded integer: The click included
    • commitmentCalculatedFinishUtcDate string: The calculated end date of commitment
    • commitmentPeriodInMonth integer: The commitment period in month
    • contractId contractId
    • currencyCode BeezUP.Common.CurrencyCode
    • discountDurationInMonth integer: The discount duration in month
    • discountEndUtcDate string: The end of your discount
    • fixedAndVariableClickInfo fixedAndVariableClickModelInfo
    • fixedPrice number: The fixed price of your contract
    • ipUserCreation string: The IP of the user who creates the contract
    • ipUserModification string: The IP of the user who modified the contract
    • isCommitmentRenewalAutomatically boolean: Is commitment is automatically renewed
    • isModifiableContract boolean: Is the contract is modifiable ?
    • offerId offerId
    • offerName string: The offer name based on /offers
    • percentDiscount number: The percent of the discount
    • startUtcDate string: The start date of your contract
    • storeCount storeCount
    • trialPeriodInMonth integer: The trial period in month
    • variableModelInfo variableModelInfo

contractMoneyInfo

  • contractMoneyInfo object: Describe the pricing information related to the offer.
    • amountExcludingTaxesAndExcludingCodePromoDiscountIncludingBillingPeriodDiscount number: The amount excluding taxes and excluding code promo discount including billing period discount.
    • amountExcludingTaxesAndExcludingDiscounts number: The amount excluding taxes and excluding discounts.
    • amountExcludingTaxesIncludingDiscounts number: The amount excluding taxes including discounts.
    • amountExcludingTaxesIncludingDiscountsPerMonth number: The amount excluding taxes including discounts per month.
    • amountIncludingTaxesExcludingDiscountIncludingBillingPeriodDiscount number: The amount including taxes excluding discount including billing period discount.
    • amountIncludingTaxesIncludingDiscounts number: The amount including taxes including discounts.
    • amountTaxesExcludingDiscountIncludingBillingPeriodDiscount number: The taxes excluding discount including billing period discount.
    • amountTaxesIncludingDiscounts number: Taxes including discounts.
    • currencyCode BeezUP.Common.CurrencyCode
    • initialOfferFixedPrice number: The initial offer fixed price.
    • vatPercent number: The VAT percent.

contractStoreInfo

  • contractStoreInfo object: Describe the store information related to the offer.
    • additionalStorePrice number: The additional store price.
    • maxStoreCount integer: The maximum store count related to the offer.
    • minStoreCount integer: The minimum store count related to the offer.
    • ownedStoreCount integer: The owned store count.
    • storeCount storeCount
    • storeIncluded integer: The store count included in the offer.

contractTerminationReason

  • contractTerminationReason string: The termination reason, if your current contract is scheduled to be terminated.

contractTerminationReasonType

  • contractTerminationReasonType integer: The contract termination reason type identifier, if your current contract is scheduled to be terminated. The value is based on the list of values /user/lov/ContractTerminationReason

contracts

contractsLinks

copyOptimisationRequest

  • copyOptimisationRequest object: Copy the optimisation between 2 channels

copyOptimisationResponse

  • copyOptimisationResponse object: Products optimisatisation copied
    • catalogProductCount required integer: The catalog product count
    • channel required BeezUP.Common.ChannelBasicInfo
    • enabledProductCount required integer: The enabled product count

costSettings

  • costSettings object: If this property is not indicated please force the user to configure the cost settings.
    • costType required costType
    • globalCostValue number: In case of global cost type, you have to indicate the cost value.

costStatus

  • costStatus string (values: required, optional, notConfigurable)

costType

  • costType string (values: CPC_Global, CPA_Global, CPC_ByCategory, CPA_ByCategory, Fixed_Global): CPC means cost per click.

couponDiscountCode

  • couponDiscountCode string: The coupon discount code

couponOfferCode

  • couponOfferCode string: Your special coupon offer identifier

createContract

createContractResponse

createContractResponseLinks

createCustomColumnRequest

createRuleRequest

  • createRuleRequest object
    • endUtcDate string: The end validity utc date of the rule
    • optimisationActionName required optimisationActionName
    • reportFilterId required string: The report filter to use for the rule
    • ruleName required string: The name of the rule
    • startUtcDate string: The start validity utc date of the rule

createStoreRequest

createSubscriptionRequest

credential

  • credential object: Provides the credentials
    • password string: The password
    • userName required string: The user name

creditCardInfo

creditCardInfoResponse

creditCardInfoResponseLinks

creditCardInfoWithCardType

  • creditCardInfoWithCardType object
    • cardNumber required cardNumber
    • cardType required string: Your credit card type. Example: VISA, MasterCard, etc...
    • expirationMonth required expirationMonth
    • expirationYear required expirationYear

csvSeparator

  • csvSeparator string: Indicate the separator of the values in the CSV file. Generally ";"

cultureName

  • cultureName string: If the error is translated, the culture name will be indicated

currencyCode

  • currencyCode string: The currency code (ISO 4217)

currentContractInfo

  • currentContractInfo
    • additionalClickPrice number: Additional click price
    • billingPeriodInMonth integer: The billing period in month
    • billingPeriodPercentDiscount number: The percent discount related to the billing period
    • clickIncluded integer: The click included
    • commitmentCalculatedFinishUtcDate string: The calculated end date of commitment
    • commitmentPeriodInMonth integer: The commitment period in month
    • contractId contractId
    • currencyCode BeezUP.Common.CurrencyCode
    • discountDurationInMonth integer: The discount duration in month
    • discountEndUtcDate string: The end of your discount
    • fixedAndVariableClickInfo fixedAndVariableClickModelInfo
    • fixedPrice number: The fixed price of your contract
    • ipUserCreation string: The IP of the user who creates the contract
    • ipUserModification string: The IP of the user who modified the contract
    • isCommitmentRenewalAutomatically boolean: Is commitment is automatically renewed
    • isModifiableContract boolean: Is the contract is modifiable ?
    • offerId offerId
    • offerName string: The offer name based on /offers
    • percentDiscount number: The percent of the discount
    • startUtcDate string: The start date of your contract
    • storeCount storeCount
    • trialPeriodInMonth integer: The trial period in month
    • variableModelInfo variableModelInfo
    • links required currentContractInfoLinks

currentContractInfoLinks

customColumn

customColumnLinks

customColumnList

customColumnListLinks

customerIndex

customerIndexLinks

customerIndexLovLinks

dateSearchType

  • dateSearchType string (values: Modification, Purchase, MarketPlaceModification): Indicates on which date you want to make the filter

detectedCatalogColumn

detectedCatalogColumnLinks

detectedCatalogColumnList

detectedCatalogColumnListLinks

displayGroupName

  • displayGroupName string: Indicate the display group name where the column must be putted

docUrl

  • docUrl string: The documentation related to this operation.

downloadCatalogStrategy

  • downloadCatalogStrategy string (values: SimpleUri, FtpLatest, Sftp, SftpLatest, Ftps, FtpsLatest, Local): Indicate the download strategy (simple uri, ftps, ftplatest file, etc...)

duplicateProductValueConfiguration

duplicateProductValueStrategy

  • duplicateProductValueStrategy string (values: None, SkipAllDuplicateProducts, KeepFirstDuplicateProductOnly, FailImportationIfAnyDuplicateProduct): Indicate the duplicate product sku strategy.

email

  • email string: The email

encryptedBlocklyExpression

  • encryptedBlocklyExpression string: The encrypted XML Blockly representation of the expression

encryptedExpression

  • encryptedExpression string: The encrypted excel expression of the column

errorCode

  • errorCode string: Error Code

errorResponseMessage

errorResponseMessagePaymentRequired

errorResponseMessagePaymentRequiredLinks

errorSummary

  • errorSummary object
    • errorArguments object
    • errorCode string
    • errorGuid string
    • errorMessage string
    • exceptionDetail exceptionDetail
    • objectName string
    • propertyName string
    • propertyValue string
    • source string
    • technicalErrorMessage string
    • utcDate string

etag

  • etag string: ETag value to identify the order.\

exceptionDetail

  • exceptionDetail object
    • helpLink string
    • message string
    • stackTrace string
    • type string

exchangedMessagesItem

  • exchangedMessagesItem object
    • operationName required string
    • requestUri string
    • requestUtcDate string
    • responseUri string
    • responseUtcDate string

exclusionFilter

  • exclusionFilter object: The exclusion filter
    • channelColumnId required BeezUP.Common.ChannelColumnId
    • enabled required boolean: indicates if the filter is currently enable.
    • groupId required string: Indicate the filter's group. All filters in the same group means an "AND" operation in the filter group
    • name required exclusionFilterName
    • operatorName required exclusionFilterOperatorName
    • position required integer: The position of the exclusion filter
    • positionInGroup required integer: Indicate the filter group position. This information is used for the UI purpose and must be unique in the filter group.
    • value string: The value indicate by the user when the filter operation requires it.

exclusionFilterName

  • exclusionFilterName string: The exclusion filter name

exclusionFilterOperator

exclusionFilterOperatorDataType

  • exclusionFilterOperatorDataType string (values: string, number): Data type of the operator

exclusionFilterOperatorName

  • exclusionFilterOperatorName string: The exclusion filter operator name

exclusionFilters

exclusionFiltersResponse

exclusionFiltersResponseLinks

executionId

  • executionId string: The execution identifier of the catalog importation

executionUUID

  • executionUUID string: The execution identifier

expirationMonth

  • expirationMonth integer: Expiration Month

expirationYear

  • expirationYear integer: Expiration Year

exportOrderListFormat

  • exportOrderListFormat string (values: csv): The type of the file to export

exportOrderListRequest

externalLinks.Catalog_GetBeezUPColumnsLink

  • externalLinks.Catalog_GetBeezUPColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

externalLinks.GetChannelCatalogMarketplaceSettingsLink

  • externalLinks.GetChannelCatalogMarketplaceSettingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

externalLinks.GetChannelInfoLink

  • externalLinks.GetChannelInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

externalLinks.GetExternalConfigurationPageLink

  • externalLinks.GetExternalConfigurationPageLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

feedType

  • feedType string (values: Products, Inventory, Pricing, Images, Relationships, Unpublish, Offers): The Feed Type

fileFormatStrategy

  • fileFormatStrategy string (values: Unknown, Csv, Xml, Json): CSV or XML

firstName

  • firstName string: Your first name

fixedAndVariableClickModelInfo

  • fixedAndVariableClickModelInfo object: Internal usage: Old offer type. Describe the fix and variable model information

footerContentHtml

  • footerContentHtml string: Footer Content HTML

friendCountryIsoCodeAlpha3

  • friendCountryIsoCodeAlpha3 string: Your friend's user country iso code alpha 3

friendEmail

  • friendEmail string: Your friend's user email

friendProfilePictureUrl

  • friendProfilePictureUrl string: Your friend's user profile picture url

functionality

  • functionality object
    • code required string: The functionality code
    • order required integer: UI purpose: Indicate the position of the functionality

functionalityRightInfo

  • functionalityRightInfo object: Describe the rights for a functionality
    • functionalityCode required string: The functionality code
    • maxValueInterger integer: The max value for this functionality code considering your rights
    • unlimited boolean: If you can use this functionality unlimitedly

generalSettings

  • generalSettings object: Represents the general settings of your channel catalog
    • acceptToPublishInfo required boolean: If true then you authorize disclosure of my statistics generated from clicks and sales
    • activeBeezUPTracking required boolean: Activate BeezUP tracking for my statistics (checked by default)
    • doNotExportOutOfStockProducts required boolean: Do not export "out of stock" products. Note: this option is not taken into account by the counter.

generateOrderInvoiceRequest

getChannelCatalogProductInfoListRequest

getImportationProductsReportRequest

getImportationProductsReportRequestErrorCode

  • getImportationProductsReportRequestErrorCode object: Get Importation Products Report Request Error Codes

getImportationProductsReportRequestErrorCodes

getImportationProductsReportResponse

getImportationReportResponse

getImportationReportResponseDiff

  • getImportationReportResponseDiff object
    • createdCount required integer
    • deletedCount required integer
    • unchangedCount integer
    • updatedCount required integer

getImportationReportResponseError

  • getImportationReportResponseError object

getImportationReportResponseErrors

getImportationReportResponseImportationInfo

  • getImportationReportResponseImportationInfo object
    • beginUtcDate required string: The start date of the importation
    • endUtcDate required string: The start date of the importation
    • inputConfiguration required inputFileConfiguration
    • userId required BeezUP.Common.UserId

getImportationReportResponseProductMetrics

  • getImportationReportResponseProductMetrics object
    • activeCount required integer
    • detectedCount required integer
    • duplicatedCount required integer
    • failedCount required integer

getOrderInvoiceDesignPreviewResponse

  • getOrderInvoiceDesignPreviewResponse object

getOrderInvoiceGeneralSettingsResponse

getOrderInvoicePdfFromHtmlInvoiceUrlRequest

  • getOrderInvoicePdfFromHtmlInvoiceUrlRequest object

getProductsRequest

gravatarProfilePictureUrl

  • gravatarProfilePictureUrl string: Indicate the url of your picture profil based on gravatar

harvestOrderReporting

  • harvestOrderReporting object: The reporting related to a harvest order operation
    • beezUPForcedStatus string: The marketplace order status forced by BeezUP during the order change oepration. This could happend when there is no status on the marketplace side.
    • beezUPStatus beezUPOrderStatus
    • creationUtcDate string: The creation UTC date of the execution
    • errorMessage string: The warning message during the execution
    • executionUUID executionUUID
    • lastUpdateUtcDate string: The last update UTC date of the execution
    • marketplaceStatus string: The order marketplace status
    • processingStatus string: The processing status of the execution
    • warningMessage string: The warning message during the execution

headerContentHtml

  • headerContentHtml string: Header Content HTML

href

  • href string: Indicate the relative uri for this link

httpMethod

  • httpMethod string (values: GET, POST, PATCH, DELETE, PUT, HEAD): Indicate the http method to use on this link

httpUrl

importAlreadyInProgressResponse

importAlreadyInProgressResponseLinks

importationCustomColumn

importationCustomColumnLinks

importationCustomColumnList

importationCustomColumnListLinks

importationMonitoring

  • importationMonitoring object: Describe the reporting of the catalog importation
    • beginUtcDate required string: The start date of the importation
    • errors array: In case of error a description will be indicated
    • executionId required executionId
    • lastUpdateUtcDate required string: The last update of the reporting
    • links importationMonitoringLinks
    • steps required object: Contains all steps of the importation process with a boolean. If true the step has been passed, false the step is not complete
    • success required boolean: Indicates if the importation was successfully completed or not
    • userId BeezUP.Common.UserId

importationMonitoringLinks

importationReporting

  • importationReporting object: The catalog importation reporting
    • autoImported boolean: Indicate if this importation is an auto import or not.
    • beginUtcDate required string: Indicate the begin UTC date of this importation.
    • endUtcDate string: Indicate the end UTC date of this importation.
    • errors array: Indicate the error message list related to this importation.
    • executionId required executionId
    • inputConfigurationUrl string: Indicate the input url of this importation.
    • lastUpdateUtcDate required string: Indicate the last update UTC date of the reporting.
    • links importationReportingLinks
    • stepName string: The last step name of the importation process
    • steps required object: Indicate the steps that have been passed during the importation process
    • success boolean: Indicate if the importation succeed or not.
    • totalProductCount integer: Indicate the total product count detected in the catalog during the importation.
    • totalProductErrorCount integer: Indicate the total product count in error detected in the catalog during the importation.
    • totalProductSuccessCount integer: Indicate the total product count in success in the catalog during the importation.
    • userId BeezUP.Common.UserId

importationReportingLinks

importationTechnicalProgression

  • importationTechnicalProgression object
    • stepsProgression object: Indicate for each step of the importation the uris to look at

importationsResponse

importationsResponseLinks

infoSummaries

infoSummary

  • infoSummary object
    • informationArguments object
    • informationCode string
    • informationMessage string
    • objectName string
    • propertyName string
    • propertyValue string

initialsProfilePictureUrl

  • initialsProfilePictureUrl string: Indicate the url of your picture profil based on your initials

inputConfiguration

  • inputConfiguration object: Describe the input configuration
    • files required array: The list of files to get and read
    • transformFileUrl string: Can be null. Use to transform multiple files with an XSLT file.

inputFileConfiguration

inputFileFetchConfiguration

  • inputFileFetchConfiguration object: Describe the way to download the file
    • compressedRelativePath string: Indicate the relative path in the compressed file
    • compressionFormatStrategy compressionFormatStrategy
    • credential credential
    • downloadCatalogStrategy required downloadCatalogStrategy
    • downloadTimeout integer: Indicate the download time out in second
    • uri required string: Indicate the Uri of the file. (http, https, ftp, ftps, sftp are allowed)

inputFileReadConfiguration

  • inputFileReadConfiguration object: Describe how to read the file. If FileFormatStrategy is CSV, csvFileReadProperties is required. Otherwise the xmlFileReadProperties is required.

inputFileReadCsvConfiguration

  • inputFileReadCsvConfiguration object: The CSV file description
    • csvSeparator required csvSeparator
    • csvTextQualifier string: Indicate the text qualifier of the CSV file. Generally the value is "
    • hasHeaderRecord required boolean: Indicate if the csv file contains the column name at the first row
    • ignoreHeaderRecord required boolean: Indicate if the importation should not use the csv column name from the file

inputFileReadXmlConfiguration

  • inputFileReadXmlConfiguration object: The XML file description
    • flattenXmlChildElements required boolean: Indicate if the children xml nodes should be flatten with there parent to take in account the sub node values.
    • useXmlAttributes required boolean: Indicate if the importation should take in account the attribute in the xml nodes.

invoice

  • invoice object
    • amount required number: The amount of your invoice
    • amountToBePaid required number: The remaining amount to be paid for this invoice
    • contractId required contractId
    • currencyCode required BeezUP.Common.CurrencyCode
    • dueDate required string
    • invoiceDate required string: The invoice date
    • invoiceNumber required invoiceNumber
    • invoiceUrl string: The url of the invoice document
    • paymentStatus required invoicePaymentStatus

invoiceAvailabilityType

  • invoiceAvailabilityType string: Indicates on which invoice availability to filter

invoiceContentHtml

  • invoiceContentHtml string: Invoice Content HTML

invoiceList

invoiceListLinks

invoiceNumber

  • invoiceNumber string: Your invoice number

invoicePaymentStatus

  • invoicePaymentStatus string (values: Paid, NotPaid, PartiallyPaid, Loss): The payment status

invoicePrefix

  • invoicePrefix string: Invoice Prefix. Can contain 1 to 50 characters, with alphanumeric characters in lowercase uppercase and #, _, -

invoiceSequenceNumber

  • invoiceSequenceNumber integer: Invoice Sequence Number

lastManualImportInputConfiguration

  • lastManualImportInputConfiguration object: Last manual import input configuration

lastName

  • lastName string: Your last name

link3

  • link3 object
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

linkClickToOrderType

  • linkClickToOrderType string (values: OnPurchaseDate, OnClickDate)

linkParameter3

  • linkParameter3 object
    • description string: description of the parameter
    • in required parameterIn
    • label string: The label corresponding to the link parameter. This label is automatically translated based on the Accept-Language http header.
    • lovLink LOVLink3
    • lovRequired boolean: If true, you MUST indicate a value from the list of values otherwise it's a freetext
    • pattern validationPattern
    • required boolean
    • schema string: schema of the parameter
    • value object: The value of the parameter. It can be an integer a string or an object.

linkParameter3Types

  • linkParameter3Types object

linkParameterProperty3

  • linkParameterProperty3 object
    • description string: description of the parameter
    • label string: The label corresponding to the link parameter property. This label is automatically translated based on the Accept-Language http header.
    • lovLink LOVLink3
    • lovRequired boolean: If true, you MUST use indicate a value from the list of values otherwise it's a freetext
    • pattern validationPattern
    • required boolean
    • schema string: schema of the parameter
    • type required parameterType
    • value object: The value of the parameter. It can be an integer a string or an object.

links.AddChannelCatalogLink

  • links.AddChannelCatalogLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.AnalyticsIndexLink

  • links.AnalyticsIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Auto_ConfigureAutoImportIntervalLink

  • links.Auto_ConfigureAutoImportIntervalLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Auto_GetAutoImportConfigurationLink

  • links.Auto_GetAutoImportConfigurationLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Auto_PauseAutoImportLink

  • links.Auto_PauseAutoImportLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Auto_ResumeAutoImportLink

  • links.Auto_ResumeAutoImportLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Auto_ScheduleAutoImportLink

  • links.Auto_ScheduleAutoImportLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Auto_StartAutoImportLink

  • links.Auto_StartAutoImportLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.CatalogIndexLink

  • links.CatalogIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.CatalogStoreIndexLink

  • links.CatalogStoreIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_ChangeCatalogColumnUserNameLink

  • links.Catalog_ChangeCatalogColumnUserNameLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_ChangeCustomColumnExpressionLink

  • links.Catalog_ChangeCustomColumnExpressionLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_ChangeCustomColumnUserNameLink

  • links.Catalog_ChangeCustomColumnUserNameLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_ComputeExpressionLink

  • links.Catalog_ComputeExpressionLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_DeleteCustomColumnLink

  • links.Catalog_DeleteCustomColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetBeezUPColumnsLink

  • links.Catalog_GetBeezUPColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetCatalogColumnsLink

  • links.Catalog_GetCatalogColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetCategoriesLink

  • links.Catalog_GetCategoriesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetCustomColumnExpressionLink

  • links.Catalog_GetCustomColumnExpressionLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetCustomColumnsLink

  • links.Catalog_GetCustomColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetProductsLink

  • links.Catalog_GetProductsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_GetRandomProductsLink

  • links.Catalog_GetRandomProductsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Catalog_SaveCustomColumnLink

  • links.Catalog_SaveCustomColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ChangeOrderLink

  • links.ChangeOrderLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not
    • rel string: Indicate the relation name related to the link

links.ChangeOrderV3Link

  • links.ChangeOrderV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not
    • rel string: Indicate the relation name related to the link

links.ClearChannelCatalogExportationCacheLink

  • links.ClearChannelCatalogExportationCacheLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ClearMerchantOrderInfoLink

  • links.ClearMerchantOrderInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ClearMerchantOrderInfoListLink

  • links.ClearMerchantOrderInfoListLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ClearMerchantOrderInfoListV3Link

  • links.ClearMerchantOrderInfoListV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.ClearMerchantOrderInfoV3Link

  • links.ClearMerchantOrderInfoV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureAutomaticTransitionsLink

  • links.ConfigureAutomaticTransitionsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogCategoryLink

  • links.ConfigureChannelCatalogCategoryLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogColumnMappingsLink

  • links.ConfigureChannelCatalogColumnMappingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogCostSettingsLink

  • links.ConfigureChannelCatalogCostSettingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogExclusionFiltersCopyLink

  • links.ConfigureChannelCatalogExclusionFiltersCopyLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogExclusionFiltersLink

  • links.ConfigureChannelCatalogExclusionFiltersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogGeneralSettingsLink

  • links.ConfigureChannelCatalogGeneralSettingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ConfigureChannelCatalogProductValueOverrideCopyLink

  • links.ConfigureChannelCatalogProductValueOverrideCopyLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.CreateRuleLink

  • links.CreateRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DeleteChannelCatalogLink

  • links.DeleteChannelCatalogLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DeleteReportFilterLink

  • links.DeleteReportFilterLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DeleteRuleLink

  • links.DeleteRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DisableChannelCatalogCategoryMappingLink

  • links.DisableChannelCatalogCategoryMappingLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DisableChannelCatalogLink

  • links.DisableChannelCatalogLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DisableChannelCatalogProductLink

  • links.DisableChannelCatalogProductLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.DisableRuleLink

  • links.DisableRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.EnableChannelCatalogLink

  • links.EnableChannelCatalogLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.EnableRuleLink

  • links.EnableRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ExportChannelCatalogProductInfoListLink

  • links.ExportChannelCatalogProductInfoListLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ExportOrdersLink

  • links.ExportOrdersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ExportOrdersV3Link

  • links.ExportOrdersV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetAutomaticTransitionsLink

  • links.GetAutomaticTransitionsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogCategoriesLink

  • links.GetChannelCatalogCategoriesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogExclusionFilterOperatorsLink

  • links.GetChannelCatalogExclusionFilterOperatorsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogExclusionFiltersCopyLink

  • links.GetChannelCatalogExclusionFiltersCopyLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogExclusionFiltersLink

  • links.GetChannelCatalogExclusionFiltersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogExportationCacheInfoLink

  • links.GetChannelCatalogExportationCacheInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogExportationHistoryLink

  • links.GetChannelCatalogExportationHistoryLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogLink

  • links.GetChannelCatalogLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogMarketplacePropertiesLink

  • links.GetChannelCatalogMarketplacePropertiesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogMarketplaceSettingsLink

  • links.GetChannelCatalogMarketplaceSettingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogProductInfoLink

  • links.GetChannelCatalogProductInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogProductInfoListLink

  • links.GetChannelCatalogProductInfoListLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogProductValueOverrideCopyLink

  • links.GetChannelCatalogProductValueOverrideCopyLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelCatalogsLink

  • links.GetChannelCatalogsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelInfoLink

  • links.GetChannelInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelsIndexLink

  • links.GetChannelsIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetChannelsLink

  • links.GetChannelsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetCustomerIndexLink

  • links.GetCustomerIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetMarketplaceAccountsSynchronizationLink

  • links.GetMarketplaceAccountsSynchronizationLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetMarketplaceAccountsSynchronizationV3Link

  • links.GetMarketplaceAccountsSynchronizationV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetMarketplaceChannelCatalogsLink

  • links.GetMarketplaceChannelCatalogsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderExportationsLink

  • links.GetOrderExportationsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderExportationsV3Link

  • links.GetOrderExportationsV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderHistoryLink

  • links.GetOrderHistoryLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderHistoryV3Link

  • links.GetOrderHistoryV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderIndexLink

  • links.GetOrderIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderLink

  • links.GetOrderLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderListFullLink

  • links.GetOrderListFullLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderListFullV3Link

  • links.GetOrderListFullV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderListLightLink

  • links.GetOrderListLightLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderListLightV3Link

  • links.GetOrderListLightV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetOrderV3Link

  • links.GetOrderV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetPublicListOfValuesLink

  • links.GetPublicListOfValuesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetPublicLovIndexLink

  • links.GetPublicLovIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetPublicationsLink

  • links.GetPublicationsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetReportFilterLink

  • links.GetReportFilterLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetReportFiltersLink

  • links.GetReportFiltersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetRuleLink

  • links.GetRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetRulesExecutionsLink

  • links.GetRulesExecutionsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetRulesLink

  • links.GetRulesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreReportByCategoryLink

  • links.GetStoreReportByCategoryLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreReportByChannelLink

  • links.GetStoreReportByChannelLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreReportByDayLink

  • links.GetStoreReportByDayLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreReportByProductLink

  • links.GetStoreReportByProductLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreTrackedClicksLink

  • links.GetStoreTrackedClicksLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreTrackedExternalOrdersLink

  • links.GetStoreTrackedExternalOrdersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreTrackedOrdersLink

  • links.GetStoreTrackedOrdersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetStoreTrackingStatusLink

  • links.GetStoreTrackingStatusLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetTrackingStatusLink

  • links.GetTrackingStatusLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetUserListOfValuesLink

  • links.GetUserListOfValuesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.GetUserLovIndexLink

  • links.GetUserLovIndexLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.HarvestAllLink

  • links.HarvestAllLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.HarvestAllV3Link

  • links.HarvestAllV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.HarvestOrderLink

  • links.HarvestOrderLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.HarvestOrderV3Link

  • links.HarvestOrderV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_ActivateAutoImportLink

  • links.Importation_ActivateAutoImportLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_CancelLink

  • links.Importation_CancelLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_CommitColumnsLink

  • links.Importation_CommitColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_CommitLink

  • links.Importation_CommitLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_ConfigureCatalogColumnLink

  • links.Importation_ConfigureCatalogColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_ConfigureRemainingCatalogColumnsLink

  • links.Importation_ConfigureRemainingCatalogColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_DeleteCustomColumnLink

  • links.Importation_DeleteCustomColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetCustomColumnExpressionLink

  • links.Importation_GetCustomColumnExpressionLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetCustomColumnsLink

  • links.Importation_GetCustomColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetDetectedCatalogColumnsLink

  • links.Importation_GetDetectedCatalogColumnsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetImportationMonitoringLink

  • links.Importation_GetImportationMonitoringLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetManualUpdateLastInputConfigLink

  • links.Importation_GetManualUpdateLastInputConfigLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetProductSampleCustomColumnValueLink

  • links.Importation_GetProductSampleCustomColumnValueLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetProductSampleLink

  • links.Importation_GetProductSampleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetReportLink

  • links.Importation_GetReportLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_GetReportingsLink

  • links.Importation_GetReportingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_IgnoreColumnLink

  • links.Importation_IgnoreColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_MapCatalogColumnLink

  • links.Importation_MapCatalogColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_MapCustomColumnLink

  • links.Importation_MapCustomColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_ReattendColumnLink

  • links.Importation_ReattendColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_SaveCustomColumnLink

  • links.Importation_SaveCustomColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_StartManualUpdateLink

  • links.Importation_StartManualUpdateLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_TechnicalProgressionLink

  • links.Importation_TechnicalProgressionLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_UnmapCatalogColumnLink

  • links.Importation_UnmapCatalogColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.Importation_UnmapCustomColumnLink

  • links.Importation_UnmapCustomColumnLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.MoveDownRuleLink

  • links.MoveDownRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.MoveUpRuleLink

  • links.MoveUpRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.OptimiseAllLink

  • links.OptimiseAllLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.OptimiseByCategoryLink

  • links.OptimiseByCategoryLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.OptimiseByChannelLink

  • links.OptimiseByChannelLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.OptimiseByProductLink

  • links.OptimiseByProductLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.OptimiseLink

  • links.OptimiseLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.OverrideChannelCatalogProductValuesLink

  • links.OverrideChannelCatalogProductValuesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ReenableChannelCatalogCategoryMappingLink

  • links.ReenableChannelCatalogCategoryMappingLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.ReenableChannelCatalogProductLink

  • links.ReenableChannelCatalogProductLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.RunRuleLink

  • links.RunRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.RunRulesLink

  • links.RunRulesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.SaveReportFilterLink

  • links.SaveReportFilterLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.SetChannelCatalogMarketplaceSettingsLink

  • links.SetChannelCatalogMarketplaceSettingsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.SetMerchantOrderInfoLink

  • links.SetMerchantOrderInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.SetMerchantOrderInfoListLink

  • links.SetMerchantOrderInfoListLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.SetMerchantOrderInfoListV3Link

  • links.SetMerchantOrderInfoListV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.SetMerchantOrderInfoV3Link

  • links.SetMerchantOrderInfoV3Link
    • info infoSummaries
    • parameters linkParameter3Types
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl docUrl
    • href required href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method httpMethod
    • operationId operationId
    • rel string: Indicate the relation name related to the link
    • urlTemplated boolean: indicates whether the href is templated or not

links.UpdateRuleLink

  • links.UpdateRuleLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.activateUserAccountLink

  • links.activateUserAccountLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.changeEmailLink

  • links.changeEmailLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.changePasswordLink

  • links.changePasswordLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.createContractLink

  • links.createContractLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.createStoreLink

  • links.createStoreLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.deleteNextContractLink

  • links.deleteNextContractLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.deleteStoreLink

  • links.deleteStoreLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.deleteStoreShareLink

  • links.deleteStoreShareLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getBillingPeriodsLink

  • links.getBillingPeriodsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getContractsLink

  • links.getContractsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getCreditCardInfoLink

  • links.getCreditCardInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getFriendInfoLink

  • links.getFriendInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getInvoicesLink

  • links.getInvoicesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getOfferLink

  • links.getOfferLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getProfilePictureInfoLink

  • links.getProfilePictureInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getStandardOffersLink

  • links.getStandardOffersLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getStoreLink

  • links.getStoreLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getStoreSharesLink

  • links.getStoreSharesLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getStoresLink

  • links.getStoresLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.getUserAccountInfoLink

  • links.getUserAccountInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.logoutLink

  • links.logoutLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.reactivateCurrentContractLink

  • links.reactivateCurrentContractLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.saveCompanyInfoLink

  • links.saveCompanyInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.saveCreditCardInfoLink

  • links.saveCreditCardInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.savePersonalInfoLink

  • links.savePersonalInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.saveProfilePictureInfoLink

  • links.saveProfilePictureInfoLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.saveStoreAlertsLink

  • links.saveStoreAlertsLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.shareStoreLink

  • links.shareStoreLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.terminateCurrentContractLink

  • links.terminateCurrentContractLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

links.updateStoreLink

  • links.updateStoreLink
    • info BeezUP.Common.InfoSummaries
    • parameters object
    • allOptionalParamsProvided boolean: indicates whether all optionals params have been provided
    • allRequiredParamsProvided boolean: indicates whether all required params have been provided
    • description string: The description of the link
    • docUrl BeezUP.Common.DocUrl
    • href required BeezUP.Common.Href
    • label string: The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
    • method BeezUP.Common.HttpMethod
    • operationId BeezUP.Common.OperationId
    • urlTemplated boolean: indicates whether the href is templated or not

listOfValueItem

  • listOfValueItem object: This object is used by LOV apis
    • codeIdentifier required string
    • intIdentifier required integer
    • position integer
    • translationText string

loginRequest

  • loginRequest object

mapBeezUPColumnRequest

mappingStatus

  • mappingStatus string (values: required, optional, notConfigurable)

marginType

  • marginType string (values: Tracker, Global)

marketplaceChannelCatalog

marketplaceChannelCatalogLinks

marketplaceChannelCatalogList

marketplaceChannelCatalogListLinks

marketplaceChannelCatalogLovLinks

marketplaceOrderId

  • marketplaceOrderId string: The order marketplace identifier

marketplaceOrderStatus

  • marketplaceOrderStatus string: The marketplace order state

messageId

  • messageId string: The message identifier. It's a guid.

nextContractInfo

  • nextContractInfo
    • additionalClickPrice number: Additional click price
    • billingPeriodInMonth integer: The billing period in month
    • billingPeriodPercentDiscount number: The percent discount related to the billing period
    • clickIncluded integer: The click included
    • commitmentCalculatedFinishUtcDate string: The calculated end date of commitment
    • commitmentPeriodInMonth integer: The commitment period in month
    • contractId contractId
    • currencyCode BeezUP.Common.CurrencyCode
    • discountDurationInMonth integer: The discount duration in month
    • discountEndUtcDate string: The end of your discount
    • fixedAndVariableClickInfo fixedAndVariableClickModelInfo
    • fixedPrice number: The fixed price of your contract
    • ipUserCreation string: The IP of the user who creates the contract
    • ipUserModification string: The IP of the user who modified the contract
    • isCommitmentRenewalAutomatically boolean: Is commitment is automatically renewed
    • isModifiableContract boolean: Is the contract is modifiable ?
    • offerId offerId
    • offerName string: The offer name based on /offers
    • percentDiscount number: The percent of the discount
    • startUtcDate string: The start date of your contract
    • storeCount storeCount
    • trialPeriodInMonth integer: The trial period in month
    • variableModelInfo variableModelInfo
    • links required nextContractInfoLinks

nextContractInfoLinks

oMReadyMarketplaceBusinessCodeResponse

offer

offerContent

offerFunctionality

  • offerFunctionality object
    • functionalityCode required string: The functionality code
    • maxValueInteger integer: The max value in integer for this feature in this offer
    • text string: A description text of this feature
    • unlimited required boolean: Is this feature is unlimited for this offer?

offerId

  • offerId integer: The offer id based on /offers. Not a free offer of course.

offerLinks

offerRequest

operationId

  • operationId string: The operationId to call.

optimisationActionName

  • optimisationActionName string (values: reenable, disable): The optimisation action

optimiseAllRequest

optimiseRequest

order

  • order
    • accountId required accountId
    • beezUPOrderId required beezUPOrderId
    • beezUPOrderUrl BeezUP.Common.HttpUrl
    • etag required etag
    • links required orderHeaderLinks
    • marketplaceBusinessCode required BeezUP.Common.MarketplaceBusinessCode
    • marketplaceTechnicalCode required BeezUP.Common.MarketplaceTechnicalCode
    • order_Buyer_Name order_Buyer_Name
    • order_CurrencyCode BeezUP.Common.CurrencyCode
    • order_Invoice_Number string: The order invoice number
    • order_Invoice_Uri string: The order invoice URI
    • order_LastModificationUtcDate required string: The last modification UTC date done by BeezUP of this order
    • order_MarketplaceLastModificationUtcDate required string: The last modification UTC date done by the marketplace on this order
    • order_MarketplaceOrderId required marketplaceOrderId
    • order_MerchantECommerceSoftwareName order_MerchantECommerceSoftwareName
    • order_MerchantECommerceSoftwareVersion order_MerchantECommerceSoftwareVersion
    • order_MerchantOrderId order_MerchantOrderId
    • order_PurchaseUtcDate required string: The purchase date of this order
    • order_Status_BeezUPOrderStatus required beezUPOrderStatus
    • order_Status_MarketplaceOrderStatus marketplaceOrderStatus
    • order_TotalPrice number: The total price of this order (corresponding to the amount paid by the customer)
    • processing required processing
    • links required orderLinks
    • orderItems required array
    • order_Buyer_AddressCity string: The Buyer address city of this order
    • order_Buyer_AddressCountryIsoCodeAlpha2 string: The Buyer address country iso code alpha 2 (see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#/decoding_table for more details)
    • order_Buyer_AddressCountryName string: The Buyer address country name
    • order_Buyer_AddressLine1 string: The Buyer address line 1 of this order
    • order_Buyer_AddressLine2 string: The Buyer address line 2 of this order
    • order_Buyer_AddressLine3 string: The Buyer address line 3 of this order
    • order_Buyer_AddressPostalCode string: The Buyer address postal code of this order
    • order_Buyer_AddressStateOrRegion string: The Buyer address state or region of this order
    • order_Buyer_Civility string: The buyer civility for this order
    • order_Buyer_CompanyName string: The buyer company name for this order
    • order_Buyer_Email string: The email of the buyer for this order
    • order_Buyer_FirstName string: Order Buyer first name
    • order_Buyer_Identifier string: The buyer identifier for this order
    • order_Buyer_LastName string: Order Buyer last name
    • order_Buyer_MobilePhone string: The mobile phone number of the buyer for this order
    • order_Buyer_Phone string: The phone number of the buyer for this order
    • order_Comment string: The comment associated to this order
    • order_FulfilledBy string: The order FulfilledBy
    • order_IsBusiness boolean: The order IsBusiness
    • order_IsPrime boolean: Indicates if the order is considered as Prime (only on Amazon)
    • order_MarketPlaceChannel string: Useful to identify the origin of the order. For example in Amazon.
    • order_OrderItemsSourceUri string: Technical information: The url to the source of this order items. We received this information from the marketplace.
    • order_OrderSourceUri string: Technical information: The url to the source of this order. We received this information from the marketplace.
    • order_PayingUtcDate string: The UTC date of the payment of this order
    • order_PaymentMethod string: The payment method of this order
    • order_Shipping_AddressCity string: The shipping address city of this order
    • order_Shipping_AddressCountryIsoCodeAlpha2 string: The shipping address country iso code alpha 2 (see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#/decoding_table for more details)
    • order_Shipping_AddressCountryName string: The shipping address country name
    • order_Shipping_AddressLine1 string: The shipping address line 1 of this order
    • order_Shipping_AddressLine2 string: The shipping address line 2 of this order
    • order_Shipping_AddressLine3 string: The shipping address line 3 of this order
    • order_Shipping_AddressName string: The name of the person in the shipping address for this order
    • order_Shipping_AddressPostalCode string: The shipping address postal code of this order
    • order_Shipping_AddressStateOrRegion string: The shipping address state or region of this order
    • order_Shipping_Civility string: The civility of the person in the shipping address for this order
    • order_Shipping_CompanyName string: The company name of the shipping address for this order
    • order_Shipping_EarliestShipUtcDate string: The UTC date of the earliest ship for this order
    • order_Shipping_Email string: The email of the person in the shipping address for this order
    • order_Shipping_FirstName string: Order Shipping first name
    • order_Shipping_LastName string: Order Shipping last name
    • order_Shipping_LatestShipUtcDate string: The UTC date of the latest ship for this order
    • order_Shipping_Method string: The shipping method of this order
    • order_Shipping_MobilePhone string: The mobile phone number of the person in the shipping address for this order
    • order_Shipping_Phone string: The phone number of the person in the shipping address for this order
    • order_Shipping_Price number: The shipping price of this order
    • order_Shipping_ShippingTax number: The shipping tax for this order
    • order_TotalCommission number: The total commission of this order
    • order_TotalTax number: The total tax of this order
    • transitionLinks required orderTransitionLinks

orderByDirection

  • orderByDirection string (values: Ascending, Descending): Indicate which direction to order results by

orderChangeType

  • orderChangeType string: The business operation type that can be done on an orde

orderExportationReporting

  • orderExportationReporting object: Represent the reporting of the Order report exportations
    • abortionUtcDate string
    • beginUtcDate string
    • blobNameUri string
    • endUtcDate string
    • enqueuedUtcDate required string
    • errorMessage string
    • executionUUID required string
    • expirationUtcDate string
    • failureUtcDate string
    • ipAddress required string
    • jsonCriteria string: Raw representation of the JSON
    • lastUpdateUtcDate string
    • orderCount integer
    • processingStatus required orderExportationReportingProcessingStatus
    • remainingOrderCount integer
    • resumedUtcDate string
    • sourceType required sourceType
    • sourceUserId BeezUP.Common.UserId
    • sourceUserName required string
    • suspendedUtcDate string
    • timeoutDuration string
    • warningMessage string

orderExportationReportingProcessingStatus

  • orderExportationReportingProcessingStatus string (values: None, InProgress, Done, Failed, AlreadyInProgress, Aborted, Suspended)

orderExportations

orderExportationsLinks

orderExportationsWithLinks

orderHeader

orderHeaderLinks

orderHeaderWithLinks

orderHistory

  • orderHistory object: Describe the history related to an order

orderIdentifier

orderIdentifierWithETag

orderIndex

orderIndexLinks

orderIndexLovLinks

orderInvoiceDesignSettings

orderInvoiceGeneralSettings

orderInvoiceUri

  • orderInvoiceUri string: order invoice url

orderItem

  • orderItem object: Describe an order item. All properties with the prefix orderItem_ are translated in the list of values /user/lov/OrderMetaInfoOrderItems
    • beezUPOrderItemId required string: The BeezUP identifier of the order Item
    • orderItem_BeezUPStoreId string: The store id in the beezup system related to the order item. This property will help you to match the order to the inventory system.
    • orderItem_Condition string: The merchant product condition of the order item
    • orderItem_ImageUrl string: The URL of the image of the order item
    • orderItem_ItemPrice number: The price of the order item
    • orderItem_ItemTax number: The tax of the order item
    • orderItem_MarketPlaceProductId string: The marketplace product identifier of the order item
    • orderItem_MarketplaceImageUri string: The marketplace image uri
    • orderItem_MarketplaceProductUri string: The merchant product uri of the order item
    • orderItem_MerchantImportedProductId string: The product id indicated in the catalog importation in BeezUP system for this order item. This property will help you to match the order to the inventory system.
    • orderItem_MerchantImportedProductIdColumnName string: The column name for the product id indicated in the catalog importation in BeezUP system related to this order item. This property will help you to match the order to the inventory system.
    • orderItem_MerchantImportedProductUrl string: The product url indicated in the catalog importation in BeezUP system related to this order item
    • orderItem_MerchantProductId string: The merchant product id of the order item
    • orderItem_MerchantProductIdColumnName string: The column name indicate in the mapping for the product id related to the order item
    • orderItem_OrderItemType required string: The order item type of the order item
    • orderItem_Quantity number: The quantity of the order item
    • orderItem_Shipping_Price number: The shipping price of the order item
    • orderItem_Title string: The title of the order item
    • orderItem_TotalPrice number: The total price of the order item
    • orderItem_gtin string: The order item gtin

orderLinks

orderListDateSearchType

  • orderListDateSearchType string (values:

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/beezup

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

1

Version

6.0.0

License

MIT

Unpacked Size

1.4 MB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware