Export Orders
Intent
Reads the orders without changing it.
When to call it
Call this after your application has received or stored the identifier for the orders.
Access boundary
Authorize the request with a token that carries orders:read.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Export orders as a CSV file.
Scopes: orders:read
GET
Export Orders
Authorizations
Query Parameters
Filter by organization ID. The organization ID.
Example:
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Filter by product ID. The product ID.
Response
Successful Response
The response is of type string.
Previous
Complete Order### Intent
Runs the complete order action.
### When to call it
Call this when your workflow reaches the point where it must complete order.
### Access boundary
Authorize the request with a token that carries `orders:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
### Operational notes
Finalize a draft order and synchronously attempt an off-session charge.
On success, the order transitions to `paid` and benefit grants fire
before the response returns. On failure (decline, missing payment method,
SCA challenge), the order stays in `draft` and a 4xx error is returned.
The request fails with 412 if the order is not in `draft` status.
**Scopes**: `orders:write`
Next
Export Orders