Module sap.commerce.webservices
ballerinax/sap.commerce.webservices Ballerina library
0.9.0
Overview
SAP Commerce Cloud is a comprehensive e-commerce platform that enables businesses to deliver personalized, omnichannel shopping experiences across all touchpoints, from web and mobile to social and in-store interactions.
The ballerinax/sap.commerce.webservices package offers APIs to connect and interact with SAP Commerce Cloud API endpoints, specifically based on SAP Commerce Web Services API v2.
Setup guide
To use the SAP Commerce Web Services connector, you must have access to SAP Commerce Cloud (formerly SAP Hybris) through a valid SAP account and configure OAuth2 authentication credentials. If you do not have an SAP account, you can sign up for one here and explore SAP Commerce Cloud solutions at the SAP Commerce Cloud portal.
Step 1: Create an SAP Account and Access SAP Commerce Cloud
-
Navigate to the SAP website and sign up for an account or log in if you already have one.
-
Ensure you have access to SAP Commerce Cloud, which typically requires a licensed subscription or access through SAP's cloud platform services.
Step 2: Configure OAuth2 Client Credentials
-
Log in to your SAP Commerce Cloud administration console (Backoffice or HAC - Hybris Administration Console).
-
Navigate to System > OAuth > OAuth Client Details or access the OAuth configuration through the Platform > Configuration menu.
-
Create a new OAuth client or modify an existing one by providing the necessary client ID and client secret for your application.
-
Configure the appropriate scopes and grant types (typically "client_credentials" for API access) based on your integration requirements.
Tip: You must copy and store the client secret somewhere safe. It won't be visible again in your configuration settings for security reasons.
Quickstart
To use the SAP Commerce Web Services connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerina/oauth2; import ballerinax/sap.commerce.webservices as sapcommerce;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile with your credentials:
clientId = "<Your_Client_Id>" clientSecret = "<Your_Client_Secret>" refreshToken = "<Your_Refresh_Token>"
- Create a
sapcommerce:ConnectionConfigand initialize the client:
configurable string clientId = ?; configurable string clientSecret = ?; configurable string refreshToken = ?; final sapcommerce:Client sapcommerceClient = check new({ auth: { clientId, clientSecret, refreshToken } });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Create a new cost center
public function main() returns error? { sapcommerce:B2BCostCenter newCostCenter = { code: "CC001", name: "Marketing Cost Center", activeFlag: true, currency: { isocode: "USD", name: "US Dollar" } }; sapcommerce:B2BCostCenter response = check sapcommerceClient->createCostCenter("electronics", newCostCenter); }
Step 4: Run the Ballerina application
bal run
Examples
The sap.commerce.webservices connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Procurement cost center setup - Demonstrates how to configure and manage procurement cost centers using the SAP Commerce Web Services connector.
- Catalog inventory management - Illustrates managing product catalogs and inventory levels through SAP Commerce Web Services.
- Support ticket management - Shows how to create, update, and track customer support tickets using the connector.
- Customer service workflow - Demonstrates automating customer service processes and workflows through SAP Commerce Web Services.
Clients
sap.commerce.webservices: Client
Isolated
Manages all of the common commerce functionality, and also includes customizations from installed AddOns. The implementing extension is called commercewebservices.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "http://localhost:9001/occ/v2" - URL of the target service
getBaseSites
Isolated FunctionRemote Function
function getBaseSites(map<string|string[]> headers, *GetBaseSitesQueries queries) returns BaseSiteList|xml|errorRetrieves the base sites.
Parameters
- queries *GetBaseSitesQueries - Queries to be sent with the request
Return Type
- BaseSiteList|xml|error - OK
getAccessCodePublicKey
Isolated FunctionRemote Function
function getAccessCodePublicKey(string baseSiteId, map<string|string[]> headers) returns SAPAccessCodePublicKey|errorRetrieves the public key to verify the access code.
Parameters
- baseSiteId string - Base site identifier
Return Type
getBaseStore
Isolated FunctionRemote Function
function getBaseStore(string baseSiteId, string baseStoreUid, map<string|string[]> headers, *GetBaseStoreQueries queries) returns BaseStore|xml|errorRetrieves a base store.
Parameters
- baseSiteId string - Base site identifier
- baseStoreUid string - Base store identifier
- queries *GetBaseStoreQueries - Queries to be sent with the request
getCardTypes
Isolated FunctionRemote Function
function getCardTypes(string baseSiteId, map<string|string[]> headers, *GetCardTypesQueries queries) returns CardTypeList|xml|errorRetrieves a list of supported payment card types.
Parameters
- baseSiteId string - Base site identifier
- queries *GetCardTypesQueries - Queries to be sent with the request
Return Type
- CardTypeList|xml|error - OK
getCatalogs
Isolated FunctionRemote Function
function getCatalogs(string baseSiteId, map<string|string[]> headers, *GetCatalogsQueries queries) returns CatalogList|xml|errorRetrieves a list of catalogs.
Parameters
- baseSiteId string - Base site identifier
- queries *GetCatalogsQueries - Queries to be sent with the request
Return Type
- CatalogList|xml|error - OK
getCatalog
Isolated FunctionRemote Function
function getCatalog(string baseSiteId, string catalogId, map<string|string[]> headers, *GetCatalogQueries queries) returns Catalog|xml|errorRetrieves a catalog.
Parameters
- baseSiteId string - Base site identifier
- catalogId string - Catalog identifier
- queries *GetCatalogQueries - Queries to be sent with the request
getCatalogVersion
Isolated FunctionRemote Function
function getCatalogVersion(string baseSiteId, string catalogId, string catalogVersionId, map<string|string[]> headers, *GetCatalogVersionQueries queries) returns CatalogVersion|xml|errorRetrieves information about the catalog version.
Parameters
- baseSiteId string - Base site identifier
- catalogId string - Catalog identifier
- catalogVersionId string - Catalog version identifier
- queries *GetCatalogVersionQueries - Queries to be sent with the request
Return Type
- CatalogVersion|xml|error - OK
getCategories
Isolated FunctionRemote Function
function getCategories(string baseSiteId, string catalogId, string catalogVersionId, string categoryId, map<string|string[]> headers, *GetCategoriesQueries queries) returns CategoryHierarchy|xml|errorRetrieves information about the category.
Parameters
- baseSiteId string - Base site identifier
- catalogId string - Catalog identifier
- catalogVersionId string - Catalog version identifier
- categoryId string - Category identifier
- queries *GetCategoriesQueries - Queries to be sent with the request
Return Type
- CategoryHierarchy|xml|error - OK
getProductsByCategory
Isolated FunctionRemote Function
function getProductsByCategory(string baseSiteId, string categoryId, map<string|string[]> headers, *GetProductsByCategoryQueries queries) returns ProductSearchPage|xml|errorRetrieves a list of products for a category.
Parameters
- baseSiteId string - Base site identifier
- categoryId string - Category identifier
- queries *GetProductsByCategoryQueries - Queries to be sent with the request
Return Type
- ProductSearchPage|xml|error - OK
getProductConfiguration
Isolated FunctionRemote Function
function getProductConfiguration(string baseSiteId, string configId, map<string|string[]> headers, *GetProductConfigurationQueries queries) returns CCPConfiguration|xml|errorGets a product configuration
Parameters
- baseSiteId string - Base site identifier
- configId string - Configuration identifier
- queries *GetProductConfigurationQueries - Queries to be sent with the request
Return Type
- CCPConfiguration|xml|error - OK
updateProductConfiguration
Isolated FunctionRemote Function
function updateProductConfiguration(string baseSiteId, string configId, CCPConfiguration payload, map<string|string[]> headers, *UpdateProductConfigurationQueries queries) returns CCPConfiguration|xml|errorUpdates a product configuration
Parameters
- baseSiteId string - Base site identifier
- configId string - Configuration identifier
- payload CCPConfiguration - Request body for updating product configuration
- queries *UpdateProductConfigurationQueries - Queries to be sent with the request
Return Type
- CCPConfiguration|xml|error - OK
getProductConfigurationOverview
Isolated FunctionRemote Function
function getProductConfigurationOverview(string baseSiteId, string configId, map<string|string[]> headers) returns CCPConfigurationOverview|xml|errorGets a product configuration overview
Return Type
updateProductConfigurationOverview
Isolated FunctionRemote Function
function updateProductConfigurationOverview(string baseSiteId, string configId, CCPConfigurationOverview payload, map<string|string[]> headers) returns CCPConfigurationOverview|xml|errorUpdates the product configuration overview
Parameters
- baseSiteId string - Base site identifier
- configId string - Configuration identifier
- payload CCPConfigurationOverview - Request body for updating product configuration overview
Return Type
getProductConfigurationPricing
Isolated FunctionRemote Function
function getProductConfigurationPricing(string baseSiteId, string configId, map<string|string[]> headers, *GetProductConfigurationPricingQueries queries) returns CCPConfigurationPricing|xml|errorGets prices for a product configuration
Parameters
- baseSiteId string - Base site identifier
- configId string - Configuration identifier
- queries *GetProductConfigurationPricingQueries - Queries to be sent with the request
Return Type
getProductConfigurationVariantSearch
Isolated FunctionRemote Function
function getProductConfigurationVariantSearch(string baseSiteId, string configId, map<string|string[]> headers) returns xml|errorGets variants for a product configuration
getDistricts
Isolated FunctionRemote Function
function getDistricts(string baseSiteId, string cityId, map<string|string[]> headers) returns DistrictList|xml|errorRetrieves a list of districts for a city.
Return Type
- DistrictList|xml|error - OK
getComponentsByIds
DeprecatedIsolated FunctionRemote Function
function getComponentsByIds(string baseSiteId, map<string|string[]> headers, *GetComponentsByIdsQueries queries) returns ComponentList|xml|errorRetrieves the component data.
Parameters
- baseSiteId string - Base site identifier
- queries *GetComponentsByIdsQueries - Queries to be sent with the request
Return Type
- ComponentList|xml|error - ComponentIDListWsDTO
Deprecated
searchComponentsByIds
DeprecatedIsolated FunctionRemote Function
function searchComponentsByIds(string baseSiteId, ComponentIDList payload, map<string|string[]> headers, *SearchComponentsByIdsQueries queries) returns ComponentList|xml|errorRetrieves the component data.
Parameters
- baseSiteId string - Base site identifier
- payload ComponentIDList - Request body with component IDs to search
- queries *SearchComponentsByIdsQueries - Queries to be sent with the request
Return Type
- ComponentList|xml|error - ComponentIDListWsDTO
Deprecated
getComponentById
DeprecatedIsolated FunctionRemote Function
function getComponentById(string baseSiteId, string componentId, map<string|string[]> headers, *GetComponentByIdQueries queries) returns Component|xml|errorRetrieves the component data.
Parameters
- baseSiteId string - Base site identifier
- componentId string - Component identifier
- queries *GetComponentByIdQueries - Queries to be sent with the request
Deprecated
getPage
DeprecatedIsolated FunctionRemote Function
function getPage(string baseSiteId, map<string|string[]> headers, *GetPageQueries queries) returns CMSPage|xml|errorRetrieves the page data and the CMS content slots.
Parameters
- baseSiteId string - Base site identifier
- queries *GetPageQueries - Queries to be sent with the request
Deprecated
getPageById
DeprecatedIsolated FunctionRemote Function
function getPageById(string baseSiteId, string pageId, map<string|string[]> headers, *GetPageByIdQueries queries) returns CMSPage|xml|errorRetrieves the page data and CMS content slots using the page identifier.
Parameters
- baseSiteId string - Base site identifier
- pageId string - Page Id
- queries *GetPageByIdQueries - Queries to be sent with the request
Deprecated
getAllPages
DeprecatedIsolated FunctionRemote Function
function getAllPages(string baseSiteId, map<string|string[]> headers, *GetAllPagesQueries queries) returns CMSPageList|xml|errorRetrieves the page data.
Parameters
- baseSiteId string - Base site identifier
- queries *GetAllPagesQueries - Queries to be sent with the request
Return Type
- CMSPageList|xml|error - CMSPageListWsDTO
Deprecated
getActiveCostCenters
Isolated FunctionRemote Function
function getActiveCostCenters(string baseSiteId, map<string|string[]> headers, *GetActiveCostCentersQueries queries) returns B2BCostCenterList|xml|errorRetrieves active cost centers.
Parameters
- baseSiteId string - Base site identifier
- queries *GetActiveCostCentersQueries - Queries to be sent with the request
Return Type
- B2BCostCenterList|xml|error - OK
createCostCenter
Isolated FunctionRemote Function
function createCostCenter(string baseSiteId, B2BCostCenter payload, map<string|string[]> headers, *CreateCostCenterQueries queries) returns B2BCostCenter|errorCreates a cost center.
Parameters
- baseSiteId string - Base site identifier
- payload B2BCostCenter - Request body for creating cost center
- queries *CreateCostCenterQueries - Queries to be sent with the request
Return Type
- B2BCostCenter|error - Created
getCostCenter
Isolated FunctionRemote Function
function getCostCenter(string baseSiteId, string costCenterCode, map<string|string[]> headers, *GetCostCenterQueries queries) returns B2BCostCenter|xml|errorRetrieves the cost center.
Parameters
- baseSiteId string - Base site identifier
- costCenterCode string - Cost center identifier
- queries *GetCostCenterQueries - Queries to be sent with the request
Return Type
- B2BCostCenter|xml|error - OK
updateCostCenter
Isolated FunctionRemote Function
function updateCostCenter(string baseSiteId, string costCenterCode, B2BCostCenter payload, map<string|string[]> headers, *UpdateCostCenterQueries queries) returns B2BCostCenter|errorUpdates the cost center.
Parameters
- baseSiteId string - Base site identifier
- costCenterCode string - Cost center identifier
- payload B2BCostCenter - Request body for updating cost center
- queries *UpdateCostCenterQueries - Queries to be sent with the request
Return Type
- B2BCostCenter|error - OK
getBudgetsForCostCenter
Isolated FunctionRemote Function
function getBudgetsForCostCenter(string baseSiteId, string costCenterCode, map<string|string[]> headers, *GetBudgetsForCostCenterQueries queries) returns BudgetList|errorRetrieves all budgets and certain budgets associated with the specified cost center.
Parameters
- baseSiteId string - Base site identifier
- costCenterCode string - Cost center identifier
- queries *GetBudgetsForCostCenterQueries - Queries to be sent with the request
Return Type
- BudgetList|error - OK
doAddBudgetToCostCenter
Isolated FunctionRemote Function
function doAddBudgetToCostCenter(string baseSiteId, string costCenterCode, map<string|string[]> headers, *DoAddBudgetToCostCenterQueries queries) returns B2BSelectionData|errorCreates a budget for the cost center.
Parameters
- baseSiteId string - Base site identifier
- costCenterCode string - Cost center to which the budget will be added
- queries *DoAddBudgetToCostCenterQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
removeBudgetFromCostCenter
Isolated FunctionRemote Function
function removeBudgetFromCostCenter(string baseSiteId, string budgetCode, string costCenterCode, map<string|string[]> headers, *RemoveBudgetFromCostCenterQueries queries) returns B2BSelectionData|errorDeletes the budget from a cost center.
Parameters
- baseSiteId string - Base site identifier
- budgetCode string - Budget that will be removed from a specific cost center
- costCenterCode string - Cost center from which the budget will be removed
- queries *RemoveBudgetFromCostCenterQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
getCostCenters
Isolated FunctionRemote Function
function getCostCenters(string baseSiteId, map<string|string[]> headers, *GetCostCentersQueries queries) returns B2BCostCenterList|errorRetrieves the cost centers.
Parameters
- baseSiteId string - Base site identifier
- queries *GetCostCentersQueries - Queries to be sent with the request
Return Type
- B2BCostCenterList|error - OK
getCountries
Isolated FunctionRemote Function
function getCountries(string baseSiteId, map<string|string[]> headers, *GetCountriesQueries queries) returns CountryList|xml|errorRetrieves a list of countries.
Parameters
- baseSiteId string - Base site identifier
- queries *GetCountriesQueries - Queries to be sent with the request
Return Type
- CountryList|xml|error - OK
getCountryRegions
Isolated FunctionRemote Function
function getCountryRegions(string baseSiteId, string countyIsoCode, map<string|string[]> headers, *GetCountryRegionsQueries queries) returns RegionList|xml|errorRetrieves a list of regions.
Parameters
- baseSiteId string - Base site identifier
- countyIsoCode string - An ISO code for a country
- queries *GetCountryRegionsQueries - Queries to be sent with the request
Return Type
- RegionList|xml|error - OK
updateCpqAttribute
Isolated FunctionRemote Function
function updateCpqAttribute(Signed32 attributeCode, string baseSiteId, string configurationId, SAPCPQConfigurationChangeAttributeValue payload, map<string|string[]> headers, *UpdateCpqAttributeQueries queries) returns SAPCPQConfiguration|errorUpdates the CPQ attribute
Parameters
- attributeCode Signed32 - Standard attribute code
- baseSiteId string - Base site identifier
- configurationId string - Configuration identifier
- payload SAPCPQConfigurationChangeAttributeValue - Request body for updating CPQ attribute value
- queries *UpdateCpqAttributeQueries - Queries to be sent with the request
Return Type
- SAPCPQConfiguration|error - OK
updateCpqAttributeValueQuantity
Isolated FunctionRemote Function
function updateCpqAttributeValueQuantity(Signed32 attributeCode, Signed32 attributeValueId, string baseSiteId, string configurationId, SAPCPQConfigurationChangeAttributeValueQuantity payload, map<string|string[]> headers, *UpdateCpqAttributeValueQuantityQueries queries) returns SAPCPQConfiguration|errorUpdates the quantity of the CPQ attribute value
Parameters
- attributeCode Signed32 - Standard attribute code
- attributeValueId Signed32 - Attribute value identifier
- baseSiteId string - Base site identifier
- configurationId string - Configuration identifier
- payload SAPCPQConfigurationChangeAttributeValueQuantity - Request body for updating CPQ attribute value quantity
- queries *UpdateCpqAttributeValueQuantityQueries - Queries to be sent with the request
Return Type
- SAPCPQConfiguration|error - OK
readCpqConfiguration
Isolated FunctionRemote Function
function readCpqConfiguration(string baseSiteId, string configurationId, map<string|string[]> headers, *ReadCpqConfigurationQueries queries) returns SAPCPQConfiguration|errorRetrieves a configuration tab.
Parameters
- baseSiteId string - Base site identifier
- configurationId string - Configuration identifier
- queries *ReadCpqConfigurationQueries - Queries to be sent with the request
Return Type
- SAPCPQConfiguration|error - OK
readCpqConfigurationOverview
Isolated FunctionRemote Function
function readCpqConfigurationOverview(string baseSiteId, string configurationId, map<string|string[]> headers) returns SAPCPQConfiguration|errorRetrieves CPQ configuration overview.
Return Type
- SAPCPQConfiguration|error - OK
getCurrencies
Isolated FunctionRemote Function
function getCurrencies(string baseSiteId, map<string|string[]> headers, *GetCurrenciesQueries queries) returns CurrencyList|xml|errorRetrieves a list of available currencies.
Parameters
- baseSiteId string - Base site identifier
- queries *GetCurrenciesQueries - Queries to be sent with the request
Return Type
- CurrencyList|xml|error - OK
getCustomerGroups
Isolated FunctionRemote Function
function getCustomerGroups(string baseSiteId, map<string|string[]> headers, *GetCustomerGroupsQueries queries) returns UserGroupList|xml|errorRetrieves the subgroups of a customer group.
Parameters
- baseSiteId string - Base site identifier
- queries *GetCustomerGroupsQueries - Queries to be sent with the request
Return Type
- UserGroupList|xml|error - OK
createCustomerGroup
Isolated FunctionRemote Function
function createCustomerGroup(string baseSiteId, UserGroup payload, map<string|string[]> headers) returns error?Creates a new customer group.
Parameters
- baseSiteId string - Base site identifier
- payload UserGroup - Request body for creating customer group
Return Type
- error? - Created
getCustomerGroup
Isolated FunctionRemote Function
function getCustomerGroup(string baseSiteId, string groupId, map<string|string[]> headers, *GetCustomerGroupQueries queries) returns UserGroup|xml|errorRetrieves a customer group.
Parameters
- baseSiteId string - Base site identifier
- groupId string - Group identifier
- queries *GetCustomerGroupQueries - Queries to be sent with the request
replaceUsersForCustomerGroup
Isolated FunctionRemote Function
function replaceUsersForCustomerGroup(string baseSiteId, string groupId, MemberList payload, map<string|string[]> headers) returns error?Sets members for a user group.
Parameters
- baseSiteId string - Base site identifier
- groupId string - Group identifier.
- payload MemberList - Request body with member list
Return Type
- error? - OK
updateCustomerGroupWithUsers
Isolated FunctionRemote Function
function updateCustomerGroupWithUsers(string baseSiteId, string groupId, MemberList payload, map<string|string[]> headers) returns error?Assigns members to a customer group.
Parameters
- baseSiteId string - Base site identifier
- groupId string - Group identifier.
- payload MemberList - Request body with member list
Return Type
- error? - OK
removeUsersFromCustomerGroup
Isolated FunctionRemote Function
function removeUsersFromCustomerGroup(string baseSiteId, string groupId, string userId, map<string|string[]> headers) returns error?Deletes the customer from a customer group.
Parameters
- baseSiteId string - Base site identifier
- groupId string - Group identifier
- userId string - User identifier or one of the literals: ‘current’ for currently authenticated user, ‘anonymous’ for anonymous user
Return Type
- error? - OK
getDeliveryCountries
DeprecatedIsolated FunctionRemote Function
function getDeliveryCountries(string baseSiteId, map<string|string[]> headers, *GetDeliveryCountriesQueries queries) returns CountryList|xml|errorRetrieves a list of shipping countries.
Parameters
- baseSiteId string - Base site identifier
- queries *GetDeliveryCountriesQueries - Queries to be sent with the request
Return Type
- CountryList|xml|error - OK
Deprecated
getExportedProducts
Isolated FunctionRemote Function
function getExportedProducts(string baseSiteId, map<string|string[]> headers, *GetExportedProductsQueries queries) returns ProductList|xml|errorRetrieves a list of exported products.
Parameters
- baseSiteId string - Base site identifier
- queries *GetExportedProductsQueries - Queries to be sent with the request
Return Type
- ProductList|xml|error - OK
getOrderStatusFeed
Isolated FunctionRemote Function
function getOrderStatusFeed(string baseSiteId, map<string|string[]> headers, *GetOrderStatusFeedQueries queries) returns OrderStatusUpdateElementList|xml|errorRetrieves a list of orders with status updates.
Parameters
- baseSiteId string - Base site identifier
- queries *GetOrderStatusFeedQueries - Queries to be sent with the request
Return Type
doRestorePassword
DeprecatedIsolated FunctionRemote Function
function doRestorePassword(string baseSiteId, map<string|string[]> headers, *DoRestorePasswordQueries queries) returns error?Creates a token to restore a forgotten password.
Parameters
- baseSiteId string - Base site identifier
- queries *DoRestorePasswordQueries - Queries to be sent with the request
Return Type
- error? - Accepted
Deprecated
doHandleMerchantCallback
Isolated FunctionRemote Function
Validates the decision of the merchant.
Parameters
- baseSiteId string - Base site identifier
Return Type
- error? - OK
doHandleCartMerchantCallback
Isolated FunctionRemote Function
function doHandleCartMerchantCallback(string baseSiteId, string cartId, string userId, map<string|string[]> headers) returns error?Validates the decision of the merchant for a SOP payment related to a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getLanguages
Isolated FunctionRemote Function
function getLanguages(string baseSiteId, map<string|string[]> headers, *GetLanguagesQueries queries) returns LanguageList|xml|errorRetrieves a list of available languages.
Parameters
- baseSiteId string - Base site identifier
- queries *GetLanguagesQueries - Queries to be sent with the request
Return Type
- LanguageList|xml|error - OK
sendMessage
Isolated FunctionRemote Function
function sendMessage(string baseSiteId, ConversationMessageList payload, map<string|string[]> headers) returns Conversation|xml|errorSends a message.
Parameters
- baseSiteId string - Base site identifier
- payload ConversationMessageList - Request body with conversation message list
Return Type
- Conversation|xml|error - OK
getConversationsForAgent
Isolated FunctionRemote Function
function getConversationsForAgent(string baseSiteId, map<string|string[]> headers, *GetConversationsForAgentQueries queries) returns ConversationList|xml|errorRetrieves the unassigned or open conversations.
Parameters
- baseSiteId string - Base site identifier
- queries *GetConversationsForAgentQueries - Queries to be sent with the request
Return Type
- ConversationList|xml|error - OK
getConversationsForCustomer
Isolated FunctionRemote Function
function getConversationsForCustomer(string baseSiteId, map<string|string[]> headers) returns ConversationList|xml|errorRetrieves the conversations.
Parameters
- baseSiteId string - Base site identifier
Return Type
- ConversationList|xml|error - OK
closeConversation
Isolated FunctionRemote Function
function closeConversation(string baseSiteId, string conversationId, map<string|string[]> headers) returns Conversation|xml|errorCloses an open conversation.
Return Type
- Conversation|xml|error - OK
getMessagesForConversation
Isolated FunctionRemote Function
function getMessagesForConversation(string baseSiteId, string conversationId, map<string|string[]> headers) returns ConversationMessageList|xml|errorRetrieves the messages of a specific conversation.
Return Type
pickConversation
Isolated FunctionRemote Function
function pickConversation(string baseSiteId, string conversationId, map<string|string[]> headers) returns Conversation|xml|errorPicks an unassigned conversation.
Return Type
- Conversation|xml|error - OK
getOrderApprovalPermissionTypes
Isolated FunctionRemote Function
function getOrderApprovalPermissionTypes(string baseSiteId, map<string|string[]> headers, *GetOrderApprovalPermissionTypesQueries queries) returns OrderApprovalPermissionTypeList|errorRetrieves the order approval permission types.
Parameters
- baseSiteId string - Base site identifier
- queries *GetOrderApprovalPermissionTypesQueries - Queries to be sent with the request
Return Type
retrieveAllOrderForms
Isolated FunctionRemote Function
function retrieveAllOrderForms(string baseSiteId, map<string|string[]> headers, *RetrieveAllOrderFormsQueries queries) returns OrderFormList|xml|errorRetrieves all order forms.
Parameters
- baseSiteId string - Base site identifier
- queries *RetrieveAllOrderFormsQueries - Queries to be sent with the request
Return Type
- OrderFormList|xml|error - OK
createAnOrderForm
Isolated FunctionRemote Function
function createAnOrderForm(string baseSiteId, OrderForm payload, map<string|string[]> headers) returns error?Creates an order form.
Parameters
- baseSiteId string - Base site identifier
- payload OrderForm - Request body for creating order form
Return Type
- error? - Created
retrieveAnOrderForm
Isolated FunctionRemote Function
function retrieveAnOrderForm(string baseSiteId, string orderFormCode, map<string|string[]> headers, *RetrieveAnOrderFormQueries queries) returns OrderForm|xml|errorRetrieves an order form.
Parameters
- baseSiteId string - Base site identifier
- orderFormCode string - The order form identifier. Example: 0000000
- queries *RetrieveAnOrderFormQueries - Queries to be sent with the request
updateAnOrderForm
Isolated FunctionRemote Function
function updateAnOrderForm(string baseSiteId, string orderFormCode, OrderForm payload, map<string|string[]> headers, *UpdateAnOrderFormQueries queries) returns OrderForm|xml|errorUpdates an order form.
Parameters
- baseSiteId string - Base site identifier
- orderFormCode string - The order form identifier. Example: 0000000
- payload OrderForm - Request body for updating order form
- queries *UpdateAnOrderFormQueries - Queries to be sent with the request
deleteAnOrderForm
Isolated FunctionRemote Function
function deleteAnOrderForm(string baseSiteId, string orderFormCode, map<string|string[]> headers) returns error?Deletes an order form.
Parameters
- baseSiteId string - Base site identifier
- orderFormCode string - The order form identifier. Example: 0000000
Return Type
- error? - No Content
addOrderFormToCart
Isolated FunctionRemote Function
function addOrderFormToCart(string baseSiteId, string orderFormCode, map<string|string[]> headers, *AddOrderFormToCartQueries queries) returns error?Adds products in an order form to the current cart.
Parameters
- baseSiteId string - Base site identifier
- orderFormCode string - The order form identifier. Example: 0000000
- queries *AddOrderFormToCartQueries - Queries to be sent with the request
Return Type
- error? - No Content
getOrder
Isolated FunctionRemote Function
function getOrder(string baseSiteId, string code, map<string|string[]> headers, *GetOrderQueries queries) returns Order|xml|errorRetrieves the order.
Parameters
- baseSiteId string - Base site identifier
- code string - Order GUID or order code
- queries *GetOrderQueries - Queries to be sent with the request
getOrgProduct
Isolated FunctionRemote Function
function getOrgProduct(string baseSiteId, string productCode, map<string|string[]> headers, *GetOrgProductQueries queries) returns Product|xml|errorRetrieves product details.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- queries *GetOrgProductQueries - Queries to be sent with the request
createRegistrationRequest
Isolated FunctionRemote Function
function createRegistrationRequest(string baseSiteId, OrgUserRegistrationData payload, CreateRegistrationRequestHeaders headers, *CreateRegistrationRequestQueries queries) returns error?Creates a registration request for a B2B customer.
Parameters
- baseSiteId string - Base site identifier
- payload OrgUserRegistrationData - Request body with organization user registration data
- headers CreateRegistrationRequestHeaders (default {}) - Headers to be sent with the request
- queries *CreateRegistrationRequestQueries - Queries to be sent with the request
Return Type
- error? - Created
getOrgUser
Isolated FunctionRemote Function
function getOrgUser(string baseSiteId, string userId, map<string|string[]> headers, *GetOrgUserQueries queries) returns User|xml|errorRetrieves a B2B customer profile.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUserQueries - Queries to be sent with the request
createCartFromOrder
Isolated FunctionRemote Function
function createCartFromOrder(string baseSiteId, string userId, map<string|string[]> headers, *CreateCartFromOrderQueries queries) returns CartModificationList|xml|errorCreates a cart from a previous order.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *CreateCartFromOrderQueries - Queries to be sent with the request
Return Type
- CartModificationList|xml|error - Created
replaceOrgCartDeliveryAddress
Isolated FunctionRemote Function
function replaceOrgCartDeliveryAddress(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceOrgCartDeliveryAddressQueries queries) returns Cart|xml|errorUpdates the delivery address for a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceOrgCartDeliveryAddressQueries - Queries to be sent with the request
replaceOrgCartEntries
Isolated FunctionRemote Function
function replaceOrgCartEntries(string baseSiteId, string cartId, string userId, OrderEntryList payload, map<string|string[]> headers, *ReplaceOrgCartEntriesQueries queries) returns CartModificationList|xml|errorUpdates the quantity of the specified products in a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntryList - Request body with order entry list
- queries *ReplaceOrgCartEntriesQueries - Queries to be sent with the request
Return Type
- CartModificationList|xml|error - OK
doAddOrgCartEntries
Isolated FunctionRemote Function
function doAddOrgCartEntries(string baseSiteId, string cartId, string userId, OrderEntryList payload, map<string|string[]> headers, *DoAddOrgCartEntriesQueries queries) returns CartModificationList|xml|errorCreates additional quantity of a product in the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntryList - Request body with order entry list
- queries *DoAddOrgCartEntriesQueries - Queries to be sent with the request
Return Type
- CartModificationList|xml|error - OK
placeOrgOrder
Isolated FunctionRemote Function
function placeOrgOrder(string baseSiteId, string userId, map<string|string[]> headers, *PlaceOrgOrderQueries queries) returns Order|xml|errorCreates a B2B order.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *PlaceOrgOrderQueries - Queries to be sent with the request
getUserBranchOrderHistory
Isolated FunctionRemote Function
function getUserBranchOrderHistory(string baseSiteId, string userId, map<string|string[]> headers, *GetUserBranchOrderHistoryQueries queries) returns OrderHistoryList|xml|errorRetrieves the order history for the customer's organization branch.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserBranchOrderHistoryQueries - Queries to be sent with the request
Return Type
- OrderHistoryList|xml|error - OK
getBranchOrder
Isolated FunctionRemote Function
function getBranchOrder(string baseSiteId, string code, string userId, map<string|string[]> headers, *GetBranchOrderQueries queries) returns Order|xml|errorRetrieves the order from the customer's organization branch.
Parameters
- baseSiteId string - Base site identifier
- code string - Order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetBranchOrderQueries - Queries to be sent with the request
createReplenishmentOrder
Isolated FunctionRemote Function
function createReplenishmentOrder(string baseSiteId, string userId, ScheduleReplenishmentForm payload, map<string|string[]> headers, *CreateReplenishmentOrderQueries queries) returns ReplenishmentOrder|errorCreates replenishment orders.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ScheduleReplenishmentForm - Request body with schedule replenishment form
- queries *CreateReplenishmentOrderQueries - Queries to be sent with the request
Return Type
- ReplenishmentOrder|error - Created
sendPasswordRestoreToken
Isolated FunctionRemote Function
function sendPasswordRestoreToken(string baseSiteId, PasswordRestoreTokenInput payload, map<string|string[]> headers) returns error?Creates and sends a token to restore a forgotten password.
Parameters
- baseSiteId string - Base site identifier
- payload PasswordRestoreTokenInput - Request body with password restore token input
Return Type
- error? - Created
getPaymentModes
Isolated FunctionRemote Function
function getPaymentModes(string baseSiteId, map<string|string[]> headers, *GetPaymentModesQueries queries) returns PaymentModeList|xml|errorRetrieves the available payment modes.
Parameters
- baseSiteId string - Base site identifier
- queries *GetPaymentModesQueries - Queries to be sent with the request
Return Type
- PaymentModeList|xml|error - OK
getPaymentTypes
Isolated FunctionRemote Function
function getPaymentTypes(string baseSiteId, map<string|string[]> headers, *GetPaymentTypesQueries queries) returns B2BPaymentTypeList|xml|errorRetrieves the available payment types.
Parameters
- baseSiteId string - Base site identifier
- queries *GetPaymentTypesQueries - Queries to be sent with the request
Return Type
- B2BPaymentTypeList|xml|error - OK
getProductAvailability
Isolated FunctionRemote Function
function getProductAvailability(string baseSiteId, map<string|string[]> headers, *GetProductAvailabilityQueries queries) returns SAPAvailability|xml|errorRetrieves availability information for a list of products.
Parameters
- baseSiteId string - Base site identifier
- queries *GetProductAvailabilityQueries - Queries to be sent with the request
Return Type
- SAPAvailability|xml|error - OK
getExpressUpdateProducts
Isolated FunctionRemote Function
function getExpressUpdateProducts(string baseSiteId, map<string|string[]> headers, *GetExpressUpdateProductsQueries queries) returns ProductExpressUpdateElementList|xml|errorRetrieves products that were added to the express update feed.
Parameters
- baseSiteId string - Base site identifier
- queries *GetExpressUpdateProductsQueries - Queries to be sent with the request
Return Type
getProducts
Isolated FunctionRemote Function
function getProducts(string baseSiteId, map<string|string[]> headers, *GetProductsQueries queries) returns ProductSearchPage|xml|errorRetrieves a list of products.
Parameters
- baseSiteId string - Base site identifier
- queries *GetProductsQueries - Queries to be sent with the request
Return Type
- ProductSearchPage|xml|error - OK
countProducts
Isolated FunctionRemote Function
function countProducts(string baseSiteId, map<string|string[]> headers, *CountProductsQueries queries) returns Response|errorRetrieves the total number of products.
Parameters
- baseSiteId string - Base site identifier
- queries *CountProductsQueries - Queries to be sent with the request
Return Type
- Response|error - OK
getSuggestions
Isolated FunctionRemote Function
function getSuggestions(string baseSiteId, map<string|string[]> headers, *GetSuggestionsQueries queries) returns SuggestionList|xml|errorRetrieves the available suggestions.
Parameters
- baseSiteId string - Base site identifier
- queries *GetSuggestionsQueries - Queries to be sent with the request
Return Type
- SuggestionList|xml|error - OK
getProduct
Isolated FunctionRemote Function
function getProduct(string baseSiteId, string productCode, map<string|string[]> headers, *GetProductQueries queries) returns Product|xml|errorRetrieves product details.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- queries *GetProductQueries - Queries to be sent with the request
getConfigurationByProductCode
Isolated FunctionRemote Function
function getConfigurationByProductCode(string baseSiteId, string productCode, map<string|string[]> headers) returns ConfigurationInfoList|xml|errorGet textfield configuration
Return Type
getDefaultProductConfiguration
Isolated FunctionRemote Function
function getDefaultProductConfiguration(string baseSiteId, string productCode, map<string|string[]> headers, *GetDefaultProductConfigurationQueries queries) returns CCPConfiguration|xml|errorGets the default product configuration for a complex product
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product code
- queries *GetDefaultProductConfigurationQueries - Queries to be sent with the request
Return Type
- CCPConfiguration|xml|error - OK
createCpqConfiguration
Isolated FunctionRemote Function
function createCpqConfiguration(string baseSiteId, string productCode, map<string|string[]> headers) returns SAPCPQConfiguration|errorCreates a configuration of the CPQ product.
Return Type
- SAPCPQConfiguration|error - OK
getProductReferences
Isolated FunctionRemote Function
function getProductReferences(string baseSiteId, string productCode, map<string|string[]> headers, *GetProductReferencesQueries queries) returns ProductReferenceList|xml|errorRetrieves the product references.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- queries *GetProductReferencesQueries - Queries to be sent with the request
Return Type
- ProductReferenceList|xml|error - OK
getProductReviews
Isolated FunctionRemote Function
function getProductReviews(string baseSiteId, string productCode, map<string|string[]> headers, *GetProductReviewsQueries queries) returns ReviewList|xml|errorRetrieves the reviews of a product.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- queries *GetProductReviewsQueries - Queries to be sent with the request
Return Type
- ReviewList|xml|error - OK
createProductReview
Isolated FunctionRemote Function
function createProductReview(string baseSiteId, string productCode, Review payload, map<string|string[]> headers, *CreateProductReviewQueries queries) returns Review|xml|errorCreates a customer review as an anonymous user.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- payload Review - Request body with review
- queries *CreateProductReviewQueries - Queries to be sent with the request
getLocationProductStock
Isolated FunctionRemote Function
function getLocationProductStock(string baseSiteId, string productCode, map<string|string[]> headers, *GetLocationProductStockQueries queries) returns StoreFinderStockSearchPage|xml|errorRetrieves the stock level of a product.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- queries *GetLocationProductStockQueries - Queries to be sent with the request
Return Type
countProductStockByLocation
Isolated FunctionRemote Function
function countProductStockByLocation(string baseSiteId, string productCode, map<string|string[]> headers, *CountProductStockByLocationQueries queries) returns Response|errorRetrieves the total number of stock levels of a product.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- queries *CountProductStockByLocationQueries - Queries to be sent with the request
Return Type
- Response|error - OK
getStoreProductStock
Isolated FunctionRemote Function
function getStoreProductStock(string baseSiteId, string productCode, string storeName, map<string|string[]> headers, *GetStoreProductStockQueries queries) returns Stock|xml|errorRetrieves the stock level of a product.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- storeName string - Store identifier
- queries *GetStoreProductStockQueries - Queries to be sent with the request
getPromotions
Isolated FunctionRemote Function
function getPromotions(string baseSiteId, map<string|string[]> headers, *GetPromotionsQueries queries) returns PromotionList|xml|errorRetrieves the promotions.
Parameters
- baseSiteId string - Base site identifier
- queries *GetPromotionsQueries - Queries to be sent with the request
Return Type
- PromotionList|xml|error - OK
getPromotion
Isolated FunctionRemote Function
function getPromotion(string baseSiteId, string code, map<string|string[]> headers, *GetPromotionQueries queries) returns Promotion|xml|errorRetrieves the promotion.
Parameters
- baseSiteId string - Base site identifier
- code string - Promotion identifier (code)
- queries *GetPromotionQueries - Queries to be sent with the request
createPunchOutPurchaseOrderRequest
Isolated FunctionRemote Function
function createPunchOutPurchaseOrderRequest(string baseSiteId, CXML payload, map<string|string[]> headers) returns xml|errorHandles a purchase order request from the PunchOut provider.
createPunchOutProfileRequest
Isolated FunctionRemote Function
function createPunchOutProfileRequest(string baseSiteId, CreatePunchOutProfileRequestHeaders headers, CXML payload) returns xml|errorCreates a PunchOut profile request.
Parameters
- baseSiteId string - Base site identifier
- headers CreatePunchOutProfileRequestHeaders - Headers to be sent with the request
- payload CXML - Request body with CXML
createPunchOutSetUpRequest
Isolated FunctionRemote Function
function createPunchOutSetUpRequest(string baseSiteId, CXML payload, map<string|string[]> headers) returns xml|errorCreates a new PunchOut session.
getPunchOutSessionInfo
Isolated FunctionRemote Function
function getPunchOutSessionInfo(string baseSiteId, string sid, map<string|string[]> headers, *GetPunchOutSessionInfoQueries queries) returns PunchOutSessionInfo|errorRetrieves information about PunchOut session.
Parameters
- baseSiteId string - Base site identifier
- sid string - PunchOut session identifier
- queries *GetPunchOutSessionInfoQueries - Queries to be sent with the request
Return Type
- PunchOutSessionInfo|error - OK
getRequisitionFormData
Isolated FunctionRemote Function
function getRequisitionFormData(string baseSiteId, string sid, map<string|string[]> headers, *GetRequisitionFormDataQueries queries) returns RequisitionFormData|errorRetrieves the order message and URL for the procurement system.
Parameters
- baseSiteId string - Base site identifier
- sid string - PunchOut session identifier
- queries *GetRequisitionFormDataQueries - Queries to be sent with the request
Return Type
- RequisitionFormData|error - OK
getCities
Isolated FunctionRemote Function
function getCities(string baseSiteId, string regionId, map<string|string[]> headers) returns CityList|xml|errorRetrieves a list of cities for a region.
doResetPassword
Isolated FunctionRemote Function
function doResetPassword(string baseSiteId, ResetPassword payload, map<string|string[]> headers) returns error?Resets a forgotten password.
Parameters
- baseSiteId string - Base site identifier
- payload ResetPassword - Request body with reset password
Return Type
- error? - Accepted
getStoreLocations
Isolated FunctionRemote Function
function getStoreLocations(string baseSiteId, map<string|string[]> headers, *GetStoreLocationsQueries queries) returns StoreFinderSearchPage|xml|errorRetrieves the store locations.
Parameters
- baseSiteId string - Base site identifier
- queries *GetStoreLocationsQueries - Queries to be sent with the request
Return Type
countStoreLocations
Isolated FunctionRemote Function
function countStoreLocations(string baseSiteId, map<string|string[]> headers, *CountStoreLocationsQueries queries) returns Response|errorRetrieves a header that indicates the number of store locations.
Parameters
- baseSiteId string - Base site identifier
- queries *CountStoreLocationsQueries - Queries to be sent with the request
Return Type
- Response|error - OK
getStoresByCountry
Isolated FunctionRemote Function
function getStoresByCountry(string baseSiteId, string countryIso, map<string|string[]> headers, *GetStoresByCountryQueries queries) returns PointOfServiceList|xml|errorRetrieves the store locations in a country.
Parameters
- baseSiteId string - Base site identifier
- countryIso string - Country ISO code
- queries *GetStoresByCountryQueries - Queries to be sent with the request
Return Type
- PointOfServiceList|xml|error - OK
getStoresByCountryAndRegion
Isolated FunctionRemote Function
function getStoresByCountryAndRegion(string baseSiteId, string countryIso, string regionIso, map<string|string[]> headers, *GetStoresByCountryAndRegionQueries queries) returns PointOfServiceList|xml|errorRetrieves the store locations.
Parameters
- baseSiteId string - Base site identifier
- countryIso string - Country ISO code
- regionIso string - Region ISO code
- queries *GetStoresByCountryAndRegionQueries - Queries to be sent with the request
Return Type
- PointOfServiceList|xml|error - OK
getLocationCounts
Isolated FunctionRemote Function
function getLocationCounts(string baseSiteId, map<string|string[]> headers) returns StoreCountList|xml|errorRetrieves store counts.
Parameters
- baseSiteId string - Base site identifier
Return Type
- StoreCountList|xml|error - OK
getStoreLocation
Isolated FunctionRemote Function
function getStoreLocation(string baseSiteId, string storeId, map<string|string[]> headers, *GetStoreLocationQueries queries) returns PointOfService|xml|errorRetrieves a store location.
Parameters
- baseSiteId string - Base site identifier
- storeId string - Store identifier (currently store name)
- queries *GetStoreLocationQueries - Queries to be sent with the request
Return Type
- PointOfService|xml|error - OK
getTicketCategories
Isolated FunctionRemote Function
function getTicketCategories(string baseSiteId, map<string|string[]> headers, *GetTicketCategoriesQueries queries) returns TicketCategoryList|errorRetrieves the ticket categories.
Parameters
- baseSiteId string - Base site identifier
- queries *GetTicketCategoriesQueries - Queries to be sent with the request
Return Type
- TicketCategoryList|error - OK
getTitles
Isolated FunctionRemote Function
function getTitles(string baseSiteId, map<string|string[]> headers, *GetTitlesQueries queries) returns TitleList|xml|errorRetrieves the localized titles.
Parameters
- baseSiteId string - Base site identifier
- queries *GetTitlesQueries - Queries to be sent with the request
createUser
Isolated FunctionRemote Function
function createUser(string baseSiteId, UserSignUp payload, CreateUserHeaders headers, *CreateUserQueries queries) returns User|xml|errorRegisters a customer.
Parameters
- baseSiteId string - Base site identifier
- payload UserSignUp - Request body with user sign up data
- headers CreateUserHeaders (default {}) - Headers to be sent with the request
- queries *CreateUserQueries - Queries to be sent with the request
getUser
Isolated FunctionRemote Function
function getUser(string baseSiteId, string userId, map<string|string[]> headers, *GetUserQueries queries) returns User|xml|errorRetrieves the customer profile.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserQueries - Queries to be sent with the request
replaceUser
Isolated FunctionRemote Function
function replaceUser(string baseSiteId, string userId, User payload, map<string|string[]> headers) returns error?Updates the customer profile.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload User - Request body with user data
Return Type
- error? - OK
removeUser
Isolated FunctionRemote Function
Deletes the customer profile.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updateUser
Isolated FunctionRemote Function
function updateUser(string baseSiteId, string userId, User payload, map<string|string[]> headers) returns error?Updates customer profile
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload User - Request body with user data
Return Type
- error? - OK
getAccessToConfigurationEngine
Isolated FunctionRemote Function
function getAccessToConfigurationEngine(string baseSiteId, string userId, map<string|string[]> headers) returns CPQConfigurationEngineAccess|xml|errorRetrieves access data.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
getAddresses
Isolated FunctionRemote Function
function getAddresses(string baseSiteId, string userId, map<string|string[]> headers, *GetAddressesQueries queries) returns AddressList|xml|errorRetrieves the addresses of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAddressesQueries - Queries to be sent with the request
Return Type
- AddressList|xml|error - List of customer's addresses
createAddress
Isolated FunctionRemote Function
function createAddress(string baseSiteId, string userId, Address payload, map<string|string[]> headers, *CreateAddressQueries queries) returns Address|xml|errorCreates a new address.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address
- queries *CreateAddressQueries - Queries to be sent with the request
validateAddress
Isolated FunctionRemote Function
function validateAddress(string baseSiteId, string userId, Address payload, map<string|string[]> headers, *ValidateAddressQueries queries) returns AddressValidation|xml|errorVerifies the address.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address
- queries *ValidateAddressQueries - Queries to be sent with the request
Return Type
- AddressValidation|xml|error - OK
getAddress
Isolated FunctionRemote Function
function getAddress(string addressId, string baseSiteId, string userId, map<string|string[]> headers, *GetAddressQueries queries) returns Address|xml|errorRetrieves the address details of a customer.
Parameters
- addressId string - Address identifier
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAddressQueries - Queries to be sent with the request
replaceAddress
Isolated FunctionRemote Function
function replaceAddress(string addressId, string baseSiteId, string userId, Address payload, map<string|string[]> headers) returns error?Updates the address of a customer.
Parameters
- addressId string - Address identifier
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address
Return Type
- error? - OK
removeAddress
Isolated FunctionRemote Function
function removeAddress(string addressId, string baseSiteId, string userId, map<string|string[]> headers) returns error?Deletes the address of a customer.
Parameters
- addressId string - Address identifier
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updateAddress
Isolated FunctionRemote Function
function updateAddress(string addressId, string baseSiteId, string userId, Address payload, map<string|string[]> headers) returns error?Updates the address
Parameters
- addressId string - Address identifier
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address
Return Type
- error? - OK
getAvailableOrgUnitNodes
Isolated FunctionRemote Function
function getAvailableOrgUnitNodes(string baseSiteId, string userId, map<string|string[]> headers, *GetAvailableOrgUnitNodesQueries queries) returns B2BUnitNodeList|errorRetrieves the available organizational unit nodes.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAvailableOrgUnitNodesQueries - Queries to be sent with the request
Return Type
- B2BUnitNodeList|error - OK
getBudgets
Isolated FunctionRemote Function
function getBudgets(string baseSiteId, string userId, map<string|string[]> headers, *GetBudgetsQueries queries) returns BudgetList|errorRetrieves the list of budgets.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetBudgetsQueries - Queries to be sent with the request
Return Type
- BudgetList|error - OK
createBudget
Isolated FunctionRemote Function
function createBudget(string baseSiteId, string userId, Budget payload, map<string|string[]> headers, *CreateBudgetQueries queries) returns Budget|errorCreates a new budget.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Budget - Request body with budget
- queries *CreateBudgetQueries - Queries to be sent with the request
getBudget
Isolated FunctionRemote Function
function getBudget(string baseSiteId, string budgetCode, string userId, map<string|string[]> headers, *GetBudgetQueries queries) returns Budget|errorRetrieves the details of a budget.
Parameters
- baseSiteId string - Base site identifier
- budgetCode string - Budget GUID or budget code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetBudgetQueries - Queries to be sent with the request
updateBudget
Isolated FunctionRemote Function
function updateBudget(string baseSiteId, string budgetCode, string userId, Budget payload, map<string|string[]> headers, *UpdateBudgetQueries queries) returns Budget|errorUpdates the budget.
Parameters
- baseSiteId string - Base site identifier
- budgetCode string - Budget GUID or budget code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Budget - Request body with budget
- queries *UpdateBudgetQueries - Queries to be sent with the request
getCarts
Isolated FunctionRemote Function
function getCarts(string baseSiteId, string userId, map<string|string[]> headers, *GetCartsQueries queries) returns CartList|xml|errorRetrieves the carts of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartsQueries - Queries to be sent with the request
createCart
Isolated FunctionRemote Function
function createCart(string baseSiteId, string userId, map<string|string[]> headers, *CreateCartQueries queries) returns Cart|xml|errorCreates or restore a cart for a user.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *CreateCartQueries - Queries to be sent with the request
getCurrentOrgCart
Isolated FunctionRemote Function
function getCurrentOrgCart(string baseSiteId, string userId, map<string|string[]> headers, *GetCurrentOrgCartQueries queries) returns Cart|xml|errorGets the current cart.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCurrentOrgCartQueries - Queries to be sent with the request
getCart
Isolated FunctionRemote Function
function getCart(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetCartQueries queries) returns Cart|xml|errorRetrieves a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartQueries - Queries to be sent with the request
removeCart
Isolated FunctionRemote Function
function removeCart(string baseSiteId, string cartId, string userId, map<string|string[]> headers) returns error?Deletes the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getCartIdAccessCode
Isolated FunctionRemote Function
function getCartIdAccessCode(string baseSiteId, string cartId, string userId, map<string|string[]> headers) returns SAPAccessCode|errorGenerates an access code for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- SAPAccessCode|error - OK
updateBillingAddress
Isolated FunctionRemote Function
function updateBillingAddress(string baseSiteId, string cartId, string userId, Address payload, map<string|string[]> headers) returns error?Create or update the billing address of the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address
Return Type
- error? - OK
replaceCartDeliveryAddress
Isolated FunctionRemote Function
function replaceCartDeliveryAddress(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceCartDeliveryAddressQueries queries) returns error?Updates the delivery address for a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceCartDeliveryAddressQueries - Queries to be sent with the request
Return Type
- error? - OK
createCartDeliveryAddress
Isolated FunctionRemote Function
function createCartDeliveryAddress(string baseSiteId, string cartId, string userId, Address payload, map<string|string[]> headers, *CreateCartDeliveryAddressQueries queries) returns Address|xml|errorCreates a delivery address for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address
- queries *CreateCartDeliveryAddressQueries - Queries to be sent with the request
removeCartDeliveryAddress
Isolated FunctionRemote Function
function removeCartDeliveryAddress(string baseSiteId, string cartId, string userId, map<string|string[]> headers) returns error?Deletes the delivery address.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
applyCartVoucher
Isolated FunctionRemote Function
function applyCartVoucher(string baseSiteId, string cartId, string userId, SAPVoucherRequest payload, map<string|string[]> headers) returns error?Assigns a voucher to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPVoucherRequest - Request body with voucher request
Return Type
- error? - No Content
createBundle
Isolated FunctionRemote Function
function createBundle(string baseSiteId, string cartId, string userId, BundleStarter payload, map<string|string[]> headers) returns CartModification|errorCreates a bundle in a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload BundleStarter - Request body with bundle starter
Return Type
- CartModification|error - Created
doCartClone
DeprecatedIsolated FunctionRemote Function
function doCartClone(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoCartCloneQueries queries) returns SaveCartResult|xml|errorCreates a clone of a saved cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoCartCloneQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
Deprecated
getConsolidatedPickupLocations
Isolated FunctionRemote Function
function getConsolidatedPickupLocations(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetConsolidatedPickupLocationsQueries queries) returns PointOfServiceList|xml|errorRetrieves a list of pickup options.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetConsolidatedPickupLocationsQueries - Queries to be sent with the request
Return Type
- PointOfServiceList|xml|error - OK
createConsolidatedPickupLocation
Isolated FunctionRemote Function
function createConsolidatedPickupLocation(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *CreateConsolidatedPickupLocationQueries queries) returns CartModificationList|xml|errorCreates a consolidated pickup location.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *CreateConsolidatedPickupLocationQueries - Queries to be sent with the request
Return Type
- CartModificationList|xml|error - OK
copySavedCart
Isolated FunctionRemote Function
function copySavedCart(string baseSiteId, string cartId, string userId, SAPSavedCartRequest payload, map<string|string[]> headers, *CopySavedCartQueries queries) returns SaveCartResult|xml|errorCreates a clone of a saved cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPSavedCartRequest - Request body with saved cart request
- queries *CopySavedCartQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
replaceOrgCartCostCenter
Isolated FunctionRemote Function
function replaceOrgCartCostCenter(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceOrgCartCostCenterQueries queries) returns Cart|xml|errorUpdates the cost center for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceOrgCartCostCenterQueries - Queries to be sent with the request
getCartDeliveryMode
Isolated FunctionRemote Function
function getCartDeliveryMode(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetCartDeliveryModeQueries queries) returns DeliveryMode|xml|errorRetrieves the delivery mode for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartDeliveryModeQueries - Queries to be sent with the request
Return Type
- DeliveryMode|xml|error - OK
replaceCartDeliveryMode
Isolated FunctionRemote Function
function replaceCartDeliveryMode(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceCartDeliveryModeQueries queries) returns error?Updates the delivery mode for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceCartDeliveryModeQueries - Queries to be sent with the request
Return Type
- error? - OK
removeCartDeliveryMode
Isolated FunctionRemote Function
function removeCartDeliveryMode(string baseSiteId, string cartId, string userId, map<string|string[]> headers) returns error?Deletes the delivery mode from the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getCartDeliveryModes
Isolated FunctionRemote Function
function getCartDeliveryModes(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetCartDeliveryModesQueries queries) returns DeliveryModeList|xml|errorRetrieves the delivery modes for the current store and delivery address.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartDeliveryModesQueries - Queries to be sent with the request
Return Type
- DeliveryModeList|xml|error - OK
replaceCartGuestUser
DeprecatedIsolated FunctionRemote Function
function replaceCartGuestUser(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceCartGuestUserQueries queries) returns error?Assigns an email address to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceCartGuestUserQueries - Queries to be sent with the request
Return Type
- error? - OK
Deprecated
getCartEntries
Isolated FunctionRemote Function
function getCartEntries(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetCartEntriesQueries queries) returns OrderEntryList|xml|errorRetrieves the cart entries.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartEntriesQueries - Queries to be sent with the request
Return Type
- OrderEntryList|xml|error - OK
createCartEntry
Isolated FunctionRemote Function
function createCartEntry(string baseSiteId, string cartId, string userId, OrderEntry payload, map<string|string[]> headers, *CreateCartEntryQueries queries) returns CartModification|xml|errorAssigns a product to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntry - Request body with order entry
- queries *CreateCartEntryQueries - Queries to be sent with the request
Return Type
- CartModification|xml|error - OK
createCartEntryConfiguration
Isolated FunctionRemote Function
function createCartEntryConfiguration(string baseSiteId, string cartId, string userId, CCPOrderEntry payload, map<string|string[]> headers) returns CartModification|xml|errorAdds a product configuration to the cart
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CCPOrderEntry - Request body with CCP order entry
Return Type
- CartModification|xml|error - Created
addCartEntry
Isolated FunctionRemote Function
function addCartEntry(string baseSiteId, string cartId, string userId, OrderEntry payload, map<string|string[]> headers, *AddCartEntryQueries queries) returns CartModification|xml|errorAdds a product to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntry - Request body with order entry
- queries *AddCartEntryQueries - Queries to be sent with the request
Return Type
- CartModification|xml|error - OK
createCartEntryCPQConfiguration
Isolated FunctionRemote Function
function createCartEntryCPQConfiguration(string baseSiteId, string cartId, string userId, CPQOrderEntry payload, map<string|string[]> headers) returns CartModification|xml|errorAdds a configurable product to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CPQOrderEntry - Request body with CPQ order entry
Return Type
- CartModification|xml|error - Created
getCartEntry
Isolated FunctionRemote Function
function getCartEntry(string baseSiteId, string cartId, int entryNumber, string userId, map<string|string[]> headers, *GetCartEntryQueries queries) returns OrderEntry|xml|errorRetrieves the details of a cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber int - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartEntryQueries - Queries to be sent with the request
Return Type
- OrderEntry|xml|error - OK
replaceCartEntry
Isolated FunctionRemote Function
function replaceCartEntry(string baseSiteId, string cartId, int entryNumber, string userId, OrderEntry payload, map<string|string[]> headers, *ReplaceCartEntryQueries queries) returns CartModification|xml|errorUpdates the details of a cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber int - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntry - Request body with order entry
- queries *ReplaceCartEntryQueries - Queries to be sent with the request
Return Type
- CartModification|xml|error - OK
removeCartEntry
Isolated FunctionRemote Function
function removeCartEntry(string baseSiteId, string cartId, int entryNumber, string userId, map<string|string[]> headers) returns error?Deletes the cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber int - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updateCartEntry
Isolated FunctionRemote Function
function updateCartEntry(string baseSiteId, string cartId, int entryNumber, string userId, OrderEntry payload, map<string|string[]> headers, *UpdateCartEntryQueries queries) returns CartModification|xml|errorUpdates the details of a cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber int - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntry - Request body with order entry
- queries *UpdateCartEntryQueries - Queries to be sent with the request
Return Type
- CartModification|xml|error - OK
getCartEntryConfiguration
Isolated FunctionRemote Function
function getCartEntryConfiguration(string baseSiteId, string cartId, Signed32 entryNumber, string userId, map<string|string[]> headers, *GetCartEntryConfigurationQueries queries) returns CCPConfiguration|xml|errorGets the configuration of a cart entry
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartEntryConfigurationQueries - Queries to be sent with the request
Return Type
- CCPConfiguration|xml|error - OK
replaceCartEntryConfiguration
Isolated FunctionRemote Function
function replaceCartEntryConfiguration(string baseSiteId, string cartId, Signed32 entryNumber, string userId, CCPOrderEntry payload, map<string|string[]> headers) returns CartModification|xml|errorUpdates the configuration of a cart entry
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CCPOrderEntry - Request body with CCP order entry
Return Type
- CartModification|xml|error - OK
getConfigurationOverviewForSavedCart
Isolated FunctionRemote Function
function getConfigurationOverviewForSavedCart(string baseSiteId, string cartId, Signed32 entryNumber, string userId, map<string|string[]> headers) returns CCPConfigurationOverview|xml|errorGets a product configuration overview of an saved cart entry
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
getConfigurationInEntry
Isolated FunctionRemote Function
function getConfigurationInEntry(string baseSiteId, string cartId, Signed32 entryNumber, string userId, map<string|string[]> headers) returns ConfigurationInfoList|xml|errorGet configuration of cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber Signed32 - Cart entry number
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
getConfigurationInEntry1
Isolated FunctionRemote Function
function getConfigurationInEntry1(string baseSiteId, string cartId, Signed32 entryNumber, string userId, ConfigurationInfoList payload, map<string|string[]> headers) returns xml|errorUpdate configuration of cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber Signed32 - Cart entry number
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ConfigurationInfoList - Request body with configuration info list
replaceCartEntryCPQConfiguration
Isolated FunctionRemote Function
function replaceCartEntryCPQConfiguration(string baseSiteId, string cartId, Signed32 entryNumber, string userId, CPQOrderEntry payload, map<string|string[]> headers) returns CartModification|xml|errorUpdates the configuration.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber Signed32 - Each entry in the cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CPQOrderEntry - Request body with CPQ order entry
Return Type
- CartModification|xml|error - OK
readCpqConfigurationForCartEntry
Isolated FunctionRemote Function
function readCpqConfigurationForCartEntry(string baseSiteId, string cartId, Signed32 entryNumber, string userId, map<string|string[]> headers) returns SAPCPQConfiguration|errorRetrieves the CPQ configuration of a cart entry.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryNumber Signed32 - Each entry in the cart has an entry number. Cart entries are numbered in ascending order
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- SAPCPQConfiguration|error - OK
addToCartEntryGroup
Isolated FunctionRemote Function
function addToCartEntryGroup(string baseSiteId, string cartId, Signed32 entryGroupNumber, string userId, OrderEntry payload, map<string|string[]> headers, *AddToCartEntryGroupQueries queries) returns CartModification|xml|errorAssigns a product to a cart entry group.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryGroupNumber Signed32 - Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderEntry - Request body with order entry
- queries *AddToCartEntryGroupQueries - Queries to be sent with the request
Return Type
- CartModification|xml|error - OK
removeCartEntryGroup
Isolated FunctionRemote Function
function removeCartEntryGroup(string baseSiteId, string cartId, Signed32 entryGroupNumber, string userId, map<string|string[]> headers) returns error?Deletes an entry group.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryGroupNumber Signed32 - Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getAvailableProducts
Isolated FunctionRemote Function
function getAvailableProducts(string baseSiteId, string cartId, Signed32 entryGroupNumber, string userId, map<string|string[]> headers, *GetAvailableProductsQueries queries) returns ProductSearchPage|xml|errorRetrieves products for an entry group.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- entryGroupNumber Signed32 - Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAvailableProductsQueries - Queries to be sent with the request
Return Type
- ProductSearchPage|xml|error - OK
doUpdateFlagForDeletion
Isolated FunctionRemote Function
function doUpdateFlagForDeletion(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoUpdateFlagForDeletionQueries queries) returns SaveCartResult|xml|errorUpdates the cart by flagging it for deletion.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoUpdateFlagForDeletionQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
createCartGuestUser
Isolated FunctionRemote Function
function createCartGuestUser(string baseSiteId, string cartId, string userId, SAPGuestUserRequest payload, map<string|string[]> headers, *CreateCartGuestUserQueries queries) returns SAPGuestUserRequest|errorCreates a guest user for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPGuestUserRequest - Request body with guest user details
- queries *CreateCartGuestUserQueries - Queries to be sent with the request
Return Type
- SAPGuestUserRequest|error - Created
updateCurrentUserProfile
Isolated FunctionRemote Function
function updateCurrentUserProfile(string baseSiteId, string cartId, string userId, SAPGuestUserRequest payload, map<string|string[]> headers, *UpdateCurrentUserProfileQueries queries) returns SAPGuestUserRequest|errorUpdates profile for current cart guest user.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPGuestUserRequest - Request body with guest user details
- queries *UpdateCurrentUserProfileQueries - Queries to be sent with the request
Return Type
- SAPGuestUserRequest|error - OK
createDigitalPaymentRequest
Isolated FunctionRemote Function
function createDigitalPaymentRequest(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *CreateDigitalPaymentRequestQueries queries) returns PaymentRequest|xml|errorRequests information to create a subscription.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *CreateDigitalPaymentRequestQueries - Queries to be sent with the request
Return Type
- PaymentRequest|xml|error - OK
doHandleDigitalPaymentResponse
Isolated FunctionRemote Function
function doHandleDigitalPaymentResponse(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoHandleDigitalPaymentResponseQueries queries) returns PaymentDetails|xml|errorCreates the payment details from the response of the digital payments system.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoHandleDigitalPaymentResponseQueries - Queries to be sent with the request
Return Type
- PaymentDetails|xml|error - OK
getSopPaymentRequestDetails
Isolated FunctionRemote Function
function getSopPaymentRequestDetails(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetSopPaymentRequestDetailsQueries queries) returns PaymentRequest|xml|errorRetrieves the information required to create a subscription.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetSopPaymentRequestDetailsQueries - Queries to be sent with the request
Return Type
- PaymentRequest|xml|error - OK
getSopPaymentResponse
Isolated FunctionRemote Function
function getSopPaymentResponse(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetSopPaymentResponseQueries queries) returns PaymentDetails|xml|errorRetrieves the create subscription response from the payment provider.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetSopPaymentResponseQueries - Queries to be sent with the request
Return Type
- PaymentDetails|xml|error - OK
doHandleSopPaymentResponse
Isolated FunctionRemote Function
function doHandleSopPaymentResponse(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoHandleSopPaymentResponseQueries queries) returns PaymentDetails|xml|errorCreates the SOP payment details.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoHandleSopPaymentResponseQueries - Queries to be sent with the request
Return Type
- PaymentDetails|xml|error - OK
removeSopPaymentResponse
Isolated FunctionRemote Function
function removeSopPaymentResponse(string baseSiteId, string cartId, string userId, map<string|string[]> headers) returns error?Deletes the response from the payment provider.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updateSapPaymentOption
Isolated FunctionRemote Function
function updateSapPaymentOption(string baseSiteId, string cartId, string userId, SAPPaymentOptionRequest payload, map<string|string[]> headers, *UpdateSapPaymentOptionQueries queries) returns Cart|xml|errorSet the payment option for the cart.
Parameters
- baseSiteId string - The base site identifier
- cartId string - Cart identifier: cart code for logged-in user
- userId string - User identifier or one of the literals : 'current' for currently authenticated user
- payload SAPPaymentOptionRequest - Request body with payment option details
- queries *UpdateSapPaymentOptionQueries - Queries to be sent with the request
replaceCartPaymentDetails
Isolated FunctionRemote Function
function replaceCartPaymentDetails(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceCartPaymentDetailsQueries queries) returns error?Sets credit card payment details for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceCartPaymentDetailsQueries - Queries to be sent with the request
Return Type
- error? - OK
createCartPaymentDetails
Isolated FunctionRemote Function
function createCartPaymentDetails(string baseSiteId, string cartId, string userId, PaymentDetails payload, map<string|string[]> headers, *CreateCartPaymentDetailsQueries queries) returns PaymentDetails|xml|errorCreates details of a new credit card payment for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload PaymentDetails - Request body with payment details
- queries *CreateCartPaymentDetailsQueries - Queries to be sent with the request
Return Type
- PaymentDetails|xml|error - Created
replaceOrgCartPaymentType
Isolated FunctionRemote Function
function replaceOrgCartPaymentType(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ReplaceOrgCartPaymentTypeQueries queries) returns Cart|xml|errorUpdates the payment type for the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceOrgCartPaymentTypeQueries - Queries to be sent with the request
getCartPromotions
Isolated FunctionRemote Function
function getCartPromotions(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetCartPromotionsQueries queries) returns PromotionResultList|xml|errorRetrieves the cart promotions.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartPromotionsQueries - Queries to be sent with the request
Return Type
- PromotionResultList|xml|error - OK
doApplyCartPromotion
Isolated FunctionRemote Function
function doApplyCartPromotion(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoApplyCartPromotionQueries queries) returns error?Assigns a promotion to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoApplyCartPromotionQueries - Queries to be sent with the request
Return Type
- error? - OK
getCartPromotion
Isolated FunctionRemote Function
function getCartPromotion(string baseSiteId, string cartId, string promotionId, string userId, map<string|string[]> headers, *GetCartPromotionQueries queries) returns PromotionResultList|xml|errorRetrieves information about the promotion.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- promotionId string - Promotion identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartPromotionQueries - Queries to be sent with the request
Return Type
- PromotionResultList|xml|error - OK
removeCartPromotion
Isolated FunctionRemote Function
function removeCartPromotion(string baseSiteId, string cartId, string promotionId, string userId, map<string|string[]> headers) returns error?Deletes the promotion.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- promotionId string - Promotion identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
doCartVoucherRemoval
Isolated FunctionRemote Function
function doCartVoucherRemoval(string baseSiteId, string cartId, string userId, SAPVoucherRequest payload, map<string|string[]> headers) returns error?Removes a voucher defined for the current cart. This endpoint is added in the 2211.28 update.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPVoucherRequest - Request body with voucher details
Return Type
- error? - No Content
setCartRequestedRetrievalDate
Isolated FunctionRemote Function
function setCartRequestedRetrievalDate(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *SetCartRequestedRetrievalDateQueries queries) returns error?Sets the requested retrieval date for a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *SetCartRequestedRetrievalDateQueries - Queries to be sent with the request
Return Type
- error? - OK
doUpdateSavedCart
Isolated FunctionRemote Function
function doUpdateSavedCart(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoUpdateSavedCartQueries queries) returns SaveCartResult|xml|errorRestores a saved cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoUpdateSavedCartQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
doSaveCart
DeprecatedIsolated FunctionRemote Function
function doSaveCart(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoSaveCartQueries queries) returns SaveCartResult|xml|errorUpdates a cart to save it.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoSaveCartQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
Deprecated
doCartSave
Isolated FunctionRemote Function
function doCartSave(string baseSiteId, string cartId, string userId, SAPSavedCartRequest payload, map<string|string[]> headers, *DoCartSaveQueries queries) returns SaveCartResult|xml|errorUpdates a cart to save it.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPSavedCartRequest - Request body with saved cart details
- queries *DoCartSaveQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
getSavedCart
Isolated FunctionRemote Function
function getSavedCart(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetSavedCartQueries queries) returns SaveCartResult|xml|errorRetrieves the saved cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetSavedCartQueries - Queries to be sent with the request
Return Type
- SaveCartResult|xml|error - OK
updateCartServiceScheduleSlot
Isolated FunctionRemote Function
function updateCartServiceScheduleSlot(string baseSiteId, string cartId, string userId, ServiceScheduleSlot payload, map<string|string[]> headers) returns error?Updates the scheduled service order date for the products in a cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ServiceScheduleSlot - Request body with service schedule slot details
Return Type
- error? - OK
setGuestUserEmail
Isolated FunctionRemote Function
function setGuestUserEmail(string baseSiteId, string cartId, string userId, SAPGuestUserRequest payload, map<string|string[]> headers) returns error?Assigns an email address to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPGuestUserRequest - Request body with guest user email details
Return Type
- error? - No Content
validateCart
Isolated FunctionRemote Function
function validateCart(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *ValidateCartQueries queries) returns CartModificationList|xml|errorValidates the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ValidateCartQueries - Queries to be sent with the request
Return Type
- CartModificationList|xml|error - OK
getCartVouchers
Isolated FunctionRemote Function
function getCartVouchers(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *GetCartVouchersQueries queries) returns VoucherList|xml|errorRetrieves a list of vouchers.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCartVouchersQueries - Queries to be sent with the request
Return Type
- VoucherList|xml|error - OK
doApplyCartVoucher
DeprecatedIsolated FunctionRemote Function
function doApplyCartVoucher(string baseSiteId, string cartId, string userId, map<string|string[]> headers, *DoApplyCartVoucherQueries queries) returns error?Assigns a voucher to the cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoApplyCartVoucherQueries - Queries to be sent with the request
Return Type
- error? - OK
Deprecated
removeCartVoucher
DeprecatedIsolated FunctionRemote Function
function removeCartVoucher(string baseSiteId, string cartId, string userId, string voucherId, map<string|string[]> headers) returns error?Deletes a voucher defined for the current cart.
Parameters
- baseSiteId string - Base site identifier
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- voucherId string - Voucher identifier (code)
Return Type
- error? - No Content
Deprecated
getComponentsByIdsAndUser
Isolated FunctionRemote Function
function getComponentsByIdsAndUser(string baseSiteId, string userId, map<string|string[]> headers, *GetComponentsByIdsAndUserQueries queries) returns ComponentList|xml|errorRetrieves the component data.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetComponentsByIdsAndUserQueries - Queries to be sent with the request
Return Type
- ComponentList|xml|error - ComponentIDListWsDTO
getComponentByIdAndUser
Isolated FunctionRemote Function
function getComponentByIdAndUser(string baseSiteId, string componentId, string userId, map<string|string[]> headers, *GetComponentByIdAndUserQueries queries) returns Component|xml|errorRetrieves the component data.
Parameters
- baseSiteId string - Base site identifier
- componentId string - Component identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetComponentByIdAndUserQueries - Queries to be sent with the request
getPageWithUser
Isolated FunctionRemote Function
function getPageWithUser(string baseSiteId, string userId, map<string|string[]> headers, *GetPageWithUserQueries queries) returns CMSPage|xml|errorRetrieves the page data and the CMS content slots.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetPageWithUserQueries - Queries to be sent with the request
getPageByIdAndUser
Isolated FunctionRemote Function
function getPageByIdAndUser(string baseSiteId, string pageId, string userId, map<string|string[]> headers, *GetPageByIdAndUserQueries queries) returns CMSPage|xml|errorRetrieves the page data and CMS content slots using the page identifier.
Parameters
- baseSiteId string - Base site identifier
- pageId string - Page Id
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetPageByIdAndUserQueries - Queries to be sent with the request
getAllPagesWithUser
Isolated FunctionRemote Function
function getAllPagesWithUser(string baseSiteId, string userId, map<string|string[]> headers, *GetAllPagesWithUserQueries queries) returns CMSPageList|xml|errorRetrieves the page data.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAllPagesWithUserQueries - Queries to be sent with the request
Return Type
- CMSPageList|xml|error - CMSPageListWsDTO
doGiveConsent
Isolated FunctionRemote Function
function doGiveConsent(string baseSiteId, string userId, map<string|string[]> headers, *DoGiveConsentQueries queries) returns ConsentTemplate|xml|errorCreates consent.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoGiveConsentQueries - Queries to be sent with the request
Return Type
- ConsentTemplate|xml|error - OK
removeConsent
Isolated FunctionRemote Function
function removeConsent(string baseSiteId, string consentCode, string userId, map<string|string[]> headers) returns error?Deletes the user consent.
Parameters
- baseSiteId string - Base site identifier
- consentCode string - Consent code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getConsentTemplates
Isolated FunctionRemote Function
function getConsentTemplates(string baseSiteId, string userId, map<string|string[]> headers, *GetConsentTemplatesQueries queries) returns ConsentTemplateList|xml|errorRetrieves the consents.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetConsentTemplatesQueries - Queries to be sent with the request
Return Type
- ConsentTemplateList|xml|error - OK
getConsentTemplate
Isolated FunctionRemote Function
function getConsentTemplate(string baseSiteId, string consentTemplateId, string userId, map<string|string[]> headers, *GetConsentTemplateQueries queries) returns ConsentTemplate|xml|errorRetrieves the consent.
Parameters
- baseSiteId string - Base site identifier
- consentTemplateId string - Consent template identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetConsentTemplateQueries - Queries to be sent with the request
Return Type
- ConsentTemplate|xml|error - OK
getCustomerCoupons
Isolated FunctionRemote Function
function getCustomerCoupons(string baseSiteId, string userId, map<string|string[]> headers, *GetCustomerCouponsQueries queries) returns CustomerCouponSearchResult|xml|errorRetrieves the coupons of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetCustomerCouponsQueries - Queries to be sent with the request
Return Type
claimCustomerCoupon
Isolated FunctionRemote Function
function claimCustomerCoupon(string baseSiteId, string userId, SAPCustomerCouponOperationRequest payload, map<string|string[]> headers, *ClaimCustomerCouponQueries queries) returns CustomerCoupon2Customer|xml|errorClaims a customer coupon.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPCustomerCouponOperationRequest - Request body with customer coupon operation details
- queries *ClaimCustomerCouponQueries - Queries to be sent with the request
Return Type
- CustomerCoupon2Customer|xml|error - Created
discardCustomerCoupon
Isolated FunctionRemote Function
function discardCustomerCoupon(string baseSiteId, string userId, SAPCustomerCouponOperationRequest payload, map<string|string[]> headers) returns error?Discards a customer coupon.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPCustomerCouponOperationRequest - Request body with customer coupon operation details
Return Type
- error? - OK
subscribeNotificationsOfCustomerCoupon
Isolated FunctionRemote Function
function subscribeNotificationsOfCustomerCoupon(string baseSiteId, string userId, SAPCustomerCouponOperationRequest payload, map<string|string[]> headers, *SubscribeNotificationsOfCustomerCouponQueries queries) returns CustomerCouponNotification|xml|errorSubscribes to coupon notifications.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPCustomerCouponOperationRequest - Request body with customer coupon operation details
- queries *SubscribeNotificationsOfCustomerCouponQueries - Queries to be sent with the request
Return Type
- CustomerCouponNotification|xml|error - Created
unsubscribeNotificationsOfCustomerCoupon
Isolated FunctionRemote Function
function unsubscribeNotificationsOfCustomerCoupon(string baseSiteId, string userId, SAPCustomerCouponOperationRequest payload, map<string|string[]> headers) returns error?Unsubscribes from coupon notifications.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload SAPCustomerCouponOperationRequest - Request body with customer coupon operation details
Return Type
- error? - OK
doClaimCustomerCoupon
DeprecatedIsolated FunctionRemote Function
function doClaimCustomerCoupon(string baseSiteId, string couponCode, string userId, map<string|string[]> headers, *DoClaimCustomerCouponQueries queries) returns CustomerCoupon2Customer|xml|errorClaims and remembers a customer coupon.
Parameters
- baseSiteId string - Base site identifier
- couponCode string - Coupon code. A valid coupon code can be used to get a discount
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoClaimCustomerCouponQueries - Queries to be sent with the request
Return Type
- CustomerCoupon2Customer|xml|error - Created
Deprecated
unassignCustomerCoupon
DeprecatedIsolated FunctionRemote Function
function unassignCustomerCoupon(string baseSiteId, string couponCode, string userId, map<string|string[]> headers) returns error?Disclaims a customer coupon.
Parameters
- baseSiteId string - Base site identifier
- couponCode string - Coupon code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
Deprecated
doSubscribeToCustomerCoupon
DeprecatedIsolated FunctionRemote Function
function doSubscribeToCustomerCoupon(string baseSiteId, string couponCode, string userId, map<string|string[]> headers, *DoSubscribeToCustomerCouponQueries queries) returns CustomerCouponNotification|xml|errorCreates a coupon notification.
Parameters
- baseSiteId string - Base site identifier
- couponCode string - Coupon code. A valid coupon code can be used to get a discount
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoSubscribeToCustomerCouponQueries - Queries to be sent with the request
Return Type
- CustomerCouponNotification|xml|error - Created
Deprecated
doUnsubscribeFromCustomerCoupon
DeprecatedIsolated FunctionRemote Function
function doUnsubscribeFromCustomerCoupon(string baseSiteId, string couponCode, string userId, map<string|string[]> headers) returns error?Deletes a coupon notification.
Parameters
- baseSiteId string - Base site identifier
- couponCode string - Coupon code. A valid coupon code can be used to get a discount
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
Deprecated
getUserCustomerGroups
Isolated FunctionRemote Function
function getUserCustomerGroups(string baseSiteId, string userId, map<string|string[]> headers, *GetUserCustomerGroupsQueries queries) returns UserGroupList|xml|errorRetrieves the customer groups.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier
- queries *GetUserCustomerGroupsQueries - Queries to be sent with the request
Return Type
- UserGroupList|xml|error - OK
getEntitlementInstances
Isolated FunctionRemote Function
function getEntitlementInstances(string baseSiteId, string userId, map<string|string[]> headers, *GetEntitlementInstancesQueries queries) returns EntitlementInstanceList|errorRetrieves a list of entitlements
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetEntitlementInstancesQueries - Queries to be sent with the request
Return Type
- EntitlementInstanceList|error - List of user's entitlements
getEntitlementInstance
Isolated FunctionRemote Function
function getEntitlementInstance(string baseSiteId, string entitlementInstanceId, string userId, map<string|string[]> headers, *GetEntitlementInstanceQueries queries) returns EntitlementInstance|errorRetrieves an entitlement
Parameters
- baseSiteId string - Base site identifier
- entitlementInstanceId string - Number of the entitlement instance
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetEntitlementInstanceQueries - Queries to be sent with the request
Return Type
- EntitlementInstance|error - Entitlement Details
getFutureStocksList
Isolated FunctionRemote Function
function getFutureStocksList(string baseSiteId, string userId, map<string|string[]> headers, *GetFutureStocksListQueries queries) returns ProductFutureStocksList|errorRetrieves the future availability of the products.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetFutureStocksListQueries - Queries to be sent with the request
Return Type
getFutureStocks
Isolated FunctionRemote Function
function getFutureStocks(string baseSiteId, string productCode, string userId, map<string|string[]> headers, *GetFutureStocksQueries queries) returns ProductFutureStocks|errorRetrieves the future availability of a product.
Parameters
- baseSiteId string - Base site identifier
- productCode string - Product identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetFutureStocksQueries - Queries to be sent with the request
Return Type
- ProductFutureStocks|error - OK
replaceUserLogin
DeprecatedIsolated FunctionRemote Function
function replaceUserLogin(string baseSiteId, string userId, map<string|string[]> headers, *ReplaceUserLoginQueries queries) returns error?Changes customer's login name.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *ReplaceUserLoginQueries - Queries to be sent with the request
Return Type
- error? - OK
Deprecated
changeUserLoginId
Isolated FunctionRemote Function
function changeUserLoginId(string baseSiteId, string userId, ReplaceLoginIdInput payload, map<string|string[]> headers) returns error?Changes customer's login id.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ReplaceLoginIdInput - Request body with new login id details
Return Type
- error? - OK
doPublishSuccessfulLoginEvent
Isolated FunctionRemote Function
function doPublishSuccessfulLoginEvent(string baseSiteId, string userId, map<string|string[]> headers) returns error?Notify about successful login.
Return Type
- error? - Accepted
getNotificationPreferences
Isolated FunctionRemote Function
function getNotificationPreferences(string baseSiteId, string userId, map<string|string[]> headers) returns NotificationPreferenceList|xml|errorGets all notification preferences of the current customer
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
updateNotificationPreferences
Isolated FunctionRemote Function
function updateNotificationPreferences(string baseSiteId, string userId, BasicnotificationPreferenceList payload, map<string|string[]> headers) returns error?Updates the notification preferences of the current customer
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload BasicnotificationPreferenceList - Request body with notification preferences
Return Type
- error? - OK
siteMessages
Isolated FunctionRemote Function
function siteMessages(string baseSiteId, string userId, map<string|string[]> headers, *SiteMessagesQueries queries) returns SiteMessageSearchResult|xml|errorGets all site messages of current customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *SiteMessagesQueries - Queries to be sent with the request
Return Type
getOrderApprovalPermissions
Isolated FunctionRemote Function
function getOrderApprovalPermissions(string baseSiteId, string userId, map<string|string[]> headers, *GetOrderApprovalPermissionsQueries queries) returns OrderApprovalPermissionList|errorRetrieves the order approval permissions.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrderApprovalPermissionsQueries - Queries to be sent with the request
Return Type
createOrderApprovalPermission
Isolated FunctionRemote Function
function createOrderApprovalPermission(string baseSiteId, string userId, OrderApprovalPermission payload, map<string|string[]> headers, *CreateOrderApprovalPermissionQueries queries) returns OrderApprovalPermission|errorCreates an order approval permission.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderApprovalPermission - Request body with order approval permission details
- queries *CreateOrderApprovalPermissionQueries - Queries to be sent with the request
Return Type
- OrderApprovalPermission|error - Created
getOrderApprovalPermission
Isolated FunctionRemote Function
function getOrderApprovalPermission(string baseSiteId, string orderApprovalPermissionCode, string userId, map<string|string[]> headers, *GetOrderApprovalPermissionQueries queries) returns OrderApprovalPermission|errorRetrieves the order approval permission.
Parameters
- baseSiteId string - Base site identifier
- orderApprovalPermissionCode string - Order approval permission code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrderApprovalPermissionQueries - Queries to be sent with the request
Return Type
updateOrderApprovalPermission
Isolated FunctionRemote Function
function updateOrderApprovalPermission(string baseSiteId, string orderApprovalPermissionCode, string userId, OrderApprovalPermission payload, map<string|string[]> headers, *UpdateOrderApprovalPermissionQueries queries) returns OrderApprovalPermission|errorUpdates the order approval permission.
Parameters
- baseSiteId string - Base site identifier
- orderApprovalPermissionCode string - Order approval permission code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderApprovalPermission - Request body with order approval permission details
- queries *UpdateOrderApprovalPermissionQueries - Queries to be sent with the request
Return Type
getReturnRequests
Isolated FunctionRemote Function
function getReturnRequests(string baseSiteId, string userId, map<string|string[]> headers, *GetReturnRequestsQueries queries) returns ReturnRequestList|errorRetrieves the return request history of the customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetReturnRequestsQueries - Queries to be sent with the request
Return Type
- ReturnRequestList|error - OK
createReturnRequest
Isolated FunctionRemote Function
function createReturnRequest(string baseSiteId, string userId, ReturnRequestEntryInputList payload, map<string|string[]> headers, *CreateReturnRequestQueries queries) returns ReturnRequest|errorCreates an order return request.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ReturnRequestEntryInputList - Request body with return request entry list
- queries *CreateReturnRequestQueries - Queries to be sent with the request
Return Type
- ReturnRequest|error - Created
getReturnRequest
Isolated FunctionRemote Function
function getReturnRequest(string baseSiteId, string returnRequestCode, string userId, map<string|string[]> headers, *GetReturnRequestQueries queries) returns ReturnRequest|errorRetrieves the details of a return request.
Parameters
- baseSiteId string - Base site identifier
- returnRequestCode string - Order returns request code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetReturnRequestQueries - Queries to be sent with the request
Return Type
- ReturnRequest|error - OK
updateReturnRequest
Isolated FunctionRemote Function
function updateReturnRequest(string baseSiteId, string returnRequestCode, string userId, ReturnRequestModification payload, map<string|string[]> headers) returns error?Updates the order return request using the specified code.
Parameters
- baseSiteId string - Base site identifier
- returnRequestCode string - Order returns request code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ReturnRequestModification - Request body with return request modification details
Return Type
- error? - OK
getOrderApprovals
Isolated FunctionRemote Function
function getOrderApprovals(string baseSiteId, string userId, map<string|string[]> headers, *GetOrderApprovalsQueries queries) returns OrderApprovalList|errorRetrieves the orders to approve.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrderApprovalsQueries - Queries to be sent with the request
Return Type
- OrderApprovalList|error - OK
getOrderApproval
Isolated FunctionRemote Function
function getOrderApproval(string baseSiteId, string orderApprovalCode, string userId, map<string|string[]> headers, *GetOrderApprovalQueries queries) returns OrderApproval|errorRetrieves an order to approve.
Parameters
- baseSiteId string - Base site identifier
- orderApprovalCode string - Order approval code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrderApprovalQueries - Queries to be sent with the request
Return Type
- OrderApproval|error - OK
doMakeOrderApprovalDecision
Isolated FunctionRemote Function
function doMakeOrderApprovalDecision(string baseSiteId, string orderApprovalCode, string userId, OrderApprovalDecision payload, map<string|string[]> headers, *DoMakeOrderApprovalDecisionQueries queries) returns OrderApprovalDecision|errorCreates a decision for the order approval.
Parameters
- baseSiteId string - Base site identifier
- orderApprovalCode string - Order approval code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrderApprovalDecision - Request body with order approval decision details
- queries *DoMakeOrderApprovalDecisionQueries - Queries to be sent with the request
Return Type
getUserOrderHistory
Isolated FunctionRemote Function
function getUserOrderHistory(string baseSiteId, string userId, map<string|string[]> headers, *GetUserOrderHistoryQueries queries) returns OrderHistoryList|xml|errorRetrieves the order history of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserOrderHistoryQueries - Queries to be sent with the request
Return Type
- OrderHistoryList|xml|error - OK
placeOrder
Isolated FunctionRemote Function
function placeOrder(string baseSiteId, string userId, map<string|string[]> headers, *PlaceOrderQueries queries) returns Order|xml|errorCreates an order.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *PlaceOrderQueries - Queries to be sent with the request
countUserOrders
Isolated FunctionRemote Function
function countUserOrders(string baseSiteId, string userId, map<string|string[]> headers, *CountUserOrdersQueries queries) returns Response|errorRetrieves the total number of orders for a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *CountUserOrdersQueries - Queries to be sent with the request
Return Type
- Response|error - OK
paymentAuthorizedOrderPlacement
Isolated FunctionRemote Function
function paymentAuthorizedOrderPlacement(string baseSiteId, string userId, map<string|string[]> headers, *PaymentAuthorizedOrderPlacementQueries queries) returns Order|errorPlace an order with authorized payment.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *PaymentAuthorizedOrderPlacementQueries - Queries to be sent with the request
getUserOrders
Isolated FunctionRemote Function
function getUserOrders(string baseSiteId, string code, string userId, map<string|string[]> headers, *GetUserOrdersQueries queries) returns Order|xml|errorRetrieves the order.
Parameters
- baseSiteId string - Base site identifier
- code string - Order GUID or order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserOrdersQueries - Queries to be sent with the request
getUserOrderAttachments
Isolated FunctionRemote Function
function getUserOrderAttachments(string baseSiteId, string code, string userId, map<string|string[]> headers, *GetUserOrderAttachmentsQueries queries) returns SAPOrderAttachmentList|errorGet attachments for an order.
Parameters
- baseSiteId string - Base site identifier
- code string - Order Code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserOrderAttachmentsQueries - Queries to be sent with the request
Return Type
- SAPOrderAttachmentList|error - List of attachments of an order
getUserOrderAttachmentBinary
Isolated FunctionRemote Function
function getUserOrderAttachmentBinary(string attachmentId, string baseSiteId, string code, string userId, map<string|string[]> headers) returns byte[]|errorGet binary attachment of an order
Parameters
- attachmentId string - Attachment ID
- baseSiteId string - Base site identifier
- code string - Order Code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- byte[]|error - OK
getBillingDocument
Isolated FunctionRemote Function
function getBillingDocument(string baseSiteId, string billingDocId, string code, string userId, map<string|string[]> headers, *GetBillingDocumentQueries queries) returns Response|errorRetrieves the billing document of an order.
Parameters
- baseSiteId string - Base site identifier
- billingDocId string - Billing document identifier
- code string - Order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetBillingDocumentQueries - Queries to be sent with the request
Return Type
- Response|error - Returns PDF
doCancelOrder
Isolated FunctionRemote Function
function doCancelOrder(string baseSiteId, string code, string userId, CancellationRequestEntryInputList payload, map<string|string[]> headers) returns error?Cancels an order.
Parameters
- baseSiteId string - Base site identifier
- code string - Order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CancellationRequestEntryInputList - Request body with cancellation request entry list
Return Type
- error? - OK
getUserOrderInvoices
Isolated FunctionRemote Function
function getUserOrderInvoices(string baseSiteId, string code, string userId, map<string|string[]> headers, *GetUserOrderInvoicesQueries queries) returns SAPInvoiceList|xml|errorGet invoices for an order.
Parameters
- baseSiteId string - Base site identifier
- code string - Order Code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserOrderInvoicesQueries - Queries to be sent with the request
Return Type
- SAPInvoiceList|xml|error - List of invoice of an order
getUserOrderInvoiceBinary
Isolated FunctionRemote Function
function getUserOrderInvoiceBinary(string baseSiteId, string code, string invoiceId, string userId, map<string|string[]> headers, *GetUserOrderInvoiceBinaryQueries queries) returns byte[]|errorGet binary invoice of an order
Parameters
- baseSiteId string - Base site identifier
- code string - Order Code
- invoiceId string - Invoice ID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetUserOrderInvoiceBinaryQueries - Queries to be sent with the request
Return Type
- byte[]|error - OK
cancelServiceOrder
Isolated FunctionRemote Function
function cancelServiceOrder(string baseSiteId, string code, string userId, CancellationRequestEntryInputList payload, map<string|string[]> headers) returns error?Cancels a service order
Parameters
- baseSiteId string - Base site identifier
- code string - Order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CancellationRequestEntryInputList - Request body with cancellation request entry list
Return Type
- error? - OK
updateOrderServiceScheduleSlot
Isolated FunctionRemote Function
function updateOrderServiceScheduleSlot(string baseSiteId, string code, string userId, ServiceScheduleSlot payload, map<string|string[]> headers) returns error?Updates the scheduled service order date for the products in an order.
Parameters
- baseSiteId string - Base site identifier
- code string - Order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ServiceScheduleSlot - Request body with service schedule slot details
Return Type
- error? - OK
getConsignmentTrackingData
Isolated FunctionRemote Function
function getConsignmentTrackingData(string baseSiteId, string consignmentCode, string orderCode, string userId, map<string|string[]> headers) returns ConsignmentTracking|xml|errorRetrieves consignment tracking information
Parameters
- baseSiteId string - Base site identifier
- consignmentCode string - Consignment identifier
- orderCode string - Order identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- ConsignmentTracking|xml|error - OK
getConfigurationOverviewForOrderEntry
Isolated FunctionRemote Function
function getConfigurationOverviewForOrderEntry(string baseSiteId, Signed32 entryNumber, string orderId, string userId, map<string|string[]> headers) returns CCPConfigurationOverview|xml|errorGets a product configuration overview of an order entry
Parameters
- baseSiteId string - Base site identifier
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- orderId string - Order identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
getTextfieldConfigurationForOrderEntry
Isolated FunctionRemote Function
function getTextfieldConfigurationForOrderEntry(string baseSiteId, string userId, Signed32 entryNumber, string orderId, map<string|string[]> headers) returns ConfigurationInfoList|xml|errorGet textfield configuration for order entry.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- orderId string - Order identifier
Return Type
readCpqConfigurationForOrderEntry
Isolated FunctionRemote Function
function readCpqConfigurationForOrderEntry(string baseSiteId, Signed32 entryNumber, string orderId, string userId, map<string|string[]> headers) returns SAPCPQConfiguration|errorRetrieves the CPQ configuration of an order entry.
Parameters
- baseSiteId string - Base site identifier
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order
- orderId string - The order identifier. Each order has a unique identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- SAPCPQConfiguration|error - OK
getOrgCustomers
Isolated FunctionRemote Function
function getOrgCustomers(string baseSiteId, string userId, map<string|string[]> headers, *GetOrgCustomersQueries queries) returns OrgUnitUserList|errorRetrieves the list of organizational customers.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgCustomersQueries - Queries to be sent with the request
Return Type
- OrgUnitUserList|error - OK
createOrgCustomer
Isolated FunctionRemote Function
function createOrgCustomer(string baseSiteId, string userId, OrgCustomerCreation payload, map<string|string[]> headers, *CreateOrgCustomerQueries queries) returns User|xml|errorCreates an organizational customer profile.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrgCustomerCreation - Request body with org customer creation details
- queries *CreateOrgCustomerQueries - Queries to be sent with the request
getOrgCustomer
Isolated FunctionRemote Function
function getOrgCustomer(string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *GetOrgCustomerQueries queries) returns User|xml|errorRetrieves the profile of the organizational unit customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgCustomerQueries - Queries to be sent with the request
updateOrgCustomer
Isolated FunctionRemote Function
function updateOrgCustomer(string baseSiteId, string orgCustomerId, string userId, OrgCustomerModification payload, map<string|string[]> headers) returns error?Updates the profile of the organizational unit customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrgCustomerModification - Request body with org customer modification details
Return Type
- error? - No Content
getOrgCustomerApprovers
Isolated FunctionRemote Function
function getOrgCustomerApprovers(string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *GetOrgCustomerApproversQueries queries) returns OrgUnitUserList|errorRetrieves the approvers.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgCustomerApproversQueries - Queries to be sent with the request
Return Type
- OrgUnitUserList|error - OK
doAddApproverToOrgCustomer
Isolated FunctionRemote Function
function doAddApproverToOrgCustomer(string approverId, string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *DoAddApproverToOrgCustomerQueries queries) returns B2BSelectionData|errorAdds an approver for an organizational customer.
Parameters
- approverId string - Approver GUID
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddApproverToOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
removeApproverFromOrgCustomer
Isolated FunctionRemote Function
function removeApproverFromOrgCustomer(string approverId, string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *RemoveApproverFromOrgCustomerQueries queries) returns B2BSelectionData|errorDeletes an approver for an organizational customer.
Parameters
- approverId string - Approver GUID
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *RemoveApproverFromOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
getOrgCustomerOrgUserGroups
Isolated FunctionRemote Function
function getOrgCustomerOrgUserGroups(string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *GetOrgCustomerOrgUserGroupsQueries queries) returns OrgUnitUserGroupList|errorRetrieves the organizational user groups.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgCustomerOrgUserGroupsQueries - Queries to be sent with the request
Return Type
doAddOrgUserGroupToOrgCustomer
Isolated FunctionRemote Function
function doAddOrgUserGroupToOrgCustomer(string baseSiteId, string orgCustomerId, string userGroupId, string userId, map<string|string[]> headers, *DoAddOrgUserGroupToOrgCustomerQueries queries) returns B2BSelectionData|errorCreates an Organizational organizational user group objfor an organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userGroupId string - Organizational user group GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddOrgUserGroupToOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
removeOrgUserGroupFromOrgCustomer
Isolated FunctionRemote Function
function removeOrgUserGroupFromOrgCustomer(string baseSiteId, string orgCustomerId, string userGroupId, string userId, map<string|string[]> headers) returns error?Deletes an organizational user group for an organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userGroupId string - Organizational user group GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getOrgCustomerPermissions
Isolated FunctionRemote Function
function getOrgCustomerPermissions(string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *GetOrgCustomerPermissionsQueries queries) returns OrderApprovalPermissionList|errorRetrieves the permissions of the customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgCustomerPermissionsQueries - Queries to be sent with the request
Return Type
doAddPermissionToOrgCustomer
Isolated FunctionRemote Function
function doAddPermissionToOrgCustomer(string baseSiteId, string orgCustomerId, string permissionId, string userId, map<string|string[]> headers, *DoAddPermissionToOrgCustomerQueries queries) returns B2BSelectionData|errorCreates a permission for an organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- permissionId string - Permission GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddPermissionToOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
removePermissionFromOrgCustomer
Isolated FunctionRemote Function
function removePermissionFromOrgCustomer(string baseSiteId, string orgCustomerId, string permissionId, string userId, map<string|string[]> headers, *RemovePermissionFromOrgCustomerQueries queries) returns B2BSelectionData|errorDeletes a permission for an organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer GUID
- permissionId string - Permission GUID
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *RemovePermissionFromOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
doAddRoleToOrgCustomer
Isolated FunctionRemote Function
function doAddRoleToOrgCustomer(string baseSiteId, string orgCustomerId, string userId, map<string|string[]> headers, *DoAddRoleToOrgCustomerQueries queries) returns B2BSelectionData|errorCreates a role for an organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer to which the role will be added
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddRoleToOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - Created
removeRoleFromOrgCustomer
Isolated FunctionRemote Function
function removeRoleFromOrgCustomer(string baseSiteId, string orgCustomerId, string roleId, string userId, map<string|string[]> headers, *RemoveRoleFromOrgCustomerQueries queries) returns B2BSelectionData|errorDeletes the role from the organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer from which the role will be removed
- roleId string - Role that is removed from the user. Example roles: b2badmingroup, b2bmanagergroup, or b2bcustomergroup
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *RemoveRoleFromOrgCustomerQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
getOrgUnitUserGroups
Isolated FunctionRemote Function
function getOrgUnitUserGroups(string baseSiteId, string userId, map<string|string[]> headers, *GetOrgUnitUserGroupsQueries queries) returns OrgUnitUserGroupList|errorRetrieves the list of user groups in an organizational unit.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitUserGroupsQueries - Queries to be sent with the request
Return Type
createOrgUnitUserGroup
Isolated FunctionRemote Function
function createOrgUnitUserGroup(string baseSiteId, string userId, OrgUnitUserGroup payload, map<string|string[]> headers, *CreateOrgUnitUserGroupQueries queries) returns OrgUnitUserGroup|errorCreates a new user group in an organizational unit.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrgUnitUserGroup - Request body with org unit user group details
- queries *CreateOrgUnitUserGroupQueries - Queries to be sent with the request
Return Type
- OrgUnitUserGroup|error - Created
getOrgUnitUserGroup
Isolated FunctionRemote Function
function getOrgUnitUserGroup(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers, *GetOrgUnitUserGroupQueries queries) returns OrgUnitUserGroup|errorRetrieves the details of the organizational unit user group.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitUserGroupQueries - Queries to be sent with the request
Return Type
- OrgUnitUserGroup|error - OK
removeOrgUnitUserGroup
Isolated FunctionRemote Function
function removeOrgUnitUserGroup(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers) returns error?Deletes the organizational unit user group.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updateOrgUnitUserGroup
Isolated FunctionRemote Function
function updateOrgUnitUserGroup(string baseSiteId, string orgUnitUserGroupId, string userId, OrgUnitUserGroup payload, map<string|string[]> headers) returns error?Updates the organizational unit user group.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload OrgUnitUserGroup - Request body with org unit user group details
Return Type
- error? - No Content
getOrderApprovalPermissionsForOrgUnitUserGroup
Isolated FunctionRemote Function
function getOrderApprovalPermissionsForOrgUnitUserGroup(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers, *GetOrderApprovalPermissionsForOrgUnitUserGroupQueries queries) returns OrderApprovalPermissionList|errorRetrieves the order approval permissions.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrderApprovalPermissionsForOrgUnitUserGroupQueries - Queries to be sent with the request
Return Type
getAvailableOrgCustomersForUserGroup
Isolated FunctionRemote Function
function getAvailableOrgCustomersForUserGroup(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers, *GetAvailableOrgCustomersForUserGroupQueries queries) returns OrgUnitUserList|errorRetrieves the organizational customers.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAvailableOrgCustomersForUserGroupQueries - Queries to be sent with the request
Return Type
- OrgUnitUserList|error - OK
doAddOrgCustomerToOrgUnitUserGroupMembers
Isolated FunctionRemote Function
function doAddOrgCustomerToOrgUnitUserGroupMembers(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers, *DoAddOrgCustomerToOrgUnitUserGroupMembersQueries queries) returns error?Adds an organizational customer as a member of an organizational unit user group.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddOrgCustomerToOrgUnitUserGroupMembersQueries - Queries to be sent with the request
Return Type
- error? - Created
removeOrgUnitUserGroupMembers
Isolated FunctionRemote Function
function removeOrgUnitUserGroupMembers(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers) returns error?Deletes all organizational customers as user group members in the organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
removeOrgCustomerFromOrgUnitUserGroupMembers
Isolated FunctionRemote Function
function removeOrgCustomerFromOrgUnitUserGroupMembers(string baseSiteId, string orgCustomerId, string orgUnitUserGroupId, string userId, map<string|string[]> headers) returns error?Deletes an organizational customer from the organizational unit group members.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer from which the role will be removed
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
doAddOrderApprovalPermissionToOrgUnitUserGroup
Isolated FunctionRemote Function
function doAddOrderApprovalPermissionToOrgUnitUserGroup(string baseSiteId, string orgUnitUserGroupId, string userId, map<string|string[]> headers, *DoAddOrderApprovalPermissionToOrgUnitUserGroupQueries queries) returns B2BSelectionData|errorCreates an order approval permission to a user group in the organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitUserGroupId string - Organizational unit user group to which the order approval permission will be added
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddOrderApprovalPermissionToOrgUnitUserGroupQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - Created
removeOrderApprovalPermissionFromOrgUnitUserGroup
Isolated FunctionRemote Function
function removeOrderApprovalPermissionFromOrgUnitUserGroup(string baseSiteId, string orderApprovalPermissionCode, string orgUnitUserGroupId, string userId, map<string|string[]> headers, *RemoveOrderApprovalPermissionFromOrgUnitUserGroupQueries queries) returns B2BSelectionData|errorDeletes the order approval permission from the organizational unit user group.
Parameters
- baseSiteId string - Base site identifier
- orderApprovalPermissionCode string - Order approval permission that will be removed from the organizational unit user group
- orgUnitUserGroupId string - Organizational unit user group identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *RemoveOrderApprovalPermissionFromOrgUnitUserGroupQueries - Queries to be sent with the request
Return Type
- B2BSelectionData|error - OK
createOrgUnit
Isolated FunctionRemote Function
function createOrgUnit(string baseSiteId, string userId, B2BUnit payload, map<string|string[]> headers, *CreateOrgUnitQueries queries) returns B2BUnit|errorCreates a new organizational unit.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload B2BUnit - Request body with B2B unit details
- queries *CreateOrgUnitQueries - Queries to be sent with the request
getOrgUnit
Isolated FunctionRemote Function
function getOrgUnit(string baseSiteId, string orgUnitId, string userId, map<string|string[]> headers, *GetOrgUnitQueries queries) returns B2BUnit|errorRetrieves the organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitQueries - Queries to be sent with the request
updateOrgUnit
Isolated FunctionRemote Function
function updateOrgUnit(string baseSiteId, string orgUnitId, string userId, B2BUnit payload, map<string|string[]> headers) returns error?Updates the organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload B2BUnit - Request body with B2B unit details
Return Type
- error? - No Content
getAccountSummary
Isolated FunctionRemote Function
function getAccountSummary(string baseSiteId, string orgUnitId, string userId, map<string|string[]> headers) returns AccountSummary|errorRetrieves the account summary.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- AccountSummary|error - OK
getOrgUnitAddresses
Isolated FunctionRemote Function
function getOrgUnitAddresses(string baseSiteId, string orgUnitId, string userId, map<string|string[]> headers, *GetOrgUnitAddressesQueries queries) returns AddressList|errorRetrieves the addresses of an organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitAddressesQueries - Queries to be sent with the request
Return Type
- AddressList|error - OK
createOrgUnitAddress
Isolated FunctionRemote Function
function createOrgUnitAddress(string baseSiteId, string orgUnitId, string userId, Address payload, map<string|string[]> headers, *CreateOrgUnitAddressQueries queries) returns Address|errorCreates an address for the organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address details
- queries *CreateOrgUnitAddressQueries - Queries to be sent with the request
removeOrgUnitAddress
Isolated FunctionRemote Function
function removeOrgUnitAddress(string addressId, string baseSiteId, string orgUnitId, string userId, map<string|string[]> headers) returns error?Deletes the organizational unit address.
Parameters
- addressId string - Address identifier
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updateOrgUnitAddress
Isolated FunctionRemote Function
function updateOrgUnitAddress(string addressId, string baseSiteId, string orgUnitId, string userId, Address payload, map<string|string[]> headers) returns error?Updates the organizational unit address.
Parameters
- addressId string - Address identifier
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload Address - Request body with address details
Return Type
- error? - No Content
getAvailableParentUnits
Isolated FunctionRemote Function
function getAvailableParentUnits(string baseSiteId, string orgUnitId, string userId, map<string|string[]> headers, *GetAvailableParentUnitsQueries queries) returns B2BUnitNodeList|errorRetrieves the available parent units.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetAvailableParentUnitsQueries - Queries to be sent with the request
Return Type
- B2BUnitNodeList|error - OK
getOrgUnitUsers
Isolated FunctionRemote Function
function getOrgUnitUsers(string baseSiteId, string orgUnitId, string roleId, string userId, map<string|string[]> headers, *GetOrgUnitUsersQueries queries) returns OrgUnitUserList|errorRetrieves the users who belong to the organizational unit.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- roleId string - Role that is returned. Example roles: b2bapprovergroup, b2badmingroup, b2bmanagergroup, or b2bcustomergroup
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitUsersQueries - Queries to be sent with the request
Return Type
- OrgUnitUserList|error - OK
doAddOrgUnitRoleToOrgCustomer
Isolated FunctionRemote Function
function doAddOrgUnitRoleToOrgCustomer(string baseSiteId, string orgCustomerId, string orgUnitId, string userId, map<string|string[]> headers, *DoAddOrgUnitRoleToOrgCustomerQueries queries) returns error?Adds an organizational unit dependent role to a specific organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer to which the role will be added
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *DoAddOrgUnitRoleToOrgCustomerQueries - Queries to be sent with the request
Return Type
- error? - Created
removeOrgUnitRoleFromOrgCustomer
Isolated FunctionRemote Function
function removeOrgUnitRoleFromOrgCustomer(string baseSiteId, string orgCustomerId, string orgUnitId, string roleId, string userId, map<string|string[]> headers) returns error?Deletes an organizational, unit-dependent role from an organizational customer.
Parameters
- baseSiteId string - Base site identifier
- orgCustomerId string - Organizational customer from which the role will be removed
- orgUnitId string - Organizational unit identifier
- roleId string - Role that is removed from the user. Example roles: b2badmingroup, b2bmanagergroup, or b2bcustomergroup
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
getOrgDocuments
Isolated FunctionRemote Function
function getOrgDocuments(string baseSiteId, string orgUnitId, string userId, map<string|string[]> headers, *GetOrgDocumentsQueries queries) returns OrgDocumentList|errorRetrieves the financial organizational documents.
Parameters
- baseSiteId string - Base site identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgDocumentsQueries - Queries to be sent with the request
Return Type
- OrgDocumentList|error - OK
getOrgDocumentAttachment
Isolated FunctionRemote Function
function getOrgDocumentAttachment(string baseSiteId, string orgDocumentAttachmentId, string orgDocumentId, string orgUnitId, string userId, map<string|string[]> headers) returns byte[]|errorRetrieves the attachment of a document.
Parameters
- baseSiteId string - Base site identifier
- orgDocumentAttachmentId string - Organizational document attachment identifier
- orgDocumentId string - Organizational document identifier
- orgUnitId string - Organizational unit identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- byte[]|error - OK
getOrgUnitsAvailableApprovalProcesses
Isolated FunctionRemote Function
function getOrgUnitsAvailableApprovalProcesses(string baseSiteId, string userId, map<string|string[]> headers, *GetOrgUnitsAvailableApprovalProcessesQueries queries) returns B2BApprovalProcessList|errorRetrieves the available business approval processes.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitsAvailableApprovalProcessesQueries - Queries to be sent with the request
Return Type
getOrgUnitsRootNodeTree
Isolated FunctionRemote Function
function getOrgUnitsRootNodeTree(string baseSiteId, string userId, map<string|string[]> headers, *GetOrgUnitsRootNodeTreeQueries queries) returns B2BUnitNode|errorRetrieves the root organizational unit node.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetOrgUnitsRootNodeTreeQueries - Queries to be sent with the request
Return Type
- B2BUnitNode|error - OK
replaceUserPassword
DeprecatedIsolated FunctionRemote Function
function replaceUserPassword(string baseSiteId, string userId, map<string|string[]> headers, *ReplaceUserPasswordQueries queries) returns error?Updates the password of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier
- queries *ReplaceUserPasswordQueries - Queries to be sent with the request
Return Type
- error? - Accepted
Deprecated
changeUserPassword
Isolated FunctionRemote Function
function changeUserPassword(string baseSiteId, string userId, ReplacePasswordInput payload, map<string|string[]> headers) returns error?Updates the password of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload ReplacePasswordInput - Request body with password change details
Return Type
- error? - OK
getPaymentDetailsList
Isolated FunctionRemote Function
function getPaymentDetailsList(string baseSiteId, string userId, map<string|string[]> headers, *GetPaymentDetailsListQueries queries) returns PaymentDetailsList|xml|errorRetrieves all credit card payment details of the customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetPaymentDetailsListQueries - Queries to be sent with the request
Return Type
- PaymentDetailsList|xml|error - OK
getPaymentDetails
Isolated FunctionRemote Function
function getPaymentDetails(string baseSiteId, string paymentDetailsId, string userId, map<string|string[]> headers, *GetPaymentDetailsQueries queries) returns PaymentDetails|xml|errorRetrieves detailed information for a specific credit card payment.
Parameters
- baseSiteId string - Base site identifier
- paymentDetailsId string - Payment details identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetPaymentDetailsQueries - Queries to be sent with the request
Return Type
- PaymentDetails|xml|error - OK
replacePaymentDetails
Isolated FunctionRemote Function
function replacePaymentDetails(string baseSiteId, string paymentDetailsId, string userId, PaymentDetails payload, map<string|string[]> headers) returns error?Updates existing detailed information for a specific credit card payment.
Parameters
- baseSiteId string - Base site identifier
- paymentDetailsId string - Payment details identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload PaymentDetails - Request body with payment details
Return Type
- error? - OK
removePaymentDetails
Isolated FunctionRemote Function
function removePaymentDetails(string baseSiteId, string paymentDetailsId, string userId, map<string|string[]> headers) returns error?Deletes detailed information for a specific credit card payment.
Parameters
- baseSiteId string - Base site identifier
- paymentDetailsId string - Payment details identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- error? - OK
updatePaymentDetails
Isolated FunctionRemote Function
function updatePaymentDetails(string baseSiteId, string paymentDetailsId, string userId, PaymentDetails payload, map<string|string[]> headers) returns error?Updates existing detailed information for a specific credit card payment.
Parameters
- baseSiteId string - Base site identifier
- paymentDetailsId string - Payment details identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload PaymentDetails - Request body with payment details
Return Type
- error? - OK
getProductInterests
Isolated FunctionRemote Function
function getProductInterests(string baseSiteId, string userId, map<string|string[]> headers, *GetProductInterestsQueries queries) returns CustomerInterestsSearchPage|xml|errorRetrieves the product interests of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetProductInterestsQueries - Queries to be sent with the request
Return Type
createProductInterest
Isolated FunctionRemote Function
function createProductInterest(string baseSiteId, string userId, map<string|string[]> headers, *CreateProductInterestQueries queries) returns ProductInterestRelation|xml|errorCreates product interests.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *CreateProductInterestQueries - Queries to be sent with the request
Return Type
removeProductInterest
Isolated FunctionRemote Function
function removeProductInterest(string baseSiteId, string userId, map<string|string[]> headers, *RemoveProductInterestQueries queries) returns error?Deletes the product interests.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *RemoveProductInterestQueries - Queries to be sent with the request
Return Type
- error? - OK
getQuotes
Isolated FunctionRemote Function
function getQuotes(string baseSiteId, string userId, map<string|string[]> headers, *GetQuotesQueries queries) returns QuoteList|errorRetrieves all quotes for a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetQuotesQueries - Queries to be sent with the request
createQuote
Isolated FunctionRemote Function
function createQuote(string baseSiteId, string userId, QuoteStarter payload, map<string|string[]> headers, *CreateQuoteQueries queries) returns Quote|errorCreates a quote.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload QuoteStarter - Request body with quote starter details
- queries *CreateQuoteQueries - Queries to be sent with the request
getQuote
Isolated FunctionRemote Function
function getQuote(string baseSiteId, string quoteCode, string userId, map<string|string[]> headers, *GetQuoteQueries queries) returns Quote|errorRetrieves the quote.
Parameters
- baseSiteId string - Base site identifier
- quoteCode string - Identifying code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetQuoteQueries - Queries to be sent with the request
replaceQuote
Isolated FunctionRemote Function
function replaceQuote(string baseSiteId, string quoteCode, string userId, QuoteMetadata payload, map<string|string[]> headers) returns error?Updates the quote.
Parameters
- baseSiteId string - Base site identifier
- quoteCode string - Identifying code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload QuoteMetadata - Request body with quote metadata
Return Type
- error? - OK
updateQuote
Isolated FunctionRemote Function
function updateQuote(string baseSiteId, string quoteCode, string userId, QuoteMetadata payload, map<string|string[]> headers) returns error?Updates the quote.
Parameters
- baseSiteId string - Base site identifier
- quoteCode string - Identifying code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload QuoteMetadata - Request body with quote metadata
Return Type
- error? - OK
performQuoteAction
Isolated FunctionRemote Function
function performQuoteAction(string baseSiteId, string quoteCode, string userId, QuoteAction payload, map<string|string[]> headers) returns error?Creates workflow actions for the quote.
Parameters
- baseSiteId string - Base site identifier
- quoteCode string - Code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload QuoteAction - Request body with quote action details
Return Type
- error? - OK
getQuoteAttachment
Isolated FunctionRemote Function
function getQuoteAttachment(string attachmentId, string baseSiteId, string quoteCode, string userId, map<string|string[]> headers) returns byte[]|errorRetrieves the quote attachment.
Parameters
- attachmentId string - Identifying code of the quote attachment
- baseSiteId string - Base site identifier
- quoteCode string - Identifying code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- byte[]|error - OK
createCommentForQuote
Isolated FunctionRemote Function
function createCommentForQuote(string baseSiteId, string quoteCode, string userId, CreateComment payload, map<string|string[]> headers) returns error?Creates a comment for a quote.
Parameters
- baseSiteId string - Base site identifier
- quoteCode string - Identifying code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CreateComment - Request body with comment details
Return Type
- error? - Created
createQuoteDiscount
Isolated FunctionRemote Function
function createQuoteDiscount(string baseSiteId, string quoteCode, string userId, QuoteDiscount payload, map<string|string[]> headers) returns error?Creates a discount for an existing quote.
Parameters
- baseSiteId string - Base site identifier
- quoteCode string - Code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload QuoteDiscount - Request body with quote discount details
Return Type
- error? - Created
createQuoteEntryComment
Isolated FunctionRemote Function
function createQuoteEntryComment(string baseSiteId, int entryNumber, string quoteCode, string userId, CreateComment payload, map<string|string[]> headers) returns error?Creates a comment for a quote entry.
Parameters
- baseSiteId string - Base site identifier
- entryNumber int - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- quoteCode string - Code of the quote
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CreateComment - Request body with comment details
Return Type
- error? - Created
getConfigurationOverviewForQuote
Isolated FunctionRemote Function
function getConfigurationOverviewForQuote(string baseSiteId, Signed32 entryNumber, string quoteId, string userId, map<string|string[]> headers) returns CCPConfigurationOverview|xml|errorGets a product configuration overview of an quote entry
Parameters
- baseSiteId string - Base site identifier
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- quoteId string - Quote identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
getTextfieldConfigurationForQuoteEntry
Isolated FunctionRemote Function
function getTextfieldConfigurationForQuoteEntry(string baseSiteId, string userId, Signed32 entryNumber, string quoteId, map<string|string[]> headers) returns ConfigurationInfoList|xml|errorGet textfield configuration for quote entry.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
- quoteId string - Quote identifier
Return Type
readCpqConfigurationForQuoteEntry
Isolated FunctionRemote Function
function readCpqConfigurationForQuoteEntry(string baseSiteId, Signed32 entryNumber, string quoteId, string userId, map<string|string[]> headers) returns SAPCPQConfiguration|errorRetrieves the CPQ configuration of a quote entry.
Parameters
- baseSiteId string - Base site identifier
- entryNumber Signed32 - The entry number. Each entry in a quote has an entry number. Quote entries are numbered in ascending order
- quoteId string - The quote identifier. Each quote has a unique identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- SAPCPQConfiguration|error - OK
getReplenishmentOrders
Isolated FunctionRemote Function
function getReplenishmentOrders(string baseSiteId, string userId, map<string|string[]> headers, *GetReplenishmentOrdersQueries queries) returns ReplenishmentOrderList|errorRetrieves the replenishment orders.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetReplenishmentOrdersQueries - Queries to be sent with the request
Return Type
getReplenishmentOrder
Isolated FunctionRemote Function
function getReplenishmentOrder(string baseSiteId, string replenishmentOrderCode, string userId, map<string|string[]> headers, *GetReplenishmentOrderQueries queries) returns ReplenishmentOrder|errorRetrieves the replenishment order.
Parameters
- baseSiteId string - Base site identifier
- replenishmentOrderCode string - Replenishment order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetReplenishmentOrderQueries - Queries to be sent with the request
Return Type
- ReplenishmentOrder|error - OK
updateReplenishmentOrder
Isolated FunctionRemote Function
function updateReplenishmentOrder(string baseSiteId, string replenishmentOrderCode, string userId, map<string|string[]> headers, *UpdateReplenishmentOrderQueries queries) returns ReplenishmentOrder|errorUpdates the replenishment order.
Parameters
- baseSiteId string - Base site identifier
- replenishmentOrderCode string - Unique code for the replenishment order
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *UpdateReplenishmentOrderQueries - Queries to be sent with the request
Return Type
- ReplenishmentOrder|error - OK
getReplenishmentOrderHistory
Isolated FunctionRemote Function
function getReplenishmentOrderHistory(string baseSiteId, string replenishmentOrderCode, string userId, map<string|string[]> headers, *GetReplenishmentOrderHistoryQueries queries) returns OrderHistoryList|errorRetrieves the history of the replenishment order.
Parameters
- baseSiteId string - Base site identifier
- replenishmentOrderCode string - Replenishment order code
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetReplenishmentOrderHistoryQueries - Queries to be sent with the request
Return Type
- OrderHistoryList|error - OK
getTextfieldConfigurationForSavedCartEntry
Isolated FunctionRemote Function
function getTextfieldConfigurationForSavedCartEntry(string baseSiteId, string userId, string cartId, Signed32 entryNumber, map<string|string[]> headers) returns ConfigurationInfoList|xml|errorGet textfield configuration for saved cart entry
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- cartId string - Cart identifier
- entryNumber Signed32 - Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero
Return Type
readCpqConfigurationForSavedCartEntry
Isolated FunctionRemote Function
function readCpqConfigurationForSavedCartEntry(string baseSiteId, Signed32 entryNumber, string savedCartId, string userId, map<string|string[]> headers) returns SAPCPQConfiguration|errorRetrieves the CPQ configuration of a saved cart entry.
Parameters
- baseSiteId string - Base site identifier
- entryNumber Signed32 - Each entry in a cart has an entry number. Saved cart entries are numbered in ascending order
- savedCartId string - The saved cart identifier. Each saved cart has a unique identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- SAPCPQConfiguration|error - OK
getTicketAssociatedObjects
Isolated FunctionRemote Function
function getTicketAssociatedObjects(string baseSiteId, string userId, map<string|string[]> headers, *GetTicketAssociatedObjectsQueries queries) returns TicketAssociatedObjectList|errorRetrieves the object associated with a ticket.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetTicketAssociatedObjectsQueries - Queries to be sent with the request
Return Type
getTickets
Isolated FunctionRemote Function
function getTickets(string baseSiteId, string userId, map<string|string[]> headers, *GetTicketsQueries queries) returns TicketList|errorRetrieves the tickets of a customer.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetTicketsQueries - Queries to be sent with the request
Return Type
- TicketList|error - OK
createTicket
Isolated FunctionRemote Function
function createTicket(string baseSiteId, string userId, TicketStarter payload, map<string|string[]> headers, *CreateTicketQueries queries) returns Ticket|errorCreates a ticket.
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload TicketStarter - Request body with ticket starter details
- queries *CreateTicketQueries - Queries to be sent with the request
getTicket
Isolated FunctionRemote Function
function getTicket(string baseSiteId, string ticketId, string userId, map<string|string[]> headers, *GetTicketQueries queries) returns Ticket|errorRetrieves a ticket.
Parameters
- baseSiteId string - Base site identifier
- ticketId string - Ticket identifier.<br> Example:
00000001
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- queries *GetTicketQueries - Queries to be sent with the request
createTicketEvent
Isolated FunctionRemote Function
function createTicketEvent(string baseSiteId, string ticketId, string userId, TicketEvent payload, map<string|string[]> headers, *CreateTicketEventQueries queries) returns TicketEvent|errorCreates a ticket event.
Parameters
- baseSiteId string - Base site identifier
- ticketId string - Ticket identifier.<br> Example:
00000001
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload TicketEvent - Request body with ticket event details
- queries *CreateTicketEventQueries - Queries to be sent with the request
Return Type
- TicketEvent|error - Created
createTicketEventAttachment
Isolated FunctionRemote Function
function createTicketEventAttachment(string baseSiteId, string eventCode, string ticketId, string userId, EventCodeAttachmentsBody payload, map<string|string[]> headers, *CreateTicketEventAttachmentQueries queries) returns TicketEventAttachment|errorCreates an attachment for an event in a ticket.
Parameters
- baseSiteId string - Base site identifier
- eventCode string - Ticket event code is specific to each event. It is used to identify an event.<br>Example:
00000A15
- ticketId string - Ticket identifier.<br> Example:
00000001
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload EventCodeAttachmentsBody - Request body with event code attachments
- queries *CreateTicketEventAttachmentQueries - Queries to be sent with the request
Return Type
- TicketEventAttachment|error - Created
getTicketEventAttachment
Isolated FunctionRemote Function
function getTicketEventAttachment(string attachmentId, string baseSiteId, string eventCode, string ticketId, string userId, map<string|string[]> headers) returns byte[]|errorRetrieves an attachment for an event in a ticket.
Parameters
- attachmentId string - Attachment identifier.<br>Example:
001
- baseSiteId string - Base site identifier
- eventCode string - Ticket event code that is specific to each event. It is used to identify an event.<br>Example:
00000A15
- ticketId string - Ticket identifier.<br> Example:
00000001
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Return Type
- byte[]|error - OK
createVerificationToken
Isolated FunctionRemote Function
function createVerificationToken(string baseSiteId, string userId, CreateVerificationTokenInput payload, map<string|string[]> headers) returns VerificationToken|errorCreates verification token
Parameters
- baseSiteId string - Base site identifier
- userId string - User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
- payload CreateVerificationTokenInput - Request body with verification token input
Return Type
- VerificationToken|error - Created
getVoucherByCode
Isolated FunctionRemote Function
function getVoucherByCode(string baseSiteId, SAPVoucherOperationRequest payload, map<string|string[]> headers, *GetVoucherByCodeQueries queries) returns Voucher|xml|errorRetrieves the voucher by voucher code.
Parameters
- baseSiteId string - Base site identifier
- payload SAPVoucherOperationRequest - Request body with voucher operation details
- queries *GetVoucherByCodeQueries - Queries to be sent with the request
getVoucher
DeprecatedIsolated FunctionRemote Function
function getVoucher(string baseSiteId, string code, map<string|string[]> headers, *GetVoucherQueries queries) returns Voucher|xml|errorRetrieves the voucher.
Parameters
- baseSiteId string - Base site identifier
- code string - Voucher identifier (code)
- queries *GetVoucherQueries - Queries to be sent with the request
Deprecated
Records
sap.commerce.webservices: AccountSummary
Account summary of an organizational unit
Fields
- amountBalance? AmountBalance - Account balance details
- accountManagerName? string - Name of the account manager
- orgUnit? OrgUnitReference - Reference to organizational unit
- creditLimit? string - Credit limit amount, formatted as per the selected currency
- accountManagerEmail? string - Email of the account manager
- billingAddress? Address - Address object
sap.commerce.webservices: AddCartEntryQueries
Represents the Queries record for the operation: addCartEntry
Fields
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration (list of fields, which should be returned in response)
sap.commerce.webservices: AddOrderFormToCartQueries
Represents the Queries record for the operation: addOrderFormToCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: Address
Address object
Fields
- lastName string - Last name of the address person
- country? Country - Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format
- town string - Town, field required
- city? City - data object of city
- companyName? string - Company Name
- postalCode string - Postal code of the address
- cityDistrict? District - data object of district
- title? string - Title of the address person
- titleCode string - Code of the title
- firstName string - First name of the address person
- formattedAddress? string - Boolean flag if address is formatted
- phone? string - Phone number
- visibleInAddressBook? boolean - Boolean flag if address is visible in the Address Book
- district? string - District name
- cellphone? string - Cellphone number
- shippingAddress? boolean - Boolean flag if address is for shipping
- id? string - Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key
- region? Region - Response body fields which will be returned while fetching the list of country's regions
- line2? string - Second line of the address
- line1 string - First line of the address
- email? string - Email address
- defaultAddress? boolean - Boolean flag if address is default
sap.commerce.webservices: AddressList
Representation of an Address list
Fields
- addresses? Address[] - List of addresses
sap.commerce.webservices: AddressValidation
Representation of an Address Validation
Fields
- decision? string - Decision
- suggestedAddresses? Address[] - List of suggested addresses
- errors? ErrorList - List of validation errors for the address
sap.commerce.webservices: AddToCartEntryGroupQueries
Represents the Queries record for the operation: addToCartEntryGroup
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: AmountBalance
Account balance details
Fields
- pastDueBalance? string - Past due balance as the sum of all open transactional documents that are past the payment due date
- currentBalance? string - Current balance as the sum of all open transactional documents that are not past the payment due date
- dueBalances? DueBalanceRange[] - Balance due for each of the defined day ranges. For example, $100 due in 1-30 days, $200 due in 31-60 days, $300 due in 61-90 days, $400 due in 91+ days
- openBalance? string - Open balance as the sum of all open transactional documents, including documents that are past the payment due date
sap.commerce.webservices: ApiMessage
Representation of supplementary info, warning messages, even when the business APIs successfully execute their operations
Fields
- code? string - A unique identifier for the message
- kind? string - Type of message, e.g. info, warning
- message? string - A human-readable description of the message
- target? string - Reference(s) to the specific part(s) of the cart that the message pertains to
sap.commerce.webservices: B2BApprovalProcess
Representation of an organizational approval process
Fields
- code string - Code of the Organizational Approval Process
- name? string - Name of the Organizational Approval Process
sap.commerce.webservices: B2BApprovalProcessList
Representation of an organizational approval process list
Fields
- approvalProcesses B2BApprovalProcess[] - List of Organizational Approval Process
sap.commerce.webservices: B2BCostCenter
Cost center object
Fields
- unit? B2BUnit - Organizational unit object
- code? string - The code of the cost center
- name? string - The name of the cost center
- originalCode? string - The original code of the cost center. Deprecated since 2005
- active? string - Indication of whether the cost center is active. Deprecated since 2005. Read-only, used for display purposes
- assignedBudgets? BudgetShallow[] - Budgets assigned to this cost center
- currency? Currency - Representation of a Currency
- activeFlag? boolean - Boolean flag of whether the cost center is active
sap.commerce.webservices: B2BCostCenterList
Representation of a cost center list
Fields
- pagination? DeprecatedPagination - Representation of a search results pagination
- sorts? Sort[] - List of sorts
- costCenters? B2BCostCenter[] - List of cost centers
sap.commerce.webservices: B2BCostCenterShallow
Representation of a cost center. This bean is shallow, which means its potential relationship fields to other Org Unit fields are simple ids. No Org Unit WsDTO fields should be declared in this bean to avoid circular references
Fields
- code? string - The code of the cost center
- name? string - The name of the cost center
- originalCode? string - The original code of the cost center. Deprecated since 2005
- active? string - Indication of whether the cost center is active. Deprecated since 2005. Read-only, used for display purposes
- currency? Currency - Representation of a Currency
- activeFlag? boolean - Boolean flag of whether the cost center is active
sap.commerce.webservices: B2BPaymentType
Payment method type available for B2B transactions
Fields
- code? string - Unique identifier code for the B2B payment type
- displayName? string - Human-readable name for the B2B payment type
sap.commerce.webservices: B2BPaymentTypeList
Container for a list of B2B payment types
Fields
- paymentTypes? B2BPaymentType[] - Array of available B2B payment types
sap.commerce.webservices: B2BSelectionData
Representation of object selection data
Fields
- displayRoles? string[] - display roles
- roles? string[] - roles
- active? boolean - If this object is active
- id? string - The ID of the selected object
- normalizedCode? string - The normalized code
- selected? boolean - If the this object was selected
sap.commerce.webservices: B2BUnit
Organizational unit object
Fields
- uid string - Identifier of the organizational unit
- parentOrgUnit? B2BUnit - Organizational unit object
- addresses? Address[] - Addresses of the organizational unit node
- name? string - Name of the organizational unit
- active? boolean - Boolean flag of whether Organizational Unit is active
- approvers? User[] - Approvers of the organizational unit node
- customers? User[] - Customers of the organizational unit node
- approvalProcess? B2BApprovalProcess - Representation of an organizational approval process
- managers? User[] - Managers of the organizational unit node
- administrators? User[] - Administrators of the organizational unit node
- costCenters? B2BCostCenterShallow[] - The cost centers of the organizational unit node
sap.commerce.webservices: B2BUnitNode
Representation of an organizational unit node
Fields
- parent? string - Unique identifier of organizational unit node's parent unit
- children? B2BUnitNode[] - Child nodes of the organizational unit node
- name? string - Name of the organizational unit represented by the node
- active? boolean - Boolean flag of whether organizational unit represented by the node is active
- id string - Identifier of the organizational unit represented by the node
sap.commerce.webservices: B2BUnitNodeList
Representation of an organizational unit node list
Fields
- unitNodes B2BUnitNode[] - List of Unit Nodes
sap.commerce.webservices: BaseOption
Representation of a Base Option
Fields
- variantType? string - Variant type of base option
- options? VariantOption[] - List of all variant options
- selected? VariantOption - Representation of a Variant Option
sap.commerce.webservices: BaseSite
Dependent types for the missing operations return types Representation of a Base Site
Fields
- registrationEnabled? boolean - Indicates if the website supports registration
- defaultPreviewCatalogId? string - Default preview catalog id
- urlPatterns? string[] - List of url patterns
- stores? BaseStore[] - List of Basestores
- channel? string - Channel
- 'isolated? boolean - Indicates whether customer data isolation is enabled for this site. If true, customer can get site information after registration, For example registerd username is name@sap.com, returned uid will be name@sap.com|baseSiteUid
- locale? string - Locale data for Basesite
- uid? string - Unique identifier of Basesite
- defaultPreviewCategoryCode? string - Default preview category code
- defaultLanguage? Language - Default language configuration for the base site
- urlEncodingAttributes? string[] - List of url encoding attributes
- name? string - Name of Basesite
- theme? string - Theme of Basesite
- defaultPreviewProductCode? string - Default preview product code
- requiresAuthentication? boolean - Indicates if the BaseSite requires authentication prior to use it
- captchaConfig? CaptchaConfig - CAPTCHA configuration settings for the base site
sap.commerce.webservices: BaseSiteList
Representation of a Base Site List
Fields
- baseSites? BaseSite[] - List of basesites
sap.commerce.webservices: BaseStore
Representation of a Base Store
Fields
- submitOrderProcessCode? string - Submit order process code
- languages? Language[] - List of languages
- deliveryCountries? Country[] - List of delivery countries
- externalTaxEnabled? boolean - Flag defining is external tax is enabled
- deliveryModes? DeliveryModeList - Available delivery modes for the store
- defaultLanguage? Language - Default language configuration for the store
- paymentProvider? string - Payment provider
- maxRadiusForPosSearch? decimal - Maximum radius for searching point of service
- defaultDeliveryOrigin? PointOfService - Default point of service for delivery origin
- defaultCurrency? Currency - Default currency configuration for the store
- pointsOfService? PointOfService[] - List of points of service
- name? string - Base store name
- createReturnProcessCode? string - Create return process code
- expressCheckoutEnabled? boolean - Flag specifying whether the express checkout option is enabled
- serviceOrderConfiguration? ServiceOrderConfiguration - Service order configuration settings for the store
- currencies? Currency[] - List of currencies
sap.commerce.webservices: BasicnotificationPreference
Basic notification preference
Fields
- channel? string - preference channel
- enabled? boolean - if true, the channel is on; if false, the channel is off
sap.commerce.webservices: BasicnotificationPreferenceList
Notification preference list
Fields
- preferences? BasicnotificationPreference[] - Basic notification preferences
sap.commerce.webservices: BillingDocument
Representation of a Billing document
Fields
- date? string - Billing date
- totalPrice? Price - Representation of a Price
- id? string - Billing doc Id
- 'type? string - Billing type eg. SALES/SERVICE
sap.commerce.webservices: Breadcrumb
Representation of a Breadcrumb
Fields
- facetValueName? string - Value name of the facet
- facetName? string - Name of the facet
- truncateQuery? SearchState - Representation of a Search State
- facetValueCode? string - Value code of the facet
- facetCode? string - Code of the facet
sap.commerce.webservices: Budget
Budget
Fields
- code? string - Code of the Budget
- endDate? string - The end date of the Budget
- orgUnit? B2BUnit - Organizational unit object
- name? string - The name of the Budget
- active? boolean - Boolean flag of whether the Budget is active
- currency? Currency - Representation of a Currency
- startDate? string - The start date of the Budget
- selected? boolean - Boolean flag whether the budget is selected for a cost center
- budget? decimal - Value of Budget
- costCenters? B2BCostCenter[] - List of Cost Centers
sap.commerce.webservices: BudgetList
Representation of a Budget List
Fields
- pagination? DeprecatedPagination - Representation of a search results pagination
- budgets? Budget[] - List of Budgets
- sorts? Sort[] - List of sorts
sap.commerce.webservices: BudgetShallow
Request body fields required and optional to operate on Budget data. This bean is shallow, which means its potential relationship fields to other Org Unit fields are simple ids. No Org Unit WsDTO should be declared in this bean to avoid circular references
Fields
- code? string - Code of the Budget
- endDate? string - The end date of the Budget
- name? string - The name of the Budget
- active? boolean - Boolean flag of whether the Budget is active
- currency? Currency - Representation of a Currency
- startDate? string - The start date of the Budget
- selected? boolean - Boolean flag whether the budget is selected for a cost center
- budget? decimal - Value of Budget
sap.commerce.webservices: BundleStarter
Mandatory data required to create a bundle. This includes the templateId of the bundle, the productCode, and the quantity of the product itself
Fields
- productCode string - Product code
- quantity int - Quantity of the product added to cart
- templateId string - Id of a template to create a bundle
sap.commerce.webservices: BundleTemplate
Description of a bundle component related to a product
Fields
- name? string - Name of this bundle template
- rootBundleTemplateName? string - Name of the root bundle template within the bundle tree structure
- id string - Id of this bundle template
sap.commerce.webservices: CancellationRequestEntryInput
Representation of a cancellation request entry input for an order
Fields
- orderEntryNumber Signed32 - Order entry number of the cancelled product
- quantity int - Quantity of the product which belongs to the order entry and is requested to be cancelled
sap.commerce.webservices: CancellationRequestEntryInputList
Cancellation request input list for the current order
Fields
- cancellationRequestEntryInputs CancellationRequestEntryInput[] - Cancellation request entry inputs which contain information about the order entries which are requested to be cancelled
- cancelReason? string - Cancellation reason
sap.commerce.webservices: CaptchaConfig
Configuration information of captcha
Fields
- publicKey? string - The public key used in captcha validation
- enabled? boolean - Indicates if the captcha is enabled or not
sap.commerce.webservices: CardType
Representation of a Card Type
Fields
- code? string - Card type code
- name? string - Card type name
sap.commerce.webservices: CardTypeList
Representation of a Card Type List
Fields
- cardTypes? CardType[] - List of card types
sap.commerce.webservices: Carrier
Carrier
Fields
- code? string - Carrier code
- name? string - Carrier name
sap.commerce.webservices: Cart
Representation of a Cart
Fields
- appliedProductPromotions? PromotionResult[] - List of applied product promotions
- sapCustomerEmail? string - Email of customer
- sapPaymentOptionId? string - The payment option identifier
- subTotal? Price - Representation of a Price
- totalTax? Price - Representation of a Price
- appliedVouchers? Voucher[] - List of applied vouchers
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- deliveryAddress? Address - Address object
- net? boolean - Flag stating if value is net-value
- saveTime? string - Date of saving cart
- calculated? boolean - Flag showing if order is calculated
- sapBillingAddress? Address - Address object
- productDiscounts? Price - Representation of a Price
- appliedOrderPromotions? PromotionResult[] - List of applied order promotions
- potentialProductPromotions? PromotionResult[] - List of potential product promotions for cart
- totalPriceWithTax? Price - Representation of a Price
- entries? OrderEntry[] - List of order entries
- deliveryCost? Price - Representation of a Price
- totalItems? int - Number of order entries
- totalPrice? Price - Representation of a Price
- potentialOrderPromotions? PromotionResult[] - List of potential order promotions
- code? string - Code of order/cart
- sapCustomerName? string - Name of customer
- paymentInfo? PaymentDetails - Payment information
- pickupOrderGroups? OrderEntry[] - List of pickup order entries
- orderDiscounts? Price - Representation of a Price
- description? string - Description of cart
- purchaseOrderNumber? string - Purchase order number
- name? string - Name of cart
- deliveryItemsQuantity? Signed32 - Delivery items quantity
- paymentType? B2BPaymentType - Payment type
- pickupItemsQuantity? Signed32 - Pickup items quantity
- guid? string - GUID value of order/cart
- totalUnitCount? Signed32 - Total unit count
- user? Principal - Representation of a Principal webservice DTO
- totalDiscounts? Price - Representation of a Price
- deliveryOrderGroups? OrderEntry[] - List of delivery order entries
sap.commerce.webservices: CartList
List of carts
Fields
- carts? Cart[] - List of carts
sap.commerce.webservices: CartModification
Representation of a Cart modification
Fields
- entry? OrderEntry - Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) The DTO is in XML or .json format
- quantity? int - Total number of products to be created, added or updated during a cart modification. This value is always the quantity that has been requested
- deliveryModeChanged? boolean - Delivery mode changed
- statusMessage? string - Status message
- statusCode? string - Status code of cart modification
- quantityAdded? int - Quantity added with cart modification
sap.commerce.webservices: CartModificationList
Representation of a Cart modification list
Fields
- cartModifications? CartModification[] - List of cart modifications
sap.commerce.webservices: Catalog
Representation of a Catalog
Fields
- catalogVersions? CatalogVersion[] - List of versions of catalog
- name? string - Name of abstract catalog item
- id? string - Identifier of abstract catalog item
- lastModified? string - Date of last modification
- url? string - Url address of abstract catalog item
sap.commerce.webservices: CatalogList
List of catalogs
Fields
- catalogs? Catalog[] - List of catalog items
sap.commerce.webservices: CatalogVersion
Representation of a Catalog Version
Fields
- name? string - Name of abstract catalog item
- id? string - Identifier of abstract catalog item
- lastModified? string - Date of last modification
- categories? CategoryHierarchy[] - List of category hierarchies
- url? string - Url address of abstract catalog item
sap.commerce.webservices: Category
Representation of a Category
Fields
- image? Image - Representation of an Image
- code? string - Code of the category
- name? string - Name of the category
- url? string - URL of the category
sap.commerce.webservices: CategoryHierarchy
Representation of a Category Hierarchy
Fields
- name? string - Name of abstract catalog item
- id? string - Identifier of abstract catalog item
- lastModified? string - Date of last modification
- subcategories? CategoryHierarchy[] - List of subcategory hierarchies
- url? string - Url address of abstract catalog item
sap.commerce.webservices: CCPAttribute
An attribute of a complex product
Fields
- images? Image[] - Image list
- visible? boolean - Attribute is visible
- maxlength? Signed32 - Maximum length of attribute value names for all domain values
- validationType? "NUMERIC"|"SAP_DATE"|"NONE" - Attribute validation type. Specifies how an attribute should be validated in case it's free input
- numberScale? Signed32 - Number of decimal places. Only relevant if the attribute is of numeric type
- typeLength? Signed32 - Maximum number of decimal places. Only relevant if the attribute is of numeric type
- negativeAllowed? boolean - Are negative values allowed? Only relevant if the attribute is of numeric type
- langDepName? string - Language-dependent attribute description
- 'type? "STRING"|"NUMERIC"|"CHECK_BOX"|"CHECK_BOX_LIST"|"RADIO_BUTTON"|"RADIO_BUTTON_ADDITIONAL_INPUT"|"DROPDOWN"|"DROPDOWN_ADDITIONAL_INPUT"|"READ_ONLY"|"NOT_IMPLEMENTED"|"SINGLE_SELECTION_IMAGE"|"MULTI_SELECTION_IMAGE"|"READ_ONLY_SINGLE_SELECTION_IMAGE"|"READ_ONLY_MULTI_SELECTION_IMAGE"|"SAP_DATE" - Attribute type. Specifies how the attribute should be rendered ideally
- required? boolean - It is required to specify this attribute in order to complete the configuration
- intervalInDomain? boolean - The list of attribute domain values contain an interval. Only relevant if the attribute is of numeric type
- domainValues? CCPAttributeValue[] - List of domain values
- longText? string - Language-dependent attribute long description
- domainOnDemand? boolean - If true domain was omitted and must be fetched separately
- name? string - Language-independent attribute name as assigned in the modeling environment
- formattedValue? string - Formatted attribute value, relevant for numeric attributes. This formatting takes the session locale into account
- conflicts? CCPConflict[] - List of conflicts
- messages? CCPMessage[] - Message list
- retractTriggered? boolean - Has a retract been triggered for all values of this attribute?
- retractBlocked? boolean - Retract must never happen for this attribute because the configuration engine forbids it
- value? string - Attribute value, if the attribute is single-valued
- 'key? string - Language-independent attribute key
sap.commerce.webservices: CCPAttributePricing
Enriches an attribute with supplementary pricing data
Fields
- csticUiKey? string - Attribute key
- selectedValues? string[] - List of currently selected domain values
- priceSupplements? CCPAttributeValuePricing[] - List of value price supplements
sap.commerce.webservices: CCPAttributeValue
Representation of an attribute value
Fields
- images? Image[] - List of images
- longText? string - Language dependent value description
- 'readonly? boolean - Indicates if value is read-only
- name? string - Language-independent value name
- messages? CCPMessage[] - Message list
- langDepName? string - Language-dependent value description
- 'key? string - Value key
- selected? boolean - Indicates if value is selected
sap.commerce.webservices: CCPAttributeValueOverview
Representation of an attribute value in the context of the configuration overview
Fields
- valueId? string - Value identifier
- obsoletePrice? Price - Representation of a Price
- price? Price - Representation of a Price
- messages? CCPMessage[] - Message list
- characteristicId? string - Attribute ID
- value? string - Language-dependent value name
- characteristic? string - Language-dependent attribute name
sap.commerce.webservices: CCPAttributeValuePricing
Enriches an attribute value with supplementary pricing data
Fields
- obsoletePriceValue? Price - Previous price value that is no longer current for the attribute
- attributeValueKey? string - Value key
- priceValue? Price - Current price value for the configurable product attribute
sap.commerce.webservices: CCPConfiguration
Representation of a product configuration. Contains the entities that describe a complex product: attributes of different types, groups of attributes, hierarchies of groups, statuses and messages. Typically, the attributes are connected through dependencies
Fields
- quantity? int - Configuration quantity
- rootProduct? string - Code of the configuration root product
- groups? CCPGroup[] - Attribute groups
- hideBasePriceAndSelectedOptions? boolean - If active, price components 'base price' and 'selected options' are not provided, only the total price of a configuration is provided
- consistent? boolean - Configuration is consistent, meaning it contains no conflicts
- pricingEnabled? boolean - Pricing is enabled, meaning that pricing related APIs are called and prices are shown during configuration
- totalNumberOfIssues? Signed32 - Total number of issues: sum of number of conflicts and number of incomplete mandatory fields
- configId? string - Configuration Identifier. A randomly generated UUID owned by the product configurator
- immediateConflictResolution? boolean - Indicates that conflicts need to be resolved immediately, before any other action is taken
- kbKey? CCPKBData - Representation of knowledge base key and administrative data
- messages? CCPMessage[] - Message list
- complete? boolean - Configuration is complete, meaning each mandatory attribute has been specified
- newConfiguration? boolean - Indicates whether the configuration is a new configuration
sap.commerce.webservices: CCPConfigurationOverallPricing
Prices on overall product configuration level
Fields
- currentTotalSavings? Price - Representation of a Price
- selectedOptions? Price - Representation of a Price
- currentTotal? Price - Representation of a Price
- basePrice? Price - Representation of a Price
sap.commerce.webservices: CCPConfigurationOverview
Representation of a product configuration overview, a condensed read-only view of a product configuration. Contains only the selected values
Fields
- numberOfIncompleteCharacteristics? Signed32 - Total number of incomplete attributes
- productCode? string - Product code of configuration's root product
- groupFilterList? CCPFilterData[] - For filtering the configuration overview according to the UI groups
- numberOfConflicts? Signed32 - Total number of conflicts
- groups? CCPGroupOverview[] - Configuration overview groups
- messages? CCPMessage[] - Message list
- id? string - Configuration Identifier. A randomly generated UUID owned by the product configurator
- pricingEnabled? boolean - Pricing is enabled, meaning that pricing related APIs are called and prices are shown during configuration
- sourceDocumentId? string - Identifier of document that owns this configuration. Can be the identifier of a saved cart, a quote, or an order
- appliedCsticFilter? CCPFilterData[] - For filtering the configuration overview according to attribute facets such as price relevance or attribute author
- totalNumberOfIssues? Signed32 - Total number of issues: sum of number of conflicts and number of incomplete mandatory fields
- pricing? CCPConfigurationOverallPricing - Prices on overall product configuration level
sap.commerce.webservices: CCPConfigurationPricing
Enriches a product configuration with supplementary pricing data
Fields
- priceSummary? CCPConfigurationOverallPricing - Overall pricing summary for the configuration
- showDeltaPrices? boolean - Indicates that attribute surcharges are displayed relatively to the current attribute price
- configId? string - Configuration Identifier. A randomly generated UUID owned by the product configurator
- pricingError? boolean - Indicates that pricing is currently not available
- attributes? CCPAttributePricing[] - List of supplementary data on attribute level
sap.commerce.webservices: CCPConflict
Textual representation of a conflict
Fields
- text? string - Language-dependent conflict text
sap.commerce.webservices: CCPFilterData
Bean used for filtering the configuration overview
Fields
- 'key? string - Identifier of the filter. Can contain the UI group identifier or an enum representing different attribute facets such as 'USER_INPUT' or 'PRICE_RELEVANT'
- selected? boolean - Describes if filter item is selected
sap.commerce.webservices: CCPGroup
Representation of a group in the context of the product configuration
Fields
- groupType? string - INSTANCE
- name? string - Language independent group name
- subGroups? CCPGroup[] - List of subordinate groups
- description? string - Language dependent group description
- consistent? boolean - Group is consistent, meaning it contains no conflicts
- attributes? CCPAttribute[] - List of attributes
- id? string - Group Identifier
- complete? boolean - Group is complete, meaning each mandatory attribute has been specified
- 'configurable? boolean - Group contains attributes. False if the group represents a non-configurable leaf in the configuration hierarchy
sap.commerce.webservices: CCPGroupOverview
Representation of a group in the context of the product configuration overview
Fields
- groupType? string - Type of group
- groupDescription? string - Language-dependent group description
- subGroups? CCPGroupOverview[] - List of subordinate groups
- id? string - Group Identifier
- characteristicValues? CCPAttributeValueOverview[] - Attribute values
sap.commerce.webservices: CCPKBData
Representation of knowledge base key and administrative data
Fields
- kbName? string - Knowledge base name
- kbBuildNumber? string - Knowledge base build number
- kbVersion? string - Knowledge base version
- kbLogsys? string - Logical system identifier of source system
sap.commerce.webservices: CCPMessage
Product configuration message
Fields
- severity? string - Message severity
- extendedMessage? string - Extended message text
- endDate? string - Offer expiration date
- promoType? string - Message promotion type
- message? string - Message text
sap.commerce.webservices: CCPOrderEntry
Requests body parameter that contains attributes for creating the order entry, such as quantity, product code, and configuration identifier
Fields
- quantityReturned? int - Number of items returned from this order entry
- updateable? boolean - Flag defining if order entry item is updateable
- quantityCancelled? int - Number of items cancelled from this order entry
- totalPrice? Price - Representation of a Price
- deliveryPointOfService? PointOfService - Representation of a Point of service
- cancelledItemsPrice? Price - Representation of a Price
- quantityAllocated? int - Number of items allocated for fulfillment from inventory
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- configId? string - Configuration Identifier. A randomly generated UUID owned by the product configurator
- statusSummaryList? StatusSummary[] - List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty
- scheduleLines? ScheduleLine[] - List of ScheduleLine
- returnedItemsPrice? Price - Representation of a Price
- basePrice? Price - Representation of a Price
- product? Product - Representation of a Product
- quantity? int - Quantity number of items in order entry
- comments? Comment[] - List of order entry comments
- cancellableQuantity? int - Quantity number of cancellable items in order entry
- quantityPending? int - Number of items pending fulfillment
- cpqDiscounts? CpqQuoteEntryDiscount[] - Discounts of the quote
- url? string - URL link to the order entry details
- returnableQuantity? int - Quantity number of returnable items in order entry
- quantityShipped? int - Number of items shipped from this order entry
- arrivalSlots? EntryArrivalSlot[] - List of item arrival slot
- entryNumber? Signed32 - Entry number of the order entry
- configurationInfos? ConfigurationInfo[] - Configuration info of order entry
- quantityUnallocated? int - Number of items not yet allocated from inventory
sap.commerce.webservices: ChinesePaymentInfo
Chinese payment info
Fields
- serviceType? string - The serviceType which is used for payment and defined in different payment providers
- paymentProviderLogo? string - Logo url of payment provider
- paymentProviderName? string - Name of payment provider
- paymentProvider? string - Payment provider of Chinese payment info
- id? string - Chinese payment info identifier
sap.commerce.webservices: City
data object of city
Fields
- isocode? string - ISO 3166-1 alpha-2 standard, e.g.[countryIso]-[regionNumber]-[cityNumber]
- name? string - name of city
sap.commerce.webservices: CityList
list of city
Fields
- cities? City[] - list of city
sap.commerce.webservices: ClaimCustomerCouponQueries
Represents the Queries record for the operation: claimCustomerCoupon
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: Classification
Representation of a Classification
Fields
- features? Feature[] - List of features for given classification
- code? string - Code of the classification
- name? string - Name of the classification
sap.commerce.webservices: CMSPage
Content management system page with template and content configuration
Fields
- template? string - Template identifier used for rendering the CMS page
- catalogVersionUuid? string - Unique identifier of the catalog version containing this page
- uid? string - Unique identifier for the CMS page
- defaultPage? boolean - Indicates if this is the default page for its category
- contentSlots? ContentSlotList - List of content slots associated with the CMS page
- robotTag? string - SEO robot tag instructions for search engine crawlers
- name? string - Display name of the CMS page
- description? string - Detailed description of the CMS page content
- title? string - Display title of the CMS page
- uuid? string - Unique identifier for the CMS page
- typeCode? string - Type classification code for the CMS page
sap.commerce.webservices: CMSPageList
Container for a collection of CMS pages
Fields
- page? CMSPage[] - Array of CMS page objects
sap.commerce.webservices: Comment
Object of the comment, which can be added to any Item in the commerce suite
Fields
- text string - Text of the comment
- creationDate string - Date when the comment was created
- fromCustomer boolean - Flag showing if the current customer was the author of the comment
sap.commerce.webservices: Component
Represents a commerce system component with metadata and properties
Fields
- uid? string - Unique identifier for the component
- modifiedtime? string - Date and time when the component was last modified
- name? string - Display name of the component
- uuid? string - Unique identifier for the component
- typeCode? string - Type code identifying the component type
sap.commerce.webservices: ComponentIDList
List of component identifiers
Fields
- idList? string[] - Array of component identifier strings
sap.commerce.webservices: ComponentList
Container for a list of components
Fields
- component? Component[] - Array of component objects
sap.commerce.webservices: ConfigurationInfo
Representation of a Configuration Info
Fields
- configurationLabel? string - Label of configuration info
- configuratorType? string - Type of configuration info
- configurationValue? string - Value of configuration info
- status? string - Status of configuration info
sap.commerce.webservices: ConfigurationInfoList
Request body parameter (DTO in xml or json format) which contains details like : product code (product.code), quantity of product (quantity), pickup store name (deliveryPointOfService.name)
Fields
- configurationInfos? ConfigurationInfo[] - List of configuration info
sap.commerce.webservices: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - 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
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - 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(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
sap.commerce.webservices: Consent
Representation of a Consent
Fields
- code? string - Code of consent
- consentGivenDate? string - Date of consenting
- consentWithdrawnDate? string - Consent withdrawn date
sap.commerce.webservices: ConsentTemplate
Representation of a Consent Template
Fields
- currentConsent? Consent - Current consent status associated with this consent template
- name? string - Consent template name
- description? string - Consent template description
- id? string - Consent template identifier
- version? Signed32 - Consent template version
sap.commerce.webservices: ConsentTemplateList
Representation of a Consent Template List
Fields
- consentTemplates? ConsentTemplate[] - List of consent templates
sap.commerce.webservices: Consignment
Representation of a Consignment
Fields
- statusDate? string - Consignment status date
- code? string - Consignment code
- shippingDate? string - Date and time when the consignment was shipped
- statusDisplay? string - Consignment status display
- deliveryPointOfService? PointOfService - Representation of a Point of service
- warehouseCode? string - Code identifying the warehouse from which the consignment originates
- packagingInfo? PackagingInfo - Representation of a Packaging Information
- entries? ConsignmentEntry[] - List of consignment entries
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- arrivalSlot? EntryArrivalSlot - Records of item arrivals facilitate the tracking and management of item quantities, associated arrival times, and certainty levels. These records distinguish between guaranteed, estimated, and unknown arrival scenarios
- shippingAddress? Address - Address object
- orderCode? string - Unique identifier code for the associated order
- trackingID? string - Consignment tracking identifier
- status? string - Consignment status
sap.commerce.webservices: ConsignmentEntry
Representation of a Consignment Entry
Fields
- orderEntry? OrderEntry - Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) The DTO is in XML or .json format
- quantity? int - Quantity value of Consignment entry
- quantityShipped? int - The number of items already shipped in this consignment
- quantityPending? int - The number of items pending shipment in this consignment
- shippedQuantity? int - Shipped quantity
- quantityDeclined? int - The number of items declined or cancelled in this consignment
sap.commerce.webservices: ConsignmentTracking
Consignment tracking data
Fields
- statusDisplay? string - Consignment status
- trackingUrl? string - The tracking url provided by the carrier
- targetArrivalDate? string - Target arrival date
- trackingEvents? ConsignmentTrackingEvent[] - Logistics tracking information
- carrierDetails? Carrier - Information about the shipping carrier handling the consignment
- trackingID? string - Tracking identifier
sap.commerce.webservices: ConsignmentTrackingEvent
Consignment tracking event
Fields
- location? string - Consignment location
- detail? string - Tracking detail
- referenceCode? string - Logistics status
- eventDate? string - Date of tracking event
sap.commerce.webservices: ContentSlot
Content slot containing components and metadata for page layout
Fields
- components? ComponentList - List of components contained within this content slot
- slotUuid? string - Unique identifier for the content slot
- slotStatus? string - Current status of the content slot
- name? string - Display name of the content slot
- otherProperties? map<anydata> - Additional properties and metadata for the content slot
- slotId? string - Identifier for the content slot
- position? string - Position or placement of the content slot on the page
sap.commerce.webservices: ContentSlotList
Collection of content slots for page layout management
Fields
- contentSlot? ContentSlot[] - Array of content slot objects
sap.commerce.webservices: Conversation
Conversation
Fields
- closeDate? string - close date
- agent? Principal - Agent assigned to handle the conversation
- latestMessage? ConversationMessage - Most recent message in the conversation
- id? string - conversation identifier
- status? string - conversation status
- customer? Principal - Customer participating in the conversation
- createDate? string - create date
sap.commerce.webservices: ConversationList
Conversation list
Fields
- conversations? Conversation[] - conversation data
sap.commerce.webservices: ConversationMessage
Conversation message
Fields
- sender? Principal - Representation of a Principal webservice DTO used for defining User data types
- sentTime? string - sent time
- content? string - message content
sap.commerce.webservices: ConversationMessageList
the list of messages
Fields
- conversationId? string - conversation identifier
- messages? ConversationMessage[] - the messages list of this conversation
sap.commerce.webservices: CopySavedCartQueries
Represents the Queries record for the operation: copySavedCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CountProductsQueries
Represents the Queries record for the operation: countProducts
Fields
- query? string - Formatted query string. It contains query criteria like free text search, facet. The format is <freeTextSearch>:<sort>:<facetKey1>:<facetValue1>:...:<facetKeyN>:<facetValueN>
sap.commerce.webservices: CountProductStockByLocationQueries
Represents the Queries record for the operation: countProductStockByLocation
Fields
- latitude? decimal - Coordinate that specifies the north-south position of a point on the Earth's surface
- location? string - Free-text location
- longitude? decimal - Coordinate that specifies the east-west position of a point on the Earth's surface
sap.commerce.webservices: Country
Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format
Fields
- isocode? string - Country code in iso format
- name? string - Name of the country
sap.commerce.webservices: CountryList
List of countries
Fields
- countries? Country[] - This is the list of Country fields that should be returned in the response body
sap.commerce.webservices: CountStoreLocationsQueries
Represents the Queries record for the operation: countStoreLocations
Fields
- latitude? decimal - Coordinate that specifies the north-south position of a point on the Earth's surface
- query? string - Location in plain text. Example: USA or New York City
- accuracy decimal(default 0) - Accuracy in meters
- radius decimal(default 100000.0) - Radius in meters. Max value: 40075000.0 (Earth's perimeter)
- longitude? decimal - Coordinate that specifies the east-west position of a point on the Earth's surface
sap.commerce.webservices: CountUserOrdersQueries
Represents the Queries record for the operation: countUserOrders
Fields
- statuses? string - Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID
sap.commerce.webservices: CPQConfigurationEngineAccess
Access data for configuration engine
Fields
- endpoint? string - Configuration engine endpoint url
- accessToken? string - Configuration engine access token
- accessTokenExpirationTime? int - Configuration engine access token expiration time in milliseconds since 1970-01-01
sap.commerce.webservices: CPQOrderEntry
Request body parameter that contains attributes for creating the order entry, like quantity, product code and configuration identifier
Fields
- quantityReturned? int - Number of items returned from this order entry
- updateable? boolean - Flag defining if order entry item is updateable
- quantityCancelled? int - Number of items cancelled from this order entry
- totalPrice? Price - Representation of a Price
- deliveryPointOfService? PointOfService - Representation of a Point of service
- cancelledItemsPrice? Price - Representation of a Price
- quantityAllocated? int - Number of items allocated for this order entry
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- configId? string - Configuration Identifier. A randomly generated UUID owned by the product configurator
- statusSummaryList? StatusSummary[] - List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty
- scheduleLines? ScheduleLine[] - List of ScheduleLine
- returnedItemsPrice? Price - Representation of a Price
- basePrice? Price - Representation of a Price
- product? Product - Representation of a Product
- quantity? int - Quantity number of items in order entry
- comments? Comment[] - List of order entry comments
- cancellableQuantity? int - Quantity number of cancellable items in order entry
- quantityPending? int - Number of items in the order entry awaiting processing or fulfillment
- cpqDiscounts? CpqQuoteEntryDiscount[] - Discounts of the quote
- url? string - URL reference associated with the CPQ order entry
- returnableQuantity? int - Quantity number of returnable items in order entry
- quantityShipped? int - Number of items in the order entry that have been shipped
- arrivalSlots? EntryArrivalSlot[] - List of item arrival slot
- entryNumber? Signed32 - Entry number of the order entry
- configurationInfos? ConfigurationInfo[] - Configuration info of order entry
- quantityUnallocated? int - Number of items in the order entry not yet allocated for fulfillment
sap.commerce.webservices: CpqQuoteEntryDiscount
Discount applied to the CPQ quote entry
Fields
- isoCode? string - Currency
- appliedValue? decimal - Discount Amount of the quote
- value? decimal - Discount Percentage of the quote
sap.commerce.webservices: CreateAddressQueries
Represents the Queries record for the operation: createAddress
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateBudgetQueries
Represents the Queries record for the operation: createBudget
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateCartDeliveryAddressQueries
Represents the Queries record for the operation: createCartDeliveryAddress
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateCartEntryQueries
Represents the Queries record for the operation: createCartEntry
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateCartFromOrderQueries
Represents the Queries record for the operation: createCartFromOrder
Fields
- orderCode string - Order code
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body
sap.commerce.webservices: CreateCartGuestUserQueries
Represents the Queries record for the operation: createCartGuestUser
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateCartPaymentDetailsQueries
Represents the Queries record for the operation: createCartPaymentDetails
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateCartQueries
Represents the Queries record for the operation: createCart
Fields
- toMergeCartGuid? string - The cart GUID that will be merged with the anonymous cart
- oldCartId? string - Anonymous cart GUID
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateComment
Text of the comment
Fields
- text string - Text of the comment
sap.commerce.webservices: CreateConsolidatedPickupLocationQueries
Represents the Queries record for the operation: createConsolidatedPickupLocation
Fields
- storeName string - The name of the store where items will be picked up
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateCostCenterQueries
Represents the Queries record for the operation: createCostCenter
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateDigitalPaymentRequestQueries
Represents the Queries record for the operation: createDigitalPaymentRequest
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateOrderApprovalPermissionQueries
Represents the Queries record for the operation: createOrderApprovalPermission
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateOrgCustomerQueries
Represents the Queries record for the operation: createOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateOrgUnitAddressQueries
Represents the Queries record for the operation: createOrgUnitAddress
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateOrgUnitQueries
Represents the Queries record for the operation: createOrgUnit
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateOrgUnitUserGroupQueries
Represents the Queries record for the operation: createOrgUnitUserGroup
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateProductInterestQueries
Represents the Queries record for the operation: createProductInterest
Fields
- productCode string - Product identifier
- notificationType string - Notification type
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateProductReviewQueries
Represents the Queries record for the operation: createProductReview
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreatePunchOutProfileRequestHeaders
Represents the Headers record for the operation: createPunchOutProfileRequest
Fields
- host string - Commerce API host address
sap.commerce.webservices: CreateQuoteQueries
Represents the Queries record for the operation: createQuote
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateRegistrationRequestHeaders
Represents the Headers record for the operation: createRegistrationRequest
Fields
- sapCommerceCloudCaptchaToken? string - The user's response token returned by captcha provider. When the captchaCheckEnabled = true for the store, the field is mandatory and will call the provider to validate
sap.commerce.webservices: CreateRegistrationRequestQueries
Represents the Queries record for the operation: createRegistrationRequest
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateReplenishmentOrderQueries
Represents the Queries record for the operation: createReplenishmentOrder
Fields
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- termsChecked boolean - Whether terms were accepted or not
sap.commerce.webservices: CreateReturnRequestQueries
Represents the Queries record for the operation: createReturnRequest
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateTicketEventAttachmentQueries
Represents the Queries record for the operation: createTicketEventAttachment
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateTicketEventQueries
Represents the Queries record for the operation: createTicketEvent
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateTicketQueries
Represents the Queries record for the operation: createTicket
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateUserHeaders
Represents the Headers record for the operation: createUser
Fields
- sapCommerceCloudCaptchaToken? string - The user's response token returned by captcha provider. When the captchaCheckEnabled = true for the store, the field is mandatory and will call the provider to validate
sap.commerce.webservices: CreateUserQueries
Represents the Queries record for the operation: createUser
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: CreateVerificationTokenInput
Object contains information for obtaining a verification token
Fields
- password? string - User password to authenticate the request. This field is required when the purpose is LOGIN
- loginId string - User login identifier. Target to receive verification token code
- purpose "LOGIN"|"REGISTRATION" - Purpose for which the verification token is requested
sap.commerce.webservices: Currency
Representation of a Currency
Fields
- symbol? string - Symbol of the currency
- isocode? string - Code of the currency in iso format
- name? string - Name of the currency
- active? boolean - Boolean flag whether currency is active
sap.commerce.webservices: CurrencyList
List of currencies
Fields
- currencies? Currency[] - List of currencies
sap.commerce.webservices: CustomerCoupon
Customer coupon
Fields
- endDate? string - End date of the coupon
- notificationOn? boolean - Indicates if notification is enabled or disabled
- name? string - Name of the coupon
- description? string - Description of the coupon
- couponId? string - Coupon identifier
- allProductsApplicable? boolean - Indicates whether the coupon is applicable for all products
- startDate? string - Start date of the coupon
- status? string - Status of the coupon
sap.commerce.webservices: CustomerCoupon2Customer
Customer coupon for customer
Fields
- coupon? CustomerCoupon - The coupon details in the customer-coupon association
- customer? User - The customer associated with the coupon
sap.commerce.webservices: CustomerCouponNotification
Customer coupon notification
Fields
- coupon? CustomerCoupon - Customer coupon details included in the notification
- customer? User - User information for the customer receiving the coupon notification
- status? string - Notification status
sap.commerce.webservices: CustomerCouponSearchResult
Customer coupon search result
Fields
- pagination? Pagination - Pagination information for customer coupon search results
- coupons? CustomerCoupon[] - List of coupon
- sorts? Sort1[] - Sorting information
sap.commerce.webservices: CustomerInterestsSearchPage
Customer interests search page
Fields
- pagination? Pagination - Pagination details for the customer interests search results
- results? ProductInterestRelation[] - List of product interest relation
- sorts? Sort1[] - Sorting information
sap.commerce.webservices: CXML
The cXML containing the order to be processed. It consists of a header that contains fields such as order id, order date,ship to and tax. The payload contains information pertaining to individual items ordered
Fields
- payloadID? string - Unique identifier for the cXML payload
- xmlLang? string - Language specification for the XML document content
- headerOrMessageOrRequestOrResponse? record {}[] - Array of cXML document elements (header, message, request, or response)
- dsSignature? DsSignature[] - Digital signatures for the cXML document
- version? string - Version of the cXML specification used
- signatureVersion? string - Version of the digital signature specification used
- timestamp? string - Timestamp when the cXML document was created
sap.commerce.webservices: DayRange
Maximum and minimum limits of the day range
Fields
- minBoundary Signed32 - Minimum day range
- maxBoundary? Signed32 - Maximum day range. The value null is used for infinite ranges. For example, a minBoundary of 91 and a maxBoundary of null represents a 91+ day range
sap.commerce.webservices: DeliveryMode
Representation of a Delivery mode
Fields
- code? string - Code of the delivery mode
- name? string - Name of the delivery mode
- description? string - Description of the delivery mode
- deliveryCost? Price - Representation of a Price
sap.commerce.webservices: DeliveryModeList
List of delivery modes
Fields
- deliveryModes? DeliveryMode[] - List of delivery modes
sap.commerce.webservices: DeliveryOrderEntryGroup
Representation of a Delivery Order Entry Group
Fields
- entries? OrderEntry[] - List of order entries
- quantity? int - Quantity of order entries in a group
- deliveryAddress? Address - Address object
- totalPriceWithTax? Price - Representation of a Price
sap.commerce.webservices: DeliveryTimeSlot
data type of delivery timeslot
Fields
- code? string - delivery timeslot code
- name? string - delivery timeslot name
sap.commerce.webservices: DeprecatedPagination
Representation of a search results pagination
Fields
- totalResults? int - The total number of matched results across all pages
- totalPages? Signed32 - The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults
- pageSize? Signed32 - The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results
- sort? string - The selected sort code
- currentPage? Signed32 - The current page number. The first page is number zero (0), the second page is number one (1), and so on
sap.commerce.webservices: District
data object of district
Fields
- isocode? string - ISO 3166-1 alpha-2 standard, e.g.[countryIso]-[regionNumber]-[cityNumber]-[districtNumber]
- name? string - name of district
sap.commerce.webservices: DistrictList
list of district
Fields
- districts? District[] - list of district
sap.commerce.webservices: DoAddApproverToOrgCustomerQueries
Represents the Queries record for the operation: doAddApproverToOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoAddBudgetToCostCenterQueries
Represents the Queries record for the operation: doAddBudgetToCostCenter
Fields
- budgetCode string - Budget that will be added to a specific cost center
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoAddOrderApprovalPermissionToOrgUnitUserGroupQueries
Represents the Queries record for the operation: doAddOrderApprovalPermissionToOrgUnitUserGroup
Fields
- orderApprovalPermissionCode string - Order approval permission that will be added to the organizational unit user group
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoAddOrgCartEntriesQueries
Represents the Queries record for the operation: doAddOrgCartEntries
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoAddOrgCustomerToOrgUnitUserGroupMembersQueries
Represents the Queries record for the operation: doAddOrgCustomerToOrgUnitUserGroupMembers
Fields
- orgCustomerId string - Organizational customer that will be added to the organizational unit user group
sap.commerce.webservices: DoAddOrgUnitRoleToOrgCustomerQueries
Represents the Queries record for the operation: doAddOrgUnitRoleToOrgCustomer
Fields
- roleId string - Role that is added to the user. Example role: b2bapprovergroup
sap.commerce.webservices: DoAddOrgUserGroupToOrgCustomerQueries
Represents the Queries record for the operation: doAddOrgUserGroupToOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoAddPermissionToOrgCustomerQueries
Represents the Queries record for the operation: doAddPermissionToOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoAddRoleToOrgCustomerQueries
Represents the Queries record for the operation: doAddRoleToOrgCustomer
Fields
- roleId string - Role that is added to the user
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoApplyCartPromotionQueries
Represents the Queries record for the operation: doApplyCartPromotion
Fields
- promotionId string - Promotion identifier
sap.commerce.webservices: DoApplyCartVoucherQueries
Represents the Queries record for the operation: doApplyCartVoucher
Fields
- voucherId string - Voucher identifier (code)
sap.commerce.webservices: DoCartCloneQueries
Represents the Queries record for the operation: doCartClone
Fields
- name? string - Name of the cloned cart
- description? string - Description of the cloned cart
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoCartSaveQueries
Represents the Queries record for the operation: doCartSave
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoClaimCustomerCouponQueries
Represents the Queries record for the operation: doClaimCustomerCoupon
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoGiveConsentQueries
Represents the Queries record for the operation: doGiveConsent
Fields
- consentTemplateId string - Consent template identifier
- consentTemplateVersion Signed32 - Consent template version
sap.commerce.webservices: DoHandleDigitalPaymentResponseQueries
Represents the Queries record for the operation: doHandleDigitalPaymentResponse
Fields
- sign string - Signed session identifier
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- sid string - Session identifier for digital payments
sap.commerce.webservices: DoHandleSopPaymentResponseQueries
Represents the Queries record for the operation: doHandleSopPaymentResponse
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoMakeOrderApprovalDecisionQueries
Represents the Queries record for the operation: doMakeOrderApprovalDecision
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoRestorePasswordQueries
Represents the Queries record for the operation: doRestorePassword
Fields
- userId string - Customer's user id. Customer user id is case insensitive
sap.commerce.webservices: DoSaveCartQueries
Represents the Queries record for the operation: doSaveCart
Fields
- saveCartName? string - Name of the saved cart
- saveCartDescription? string - Description of the saved cart
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoSubscribeToCustomerCouponQueries
Represents the Queries record for the operation: doSubscribeToCustomerCoupon
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoUpdateFlagForDeletionQueries
Represents the Queries record for the operation: doUpdateFlagForDeletion
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DoUpdateSavedCartQueries
Represents the Queries record for the operation: doUpdateSavedCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: DsCanonicalizationMethod
Digital signature canonicalization method configuration
Fields
- getvalue? string - Value of the canonicalization method
- algorithm? string - Algorithm identifier for the canonicalization method
sap.commerce.webservices: DsDigestMethod
Digital signature digest method configuration
Fields
- getvalue? string - Value of the digest method
- algorithm? string - Algorithm used for the digest method
sap.commerce.webservices: DsKeyInfo
Digital signature key information with value and ID attributes
Fields
- getvalue? string - Value content of the digital signature key info
- id? string - Identifier attribute for the digital signature key info
sap.commerce.webservices: DsObject
Digital signature object containing encoded data with metadata attributes
Fields
- getvalue? string - Value content of the digital signature object
- id? string - Unique identifier for the digital signature object
- mimeType? string - MIME type of the digital signature object content
- encoding? string - Encoding format of the digital signature object
sap.commerce.webservices: DsReference
Digital signature reference containing digest method and value
Fields
- dsTransforms? DsTransforms - Collection of transform operations for digital signature processing
- dsDigestMethod DsDigestMethod - Digital signature digest method configuration
- id? string - Unique identifier for the reference
- 'type? string - Type attribute specifying the reference category
- dsDigestValue string - Computed digest value of the referenced data
- uri? string - URI pointing to the referenced resource
sap.commerce.webservices: DsSignature
Digital signature schema containing XML signature elements and attributes
Fields
- dsSignatureValue DsSignatureValue - Digital signature value container with ID and signature content
- xmlnsXades? string - XML namespace attribute for XAdES signature extensions
- dsKeyInfo? DsKeyInfo - Digital signature key information with value and ID attributes
- dsObject? DsObject[] - Array of digital signature object elements
- xmlnsDs? string - XML namespace attribute for digital signature elements
- id? string - Unique identifier attribute for the digital signature
- dsSignedInfo DsSignedInfo - Digital signature signed info containing canonicalization, signature methods
sap.commerce.webservices: DsSignatureMethod
Digital signature method configuration
Fields
- getvalue? string - Value of the signature method
- algorithm? string - Algorithm identifier for the signature method
sap.commerce.webservices: DsSignatureValue
Digital signature value container with ID and signature content
Fields
- getvalue? string - The actual digital signature value as a string
- id? string - Unique identifier for the digital signature value
sap.commerce.webservices: DsSignedInfo
Digital signature signed info containing canonicalization, signature methods
Fields
- id? string - Unique identifier for the signed info element
- dsCanonicalizationMethod DsCanonicalizationMethod - Digital signature canonicalization method configuration
- dsReference DsReference[] - Array of references to signed elements in the digital signature
- dsSignatureMethod DsSignatureMethod - Digital signature method configuration
sap.commerce.webservices: DsTransform
Digital signature transformation configuration object
Fields
- getvalue? string - Value retrieved from the transformation process
- algorithm? string - Algorithm used for the digital signature transformation
sap.commerce.webservices: DsTransforms
Collection of transform operations for digital signature processing
Fields
- dsTransform DsTransform[] - Array of transform operations to apply to the data
sap.commerce.webservices: DueBalanceRange
Amount due in the specified day range
Fields
- amount? string - Amount due in the specified range
- dayRange? DayRange - Maximum and minimum limits of the day range
sap.commerce.webservices: EntitlementInstance
Representation of an Entitlement Instance
Fields
- number? Signed32 - Number associated with an Entitlement Instance
- productCode? string - Product ID
- quantity? Signed32 - Quantity of an Entitlement Instance
- orderNumber? string - Order Reference Number
- name? string - Entitlement Instance Model Name
- id? string - Guid for Entitlement Instance
- validFrom? string - Valid from date of an Entitlement Instance
- right? string - The Right the entitlement instance gives the users
- 'type? string - Entitlement Instance type name
- region? string - The region of the Entitlement Instance
- status? string - Status Name
- validTo? string - Valid to date of an Entitlement Instance
sap.commerce.webservices: EntitlementInstanceList
Collection of entitlement instances with pagination and sorting options
Fields
- entitlements? EntitlementInstance[] - Entitlement Instance
- pagination? DeprecatedPagination - Representation of a search results pagination
- sorts? Sort[] - Sorting method applied to the return results
sap.commerce.webservices: EntryArrivalSlot
Records of item arrivals facilitate the tracking and management of item quantities, associated arrival times, and certainty levels. These records distinguish between guaranteed, estimated, and unknown arrival scenarios
Fields
- quantity? decimal - Represents the number of items expected to arrive
- at? string - The date associated with the expected arrival slot
- accuracy? "ESTIMATED"|"UNKNOWN" - The accuracy of the arrival slot as estimated, or unknown
sap.commerce.webservices: EntryGroup
Representation of an Entry Group
Fields
- entryGroups? EntryGroup[] - List of child entry groups
- entries? OrderEntry[] - List of order entries
- entryGroupNumber? Signed32 - Identifier of the entry group
- label? string - Label for the entry group
- 'type? string - Indicates type of the group, possible values are STANDALONE, CONFIGURABLEBUNDLE or any customer implemented type for any new provider
- erroneous? boolean - Indicates if the entry group is in an error state
sap.commerce.webservices: Error
Error message
Fields
- reason? string - Additional classification specific for each error type e.g. 'noStock'
- subject? string - Identifier of the related object e.g. '1'
- errorCode? string - Error code
- language? string - The language in which the error message is displayed
- position? Signed32 - The position or sequence number of this error in the error list
- 'type? string - Type of the error e.g. 'LowStockError'
- message? string - Descriptive, human readable error message
- subjectType? string - Type of the object related to the error e.g. 'entry'
- exceptionMessage? string - The detailed exception message describing the error
sap.commerce.webservices: ErrorList
List of errors
Fields
- errors? Error[] - Array of error objects containing detailed error information
sap.commerce.webservices: EventCodeAttachmentsBody
Request body for attaching files to ticket events
Fields
- ticketEventAttachment record { fileContent byte[], fileName string } - File to be attached to a ticket event
sap.commerce.webservices: Facet
Representation of a Facet
Fields
- visible? boolean - Flag stating if facet is visible
- values? FacetValue[] - List of all facet values
- name? string - Name of the facet
- priority? Signed32 - Priority value of the facet
- category? boolean - Flag stating if facet is category facet
- topValues? FacetValue[] - List of top facet values
- multiSelect? boolean - Flag stating if facet is multiSelect
sap.commerce.webservices: FacetValue
Representation of a Facet Value
Fields
- query? SearchState - Representation of a Search State
- name? string - Name of the facet value
- count? int - Count of the facet value
- selected? boolean - Flag stating if facet value is selected
sap.commerce.webservices: Feature
Representation of a Feature
Fields
- featureUnit? FeatureUnit - Representation of a Feature Unit
- code? string - Code of the feature
- name? string - Name of the feature
- description? string - Description of the feature
- range? boolean - Range number of the feature
- 'type? string - Type of the feature
- comparable? boolean - Flag defining it feature is comparable
- featureValues? FeatureValue[] - List of feature values
sap.commerce.webservices: FeatureUnit
Representation of a Feature Unit
Fields
- unitType? string - Type of the feature unit
- symbol? string - Symbol of the feature unit
- name? string - Name of the feature unit
sap.commerce.webservices: FeatureValue
Representation of a Feature Value
Fields
- value? string - Value of the feature
sap.commerce.webservices: FutureStock
Representation of a Future Stock
Fields
- date? string - Date of future stock
- formattedDate? string - Date of future stock expressed in text value
- stock? Stock - Representation of a Stock
sap.commerce.webservices: GeoPoint
Representation of a GeoPoint
Fields
- latitude? decimal - Geopoint latitude
- longitude? decimal - Geopoint longitude
sap.commerce.webservices: GetActiveCostCentersQueries
Represents the Queries record for the operation: getActiveCostCenters
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetAddressesQueries
Represents the Queries record for the operation: getAddresses
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetAddressQueries
Represents the Queries record for the operation: getAddress
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetAllPagesQueries
Represents the Queries record for the operation: getAllPages
Fields
- pageType? "ContentPage"|"ProductPage"|"CategoryPage"|"CatalogPage" - Page type
- pageSize Signed32(default 10) - Number of results returned per page. Default value: 10
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetAllPagesWithUserQueries
Represents the Queries record for the operation: getAllPagesWithUser
Fields
- pageType? "ContentPage"|"ProductPage"|"CategoryPage"|"CatalogPage" - Page type
- pageSize Signed32(default 10) - Number of results returned per page. Default value: 10
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetAvailableOrgCustomersForUserGroupQueries
Represents the Queries record for the operation: getAvailableOrgCustomersForUserGroup
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "name") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetAvailableOrgUnitNodesQueries
Represents the Queries record for the operation: getAvailableOrgUnitNodes
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetAvailableParentUnitsQueries
Represents the Queries record for the operation: getAvailableParentUnits
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetAvailableProductsQueries
Represents the Queries record for the operation: getAvailableProducts
Fields
- query? string - Formatted query string. It contains query criteria like free text search, facet. The format is <freeTextSearch>:<sort>:<facetKey1>:<facetValue1>:...:<facetKeyN>:<facetValueN>
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetBaseSitesQueries
Represents the Queries record for the operation: getBaseSites
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetBaseStoreQueries
Represents the Queries record for the operation: getBaseStore
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetBillingDocumentQueries
Represents the Queries record for the operation: getBillingDocument
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetBranchOrderQueries
Represents the Queries record for the operation: getBranchOrder
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetBudgetQueries
Represents the Queries record for the operation: getBudget
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetBudgetsForCostCenterQueries
Represents the Queries record for the operation: getBudgetsForCostCenter
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetBudgetsQueries
Represents the Queries record for the operation: getBudgets
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "code") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCardTypesQueries
Represents the Queries record for the operation: getCardTypes
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartDeliveryModeQueries
Represents the Queries record for the operation: getCartDeliveryMode
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartDeliveryModesQueries
Represents the Queries record for the operation: getCartDeliveryModes
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartEntriesQueries
Represents the Queries record for the operation: getCartEntries
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartEntryConfigurationQueries
Represents the Queries record for the operation: getCartEntryConfiguration
Fields
- expMode boolean(default false) - If this parameter is provided and its value is true, the system tries to execute the request in expert mode (only possible if the current user belongs to group 'sapproductconfigexpmodegroup'
sap.commerce.webservices: GetCartEntryQueries
Represents the Queries record for the operation: getCartEntry
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartPromotionQueries
Represents the Queries record for the operation: getCartPromotion
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartPromotionsQueries
Represents the Queries record for the operation: getCartPromotions
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartQueries
Represents the Queries record for the operation: getCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartsQueries
Represents the Queries record for the operation: getCarts
Fields
- pageSize Signed32(default 20) - Number of results returned per page if the savedCartsOnly parameter is set to true. Default value: 20
- savedCartsOnly boolean(default false) - If the value is true, only saved carts are returned
- sort? string - Sorting method applied to the return results if the savedCartsOnly parameter is set to true
- currentPage Signed32(default 0) - Pagination for savedCartsOnly. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCartVouchersQueries
Represents the Queries record for the operation: getCartVouchers
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCatalogQueries
Represents the Queries record for the operation: getCatalog
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCatalogsQueries
Represents the Queries record for the operation: getCatalogs
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCatalogVersionQueries
Represents the Queries record for the operation: getCatalogVersion
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCategoriesQueries
Represents the Queries record for the operation: getCategories
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetComponentByIdAndUserQueries
Represents the Queries record for the operation: getComponentByIdAndUser
Fields
- productCode? string - Product code
- catalogCode? string - Catalog code
- categoryCode? string - Category code
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetComponentByIdQueries
Represents the Queries record for the operation: getComponentById
Fields
- productCode? string - Product code
- catalogCode? string - Catalog code
- categoryCode? string - Category code
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetComponentsByIdsAndUserQueries
Represents the Queries record for the operation: getComponentsByIdsAndUser
Fields
- productCode? string - Product code
- componentIds? string[] - List of Component identifiers
- catalogCode? string - Catalog code
- pageSize Signed32(default 10) - Number of results returned per page. Default value: 10
- categoryCode? string - Category code
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetComponentsByIdsQueries
Represents the Queries record for the operation: getComponentsByIds
Fields
- productCode? string - Product code
- componentIds? string[] - List of Component identifiers
- catalogCode? string - Catalog code
- pageSize Signed32(default 10) - Number of results returned per page. Default value: 10
- categoryCode? string - Category code
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetConsentTemplateQueries
Represents the Queries record for the operation: getConsentTemplate
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetConsentTemplatesQueries
Represents the Queries record for the operation: getConsentTemplates
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetConsolidatedPickupLocationsQueries
Represents the Queries record for the operation: getConsolidatedPickupLocations
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetConversationsForAgentQueries
Represents the Queries record for the operation: getConversationsForAgent
Fields
- status "open"|"unassigned" - Conversation status
sap.commerce.webservices: GetCostCenterQueries
Represents the Queries record for the operation: getCostCenter
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCostCentersQueries
Represents the Queries record for the operation: getCostCenters
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCountriesQueries
Represents the Queries record for the operation: getCountries
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- 'type? "SHIPPING"|"BILLING" - The type of countries
sap.commerce.webservices: GetCountryRegionsQueries
Represents the Queries record for the operation: getCountryRegions
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCurrenciesQueries
Represents the Queries record for the operation: getCurrencies
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCurrentOrgCartQueries
Represents the Queries record for the operation: getCurrentOrgCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCustomerCouponsQueries
Represents the Queries record for the operation: getCustomerCoupons
Fields
- needsTotal? "true"|"false" - Flag to indicate if the total number of results is needed or not
- pageSize Signed32(default 10) - The number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCustomerGroupQueries
Represents the Queries record for the operation: getCustomerGroup
Fields
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetCustomerGroupsQueries
Represents the Queries record for the operation: getCustomerGroups
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetDefaultProductConfigurationQueries
Represents the Queries record for the operation: getDefaultProductConfiguration
Fields
- provideAllAttributes boolean(default false) - If this parameter is provided and its value is true, attributes for all groups are returned. Otherwise, attributes only for the first group are considered
- configIdTemplate string(default "") - If this parameter is provided, the template configuration values will be applied to the default configuration
- expMode boolean(default false) - If this parameter is provided and its value is true, the system tries to execute the request in expert mode (only possible if the current user belongs to group 'sapproductconfigexpmodegroup'
- forceReset boolean(default false) - If this parameter is provided and its value is true, the system will force the creation of a new configuration independent of an existing configuration
sap.commerce.webservices: GetDeliveryCountriesQueries
Represents the Queries record for the operation: getDeliveryCountries
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetEntitlementInstanceQueries
Represents the Queries record for the operation: getEntitlementInstance
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Example: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetEntitlementInstancesQueries
Represents the Queries record for the operation: getEntitlementInstances
Fields
- pageSize Signed32(default 100) - The number of results returned per page
- currentPage Signed32(default 1) - The current result page requested
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Example: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetExportedProductsQueries
Represents the Queries record for the operation: getExportedProducts
Fields
- catalog? string - Only products from this catalog are returned. The catalog must be provided along with the version
- pageSize Signed32(default 20) - Number of results returned per page
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- version? string - Only products from this catalog version are returned. The catalog version must be provided along with the catalog
- timestamp? string - Only products that are more recent than the given parameter are returned. The value should be in ISO-8601 format: 2018-01-09T16:28:45+0000
sap.commerce.webservices: GetExpressUpdateProductsQueries
Represents the Queries record for the operation: getExpressUpdateProducts
Fields
- catalog? string - Only products from this catalog are returned. Format: catalogId:catalogVersion
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- timestamp string - Only products that are more recent than the given parameter are returned. The value should be in ISO-8601 format: 2018-01-09T16:28:45+0000
sap.commerce.webservices: GetFutureStocksListQueries
Represents the Queries record for the operation: getFutureStocksList
Fields
- productCodes string - Products identifiers
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetFutureStocksQueries
Represents the Queries record for the operation: getFutureStocks
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetLanguagesQueries
Represents the Queries record for the operation: getLanguages
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetLocationProductStockQueries
Represents the Queries record for the operation: getLocationProductStock
Fields
- latitude? decimal - Coordinate that specifies the north-south position of a point on the Earth's surface
- pageSize Signed32(default 20) - Number of results returned per page
- location? string - Free-text location
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- longitude? decimal - Coordinate that specifies the east-west position of a point on the Earth's surface
sap.commerce.webservices: GetOrderApprovalPermissionQueries
Represents the Queries record for the operation: getOrderApprovalPermission
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderApprovalPermissionsForOrgUnitUserGroupQueries
Represents the Queries record for the operation: getOrderApprovalPermissionsForOrgUnitUserGroup
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "name") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderApprovalPermissionsQueries
Represents the Queries record for the operation: getOrderApprovalPermissions
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderApprovalPermissionTypesQueries
Represents the Queries record for the operation: getOrderApprovalPermissionTypes
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderApprovalQueries
Represents the Queries record for the operation: getOrderApproval
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderApprovalsQueries
Represents the Queries record for the operation: getOrderApprovals
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderQueries
Represents the Queries record for the operation: getOrder
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrderStatusFeedQueries
Represents the Queries record for the operation: getOrderStatusFeed
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- timestamp string - Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000)
sap.commerce.webservices: GetOrgCustomerApproversQueries
Represents the Queries record for the operation: getOrgCustomerApprovers
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "name") - Sorting method applied to the returned results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgCustomerOrgUserGroupsQueries
Represents the Queries record for the operation: getOrgCustomerOrgUserGroups
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "name") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgCustomerPermissionsQueries
Represents the Queries record for the operation: getOrgCustomerPermissions
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "name") - Sorting method applied to the returned results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgCustomerQueries
Represents the Queries record for the operation: getOrgCustomer
Fields
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body
sap.commerce.webservices: GetOrgCustomersQueries
Represents the Queries record for the operation: getOrgCustomers
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "name") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgDocumentsQueries
Represents the Queries record for the operation: getOrgDocuments
Fields
- startRange string(default "") - Lower limit for a specified range filter (for range filterByKeys: orgDocumentIdRange, createdAtDateRange (format: MM/dd/yyyy), dueAtDateRange (format: MM/dd/yyyy), amountRange (number) and openAmountRange (number).)
- endRange string(default "") - Upper limit for a specified range filter (for range filterByKeys: orgDocumentIdRange, createdAtDateRange (format: MM/dd/yyyy), dueAtDateRange (format: MM/dd/yyyy), amountRange (number) and openAmountRange (number).)
- pageSize Signed32(default 10) - Number of results returned per page
- filterByValue string(default "") - Value for a specified filter (for single value filterByKeys: orgDocumentId and orgDocumentType.)
- page Signed32(default 0) - Current result page. Default value is 0
- sort string(default "byCreatedAtDateAsc") - Sorting method applied to the return results. Default value is: byCreatedAtDateAsc
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- filterByKey string(default "orgDocumentId") - Filter to apply on the retrieved list of organizational documents. Possible values are: orgDocumentId, orgDocumentIdRange, orgDocumentType, createdAtDateRange, dueAtDateRange, amountRange, and openAmountRange
- status string(default "open") - Organizational document status. Possible values are: open, closed, and all
sap.commerce.webservices: GetOrgProductQueries
Represents the Queries record for the operation: getOrgProduct
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitAddressesQueries
Represents the Queries record for the operation: getOrgUnitAddresses
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitQueries
Represents the Queries record for the operation: getOrgUnit
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitsAvailableApprovalProcessesQueries
Represents the Queries record for the operation: getOrgUnitsAvailableApprovalProcesses
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitsRootNodeTreeQueries
Represents the Queries record for the operation: getOrgUnitsRootNodeTree
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitUserGroupQueries
Represents the Queries record for the operation: getOrgUnitUserGroup
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitUserGroupsQueries
Represents the Queries record for the operation: getOrgUnitUserGroups
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "uid") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUnitUsersQueries
Represents the Queries record for the operation: getOrgUnitUsers
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the display search results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetOrgUserQueries
Represents the Queries record for the operation: getOrgUser
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetPageByIdAndUserQueries
Represents the Queries record for the operation: getPageByIdAndUser
Fields
- productCode? string - Product code
- categoryCode? string - Category code
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetPageByIdQueries
Represents the Queries record for the operation: getPageById
Fields
- productCode? string - Product code
- categoryCode? string - Category code
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: GetPageQueries
Represents the Queries record for the operation: getPage
Fields
- code? string - Page code. Examples: homepage, electronics, cameras, 585
- pageType? "ContentPage"|"ProductPage"|"CategoryPage"|"CatalogPage" - Page type
- pageLabelOrId? string - Page Label or Id. If no page has a label that matches the page label exactly, try to find pages whose label starts with a section of the page label. Otherwise, try to find the page by id. When label and ID values can match, passing in the pageId parameter may result in obtaining variation pages with the same pageLabel but different pageId. Therefore, it is advisable to use both the pageId and pageLabel parameters to ensure accuracy.Note: URL encoding on the page label should be applied when the label contains special characters
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
- pageId? string - Page id. When pageId is provided, pageLabelOrId will be ignored
- pageLabel? string - Page label. If no page has a label that matches the page label exactly, try to find pages whose label starts with a section of the page label. Note: URL encoding on the page label should be applied when the label contains special characters. When pageLabel is provided, pageLabelOrId will be ignored
sap.commerce.webservices: GetPageWithUserQueries
Represents the Queries record for the operation: getPageWithUser
Fields
- code? string - Page code. Examples: homepage, electronics, cameras, 585
- pageType? "ContentPage"|"ProductPage"|"CategoryPage"|"CatalogPage" - Page type
- pageLabelOrId? string - Page Label or Id. If no page has a label that matches the page label exactly, try to find pages whose label starts with a section of the page label. Otherwise, try to find the page by id. When label and ID values can match, passing in the pageId parameter may result in obtaining variation pages with the same pageLabel but different pageId. Therefore, it is advisable to use both the pageId and pageLabel parameters to ensure accuracy.Note: URL encoding on the page label should be applied when the label contains special characters
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
- pageId? string - Page id. When pageId is provided, pageLabelOrId will be ignored
- pageLabel? string - Page label. If no page has a label that matches the page label exactly, try to find pages whose label starts with a section of the page label. Note: URL encoding on the page label should be applied when the label contains special characters. When pageLabel is provided, pageLabelOrId will be ignored
sap.commerce.webservices: GetPaymentDetailsListQueries
Represents the Queries record for the operation: getPaymentDetailsList
Fields
- saved boolean(default false) - The flag to mark if the detailed payment is a saved one
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetPaymentDetailsQueries
Represents the Queries record for the operation: getPaymentDetails
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetPaymentModesQueries
Represents the Queries record for the operation: getPaymentModes
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetPaymentTypesQueries
Represents the Queries record for the operation: getPaymentTypes
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetProductAvailabilityQueries
Represents the Queries record for the operation: getProductAvailability
Fields
- filters string - Product codes and their respective units in which the availability should be retrieved. In the following format - productCodeA:unitCodeA,unitCodeB;productCodeB:unitCodeA,unitCodeB. Example - 3318057_A:EA,PC;4112097_B:EA
sap.commerce.webservices: GetProductConfigurationPricingQueries
Represents the Queries record for the operation: getProductConfigurationPricing
Fields
- groupId? string - Specifies the group for which the value prices are requested; if not specified, no value prices are returned
sap.commerce.webservices: GetProductConfigurationQueries
Represents the Queries record for the operation: getProductConfiguration
Fields
- groupId? string - If the parameter is provided, only the attributes of the requested group are returned. If the parameter is not provided, attributes for all groups are returned
- attributeKeyRequiresDomain? string - If this parameter is provided, the system will provide the domain values for the specified attribute
- expMode boolean(default false) - If this parameter is provided and its value is true, the system tries to execute the request in expert mode (only possible if the current user belongs to group 'sapproductconfigexpmodegroup'
sap.commerce.webservices: GetProductInterestsQueries
Represents the Queries record for the operation: getProductInterests
Fields
- needsTotal "true"|"false" (default "true") - Flag to indicate if the total number of results is needed or not
- productCode? string - Product identifier
- pageSize string(default "20") - The number of results returned per page
- notificationType? string - Notification type
- sort? string - Sorting method applied to the return results. Default value is by name
- currentPage string(default "0") - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetProductQueries
Represents the Queries record for the operation: getProduct
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetProductReferencesQueries
Represents the Queries record for the operation: getProductReferences
Fields
- pageSize Signed32(default 2147483647) - Number of results returned per page
- referenceType? string - Comma-separated list of reference types. If not specified, all types of product references will be used. Example: ACCESSORIES,BASE_PRODUCT
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetProductReviewsQueries
Represents the Queries record for the operation: getProductReviews
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- maxCount? Signed32 - Maximum number of reviews
sap.commerce.webservices: GetProductsByCategoryQueries
Represents the Queries record for the operation: getProductsByCategory
Fields
- query? string - Formatted query string. It contains query criteria like free text search, facet. The format is <freeTextSearch>:<sort>:<facetKey1>:<facetValue1>:...:<facetKeyN>:<facetValueN>
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetProductsQueries
Represents the Queries record for the operation: getProducts
Fields
- query? string - Formatted query string. It contains query criteria like free text search, facet. The format is <freeTextSearch>:<sort>:<facetKey1>:<facetValue1>:...:<facetKeyN>:<facetValueN>
- pageSize Signed32(default 20) - Number of results returned per page
- filters? string - Filter conditions that combine attribute keys and attribute values. The attributes are the fields or properties for the Product type configured in the search index type. The format is <attributeKey1>:<attributeValue1>:...:<attributeKeyN>:<attributeValueN>
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- searchQueryContext? string - Name of the search query template to be used in the search query. Examples: DEFAULT, SUGGESTIONS
sap.commerce.webservices: GetPromotionQueries
Represents the Queries record for the operation: getPromotion
Fields
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetPromotionsQueries
Represents the Queries record for the operation: getPromotions
Fields
- promotionGroup? string - Only promotions from this group are returned
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- 'type "all"|"product"|"order" - Type of promotions that should be returned. Possible values are: <ul><li>all: All available promotions are returned. </li><li>product: Only product promotions are returned. </li><li>order: Only order promotions are returned. </li></ul>
sap.commerce.webservices: GetPunchOutSessionInfoQueries
Represents the Queries record for the operation: getPunchOutSessionInfo
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetQuoteQueries
Represents the Queries record for the operation: getQuote
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetQuotesQueries
Represents the Queries record for the operation: getQuotes
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetReplenishmentOrderHistoryQueries
Represents the Queries record for the operation: getReplenishmentOrderHistory
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "code") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetReplenishmentOrderQueries
Represents the Queries record for the operation: getReplenishmentOrder
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetReplenishmentOrdersQueries
Represents the Queries record for the operation: getReplenishmentOrders
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "code") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetRequisitionFormDataQueries
Represents the Queries record for the operation: getRequisitionFormData
Fields
- discardCartEntries boolean(default false) - Requisition form that generates data with or without cart entries. If true, it will generate data with an empty cart. If false, it will generate data with cart entries
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetReturnRequestQueries
Represents the Queries record for the operation: getReturnRequest
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetReturnRequestsQueries
Represents the Queries record for the operation: getReturnRequests
Fields
- pageSize Signed32(default 20) - Number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetSavedCartQueries
Represents the Queries record for the operation: getSavedCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetSopPaymentRequestDetailsQueries
Represents the Queries record for the operation: getSopPaymentRequestDetails
Fields
- responseUrl string - The URL that the payment provider uses to return payment information. Possible values for responseUrl include the following: “orderPage_cancelResponseURL”, “orderPage_declineResponseURL”, and “orderPage_receiptResponseURL”
- extendedMerchantCallback boolean(default false) - Define which url should be returned
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetSopPaymentResponseQueries
Represents the Queries record for the operation: getSopPaymentResponse
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetStoreLocationQueries
Represents the Queries record for the operation: getStoreLocation
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetStoreLocationsQueries
Represents the Queries record for the operation: getStoreLocations
Fields
- latitude? decimal - Coordinate that specifies the north-south position of a point on the Earth's surface
- query? string - Location in plain text. Example: USA or New York City
- accuracy decimal(default 0) - Accuracy in meters
- pageSize Signed32(default 20) - Number of results returned per page
- sort string(default "asc") - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- radius decimal(default 100000.0) - Radius in meters. Max value: 40075000.0 (Earth's perimeter)
- longitude? decimal - Coordinate that specifies the east-west position of a point on the Earth's surface
sap.commerce.webservices: GetStoreProductStockQueries
Represents the Queries record for the operation: getStoreProductStock
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetStoresByCountryAndRegionQueries
Represents the Queries record for the operation: getStoresByCountryAndRegion
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetStoresByCountryQueries
Represents the Queries record for the operation: getStoresByCountry
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetSuggestionsQueries
Represents the Queries record for the operation: getSuggestions
Fields
- max Signed32(default 10) - Maximum number of results
- term string - Specified term. The suggestions will be given based on it
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetTicketAssociatedObjectsQueries
Represents the Queries record for the operation: getTicketAssociatedObjects
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetTicketCategoriesQueries
Represents the Queries record for the operation: getTicketCategories
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetTicketQueries
Represents the Queries record for the operation: getTicket
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetTicketsQueries
Represents the Queries record for the operation: getTickets
Fields
- pageSize Signed32(default 20) - Number of results returned per page. Example: 20
- sort string(default "byDate") - Sorting method applied to the return results. Possible values are: byDate and byTicketId
- currentPage Signed32(default 0) - The current result page requested. Default value is 0
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetTitlesQueries
Represents the Queries record for the operation: getTitles
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserBranchOrderHistoryQueries
Represents the Queries record for the operation: getUserBranchOrderHistory
Fields
- pageSize Signed32(default 20) - The number of results returned per page
- statuses? string - Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID
- filters? string - Serialized filters applied to the query in the following format: ::facetKey1:facetValue1:facetKey2:facetValue2. Correct values for facetKey are 'user' and 'unit'
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserCustomerGroupsQueries
Represents the Queries record for the operation: getUserCustomerGroups
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserOrderAttachmentsQueries
Represents the Queries record for the operation: getUserOrderAttachments
Fields
- pageSize Signed32(default 20) - The number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - The current result page requested
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserOrderHistoryQueries
Represents the Queries record for the operation: getUserOrderHistory
Fields
- pageSize Signed32(default 20) - The number of results returned per page
- statuses? string - Filters orders with specified status(es). For example, statuses = CANCELLED returns CANCELLED orders. To filter multiple statuses, separate statuses with "," and all orders with these statuses will be returned. For example, statuses = CANCELLED,COMPLETED,READY returns all orders with statuses CANCELLED, COMPLETED, and READY. Options available are: CANCELLING, CHECKED_VALID, CREATED, OPEN, READY, CHECKED_INVALID, ON_HOLD, ON_VALIDATION, PENDING_APPROVAL, SUSPENDED, COMPLETED, PAYMENT_AUTHORIZED, PENDING_APPROVAL_FROM_MERCHANT, CANCELLED, PAYMENT_NOT_AUTHORIZED, PENDING_QUOTE, APPROVED_QUOTE, PAYMENT_AMOUNT_RESERVED, PAYMENT_AMOUNT_NOT_RESERVED, REJECTED_QUOTE, APPROVED, PAYMENT_CAPTURED, PAYMENT_NOT_CAPTURED, REJECTED, APPROVED_BY_MERCHANT, FRAUD_CHECKED, ORDER_SPLIT, REJECTED_BY_MERCHANT, ASSIGNED_TO_ADMIN, PROCESSING_ERROR, B2B_PROCESSING_ERROR, WAIT_FRAUD_MANUAL_CHECK, PAYMENT_NOT_VOIDED, TAX_NOT_VOIDED, TAX_NOT_COMMITTED, TAX_NOT_REQUOTED
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserOrderInvoiceBinaryQueries
Represents the Queries record for the operation: getUserOrderInvoiceBinary
Fields
- externalSystemId? string - External system identifier where the invoice resides
sap.commerce.webservices: GetUserOrderInvoicesQueries
Represents the Queries record for the operation: getUserOrderInvoices
Fields
- pageSize Signed32(default 20) - The number of results returned per page
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - The current result page requested
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserOrdersQueries
Represents the Queries record for the operation: getUserOrders
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetUserQueries
Represents the Queries record for the operation: getUser
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetVoucherByCodeQueries
Represents the Queries record for the operation: getVoucherByCode
Fields
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: GetVoucherQueries
Represents the Queries record for the operation: getVoucher
Fields
- fields string(default "BASIC") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: Image
Representation of an Image
Fields
- altText? string - Tooltip content which is visible while image mouse hovering
- format? string - Format of the image, can be zoom, product, thumbnail, store, cartIcon, etc
- galleryIndex? Signed32 - Index of the image while displayed in gallery
- imageType? "PRIMARY"|"GALLERY" - Type of the image, can be PRIMARY or GALLERY
- url? string - URL address of the image
sap.commerce.webservices: Language
Representation of a Language
Fields
- nativeName? string - name the language in native form
- isocode? string - iso code of the language
- name? string - name of the language
- active? boolean - true/false indicator when the language is active
sap.commerce.webservices: LanguageList
List of languages
Fields
- languages? Language[] - This is the list of Language fields that should be returned in the response body
sap.commerce.webservices: MemberList
List of users to assign to customer group
Fields
- members? Principal[] - List of member
sap.commerce.webservices: NotificationPreference
Notification preference
Fields
- visible? boolean - if true, the channel is visible; if false, the channel is invisible
- channel? string - preference channel
- value? string - the corresponding value of current channel, for example, for SMS it should be a mobile number; for email it should be an email address
- enabled? boolean - if true, the channel is on; if false, the channel is off
sap.commerce.webservices: NotificationPreferenceList
Notification preference list
Fields
- preferences? NotificationPreference[] - notification preferences
sap.commerce.webservices: OAuth2ClientCredentialsGrantConfig
Closed record
OAuth2 Client Credentials Grant Configs
Fields
- tokenUrl string(default "http://localhost:9090/v1/authorizationserver/oauth/token") - Token URL
sap.commerce.webservices: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- refreshUrl string(default "http://localhost:9090/v1/authorizationserver/oauth/token") - Refresh URL
sap.commerce.webservices: OpeningSchedule
Representation of an Opening schedule
Fields
- code? string - Code of the opening schedule
- specialDayOpeningList? SpecialOpeningDay[] - List of special opening days
- name? string - Name of the opening schedule
- weekDayOpeningList? WeekdayOpeningDay[] - List of weekday opening days
sap.commerce.webservices: Order
Representation of a order. Note that sapBillingAddress is mutually exclusive with paymentInfo.billingAddress, which is used when the billing address is created concurrently with the paymentInfo. sapBillingAddress is used when there is a need to save the billing address, but the related paymentInfo has not been created yet
Fields
- orgCustomer? User - User's object
- appliedProductPromotions? PromotionResult[] - List of applied product promotions
- sapCustomerEmail? string - Email of customer
- sapPaymentOptionId? string - The payment option identifier. It specifies which option the consumer selected to make the payment for the cart
- subTotal? Price - Representation of a Price
- cancellable? boolean - Boolean flag showing if order is cancellable
- totalTax? Price - Representation of a Price
- appliedVouchers? Voucher[] - List of applied vouchers
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- deliveryAddress? Address - Address object
- net? boolean - Flag stating iv value is net-value
- calculated? boolean - Flag showing if order is calculated
- sapBillingAddress? Address - Address object
- productDiscounts? Price - Representation of a Price
- appliedOrderPromotions? PromotionResult[] - List of applied order promotions
- created? string - Date of order creation
- costCenter? B2BCostCenter - Cost center object
- orgUnit? B2BUnit - Organizational unit object
- chinesePaymentInfo? ChinesePaymentInfo - Chinese payment info
- orderDiscounts? Price - Representation of a Price
- paymentAddress? Address - Address object
- entries? OrderEntry[] - List of order entries
- returnable? boolean - Boolean flag showing if order is returnable
- unconsignedEntries? OrderEntry[] - List of unconsigned order entries
- totalUnitCount? Signed32 - Total number of individual units across all items in the order
- guid? string - Guest user id identifier
- deliveryStatusDisplay? string - Order delivery status display
- deliveryOrderGroups? DeliveryOrderEntryGroup[] - List of delivery order entries group
- deliveryStatus? string - Order delivery status
- status? string - Status of order
- requestedRetrievalAt? string - Customer requested date for order retrieval
- code? string - Code number of order
- totalPrice? Price - Representation of a Price
- totalDiscounts? Price - Representation of a Price
- guestCustomer? boolean - Flag showing if customer is Guest customer
- serviceReschedulable? boolean - If Service product Exist,Service Order is Reschedubale or not.If Service Product Doesnt Exits the valuue will be set as False. The flags are used to show/hide the 'Service Order Reschedule' button in UI
- paymentType? B2BPaymentType - Payment method type available for B2B transactions
- servicedAt? string - Requested Seervice Date for all service products in cart/Order
- taxInvoice? TaxInvoice - data type of tax invoice
- deliveryItemsQuantity? int - Quantity of delivery items
- totalPriceWithTax? Price - Representation of a Price
- sapQuoteCode? string - Quote Code associated with the Order. The Quote Code is present if the order was placed from a quote
- paymentStatus? string - Payment status
- permissionResults? OrderApprovalPermissionResult[] - Results of permissions associated with the order
- serviceCancellable? boolean - If Service product Exist,based on condition Service Order is cancellable or not.If Service Product Doesnt Exits the valuue will be set as False.The flags are used to show/hide the 'Service Order Cancel' button in UI
- entryGroups? EntryGroup[] - List of entry groups
- totalItems? Signed32 - Total number of distinct items in the order
- statusDisplay? string - Status display
- pickupOrderGroups? PickupOrderEntryGroup[] - List of pickup order entry group
- store? string - Store
- site? string - Site
- deliveryTimeSlot? DeliveryTimeSlot - data type of delivery timeslot
- purchaseOrderNumber? string - Purchase order number
- billingDocuments? BillingDocument[] - Billing documents associated with the order
- pickupItemsQuantity? int - Quantity of pickup items
- consignments? Consignment[] - List of consignment
- user? Principal - Representation of a Principal webservice DTO used for defining User data types
- paymentInfo? PaymentDetails - Payment details object
- deliveryCost? Price - Representation of a Price
sap.commerce.webservices: OrderApproval
Details of one specific order approval
Fields
- code string - Code that identifies the approval
- approvalDecisionRequired? boolean - Boolean flag which states whether an approval decision is required
- customerOrderApprovalRecords? OrderApprovalRecord[] - Customer approval records related to this order approval
- trigger? Trigger - Representation of a Trigger
- 'order? Order - Representation of a order. Note that sapBillingAddress is mutually exclusive with paymentInfo.billingAddress, which is used when the billing address is created concurrently with the paymentInfo. sapBillingAddress is used when there is a need to save the billing address, but the related paymentInfo has not been created yet
- merchantOrderApprovalRecords? OrderApprovalRecord[] - Merchant approval records related to this order approval
sap.commerce.webservices: OrderApprovalDecision
The order approval decision. The approval decision field is mandatory, and the approval comment field is mandatory if the decision is 'rejected'
Fields
- decision string - Decision from the approver when approving/rejecting an order. Typical decisions are: APPROVE, REJECT
- comment? string - Any comments the approver (or the workflow system) adds when approving/rejecting an order
sap.commerce.webservices: OrderApprovalList
Representation of a Order Approval List
Fields
- orderApprovals OrderApproval[] - List of Order Approvals
- pagination DeprecatedPagination - Representation of a search results pagination
- sorts Sort[] - List of sorts
sap.commerce.webservices: OrderApprovalPermission
Order Approval Permission object
Fields
- code string - Code of the Order Approval Permission
- orderApprovalPermissionType? OrderApprovalPermissionType - Request body fields required and optional to operate on Order Approval Permission Type data. Typical permission types are: B2BBudgetExceededPermission, B2BOrderThresholdTimespanPermission and B2BOrderThresholdPermission
- orgUnit? B2BUnit - Organizational unit object
- active? boolean - Boolean flag of whether Order Approval Permission is active
- currency? Currency - Representation of a Currency
- periodRange? "DAY"|"WEEK"|"MONTH"|"QUARTER"|"YEAR" - Period range of the Order Approval Permission, used for type B2BOrderThresholdTimespanPermission
- threshold? decimal - Threshold value of the Order Approval Permission, used for type B2BOrderThresholdPermission and B2BOrderThresholdTimespanPermission
- selected? boolean - Boolean flag of whether the user is selected
sap.commerce.webservices: OrderApprovalPermissionList
Representation of a Order Approval Permission List
Fields
- pagination DeprecatedPagination - Representation of a search results pagination
- orderApprovalPermissions OrderApprovalPermission[] - List of Order Approval Permissions
- sorts Sort[] - List of sorts
sap.commerce.webservices: OrderApprovalPermissionResult
Details of an order approval permission result related to an order
Fields
- permissionType? OrderApprovalPermissionType - Request body fields required and optional to operate on Order Approval Permission Type data. Typical permission types are: B2BBudgetExceededPermission, B2BOrderThresholdTimespanPermission and B2BOrderThresholdPermission
- statusDisplay? string - Status of the order approval
- approverNotes? string - Any comments the approver added to the approval item
- approverName? string - Name of the approver responsible for this permission result
sap.commerce.webservices: OrderApprovalPermissionType
Request body fields required and optional to operate on Order Approval Permission Type data. Typical permission types are: B2BBudgetExceededPermission, B2BOrderThresholdTimespanPermission and B2BOrderThresholdPermission
Fields
- code string - Code of the Order Approval Permission Type
- name? string - Name of the Order Approval Permission Type
sap.commerce.webservices: OrderApprovalPermissionTypeList
Representation of an Order Approval Permission Type list
Fields
- orderApprovalPermissionTypes OrderApprovalPermissionType[] - List of Order Approval Permission Types
sap.commerce.webservices: OrderApprovalRecord
Details of one order approval record
Fields
- approver? Principal - Representation of a Principal webservice DTO used for defining User data types
- comments? string - Any comments the approver (or the workflow system) added to the approval item
- statusDisplay? string - Status of the order approval
- permissionTypes? OrderApprovalPermissionType[] - List of permission types related to this approval record
sap.commerce.webservices: OrderEntry
Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name)
The DTO is in XML or .json format
Fields
- quantityReturned? int - Number of items returned for this order entry
- updateable? boolean - Flag defining if order entry item is updateable
- quantityCancelled? int - Number of items cancelled for this order entry
- totalPrice? Price - Representation of a Price
- deliveryPointOfService? PointOfService - Representation of a Point of service
- cancelledItemsPrice? Price - Representation of a Price
- quantityAllocated? int - Number of items allocated for this order entry
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- statusSummaryList? StatusSummary[] - List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty
- scheduleLines? ScheduleLine[] - List of ScheduleLine
- returnedItemsPrice? Price - Representation of a Price
- basePrice? Price - Representation of a Price
- product? Product - Representation of a Product
- quantity? int - Quantity number of items in order entry
- comments? Comment[] - List of order entry comments
- cancellableQuantity? int - Quantity number of cancellable items in order entry
- quantityPending? int - Number of items in the order entry awaiting processing or fulfillment
- cpqDiscounts? CpqQuoteEntryDiscount[] - Discounts of the quote
- url? string - URL reference or link associated with the order entry
- returnableQuantity? int - Quantity number of returnable items in order entry
- quantityShipped? int - Number of items in the order entry that have been shipped
- arrivalSlots? EntryArrivalSlot[] - List of item arrival slot
- entryNumber? Signed32 - Entry number of the order entry
- configurationInfos? ConfigurationInfo[] - Configuration info of order entry
- quantityUnallocated? int - Number of items in the order entry not yet allocated to inventory
sap.commerce.webservices: OrderEntryList
List of entries containing the amount to add and the product code or the entryNumber
Fields
- orderEntries? OrderEntry[] - List of order entries
sap.commerce.webservices: OrderForm
Order form containing entries, code, description, currency, and user details
Fields
- entries? OrderFormEntry[] - List of order form entries
- code? string - Unique code identifying the order form
- description? string - Description of the order form
- currency? Currency - Representation of a Currency
- user? Principal - Representation of a Principal webservice DTO used for defining User data types
sap.commerce.webservices: OrderFormEntry
Represents an order entry with quantity and SKU information
Fields
- quantity? Signed32 - The quantity of items for this order entry
- sku? string - The stock keeping unit identifier for the product
sap.commerce.webservices: OrderFormList
Container for a collection of order forms
Fields
- orderForms? OrderForm[] - Array of order form objects
sap.commerce.webservices: OrderHistory
Representation of an Order History
Fields
- orgCustomer? User - User's object
- total? Price - Representation of a Price
- code? string - Code of Order History
- placed? string - Date of placing order
- statusDisplay? string - Status display
- costCenter? B2BCostCenter - Cost center object
- orgUnit? B2BUnit - Organizational unit object
- purchaseOrderNumber? string - Purchase order number
- guid? string - Guest user identifier
- status? string - Status of Order History
sap.commerce.webservices: OrderHistoryList
Representation of an Order History List
Fields
- pagination? DeprecatedPagination - Representation of a search results pagination
- orders? OrderHistory[] - List of order history items
- sorts? Sort[] - List of sorts
- facets? Facet[] - List of facets
sap.commerce.webservices: OrderStatusUpdateElement
Representation of an Order Status Update Element
Fields
- code? string - Code of update element of order status
- baseSiteId? string - BaseSite identifier
- status? string - Status of update element
sap.commerce.webservices: OrderStatusUpdateElementList
Representation of an Order Status Update Element List
Fields
- orderStatusUpdateElements? OrderStatusUpdateElement[] - List of order status update elements
sap.commerce.webservices: OrgCustomerCreation
Data object that contains information necessary for user creation
Fields
- firstName? string - First name of the user
- lastName? string - Last name of the user
- orgUnit? B2BUnit - Organizational unit object
- roles? string[] - List of organizational approvers
- email? string - Email of the user
- titleCode? string - Code of the user's title
sap.commerce.webservices: OrgCustomerModification
Data object which contains information necessary for user modification
Fields
- firstName? string - First name of the user
- lastName? string - Last name of the user
- password? string - Password of the user
- orgUnit? B2BUnit - Organizational unit object
- roles? string[] - List of organizational approvers
- active? boolean - Boolean flag of whether the user is active/enabled or not
- email? string - Email of the user
- titleCode? string - Code of the user's title
sap.commerce.webservices: OrgDocument
Representation of an organizational document
Fields
- formattedOpenAmount? string - Open amount due for the organizational document, formatted as per the selected currency
- createdAtDate? string - Creation date for the organizational document
- amount decimal - Original amount due for the organizational document
- orgDocumentType? OrgDocumentType - Representation of an organizational document type
- attachments? OrgDocumentAttachment[] - Attachments associated to the organizational document
- currency Currency - Representation of a Currency
- id string - Unique identifier for the organizational document
- dueAtDate? string - Due date for the organizational document
- formattedAmount string - Original amount due for the organizational document, formatted as per the selected currency
- openAmount? decimal - Open amount due for the organizational document
- status string - Organizational document status. Possible values are: open, closed
sap.commerce.webservices: OrgDocumentAttachment
Attachments associated to the organizational document
Fields
- id? string - Organizational document attachment identifier
sap.commerce.webservices: OrgDocumentList
Representation of a list of organizational documents for the organizational unit
Fields
- orgDocumentTypes? OrgDocumentType[] - List of organizational document types
- pagination DeprecatedPagination - Representation of a search results pagination
- sorts? Sort[] - List of sort codes
- orgDocuments OrgDocument[] - List of organizational documents
sap.commerce.webservices: OrgDocumentType
Representation of an organizational document type
Fields
- code string - Organizational document type code
- name? string - Organizational document type name
sap.commerce.webservices: OrgUnitReference
Reference to organizational unit
Fields
- uid string - Identifier of the organizational unit
- name? string - Name of the organizational unit
sap.commerce.webservices: OrgUnitUserGroup
Organizational unit user group object
Fields
- uid? string - Unique user identifier
- membersCount? Signed32 - Number of members
- permissions? OrderApprovalPermission[] - Order approval permission of the user group
- members? Principal[] - List of members
- orgUnit? B2BUnit - Organizational unit object
- roles? string[] - List of Roles
- name? string - Name of the user
- subGroups? UserGroup[] - List of subgroups
- selected? boolean - Boolean flag of whether a user group is selected or not
sap.commerce.webservices: OrgUnitUserGroupList
Representation of an user list used in organizational units
Fields
- pagination DeprecatedPagination - Representation of a search results pagination
- orgUnitUserGroups OrgUnitUserGroup[] - List of organizational unit user groups
- sorts Sort[] - List of sorts
sap.commerce.webservices: OrgUnitUserList
Representation of an user list used in organizational units
Fields
- pagination DeprecatedPagination - Representation of a search results pagination
- sorts Sort[] - List of sorts
- users User[] - List of users
sap.commerce.webservices: OrgUserRegistrationData
Data object that contains information necessary to apply user registration
Fields
- firstName string - First name of the user
- lastName string - Last name of the user
- verificationTokenCode? string - Code included in the email sent to the customer to be registered. Only needed when OTP for registration is enabled
- message? string - Contains info to approver, usually composed by UI with a template
- verificationTokenId? string - Authentication identifier of a new B2B customer registration. Only needed when OTP for registration is enabled
- titleCode? string - Code of the user's title
- email string - Email of the user
sap.commerce.webservices: PackagingInfo
Representation of a Packaging Information
Fields
- grossWeight? string - Total weight of the package including contents
- width? string - Width dimension of the package
- length? string - Length dimension of the package
- insuredValue? string - Insurance value declared for the package
- dimensionUnit? string - Unit of measurement for package dimensions
- height? string - Height dimension of the package
- weightUnit? string - Unit of measurement for package weight
sap.commerce.webservices: Pagination
Pagination info
Fields
- count? Signed32 - Number of elements on this page
- totalPages? Signed32 - Total number of pages
- hasPrevious? boolean - Indicates if there is previous page
- hasNext? boolean - Indicates if there is next page
- page? Signed32 - Current page number
- totalCount? int - Total number of elements
sap.commerce.webservices: PasswordRestoreTokenInput
Object contains information required for creating and sending a token to restore a forgotten password
Fields
- loginId string - User login identifier. Target to receive the token
sap.commerce.webservices: PaymentAuthorizedOrderPlacementQueries
Represents the Queries record for the operation: paymentAuthorizedOrderPlacement
Fields
- cartId string - Cart code for logged in user, cart GUID for guest checkout
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: PaymentDetails
Payment details object
Fields
- startMonth? string - Start month from which payment is valid
- saved? boolean - Flag to mark if payment is saved one
- issueNumber? string - Issue number
- cardType? CardType - Representation of a Card Type
- startYear? string - Start year from which payment is valid
- expiryMonth? string - Month of expiration of payment
- expiryYear? string - Year of expiration of payment
- accountHolderName? string - Name of account holder
- defaultPayment? boolean - Flag to mark if payment the default one
- sapPaymentMethod? SAPPaymentMethod - Payment Method
- id? string - Unique identifier of payment detail
- billingAddress? Address - Address object
- subscriptionId? string - Identifier of subscription
- cardNumber? string - Payment card number
sap.commerce.webservices: PaymentDetailsList
Representation of a Payment details list
Fields
- payments? PaymentDetails[] - List of payment details
sap.commerce.webservices: PaymentMode
Representation of a Payment Mode
Fields
- pspLogoUrl? string - Logo url of payment mode
- code? string - Payment mode code
- name? string - Payment mode name
- description? string - Payment mode description
sap.commerce.webservices: PaymentModeList
List of payment modes
Fields
- paymentModes? PaymentMode[] - List of payment modes
sap.commerce.webservices: PaymentRequest
Payment request containing URL endpoint and parameters for processing
Fields
- postUrl? string - Target URL endpoint for submitting the payment request
sap.commerce.webservices: PickupOrderEntryGroup
Representation of a Pickup Order Entry Group
Fields
- entries? OrderEntry[] - List of order entries
- quantity? int - Quantity of order entries in a group
- distance? decimal - Distance calculated to pickup place
- deliveryPointOfService? PointOfService - Representation of a Point of service
- totalPriceWithTax? Price - Representation of a Price
sap.commerce.webservices: PlaceOrderQueries
Represents the Queries record for the operation: placeOrder
Fields
- cartId string - Cart code for logged in user, cart GUID for guest checkout
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: PlaceOrgOrderQueries
Represents the Queries record for the operation: placeOrgOrder
Fields
- cartId string - Cart identifier: cart code for logged-in user, cart GUID for anonymous user, or 'current' for the last modified cart
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- termsChecked boolean - Whether terms were accepted or not
sap.commerce.webservices: PointOfService
Representation of a Point of service
Fields
- address? Address - Address object
- displayName? string - Display name of the point of service
- description? string - Description of the point of service
- formattedDistance? string - Distance to the point of service as text value
- distanceKm? decimal - Distance to the point of service as number value
- warehouseCodes? string[] - List of warehouse codes associated with this point of service
- geoPoint? GeoPoint - Representation of a GeoPoint
- pickUpInStoreInstructions? string - Instructions used for picking up an order in store
- url? string - Url address of the point of service
- mapIcon? Image - Representation of an Image
- features? record { string... } - List of features for a given point of service
- storeImages? Image[] - Collection of images associated with a point of service
- name? string - Name of the point of service
- openingHours? OpeningSchedule - Representation of an Opening schedule
- storeContent? string - Store content of given point of service
sap.commerce.webservices: PointOfServiceList
Representation of a Point of Service List
Fields
- pointOfServices? PointOfService[] - List of points of service
sap.commerce.webservices: PointOfServiceStock
Representation of a Point Of Service Stock
Fields
- address? Address - Physical address of the point of service location
- displayName? string - Display name of the point of service
- description? string - Description of the point of service
- formattedDistance? string - Distance to the point of service as text value
- distanceKm? decimal - Distance to the point of service as number value
- warehouseCodes? string[] - List of warehouse codes associated with the point of service
- geoPoint? GeoPoint - Geographic coordinates of the point of service location
- pickUpInStoreInstructions? string - Instructions used for picking up an order in store
- url? string - Url address of the point of service
- mapIcon? Image - Icon image displayed for the point of service on maps
- features? map<anydata> - List of features for a given point of service
- storeImages? Image[] - Collection of images associated with a point of service
- stockInfo? Stock - Stock information for the point of service location
- name? string - Name of the point of service
- openingHours? OpeningSchedule - Operating hours schedule for the point of service location
- storeContent? string - Store content of given point of service
sap.commerce.webservices: Price
Representation of a Price
Fields
- currencyIso? string - Currency iso format
- minQuantity? int - Minimum quantity of the price value
- maxQuantity? int - Maximum quantity of the price value
- priceType? "BUY"|"FROM" - Type of the price
- formattedValue? string - Value of price formatted
- value? decimal - Value of price in BigDecimal format
sap.commerce.webservices: PriceRange
Representation of a Price Range
Fields
- minPrice? Price - Representation of a Price
- maxPrice? Price - Representation of a Price
sap.commerce.webservices: Principal
Representation of a Principal webservice DTO used for defining User data types
Fields
- uid? string - Unique user identifier
- name? string - Name of the user
sap.commerce.webservices: Product
Representation of a Product
Fields
- availableForPickup? boolean - Flag defining if product is available for pickup
- volumePricesFlag? boolean - Flag stating if volume price should be displayed
- purchasable? boolean - Flag defining if product is purchasable
- code? string - Code of the product
- sapUnit? SAPUnit - Representation of a Unit
- bundleTemplates? BundleTemplate[] - Set of bundle templates that are identified as starter components and can initiate a bundle in the cart
- numberOfReviews? Signed32 - Number of reviews associated with the product
- variantMatrix? VariantMatrixElement[] - List of variant matrixes associated with the product
- description? string - Description of the product
- sapAddToCartDisabled? boolean - Flag specifies whether product can be added to cart. When addToCartDisabled=true, the product is not allowed to be added into cart and the reason is explained through sapAddToCartDisabledMessage; when addToCartDisabled=false, the product is allowed to be added into cart
- manufacturer? string - Data of product manufacturer
- variantType? string - Variant type of the product
- reviews? Review[] - List of reviews associated with the product
- variantOptions? VariantOption[] - List of variant options related to the product
- price? Price - Representation of a Price
- averageRating? decimal - Rating number of average value
- firstVariantImage? string - URL or path to the first variant's product image
- categories? Category[] - List of categories product belongs to
- potentialPromotions? Promotion[] - List of potential promotions related to the product
- stock? Stock - Representation of a Stock
- summary? string - Product summary
- images? Image[] - List of images linked to product
- baseProduct? string - Information about base product
- productTypes? string - Product Type tells what type of product it is eg. SERVICE or PHYSICAL or SUBSCRIPTION or any Custom defined types can be added.It can be multiple type of produuct which will be seperated by commas
- url? string - Url address of the product
- firstVariantCode? string - Product code identifier for the first available variant
- futureStocks? FutureStock[] - List of future stocks
- classifications? Classification[] - List of classifications related to the product
- timedAccessPromotion? Promotion - Representation of a Promotion
- productReferences? ProductReference[] - List of product references
- name? string - Name of the product
- configuratorType? string - Configurator type related to the product
- sapAddToCartDisabledMessage? string - Message shows why product can not be added to cart
- volumePrices? Price[] - List of volume prices
- priceRange? PriceRange - Representation of a Price Range
- multidimensional? boolean - Flag stating if product is multidimensional
- baseOptions? BaseOption[] - List of base options related to the product
- 'configurable? boolean - Flag stating if product is configurable
sap.commerce.webservices: ProductExpressUpdateElement
Representation of a Product Express Update Element
Fields
- catalogVersion? string - Catalog version
- code? string - Code of product express update element
- catalogId? string - Catalog identifier
sap.commerce.webservices: ProductExpressUpdateElementList
Representation of a Product Express Update Element List
Fields
- productExpressUpdateElements? ProductExpressUpdateElement[] - List of product express update element
sap.commerce.webservices: ProductFutureStocks
Representation of a Product Future Stocks
Fields
- productCode? string - Product identifier
- futureStocks? FutureStock[] - List of future stocks
sap.commerce.webservices: ProductFutureStocksList
Representation of a Product Future Stocks List
Fields
- productFutureStocks? ProductFutureStocks[] - List of product future stocks
sap.commerce.webservices: ProductInterestEntry
Product interest entry
Fields
- interestType? string - Product interest type
- dateAdded? string - Added date of product interest
- expirationDate? string - Expiration date of product interest
sap.commerce.webservices: ProductInterestRelation
Product interest relation
Fields
- productInterestEntry? ProductInterestEntry[] - List of product interest entry
- product? Product - Product associated with the interest relation
sap.commerce.webservices: ProductList
Representation of a Product List
Fields
- catalog? string - Catalog of product list
- totalPageCount? Signed32 - Total page count
- currentPage? Signed32 - Number of current page
- version? string - Version of product list
- products? Product[] - List of products
- totalProductCount? Signed32 - Total product count
sap.commerce.webservices: ProductReference
Representation of a Product Reference
Fields
- quantity? Signed32 - Reference quantity
- preselected? boolean - Flag stating if product reference is preselected
- referenceType? string - Reference type
- description? string - Reference description
- target? Product - Representation of a Product
sap.commerce.webservices: ProductReferenceList
Representation of a Product Reference List
Fields
- references? ProductReference[] - List of product references
sap.commerce.webservices: ProductSearchPage
Representation of a Product Search Page
Fields
- freeTextSearch? string - Free text search
- pagination? DeprecatedPagination - Representation of a search results pagination
- currentQuery? SearchState - Representation of a Search State
- keywordRedirectUrl? string - Redirect url address keyword
- spellingSuggestion? SpellingSuggestion - Representation of a Spell Checker Suggestion
- products? Product[] - List of products
- facets? Facet[] - List of facets
- categoryCode? string - Category code
- sorts? Sort[] - List of sorts
sap.commerce.webservices: Promotion
Representation of a Promotion
Fields
- promotionType? string - Type of the promotion
- code? string - Code of the promotion
- endDate? string - Last date of validity of the promotion
- description? string - Description of the promotion
- restrictions? PromotionRestriction[] - List of promotion restrictions
- title? string - Promotion title
- priority? Signed32 - Priority index as numeric value of the promotion. Higher number means higher priority
- enabled? boolean - Boolean flag if promotion is enabled
- firedMessages? string[] - Message fired while the promotion is active. This is info how much you will get when applying the promotion
- couldFireMessages? string[] - Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description
- promotionGroup? string - Group of the promotion
- productBanner? Image - Representation of an Image
- startDate? string - The initial date of the promotion
sap.commerce.webservices: PromotionList
List of promotions
Fields
- promotions? Promotion[] - List of promotions
sap.commerce.webservices: PromotionOrderEntryConsumed
Representation of a Promotion order entry consumed
Fields
- orderEntryNumber? Signed32 - Order entry number
- code? string - Order entry code
- quantity? int - Quantity of promotion order entry
- adjustedUnitPrice? decimal - Adjusted unit price for promotion order entry
sap.commerce.webservices: PromotionRestriction
Representation of a Promotion Restriction
Fields
- restrictionType? string - Type of the promotion restriction
- description? string - Description of the promotion restriction
sap.commerce.webservices: PromotionResult
Representation of a Promotion result
Fields
- consumedEntries? PromotionOrderEntryConsumed[] - List of promotion order entries consumed
- description? string - Description of promotion result
- promotion? Promotion - Representation of a Promotion
sap.commerce.webservices: PromotionResultList
Representation of a Promotion result list
Fields
- promotions? PromotionResult[] - List of promotion results
sap.commerce.webservices: PunchOutSessionInfo
PunchOutSessionInfo contains the user ID, cart ID, token, PunchOut level, PunchOut operation and selected item
Fields
- punchOutLevel "STORE"|"PRODUCT"|"AISLE"|"SHELF" - The punchoutLevel is an attribute that allows suppliers to specify how procurement applications should present the PunchOut item to users
- selectedItem? string - The selected item specify PunchOut for an entire store or any subset of product offerings
- cartId string - ID of the cart
- customerId string - CustomerID of the user
- punchOutOperation "CREATE"|"EDIT"|"INSPECT" - Supported PunchOut operations
- token PunchOutToken - Holds the token info for the user
sap.commerce.webservices: PunchOutToken
Holds the token info for the user
Fields
- accessToken string - The access token issued by the authorization server
- tokenType string - The access token type provides the client with the information required to successfully utilize the access token to make a protected resource request (along with type-specific attributes). The client MUST NOT use an access token if it does not understand or does not trust the token type
sap.commerce.webservices: Quote
Representation of the quote object
Fields
- code string - Code of the quote
- creationTime string - Date of quote creation
- totalPrice? Price - Representation of a Price
- allowedActions? string[] - Actions, which are allowed to perform with the quote
- description? string - Description of the quote
- threshold decimal - Minimum subtotal value for the quote in the currency of the store
- previousEstimatedTotal? Price - Representation of a Price
- quoteDiscounts? Price - Representation of a Price
- totalPriceWithTax? Price - Representation of a Price
- state string - Current state of the quote. Possible state values - DRAFT, SUBMITTED, OFFER, CANCELLED, EXPIRED, etc.. The list of the states can be extended
- sapQuoteDiscountsType? string - Type of the discount - PERCENT for discount by percentage, ABSOLUTE for discount by amount, TARGET for discount by adjustment of the total value
- entryGroups? EntryGroup[] - List of entry groups
- updatedTime string - Date of the last quote update
- totalItems Signed32 - Total number of the items in the quote
- comments? Comment[] - List of quote comments
- productDiscounts? Price - Representation of a Price
- subTotalWithDiscounts? Price - Representation of a Price
- cartId? string - Id of the cart, which is linked to the quote
- sapSubtotalExcludingOrderLevelDiscount? Price - Representation of a Price
- orderDiscounts? Price - Representation of a Price
- version Signed32 - Current version of the quote
- sapQuoteDiscountsRate? decimal - Value of the discount
- sapOrderCode? string - Order Code associated with the Quote. The Order Code is present if the quote was used to place an order
- entries? OrderEntry[] - Entries of the cart
- sapAttachments? SAPAttachment[] - List of SAP attachments
- expirationTime string - Expiration time of the quote
- name string - Name of the quote
sap.commerce.webservices: QuoteAction
The action with the quote. The quote action field is mandatory
Fields
- action string - User's actions with the quote. Typical actions are: CANCEL, SUBMIT, ACCEPT, APPROVE, REJECT
sap.commerce.webservices: QuoteDiscount
Discount applied to the quote - discountType for type of the discount, discountRate for value of the discount
Fields
- discountRate? decimal - Value of the discount
- discountType? string - Type of the discount - PERCENT for discount by percentage, ABSOLUTE for discount by amount, TARGET for discount by adjustment of the total value
sap.commerce.webservices: QuoteList
Representation of a Quote result list
Fields
- pagination? DeprecatedPagination - Representation of a search results pagination
- quotes? Quote[] - List of quotes
sap.commerce.webservices: QuoteMetadata
Updated name, description or expiry date of the quote
Fields
- expirationTime string - Expiration time of the quote
- name string - Name of the quote
- description? string - Description of the quote
sap.commerce.webservices: QuoteStarter
Object representing ways of creating new quote - by cartId for creating a new quote from the cart, by quoteCode for the requote action
Fields
- cartId? string - CartId of the cart from which the quote will be created
- quoteCode? string - Code of the quote for the requote action
sap.commerce.webservices: ReadCpqConfigurationQueries
Represents the Queries record for the operation: readCpqConfiguration
Fields
- tabId? Signed32 - Tab identifier
sap.commerce.webservices: Region
Response body fields which will be returned while fetching the list of country's regions
Fields
- isocode? string - Country and Region code in iso format
- countryIso? string - Country code in iso format
- name? string - Name of the region
- isocodeShort? string - Region code in short iso form
sap.commerce.webservices: RegionList
List of Regions
Fields
- regions? Region[] - This is the list of Region fields that should be returned in the response body
sap.commerce.webservices: RemoveApproverFromOrgCustomerQueries
Represents the Queries record for the operation: removeApproverFromOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: RemoveBudgetFromCostCenterQueries
Represents the Queries record for the operation: removeBudgetFromCostCenter
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: RemoveOrderApprovalPermissionFromOrgUnitUserGroupQueries
Represents the Queries record for the operation: removeOrderApprovalPermissionFromOrgUnitUserGroup
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: RemovePermissionFromOrgCustomerQueries
Represents the Queries record for the operation: removePermissionFromOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: RemoveProductInterestQueries
Represents the Queries record for the operation: removeProductInterest
Fields
- productCode string - Product identifier
- notificationType string - Notification type
sap.commerce.webservices: RemoveRoleFromOrgCustomerQueries
Represents the Queries record for the operation: removeRoleFromOrgCustomer
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: ReplaceCartDeliveryAddressQueries
Represents the Queries record for the operation: replaceCartDeliveryAddress
Fields
- addressId string - Address identifier
sap.commerce.webservices: ReplaceCartDeliveryModeQueries
Represents the Queries record for the operation: replaceCartDeliveryMode
Fields
- deliveryModeId string - Delivery mode identifier (code)
sap.commerce.webservices: ReplaceCartEntryQueries
Represents the Queries record for the operation: replaceCartEntry
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: ReplaceCartGuestUserQueries
Represents the Queries record for the operation: replaceCartGuestUser
Fields
- email string - Email of the guest user. It will be used during the checkout process
sap.commerce.webservices: ReplaceCartPaymentDetailsQueries
Represents the Queries record for the operation: replaceCartPaymentDetails
Fields
- paymentDetailsId string - Payment details identifier
sap.commerce.webservices: ReplaceLoginIdInput
Representation of a request of replacing an existing user's login id
Fields
- password string - User password
- newLoginId string - New login id that is a unique string to identify a user
sap.commerce.webservices: ReplaceOrgCartCostCenterQueries
Represents the Queries record for the operation: replaceOrgCartCostCenter
Fields
- costCenterId string - Cost center identifier
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: ReplaceOrgCartDeliveryAddressQueries
Represents the Queries record for the operation: replaceOrgCartDeliveryAddress
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- addressId string - The id of the address
sap.commerce.webservices: ReplaceOrgCartEntriesQueries
Represents the Queries record for the operation: replaceOrgCartEntries
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: ReplaceOrgCartPaymentTypeQueries
Represents the Queries record for the operation: replaceOrgCartPaymentType
Fields
- purchaseOrderNumber? string - Purchase order number to assign to the cart during the checkout process
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
- paymentType string - Payment type choice. Examples:card,account
sap.commerce.webservices: ReplacePasswordInput
Representation of a request of replacing an existing user's password
Fields
- oldPassword string - Current password of the customer
- newPassword string - New password of the customer
sap.commerce.webservices: ReplaceUserLoginQueries
Represents the Queries record for the operation: replaceUserLogin
Fields
- password string - Current password of a customer
- newLogin string - New login name of a customer. The name is case insensitive
sap.commerce.webservices: ReplaceUserPasswordQueries
Represents the Queries record for the operation: replaceUserPassword
Fields
- 'new string - New password
- old string - Old password
sap.commerce.webservices: ReplenishmentOrder
Request body fields required and optional to operate on Replenishment Order data
Fields
- appliedProductPromotions? PromotionResult[] - List of applied product promotions
- sapCustomerEmail? string - Email of customer
- sapPaymentOptionId? string - The payment option identifier. It specifies which option the consumer selected to make the payment for the cart
- subTotal? Price - Representation of a Price
- totalTax? Price - Representation of a Price
- appliedVouchers? Voucher[] - List of applied vouchers
- sapQuote? Quote - Representation of the quote object
- deliveryMode? DeliveryMode - Representation of a Delivery mode
- deliveryAddress? Address - Address object
- firstDate? string - First date of the replenishment order
- net? boolean - Flag stating iv value is net-value
- saveTime? string - Date of saving cart
- calculated? boolean - Flag showing if order is calculated
- savedBy? Principal - Representation of a Principal webservice DTO used for defining User data types
- sapBillingAddress? Address - Address object
- productDiscounts? Price - Representation of a Price
- appliedOrderPromotions? PromotionResult[] - List of applied order promotions
- potentialProductPromotions? PromotionResult[] - List of potential product promotions for cart
- costCenter? B2BCostCenter - Cost center object
- chinesePaymentInfo? ChinesePaymentInfo - Chinese payment info
- active? boolean - Is the Replenishment Order active
- replenishmentOrderCode string - Unique code for the replenishment order
- orderDiscounts? Price - Representation of a Price
- entries? OrderEntry[] - List of order entries
- expirationTime? string - Date of cart expiration time
- totalUnitCount? Signed32 - Total unit count
- name? string - Name of the cart
- guid? string - Guest user id identifier
- deliveryOrderGroups? DeliveryOrderEntryGroup[] - List of delivery order entries group
- requestedRetrievalAt? string - Customer requested date for order retrieval
- code? string - Code number of order
- totalPrice? Price - Representation of a Price
- totalDiscounts? Price - Representation of a Price
- description? string - Description of the cart
- earliestRetrievalAt? string - Earliest possible retrieval date available for order
- paymentType? B2BPaymentType - Payment method type available for B2B transactions
- servicedAt? string - Requested Seervice Date for all service products in cart/Order
- taxInvoice? TaxInvoice - data type of tax invoice
- deliveryItemsQuantity? int - Quantity of delivery items
- totalPriceWithTax? Price - Representation of a Price
- paymentStatus? string - Payment status
- entryGroups? EntryGroup[] - List of entry groups
- totalItems? Signed32 - Total number of items in the replenishment order
- potentialOrderPromotions? PromotionResult[] - List of potential order promotions for cart
- pickupOrderGroups? PickupOrderEntryGroup[] - List of pickup order entry group
- store? string - Store
- trigger? Trigger - Representation of a Trigger
- messages? ApiMessage[] - Messages about supplementary info, warning messages related to the cart
- site? string - Site
- deliveryTimeSlot? DeliveryTimeSlot - data type of delivery timeslot
- purchaseOrderNumber? string - Purchase order number for the replenishment order
- pickupItemsQuantity? int - Quantity of pickup items
- user? Principal - Representation of a Principal webservice DTO used for defining User data types
- paymentInfo? PaymentDetails - Payment details object
- deliveryCost? Price - Representation of a Price
sap.commerce.webservices: ReplenishmentOrderList
Representation of a Replenishment Order List
Fields
- pagination? DeprecatedPagination - Representation of a search results pagination
- sorts? Sort[] - List of sorts
- replenishmentOrders? ReplenishmentOrder[] - List of Replenishment Orders
sap.commerce.webservices: RequisitionFormData
Representation transaction info of an order, containing the target url to submit cXML order message and base64 encode order info
Fields
- orderAsCXML string - Order info in base64 encoded cXML format, to submit this to procurement system, you must name this field with name cxml-base64 or cxml-urlencoded
- browseFormPostUrl string - The url used to submit order into procurement system
sap.commerce.webservices: ResetPassword
Request body parameter that contains details such as token and new password
Fields
- newPassword string - new password string which is required to complete process of resetting password
- token string - token value which will be generated as unique string that will be sent with email to allow user for completing reset-password operation
sap.commerce.webservices: RetrieveAllOrderFormsQueries
Represents the Queries record for the operation: retrieveAllOrderForms
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: RetrieveAnOrderFormQueries
Represents the Queries record for the operation: retrieveAnOrderForm
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: ReturnRequest
Representation of a return request for an order
Fields
- returnLabelDownloadUrl? string - URL of the return label
- code? string - Return request code
- creationTime? string - Date of the return request creation
- totalPrice? Price - Representation of a Price
- returnEntries? ReturnRequestEntry[] - Entries of the return request which contains information about the returned product
- rma? string - Return merchandise authorization number
- subTotal? Price - Representation of a Price
- refundDeliveryCost? boolean - Boolean flag for whether there is a delivery cost for refund
- cancellable? boolean - Boolean flag for whether the return request is cancellable
- deliveryCost? Price - Representation of a Price
- 'order? Order - Representation of a order. Note that sapBillingAddress is mutually exclusive with paymentInfo.billingAddress, which is used when the billing address is created concurrently with the paymentInfo. sapBillingAddress is used when there is a need to save the billing address, but the related paymentInfo has not been created yet
- status? string - Status of return request
sap.commerce.webservices: ReturnRequestEntry
Representation of a return request entry which contains information about the returned product
Fields
- orderEntry? OrderEntry - Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) The DTO is in XML or .json format
- expectedQuantity? int - Quantity which is expected to be returned for this return request entry
- refundAmount? Price - Representation of a Price
sap.commerce.webservices: ReturnRequestEntryInput
Representation of a return request entry input for an order
Fields
- orderEntryNumber Signed32 - Order entry number of the returned product
- quantity int - Quantity of the product which belongs to the order entry and is requested to be returned
sap.commerce.webservices: ReturnRequestEntryInputList
Return request input list for the current order
Fields
- orderCode string - Code of the order which return request is related to
- returnRequestEntryInputs ReturnRequestEntryInput[] - Return request entry inputs which contain information about the order entries which are requested to be returned
sap.commerce.webservices: ReturnRequestList
Representation of an Order Return Request List
Fields
- pagination? DeprecatedPagination - Representation of a search results pagination
- returnRequests? ReturnRequest[] - List of order return requests
- sorts? Sort[] - List of sorts
sap.commerce.webservices: ReturnRequestModification
Return request modification object
Fields
- status? "CANCELLING" - Status of the return request
sap.commerce.webservices: Review
Object contains review details like : rating, alias, headline, comment
Fields
- date? string - Date of the review
- principal? User - User's object
- rating? decimal - Review rating value
- alias? string - Alias name for the review
- comment? string - Review comment
- id? string - Identifier of review
- headline? string - Review headline
sap.commerce.webservices: ReviewList
Representation of a Review List
Fields
- reviews? Review[] - List of reviews
sap.commerce.webservices: SAPAccessCode
SAP system access code for authentication and authorization
Fields
- accessCode string - Representation of an SAP access code
sap.commerce.webservices: SAPAccessCodePublicKey
Public key used to decrypt SAP access codes
Fields
- publicKey string - The public key to decrypt an SAP access code
sap.commerce.webservices: SAPAttachment
Object contains attachment id for sap attachment
Fields
- filename? string - The name and the extension of the attached file
- id? string - Attachment identifier
sap.commerce.webservices: SAPAvailability
Representation of availability for a list of products
Fields
- availabilityItems? SAPProductAvailability[] - List of product availability
sap.commerce.webservices: SAPCPQConfiguration
CPQ configuration
Fields
- currencySign? string - Currency sign
- invalidMessages? string[] - Invalid messages
- numberOfConflicts? Signed32 - Number of conflicts
- tabs? SAPCPQConfigurationTab[] - List of configuration tabs/groups
- incompleteMessages? string[] - Incomplete messages
- responder? SAPCPQConfigurationPriceResponder - Configuration price information
- completed? boolean - Value indicating whether this configuration is completed
- incompleteAttributes? string[] - Incomplete attributes
- productName? string - Product name
- productSystemId? string - Product system identifier
- errorMessages? string[] - Error messages
- failedValidations? string[] - Failed validation messages
- conflictMessages? string[] - Conflict messages
- attributes? SAPCPQConfigurationAttribute[] - List of attributes. This list of configuration attributes is not used / not filled in case of the readCofigurationOverview API call, because then we return all attributes as part of the list of tabs
- configurationId? string - Configuration identifier
- currencyISOCode? string - Currency ISO code
sap.commerce.webservices: SAPCPQConfigurationAttribute
CPQ configuration attribute
Fields
- pAID? Signed32 - Identifier
- quantity? string - Attribute quantity
- dataType? string - Data type
- values? SAPCPQConfigurationAttributeValue[] - List of attribute values
- description? string - Description
- label? string - Label
- hasConflict? boolean - Value indicating whether this attribute has conflicts
- required? boolean - Value indicating whether this attribute is required
- incomplete? boolean - Value indicating whether this attribute is incomplete
- displayAs? Signed32 - Attribute UI representation, e.g. radiobutton
- stdAttrCode? Signed32 - Standard attribute code
- isEnabled? boolean - Value indicating whether this attribute is writable
- name? string - Name
- userInput? string - User input
- isLineItem? boolean - Value indicating whether this attribute is a line item and is represented as an own line in the CPQ quote
sap.commerce.webservices: SAPCPQConfigurationAttributeValue
CPQ configuration attribute
Fields
- valueDisplay? string - Value display
- productSystemId? string - Product system identifier
- quantity? string - Quantity
- price? string - Price
- description? string - Item description
- valueCode? string - Value code
- paVID? Signed32 - Identifier
- selected? boolean - Value indicating whether this attribute value is selected
sap.commerce.webservices: SAPCPQConfigurationChangeAttributeValue
CPQ configuration change attribute value structure
Fields
- quantity? decimal - Attribute quantity
- userInput? string - User input
- attributeValueIds? string - Attribute value identifiers
sap.commerce.webservices: SAPCPQConfigurationChangeAttributeValueQuantity
CPQ configuration change attribute value structure
Fields
- quantity? decimal - Attribute value quantity
sap.commerce.webservices: SAPCPQConfigurationPriceResponder
Configuration price information
Fields
- totalPrice? string - Total price
- baseProductPrice? string - Base product price
sap.commerce.webservices: SAPCPQConfigurationTab
CPQ configuration tab/group
Fields
- displayName? string - Display name
- name? string - Name
- isSelected? boolean - Value indicating whether this tab is selected
- attributes? SAPCPQConfigurationAttribute[] - List of attributes. This list of configuration attributes is used / filled only in case of readCofigurationOverview API call
- id? Signed32 - Identifier
- isIncomplete? boolean - Value indicating whether this tab is incomplete
sap.commerce.webservices: SAPCustomerCouponOperationRequest
Customer coupon operation request
Fields
- couponCode string - Coupon code. A valid coupon code can be used to get a discount
sap.commerce.webservices: SAPGuestUserRequest
Attributes needed to update for guest user, such as email address
Fields
- email? string - Email of the guest user. It will be used during the guest checkout process but may be optional when creating a guest user for a cart
sap.commerce.webservices: SAPInvoice
Representation of an Invoice
Fields
- createdAt? string - Invoice creation date
- totalAmount? Price - Total invoice amount including all taxes and charges
- netAmount? Price - Net invoice amount before taxes and additional charges
- externalSystemId? string - External system identifier where the invoice resides
- invoiceId? string - Invoice Id
sap.commerce.webservices: SAPInvoiceList
Representation of an Invoice List
Fields
- pagination? Pagination - Pagination information for the SAP invoice list results
- invoices? SAPInvoice[] - list of invoice
- sorts? Sort1[] - sorting information
sap.commerce.webservices: SAPOrderAttachment
Representation of a metadata of an Order Attachment (a binary file linked to an Order)
Fields
- sapFileName? string - Attachment File Name
- sapAttachmentId? string - Attachment Id which together with the Order code can be used to obtain content of the file
sap.commerce.webservices: SAPOrderAttachmentList
Representation of a search result for Order Attachment metadata
Fields
- sapAttachments? SAPOrderAttachment[] - list of Order Attachment objects
- pagination? Pagination - Pagination info
- sorts? Sort1[] - sorting information
sap.commerce.webservices: SAPPaymentMethod
Payment Method
Fields
- code string - Payment Method Code
- name string - Payment Method Name
sap.commerce.webservices: SAPPaymentOptionRequest
The payment option information. If payment option identifier is set, then the payment type will also be set accordingly, and other endpoints can no longer modify the payment type
Fields
- sapPaymentOptionId? string - The payment option identifier. It specifies which option the consumer selected to make the payment for the cart
- purchaseOrderNumber? string - Purchase order number
sap.commerce.webservices: SAPProductAvailability
Representation of availability for a product
Fields
- productCode? string - Product identifier
- unitAvailabilities? SAPUnitAvailability[] - List of unit availability
sap.commerce.webservices: SAPSavedCartRequest
Representation of information of a saved cart
Fields
- name? string - Name of the saved cart
- description? string - Description of the saved cart
sap.commerce.webservices: SAPUnit
Representation of a Unit
Fields
- sapCode? string - Code of the SAP unit
- code? string - Code of the unit
- name? string - Name of the unit
- availabilityCode? string - Code of the unit is used to check availability, which can be retrieved either from 'code' without any integration, from 'sapCode' with SAP OMSA integration, or potentially from another source through custom integration with a stock service
sap.commerce.webservices: SAPUnitAvailability
Representation of availability in a particular unit
Fields
- unit? string - Code of the unit of measure
- quantity? int - Available quantity
- status? string - Status of availability. Possible values can be IN_STOCK, OUT_OF_STOCK, LOW_STOCK
sap.commerce.webservices: SAPVoucherOperationRequest
Voucher operation request
Fields
- voucherCode string - Voucher code. A valid voucher code can be used to get a discount
sap.commerce.webservices: SAPVoucherRequest
Representation of information of a voucher
Fields
- voucherId string - Voucher identifier (code)
sap.commerce.webservices: SaveCartResult
Representation of a Save Cart Result
Fields
- savedCartData? Cart - Cart data that was successfully saved
sap.commerce.webservices: ScheduleLine
List of ScheduleLine
Fields
- confirmedAt? string - Scheduled Date
- confirmedQuantity? Signed32 - Scheduled Quantity
sap.commerce.webservices: ScheduleReplenishmentForm
Schedule replenishment form object
Fields
- nthDayOfMonth? string - On which date of month replenishment should be activated. Mandatory with 'recurrencePeriod=MONTHLY'
- recurrencePeriod? string - Replenishment recurrence period. Available values are DAILY, WEEKLY and MONTHLY. DAILY requires 'numberOfDays'. WEEKLY requires 'daysOfWeek' AND 'numberOfWeeks'. MONTHLY requires 'nthDayOfMonth'
- replenishmentStartDate? string - First day for replenishment order
- numberOfDays? string - How frequent replenishment should be activated expressed in days. Mandatory with 'recurrencePeriod=DAILY'
- numberOfWeeks? string - How frequent replenishment should be activated expressed in weeks. Mandatory with 'recurrencePeriod=WEEKLY'
- daysOfWeek? ("SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY")[] - List of days of week on which replenishment should occur. Mandatory with 'recurrencePeriod=WEEKLY'
sap.commerce.webservices: SearchComponentsByIdsQueries
Represents the Queries record for the operation: searchComponentsByIds
Fields
- productCode? string - Product code
- catalogCode? string - Catalog code
- pageSize Signed32(default 10) - Number of results returned per page. Default value: 10
- categoryCode? string - Category code
- sort? string - Sorting method applied to the return results
- currentPage Signed32(default 0) - Current result page. Default value is 0
- fields? "BASIC"|"DEFAULT"|"FULL" - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
sap.commerce.webservices: SearchQuery
Representation of a Search Query
Fields
- value? string - Value of search query
sap.commerce.webservices: SearchState
Representation of a Search State
Fields
- query? SearchQuery - Representation of a Search Query
- url? string - Url address of search state
sap.commerce.webservices: ServiceOrderConfiguration
Configured Service Order
Fields
- serviceScheduleTimes? string[] - List of Configured Schedule Time
- leadDays? Signed32 - Number of lead days from today required to create service order (ex. 25/09/2020(Today) + 4 - > After considering Lead Days the Date will be 28/09/2020)
sap.commerce.webservices: ServiceScheduleSlot
Schedule request for the service order
Fields
- scheduledAt? string - Requested Service Date for all service products in cart/order
sap.commerce.webservices: SetCartRequestedRetrievalDateQueries
Represents the Queries record for the operation: setCartRequestedRetrievalDate
Fields
- requestedRetrievalAt? string - Customer requested date for order retrieval
sap.commerce.webservices: SiteMessage
Site message
Fields
- uid? string - message uid
- sentDate? string - sent date
- subject? string - message subject
- notificationType? string - notification type used for this message
- body? string - message body
sap.commerce.webservices: SiteMessageSearchResult
Site message search result
Fields
- pagination? Pagination - Pagination information for the site message search results
- messages? SiteMessage[] - site messages
- sorts? Sort1[] - sorting information
sap.commerce.webservices: SiteMessagesQueries
Represents the Queries record for the operation: siteMessages
Fields
- needsTotal "true"|"false" (default "true") - The flag for indicating if total number of results is needed or not
- pageSize string(default "10") - The number of results returned per page
- sort? string - The sorting method applied to the return results
- currentPage string(default "0") - The current result page requested
sap.commerce.webservices: Sort
Representation a Sort option
Fields
- code? string - Code of Sort
- name? string - Name of Sort
- selected? boolean - Flag stating when Sort is selected
sap.commerce.webservices: Sort1
Sort option
Fields
- asc? boolean - Indicates if sorting is in ascending order
- code? string - Unique code identifier for the sort option
sap.commerce.webservices: SpecialOpeningDay
Representation of a special opening day
Fields
- date? string - Date of special opening day
- closingTime? Time - Representation of a Time
- formattedDate? string - Text representation of the date of special opening day
- openingTime? Time - Representation of a Time
- name? string - Name of the special opening day event
- closed? boolean - Flag stating if special opening day is closed
- comment? string - Comment field
sap.commerce.webservices: SpellingSuggestion
Representation of a Spelling Suggestion
Fields
- suggestion? string - Spelling suggestion
- query? string - Query for spelling suggestion
sap.commerce.webservices: StatusSummary
Representation of a status summary, an aggregated view on issues for a specific status or severity. These issues are attached to configurations of products or order entries
Fields
- numberOfIssues? Signed32 - Number of issues per status
- status? string - Status or severity indicator, can be one of ERROR, WARNING, INFO or SUCCESS
sap.commerce.webservices: Stock
Representation of a Stock
Fields
- isValueRounded? boolean - Indicate whether Stock level value is rounded
- stockLevelStatus? string - Status of stock level
- stockLevel? int - Stock level expressed as number
sap.commerce.webservices: StoreCount
Representation of a Store Count
Fields
- storeCountDataList? StoreCount[] - List of store counts
- isoCode? string - Iso code of store
- name? string - Name of store count
- count? Signed32 - Count
- 'type? string - Type of store count
sap.commerce.webservices: StoreCountList
Representation of a Store Count List
Fields
- countriesAndRegionsStoreCount? StoreCount[] - List of store counts
sap.commerce.webservices: StoreFinderSearchPage
Representation of a Store Finder Search Page
Fields
- sourceLatitude? decimal - Source latitude
- sourceLongitude? decimal - Source longitude
- pagination? DeprecatedPagination - Representation of a search results pagination
- locationText? string - Location text
- boundWestLongitude? decimal - Bound west longitude
- stores? PointOfService[] - List of stores
- boundNorthLatitude? decimal - Bound north latitude
- boundEastLongitude? decimal - Bound east longitude
- boundSouthLatitude? decimal - Bound south latitude
sap.commerce.webservices: StoreFinderStockSearchPage
Representation of a Store Finder Stock Search Page
Fields
- sourceLatitude? decimal - Source latitude
- sourceLongitude? decimal - Source longitude
- product? Product - Product information for the stock search query
- pagination? DeprecatedPagination - Pagination details for the store finder stock search results
- locationText? string - Location text
- boundWestLongitude? decimal - Bound to west longitude
- stores? PointOfServiceStock[] - List of stores
- boundNorthLatitude? decimal - Bound to north latitude
- sorts? Sort[] - List of sorts
- boundSouthLatitude? decimal - Bound to south latitude
- boundEastLongitude? decimal - Bound to east longitude
sap.commerce.webservices: SubscribeNotificationsOfCustomerCouponQueries
Represents the Queries record for the operation: subscribeNotificationsOfCustomerCoupon
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: Suggestion
Representation of a Suggestion
Fields
- value? string - Suggestion value
sap.commerce.webservices: SuggestionList
List of suggestions
Fields
- suggestions? Suggestion[] - List of suggestions
sap.commerce.webservices: TaxInvoice
data type of tax invoice
Fields
- recipientType? string - recipient type
- recipient? string - name of recipient
- taxpayerID? string - taxpayer identification number
sap.commerce.webservices: Ticket
Ticket object
Fields
- createdAt? string - Date and time of ticket creation
- associatedTo? TicketAssociatedObject - Object that can be associated with a ticket. The object can be a cart or an order
- availableStatusTransitions? TicketStatus[] - List of ticket status transitions available from the current status
- ticketCategory? TicketCategory - Ticket category details
- subject? string - Subject of ticket
- modifiedAt? string - Date and time of last modification
- ticketEvents? TicketEvent[] - List of events associated with the ticket
- customerId? string - Customer identifier
- id? string - Ticket identifier
- status? TicketStatus - Ticket status details
sap.commerce.webservices: TicketAssociatedObject
Object that can be associated with a ticket. The object can be a cart or an order
Fields
- code string - Associated object code
- modifiedAt? string - Date and time of last modification
- 'type string - Type of associated object: Cart, SavedCart or Order
sap.commerce.webservices: TicketAssociatedObjectList
List of ticket associated objects
Fields
- ticketAssociatedObjects? TicketAssociatedObject[] - List of objects associated with the ticket
sap.commerce.webservices: TicketCategory
Ticket category details
Fields
- name? string - Localized ticket category name
- id string - Ticket category identifier
sap.commerce.webservices: TicketCategoryList
List of ticket categories
Fields
- ticketCategories? TicketCategory[] - Array of ticket categories available in the system
sap.commerce.webservices: TicketEvent
Basic information about the ticket event
Fields
- createdAt? string - Date and time of event creation
- code? string - Event code is specific to each event. It is used to identify an event
- toStatus? TicketStatus - Ticket status details
- ticketEventAttachments? TicketEventAttachment[] - List of attachments associated with the ticket event
- addedByAgent? boolean - Whether an agent added this event
- message string - Detailed description of the question
sap.commerce.webservices: TicketEventAttachment
Object containing a set of fields for ticket attachment
Fields
- filename? string - The name and the extension of the attached file
- id? string - Attachment identifier
sap.commerce.webservices: TicketList
List of ticket results
Fields
- tickets? Ticket[] - List of tickets
- pagination? DeprecatedPagination - Representation of a search results pagination
- sorts? Sort[] - Ticket list sorting details
sap.commerce.webservices: TicketStarter
Basic information of the ticket
Fields
- associatedTo? TicketAssociatedObject - Object that can be associated with a ticket. The object can be a cart or an order
- ticketCategory? TicketCategory - Ticket category details
- subject string - Subject of ticket
- message string - Detailed description of the question
sap.commerce.webservices: TicketStatus
Ticket status details
Fields
- name? string - Localized ticket status name
- id string - Ticket status identifier
sap.commerce.webservices: Time
Representation of a Time
Fields
- hour? string - Hour part of the time data
- meridiemIndicator? string - Meridiem indicator
- formattedHour? string - Formatted hour
- minute? string - Minute part of the time data
sap.commerce.webservices: Title
Representation of a Title
Fields
- code? string - Title code
- name? string - Title name
sap.commerce.webservices: TitleList
Representation of a Title List
Fields
- titles? Title[] - List of titles
sap.commerce.webservices: Trigger
Representation of a Trigger
Fields
- displayTimeTable? string - Description of when the trigger is being activated
- activationTime? string - The time the trigger will be activated
sap.commerce.webservices: UpdateAnOrderFormQueries
Represents the Queries record for the operation: updateAnOrderForm
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateBudgetQueries
Represents the Queries record for the operation: updateBudget
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateCartEntryQueries
Represents the Queries record for the operation: updateCartEntry
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateCostCenterQueries
Represents the Queries record for the operation: updateCostCenter
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateCpqAttributeQueries
Represents the Queries record for the operation: updateCpqAttribute
Fields
- tabId? Signed32 - Tab identifier
sap.commerce.webservices: UpdateCpqAttributeValueQuantityQueries
Represents the Queries record for the operation: updateCpqAttributeValueQuantity
Fields
- tabId? Signed32 - Tab identifier
sap.commerce.webservices: UpdateCurrentUserProfileQueries
Represents the Queries record for the operation: updateCurrentUserProfile
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateOrderApprovalPermissionQueries
Represents the Queries record for the operation: updateOrderApprovalPermission
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateProductConfigurationQueries
Represents the Queries record for the operation: updateProductConfiguration
Fields
- expMode? boolean - If this parameter is provided and its value is true, the system tries to execute the request in expert mode (only possible if the current user belongs to group 'sapproductconfigexpmodegroup'
sap.commerce.webservices: UpdateReplenishmentOrderQueries
Represents the Queries record for the operation: updateReplenishmentOrder
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: UpdateSapPaymentOptionQueries
Represents the Queries record for the operation: updateSapPaymentOption
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: User
User's object
Fields
- lastName? string - User last name
- deactivationDate? string - Deactivation date
- mobileNumber? string - Mobile Number
- userAvatar? UserAvatar - Representation of a profile picture
- orgUnit? B2BUnit - Organizational unit object
- roles? string[] - Array of role names assigned to the user
- defaultPointOfServiceName? string - Name of the default pick up location
- approvers? User[] - List of organizational approvers
- active? boolean - Boolean flag of whether the user is active/enabled or not
- language? Language - Representation of a Language
- title? string - User title
- titleCode? string - User title code
- uid? string - Unique user identifier
- firstName? string - User first name
- displayUid? string - User identifier
- emailLanguage? string - Email Language
- lastCartId? string - The latest cart operated by customer
- hasOrder? boolean - Indicates whether customer has order. Default value is false
- name? string - Name of the user
- customerId? string - Customer identifier
- currency? Currency - Representation of a Currency
- selected? boolean - Boolean flag of whether the user is selected
- email? string - Email of the user
- defaultAddress? Address - Address object
sap.commerce.webservices: UserAvatar
Representation of a profile picture
Fields
- format? string - Image format. It's optional
- url? string - URL of customer profile image in media server. It's optional
sap.commerce.webservices: UserGroup
User group object with id and name
Fields
- uid? string - Unique user identifier
- membersCount? Signed32 - Number of members
- members? Principal[] - List of members
- name? string - Name of the user
- subGroups? UserGroup[] - List of subgroups
sap.commerce.webservices: UserGroupList
Representation of a User Group List
Fields
- userGroups? UserGroup[] - List of user groups
- totalNumber? Signed32 - Total number
- numberOfPages? Signed32 - Number of pages
- pageSize? Signed32 - Page size
- currentPage? Signed32 - Current page
sap.commerce.webservices: UserSignUp
User's object
Fields
- uid string - user id, unique string required to create new user. It can be email
- firstName string - first name of the user
- lastName string - last name of the user
- password string - User password
- verificationTokenCode? string - Code included in the email sent to the customer to be registered. Only needed when OTP for registration is enabled
- verificationTokenId? string - Authentication identifier of a new B2C customer registration. Only needed when OTP for registration is enabled
- titleCode? string - Title code for the user (e.g., 'mr', 'ms', 'dr')
sap.commerce.webservices: ValidateAddressQueries
Represents the Queries record for the operation: validateAddress
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: ValidateCartQueries
Represents the Queries record for the operation: validateCart
Fields
- fields string(default "DEFAULT") - Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
sap.commerce.webservices: VariantCategory
Representation of a Variant Category
Fields
- name? string - Variant category name
- hasImage? boolean - Flag if varian category has image assigned
- priority? Signed32 - Priority number of variant category
sap.commerce.webservices: VariantMatrixElement
Representation of a Variant Matrix Element
Fields
- parentVariantCategory? VariantCategory - Representation of a Variant Category
- variantOption? VariantOption - Representation of a Variant Option
- elements? VariantMatrixElement[] - List of elements with the type of variant matrix element
- variantValueCategory? VariantValueCategory - Representation of a Variant Value Category
- isLeaf? boolean - Indicates whether this element is a leaf node in the variant matrix
sap.commerce.webservices: VariantOption
Representation of a Variant Option
Fields
- code? string - Code of the variant option
- priceData? Price - Representation of a Price
- variantOptionQualifiers? VariantOptionQualifier[] - List of variant option qualifiers
- stock? Stock - Representation of a Stock
- url? string - Url address of the variant option
sap.commerce.webservices: VariantOptionQualifier
Representation of a Variant Option Qualifier
Fields
- image? Image - Representation of an Image
- qualifier? string - Qualifier
- name? string - Name of variant option qualifier
- value? string - Value of variant option qualifier
sap.commerce.webservices: VariantValueCategory
Representation of a Variant Value Category
Fields
- superCategories? VariantCategory[] - Parent category of variant value category
- sequence? Signed32 - Sequence number of variant value category
- name? string - Name of the variant value category
sap.commerce.webservices: VerificationToken
Representation of information for obtained verification token
Fields
- expiresIn Signed32 - Verification token expiration time in seconds
- tokenId string - Unique token ID generated for verification request, which is used for authentication along with the token code
sap.commerce.webservices: Voucher
Representation of a Voucher
Fields
- code? string - The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123
- valueString? string - The value of the voucher to display. Example: 15.0%
- freeShipping? boolean - Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false
- valueFormatted? string - Formatted value of the voucher
- name? string - Name of the voucher
- description? string - Description of the voucher
- appliedValue? Price - Representation of a Price
- currency? Currency - Representation of a Currency
- value? decimal - Value of the voucher. Example of such value is: 15.0d
- voucherCode? string - Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL
sap.commerce.webservices: VoucherList
Representation of a Voucher List
Fields
- vouchers? Voucher[] - List of vouchers
sap.commerce.webservices: WeekdayOpeningDay
Representation of a Weekday Opening Day
Fields
- closingTime? Time - Representation of a Time
- openingTime? Time - Representation of a Time
- weekDay? string - Text representation of week day opening day
- closed? boolean - Flag stating if weekday opening day is closed
Import
import ballerinax/sap.commerce.webservices;Other versions
0.9.0