Get fulfillments

GET

/preorders/reports/fulfillments

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/preorders/reports/fulfillments?range=string&group_by=variant&from=string&to=string&sort_by=string&direction=string&page=string&per_page=string' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

What is still owed to preorder customers: units sold, cancelled, fulfilled and outstanding (waiting, on hold, scheduled) per variant or product, as the dashboard’s fulfillment table.

Note: Units, not orders. Cancelled orders are left out; cancelled counts units cancelled from an order that is still open (a split order). sold = cancelled + fulfilled + outstanding, and outstanding = waiting + on_hold + scheduled. Statuses are as of now; the window selects when the units were sold. range=all_time is the dashboard’s All time. image_url is the variant’s stored image, else the product’s (null if none is stored).

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

range

null | string

Example

string

group_by

Allowed values: variant product

Example

variant

from

Example

string

to

Example

string

sort_by

Example

string

direction

Example

string

page

Example

string

per_page

Example

string

Responses

200

Success — the requested resource.

Media typeapplication/json

object

Example ^generated

{}

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

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

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"
  ]
}