Jump to

• Request
• Response

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

Body ()

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

{
    "description":"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":{
            "description":"External Context Dynamic properties values using which PriceListGroups, Catalog and Additional PriceListGroups are determined",
            "type":"object"
        }
    }
}

Nested Schema : shopperContext

Type: object

External Context Dynamic properties values using which PriceListGroups, Catalog and Additional PriceListGroups are determined

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : setShopperContext_response

Type: object

Show Source

• 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

{
    "properties":{
        "defaultAdditionalPriceListGroups":{
            "type":"array",
            "items":{
                "description":"Additional Pricelistgroup determined by webhook/Fall Back for the current context",
                "type":"object",
                "properties":{
                    "deleted":{
                        "description":"Indicates if the PriceListGroup is deleted.",
                        "type":"boolean"
                    },
                    "endDate":{
                        "description":"End date of the the associated list price list.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display name of the PriceListGroup.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The ID of the PriceListGroup item.",
                        "type":"string"
                    },
                    "listPriceList":{
                        "description":"The price list for list prices",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository id of the list price list.",
                                "type":"string"
                            }
                        }
                    },
                    "active":{
                        "description":"Indicates if the PriceListGroup is active.",
                        "type":"boolean"
                    },
                    "currency":{
                        "description":"The currency details of the PriceListGroup.",
                        "type":"object",
                        "properties":{
                            "symbol":{
                                "description":"The symbol of the currency.",
                                "type":"string"
                            },
                            "displayName":{
                                "description":"The display Name of the currency.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"The repository id of the currency.",
                                "type":"string"
                            },
                            "fractionalDigits":{
                                "description":"Fractional digits that currency supports.",
                                "type":"string"
                            },
                            "currencyCode":{
                                "description":"The currency Code of the currency.",
                                "type":"string"
                            },
                            "numericCode":{
                                "description":"The numeric Code of the currency.",
                                "type":"string"
                            }
                        }
                    },
                    "salePriceList":{
                        "description":"The price list for sale prices.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository id of the sale price list.",
                                "type":"string"
                            }
                        }
                    },
                    "locale":{
                        "description":"Locale of the the associated list price list.",
                        "type":"string"
                    },
                    "shippingSurchargePriceList":{
                        "description":"The price list for shipping surcharge prices.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository id of shipping surcharge price list.",
                                "type":"string"
                            }
                        }
                    },
                    "startDate":{
                        "description":"Start date of the the associated list price list.",
                        "type":"string"
                    }
                }
            }
        },
        "defaultPriceListGroup":{
            "description":"Pricelistgroup determined by the webhook/Fall Back for the current context",
            "type":"object",
            "properties":{
                "deleted":{
                    "description":"Indicates if the PriceListGroup is deleted.",
                    "type":"boolean"
                },
                "endDate":{
                    "description":"End date of the the associated list price list.",
                    "type":"string"
                },
                "displayName":{
                    "description":"Display name of the PriceListGroup.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The ID of the PriceListGroup item.",
                    "type":"string"
                },
                "listPriceList":{
                    "description":"The price list for list prices",
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository id of the list price list.",
                            "type":"string"
                        }
                    }
                },
                "active":{
                    "description":"Indicates if the PriceListGroup is active.",
                    "type":"boolean"
                },
                "currency":{
                    "description":"The currency details of the PriceListGroup.",
                    "type":"object",
                    "properties":{
                        "symbol":{
                            "description":"The symbol denoting currency.",
                            "type":"string"
                        },
                        "displayName":{
                            "description":"The display Name of the currency.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"The repository id of the currency.",
                            "type":"string"
                        },
                        "fractionalDigits":{
                            "description":"Fractional digits that currency supports.",
                            "type":"string"
                        },
                        "currencyCode":{
                            "description":"The currency Code of the currency.",
                            "type":"string"
                        },
                        "numericCode":{
                            "description":"The numeric Code of the currency.",
                            "type":"string"
                        }
                    }
                },
                "salePriceList":{
                    "description":"The price list for sale prices.",
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository id of the sale price list.",
                            "type":"string"
                        }
                    }
                },
                "locale":{
                    "description":"Locale of the the associated list price list.",
                    "type":"string"
                },
                "shippingSurchargePriceList":{
                    "description":"The price list for shipping surcharge prices.",
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository id of shipping surcharge price list.",
                            "type":"string"
                        }
                    }
                },
                "startDate":{
                    "description":"Start date of the the associated list price list.",
                    "type":"string"
                }
            }
        },
        "defaultCatalog":{
            "description":"Catalog determined by the webhook/Fall Back for the current context.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "type":"string"
                }
            }
        },
        "message":{
            "type":"string"
        },
        "isExternalContext":{
            "type":"boolean"
        }
    }
}

