setShopperContext
post
/ccstore/v1/shopperContext
SetShopperContext. This operation fetches the PriceListGroup,Catalog and Additional PriceListGroups determined by External Price Group and Catalog Webhook using current context/Event sent by user.Also updates X-OCStateData header with the encrypted response.
Request
Supported Media Types
- application/json
SetShopperContext. This operation fetches the PriceListGroup,Catalog and Additional PriceListGroups determined by External Price Group and Catalog Webhook using current context/Event sent by user.Also updates X-OCStateData header with the encrypted response.
Root Schema : setShopperContext_request
Type:
object
SetShopperContext. This operation fetches the PriceListGroup,Catalog and Additional PriceListGroups determined by External Price Group and Catalog Webhook using current context/Event sent by user.Also updates X-OCStateData header with the encrypted response.
Show Source
-
shopperContext(optional):
object shopperContext
External Context Dynamic properties values using which PriceListGroups, Catalog and Additional PriceListGroups are determined
Nested Schema : shopperContext
Type:
object
External Context Dynamic properties values using which PriceListGroups, Catalog and Additional PriceListGroups are determined
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : setShopperContext_response
Type:
Show Source
object
-
defaultAdditionalPriceListGroups(optional):
array defaultAdditionalPriceListGroups
-
defaultCatalog(optional):
object defaultCatalog
Catalog determined by the webhook/Fall Back for the current context.
-
defaultPriceListGroup(optional):
object defaultPriceListGroup
Pricelistgroup determined by the webhook/Fall Back for the current context
-
isExternalContext(optional):
boolean
-
message(optional):
string
Nested Schema : defaultAdditionalPriceListGroups
Type:
Show Source
array
-
Array of:
object items
Additional Pricelistgroup determined by webhook/Fall Back for the current context
Nested Schema : defaultCatalog
Type:
object
Catalog determined by the webhook/Fall Back for the current context.
Show Source
Nested Schema : defaultPriceListGroup
Type:
object
Pricelistgroup determined by the webhook/Fall Back for the current context
Show Source
-
active(optional):
boolean
Indicates if the PriceListGroup is active.
-
currency(optional):
object currency
The currency details of the PriceListGroup.
-
deleted(optional):
boolean
Indicates if the PriceListGroup is deleted.
-
displayName(optional):
string
Display name of the PriceListGroup.
-
endDate(optional):
string
End date of the the associated list price list.
-
listPriceList(optional):
object listPriceList
The price list for list prices
-
locale(optional):
string
Locale of the the associated list price list.
-
repositoryId(optional):
string
The ID of the PriceListGroup item.
-
salePriceList(optional):
object salePriceList
The price list for sale prices.
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
The price list for shipping surcharge prices.
-
startDate(optional):
string
Start date of the the associated list price list.
Nested Schema : items
Type:
object
Additional Pricelistgroup determined by webhook/Fall Back for the current context
Show Source
-
active(optional):
boolean
Indicates if the PriceListGroup is active.
-
currency(optional):
object currency
The currency details of the PriceListGroup.
-
deleted(optional):
boolean
Indicates if the PriceListGroup is deleted.
-
displayName(optional):
string
Display name of the PriceListGroup.
-
endDate(optional):
string
End date of the the associated list price list.
-
listPriceList(optional):
object listPriceList
The price list for list prices
-
locale(optional):
string
Locale of the the associated list price list.
-
repositoryId(optional):
string
The ID of the PriceListGroup item.
-
salePriceList(optional):
object salePriceList
The price list for sale prices.
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
The price list for shipping surcharge prices.
-
startDate(optional):
string
Start date of the the associated list price list.
Nested Schema : currency
Type:
object
The currency details of the PriceListGroup.
Show Source
-
currencyCode(optional):
string
The currency Code of the currency.
-
displayName(optional):
string
The display Name of the currency.
-
fractionalDigits(optional):
string
Fractional digits that currency supports.
-
numericCode(optional):
string
The numeric Code of the currency.
-
repositoryId(optional):
string
The repository id of the currency.
-
symbol(optional):
string
The symbol of the currency.
Nested Schema : listPriceList
Type:
object
The price list for list prices
Show Source
-
repositoryId(optional):
string
Repository id of the list price list.
Nested Schema : salePriceList
Type:
object
The price list for sale prices.
Show Source
-
repositoryId(optional):
string
Repository id of the sale price list.
Nested Schema : shippingSurchargePriceList
Type:
object
The price list for shipping surcharge prices.
Show Source
-
repositoryId(optional):
string
Repository id of shipping surcharge price list.
Nested Schema : currency
Type:
object
The currency details of the PriceListGroup.
Show Source
-
currencyCode(optional):
string
The currency Code of the currency.
-
displayName(optional):
string
The display Name of the currency.
-
fractionalDigits(optional):
string
Fractional digits that currency supports.
-
numericCode(optional):
string
The numeric Code of the currency.
-
repositoryId(optional):
string
The repository id of the currency.
-
symbol(optional):
string
The symbol denoting currency.
Nested Schema : listPriceList
Type:
object
The price list for list prices
Show Source
-
repositoryId(optional):
string
Repository id of the list price list.
Nested Schema : salePriceList
Type:
object
The price list for sale prices.
Show Source
-
repositoryId(optional):
string
Repository id of the sale price list.
Nested Schema : shippingSurchargePriceList
Type:
object
The price list for shipping surcharge prices.
Show Source
-
repositoryId(optional):
string
Repository id of shipping surcharge price list.