Orders: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Use an order ID across different eCommerce APIs

Some eCommerce functionality is accessible by using an order's ID and passing it to other eCommerce APIs.

1. To retrieve transaction details, including payment IDs, pass the order ID to List Transactions For Single Order.
2. To add a payment record, pass the order ID and payment details to Add Payments.
3. To modify the payment status, pass the order ID along with the payment ID to Update Payment Status.
4. To retrieve fulfillment details, pass the order ID to List Fulfillments For Single Order.

Search for orders by customer

You can retrieve all orders placed by a specific customer using their email address.

1. Call Search Orders with a filter on buyerInfo.email. For example:

   Copy

2. The response contains an array of orders matching the filter. Use the pagingMetadata.cursors object to paginate through results if needed.

3. To get transaction details for a specific order, pass the order id to List Transactions For Single Order.

Create an order with restricted edit access

If you want to ensure that only your app can edit orders it creates, you can restrict edit access at creation time. This is useful, for example, to prevent other apps from modifying imported orders.

To create an order that only your app can edit:

1. Call Create Order and add the following to the request body's settings field:

   Copy

2. The order is created with edit access restricted to your app. Any other app that attempts to edit the order receives an ORDER_CANNOT_BE_EDITED error.

Track fulfillment status

You can retrieve fulfillment details for an order and update tracking information.

1. Call List Fulfillments For Single Order with the order ID to get existing fulfillments.

2. To add a new fulfillment with tracking information, call Create Fulfillment. For example:

   Copy

3. To update tracking information on an existing fulfillment, call Update Fulfillment with the order ID, fulfillment ID, and updated tracking details.