Nested Schema : defaultAdditionalPriceListGroups

Type: array

Show Source

• Array of: object items
  Additional Pricelistgroup determined by webhook/Fall Back for the current context

{
    "type":"array",
    "items":{
        "description":"Additional Pricelistgroup determined by webhook/Fall Back for the current context",
        "type":"object",
        "properties":{
            "deleted":{
                "description":"Indicates if the PriceListGroup is deleted.",
                "type":"boolean"
            },
            "endDate":{
                "description":"End date of the the associated list price list.",
                "type":"string"
            },
            "displayName":{
                "description":"Display name of the PriceListGroup.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The ID of the PriceListGroup item.",
                "type":"string"
            },
            "listPriceList":{
                "description":"The price list for list prices",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository id of the list price list.",
                        "type":"string"
                    }
                }
            },
            "active":{
                "description":"Indicates if the PriceListGroup is active.",
                "type":"boolean"
            },
            "currency":{
                "description":"The currency details of the PriceListGroup.",
                "type":"object",
                "properties":{
                    "symbol":{
                        "description":"The symbol of the currency.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The display Name of the currency.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository id of the currency.",
                        "type":"string"
                    },
                    "fractionalDigits":{
                        "description":"Fractional digits that currency supports.",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"The currency Code of the currency.",
                        "type":"string"
                    },
                    "numericCode":{
                        "description":"The numeric Code of the currency.",
                        "type":"string"
                    }
                }
            },
            "salePriceList":{
                "description":"The price list for sale prices.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository id of the sale price list.",
                        "type":"string"
                    }
                }
            },
            "locale":{
                "description":"Locale of the the associated list price list.",
                "type":"string"
            },
            "shippingSurchargePriceList":{
                "description":"The price list for shipping surcharge prices.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository id of shipping surcharge price list.",
                        "type":"string"
                    }
                }
            },
            "startDate":{
                "description":"Start date of the the associated list price list.",
                "type":"string"
            }
        }
    }
}

Nested Schema : defaultCatalog

Type: object

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

Show Source

• repositoryId(optional): string

{
    "description":"Catalog determined by the webhook/Fall Back for the current context.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "type":"string"
        }
    }
}

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.

{
    "description":"Pricelistgroup determined by the webhook/Fall Back for the current context",
    "type":"object",
    "properties":{
        "deleted":{
            "description":"Indicates if the PriceListGroup is deleted.",
            "type":"boolean"
        },
        "endDate":{
            "description":"End date of the the associated list price list.",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the PriceListGroup.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the PriceListGroup item.",
            "type":"string"
        },
        "listPriceList":{
            "description":"The price list for list prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of the list price list.",
                    "type":"string"
                }
            }
        },
        "active":{
            "description":"Indicates if the PriceListGroup is active.",
            "type":"boolean"
        },
        "currency":{
            "description":"The currency details of the PriceListGroup.",
            "type":"object",
            "properties":{
                "symbol":{
                    "description":"The symbol denoting currency.",
                    "type":"string"
                },
                "displayName":{
                    "description":"The display Name of the currency.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The repository id of the currency.",
                    "type":"string"
                },
                "fractionalDigits":{
                    "description":"Fractional digits that currency supports.",
                    "type":"string"
                },
                "currencyCode":{
                    "description":"The currency Code of the currency.",
                    "type":"string"
                },
                "numericCode":{
                    "description":"The numeric Code of the currency.",
                    "type":"string"
                }
            }
        },
        "salePriceList":{
            "description":"The price list for sale prices.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of the sale price list.",
                    "type":"string"
                }
            }
        },
        "locale":{
            "description":"Locale of the the associated list price list.",
            "type":"string"
        },
        "shippingSurchargePriceList":{
            "description":"The price list for shipping surcharge prices.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of shipping surcharge price list.",
                    "type":"string"
                }
            }
        },
        "startDate":{
            "description":"Start date of the the associated list price list.",
            "type":"string"
        }
    }
}

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.

