Export a whole list

curl --request POST \
  --url https://api.tassyir.io/apps/2026-10/bulk/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "status": "<string>",
    "createdSince": "<string>",
    "updatedSince": "<string>",
    "storeId": "<string>",
    "collectionId": "<string>",
    "active": true
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: {
      status: '<string>',
      createdSince: '<string>',
      updatedSince: '<string>',
      storeId: '<string>',
      collectionId: '<string>',
      active: true
    }
  })
};

fetch('https://api.tassyir.io/apps/2026-10/bulk/exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "<string>",
    "resource": "orders",
    "format": "jsonl",
    "status": "queued",
    "filters": {
      "status": "<string>",
      "createdSince": "2023-11-07T05:31:56Z",
      "updatedSince": "2023-11-07T05:31:56Z",
      "storeId": "<string>",
      "collectionId": "<string>",
      "active": true
    },
    "rowCount": 4503599627370495,
    "byteCount": 4503599627370495,
    "contactFields": true,
    "url": "<string>",
    "urlExpiresAt": "2023-11-07T05:31:56Z",
    "errorCode": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "APP_TOKEN_INVALID",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "PERMISSION_DENIED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 409,
  "detail": "<string>",
  "code": "BULK_EXPORT_IN_PROGRESS",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "PAYLOAD_TOO_LARGE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 422,
  "detail": "<string>",
  "code": "IDEMPOTENCY_KEY_REUSED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 429,
  "detail": "<string>",
  "code": "BULK_EXPORT_RATE_LIMITED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 460,
  "detail": "<string>",
  "code": "STORE_SCOPE_FORBIDDEN",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 500,
  "detail": "<string>",
  "code": "INTERNAL_ERROR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "API_BUSY",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

Bulk exports

Export a whole list

Starts an export of every row the list route of resource returns (with these filters, the list’s own), as one JSON Lines file: one resource per line, exactly as the list returns it, newest first. It runs in the background: read GET /bulk/exports/{id} or subscribe to bulk/finished; once completed, download the file from url (7 days). 1 export queued or running per installation, 5 asked for per business (every app together) in any hour. Send an Idempotency-Key: a retry then answers the same export.

The scope depends on the list exported: orders needs the read_orders scope (permission orders:read); products needs the read_products scope (permission products:read); customers needs the read_customers scope (permission customers:read).

POST

apps

2026-10

bulk

exports

Export a whole list

curl --request POST \
  --url https://api.tassyir.io/apps/2026-10/bulk/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "status": "<string>",
    "createdSince": "<string>",
    "updatedSince": "<string>",
    "storeId": "<string>",
    "collectionId": "<string>",
    "active": true
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: {
      status: '<string>',
      createdSince: '<string>',
      updatedSince: '<string>',
      storeId: '<string>',
      collectionId: '<string>',
      active: true
    }
  })
};

fetch('https://api.tassyir.io/apps/2026-10/bulk/exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "<string>",
    "resource": "orders",
    "format": "jsonl",
    "status": "queued",
    "filters": {
      "status": "<string>",
      "createdSince": "2023-11-07T05:31:56Z",
      "updatedSince": "2023-11-07T05:31:56Z",
      "storeId": "<string>",
      "collectionId": "<string>",
      "active": true
    },
    "rowCount": 4503599627370495,
    "byteCount": 4503599627370495,
    "contactFields": true,
    "url": "<string>",
    "urlExpiresAt": "2023-11-07T05:31:56Z",
    "errorCode": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "BAD_REQUEST",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "APP_TOKEN_INVALID",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "PERMISSION_DENIED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 409,
  "detail": "<string>",
  "code": "BULK_EXPORT_IN_PROGRESS",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "PAYLOAD_TOO_LARGE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 422,
  "detail": "<string>",
  "code": "IDEMPOTENCY_KEY_REUSED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 429,
  "detail": "<string>",
  "code": "BULK_EXPORT_RATE_LIMITED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 460,
  "detail": "<string>",
  "code": "STORE_SCOPE_FORBIDDEN",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 500,
  "detail": "<string>",
  "code": "INTERNAL_ERROR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "API_BUSY",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Headers

Idempotency-Key

string

Makes a write safe to retry: the same key with the same method, path, query and body within 24 hours answers the stored result (Idempotent-Replayed: true) without running the write again. Only a successful answer is stored, so a retry after a failure runs. A key reused for a different request is 422 IDEMPOTENCY_KEY_REUSED; one whose first request still runs is 409 IDEMPOTENCY_KEY_IN_USE.

Required string length: 1 - 255

Pattern: ^[\x21-\x7E]+$

Body

application/json

resource

enum<string>

required

Available options:

orders,

products,

customers

filters

object | null

Show child attributes

Response

Queued.

data

object

required

A bulk export of one Admin API list (API 2026-10).

Show child attributes