Skip to content
STOQDevelopers
Open STOQ

Create notifications export

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

POST
/back_in_stock/reports/notifications/export
curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/back_in_stock/reports/notifications/export \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "from": "string", "to": "string", "variant_id": "45000000001", "product_id": "78000000001", "channel": "string", "granularity": "string", "sort_by": "string", "direction": "string", "page": "string", "per_page": "string" }'

Async CSV export of the back-in-stock notifications time series.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
from
to
variant_id
product_id
channel
granularity
sort_by
direction
page
per_page

Example 

{
  "from": "string",
  "to": "string",
  "variant_id": "45000000001",
  "product_id": "78000000001",
  "channel": "string",
  "granularity": "string",
  "sort_by": "string",
  "direction": "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