Create an export job

POST/api/exports

Queues a background job that exports one object definition to CSV or XLSX.

Request Body

application/json

Request payload for Create an export job.

TypeScript Definitions

Use the request body type in TypeScript.

objectHandle*string

Object handle to export.

Example"customers"

format*string

File format generated for the export.

Example"csv"

Value in

"csv"
"xlsx"

limit?|||||

Maximum number of results to return.

updatedSince?||

updated since.

Response Body

`application/json`

curl -X POST "https://example.com/api/exports" \  -H "Content-Type: application/json" \  -d '{    "objectHandle": "customers",    "format": "csv"  }'

{  "id": "exp_123",  "status": "queued"}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`