setShopperContext

post

/ccagent/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
• Response

Request

Supported Media Types

• application/json

Body Parameter

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

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.

Properties

shopperContext

Type: object shopperContext

Additional Properties Allowed:

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.

Body

Root Schema : setShopperContext_response

Properties

defaultAdditionalPriceListGroups

Type: array defaultAdditionalPriceListGroups

Additional Properties Allowed:

defaultCatalog

Type: object defaultCatalog

Additional Properties Allowed:

Catalog determined by the webhook/Fall Back for the current context.

defaultPriceListGroup

Type: object defaultPriceListGroup

Additional Properties Allowed:

Pricelistgroup determined by the webhook/Fall Back for the current context

isExternalContext

Type: boolean

message

Type: string

Nested Schema : defaultAdditionalPriceListGroups

Type: array

Items

• Type: object items
  Additional Properties Allowed:
  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.

Properties

repositoryId

Type: string

Nested Schema : defaultPriceListGroup

Type: object

Pricelistgroup determined by the webhook/Fall Back for the current context

Properties

active

Type: boolean

Indicates if the PriceListGroup is active.

currency

Type: object currency

Additional Properties Allowed:

The currency details of the PriceListGroup.

deleted

Type: boolean

Indicates if the PriceListGroup is deleted.

displayName

Type: string

Display name of the PriceListGroup.

endDate

Type: string

End date of the the associated list price list.

listPriceList

Type: object listPriceList

Additional Properties Allowed:

The price list for list prices

locale

Type: string

Locale of the the associated list price list.

repositoryId

Type: string

The ID of the PriceListGroup item.

salePriceList

Type: object salePriceList

Additional Properties Allowed:

The price list for sale prices.

shippingSurchargePriceList

Type: object shippingSurchargePriceList

Additional Properties Allowed:

The price list for shipping surcharge prices.

startDate

Type: 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

Properties

active

Type: boolean

Indicates if the PriceListGroup is active.

currency

Type: object currency

Additional Properties Allowed:

The currency details of the PriceListGroup.

deleted

Type: boolean

Indicates if the PriceListGroup is deleted.

displayName

Type: string

Display name of the PriceListGroup.

endDate

Type: string

End date of the the associated list price list.

listPriceList

Type: object listPriceList

Additional Properties Allowed:

The price list for list prices

locale

Type: string

Locale of the the associated list price list.

repositoryId

Type: string

The ID of the PriceListGroup item.

salePriceList

Type: object salePriceList

Additional Properties Allowed:

The price list for sale prices.

shippingSurchargePriceList

Type: object shippingSurchargePriceList

Additional Properties Allowed:

The price list for shipping surcharge prices.

startDate

Type: string

Start date of the the associated list price list.

Nested Schema : currency

Type: object

The currency details of the PriceListGroup.

Properties

currencyCode

Type: string

The currency Code of the currency.

displayName

Type: string

The display Name of the currency.

fractionalDigits

Type: string

Fractional digits that currency supports.

numericCode

Type: string

The numeric Code of the currency.

repositoryId

Type: string

The repository id of the currency.

symbol

Type: string

The symbol of the currency.

Nested Schema : listPriceList

Type: object

The price list for list prices

Properties

repositoryId

Type: string

Repository id of the list price list.

Nested Schema : salePriceList

Type: object

The price list for sale prices.

Properties

repositoryId

Type: string

Repository id of the sale price list.

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices.

Properties

repositoryId

Type: string

Repository id of shipping surcharge price list.

Nested Schema : currency

Type: object

The currency details of the PriceListGroup.

Properties

currencyCode

Type: string

The currency Code of the currency.

displayName

Type: string

The display Name of the currency.

fractionalDigits

Type: string

Fractional digits that currency supports.

numericCode

Type: string

The numeric Code of the currency.

repositoryId

Type: string

The repository id of the currency.

symbol

Type: string

The symbol denoting currency.

Nested Schema : listPriceList

Type: object

The price list for list prices

Properties

repositoryId

Type: string

Repository id of the list price list.

Nested Schema : salePriceList

Type: object

The price list for sale prices.

Properties

repositoryId

Type: string

Repository id of the sale price list.

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices.

Properties

repositoryId

Type: string

Repository id of shipping surcharge price list.