API reference Exports Start an export

Start an export

POST methodhttps://api.anyshop.io/v1/exports

Prepared once the response is sent: poll the export until its status is ready, then download it. One export is prepared at a time, 5 a day per store. Unsold keys are never available through the API: export them from the dashboard, with a two-factor code and a password.

Scope exports:write
Idempotent with Idempotency-Key
Works while the store is suspended

Body

application/json0 required, 1 optional

partsarray of enums Default: products, orders, customers, licenses, coupons and settings. Unsold keys are not available through the API.productsorderscustomerslicensescouponssettingsfilesAt least 1 items

Headers

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

Example

as_live_ or as_test_

curl -X POST https://api.anyshop.io/v1/exports \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "object": "data_export",
  "id": "dexp_01m3rw4h6j8l0n2p4r6t8v0x2z",
  "livemode": false,
  "status": "preparing",
  "parts": [
    "products"
  ],
  "counts": {},
  "size_bytes": null,
  "failure": null,
  "created_at": "2026-10-02T14:21:07.000Z",
  "ready_at": "2026-10-02T14:21:07.000Z",
  "expires_at": "2026-10-02T14:21:07.000Z",
  "download_url": null,
  "download_url_expires_at": "2026-10-02T14:21:07.000Z"
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The data_export object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After