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
| Resource | Change |
|---|---|
| get_order | Item 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_order | Same item-schema changes as get_order |
| get_payments | Payment items now use the shared Item schema and expose new optional description and nested_items fields |
| Components | Removed OrderItem and PaymentItem schemas (replaced by Item) |
Upgrade
- Update typings or deserializers that referenced
OrderItemorPaymentItemto consume the sharedItemschema instead. - For order items, treat
image_urlas a plain string and stop branching on the previous nullableanyOfshape; treatnameandquantityas guaranteed to be present. - Payment items now expose optional
descriptionandnested_items— pick them up if you need richer item detail on payments.
Need help?
Contact our integration team at [email protected]