Order API specifications change with the order segment feature

You can now retrieve split order data via the APIs, while rules for updating and cancelling orders have changed.

Required action

Review the order API specifications and update your applications accordingly.

Changes

  • You can reference split status and parent order IDs from the segment field in order responses.
  • A negative order amount is returned if the total discount exceeds an individual split order.
  • For split orders, you can update the point status only on the parent order.
  • Cancelling a parent order also cancels related split orders, and specifying a child order returns an error.
  • Specifying a child order returns an error when sending order or payment confirmation emails.

Affected areas

v1/salesv1/sales/{sale_id}v1/sales/{sale_id}/cancelv1/sales/{sale_id}/mailssegmentparent_sale_idsplittedsiblings_sale_ids

Screenshots

Order API specifications change with the order segment featureOrder API specifications change with the order segment feature
Open official page

This summary is independently created by Release Radar and is not an official announcement from the vendor. Please read the official page for accurate details.