Module beezup.merchant
ballerinax/beezup.merchant Ballerina library
1.6.0
Overview
This is a generated connector for BeezUP Merchant API v2.0 OpenAPI specification.
BeezUP Merchant API provides capability to read and write BeezUP data such as accounts, stores, product catalog, channel search etc.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a BeezUP account
- Obtain tokens
- Follow this link to obtain token
Clients
beezup.merchant: Client
Isolated
This is a generated connector for BeezUP Merchant API v2.0 OpenAPI specification. BeezUP Merchant API provides capability to read and write BeezUP data such as accounts, stores, product catalog, channel search etc.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a BeezUP account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.beezup.com/" - URL of the target service
login
Isolated FunctionRemote Function
function login(LoginRequest payload) returns ApiCredentials|errorLogin
Parameters
- payload LoginRequest -
Return Type
- ApiCredentials|error - Your tokens
register
Isolated FunctionRemote Function
function register(RegisterRequest payload) returns Response|errorUser Registration
Parameters
- payload RegisterRequest -
lostPassword
Isolated FunctionRemote Function
function lostPassword(BeezupCommonEmail payload) returns Response|errorLost password
Parameters
- payload BeezupCommonEmail - Your email
getChannelsIndex
Isolated FunctionRemote Function
function getChannelsIndex(string? ifNoneMatch) returns PublicChannelIndex|errorGet public channel index
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- PublicChannelIndex|error - Channel list regrouped by country and links to list of values
getChannels
Isolated FunctionRemote Function
function getChannels(string countryIsoCode, string[] acceptEncoding, string? ifNoneMatch) returns PublicChannelInfoList|errorThe channel list for one country
Parameters
- countryIsoCode string - The country iso code alpha 3 based on this: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Decoding_table \ To know which country are available you have to use the operation: GetChannelsByCountry
- acceptEncoding string[] - Allows the client to indicate whether it accepts a compressed encoding to reduce traffic size.
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- PublicChannelInfoList|error - The channel list for one country
getPublicLovIndex
Isolated FunctionRemote Function
function getPublicLovIndex(string? ifNoneMatch) returns PublicLovIndex|errorGet all list names
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- PublicLovIndex|error - Get the list names
getUserLovIndex
Isolated FunctionRemote Function
function getUserLovIndex() returns UserLovIndex|errorGet all list names
Return Type
- UserLovIndex|error - Get the list names
getCustomerIndex
Isolated FunctionRemote Function
function getCustomerIndex(string? ifNoneMatch) returns CustomerIndex|errorThe index of all operations and LOV
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- CustomerIndex|error - OK
getUserAccountInfo
Isolated FunctionRemote Function
function getUserAccountInfo(string? ifNoneMatch) returns AccountInfo|errorGet user account information
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- AccountInfo|error - User account information
resendEmailActivation
Isolated FunctionRemote Function
Resend email activation
activateUserAccount
Isolated FunctionRemote Function
Activate the user account
Parameters
- payload string - The email activation id received by email.
savePersonalInfo
Isolated FunctionRemote Function
function savePersonalInfo(PersonalInfo payload) returns Response|errorSave user personal information
Parameters
- payload PersonalInfo -
saveCompanyInfo
Isolated FunctionRemote Function
function saveCompanyInfo(CompanyInfo payload) returns Response|errorChange company information
Parameters
- payload CompanyInfo -
getProfilePictureInfo
Isolated FunctionRemote Function
function getProfilePictureInfo(string? ifNoneMatch) returns ProfilePictureInfoResponse|errorGet profile picture information
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- ProfilePictureInfoResponse|error - Profile picture information
saveProfilePictureInfo
Isolated FunctionRemote Function
function saveProfilePictureInfo(ProfilePictureInfo payload) returns Response|errorChange user picture information
Parameters
- payload ProfilePictureInfo -
getCreditCardInfo
Isolated FunctionRemote Function
function getCreditCardInfo(string? ifNoneMatch) returns CreditCardInfoResponse|errorGet credit card information
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- CreditCardInfoResponse|error - User credit card information
saveCreditCardInfo
Isolated FunctionRemote Function
function saveCreditCardInfo(CreditCardInfo payload) returns Response|errorSave user credit card info
Parameters
- payload CreditCardInfo - Credit card info
Return Type
changeEmail
Isolated FunctionRemote Function
function changeEmail(ChangeEmailRequest payload) returns Response|errorChange user email
Parameters
- payload ChangeEmailRequest -
changePassword
Isolated FunctionRemote Function
function changePassword(ChangePasswordRequest payload) returns Response|errorChange user password
Parameters
- payload ChangePasswordRequest -
logout
Isolated FunctionRemote Function
Log out the current user from go2
zendeskToken
Isolated FunctionRemote Function
function zendeskToken() returns ZendeskToken|errorZendesk token
Return Type
- ZendeskToken|error - A JWT token to connect the Zendesk Web Widget
getStores
Isolated FunctionRemote Function
Get store list
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
createStore
Isolated FunctionRemote Function
function createStore(CreateStoreRequest payload) returns LinksGetstorelink|errorCreate a new store
Parameters
- payload CreateStoreRequest -
Return Type
- LinksGetstorelink|error - The store has been created successfully. The http header Location contains the new resource url. The body contains the link to the new resource.
getStore
Isolated FunctionRemote Function
Get store's information
Parameters
- storeId string - Your store identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
deleteStore
Isolated FunctionRemote Function
Delete a store
Parameters
- storeId string - Your store identifier
updateStore
Isolated FunctionRemote Function
function updateStore(string storeId, UpdateStoreRequest payload) returns Response|errorUpdate some store's information.
getRights
Isolated FunctionRemote Function
function getRights(string storeId) returns FunctionalityRightInfo[]|errorGet store's rights
Parameters
- storeId string - Your store identifier
Return Type
- FunctionalityRightInfo[]|error - The store's rights
getStoreAlerts
Isolated FunctionRemote Function
function getStoreAlerts(string storeId, string? ifNoneMatch) returns StoreAlerts|errorGet store's alerts
Parameters
- storeId string - Your store identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- StoreAlerts|error - User account alerts information
saveStoreAlerts
Isolated FunctionRemote Function
function saveStoreAlerts(string storeId, SaveStoreAlertsRequest payload) returns Response|errorSave store alerts
getStoreShares
Isolated FunctionRemote Function
function getStoreShares(string storeId, string? ifNoneMatch) returns StoreShares|errorGet shares related to this store
Parameters
- storeId string - Your store identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- StoreShares|error - The sharing list of the store
shareStore
Isolated FunctionRemote Function
function shareStore(string storeId, FriendEmail payload) returns Response|errorShare a store to another user
deleteStoreShare
Isolated FunctionRemote Function
Delete a share of a store to another user
getFriendInfo
Isolated FunctionRemote Function
function getFriendInfo(string userId, string? ifNoneMatch) returns UserFriendInfo|errorGet friend information
Parameters
- userId string - Your friend user id
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- UserFriendInfo|error - Get friend info
getBillingPeriods
Isolated FunctionRemote Function
function getBillingPeriods(string? ifNoneMatch) returns BillingPeriodList|errorGet billing periods conditions
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- BillingPeriodList|error - Get the billing periods conditions
getStandardOffers
Isolated FunctionRemote Function
function getStandardOffers(string? ifNoneMatch) returns StandardOffers|errorGet all standard offers
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- StandardOffers|error - Get all standard offers
getOffer
Isolated FunctionRemote Function
function getOffer(OfferRequest payload) returns Offer|errorGet offer pricing
Parameters
- payload OfferRequest -
getContracts
Isolated FunctionRemote Function
Get contract list
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
createContract
Isolated FunctionRemote Function
function createContract(CreateContract payload) returns CreateContractResponse|errorCreate a new contract
Parameters
- payload CreateContract -
Return Type
- CreateContractResponse|error - New contract has been created. Some warnings can be present in response.
terminateCurrentContract
Isolated FunctionRemote Function
function terminateCurrentContract(TerminateContract payload) returns Response|errorSchedule termination of your current contract at the end of the commitment.
Parameters
- payload TerminateContract - Indicate the termination reason
reactivateCurrentContract
Isolated FunctionRemote Function
Reactivate your terminated contract.
deleteNextContract
Isolated FunctionRemote Function
Delete your next contract
getInvoices
Isolated FunctionRemote Function
function getInvoices(string? ifNoneMatch) returns InvoiceList|errorGet all your invoices
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- InvoiceList|error - Get all invoices of a customer
catalogIndex
Isolated FunctionRemote Function
function catalogIndex() returns CatalogIndex|errorGet the index of the catalog API
Return Type
- CatalogIndex|error - OK
catalogGetbeezupcolumns
Isolated FunctionRemote Function
function catalogGetbeezupcolumns() returns BeezUPColumnConfiguration[]|errorGet the BeezUP columns
Return Type
- BeezUPColumnConfiguration[]|error - The catalog API index
catalogStoreIndex
Isolated FunctionRemote Function
function catalogStoreIndex(string storeId) returns CatalogStoreIndex|errorGet the index of the catalog API for this store
Parameters
- storeId string - Your store identifier
Return Type
- CatalogStoreIndex|error - The catalog index
importationGetmanualupdatelastinputconfig
Isolated FunctionRemote Function
function importationGetmanualupdatelastinputconfig(string storeId) returns LastManualImportInputConfiguration|errorGet the last input configuration
Parameters
- storeId string - Your store identifier
Return Type
catalogGetcatalogcolumns
Isolated FunctionRemote Function
function catalogGetcatalogcolumns(string storeId) returns CatalogColumnList|errorGet catalog column list
Parameters
- storeId string - Your store identifier
Return Type
- CatalogColumnList|error - Catalog column list
catalogChangecatalogcolumnusername
Isolated FunctionRemote Function
function catalogChangecatalogcolumnusername(string storeId, string columnId, ChangeUserColumnNameRequest payload) returns Response|errorChange Catalog Column User Name
Parameters
- storeId string - Your store identifier
- columnId string - The catalog column identifier
- payload ChangeUserColumnNameRequest -
catalogGetcustomcolumns
Isolated FunctionRemote Function
function catalogGetcustomcolumns(string storeId) returns CustomColumnList|errorGet custom column list
Parameters
- storeId string - Your store identifier
Return Type
- CustomColumnList|error - Custom column list
catalogSavecustomcolumn
Isolated FunctionRemote Function
function catalogSavecustomcolumn(string storeId, string columnId, CreateCustomColumnRequest payload) returns Response|errorCreate or replace a custom column
Parameters
- storeId string - Your store identifier
- columnId string - The custom column identifier
- payload CreateCustomColumnRequest -
catalogDeletecustomcolumn
Isolated FunctionRemote Function
Delete custom column
catalogChangecustomcolumnusername
Isolated FunctionRemote Function
function catalogChangecustomcolumnusername(string storeId, string columnId, ChangeUserColumnNameRequest payload) returns Response|errorChange Custom Column User Name
Parameters
- storeId string - Your store identifier
- columnId string - The custom column identifier
- payload ChangeUserColumnNameRequest -
catalogGetcustomcolumnexpression
Isolated FunctionRemote Function
Get the encrypted custom column expression
catalogChangecustomcolumnexpression
Isolated FunctionRemote Function
function catalogChangecustomcolumnexpression(string storeId, string columnId, ChangeCustomColumnExpressionRequest payload) returns Response|errorChange custom column expression
Parameters
- storeId string - Your store identifier
- columnId string - The custom column identifier
- payload ChangeCustomColumnExpressionRequest -
catalogComputeexpression
Isolated FunctionRemote Function
function catalogComputeexpression(string storeId, ComputeExpressionRequest payload) returns string|errorCompute the expression for this catalog.
catalogGetcategories
Isolated FunctionRemote Function
function catalogGetcategories(string storeId, string[] acceptEncoding) returns CategoryList|errorGet category list
Parameters
- storeId string - Your store identifier
- acceptEncoding string[] - Indicates that the client accepts that the response will be compressed to reduce traffic size.
Return Type
- CategoryList|error - Categories
catalogGetproducts
Isolated FunctionRemote Function
function catalogGetproducts(string storeId, GetProductsRequest payload) returns ProductList|errorGet product list
Return Type
- ProductList|error - Product list
catalogGetrandomproducts
Isolated FunctionRemote Function
function catalogGetrandomproducts(string storeId) returns RandomProductList|errorGet random product list
Parameters
- storeId string - Your store identifier
Return Type
- RandomProductList|error - Random product list
catalogGetproductbyproductid
Isolated FunctionRemote Function
Get product by ProductId
Parameters
- storeId string - Your store identifier
- productId string - The product identifier you want to get
catalogGetproductbysku
Isolated FunctionRemote Function
Get product by Sku
importationGetreportingsallstores
Isolated FunctionRemote Function
function importationGetreportingsallstores() returns ImportationsPerStoreResponse|errorGet the latest catalog importation reporting for all your stores
Return Type
- ImportationsPerStoreResponse|error - The last importation reportings
importationGetreportings
Isolated FunctionRemote Function
function importationGetreportings(string storeId) returns ImportationsResponse|errorGet the latest catalog importation reporting
Parameters
- storeId string - Your store identifier
Return Type
- ImportationsResponse|error - The last importation reportings
importationStartmanualupdate
Isolated FunctionRemote Function
function importationStartmanualupdate(string storeId, StartManualImportRequest payload) returns LinksImportationGetimportationmonitoringlink|errorStart Manual Import
Return Type
- LinksImportationGetimportationmonitoringlink|error - Catalog importation started
importationGetimportationmonitoring
Isolated FunctionRemote Function
function importationGetimportationmonitoring(string storeId, string executionId) returns ImportationMonitoring|errorGet the importation status
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
importationCancel
Isolated FunctionRemote Function
Cancel importation
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
importationTechnicalprogression
Isolated FunctionRemote Function
function importationTechnicalprogression(string storeId, string executionId) returns ImportationTechnicalProgression|errorGet technical progression
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
- ImportationTechnicalProgression|error - When the technical progression is correctly retrived
importationConfigureremainingcatalogcolumns
Isolated FunctionRemote Function
function importationConfigureremainingcatalogcolumns(string storeId, string executionId) returns Response|errorConfigure remaining catalog columns
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
importationCommitcolumns
Isolated FunctionRemote Function
Commit columns
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
importationCommit
Isolated FunctionRemote Function
Commit Importation
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
importationGetproductsample
Isolated FunctionRemote Function
function importationGetproductsample(string storeId, string executionId, int productSampleIndex) returns ProductSample|errorGet the product sample related to this importation with all columns (catalog and custom)
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- productSampleIndex int - Index of the product sample. Starting from 0 to 99.
Return Type
- ProductSample|error - OK
importationGetproductsamplecustomcolumnvalue
Isolated FunctionRemote Function
function importationGetproductsamplecustomcolumnvalue(string storeId, string executionId, int productSampleIndex, string columnId) returns string|errorGet product sample custom column value related to this importation.
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- productSampleIndex int - Index of the product sample. Starting from 0 to 99.
- columnId string - The custom column identifier
importationGetdetectedcatalogcolumns
Isolated FunctionRemote Function
function importationGetdetectedcatalogcolumns(string storeId, string executionId) returns DetectedCatalogColumnList|errorGet detected catalog columns during this importation.
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
importationConfigurecatalogcolumn
Isolated FunctionRemote Function
function importationConfigurecatalogcolumn(string storeId, string executionId, string columnId, ConfigureCatalogColumnCatalogRequest payload) returns Response|errorConfigure catalog column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
- payload ConfigureCatalogColumnCatalogRequest -
Return Type
importationIgnorecolumn
Isolated FunctionRemote Function
function importationIgnorecolumn(string storeId, string executionId, string columnId) returns Response|errorIgnore Column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
Return Type
importationReattendcolumn
Isolated FunctionRemote Function
function importationReattendcolumn(string storeId, string executionId, string columnId) returns Response|errorReattend Column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
Return Type
importationMapcatalogcolumn
Isolated FunctionRemote Function
function importationMapcatalogcolumn(string storeId, string executionId, string columnId, MapBeezUPColumnRequest payload) returns Response|errorMap catalog column to a BeezUP column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The catalog column identifier
- payload MapBeezUPColumnRequest -
Return Type
importationUnmapcatalogcolumn
Isolated FunctionRemote Function
function importationUnmapcatalogcolumn(string storeId, string executionId, string columnId) returns Response|errorUnmap catalog column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The catalog column identifier
Return Type
importationGetcustomcolumns
Isolated FunctionRemote Function
function importationGetcustomcolumns(string storeId, string executionId) returns ImportationCustomColumnList|errorGet custom columns currently place in this importation
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
- ImportationCustomColumnList|error - Custom columns of current Importation successfully retrieved
importationGetcustomcolumnexpression
Isolated FunctionRemote Function
function importationGetcustomcolumnexpression(string storeId, string executionId, string columnId) returns string|errorGet the encrypted custom column expression in this importation
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
importationSavecustomcolumn
Isolated FunctionRemote Function
function importationSavecustomcolumn(string storeId, string executionId, string columnId, ChangeCustomColumnRequest payload) returns Response|errorCreate or replace a custom column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
- payload ChangeCustomColumnRequest -
Return Type
importationDeletecustomcolumn
Isolated FunctionRemote Function
function importationDeletecustomcolumn(string storeId, string executionId, string columnId) returns Response|errorDelete Custom Column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
importationMapcustomcolumn
Isolated FunctionRemote Function
function importationMapcustomcolumn(string storeId, string executionId, string columnId, MapBeezUPColumnRequest payload) returns Response|errorMap custom column to a BeezUP column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
- payload MapBeezUPColumnRequest -
Return Type
importationUnmapcustomcolumn
Isolated FunctionRemote Function
function importationUnmapcustomcolumn(string storeId, string executionId, string columnId) returns Response|errorUnmap custom column
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- columnId string - The custom column identifier
Return Type
importationGetproductsreport
Isolated FunctionRemote Function
function importationGetproductsreport(string storeId, string executionId, GetImportationProductsReportRequest payload) returns GetImportationProductsReportResponse|errorImportation Get Products Report
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
- payload GetImportationProductsReportRequest -
Return Type
- GetImportationProductsReportResponse|error - Get Products Report Response
importationGetreport
Isolated FunctionRemote Function
function importationGetreport(string storeId, string executionId) returns GetImportationReportResponse|errorImportation Get Report
Parameters
- storeId string - Your store identifier
- executionId string - The execution identifier of you catalog importation
Return Type
- GetImportationReportResponse|error - Get Report Response
importationActivateautoimport
Isolated FunctionRemote Function
Activate the auto importation of the last successful manual catalog importation.
Parameters
- storeId string - Your store identifier
autoGetautoimportconfiguration
Isolated FunctionRemote Function
function autoGetautoimportconfiguration(string storeId) returns AutoImportConfiguration|errorGet the auto import configuration
Parameters
- storeId string - Your store identifier
Return Type
- AutoImportConfiguration|error - Auto import configuration
autoDeleteautoimport
Isolated FunctionRemote Function
Delete Auto Import
Parameters
- storeId string - Your store identifier
autoStartautoimport
Isolated FunctionRemote Function
function autoStartautoimport(string storeId) returns LinksImportationGetimportationmonitoringlink|errorStart Auto Import Manually
Parameters
- storeId string - Your store identifier
Return Type
- LinksImportationGetimportationmonitoringlink|error - Catalog importation started
autoPauseautoimport
Isolated FunctionRemote Function
Pause Auto Import
Parameters
- storeId string - Your store identifier
autoResumeautoimport
Isolated FunctionRemote Function
Resume Auto Import
Parameters
- storeId string - Your store identifier
autoConfigureautoimportinterval
Isolated FunctionRemote Function
function autoConfigureautoimportinterval(string storeId, ConfigureAutoImportIntervalRequest payload) returns Response|errorConfigure Auto Import Interval
autoScheduleautoimport
Isolated FunctionRemote Function
function autoScheduleautoimport(string storeId, ScheduleAutoImportRequest payload) returns Response|errorConfigure Auto Import Schedules
getAvailableChannels
Isolated FunctionRemote Function
function getAvailableChannels(string storeId) returns ChannelHeader[]|errorList all available channel for this store
Parameters
- storeId string - The store identifier
Return Type
- ChannelHeader[]|error - Available channel list for this store
getChannelInfo
Isolated FunctionRemote Function
function getChannelInfo(string channelId) returns ChannelInfo|errorGet channel information
Parameters
- channelId string - The channel identifier
Return Type
- ChannelInfo|error - Channel information
getChannelCategories
Isolated FunctionRemote Function
function getChannelCategories(string channelId, string[] acceptEncoding) returns ChannelRootCategory|errorGet channel categories
Parameters
- channelId string - The channel identifier
- acceptEncoding string[] - Indicates that the client accepts that the response will be compressed to reduce traffic size.
Return Type
- ChannelRootCategory|error - Channel categories
getChannelColumns
Isolated FunctionRemote Function
function getChannelColumns(string channelId, string[] acceptEncoding, BeezupCommonChannelcolumnid[] payload) returns ChannelColumn[]|errorGet channel columns
Parameters
- channelId string - The channel identifier
- acceptEncoding string[] - Indicates that the client accepts that the response will be compressed to reduce traffic size.
- payload BeezupCommonChannelcolumnid[] - Allow you to filter the channel column identifier list your want to get
Return Type
- ChannelColumn[]|error - Channel columns
getChannelCatalogs
Isolated FunctionRemote Function
function getChannelCatalogs(string? storeId) returns ChannelCatalogList|errorList all your current channel catalogs
Parameters
- storeId string? (default ()) - The store identifier
Return Type
- ChannelCatalogList|error - OK
addChannelCatalog
Isolated FunctionRemote Function
function addChannelCatalog(AddChannelCatalogRequest payload) returns LinksGetchannelcataloglink|errorAdd a new channel catalog
Parameters
- payload AddChannelCatalogRequest -
Return Type
- LinksGetchannelcataloglink|error - When the channel has been successfully added for this store
getChannelCatalog
Isolated FunctionRemote Function
function getChannelCatalog(string channelCatalogId) returns ChannelCatalog|errorGet the channel catalog information
Parameters
- channelCatalogId string - The channel catalog identifier
Return Type
- ChannelCatalog|error - Channel catalog
deleteChannelCatalog
Isolated FunctionRemote Function
Delete the channel catalog
Parameters
- channelCatalogId string - The channel catalog identifier
getChannelCatalogFilterOperators
Isolated FunctionRemote Function
function getChannelCatalogFilterOperators() returns FilterOperator[]|errorGet channel catalog filter operators
Return Type
- FilterOperator[]|error - Channel catalog filter operator list
enableChannelCatalog
Isolated FunctionRemote Function
Enable a channel catalog
Parameters
- channelCatalogId string - The channel catalog identifier
disableChannelCatalog
Isolated FunctionRemote Function
Disable a channel catalog
Parameters
- channelCatalogId string - The channel catalog identifier
configureChannelCatalogGeneralSettings
Isolated FunctionRemote Function
function configureChannelCatalogGeneralSettings(string channelCatalogId, GeneralSettings payload) returns Response|errorConfigure channel catalog general settings
configureChannelCatalogCostSettings
Isolated FunctionRemote Function
function configureChannelCatalogCostSettings(string channelCatalogId, CostSettings payload) returns Response|errorConfigure channel catalog cost settings
configureChannelCatalogColumnMappings
Isolated FunctionRemote Function
function configureChannelCatalogColumnMappings(string channelCatalogId, ChannelCatalogColumnMappingList payload) returns Response|errorConfigure channel catalog column mappings
Parameters
- channelCatalogId string - The channel catalog identifier
- payload ChannelCatalogColumnMappingList -
getChannelCatalogCategories
Isolated FunctionRemote Function
function getChannelCatalogCategories(string channelCatalogId) returns ChannelCatalogCategoryConfigurationList|errorGet channel catalog categories
Parameters
- channelCatalogId string - The channel catalog identifier
Return Type
- ChannelCatalogCategoryConfigurationList|error - Channel catalog category mappings
disableChannelCatalogCategoryMapping
Isolated FunctionRemote Function
Disable a channel catalog category mapping
Parameters
- channelCatalogId string - The channel catalog identifier
reenableChannelCatalogCategoryMapping
Isolated FunctionRemote Function
Reenable a channel catalog category mapping
Parameters
- channelCatalogId string - The channel catalog identifier
configureChannelCatalogCategory
Isolated FunctionRemote Function
function configureChannelCatalogCategory(string channelCatalogId, ConfigureCategoryRequest payload) returns Response|errorConfigure channel catalog category
Parameters
- channelCatalogId string - The channel catalog identifier
- payload ConfigureCategoryRequest -
getChannelCatalogExclusionFilters
Isolated FunctionRemote Function
function getChannelCatalogExclusionFilters(string channelCatalogId) returns ExclusionFiltersResponse|errorGet channel catalog exclusion filters
Parameters
- channelCatalogId string - The channel catalog identifier
Return Type
- ExclusionFiltersResponse|error - Channel catalog exclusion filter list
configureChannelCatalogExclusionFilters
Isolated FunctionRemote Function
function configureChannelCatalogExclusionFilters(string channelCatalogId, ExclusionFilters payload) returns Response|errorConfigure channel catalog exclusion filters
getChannelCatalogProductInfoList
Isolated FunctionRemote Function
function getChannelCatalogProductInfoList(string channelCatalogId, GetChannelCatalogProductInfoListRequest payload) returns ChannelCatalogProductInfoList|errorGet channel catalog product information list
Parameters
- channelCatalogId string - The channel catalog identifier
- payload GetChannelCatalogProductInfoListRequest - The channel catalog product list filter
Return Type
- ChannelCatalogProductInfoList|error - Channel catalog product information
exportChannelCatalogProductInfoList
Isolated FunctionRemote Function
function exportChannelCatalogProductInfoList(string channelCatalogId, string format, GetChannelCatalogProductInfoListRequest payload) returns BeezupCommonLink3|errorExport channel catalog product information list
Parameters
- channelCatalogId string - The channel catalog identifier
- format string - The file type of the exportation
- payload GetChannelCatalogProductInfoListRequest - The channel catalog product list filter
Return Type
- BeezupCommonLink3|error - Channel catalog product information list exported
getChannelCatalogProductsCounters
Isolated FunctionRemote Function
function getChannelCatalogProductsCounters(string channelCatalogId) returns ChannelCatalogProductsCounters|errorGet channel catalog products' counters
Parameters
- channelCatalogId string - The channel catalog identifier
Return Type
- ChannelCatalogProductsCounters|error - Channel catalog products' counters
getChannelCatalogProductByChannelCatalog
Isolated FunctionRemote Function
function getChannelCatalogProductByChannelCatalog(ChannelCatalogProductByChannelCatalogRequest payload) returns ChannelCatalogProductByChannelCatalogResponse|errorGet channel catalog products related to these channel catalogs
Parameters
Return Type
- ChannelCatalogProductByChannelCatalogResponse|error - The channel catalog product by channel catalog
getChannelCatalogProductInfo
Isolated FunctionRemote Function
function getChannelCatalogProductInfo(string channelCatalogId, string productId) returns ChannelCatalogProductInfo|errorGet channel catalog product information
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
Return Type
- ChannelCatalogProductInfo|error - Channel catalog product information
overrideChannelCatalogProductValues
Isolated FunctionRemote Function
function overrideChannelCatalogProductValues(string channelCatalogId, string productId, ProductOverrides payload) returns Response|errorOverride channel catalog product values
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
- payload ProductOverrides -
deleteChannelCatalogProductValueOverride
Isolated FunctionRemote Function
function deleteChannelCatalogProductValueOverride(string channelCatalogId, string productId, string channelColumnId) returns Response|errorDelete a specific channel catalog product value override
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
- channelColumnId string - The channel column identifier
getChannelCatalogProductValueOverrideCopy
Isolated FunctionRemote Function
function getChannelCatalogProductValueOverrideCopy(string channelCatalogId, string productId) returns Response|errorGet channel catalog product value override compatibilities status
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
configureChannelCatalogProductValueOverrideCopy
Isolated FunctionRemote Function
function configureChannelCatalogProductValueOverrideCopy(string channelCatalogId, string productId) returns Response|errorCopy channel catalog product value override
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
disableChannelCatalogProduct
Isolated FunctionRemote Function
function disableChannelCatalogProduct(string channelCatalogId, string productId) returns Response|errorDisable channel catalog product
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
reenableChannelCatalogProduct
Isolated FunctionRemote Function
function reenableChannelCatalogProduct(string channelCatalogId, string productId) returns Response|errorReenable channel catalog product
Parameters
- channelCatalogId string - The channel catalog identifier
- productId string - The product identifier
getChannelCatalogExportationCacheInfo
Isolated FunctionRemote Function
function getChannelCatalogExportationCacheInfo(string channelCatalogId) returns ChannelCatalogExportCacheInfoResponse|errorGet the exportation cache information
Parameters
- channelCatalogId string - The channel catalog identifier
Return Type
- ChannelCatalogExportCacheInfoResponse|error - Channel catalog exportation cache information
clearChannelCatalogExportationCache
Isolated FunctionRemote Function
Clear the exportation cache
Parameters
- channelCatalogId string - The channel catalog identifier
getChannelCatalogExportationHistory
Isolated FunctionRemote Function
function getChannelCatalogExportationHistory(string channelCatalogId, int pageNumber, int pageSize) returns ChannelCatalogExportationHistory|errorGet the exportation history
Parameters
- channelCatalogId string - The channel catalog identifier
- pageNumber int - The page number you want to get
- pageSize int - The entry count you want to get
Return Type
- ChannelCatalogExportationHistory|error - Channel catalog exportation history
getMarketplaceChannelCatalogs
Isolated FunctionRemote Function
function getMarketplaceChannelCatalogs(string? storeId) returns MarketplaceChannelCatalogList|errorGet your marketplace channel catalog list
Parameters
- storeId string? (default ()) - The StoreId to filter by
Return Type
- MarketplaceChannelCatalogList|error - Marketplace channel catalog list
publishCatalogToMarketplace
Isolated FunctionRemote Function
function publishCatalogToMarketplace(string marketplaceTechnicalCode, int accountId, PublishCatalogToMarketplaceRequest payload) returns Response|error[PREVIEW] Launch a publication of the catalog to the marketplace
Parameters
- marketplaceTechnicalCode string - Marketplace Technical Code to query (required)
- accountId int - Account Id to query (required)
- payload PublishCatalogToMarketplaceRequest -
getPublications
Isolated FunctionRemote Function
function getPublications(string marketplaceTechnicalCode, int accountId, string[] publicationTypes, string? channelCatalogId, int count) returns AccountPublications|errorFetch the publication history for an account, sorted by descending start date
Parameters
- marketplaceTechnicalCode string - Marketplace Technical Code to query (required)
- accountId int - Account Id to query (required)
- publicationTypes string[] - Publication types by which to filter (optional)
- channelCatalogId string? (default ()) - Channel Catalog Id by which to filter (optional)
- count int (default 10) - Amount of entries to fetch (optional, default set to 10)
Return Type
- AccountPublications|error - Successfully fetched channel catalog settings
getChannelCatalogMarketplaceSettings
Isolated FunctionRemote Function
function getChannelCatalogMarketplaceSettings(string channelCatalogId) returns ChannelCatalogMarketplaceSettings|errorGet the marketplace settings for a channel catalog
Parameters
- channelCatalogId string - Channel Catalog Id to query (required)
Return Type
- ChannelCatalogMarketplaceSettings|error - Successfully fetched channel catalog settings
setChannelCatalogMarketplaceSettings
Isolated FunctionRemote Function
function setChannelCatalogMarketplaceSettings(string channelCatalogId, SetChannelCatalogMarketplaceSettingsRequest payload) returns Response|errorSave new marketplace settings for a channel catalog
Parameters
- channelCatalogId string - Channel Catalog Id to query
- payload SetChannelCatalogMarketplaceSettingsRequest - Settings to save
getOrderIndex
DeprecatedIsolated FunctionRemote Function
function getOrderIndex(string? ifNoneMatch) returns OrderIndex|error[DEPRECATED] Get all actions you can do on the order API
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- OrderIndex|error - Order index
Deprecated
getMarketplaceAccountsSynchronization
DeprecatedIsolated FunctionRemote Function
function getMarketplaceAccountsSynchronization(string? storeId, string? ifNoneMatch) returns AccountSynchronizationList|error[DEPRECATED] Get current synchronization status between your marketplaces and BeezUP accounts
Parameters
- storeId string? (default ()) - The StoreId to filter by
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- AccountSynchronizationList|error - Successfully fetched current synchronization status
Deprecated
harvestAll
DeprecatedIsolated FunctionRemote Function
[DEPRECATED] Send harvest request to all your marketplaces
Parameters
- storeId string? (default ()) - The StoreId to filter by
getAutomaticTransitions
Isolated FunctionRemote Function
function getAutomaticTransitions(string? storeId, string? ifNoneMatch) returns AutomaticTransitionInfoList|errorGet list of configured automatic Order status transitions
Parameters
- storeId string? (default ()) - The StoreId to filter by
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- AutomaticTransitionInfoList|error - Successfully fetched list of configured automatic Order status transitions
configureAutomaticTransitions
Isolated FunctionRemote Function
function configureAutomaticTransitions(ConfigureAutomaticTransitionRequest payload) returns Response|errorConfigure new or existing automatic Order status transition
Parameters
- payload ConfigureAutomaticTransitionRequest -
Return Type
getOrderListFull
DeprecatedIsolated FunctionRemote Function
function getOrderListFull(string[] acceptEncoding, OrderListRequest payload) returns OrderListFull|error[DEPRECATED] Get a paginated list of all Orders with all Order and Order Item(s) properties
Parameters
- acceptEncoding string[] - Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size
- payload OrderListRequest -
Return Type
- OrderListFull|error - Successfully fetched the full list of Orders
Deprecated
getOrderListLight
DeprecatedIsolated FunctionRemote Function
function getOrderListLight(OrderListRequest payload) returns OrderListLight|error[DEPRECATED] Get a paginated list of all Orders without details
Parameters
- payload OrderListRequest -
Return Type
- OrderListLight|error - Successfully fetched the list of Orders
Deprecated
getOrderExportations
Isolated FunctionRemote Function
function getOrderExportations(int pageNumber, int pageSize, string storeId, string? ifNoneMatch) returns OrderExportations|errorGet a paginated list of Order report exportations
Parameters
- pageNumber int - The page number you want to get
- pageSize int - The entry count you want to get
- storeId string - The store identifier to regroup the order exportations
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- OrderExportations|error - Successfully fetched the list of Order report exportations
exportOrders
Isolated FunctionRemote Function
function exportOrders(ExportOrderListRequest payload) returns Response|errorRequest a new Order report exportation to be generated
Parameters
- payload ExportOrderListRequest -
setMerchantOrderInfoList
DeprecatedIsolated FunctionRemote Function
function setMerchantOrderInfoList(SetMerchantOrderInfoListRequest payload) returns BatchOrderOperationResponse|error[DEPRECATED] Send a batch of operations to set an Order's merchant information (max 100 items per call)
Parameters
- payload SetMerchantOrderInfoListRequest -
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
Deprecated
clearMerchantOrderInfoList
DeprecatedIsolated FunctionRemote Function
function clearMerchantOrderInfoList(ClearMerchantOrderInfoListRequest payload) returns BatchOrderOperationResponse|error[DEPRECATED] Send a batch of operations to clear an Order's merchant information (max 100 items per call)
Parameters
- payload ClearMerchantOrderInfoListRequest -
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
Deprecated
changeOrderList
DeprecatedIsolated FunctionRemote Function
function changeOrderList(string changeOrderType, string userName, ChangeOrderListRequest payload, boolean testMode) returns BatchOrderOperationResponse|error[DEPRECATED] Send a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)
Parameters
- changeOrderType string - The Order change type
- userName 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.
- payload ChangeOrderListRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
Deprecated
getOrder
DeprecatedIsolated FunctionRemote Function
function getOrder(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string? ifNoneMatch) returns Order|error[DEPRECATED] DEPRECATED - Get full Order and Order Item(s) properties
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
headOrder
DeprecatedIsolated FunctionRemote Function
function headOrder(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string? ifNoneMatch) returns Response|error[DEPRECATED] DEPRECATED - Get the meta information about the order (ETag, Last-Modified)
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
getOrderHistory
DeprecatedIsolated FunctionRemote Function
function getOrderHistory(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string? ifNoneMatch) returns OrderHistory|error[DEPRECATED] Get an Order's harvest and change history
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- OrderHistory|error - Successfully fetched Order history
Deprecated
harvestOrder
DeprecatedIsolated FunctionRemote Function
function harvestOrder(string marketplaceTechnicalCode, int accountId, string beezUPOrderId) returns Response|error[DEPRECATED] Send harvest request for a single Order
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
setMerchantOrderInfo
DeprecatedIsolated FunctionRemote Function
function setMerchantOrderInfo(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, SetMerchantOrderInfoRequest payload) returns Response|error[DEPRECATED] Set an Order's merchant information
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- payload SetMerchantOrderInfoRequest -
clearMerchantOrderInfo
DeprecatedIsolated FunctionRemote Function
function clearMerchantOrderInfo(string marketplaceTechnicalCode, int accountId, string beezUPOrderId) returns Response|error[DEPRECATED] Clear an Order's merchant information
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
changeOrder
DeprecatedIsolated FunctionRemote Function
function changeOrder(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string changeOrderType, string userName, string ifMatch, ChangeOrderRequest payload, boolean testMode) returns Response|error[DEPRECATED] Change your marketplace Order Information (accept, ship, etc.)
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- changeOrderType string - The Order change type
- userName 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.
- ifMatch string - ETag value to identify the last known version of requested resource.\ To ensure that you are making a change on the lastest version of the resource.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
- payload ChangeOrderRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
getMarketplaceAccountsSynchronizationV3
Isolated FunctionRemote Function
function getMarketplaceAccountsSynchronizationV3(string? ifNoneMatch, string[]? storeIds) returns AccountSynchronizationList|errorGet current synchronization status between your marketplaces and BeezUP accounts
Parameters
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
- storeIds string[]? (default ()) - StoredIds to filter
Return Type
- AccountSynchronizationList|error - Successfully fetched the list of MarketplaceBusinessCode ready for Order Management
harvestAllV3
Isolated FunctionRemote Function
Send harvest request to all your marketplaces
Parameters
- storeId string? (default ()) - The StoreId to filter by
getOrderListFullV3
Isolated FunctionRemote Function
function getOrderListFullV3(string acceptEncoding, OrderListRequest payload) returns OrderListFullWithLinks|errorGet a paginated list of all Orders with all Order and Order Item(s) properties
Parameters
- acceptEncoding string - Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size
- payload OrderListRequest -
Return Type
- OrderListFullWithLinks|error - Successfully fetched the full list of Orders
getOrderListLightV3
Isolated FunctionRemote Function
function getOrderListLightV3(OrderListRequest payload) returns OrderListLightWithLinks|errorGet a paginated list of all Orders without details
Parameters
- payload OrderListRequest -
Return Type
- OrderListLightWithLinks|error - Successfully fetched the list of Orders
getOrderV3
Isolated FunctionRemote Function
function getOrderV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string? ifNoneMatch) returns OrderWithLinks|errorGet full Order and Order Item(s) properties
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
Return Type
- OrderWithLinks|error - Successfully fetched Order and Order Item(s) properties
headOrderV3
Isolated FunctionRemote Function
function headOrderV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string? ifNoneMatch) returns Response|errorGet the meta information about the order (ETag, Last-Modified)
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- ifNoneMatch string? (default ()) - ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3
changeOrderV3
Isolated FunctionRemote Function
function changeOrderV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string changeOrderType, string userName, ChangeOrderRequest payload, boolean testMode) returns Response|errorChange your marketplace Order Information (accept, ship, etc.)
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- changeOrderType string - The Order change type
- userName 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.
- payload ChangeOrderRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
getOrderHistoryV3
Isolated FunctionRemote Function
function getOrderHistoryV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId) returns OrderHistory|errorGet an Order's harvest and change history
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
Return Type
- OrderHistory|error - Successfully fetched Order history
harvestOrderV3
Isolated FunctionRemote Function
function harvestOrderV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId) returns Response|errorSend harvest request for a single Order
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
harvestAccount
Isolated FunctionRemote Function
function harvestAccount(string marketplaceTechnicalCode, int accountId, string? marketplaceOrderId, string? beezUPOrderId) returns Response|errorSend harvest request for an Account
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- marketplaceOrderId string? (default ()) -
- beezUPOrderId string? (default ()) -
getOrderChangeReportingV3
Isolated FunctionRemote Function
function getOrderChangeReportingV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, string orderChangeExecutionUUID) returns ChangeOrderReporting|errorGet the order change reporting
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- orderChangeExecutionUUID string - The order change execution id
Return Type
- ChangeOrderReporting|error - Successfully fetched Order change reporting
setMerchantOrderInfoV3
Isolated FunctionRemote Function
function setMerchantOrderInfoV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, SetMerchantOrderInfoRequest payload, boolean testMode) returns Response|errorSet an Order's merchant information
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- payload SetMerchantOrderInfoRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
clearMerchantOrderInfoV3
Isolated FunctionRemote Function
function clearMerchantOrderInfoV3(string marketplaceTechnicalCode, int accountId, string beezUPOrderId, boolean testMode) returns Response|errorClear an Order's merchant information
Parameters
- marketplaceTechnicalCode string - The marketplace technical code
- accountId int -
- beezUPOrderId string - The BeezUP Order identifier
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
setMerchantOrderInfoListV3
Isolated FunctionRemote Function
function setMerchantOrderInfoListV3(SetMerchantOrderInfoListRequest payload, boolean testMode) returns BatchOrderOperationResponse|errorSend a batch of operations to set an Order's merchant information (max 100 items per call)
Parameters
- payload SetMerchantOrderInfoListRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
clearMerchantOrderInfoListV3
Isolated FunctionRemote Function
function clearMerchantOrderInfoListV3(ClearMerchantOrderInfoListRequest payload, boolean testMode) returns BatchOrderOperationResponse|errorSend a batch of operations to clear an Order's merchant information (max 100 items per call)
Parameters
- payload ClearMerchantOrderInfoListRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
changeOrderListV2
Isolated FunctionRemote Function
function changeOrderListV2(string userName, string changeOrderType, ChangeOrderListRequestV2 payload, boolean testMode) returns BatchOrderOperationResponse|errorSend a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)
Parameters
- userName 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.
- changeOrderType string - The Order change type
- payload ChangeOrderListRequestV2 -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
changeOrderListV3
Isolated FunctionRemote Function
function changeOrderListV3(string userName, ChangeOrderListRequest payload, boolean testMode) returns BatchOrderOperationResponse|errorSend a batch of operations to change your marketplace Order information: accept, ship, etc. (max 100 items per call)
Parameters
- userName 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.
- payload ChangeOrderListRequest -
- testMode boolean (default false) - If true, the operation will be not be sent to marketplace. But the validation will be taken in account.
Return Type
- BatchOrderOperationResponse|error - Succesfully received and processed batched operations. Please check response to see the status per operation.
getSubscriptionList
Isolated FunctionRemote Function
function getSubscriptionList() returns SubscriptionIndex[]|errorGet the subscription list
Return Type
- SubscriptionIndex[]|error - The subscription list
getSubscription
Isolated FunctionRemote Function
function getSubscription(string id) returns SubscriptionIndex|errorGet a subscription to the orders
Parameters
- id string -
Return Type
- SubscriptionIndex|error - Subscription info
createSubscription
Isolated FunctionRemote Function
function createSubscription(string id, CreateSubscriptionRequest payload) returns Response|errorCreates a subscription to the orders
deleteSubscription
Isolated FunctionRemote Function
Delete a subscription to the orders
Parameters
- id string -
getSubscriptionPushReporting
Isolated FunctionRemote Function
function getSubscriptionPushReporting(string id, int? pageNumber, int? pageSize) returns SubscriptionPushReporting[]|errorGet the push reporting related to this subscription
Return Type
- SubscriptionPushReporting[]|error - Subscription push reporting info
activateSubscription
Isolated FunctionRemote Function
function activateSubscription(string id, ActivateSubscriptionRequest payload) returns Response|errorActivate a subscription to the orders
deactivateSubscription
Isolated FunctionRemote Function
Deactivate a subscription to the orders
Parameters
- id string -
retryPushOrders
Isolated FunctionRemote Function
Force retry push orders immediatly
Parameters
- id string -
getOrderInvoiceGeneralSettings
Isolated FunctionRemote Function
function getOrderInvoiceGeneralSettings() returns GetOrderInvoiceGeneralSettingsResponse|errorGet Order Invoice general settings
Return Type
- GetOrderInvoiceGeneralSettingsResponse|error - Settings successfully retrieved
saveOrderInvoiceGeneralSettings
Isolated FunctionRemote Function
function saveOrderInvoiceGeneralSettings(OrderInvoiceGeneralSettings payload) returns Response|errorSave Order Invoice general settings
Parameters
- payload OrderInvoiceGeneralSettings -
getOrderInvoiceDesignSettings
Isolated FunctionRemote Function
function getOrderInvoiceDesignSettings() returns OrderInvoiceDesignSettings|errorGet Order Invoice design settings
Return Type
- OrderInvoiceDesignSettings|error - Design successfully retrieved
saveOrderInvoiceDesignSettings
Isolated FunctionRemote Function
function saveOrderInvoiceDesignSettings(OrderInvoiceDesignSettings payload) returns Response|errorSave Order Invoice design settings
Parameters
- payload OrderInvoiceDesignSettings -
getOrderInvoiceDesignSettingsPreview
Isolated FunctionRemote Function
function getOrderInvoiceDesignSettingsPreview(string acceptEncoding, OrderInvoiceDesignSettings payload) returns GetOrderInvoiceDesignPreviewResponse|errorView a preview an Order Invoice using custom design settings
Parameters
- acceptEncoding string - Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size
- payload OrderInvoiceDesignSettings -
Return Type
- GetOrderInvoiceDesignPreviewResponse|error - Design Preview successfully retrieved
generateOrderInvoice
Isolated FunctionRemote Function
function generateOrderInvoice(string marketplaceTechnicalCode, string accountId, string beezUPOrderUUID, string userName, GenerateOrderInvoiceRequest payload) returns Response|errorGenerate an Order Invoice
Parameters
- marketplaceTechnicalCode string - The Marketplace Technical Code
- accountId string - The Account Identifier
- beezUPOrderUUID string - The BeezUP Order UUID
- userName 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.
- payload GenerateOrderInvoiceRequest -
getOrderInvoicePreview
Isolated FunctionRemote Function
function getOrderInvoicePreview(string marketplaceTechnicalCode, string accountId, string beezUPOrderUUID, string acceptEncoding, PreviewOrderInvoiceRequest payload) returns PreviewOrderInvoiceResponse|errorView a preview an Order Invoice
Parameters
- marketplaceTechnicalCode string - The Marketplace Technical Code
- accountId string - The Account Identifier
- beezUPOrderUUID string - The BeezUP Order UUID
- acceptEncoding string - Allows the client to indicate wether it accepts a compressed encoding to reduce traffic size
- payload PreviewOrderInvoiceRequest -
Return Type
- PreviewOrderInvoiceResponse|error - Order Invoice preview successfully returned.
getOrderInvoicePdf
Isolated FunctionRemote Function
function getOrderInvoicePdf(GetOrderInvoicePdfFromHtmlInvoiceUrlRequest payload) returns string|errorReturns the PDF version of the invoice
Parameters
analyticsIndex
Isolated FunctionRemote Function
function analyticsIndex() returns AnalyticsIndex|errorGet the Analytics API operation index
Return Type
- AnalyticsIndex|error - Analytics API operation index
analyticsStoreIndex
Isolated FunctionRemote Function
function analyticsStoreIndex(string storeId) returns AnalyticsStoreIndex|errorGet the Analytics API operation index for one store
Parameters
- storeId string - Your store identifier
Return Type
- AnalyticsStoreIndex|error - Analytics API operation index for one store
getTrackingStatus
Isolated FunctionRemote Function
function getTrackingStatus() returns TrackingStatus|errorGet the global synchronization status of clicks and orders
Return Type
- TrackingStatus|error - The tracking status informations
getStoreTrackingStatus
Isolated FunctionRemote Function
function getStoreTrackingStatus(string storeId) returns StoreTrackingStatus|errorGet the synchronization status of clicks and orders of a store
Parameters
- storeId string - Your store identifier
Return Type
- StoreTrackingStatus|error - Store Tracking Status
getStoreTrackedClicks
Isolated FunctionRemote Function
function getStoreTrackedClicks(string storeId, int count) returns TrackedClicks|errorGet the latest tracked clicks
Parameters
- storeId string - Your store identifier
- count int (default 100) - The amount of clicks to retrieve
Return Type
- TrackedClicks|error - Click list
getStoreTrackedOrders
Isolated FunctionRemote Function
function getStoreTrackedOrders(string storeId, int count) returns TrackedOrders|errorGet the latest tracked orders
Parameters
- storeId string - Your store identifier
- count int (default 100) - The amount of orders to retrieve
Return Type
- TrackedOrders|error - Order list
getStoreTrackedExternalOrders
Isolated FunctionRemote Function
function getStoreTrackedExternalOrders(string storeId, int count) returns TrackedExternalOrders|errorGet the latest tracked external orders
Parameters
- storeId string - Your store identifier
- count int (default 100) - The amount of external orders to retrieve
Return Type
- TrackedExternalOrders|error - External Order list
getStoreReportByDayPerStore
Isolated FunctionRemote Function
function getStoreReportByDayPerStore(ReportByDayRequest payload) returns ReportByDayPerStoreResponse|errorGet the report by day for a StoreId
Parameters
- payload ReportByDayRequest -
Return Type
- ReportByDayPerStoreResponse|error - Your reporting by day
getStoreReportByDay
Isolated FunctionRemote Function
function getStoreReportByDay(string storeId, ReportByDayRequest payload) returns ReportByDayResponse|errorGet the report by day for a StoreId
Return Type
- ReportByDayResponse|error - Your reporting by day
getStoreReportByChannel
Isolated FunctionRemote Function
function getStoreReportByChannel(string storeId, ReportByChannelRequest payload) returns ReportByChannelResponse|errorGet the report by channel
Return Type
- ReportByChannelResponse|error - Your reporting by channel
getStoreReportByCategory
Isolated FunctionRemote Function
function getStoreReportByCategory(string storeId, ReportByCategoryRequest payload) returns ReportByCategoryResponse|errorGet the report by category
Return Type
- ReportByCategoryResponse|error - Your reporting by channel
getStoreReportByProduct
Isolated FunctionRemote Function
function getStoreReportByProduct(string storeId, ReportByProductRequest payload) returns ReportByProductResponse|errorGet the report by product
Return Type
- ReportByProductResponse|error - Your reporting by product
optimiseAll
Isolated FunctionRemote Function
function optimiseAll(string storeId, string actionName, OptimiseAllRequest payload) returns Response|errorOptimise all products
optimise
Isolated FunctionRemote Function
function optimise(string storeId, string actionName, OptimiseRequest payload) returns Response|errorOptimise products by page
optimiseByChannel
Isolated FunctionRemote Function
function optimiseByChannel(string storeId, string channelId, string actionName) returns Response|errorOptimise products by channel
Parameters
- storeId string - Your store identifier
- channelId string - The channel identifier concerned by this optimisation
- actionName string -
optimiseByCategory
Isolated FunctionRemote Function
function optimiseByCategory(string storeId, string catalogCategoryId, string actionName, string[] payload) returns Response|errorOptimise products by category
Parameters
- storeId string - Your store identifier
- catalogCategoryId string - The category identifier concerned by this optimisation
- actionName string -
- payload string[] - The channel identifier list concerned by this optimisation
optimiseByProduct
Isolated FunctionRemote Function
function optimiseByProduct(string storeId, string productId, string actionName, string[] payload) returns Response|errorOptimise product
Parameters
- storeId string - Your store identifier
- productId string - The product identifier concerned by this optimisation
- actionName string -
- payload string[] - The channel identifier list concerned by this optimisation
copyOptimisation
Isolated FunctionRemote Function
function copyOptimisation(string storeId, CopyOptimisationRequest payload) returns CopyOptimisationResponse|errorCopy product optimisations between 2 channels
Return Type
- CopyOptimisationResponse|error - Products optimisatisation copied
getReportFilters
Isolated FunctionRemote Function
function getReportFilters(string storeId) returns ReportFilterList|errorGet report filter list for the given store
Parameters
- storeId string - Your store identifier
Return Type
- ReportFilterList|error - Report filter list
getReportFilter
Isolated FunctionRemote Function
function getReportFilter(string storeId, string reportFilterId) returns ReportFilter|errorGet the report filter description
Parameters
- storeId string - Your store identifier
- reportFilterId string - Your report filter identifier
Return Type
- ReportFilter|error - Report filter
saveReportFilter
Isolated FunctionRemote Function
function saveReportFilter(string storeId, string reportFilterId, SaveReportFilterRequest payload) returns Response|errorSave the report filter
Parameters
- storeId string - Your store identifier
- reportFilterId string - Your report filter identifier
- payload SaveReportFilterRequest -
deleteReportFilter
Isolated FunctionRemote Function
Delete the report filter
Parameters
- storeId string - Your store identifier
- reportFilterId string - Your report filter identifier
getRules
Isolated FunctionRemote Function
Gets the list of rules for a given store
Parameters
- storeId string - Your store identifier
createRule
Isolated FunctionRemote Function
function createRule(string storeId, CreateRuleRequest payload) returns Response|errorRule creation
getRule
Isolated FunctionRemote Function
Gets the rule
deleteRule
Isolated FunctionRemote Function
Delete Rule
updateRule
Isolated FunctionRemote Function
function updateRule(string storeId, string ruleId, UpdateRuleRequest payload) returns Response|errorUpdate Rule
Parameters
- storeId string - Your store identifier
- ruleId string - Your rule identifier
- payload UpdateRuleRequest -
moveUpRule
Isolated FunctionRemote Function
Move the rule up
moveDownRule
Isolated FunctionRemote Function
Move the rule down
enableRule
Isolated FunctionRemote Function
Enable rule
disableRule
Isolated FunctionRemote Function
Disable rule
runRules
Isolated FunctionRemote Function
Run all rules for this store
Parameters
- storeId string - Your store identifier
runRule
Isolated FunctionRemote Function
Run rule
getRulesExecutions
Isolated FunctionRemote Function
function getRulesExecutions(string storeId, int pageNumber, int pageSize) returns RuleExecutionReportings|errorGet the rules execution history
Parameters
- storeId string - Your store identifier
- pageNumber int - The page to retrieve
- pageSize int - The count of rule history to retrieve
Return Type
- RuleExecutionReportings|error - Rules executions list
getLegacyTrackingChannelCatalogs
Isolated FunctionRemote Function
function getLegacyTrackingChannelCatalogs(string? storeId) returns LegacyTrackingChannelCatalogList|errorList all your current channel catalogs configured to use legacy tracking format
Parameters
- storeId string? (default ()) - The store identifier
Return Type
getLegacyTrackingChannelCatalog
Isolated FunctionRemote Function
function getLegacyTrackingChannelCatalog(string channelCatalogId) returns LegacyTrackingChannelCatalog|errorGet the channel catalog configured to use legacy tracking format information
Parameters
- channelCatalogId string - The channel catalog identifier
Return Type
- LegacyTrackingChannelCatalog|error - Channel catalog configured to use legacy tracking format
migrateLegacyTrackingChannelCatalog
Isolated FunctionRemote Function
Migrate a channel catalog to current tracking format
Parameters
- channelCatalogId string - The channel catalog identifier
Records
beezup.merchant: AccountInfo
Fields
- userId BeezupCommonUserid - The user identifier
- email BeezupCommonEmail - The email
- personalInfo PersonalInfo? -
- status AccountStatus - The account status
- Active: When the account is active
- SystemBlocked: When all stores on the account are blocked by the system
- UserBlocked: When all stores on the account are blocked on GO not on the system
- NotActivated: When the email is not verified
- companyInfo CompanyInfo? -
- profilePictureUrl ProfilePictureUrl? - Indicate the url of your picture profil
- links AccountInfoLinks - The different actions you can make on this account
- info BeezupCommonInfosummaries? -
beezup.merchant: AccountInfoLinks
The different actions you can make on this account
Fields
- self LinksGetuseraccountinfolink -
- savePersonalInfo LinksSavepersonalinfolink -
- changeEmail LinksChangeemaillink -
- changePassword LinksChangepasswordlink -
- saveCompanyInfo LinksSavecompanyinfolink -
- getProfilePictureInfo LinksGetprofilepictureinfolink -
- saveProfilePictureInfo LinksSaveprofilepictureinfolink -
- getCreditCardInfo LinksGetcreditcardinfolink -
- saveCreditCardInfo LinksSavecreditcardinfolink -
- activateUserAccount LinksActivateuseraccountlink? -
beezup.merchant: AccountPublications
The publication history for an account
Fields
- links AccountPublicationsLinks -
- publications PublicationReporting[] - The recent publications for the requested account
beezup.merchant: AccountPublicationsLinks
Fields
- self LinksGetpublicationslink -
beezup.merchant: AccountSynchronization
Fields
- accountId AccountId - The marketplace account identifier in BeezUP. This account identifier is based on your api settings.
- completedHarvestSynchroUtcDate string? -
- marketplaceBusinessCode BeezupCommonMarketplacebusinesscode - In an marketplace technical code like CDiscount you can have several marketplaces like GO SPORT, etc. We identify them by a business code.
- marketplaceTechnicalCode BeezupCommonMarketplacetechnicalcode - The technical code of the marketplace.
beezup.merchant: AccountSynchronizationList
Fields
- accountSynchronizations AccountSynchronization[]? -
beezup.merchant: ActivateSubscriptionRequest
Fields
- 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. If end period is not set and the begin period is set, then you will recover existing orders from the past using the begin period last modification date and after than you will continue to receive new/updated orders in real-time. If begin/end period are not set then you will receive new/updated orders in real-time. REMARK: The begin period is required if the end period is fulfilled. REMARK: If the end period is order last modification date is indicated then once we have push all orders to your target url the subscription will be desactivated.
beezup.merchant: AddChannelCatalogRequest
Fields
- channelId BeezupCommonChannelid - The channel identifier
- storeId BeezupCommonStoreid - The store identifier
beezup.merchant: AdditionalAnalyticsProductColumnFilters
Describes a filter on a product's column. The key is the column identifier of your catalog or a custom column.
beezup.merchant: AnalyticsIndex
The Analytics API operation index.
Fields
- stores AnalyticsStoreIndex[] -
- links AnalyticsIndexLinks -
- lovLinks AnalyticsIndexLovLinks? -
beezup.merchant: AnalyticsIndexLinks
Fields
- self LinksAnalyticsindexlink -
- trackingStatus LinksGettrackingstatuslink? -
beezup.merchant: AnalyticsIndexLovLinks
Fields
- performanceIndicatorTypeLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- performanceIndicatorTypeForReportsByChannelLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- performanceIndicatorTypeForReportsByCategoryLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- performanceIndicatorTypeForReportsByProductLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- performanceIndicatorFormulaParameterTypeLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- performanceIndicatorFormulaOperatorNameLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- performanceIndicatorFilterOperatorNameLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- analyticsProductColumnFilterOperatorNameLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- analyticsNumericalProductColumnFilterOperatorNameLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- analyticsStringProductColumnFilterOperatorNameLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- storeOptimisationRuleExecutionStatusLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
beezup.merchant: AnalyticsProductColumnFilter
Fields
- operatorName AnalyticsProductColumnFilterOperatorName - Indicate the operator you want to apply on the columnId
- values string[]? - Must be null if the operator is "IsNull" or "IsNotNull". Can contains multiple value in case of "InList" operator. Otherwise a single value is expected.
beezup.merchant: AnalyticsProductColumnFilters
Fields
- sku string? - The product sku filter
- title string? - The product title filter
- additionalAnalyticsProductColumnFilters AdditionalAnalyticsProductColumnFilters? - Describes a filter on a product's column. The key is the column identifier of your catalog or a custom column.
beezup.merchant: AnalyticsStoreIndex
Fields
- links AnalyticsStoreIndexLinks -
beezup.merchant: AnalyticsStoreIndexLinks
Fields
- self LinksAnalyticsindexlink -
- trackingStatus LinksGetstoretrackingstatuslink -
- trackedClicks LinksGetstoretrackedclickslink -
- trackedOrders LinksGetstoretrackedorderslink -
- trackedExternalOrders LinksGetstoretrackedexternalorderslink? -
- reportByDay LinksGetstorereportbydaylink? -
- reportByChannel LinksGetstorereportbychannellink? -
- reportByCategory LinksGetstorereportbycategorylink? -
- reportByProduct LinksGetstorereportbyproductlink? -
- optimiseAll LinksOptimisealllink? -
- optimise LinksOptimiselink? -
- optimiseByChannel LinksOptimisebychannellink? -
- optimiseByCategory LinksOptimisebycategorylink? -
- optimiseByProduct LinksOptimisebyproductlink? -
- reportFilters LinksGetreportfilterslink -
- rules LinksGetruleslink? -
beezup.merchant: ApiCredential
Your api credential
Fields
- productName string? - The product name related to this credential
- primaryToken string? - The primary token to be used in the next call in the user scope API
- secondaryToken string? - The secondary token. Could be usefull if you want to share your access with someone else.
beezup.merchant: ApiCredentials
Fields
- credentials ApiCredential[]? - Your API credential list
beezup.merchant: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- ocpApimSubscriptionKey string - Represents API Key 'Ocp-Apim-Subscription-Key'
beezup.merchant: AutoImportConfiguration
Fields
- input InputConfiguration - Describe the input configuration
- inputConfiguredByUserId BeezupCommonUserid - The user identifier
- schedulingType SchedulingType - Indicate the scheduling type. Schedule or Interval. We recommand you to use interval for a better reporting.
- scheduledByUserId BeezupCommonUserid? - The user identifier
- schedulingValue string[] - Indicate the scheduling value. If the scheduling type is Interval then the value will be a duration otherwise the values will be the time.
- paused boolean - Indicate if the auto import is in pause or not.
- pauseStatusChangedByUserId BeezupCommonUserid? - The user identifier
- pauseStatusChangedUtcDate string? - Indicate when the pause status has changed in UTC date.
- duplicateProductConfiguration DuplicateProductValueConfiguration - Describe how you want to manage the duplication of the product value
- schedulingLocalTimeZoneName string(default "Romance Standard Time") - Indicate the time zone name of the scheduling. If the scheduling type is "Schedule"
beezup.merchant: AutoImportConfigurationLinks
Fields
- activate LinksImportationActivateautoimportlink? -
- 'start LinksAutoStartautoimportlink? -
- pause LinksAutoPauseautoimportlink? -
- resume LinksAutoResumeautoimportlink? -
- scheduleInterval LinksAutoConfigureautoimportintervallink? -
- schedule LinksAutoScheduleautoimportlink? -
beezup.merchant: AutomaticTransition
Fields
- marketplaceTechnicalCode BeezupCommonMarketplacetechnicalcode - The technical code of the marketplace.
- accountId AccountId - The marketplace account identifier in BeezUP. This account identifier is based on your api settings.
- orderStatusTransitionId int -
- enabled boolean -
beezup.merchant: AutomaticTransitionInfo
Fields
- Fields Included from *AutomaticTransition
- marketplaceTechnicalCode BeezupCommonMarketplacetechnicalcode
- accountId AccountId
- orderStatusTransitionId int
- enabled boolean
- anydata...
- marketplaceBusinessCode BeezupCommonMarketplacebusinesscode - In an marketplace technical code like CDiscount you can have several marketplaces like GO SPORT, etc. We identify them by a business code.
- beezUPOrderStatus BeezUPOrderStatus - BeezUP order status. Unified for all marketplaces.
- businessOperationType BusinessOperationType -
- links AutomaticTransitionInfoLinks? -
beezup.merchant: AutomaticTransitionInfoLinks
Fields
- configure LinksConfigureautomatictransitionslink -
beezup.merchant: AutomaticTransitionInfoList
Fields
- links AutomaticTransitionInfoListLinks -
- automaticTransitionInfos AutomaticTransitionInfo[]? -
beezup.merchant: AutomaticTransitionInfoListLinks
Fields
- configure LinksConfigureautomatictransitionslink -
beezup.merchant: BatchOrderOperationResponse
The response given by the batch operation
Fields
- operations OrderOperationResponse[] -
beezup.merchant: BeezUPColumnConfiguration
Describe a BeezUP column
Fields
- beezUPColumnName BeezupCommonBeezupcolumnname - The BeezUP column name
- unique boolean(default false) - /!\ ONLY AVAILABLE ON CATALOG COLUMN NOT ON CUSTOM COLUMNS!! If true, an error happen at the second occurence of the same value for this column This information will be used during the importation process and later for mapping proposal
- columnImportance BeezupCommonColumnimportance - Importance of the column
- columnDataType BeezupCommonColumndatatype? - Data type of the column, will be used for parsing and for consolidation proces
- canBeTruncated CanBeTruncated? - If the size of the value is greater than the limit we can truncate the value instead of failing...
- displayGroupName DisplayGroupName - Indicate the display group name where the column must be putted
- description string? - Describe the BeezUP column
beezup.merchant: BeezupCommonAdditionalproductfilters
Describe a filter on a product's column. The key is the column identifier of your catalog or a custom column.
beezup.merchant: BeezupCommonAdditionalproductfiltersvalue
Fields
- operatorName BeezupCommonProductcolumnfilteroperatorname? - Indicate the operator you want to make on the columnId
- values string[]? - Must be null if the operator is "IsNull" or "IsNotNull". Can contains multiple value in case of "InList" operator. Otherwise a single value is expected.
beezup.merchant: BeezupCommonCatalogcategoryfilter
Fields
- categoryPath string[]? - Indicates on which catalog category path you want to make the filter
beezup.merchant: BeezupCommonChannelbasicinfo
The basic info related to a channel
Fields
- channelId BeezupCommonChannelid - The channel identifier
- channelName BeezupCommonChannelname - The channel name
- channelImageUrl BeezupCommonHttpurl - The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>
beezup.merchant: BeezupCommonChannelcategoryfilter
Fields
- categoryPath string[]? - Indicates on which channel category path you want to make the filter
beezup.merchant: BeezupCommonErrorresponsemessage
Fields
- errors BeezupCommonUsererrormessage[] -
beezup.merchant: BeezupCommonErrorsummary
Fields
- utcDate string? -
- errorGuid string? -
- errorCode string? -
- errorMessage string? -
- technicalErrorMessage string? -
- exceptionDetail BeezupCommonExceptiondetail? -
- errorArguments record {}? -
- propertyName string? -
- propertyValue string? -
- objectName string? -
- 'source string? -
beezup.merchant: BeezupCommonExceptiondetail
Fields
- helpLink string? -
- message string? -
- stackTrace string? -
- 'type string? -
beezup.merchant: BeezupCommonInfosummaries
Fields
- successes BeezupCommonSuccesssummary[]? -
- errors BeezupCommonErrorsummary[]? -
- warnings BeezupCommonWarningsummary[]? -
- informations BeezupCommonInfosummary[]? -
beezup.merchant: BeezupCommonInfosummary
Fields
- informationCode string? -
- informationMessage string? -
- informationArguments record {}? -
- propertyName string? -
- propertyValue string? -
- objectName string? -
beezup.merchant: BeezupCommonLink3
Fields
- label string? - The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
- docUrl BeezupCommonDocurl? - The documentation related to this operation.
- description string? - The description of the link
- href BeezupCommonHref - Indicate the relative uri for this link
- operationId BeezupCommonOperationid? - The operationId to call.
- method BeezupCommonHttpmethod? - Indicate the http method to use on this link
- parameters record {}? -
- urlTemplated boolean? - indicates whether the href is templated or not
- allRequiredParamsProvided boolean? - indicates whether all required params have been provided
- allOptionalParamsProvided boolean? - indicates whether all optionals params have been provided
- info BeezupCommonInfosummaries? -
beezup.merchant: BeezupCommonLinkparameter3
Fields
- label string? - The label corresponding to the link parameter. This label is automatically translated based on the Accept-Language http header.
- value record {}? - The value of the parameter. It can be an integer a string or an object.
- required boolean(default false) -
- 'in BeezupCommonParameterin -
- path: if the parameter must be pass in the path uri
- header: if the parameter must be passed in http header
- query: if the parameter must be passed in querystring
- body: if the paramter must be passed in the body
- 'type BeezupCommonParametertype? - The value type of the parameter
- lovLink BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- lovRequired boolean? - If true, you MUST indicate a value from the list of values otherwise it's a freetext
- description string? - description of the parameter
- schema string? - schema of the parameter
- properties record {}? - If the parameter is an object with flexible properties (additionProperties/dictionary), we will describe the properties of the object.
beezup.merchant: BeezupCommonLinkparameterproperty3
Fields
- label string? - The label corresponding to the link parameter property. This label is automatically translated based on the Accept-Language http header.
- value record {}? - The value of the parameter. It can be an integer a string or an object.
- required boolean? -
- 'type BeezupCommonParametertype - The value type of the parameter
- lovLink BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- lovRequired boolean? - If true, you MUST use indicate a value from the list of values otherwise it's a freetext
- description string? - description of the parameter
- schema string? - schema of the parameter
beezup.merchant: BeezupCommonListofvalueitem
This object is used by LOV apis
Fields
- position int? -
- codeIdentifier string -
- translationText string? -
- intIdentifier int -
beezup.merchant: BeezupCommonLovlink3
Describe the way you have to follow to get access to the LOV
Fields
- href string - Indicate the uri to the list of value
- method BeezupCommonHttpmethod? - Indicate the http method to use on this link
beezup.merchant: BeezupCommonPaginationresult
Fields
- entryCount int - The entry count currently returned
- pageCount int - The page count
- totalEntryCount int - The total entry count
- links BeezupCommonPaginationresultlinks - The navigation links 'first', 'last', 'next', 'previous'
beezup.merchant: BeezupCommonPaginationresultlinks
The navigation links 'first', 'last', 'next', 'previous'
Fields
- first BeezupCommonLink3 -
- last BeezupCommonLink3 -
- previous BeezupCommonLink3? -
- next BeezupCommonLink3? -
beezup.merchant: BeezupCommonProductbasicinfo
The basic information related to a product
Fields
- productId string - The product identifier
- productSku string - The product SKU
- productTitle string - The product tile
- productImageUrl string? - The product image Url
- productExists boolean - Indicates if the product still exists in your catalog
beezup.merchant: BeezupCommonSuccesssummary
Fields
- successCode string? -
- successMessage string? -
- successArguments record {}? -
- propertyName string? -
- propertyValue string? -
- objectName string? -
beezup.merchant: BeezupCommonUsererrormessage
Fields
- docUrl BeezupCommonDocurl? - The documentation related to this operation.
- code string - the error code. The error code can be a pattern containing the argument's name
- message string - The error message
- cultureName string? - If the error is translated, the culture name will be indicated
- arguments BeezupCommonUsererrormessageArguments[]? - a dictionary string/object
beezup.merchant: BeezupCommonUsererrormessageArguments
Fields
- name string - The key of the parameter
- value record {} - The value of the parameter. Depending to the type.
beezup.merchant: BeezupCommonWarningsummary
Fields
- technicalErrorMessage string? -
- warningMessage string? -
- warningCode string? -
- warningArguments record {}? -
beezup.merchant: BillingPeriod
Fields
- billingPeriodInMonth int - The billing period in month
- discountPercentage decimal - The discount percentage related to this billing period
beezup.merchant: BillingPeriodList
Fields
- links BillingPeriodListLinks -
- billingPeriods BillingPeriod[] - The billing period list
beezup.merchant: BillingPeriodListLinks
Fields
- self LinksGetbillingperiodslink? -
beezup.merchant: BonusInfo
Fields
- bonusType BonusType -
- amount decimal -
beezup.merchant: CatalogColumn
The catalog column configuration
Fields
- ignored boolean(default false) - IF true, the product values of this column will be not taken in account during the importation process
- duplicateProductValueConfiguration DuplicateProductValueConfiguration? - Describe how you want to manage the duplication of the product value
- id ColumnId - The catalog column identifier
- catalogColumnName CatalogColumnName - The catalog column name
- userColumName UserColumName - Column named by the user
- configuration ColumnConfiguration - Indicates the configuration applied on the column (catalog or custom) during the importation process.
- links CatalogColumnLinks -
beezup.merchant: CatalogColumnLinks
Fields
beezup.merchant: CatalogColumnList
Fields
- catalogColumns CatalogColumn[] -
beezup.merchant: CatalogIndex
Fields
- links CatalogIndexLinks -
- lovLinks CatalogIndexLOVLinks -
- storeLinks CatalogStoreIndexList? -
beezup.merchant: CatalogIndexLinks
Fields
- self LinksCatalogindexlink -
- beezUPColumns LinksCatalogGetbeezupcolumnslink -
beezup.merchant: CatalogIndexLOVLinks
Fields
- beezUPColumnLov BeezupCommonLovlink3 - Describe the way you have to follow to get access to the LOV
- beezUPColumnDataTypeLov BeezupCommonLovlink3 - Describe the way you have to follow to get access to the LOV
- beezUPColumnImportanceLov BeezupCommonLovlink3 - Describe the way you have to follow to get access to the LOV
- beezUPColumnDisplayGroupLov BeezupCommonLovlink3 - Describe the way you have to follow to get access to the LOV
- duplicateProductValueStrategyLov BeezupCommonLovlink3 - Describe the way you have to follow to get access to the LOV
- compareOptionLov BeezupCommonLovlink3 - Describe the way you have to follow to get access to the LOV
beezup.merchant: CatalogStoreIndex
Fields
- links CatalogStoreIndexLinks -
- status CatalogStoreStatus - Indicates the status of the catalog store.
- OK: If the latest importation is a success!
- Failed: If the latest importation has failed !
- Outdated: If the latest succeed importation is later than 1 day.
beezup.merchant: CatalogStoreIndexLinks
Fields
- self LinksCatalogstoreindexlink -
- inputConfiguration LinksImportationGetmanualupdatelastinputconfiglink? -
- autoImportInfo LinksAutoGetautoimportconfigurationlink? -
- importations LinksImportationGetreportingslink? -
- startImportation LinksImportationStartmanualupdatelink? -
- catalogColumns LinksCatalogGetcatalogcolumnslink? -
- customColumns LinksCatalogGetcustomcolumnslink? -
- categories LinksCatalogGetcategorieslink? -
- products LinksCatalogGetproductslink? -
- randomProducts LinksCatalogGetrandomproductslink? -
- computeExpression LinksCatalogComputeexpressionlink? -
beezup.merchant: CatalogStoreIndexList
Fields
- links record {}? - The key is the store identifier.
beezup.merchant: Category
The catalog category
Fields
- categoryId BeezupCommonCatalogcategoryid? - The catalog category identifier
- categoryPath BeezupCommonCatalogcategorypath - The catalog category path
- totalProductCount int - The total product count related to this category and his sub categories
- selfProductCount int - The product count related to this category
beezup.merchant: CategoryList
The object which contains the category list
Fields
- categories Category[] - The category list
beezup.merchant: CategoryMappingState
The category mapping state of the channel catalog
Fields
- status CategoryMappingStatus? -
- uncategorizedProductCount int? - Indicates the uncategorized product count
- withoutCategoryCostProductCount int? - Indicates the count of products without cost defined
beezup.merchant: ChangeCustomColumnExpressionRequest
The request message to change the custom column expression
Fields
- encryptedExpression EncryptedExpression - The encrypted excel expression of the column
- encryptedBlocklyExpression EncryptedBlocklyExpression - The encrypted XML Blockly representation of the expression
beezup.merchant: ChangeCustomColumnRequest
The message request to change a custom column expression an user name
Fields
- encryptedExpression EncryptedExpression - The encrypted excel expression of the column
- encryptedBlocklyExpression EncryptedBlocklyExpression - The encrypted XML Blockly representation of the expression
- userColumName UserColumName - Column named by the user
beezup.merchant: ChangeEmailRequest
Fields
- newEmail BeezupCommonEmail - The email
beezup.merchant: ChangeOrderListRequest
Contains all change order operations you want to make. (max 100 items per call)
Fields
- changeOrders ChangeOrderListRequestItem[] - The change order operations
beezup.merchant: ChangeOrderListRequestItem
Contains the order identifier and the change order request
Fields
- 'order OrderIdentifierWithETag -
- changeOrderRequest ChangeOrderRequest? - All properties with the prefix order_ are translated in the list of values /user/lov#OrderMetaInfoPosted
beezup.merchant: ChangeOrderListRequestItemV2
Contains the order identifier and the change order request
Fields
- 'order OrderIdentifier -
- changeOrderRequest ChangeOrderRequest? - All properties with the prefix order_ are translated in the list of values /user/lov#OrderMetaInfoPosted
beezup.merchant: ChangeOrderListRequestV2
Contains all change order operations you want to make. (max 100 items per call)
Fields
- changeOrders ChangeOrderListRequestItemV2[] - The change order operations
beezup.merchant: ChangeOrderReporting
The reporting related to a change order operation
Fields
- executionUUID ExecutionUUID? - The execution identifier
- changeOrderType BusinessOperationType? -
- sourceType SourceType? - Indicates the origin of the operation
- sourceUserId BeezupCommonUserid? - The user identifier
- sourceUserName string? -
- creationUtcDate string? - The creation UTC date of the execution
- processingStatus string? - The processing status of the execution
- lastUpdateUtcDate string? - The last update UTC date of the execution
- errorMessage string? - The error message during the execution
- ipAddress string? - The IP address who request this operation
- testMode boolean? - This operation was a test
- details record {}? -
beezup.merchant: ChangeOrderRequest
All properties with the prefix order_ are translated in the list of values /user/lov#OrderMetaInfoPosted
beezup.merchant: ChangePasswordRequest
Fields
- oldPassword string - Your current password
- newPassword string - Your new password. Which must respect the same constraints as the user registeration
beezup.merchant: ChangeUserColumnNameRequest
The message request for the change user column name
Fields
- userColumName UserColumName - Column named by the user
beezup.merchant: ChannelCatalog
Fields
- Fields Included from *BeezupCommonChannelbasicinfo
- channelId BeezupCommonChannelid
- channelName BeezupCommonChannelname
- channelImageUrl BeezupCommonHttpurl
- anydata...
- enabled boolean - Indicates if the channel catalog is enable
- isMarketplace boolean - Indicates if this channel catalog is related to a marketplace
- channelCatalogId BeezupCommonChannelcatalogid - The channel catalog identifier
- storeId BeezupCommonStoreid - The store identifier
- generalSettings GeneralSettings - Represents the general settings of your channel catalog
- channelCostSettings ChannelCostSettings - Indicate the default configuration of the cost on this channel.
- channelCategorySettings ChannelCategorySettings -
- costSettings CostSettings? - If this property is not indicated please force the user to configure the cost settings. Defines the cost type you have on this channel with the cost value.
- categoryMappingSettings ChannelCatalogCategoryMappingSettings? -
- columnMappings ChannelCatalogColumnMappingListWithName? - The column mapping list between a channel and a catalog
- exclusionFilters ExclusionFilters? - The exclusion filter list
- exportUrl BeezupCommonHttpurl? - The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>
- state ChannelCatalogState - Channel Catalog State
- types string[] - The channel type list related to the channel
- links ChannelCatalogLinks - Indicates the actions you can do on a channel catalog
beezup.merchant: ChannelCatalogCategoryConfiguration
Represent a mapping between a catalog category path and a channel category path. The cost on this mapping can be applied.
Fields
- autoMapNewSubCategories boolean - Great feature! In case of mapping to parent catalog category, you can ask to automatically map new sub catalog category in the next importation to this channel category path.
- catalogCategoryPath BeezupCommonCatalogcategorypath - The catalog category path
- channelCategoryPath BeezupCommonChannelcategorypath? - The channel category path
- costValue ChannelCatalogCategoryCostValue? - In case of CPC_ByCategory or CPA_ByCategory cost type, you have to indicate the cost value.
beezup.merchant: ChannelCatalogCategoryConfigurationInfo
For all catalog categories the current mapping applied
Fields
- catalogCategoryPath BeezupCommonCatalogcategorypath - The catalog category path
- channelCategoryPath BeezupCommonChannelcategorypath? - The channel category path
- costValue ChannelCatalogCategoryCostValue? - In case of CPC_ByCategory or CPA_ByCategory cost type, you have to indicate the cost value.
beezup.merchant: ChannelCatalogCategoryConfigurationList
Fields
- links ChannelCatalogCategoryMappingsLinks - The action you can do on the category mappings
- channelCatalogCategoryConfigurations ChannelCatalogCategoryConfigurationInfo[] -
- mappingStatus MappingStatus -
- costStatus CostStatus -
beezup.merchant: ChannelCatalogCategoryMappingInfoLinks
Fields
- configureCategories LinksConfigurechannelcatalogcategorylink? -
beezup.merchant: ChannelCatalogCategoryMappingSettings
Fields
- categoryMappingDisabledByMerchant boolean? - Optional parameter. Indicates that you have decided to do not map your categories with the channel's categories.
beezup.merchant: ChannelCatalogCategoryMappingsLinks
The action you can do on the category mappings
Fields
- reenable LinksReenablechannelcatalogcategorymappinglink? -
beezup.merchant: ChannelCatalogColumnMapping
Represent a mapping between a channel column (considering channel category mapping) and a catalog column
Fields
- channelColumnId BeezupCommonChannelcolumnid - The channel column identifier
- channelCategoryPath BeezupCommonChannelcategorypath? - The channel category path
- catalogColumnId BeezupCommonCatalogcolumnid? - The catalog column identifier (catalog or custom column)
beezup.merchant: ChannelCatalogColumnMappingWithName
Fields
- Fields Included from *ChannelCatalogColumnMapping
- channelColumnId BeezupCommonChannelcolumnid
- channelCategoryPath BeezupCommonChannelcategorypath
- catalogColumnId BeezupCommonCatalogcolumnid
- anydata...
- channelColumnName BeezupCommonChannelcolumnname - The channel column name
- channelBeezUPColumnName BeezupCommonBeezupcolumnname? - The BeezUP column name
- catalogColumnName BeezupCommonCatalogcolumnusername? - The catalog column named by the user (catalog or custom column)
- catalogBeezUPColumnName BeezupCommonBeezupcolumnname? - The BeezUP column name
beezup.merchant: ChannelCatalogExportationHistory
Fields
- paginationResult BeezupCommonPaginationresult? -
- exportations ChannelCatalogExportationReporting[] -
beezup.merchant: ChannelCatalogExportationHistoryLinks
Fields
beezup.merchant: ChannelCatalogExportationReporting
Fields
- exportationUtcDate string - The exportation UTC date
- exportationDuration string? - The exportation duration.
'00:01:00' measn 1 minute.
- cacheStatus string? - The cache status during the exportation
- exportedProductCount int? - The exportated product count during this exportation
- clientIpAddress string - The IP address of the client who requests this exportation
- clientUserAgent string - The http header User-Agent sent by the client who requests this operation
beezup.merchant: ChannelCatalogExportCacheInfo
Fields
- cacheStatus string - The cache status
- lastUpdateUtcDate string? - The last update UTC date of the cache
- lastContentChangeUtcDate string? - The last content change UTC date
- expirationUtcDate string? - The expiration UTC date of the cache
- feedUrl string? - The feed url
beezup.merchant: ChannelCatalogExportCacheInfoResponse
Fields
- cacheInfo ChannelCatalogExportCacheInfo -
beezup.merchant: ChannelCatalogExportCacheInfoResponseLinks
Fields
beezup.merchant: ChannelCatalogLinks
Indicates the actions you can do on a channel catalog
Fields
- self LinksGetchannelcataloglink -
- delete LinksDeletechannelcataloglink? -
- enable LinksEnablechannelcataloglink? -
- disable LinksDisablechannelcataloglink? -
- configureGeneralSettings LinksConfigurechannelcataloggeneralsettingslink? -
- configureCostSettings LinksConfigurechannelcatalogcostsettingslink? -
- configureColumnMappings LinksConfigurechannelcatalogcolumnmappingslink? -
- reenableCategoryMappings LinksReenablechannelcatalogcategorymappinglink? -
- disableCategoryMappings LinksDisablechannelcatalogcategorymappinglink? -
- categoryMappings LinksGetchannelcatalogcategorieslink? -
- exclusionFilters LinksGetchannelcatalogexclusionfilterslink? -
- products LinksGetchannelcatalogproductinfolistlink? -
- exportationCacheInfo LinksGetchannelcatalogexportationcacheinfolink? -
- marketplaceSettings ExternallinksGetchannelcatalogmarketplacesettingslink? -
- channelInfo ExternallinksGetchannelinfolink? -
beezup.merchant: ChannelCatalogList
This is the index of the channel catalog API
Fields
- links ChannelCatalogListLinks? - Indicates how global actions you can do like how to create a channel catalog, exclusion filter operators, etc...
- lovLinks ChannelCatalogListLovLinks? -
- channelCatalogs record {}? - The channel catalog list. The key is the channel catalog identifier
beezup.merchant: ChannelCatalogListLinks
Indicates how global actions you can do like how to create a channel catalog, exclusion filter operators, etc...
Fields
- self LinksGetchannelcatalogslink? -
- beezUPColumns ExternallinksCatalogGetbeezupcolumnslink? -
- add LinksAddchannelcataloglink? -
- filterOperators LinksGetchannelcatalogfilteroperatorslink? -
beezup.merchant: ChannelCatalogListLovLinks
Fields
- channelCatalogExclusionFilterOperatorLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- channelCatalogExportCacheStatusLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
beezup.merchant: ChannelCatalogMarketplaceBooleanProperty
Fields
- Fields Included from *ChannelCatalogMarketplaceProperty
- name ChannelCatalogMarketplacePropertyName
- info BeezupCommonInfosummaries
- description string
- position int
- readOnly boolean
- minLength int
- maxLength int
- minItems int
- maxItems int
- lovLink BeezupCommonLovlink3
- lovRequired boolean
- required boolean
- offerIdRequired int
- visible boolean
- type Type
- discriminatorType ChannelCatalogMarketplacePropertyDiscriminatorType
- pattern string
- anydata...
- default boolean? - Indicate the default values of the property
beezup.merchant: ChannelCatalogMarketplaceBooleanSetting
Fields
- Fields Included from *ChannelCatalogMarketplaceSetting
- name ChannelCatalogMarketplacePropertyName
- discriminatorType ChannelCatalogMarketplaceSettingDiscriminatorType
- anydata...
- value boolean? - Channel catalog marketplace property values
beezup.merchant: ChannelCatalogMarketplaceIntegerProperty
Fields
- Fields Included from *ChannelCatalogMarketplaceProperty
- name ChannelCatalogMarketplacePropertyName
- info BeezupCommonInfosummaries
- description string
- position int
- readOnly boolean
- minLength int
- maxLength int
- minItems int
- maxItems int
- lovLink BeezupCommonLovlink3
- lovRequired boolean
- required boolean
- offerIdRequired int
- visible boolean
- type Type
- discriminatorType ChannelCatalogMarketplacePropertyDiscriminatorType
- pattern string
- anydata...
- default int[]? - Indicate the default values of the property
beezup.merchant: ChannelCatalogMarketplaceIntegerSetting
Fields
- Fields Included from *ChannelCatalogMarketplaceSetting
- name ChannelCatalogMarketplacePropertyName
- discriminatorType ChannelCatalogMarketplaceSettingDiscriminatorType
- anydata...
- values int[]? - Channel catalog marketplace property values
beezup.merchant: ChannelCatalogMarketplaceNumberProperty
Fields
- Fields Included from *ChannelCatalogMarketplaceProperty
- name ChannelCatalogMarketplacePropertyName
- info BeezupCommonInfosummaries
- description string
- position int
- readOnly boolean
- minLength int
- maxLength int
- minItems int
- maxItems int
- lovLink BeezupCommonLovlink3
- lovRequired boolean
- required boolean
- offerIdRequired int
- visible boolean
- type Type
- discriminatorType ChannelCatalogMarketplacePropertyDiscriminatorType
- pattern string
- anydata...
- default decimal[]? - Indicate the default values of the property
beezup.merchant: ChannelCatalogMarketplaceNumberSetting
Fields
- Fields Included from *ChannelCatalogMarketplaceSetting
- name ChannelCatalogMarketplacePropertyName
- discriminatorType ChannelCatalogMarketplaceSettingDiscriminatorType
- anydata...
- values decimal[]? - Channel catalog marketplace property values
beezup.merchant: ChannelCatalogMarketplaceProperties
Fields
- info BeezupCommonInfosummaries? -
- propertyGroups ChannelCatalogMarketplacePropertyGroup[] - The groups settings with constraints
beezup.merchant: ChannelCatalogMarketplacePropertiesLinks
Fields
- settings LinksGetchannelcatalogmarketplacesettingslink? -
- externalConfigurationPage ExternallinksGetexternalconfigurationpagelink? -
beezup.merchant: ChannelCatalogMarketplaceProperty
Model for fetching a channel catalog marketplace property
Fields
- name ChannelCatalogMarketplacePropertyName - Channel catalog marketplace property name
- info BeezupCommonInfosummaries? -
- description string? - Indicate the description of the property
- position int - Indicate the position of the property in the display group
- readOnly boolean - Indicate if the value cannot be changed. This is used for example for ebay token that should not be changed.
- minLength int(default 0) - Indicates the minimum size of the property value
- maxLength int? - Indicates the maximum size of the property value
- minItems int(default 1) - Indicates the minimum item count of the property value.
- maxItems int(default 1) - Indicates the maximum item count of the property value
- lovLink BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- lovRequired boolean(default false) - Indicates if the property value must be in the list of value.
- required boolean - Indicate if the property is required or not
- offerIdRequired int? - Indicates the offer identifier required to configure this property.
- visible boolean - Indicates if this property should be displayed in the configuration page.
- 'type Type - The Data Type
- discriminatorType ChannelCatalogMarketplacePropertyDiscriminatorType -
- pattern string? - Channel catalog marketplace setting value format validation regular expression
beezup.merchant: ChannelCatalogMarketplacePropertyGroup
Fields
- name string - Indicate the code identifier of the group
- position int - Indicate the position of the group
- properties ChannelCatalogMarketplaceProperty[] -
beezup.merchant: ChannelCatalogMarketplaceSetting
Model for fetching a channel catalog marketplace setting
Fields
- name ChannelCatalogMarketplacePropertyName - Channel catalog marketplace property name
- discriminatorType ChannelCatalogMarketplaceSettingDiscriminatorType -
beezup.merchant: ChannelCatalogMarketplaceSettings
The channel catalog marketplace settings
Fields
- settings ChannelCatalogMarketplaceSetting[] -
beezup.merchant: ChannelCatalogMarketplaceSettingsLinks
Fields
beezup.merchant: ChannelCatalogMarketplaceStringProperty
Fields
- Fields Included from *ChannelCatalogMarketplaceProperty
- name ChannelCatalogMarketplacePropertyName
- info BeezupCommonInfosummaries
- description string
- position int
- readOnly boolean
- minLength int
- maxLength int
- minItems int
- maxItems int
- lovLink BeezupCommonLovlink3
- lovRequired boolean
- required boolean
- offerIdRequired int
- visible boolean
- type Type
- discriminatorType ChannelCatalogMarketplacePropertyDiscriminatorType
- pattern string
- anydata...
- default string[]? - Indicate the default values of the property
beezup.merchant: ChannelCatalogMarketplaceStringSetting
Fields
- Fields Included from *ChannelCatalogMarketplaceSetting
- name ChannelCatalogMarketplacePropertyName
- discriminatorType ChannelCatalogMarketplaceSettingDiscriminatorType
- anydata...
- values string[]? - Channel catalog marketplace property values
beezup.merchant: ChannelCatalogProductByChannelCatalogRequest
Fields
- storeId BeezupCommonStoreid - The store identifier
- productId BeezupCommonProductid - The product identifier
- channelCatalogIds BeezupCommonChannelcatalogid[] - The list of channel catalog identifier
beezup.merchant: ChannelCatalogProductByChannelCatalogResponse
Fields
- channelCatalogs record {}? - The channel catalog product by channel catalog. The key is the channel catalog identifier
beezup.merchant: ChannelCatalogProductFilters
Fields
- catalogSkus string[]? - The catalog product SKU filter (multiple values)
- catalogEans string[]? - The catalog product EAN filter (multiple values)
- catalogMpns string[]? - The catalog product MPN filter (multiple values)
- channelSkus string[]? - The channel product SKU filter (multiple values)
- channelEans string[]? - The channel product EAN filter (multiple values)
- channelMpns string[]? - The channel product MPN filter (multiple values)
- title string? - The product title filter
- additionalProductFilters BeezupCommonAdditionalproductfilters? - Describe a filter on a product's column. The key is the column identifier of your catalog or a custom column.
beezup.merchant: ChannelCatalogProductInfo
Fields
- Fields Included from *BeezupCommonProductbasicinfo
- overrides ProductOverridesWithCatalogValues - The key is the channel column identifier
- disabled boolean - Indicates if the product has been disabled or not
- uncategorized boolean - Indicates if the product's category has been NOT mapped to a channel category
- excluded boolean - Indicates if the product has been excluded by a exclusion filter
- excludedBy ExclusionFilterName[]? -
- links ChannelCatalogProductInfoLinks - Indicates the differents actions you can do on a channel product
beezup.merchant: ChannelCatalogProductInfoLinks
Indicates the differents actions you can do on a channel product
Fields
- override LinksOverridechannelcatalogproductvalueslink -
- disable LinksDisablechannelcatalogproductlink? -
- reenable LinksReenablechannelcatalogproductlink? -
beezup.merchant: ChannelCatalogProductInfoList
The channel catalog product info list
Fields
- paginationResult BeezupCommonPaginationresult -
- productInfos ChannelCatalogProductInfo[] -
beezup.merchant: ChannelCatalogProductInfoListLinks
Fields
beezup.merchant: ChannelCatalogProductsCounters
The channel catalog products counters. For each counter you will have a count.
Fields
- existingProductCount int? - Imported product count currently in your catalog.
- uncategorizedProductCount int? - Product count WITHOUT category mapped on existing products.
- disabledProductCountIncludingUncategorized int? - Disabled product count INCLUDING uncategorized products on existing products.
- disabledProductCountExcludingUncategorized int? - Disabled product count EXCLUDING uncategorized products on existing products.
- excludedProductCountIncludingUncategorizedAndDisabled int? - Excluded product count INCLUDING uncategorized products AND disabled products on existing products.
- excludedProductCountExcludingUncategorizedAndDisabled int? - Excluded product count EXCLUDING uncategorized products AND disabled products on existing products.
beezup.merchant: ChannelCatalogState
Channel Catalog State
Fields
- exportedProductCount int -
- columnMappingStatus ColumnMappingStatus -
- categoryMappingState CategoryMappingState - The category mapping state of the channel catalog
- apiSettingsStatus BeezupCommonApisettingsstatus? -
beezup.merchant: ChannelCategory
The channel category
Fields
- channelCategoryId BeezupCommonChannelcategoryid -
- channelCategoryPath BeezupCommonChannelcategorypath - The channel category path
- channelCategoryLevel ChannelCategoryLevel - The channel category level starting from 1
- channelCategoryDefaultCost ChannelCategoryDefaultCost? - The default cost on this channel category
- channelCategoryChannelCode ChannelCategoryChannelCode? - The channel category channel code identifier
- channelCategoryColumnOverrides ChannelCategoryColumnOverrides? - The channel category column overrides
beezup.merchant: ChannelCategoryColumnOverride
Fields
- channelColumnId BeezupCommonChannelcolumnid - The channel column identifier
- channelColumnName BeezupCommonChannelcolumnname - The channel column name
- channelColumnDescription ChannelColumnDescription? - The channel column description
- showInMapping ChannelColumnShowInMapping - Indicates if this column must shown in the mapping page or not
- configuration ChannelColumnConfiguration - The channel column configuration. The BeezUP Column Name is optional. If the BeezUP column is mapped we will indicate the data type and column importance of the BeezUP column.
- restrictedValues ChannelColumnRestrictedValues? - The restricted values. The key will be the restricted value identifier (format:guid) and the value will be the restriced value
beezup.merchant: ChannelCategoryColumnOverrides
The channel category column overrides
beezup.merchant: ChannelCategorySettings
Fields
- 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
- mappingLeafRequired boolean? - Indicates if the category mapping is required on category path leaf or not
beezup.merchant: ChannelColumn
The channel column
Fields
- channelColumnId BeezupCommonChannelcolumnid - The channel column identifier
- channelColumnName BeezupCommonChannelcolumnname - The channel column name
- channelColumnDescription ChannelColumnDescription? - The channel column description
- showInMapping ChannelColumnShowInMapping - Indicates if this column must shown in the mapping page or not
- position int - The position of the column starting from 1
- configuration ChannelColumnConfiguration - The channel column configuration. The BeezUP Column Name is optional. If the BeezUP column is mapped we will indicate the data type and column importance of the BeezUP column.
- restrictedValues ChannelColumnRestrictedValues? - The restricted values. The key will be the restricted value identifier (format:guid) and the value will be the restriced value
beezup.merchant: ChannelColumnConfiguration
The channel column configuration. The BeezUP Column Name is optional. If the BeezUP column is mapped we will indicate the data type and column importance of the BeezUP column.
Fields
- columnImportance BeezupCommonColumnimportance - Importance of the column
- columnDataType BeezupCommonColumndatatype - Data type of the column, will be used for parsing and for consolidation proces
- beezUPColumnName BeezupCommonBeezupcolumnname? - The BeezUP column name
beezup.merchant: ChannelColumnRestrictedValues
The restricted values. The key will be the restricted value identifier (format:guid) and the value will be the restriced value
beezup.merchant: ChannelCostSettings
Indicate the default configuration of the cost on this channel.
Fields
- costType CostType - CPC means cost per click. CPA means cost per action. You can have CPC/CPA with a global cost value. You can have CPC/CPA by category the cost value MUST be null You can have global fixed price.
- globalCostValue decimal? - In case of global cost type, you have to indicate the cost value.
beezup.merchant: ChannelFirstLevelCategory
The first level category with his sub categories
Fields
- channelCategoryId BeezupCommonChannelcategoryid -
- channelCategoryName string - The channel category name
- channelCategoryLevel ChannelCategoryLevel - The channel category level starting from 1
- channelCategoryDefaultCost ChannelCategoryDefaultCost? - The default cost on this channel category
- channelCategoryChannelCode ChannelCategoryChannelCode? - The channel category channel code identifier
- channelCategoryColumnOverrides ChannelCategoryColumnOverrides? - The channel category column overrides
- subCategories ChannelCategory[]? -
beezup.merchant: ChannelHeader
The available channel
Fields
- channelId BeezupCommonChannelid - The channel identifier
- channelName BeezupCommonChannelname - The channel name
- channelLogoUrl BeezupCommonHttpurl - The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>
- types string[] - The type list related to a channel
- links ChannelHeaderLinks - The links related to an available channel
beezup.merchant: ChannelHeaderLinks
The links related to an available channel
Fields
- self LinksGetchannelinfolink? -
beezup.merchant: ChannelInfo
Fields
- channelId BeezupCommonChannelid - The channel identifier
- channelName BeezupCommonChannelname - The channel name
- channelLogoUrl BeezupCommonHttpurl? - The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>
- channelDescription string? - Indicae a description to the channel
- beezUPOffer string? - Indicate the BeezUP offer
- salesContact ChannelinfoSalescontact? -
- details ChannelinfoDetails? -
- keyNumbers ChannelinfoKeynumbers? -
- technicalContact ChannelinfoTechnicalcontact? -
beezup.merchant: ChannelinfoDetails
Fields
- costs string? - The cost's description of the channel
- businessModel string? - The business model of the channel
- channelType string? - The channel type
- trackingType string? - The tracking type
- category string? - The channel category
- homeUrl string? - The home url of the channel
- subscriptionLink string? - The subscription link to the channel
beezup.merchant: ChannelinfoKeynumbers
Fields
- products string? - The estimated product count of the channel
- categories string? - The estimated category count of the channel
- stores string? - The estimated store count of the channel
- viewsPerMonth string? - The estimated view count per month of the channel
beezup.merchant: ChannelinfoSalescontact
Fields
- name string? - Indicate the BeezUP offer
- email string? - Indicate the sales contact email
- phoneNumber string? - The sales contact phone number
beezup.merchant: ChannelinfoTechnicalcontact
Fields
- name string? - The technical contact name
- phoneNumber string? - The technical contact phone number
- email string? - The technical contact email
beezup.merchant: ChannelRootCategory
Get channel first level category list
Fields
- firstLevelCategories ChannelFirstLevelCategory[] -
beezup.merchant: ClearMerchantOrderInfoListRequest
Fields
- orders OrderIdentifier[] -
beezup.merchant: ClickIncludedAndAdditionalClickPrice
Fields
- clickIncluded int? - The click included
- additionalClickPrice decimal? - The additional click price
beezup.merchant: ClickIncludedAndVariablePrice
Fields
- clickIncluded int? - Click included
- variablePrice decimal? - The pricing applied for this range
beezup.merchant: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
beezup.merchant: ColumnConfiguration
Indicates the configuration applied on the column (catalog or custom) during the importation process.
Fields
- beezUPColumnName BeezupCommonBeezupcolumnname? - The BeezUP column name
- columnImportance BeezupCommonColumnimportance - Importance of the column
- columnDataType BeezupCommonColumndatatype - Data type of the column, will be used for parsing and for consolidation proces
- columnCultureName ColumnCultureName? - 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? - 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
- canBeTruncated CanBeTruncated? - If the size of the value is greater than the limit we can truncate the value instead of failing...
- displayGroupName DisplayGroupName? - Indicate the display group name where the column must be putted
beezup.merchant: CompanyInfo
Fields
- address Address - Your address
- postalCode PostalCode - Your address postal code
- city City - Your address city
- countryIsoCodeAlpha3 BeezupCommonCountryisocodealpha3 - The country iso code alpha 3 <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">(ISO 3166-1_alpha-3)</a>
- company Company - Your company name
- vatNumber VatNumber? - Your company VATNumber. Used for french company. This number is checked with official web service before being saved.
- accountingEmails AccountingEmails? - Your company accounting emails
beezup.merchant: ComputeExpressionRequest
The request message to compute an expression based on the provided product values
Fields
- productValues ProductValues - The key is the column identifier
- encryptedExpression EncryptedExpression - The encrypted excel expression of the column
beezup.merchant: ConfigureAutoImportIntervalRequest
The message request to configure the auto import interval
Fields
- interval string - Indicate the interval in time span. (i.e. "04:00:00" for every 4 hours)
beezup.merchant: ConfigureAutomaticTransitionRequest
Fields
- automaticTransitions AutomaticTransition[] -
beezup.merchant: ConfigureCatalogColumnCatalogRequest
The request to configure a catalog column
Fields
- catalogColumn CatalogColumn - The catalog column configuration
beezup.merchant: ConfigureCategoryRequest
The request message to make a mapping between catalog category path and a channel category path
Fields
- overrideSubCategoryMappings 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
- channelCatalogCategories ChannelCatalogCategoryConfiguration[] -
beezup.merchant: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
beezup.merchant: ContractBillingPeriodInfo
Describe the billing period information related to the offer.
Fields
- amountBillingPeriodDiscount decimal? - The amount discounted related to the billing period
- billingPeriodPercentDiscount decimal? - The discount percent related to the billing period
- billingPeriodInMonth BillingPeriodInMonth? - Can be null. The billing period in month based on /billingPeriods
beezup.merchant: ContractBonusInfo
Describe the bonus information related to your current contract.
Fields
- bonuses BonusInfo[] -
beezup.merchant: ContractClickInfo
Describe the click information related to the offer.
Fields
- additionalClickPrice decimal? - The addition click price in the offer
- clickIncluded int? - The click included in the offer
- initialOfferClickIncluded int? - The click included in your current contract
beezup.merchant: ContractCommitmentInfo
Describe the commitment information related to the offer.
Fields
- commitmentCalculatedFinishDate string? - The commitment end date related to the offer
- newContractStartDate string? - The start date related to the offer
- commitmentPeriodInMonth int? - The commitment period in month related to the offer
- trialPeriodInMonth int? - The trial period in month related to the offer
- trialPeriodFinishDate string? - The trial period end date related to the offer
- paymentDelayInDays int? - The payment delay in days related to the offer
- offerId OfferId? - The offer id based on /offers. Not a free offer of course.
- offerName string? - The offer Name
- currentContractId string? - Your current contract id
- commercialUserId string? - Your current commercial user id
- model string? - Interal usage: Old offer type. The model description
- currentContractTerminationDate string? - The current contract termination date
- requestedPaymentMethod PaymentMethod? - Payment method
- currentCustomerPaymentMethod PaymentMethod? - Payment method
- contractType int? - Internal usage: Old offer type. Your contract type
- isModelMustBeTransmittedInNewContract boolean? - Internal usage: Old offer type. Is the current contract model needs to be converted into a new contract type
- fixedAndVariableClickInfo FixedAndVariableClickModelInfo? - Internal usage: Old offer type. Describe the fix and variable model information
- variableModelInfo VariableModelInfo? - Internal usage: Old offer type. Describe the fix and variable model information
- paymentMethodAuthorized PaymentMethod? - Payment method
- couponOfferCode CouponOfferCode? - Your special coupon offer identifier
- commercialCreatorUserId string? - The commercial that is responsible of the creation of your account
- minBillingPeriodInMonths int? - The minimum billing period in month authorized for this offer.
- isCustomerWantsToTerminateHisContract boolean? - If true, this means you want to leave us and that's sad... :'-(
beezup.merchant: ContractDiscountInfo
Describe the discount information related to the offer.
Fields
- amountCodePromoDiscountPerMonth decimal? - The amount discounted per month
- discountDurationInMonth int? - Duration of the discount in month
- percentDiscount decimal? - Percentage of the discount
- promotionalCodeValidity PromotionalCodeValidity? - Indicate the validaty of the discount
- amountCodePromoDiscount decimal? - The discount amount
- couponDiscountCode string? - The discount code
- couponDiscountId int? - Internal use: The discount id
- isCouponDiscountLinkedToCouponOffer boolean? - Is this discount is related to a coupon offer
- customerHasActualDiscount boolean? - Do you have currently a discount on your contract ?
beezup.merchant: ContractInfo
Describe the conditions of a contract
Fields
- trialPeriodInMonth int? - The trial period in month
- billingPeriodPercentDiscount decimal? - The percent discount related to the billing period
- discountDurationInMonth int? - The discount duration in month
- percentDiscount decimal? - The percent of the discount
- offerId OfferId? - The offer id based on /offers. Not a free offer of course.
- storeCount StoreCount? - The store count you want to have in your contract.
- startUtcDate string? - The start date of your contract
- commitmentCalculatedFinishUtcDate string? - The calculated end date of commitment
- billingPeriodInMonth int? - The billing period in month
- fixedPrice decimal? - The fixed price of your contract
- offerName string? - The offer name based on /offers
- currencyCode BeezupCommonCurrencycode? - The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>
- contractId ContractId? - Your contract identifier
- commitmentPeriodInMonth int? - The commitment period in month
- clickIncluded int? - The click included
- additionalClickPrice decimal? - Additional click price
- ipUserCreation string? - The IP of the user who creates the contract
- ipUserModification string? - The IP of the user who modified the contract
- fixedAndVariableClickInfo FixedAndVariableClickModelInfo? - Internal usage: Old offer type. Describe the fix and variable model information
- variableModelInfo VariableModelInfo? - Internal usage: Old offer type. Describe the fix and variable model information
- isCommitmentRenewalAutomatically boolean? - Is commitment is automatically renewed
- discountEndUtcDate string? - The end of your discount
- isModifiableContract boolean? - Is the contract is modifiable ?
beezup.merchant: ContractMoneyInfo
Describe the pricing information related to the offer.
Fields
- amountExcludingTaxesAndExcludingCodePromoDiscountIncludingBillingPeriodDiscount decimal? - The amount excluding taxes and excluding code promo discount including billing period discount.
- amountExcludingTaxesIncludingDiscounts decimal? - The amount excluding taxes including discounts.
- amountTaxesExcludingDiscountIncludingBillingPeriodDiscount decimal? - The taxes excluding discount including billing period discount.
- amountIncludingTaxesExcludingDiscountIncludingBillingPeriodDiscount decimal? - The amount including taxes excluding discount including billing period discount.
- currencyCode BeezupCommonCurrencycode? - The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>
- vatPercent decimal? - The VAT percent.
- amountExcludingTaxesIncludingDiscountsPerMonth decimal? - The amount excluding taxes including discounts per month.
- amountExcludingTaxesAndExcludingDiscounts decimal? - The amount excluding taxes and excluding discounts.
- amountTaxesIncludingDiscounts decimal? - Taxes including discounts.
- amountIncludingTaxesIncludingDiscounts decimal? - The amount including taxes including discounts.
- initialOfferFixedPrice decimal? - The initial offer fixed price.
beezup.merchant: Contracts
Fields
- links ContractsLinks -
- current CurrentContractInfo? -
- next NextContractInfo? -
beezup.merchant: ContractsLinks
Fields
- self LinksGetcontractslink? -
- create LinksCreatecontractlink? -
beezup.merchant: ContractStoreInfo
Describe the store information related to the offer.
Fields
- storeCount StoreCount? - The store count you want to have in your contract.
- maxStoreCount int? - The maximum store count related to the offer.
- minStoreCount int? - The minimum store count related to the offer.
- ownedStoreCount int? - The owned store count.
- additionalStorePrice decimal? - The additional store price.
- storeIncluded int? - The store count included in the offer.
beezup.merchant: CopyOptimisationRequest
Copy the optimisation between 2 channels
Fields
- channelIdSource BeezupCommonChannelid - The channel identifier
- channelIdTarget BeezupCommonChannelid - The channel identifier
- keepExistingOptimisation boolean - If true the existing optimisation will be kept
beezup.merchant: CopyOptimisationResponse
Products optimisatisation copied
Fields
- channel BeezupCommonChannelbasicinfo - The basic info related to a channel
- catalogProductCount int - The catalog product count
- enabledProductCount int - The enabled product count
beezup.merchant: CostSettings
If this property is not indicated please force the user to configure the cost settings. Defines the cost type you have on this channel with the cost value.
Fields
- costType CostType - CPC means cost per click. CPA means cost per action. You can have CPC/CPA with a global cost value. You can have CPC/CPA by category the cost value MUST be null You can have global fixed price.
- globalCostValue decimal? - In case of global cost type, you have to indicate the cost value.
beezup.merchant: CreateContractResponse
Fields
- links CreateContractResponseLinks? -
- info BeezupCommonInfosummaries? -
beezup.merchant: CreateContractResponseLinks
Fields
- self LinksCreatecontractlink? -
- contracts LinksGetcontractslink? -
beezup.merchant: CreateCustomColumnRequest
The request message to create a custom column
Fields
- userColumnName UserColumName - Column named by the user
- encryptedExpression EncryptedExpression - The encrypted excel expression of the column
- encryptedBlocklyExpression EncryptedBlocklyExpression - The encrypted XML Blockly representation of the expression
- displayGroupName DisplayGroupName - Indicate the display group name where the column must be putted
beezup.merchant: CreateRuleRequest
Fields
- optimisationActionName OptimisationActionName - The optimisation action
- ruleName string - The name of the rule
- reportFilterId string - The report filter to use for the rule
- startUtcDate string? - The start validity utc date of the rule
- endUtcDate string? - The end validity utc date of the rule
beezup.merchant: CreateStoreRequest
The request to create a store. The store identifier is optional, if null it will be automatically computed.
Fields
- id BeezupCommonStoreid? - The store identifier
- name StoreName - The store name. Must be unique.
- url StoreUrl - The url of your store
- countryIsoCodeAlpha3 StoreCountryIsoCodeAlpha3 - The country iso code alpha 3 based on the list of values /user/lov/StoreCountry
- sectors StoreSectors - The store's sectors based on the list of values /user/lov/ParamSector
beezup.merchant: CreateSubscriptionRequest
Fields
- targetUrl HttpUrl - The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>
- name SubscriptionName - The subscription name you want to use
- merchantApplicationName SubscriptionMerchantApplicationName - The name of your application
- merchantApplicationVersion SubscriptionMerchantApplicationVersion - The version of your application
- merchantEmailAlert Email? - The email
beezup.merchant: Credential
Provides the credentials
Fields
- userName string - The user name
- password string? - The password
beezup.merchant: CreditCardInfo
Fields
- cardNumber CardNumber - Card number
- cardVerificationCode CardVerificationCode - Card Verification Code
- expirationMonth ExpirationMonth - Expiration Month
- expirationYear ExpirationYear - Expiration Year
beezup.merchant: CreditCardInfoResponse
Fields
- links CreditCardInfoResponseLinks - The different actions you can make on this offer
- currentPaymentMethod PaymentMethod - Payment method
- creditCardInfo CreditCardInfoWithCardType? -
- info BeezupCommonInfosummaries? -
beezup.merchant: CreditCardInfoResponseLinks
The different actions you can make on this offer
Fields
- self LinksGetcreditcardinfolink -
- saveCreditCardInfo LinksSavecreditcardinfolink -
beezup.merchant: CreditCardInfoWithCardType
Fields
- cardNumber CardNumber - Card number
- expirationMonth ExpirationMonth - Expiration Month
- expirationYear ExpirationYear - Expiration Year
- cardType string - Your credit card type. Example: VISA, MasterCard, etc...
beezup.merchant: CurrentContractInfo
Fields
- Fields Included from *ContractInfo
- trialPeriodInMonth int
- billingPeriodPercentDiscount decimal
- discountDurationInMonth int
- percentDiscount decimal
- offerId OfferId
- storeCount StoreCount
- startUtcDate string
- commitmentCalculatedFinishUtcDate string
- billingPeriodInMonth int
- fixedPrice decimal
- offerName string
- currencyCode BeezupCommonCurrencycode
- contractId ContractId
- commitmentPeriodInMonth int
- clickIncluded int
- additionalClickPrice decimal
- ipUserCreation string
- ipUserModification string
- fixedAndVariableClickInfo FixedAndVariableClickModelInfo
- variableModelInfo VariableModelInfo
- isCommitmentRenewalAutomatically boolean
- discountEndUtcDate string
- isModifiableContract boolean
- anydata...
- links CurrentContractInfoLinks -
beezup.merchant: CurrentContractInfoLinks
Fields
- disable LinksTerminatecurrentcontractlink? -
- reenable LinksReactivatecurrentcontractlink? -
beezup.merchant: CustomColumn
The custom column configuration
Fields
- id ColumnId - The catalog column identifier
- userColumName UserColumName - Column named by the user
- configuration ColumnConfiguration - Indicates the configuration applied on the column (catalog or custom) during the importation process.
- catalogColumnDependencies CatalogColumnName[]? -
- links CustomColumnLinks -
beezup.merchant: CustomColumnLinks
Fields
- delete LinksCatalogDeletecustomcolumnlink -
- expression LinksCatalogGetcustomcolumnexpressionlink -
- saveExpression LinksCatalogChangecustomcolumnexpressionlink -
beezup.merchant: CustomColumnList
Fields
- links CustomColumnListLinks -
- customColumns CustomColumn[] -
beezup.merchant: CustomColumnListLinks
Fields
beezup.merchant: CustomerIndex
The index of the customer API
Fields
- links CustomerIndexLinks - Gives you want you can do on this API
- lovLinks CustomerIndexLovLinks -
beezup.merchant: CustomerIndexLinks
Gives you want you can do on this API
Fields
- self LinksGetcustomerindexlink -
- accountInfo LinksGetuseraccountinfolink -
- friendInfo LinksGetfriendinfolink -
- logout LinksLogoutlink? -
- stores LinksGetstoreslink? -
- billingPeriods LinksGetbillingperiodslink -
- standardOffers LinksGetstandardofferslink -
- getOffer LinksGetofferlink? -
- invoices LinksGetinvoiceslink? -
- contracts LinksGetcontractslink? -
beezup.merchant: CustomerIndexLovLinks
Fields
- offerLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- activeOfferLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- customerStatusLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- beezUPTimeZoneLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- storeCountryLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- storeSectorLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- countryLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- contractTerminationReasonLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
- invoicePaymentStatusLov BeezupCommonLovlink3? - Describe the way you have to follow to get access to the LOV
beezup.merchant: DetectedCatalogColumn
The catalog column detected during the first parsing step
Fields
- ignored boolean(default false) - IF true, the product values of this column will be not taken in account during the importation process
- duplicateProductValueConfiguration DuplicateProductValueConfiguration? - Describe how you want to manage the duplication of the product value
- id ColumnId - The catalog column identifier
- catalogColumnName CatalogColumnName - The catalog column name
- userColumName UserColumName - Column named by the user
- configuration ColumnConfiguration - Indicates the configuration applied on the column (catalog or custom) during the importation process.
- links DetectedCatalogColumnLinks -
beezup.merchant: DetectedCatalogColumnLinks
Fields
- configure LinksImportationConfigurecatalogcolumnlink? -
- ignore LinksImportationIgnorecolumnlink? -
- reattend LinksImportationReattendcolumnlink? -
beezup.merchant: DetectedCatalogColumnList
The list of detected catalog column
Fields
- links DetectedCatalogColumnListLinks -
- detectedCatalogColumns DetectedCatalogColumn[]? - Contains all deteted catalog columns
beezup.merchant: DetectedCatalogColumnListLinks
Fields
beezup.merchant: DuplicateProductValueConfiguration
Describe how you want to manage the duplication of the product value
Fields
- strategy DuplicateProductValueStrategy - Indicate the duplicate product sku strategy.
- compareOptions CompareOptions - Indicate how the product sku are compared for the duplication check.
beezup.merchant: ErrorResponseMessage
Fields
- errors UserErrorMessage[] -
beezup.merchant: ErrorResponseMessagePaymentRequired
Fields
- Fields Included from *BeezupCommonErrorresponsemessage
- errors BeezupCommonUsererrormessage[]
- anydata...
beezup.merchant: ErrorResponseMessagePaymentRequiredLinks
Fields
- offer LinksGetofferlink -
beezup.merchant: ErrorSummary
Fields
- utcDate string? -
- errorGuid string? -
- errorCode string? -
- errorMessage string? -
- technicalErrorMessage string? -
- exceptionDetail ExceptionDetail? -
- errorArguments record {}? -
- propertyName string? -
- propertyValue string? -
- objectName string? -
- 'source string? -
beezup.merchant: ExceptionDetail
Fields
- helpLink string? -
- message string? -
- stackTrace string? -
- 'type string? -
beezup.merchant: ExchangedMessagesItem
Fields
- operationName string -
- requestUri string? -
- responseUri string? -
- requestUtcDate string? -
- responseUtcDate string? -
beezup.merchant: ExclusionFilter
The exclusion filter
Fields
- name ExclusionFilterName - The exclusion filter name
- position int - The position of the exclusion filter
- groupId string - Indicate the filter's group. All filters in the same group means an "AND" operation in the filter group
- positionInGroup int - Indicate the filter group position. This information is used for the UI purpose and must be unique in the filter group.
- channelColumnId BeezupCommonChannelcolumnid - The channel column identifier
- operatorName FilterOperatorName - The exclusion filter operator name
- value string? - The value indicate by the user when the filter operation requires it.
- enabled boolean - indicates if the filter is currently enable.
beezup.merchant: ExclusionFiltersResponse
Fields
- links ExclusionFiltersResponseLinks -
- exclusionFilters ExclusionFilters? - The exclusion filter list
beezup.merchant: ExclusionFiltersResponseLinks
Fields
- configure LinksConfigurechannelcatalogexclusionfilterslink? -
beezup.merchant: ExportOrderListRequest
The message request to export order list. The store identifier is requested to regroup the exportations.
Fields
- format ExportOrderListFormat? - The type of the file to export
- storeId BeezupCommonStoreid - The store identifier
- orderListRequestWithoutPagination OrderListRequestWithoutPagination -
beezup.merchant: ExternallinksCatalogGetbeezupcolumnslink
Fields
- Fields Included from *BeezupCommonLink3
- label string
- docUrl BeezupCommonDocurl
- description string
- href BeezupCommonHref
- operationId BeezupCommonOperationid
- method BeezupCommonHttpmethod
- parameters record { anydata... }
- urlTemplated boolean
- allRequiredParamsProvided boolean
- allOptionalParamsProvided boolean
- info BeezupCommonInfosummaries
- anydata...
beezup.merchant: ExternallinksGetchannelcatalogmarketplacesettingslink
Fields
- Fields Included from *BeezupCommonLink3
- label string
- docUrl BeezupCommonDocurl
- description string
- href BeezupCommonHref
- operationId BeezupCommonOperationid
- method BeezupCommonHttpmethod
- parameters record { anydata... }
- urlTemplated boolean
- allRequiredParamsProvided boolean
- allOptionalParamsProvided boolean
- info BeezupCommonInfosummaries
- anydata...
beezup.merchant: ExternallinksGetchannelinfolink
Fields
- Fields Included from *BeezupCommonLink3
- label string
- docUrl BeezupCommonDocurl
- description string
- href BeezupCommonHref
- operationId BeezupCommonOperationid
- method BeezupCommonHttpmethod
- parameters record { anydata... }
- urlTemplated boolean
- allRequiredParamsProvided boolean
- allOptionalParamsProvided boolean
- info BeezupCommonInfosummaries
- anydata...
beezup.merchant: FilterOperator
The filter operator
Fields
- name FilterOperatorName? - The exclusion filter operator name
- expectedChannelColumnDataType FilterOperatorDataType? - Data type of the operator
- valueRequired boolean? - This operator requires a value
- expectedValueDataType FilterOperatorDataType? - Data type of the operator
beezup.merchant: FixedAndVariableClickModelInfo
Internal usage: Old offer type. Describe the fix and variable model information
Fields
- clickIncludedAndAdditionalClickPrices ClickIncludedAndAdditionalClickPrice[] -
beezup.merchant: Functionality
Fields
- code string - The functionality code
- 'order int - UI purpose: Indicate the position of the functionality
beezup.merchant: FunctionalityRightInfo
Describe the rights for a functionality
Fields
- functionalityCode string - The functionality code
- maxValueInterger int? - The max value for this functionality code considering your rights
- unlimited boolean? - If you can use this functionality unlimitedly
beezup.merchant: GeneralSettings
Represents the general settings of your channel catalog
Fields
- acceptToPublishInfo boolean - If true then you authorize disclosure of my statistics generated from clicks and sales
- doNotExportOutOfStockProducts boolean - Do not export "out of stock" products. Note: this option is not taken into account by the counter.
- activeBeezUPTracking