Skip to main content

Unified item schema in order and payment responses

What's new

Item objects in order and payment responses now share a single Item schema. The previous per-domain OrderItem and PaymentItem schemas have been removed, and order item responses are tightened: name and quantity are now required, image_url is a plain string, and nested_items can recurse one level further.

Impact

Order and payment responses now expose item data in a consistent shape. Payment items also gain description and nested_items, which previously were only available on order items.

Changes

ResourceChange
get_orderItem schema unified to Item. name and quantity are now required. image_url is a plain string (was a nullable anyOf of URI and empty string). nested_items entries themselves now expose a nested_items field
update_orderSame item-schema changes as get_order
get_paymentsPayment items now use the shared Item schema and expose new optional description and nested_items fields
ComponentsRemoved OrderItem and PaymentItem schemas (replaced by Item)

Upgrade

  • Update typings or deserializers that referenced OrderItem or PaymentItem to consume the shared Item schema instead.
  • For order items, treat image_url as a plain string and stop branching on the previous nullable anyOf shape; treat name and quantity as guaranteed to be present.
  • Payment items now expose optional description and nested_items — pick them up if you need richer item detail on payments.

Need help?
Contact our integration team at [email protected]