Skip to main content
POST
/
v1
/
exports
Create
curl --request POST \
  --url https://{defaultHost}/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "export": {
    "type": "orders",
    "email": "[email protected]"
  }
}
'
{
  "id": "ddcbb760-a86b-4d46-a51d-664330090cb3",
  "object": "export",
  "email": "[email protected]",
  "file_url": null,
  "record_count": 0,
  "status": "pending",
  "type": "orders",
  "created_at": 1767909700,
  "updated_at": 1767909700
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
export
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
type
string

The type of export – one of charges, coupons, customers, orders, prices, promotions, refunds, subscriptions.

​
email
string

The email where the export will be sent.

​
file_url
string | null

The URL for accessing the export file.

​
status
string

The status of the export – one of pending, processed, or sent.

​
record_count
number

The number of records that were exported.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.