Introduction
The Shopping Cart component is responsible for handling all aspects related to the management and manipulation of shopping carts within the e-commerce system. It encompasses functionalities for creating, updating, and deleting shopping carts, as well as adding, removing, and modifying items within them. This component serves as the backbone of the shopping experience, enabling users to interact with their carts and make changes as needed.
Key Features:
- Multiple product categories and multiple process context support through offer container
- Capability to add, remove or update cart item(s), offer container(s) or shopping as a whole.
- New buy and in life sales journeys
- Price points
- Pricing based on channel, place, market segments and product terms
- Attribute based pricing
- Support for external price override
- Manual price override based on roles
- Agreement based pricing
- Promotions at the cart item, offer container and cart levels
- Price adjustment using gift cards or wallet balance
- Static bundles, bundles inside a bundle, bundling of offerings across different offer container categories
- Shopping Cart rules
- Category Cardinility Validation and Mutually Exclusivity
- Save carts for anonymous journeys
- Access Control based on user type and permissions assigned to user
- Non-persistence in shopping cart
- Cart Validations
- Move cart to different channel / place
- Context store and context data signature verification
What made this section unhelpful for you?
Base URL
Production:
https://your-url.com/shoppingcart-management/v4
What made this section unhelpful for you?
Query Shopping Cart
The 'Get Shopping Cart' component provides functionalities to retrieve information about shopping carts. It allows users to query various aspects of a shopping cart, including its contents, prices and promotions. This module enables both customers and administrators to view and analyze the contents of shopping carts, facilitating order management and customer service processes
Manage Shopping Cart
The 'Manage Shopping Cart' component is responsible for handling all aspects related to the management and manipulation of shopping carts within the e-commerce system. It encompasses functionalities for creating, updating, and deleting shopping carts, as well as adding, removing, and modifying items within them. This component serves as the backbone of the shopping experience, enabling users to interact with their carts and make changes as needed.
What made this section unhelpful for you?
Create Shopping Cart
This API allows you to create a shopping cart and associate it with a specific channel, place, market segment, and related parties. These associations must be made when creating the cart, as they affect the available product offerings and their pricing. A shopping cart can be created with one or more offer containers, each containing one or more cart items, or it can be created without any cart items or offer containers.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Body Parameters
Shopping Cart Id
Hyperlink reference of the entity.
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Agent Id if the owner of shopping cart is an Agent. Value is populated by system
User Id of the owner of the shopping cart. Value is populated by system
Status of shopping cart
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDSystem field for internal use
User Type of the owner of the shopping cart. Value is populated by system
Representing a Context
Show child attributes
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The username of the user who created the entity. This attribute is auto-populated.
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Non recurring price adjustment.
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Patch Shopping Cart
The Shopping Cart Patch API allows you to update specific attributes of child objects or create new child objects. It also enables you to perform multiple operations on various objects simultaneously, such as adding a cart item, updating the quantity of an existing cart item, or creating a note at the offer container level, which would otherwise require multiple API calls. The patch operation is not generalized and supports the creation, patching, and deletion of only certain objects.
The request body can contain a list of patch operations, each of which must include the operation type, path, and value. The operation type can be add, patch, delete, or replace. The path should be the full path of the object to be created or updated. The fields specified in 'value' are used to create or update the object as defined in the path.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Body Parameters
Representing a Context
Show child attributes
Show child attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Empty Shopping Cart
This API allows users to reset the shopping cart and start the configuration from the beginning. It removes all offer containers and their contents, while retaining the customer and contact information.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Path Parameters
Shopping cart Id
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Delete Shopping Cart
This API can be used to permanently delete a shopping cart from the database. This also generates a event 'ShoppingCartDeletedEvent'. Deleting a shopping cart also deletes the associated checkout data.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Path Parameters
Shopping cart Id
Response
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
Shopping cart deleted.What made this section unhelpful for you?
Add Offer Container
This API can be used to add one or more offer containers into the shopping cart. Each offer container must have category and process context defined. Offer container can by empty and have one or more cart items within it.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Body Parameters
Representing a Context
Show child attributes
Show child attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Update OfferContainers
This API can be used to replace the cart items in one or more offer containers in a single call. AdditionalAttributes are completely replaced with what is received in the request. Offer containers are uniquely identified using the portfolioId so portfolioId must be passed in the request to update an existing offer container. If the portfolioId is not passed in the request, new offer container is created. For the existing cart items in the existing offer containers, product.id must be passed in the request. If product.id is not passed for cart item in the request, a new cart item is created. Existing cart items if not sent in the request are deleted.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Body Parameters
Representing a Context
Show child attributes
Show child attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Delete offer container
This API can be used to delete an offer container from a shopping cart based on the offer container id. The complete content of the offer container is removed.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Offer container Id
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Create Cart Item
This API can be used to add one or more cart items into an offer container. Each item must have either a product offering or product associated to it.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Offer container Id
Body Parameters
Representing a Context
Show child attributes
Show child attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Update Cart Items
This API can be used to update one or more cart items within an offer container in a single call. All the existing cart items are removed and replaced with all the cart items received in the request.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Offer container Id
Body Parameters
Representing a Context
Show child attributes
Show child attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Delete Cart Item
Deletes a cart item from a given offer container in the shopping cart
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Offer container Id
Cart item Id
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Validate Shopping Cart
Validates the shopping cart and generates a validity token if successfully validated. Following validations are done:
Validates Signature
Check promotion validity and reapply promotion as per the latest definition
- Validates mandatory characteristics have a value provided
Check the validity of the product offerings based on validity dates, channel, place and market segment
Reprice the cart
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Body Parameters
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
List of errors with the error code, error message and list of parameters giving more details about the error
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"shoppingCart": {
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
""
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
""
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [],
"billingAccount": {},
"productCharacteristic": [],
"productOffering": {},
"place": [],
"productOrderItem": [],
"productPrice": [],
"productRelationship": [],
"productSpecification": {},
"productTerm": [],
"realizingResource": [],
"realizingService": [],
"status": "",
"relatedParty": [],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
""
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": []
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
""
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
""
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
},
"listOfErrors": [
{
"errorCode": "",
"errorMessage": "",
"errorMap": {}
}
]
}What made this section unhelpful for you?
Modify Channel and Place
This API transfers a shopping cart to a different channel or location. Upon successful transfer, all rules, pricing, and promotions are reevaluated according to the new channel or location. Before the transfer, the service validates the existing offers and promotions in the cart for compatibility with the new channel or location. If discrepancies are found, the service will either remove the conflicting items or return an error, based on the offerAutoRemoval and promoAutoRemoval settings specified in the request.
Additional mandatory fields :
Either channel or place
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Channel
Place
Path Parameters
Shopping cart Id
Body Parameters
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Representing a Context
Show child attributes
Response
Response Attributes
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
List of errors with the error code, error message and list of parameters giving more details about the error
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"shoppingCart": {
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
""
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
""
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [],
"billingAccount": {},
"productCharacteristic": [],
"productOffering": {},
"place": [],
"productOrderItem": [],
"productPrice": [],
"productRelationship": [],
"productSpecification": {},
"productTerm": [],
"realizingResource": [],
"realizingService": [],
"status": "",
"relatedParty": [],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
""
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": []
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
""
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
""
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
},
"listOfErrors": [
{
"errorCode": "",
"errorMessage": "",
"errorMap": {}
}
]
}What made this section unhelpful for you?
Do Base Price
This API recalculates the total price of the shopping cart. It can be used to query the cart for the latest price at the current time. For example, when a user logs in, the shopping cart created previously needs to be recalculated to reflect the latest prices.
Header Parameters
The context-id using which the context data is saved in context store.If context store is enabled, complete context data is not required to be passed in the request every time as data can be retrieved by service directlyfrom contex store using context-id
It is a unique identifier assigned to a specific transaction within a system or application.This is required to identify the sequence of API calls related to a specific transaction in the logs for monitoring and troubleshooting
It is a unique identifier assigned to a particular transaction, request, or event in a distributed system.It serves the purpose of linking related messages, actions, or components together as they traverse various parts of the system.This is required to identify the sequence of API calls related to a specific record in the logs for monitoring and troubleshooting
Name of the source channel that sent the request to be passed by consumer component.This is required to identify the API calls in the logs which have come from specific channels
It is a unique code or identifier that is assigned to each tenant in a multi-tenant system or application.In a multi-tenant architecture, a single instance of the software or service serves multiple clients or tenants, keeping their data and configurations separate to ensure privacy and data isolation. This is required to identify the API calls related to a specific tenantin the logs for monitoring and troubleshooting
Query Parameters
Path Parameters
Shopping cart Id
Body Parameters
Shopping Cart resource is used for the temporary selection and reservation of product offerings in e-commerce, call center and retail purchase
Show child attributes
Response
Response Attributes
Show child attributes
Shopping cart identifier. This is generated by system.
Hyperlink reference of the entity.
Generic attribute containing the link to the schema that defines the structure of the class type of the current object.
Generic attribute containing the name of the resource class type.
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show child attributes
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The channel defines the channel for selling product offerings. Either channel.id or channel.name is mandatory
Show child attributes
Signature object consisting of context and cart signature
Show child attributes
Id of the Agent who created this shopping cart. Value is populated by system
Id of the user who created this shopping cart. Value is populated by system
Status of shopping cart.
ACTIVESUBMITTEDABONDONEDEXPIREDQUOTE_CREATEDType of user for e.g. CUSTOMER, DEALER, ANONYMOUS, ADMINISTRATOR etc. This value comes from user token
Unique Id to query saved cart for anonymous users
The username of the user who created the entity. This attribute is auto-populated.
The date and time when the user last updated the entity. This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC)
The date and time when the user created the entity This attribute is auto-populated. By default dates are stored in UTC Format i.e. YYYY-MM-DD HH:MM:SS.SSS (UTC).
The username of the user who last updated the entity. This attribute is auto-populated.
Geographical location over which the price of an offering can vary
Show child attributes
Show child attributes
Email address of the contact of this shopping cart
The primary phone number of the contact
It is a encrypted string with a validity as defined using scValidityTime (in minutes) in application configuration. This token must be passed to checkout API to capture or query data.
This flag is sent in the response to indicate if the price of any of the cart item in the cart has changed.
This object is returned only in response when offers or promotions are auto removed by 'Modify Channel and Place' api.
Show child attributes
Show child attributes
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth
Show child attributes
Indicates whether shoppincart is of type amendment.
Show child attributes
Shopping cart signature.
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
Response Attributes
An "error code" is a numeric or alphanumeric identifier employed to signify a particular error or problem that has arisen within a service
An "error reason" refers to an explanation or description of the underlying cause or reason for a specific error or issue that has occurred within a service
This indicates the HTTP status code linked to this error
The "timestamp" at which error occurred" refers to the specific date and time when an error or issue occurred within a service
An "error message" is a specific piece of information or notification that is generated by a service to inform the user that an error or issue has occurred
Show child attributes
What made this section unhelpful for you?
Response
{
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"id": "",
"href": "",
"@schemaLocation": "",
"@type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"contactMedium": [
{
"preferred": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"mediumType": "",
"characteristic": {
"city": "",
"country": "",
"emailAddress": "",
"faxNumber": "",
"phoneNumber": "",
"postCode": "",
"stateOrProvince": "",
"addressId": "",
"street1": "",
"street2": "",
"contactType": "",
"socialNetworkId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"offerContainer": [
{
"id": "",
"processContext": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"cartItem": [
{
"action": "add",
"id": "",
"quantity": null,
"status": "",
"note": [
{
"id": "",
"author": "",
"date": "",
"text": "",
"@baseType": "",
"@schemaLocation": "",
"createdOn": "",
"updatedBy": "",
"updatedOn": "",
"@type": "",
"createdBy": ""
}
],
"itemTerm": [
{
"description": "",
"duration": {
"amount": null,
"units": ""
},
"name": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"cartItemRelationship": [
{
"id": "",
"relationshipType": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"itemPrice": [
{
"description": "",
"name": "",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriodLength": null,
"offset": null,
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {
"unit": "",
"value": null
},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"additionalAttributes": [
""
],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"priceSubType": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
{
"block": null,
"allowedSelectionCount": null,
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": ""
}
]
},
"isProrated": false,
"isArrears": false,
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productOffering": {
"id": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"version": "",
"externalId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"product": {
"id": "",
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"productLineCategory": "",
"orderDate": "",
"name": "",
"productSerialNumber": "",
"startDate": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"terminationDate": "",
"product": [
{
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
""
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {},
"productOfferingPrice": {},
"productPriceAlteration": [],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [],
"validFor": {}
}
],
"productRelationship": [
{
"relationshipType": "",
"product": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
{
"description": "",
"name": "",
"duration": {},
"validFor": {},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"agreement": [
{
"id": "",
"agreementProductOfferingPrice": [
{
"id": "",
"price": {}
}
],
"href": "",
"agreementItemId": "",
"name": "",
"characteristic": [
{
"valueType": "",
"name": "",
"value": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"place": [
{
"id": "",
"address": "",
"name": "",
"role": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productCharacteristic": [
{
"name": "",
"valueType": "",
"value": "",
"action": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [
{
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOrderItem": [
{
"orderItemAction": "",
"orderItemId": "",
"productOrderHref": "",
"role": "",
"productOrderId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"productRelationship": [
{
"relationshipType": "",
"product": {
"id": "",
"description": "",
"isBundle": false,
"isCustomerVisible": false,
"orderDate": "",
"productSerialNumber": "",
"name": "",
"startDate": "",
"terminationDate": "",
"agreement": [
""
],
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productCharacteristic": [
""
],
"productOffering": {
"id": "",
"version": "",
"externalId": "",
"category": [],
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"place": [
""
],
"productOrderItem": [
""
],
"productPrice": [
""
],
"productRelationship": [
""
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productTerm": [
""
],
"realizingResource": [
""
],
"realizingService": [
""
],
"status": "",
"relatedParty": [
""
],
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productSpecification": {
"id": "",
"version": "",
"name": "",
"targetProductSchema": {
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPrice": [
{
"priceSubType": "",
"offset": null,
"recurringChargePeriodLength": null,
"tax": [
{
"id": "",
"taxCategory": "",
"taxRate": null,
"taxAmount": {},
"name": "",
"displayName": "",
"taxType": "",
"definesExemption": false,
"validFor": {},
"additionalAttributes": [],
"@baseType": "",
"@type": ""
}
],
"priceId": "",
"isDownPaymentRequired": false,
"minimumDownPaymentAmount": null,
"offsetParameter": {
"numberofBlock": null,
"totalAllowanceSelectionCount": null,
"isCalenderBased": false,
"discountType": "",
"billingDiscountExternalRef": "",
"discountValue": null,
"allowedDiscount": [
""
]
},
"agreementBased": false,
"description": "",
"name": "",
"priceType": "",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"recurringChargePeriod": "",
"unitOfMeasure": "",
"billingAccount": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"productPriceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {},
"productOfferingPrice": {},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"@baseType": "",
"@schemaLocation": "",
"@type": "",
"itemPriceRelationship": [
{
"relationshipType": "",
"priceId": ""
}
],
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"productTerm": [
{
"description": "",
"name": "",
"duration": {
"amount": null,
"units": ""
},
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"realizingResource": [
{
"id": "",
"value": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"realizingService": [
{
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"status": "",
"parentBundleId": "",
"portfolioId": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"itemTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {},
"percentage": null,
"taxIncludedAmount": {},
"taxRate": null,
"dutyFreeAlteredAmount": {},
"taxIncludedAlteredAmount": {},
"changeAmount": {},
"actionCardinality": null,
"discount": {},
"amountPayable": {},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"bundleParentId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"updatedOn": "",
"updatedBy": "",
"createdBy": "",
"createdOn": "",
"bundlePriceOption": null,
"addedBySCRuleEngine": false,
"isCartItemPriceChanged": false,
"priceSignature": "",
"customizedPrice": [
{
"priceSubType": "",
"source": "",
"id": "",
"priceId": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"offset": null,
"type": "manualPriceOverride",
"externalId": "",
"actionType": "Flat Discount",
"actionValue": null,
"createdBy": "",
"createdOn": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
}
}
],
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"downpayment": {
"downpaymentAmount": null,
"itemPriceId": ""
},
"sku": "",
"discountPeriod": [
{
"allowedSelectionPeriod": "",
"selectedDiscountPeriod": "",
"itemPriceId": ""
}
],
"addedByPromotion": false,
"repriceOnModify": false,
"amendmentAllowed": false
}
],
"offerContainerTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"changedItemsBySCRule": {
"added": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"removed": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replaced": [
{
"replacedBy": [
{
"cartItemId": "",
"productOfferingId": ""
}
],
"replacedWith": [
{
"cartItemId": "",
"productOfferingId": ""
}
]
}
]
},
"category": {
"id": "",
"name": "",
"version": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"bundleOfferContainerId": "",
"itemPriceChanged": [
{
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "",
"changeType": "increase",
"offset": null,
"priceSubType": "",
"changeInPrice": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"taxIncludedAmount": {
"unit": "",
"value": null
},
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
}
},
"agreementBased": false
}
],
"createdOn": "",
"portfolioId": "",
"createdBy": "",
"updatedOn": "",
"updatedBy": "",
"isCartItemPriceChanged": false,
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
]
}
],
"relatedParty": [
{
"id": "",
"role": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
}
],
"cartTotalPrice": [
{
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"recurringChargePeriodLength": null,
"offset": null,
"description": "",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"priceAlteration": [
{
"applicationDuration": null,
"description": "",
"name": "",
"priceType": "Onetime, Recurring, Allowance etc.",
"priority": null,
"recurringChargePeriod": "Monthly, Quarterly, Annually",
"unitOfMeasure": "1 unit, 2 GB, 100 minutes",
"price": {
"dutyFreeAmount": {
"unit": "",
"value": null
},
"percentage": null,
"taxIncludedAmount": {
"unit": "",
"value": null
},
"taxRate": null,
"dutyFreeAlteredAmount": {
"unit": "",
"value": null
},
"taxIncludedAlteredAmount": {
"unit": "",
"value": null
},
"changeAmount": {
"unit": "",
"value": null
},
"actionCardinality": null,
"discount": {
"unit": "",
"value": null
},
"amountPayable": {
"unit": "",
"value": null
},
"taxAmount": null,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
},
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceAlterationType": "promotion",
"referenceId": "",
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"productOfferingPrice": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"priceSubType": "",
"agreementBased": false,
"@baseType": "",
"@type": "",
"@schemaLocation": ""
}
],
"channel": {
"id": "",
"href": "",
"role": "",
"name": "",
"@baseType": "",
"@schemaLocation": "",
"@referredType": "",
"@type": ""
},
"signature": {
"contextSignature": "",
"cartSignature": ""
},
"agentId": "",
"userId": "",
"status": "ACTIVE",
"userType": "",
"uniqueId": "",
"createdBy": "",
"updatedOn": "",
"createdOn": "",
"updatedBy": "",
"place": {
"id": "",
"name": "",
"role": "",
"address": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"promotions": [
{
"id": "",
"description": "",
"name": "",
"lifeCycleStatus": "Launched",
"internalLifecycleStatus": "Launched",
"type": "",
"validFor": {
"endDateTime": "",
"startDateTime": ""
},
"promotionAction": {
"id": "",
"actionType": "Add Product",
"actionValue": null,
"actionObjectId": "",
"actionCardinality": null,
"priceType": "",
"applicationDuration": null,
"priority": null,
"priceId": "",
"recurringChargePeriodType": "",
"maxActionValue": null,
"cartItemId": "",
"offerContainerId": ""
},
"priority": null,
"category": "",
"signature": "",
"promotionClassification": "Exclusive",
"promoApplicationLevel": "cart",
"externalID": "",
"coupon": {
"id": "",
"code": "",
"coupon": false
},
"isCheckout": false
}
],
"emailAddress": "",
"phoneNumber": "",
"validityToken": "",
"isCartItemPriceChanged": false,
"changedItemsBySCService": {
"autoRemovedOffer": [
{
"offerContainerId": "",
"cartItemId": "",
"offerId": ""
}
],
"autoRemovedPromotions": [
{
"offerContainerId": "",
"cartItemId": "",
"promotionId": "",
"level": ""
}
]
},
"additionalAttributes": [
{
"name": "",
"value": "",
"valueType": ""
}
],
"marketSegment": {
"id": "",
"name": "",
"href": "",
"@baseType": "",
"@type": "",
"@schemaLocation": "",
"@referredType": ""
},
"isAmendment": false,
"nonRecurringPriceAdjustment": [
{
"id": "",
"type": "giftCard",
"name": "",
"referenceId": "",
"amount": null,
"details": [
{
"name": "",
"value": ""
}
]
}
],
"scSignature": ""
}What made this section unhelpful for you?
Discounts and Price Adjustments
This API suite allows for the application of discounts through various promotions at the item, offer container, or shopping cart levels. It also supports price overrides by agents and adjusts the total payable amount in the cart based on upfront down payments, redeemed gift vouchers, or wallet balances.
Amendment Shopping Cart
Once an order is submitted, the status of the associated shopping cart is updated to "submitted," making it read-only and unmodifiable. If a user wants to make changes to the order after submission, this can be done through an order amendment process. However, items that have reached the Point of No Return (PONR) cannot be modified, even through this process.
Blue Marble order management provides APIs that allow an order to be put on hold. The client can then query the order line items to determine which items can still be amended and which cannot. Amendments are initiated using an amendment shopping cart, which initially loads all line items with a status of "Keep." The user can then modify the cart and resubmit it.
When an order is modified through the amendment shopping cart, it may result in new products being added or existing products being removed, potentially leading to price changes. If the price increases, the user may need to pay the additional amount. Conversely, if the price decreases, the user will be refunded the balance.
Shopping Cart Notes
Provides set of APIs to add, update or delete notes at item or offer container level
Anonymous Cart
Provides set of APIs to support anonymous journey
Simulated Product Price
Provides API to calculate the price of offerings in a simulated mode before they are added to the cart.
Configuration
This set of APIs enables the management of shopping cart configurations, including scheduling settings and defining price adjustment limits based on user roles.