{
    "description":"Additional Pricelistgroup determined by webhook/Fall Back for the current context",
    "type":"object",
    "properties":{
        "deleted":{
            "description":"Indicates if the PriceListGroup is deleted.",
            "type":"boolean"
        },
        "endDate":{
            "description":"End date of the the associated list price list.",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the PriceListGroup.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the PriceListGroup item.",
            "type":"string"
        },
        "listPriceList":{
            "description":"The price list for list prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of the list price list.",
                    "type":"string"
                }
            }
        },
        "active":{
            "description":"Indicates if the PriceListGroup is active.",
            "type":"boolean"
        },
        "currency":{
            "description":"The currency details of the PriceListGroup.",
            "type":"object",
            "properties":{
                "symbol":{
                    "description":"The symbol of the currency.",
                    "type":"string"
                },
                "displayName":{
                    "description":"The display Name of the currency.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The repository id of the currency.",
                    "type":"string"
                },
                "fractionalDigits":{
                    "description":"Fractional digits that currency supports.",
                    "type":"string"
                },
                "currencyCode":{
                    "description":"The currency Code of the currency.",
                    "type":"string"
                },
                "numericCode":{
                    "description":"The numeric Code of the currency.",
                    "type":"string"
                }
            }
        },
        "salePriceList":{
            "description":"The price list for sale prices.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of the sale price list.",
                    "type":"string"
                }
            }
        },
        "locale":{
            "description":"Locale of the the associated list price list.",
            "type":"string"
        },
        "shippingSurchargePriceList":{
            "description":"The price list for shipping surcharge prices.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of shipping surcharge price list.",
                    "type":"string"
                }
            }
        },
        "startDate":{
            "description":"Start date of the the associated list price list.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The currency details of the PriceListGroup.",
    "type":"object",
    "properties":{
        "symbol":{
            "description":"The symbol of the currency.",
            "type":"string"
        },
        "displayName":{
            "description":"The display Name of the currency.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository id of the currency.",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"Fractional digits that currency supports.",
            "type":"string"
        },
        "currencyCode":{
            "description":"The currency Code of the currency.",
            "type":"string"
        },
        "numericCode":{
            "description":"The numeric Code of the currency.",
            "type":"string"
        }
    }
}

Nested Schema : listPriceList

Type: object

The price list for list prices

Show Source

• repositoryId(optional): string
  Repository id of the list price list.

{
    "description":"The price list for list prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of the list price list.",
            "type":"string"
        }
    }
}

Nested Schema : salePriceList

Type: object

The price list for sale prices.

Show Source

• repositoryId(optional): string
  Repository id of the sale price list.

{
    "description":"The price list for sale prices.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of the sale price list.",
            "type":"string"
        }
    }
}

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices.

Show Source

• repositoryId(optional): string
  Repository id of shipping surcharge price list.

{
    "description":"The price list for shipping surcharge prices.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of shipping surcharge price list.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The currency details of the PriceListGroup.",
    "type":"object",
    "properties":{
        "symbol":{
            "description":"The symbol denoting currency.",
            "type":"string"
        },
        "displayName":{
            "description":"The display Name of the currency.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository id of the currency.",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"Fractional digits that currency supports.",
            "type":"string"
        },
        "currencyCode":{
            "description":"The currency Code of the currency.",
            "type":"string"
        },
        "numericCode":{
            "description":"The numeric Code of the currency.",
            "type":"string"
        }
    }
}

Nested Schema : listPriceList

Type: object

The price list for list prices

Show Source

• repositoryId(optional): string
  Repository id of the list price list.

{
    "description":"The price list for list prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of the list price list.",
            "type":"string"
        }
    }
}

Nested Schema : salePriceList

Type: object

The price list for sale prices.

Show Source

• repositoryId(optional): string
  Repository id of the sale price list.

{
    "description":"The price list for sale prices.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of the sale price list.",
            "type":"string"
        }
    }
}

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices.

Show Source

• repositoryId(optional): string
  Repository id of shipping surcharge price list.

{
    "description":"The price list for shipping surcharge prices.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of shipping surcharge price list.",
            "type":"string"
        }
    }
}

Back to Top