Question 1

What is the Retrieve an Order API endpoint?

Accepted Answer

This “Retrieve an Order” API endpoint is used to retrieve data for a completed order inside the Zonos System. The response will contain a JSON object, representing all the available information for the order including billing and shipping addresses, shipping method, order totals, and status.

Question 2

What are the common ways to use the Retrieve an Order API endpoint?

Accepted Answer

There are two common ways to use these endpoints. One is to use a custom order confirmation / success page on your domain to trigger your system to call the `orderDetail` endpoint and import a completed order. In addition, regularly call the `orderNumbers` endpoint to reconcile any orders in the Zonos System not imported into your system. The other way is to use the Zonos basic order confirmation / success page or a static page on your domain to indicate order completion to the customer. Schedule your system to regularly call the `orderNumbers` endpoint to determine when a new order is ready to be imported in your system. When an outstanding order is found, call the `orderDetail` endpoint for the data on those orders.

Question 3

What is the initial order status when calling the orderDetail endpoint?

Accepted Answer

When calling the `orderDetail` endpoint, we recommend that your system first checks the `orderStatus` property of the order data. Orders that do not require fraud review will initialize with `orderStatus` : `IGLOBAL_ORDER_IN_PROCESS`. An order in this status is ready to be processed and shipped. Orders that do require fraud review will initialize in `orderStatus` : `IGLOBAL_FRAUD_REVIEW`. An order in this status is currently being screened and reviewed for suspected fraud. We recommend you place this order on a review or hold status in your system and continue to call the `orderDetail` endpoint until the order progresses past Zonos’ fraud review process.

Question 4

What happens once the Zonos fraud screening process is completed?

Accepted Answer

Once the Zonos fraud screening process is completed, the order will move to one of the following states: If the order passes fraud screening, it will move to `orderStatus` : `IGLOBAL_ORDER_IN_PROCESS` and can continue toward shipment. If the order fails fraud screening, it will move to `orderStatus` : `IGLOBAL_ORDER_CANCELLED` and should be cancelled in your system.

Retrieve an order

주문 검색

엔드포인트

Order numbers

Order details

Retrieve an order API 엔드포인트 사용

1부: 도메인의 성공 페이지

2부: 예약된 작업 사용

초기 주문 상태

API test GUI

이 페이지가 도움이 되었나요?