Orders

Orders

Create service orders and read their results.

Modified at Apr 28, 2026, 05:38 AM UTC

Orders let your integration request a service by code and receive a structured result. Use this section for service discovery, request payloads, order creation, order status, and order history.

Service detail includes the service code, price, item limits, and accepted data format for POST /api/order.

Result States

StatusMeaning
pendingThe order was accepted and is waiting for completion.
successAll submitted items succeeded.
partialSome submitted items succeeded and some failed.
failedThe order did not complete successfully.

For asynchronous updates, configure order webhooks and keep order detail as the fallback read path.