Fields
_custom_json
JSONCustom JSON at article level. Example: { gift_wrap: true }
cart_item_meta
JSONMeta details of the article from cart. Example: { source: 'cart-page' }
extra_meta
JSONExtra metadata for the article. Example: { color: 'Red' }
gift_card
JSONGift card details if applied (price, applicable flag, message). Example: { price: 500, applicable: true }
identifier
JSONUnique identifier of the article. Example: { uid: 'ART123' }
is_gift_visible
BooleanWhether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
meta
JSONArticle metadata. Example: { bundle: false }
force_new_line_item
BooleanFlag to indicate the item as a separate line in cart. Example: false
mto_quantity
IntMake-to-order quantity if not in stock. Example: 1
parent_item_identifiers
JSONParent product identifiers. Example: { parent_item_id: 111 }
price
ArticlePriceInfoArticle level price details including base and converted prices. Example: { base: { effective: 499 }, converted: { effective: 499 } }
product_group_tags
[String]List of product grouping tags. Example: ['bundle', 'set']
quantity
IntQuantity of the article added in cart. Example: 2
seller
NameInformationBasic information which provides basic info like uid of any entity like brand or seller and name of the entity.
seller_identifier
StringSeller identifier used for the product size. Example: 'SELLER-001'
size
StringSize of the article added in cart. Example: 'M'
store
StoreInfoStore information of the store which includes store name, store id and store code.
fulfillment_option
FulfillmentOptionSelected Fulfillment Option Details.
pickup_store_detail
PickupStoreDetailProvides details about a store where customers can pick up their orders.
tags
[String]A list of article tags. Example: ['express-eligible']
item_index
IntIndex of the article in cart. Example: 0
type
StringType of the data sent in response. Example: 'article'
uid
StringUnique identifier for item × size × location. Example: 'line_abc123'
Was this section helpful?