Fields
_custom_json
JSONCustom JSON at article level. Example: { gift_wrap: true }
article_assignment
ArticleAssignmentInputArticle assignment rules (level/strategy). Example: { level: 'item', strategy: 'fast-delivery/optimal' }
article_id
StringUnique identifier of an article. Example: '5fdc737e3c05146138192f79'
display
StringDisplay text at article level. Example: 'Limited Edition'
extra_meta
JSONAdditional metadata at article level. Example: { color: 'Red' }
item_id
IntProduct identifier. Example: 987654
item_size
StringSize of the product. Example: 'M'
meta
JSONMetadata at article level. Example: { source: 'PDP' }
parent_item_identifiers
[JSON]Parent product identifiers. Example: [{ parent_item_id: 111, relation: 'bundle' }]
pos
BooleanWhether request is made from POS. Example: false
product_group_tags
[String]Product group tags for the item. Example: ['buy-1-get-1', 'clearance']
quantity
IntQuantity to add. Example: 2
seller_id
IntSelected seller ID. Example: 5678
store_id
IntSelected store ID. Example: 1234
seller_identifier
StringSeller identifier for Store OS. Example: 'SELLER-001'
fulfillment_option_slug
StringFulfillment method slug. Example: 'home-delivery' or 'store-pickup'
pickup_store_id
IntPickup store ID for store pickup. Example: 2001
force_new_line_item
BooleanIf true, forces a separate line item. Example: true
Was this section helpful?