List orders

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

GET/preorders/orders

Costs 1 rate-limit point · Rate limits

List preorder orders in this shop, paginated. search matches order number/name, customer name, email, a Shopify order id (10+ digits), an order gid (gid://shopify/Order/<id>), or a Shopify admin order URL.

Filters match the Reports > Preorders > Orders filters and combine with AND. Comma-separated: financial_status and fulfillment_status (Shopify values), preorder_fulfillment_status (on_hold, scheduled, open), cancelled_status (cancelled or not_cancelled), payment_collection_status (latest collection attempt: failed, success, unknown), offer_id (our offer ids, any state), shopify_variant_id and shopify_product_id (gids; a product means its variants). vendors is an array of vendor names, matched on the preorder lines only. A bare from/to date is that whole day in the shop's time zone.

Also searched aslist preorder ordersshow all preorder orderspreorder orderslist orders

Query parameters

searchstring
financial_statusstring
fulfillment_statusstring
preorder_fulfillment_statusstring
cancelled_statusstring
payment_collection_statusstring
offer_idstring
shopify_variant_idstring
shopify_product_idstring
vendorsstring
customer_idstring
fromstring
tostring
pagestring
per_pagestring

Errors

401

Missing or invalid X-Auth-Token.

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

Example

GET/preorders/orders

curl "https://app.stoqapp.com/api/v2/external/preorders/orders" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/orders", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/preorders/orders",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/preorders/orders")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

GET/preorders/orders

curl "https://app.stoqapp.com/api/v2/external/preorders/orders?shopify_variant_id=45000000001&shopify_product_id=78000000001" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/orders?shopify_variant_id=45000000001&shopify_product_id=78000000001", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/preorders/orders?shopify_variant_id=45000000001&shopify_product_id=78000000001",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/preorders/orders?shopify_variant_id=45000000001&shopify_product_id=78000000001")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}