Skip to content
STOQDevelopers
Open STOQ

Create customers export

BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog

POST
/preorders/reports/customers/export
curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/reports/customers/export \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "from": "string", "to": "string", "offer_id": "string", "offer_ids": [ "string" ], "product_id": "78000000001", "variant_id": "45000000001", "market_id": "gid://shopify/Market/12345", "currency": "string", "granularity": "string", "metrics": "string", "include_deposits": "string", "include_balances": "string", "page": "string", "per_page": "string" }'

Async CSV export of the customers report.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
from
to
offer_id
offer_ids
product_id
variant_id
market_id
currency
granularity
metrics
include_deposits
include_balances
page
per_page

Example 

{
  "from": "string",
  "to": "string",
  "offer_id": "string",
  "offer_ids": [
    "string"
  ],
  "product_id": "78000000001",
  "variant_id": "45000000001",
  "market_id": "gid://shopify/Market/12345",
  "currency": "string",
  "granularity": "string",
  "metrics": "string",
  "include_deposits": "string",
  "include_balances": "string",
  "page": "string",
  "per_page": "string"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success — the updated resource.

Media typeapplication/json
object

Example generated

{}

202

Section titled “202”

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object
job_id
string
status_url
string

Example 

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Section titled “401”

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Unauthorized"
  ]
}

422

Section titled “422”

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "name is required"
  ]
}

429

Section titled “429”

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Rate limit exceeded"
  ]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support