Skip to content

Get an order

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

GET/preorders/orders/{id}

Costs 1 rate-limit point · Rate limits

Read an order's full representation: payments, fulfillment, notifications, tags, attributed offers and line items.

Payments report only synced/recorded values (null when unknown). tags.tags is read live from Shopify and is null when Shopify can't be reached. Each section also has its own URL, e.g. /preorders/orders/:id/payments.

Also searched asshow preorder orderget orderlook up orderview preorder orderorder tagsorder labelswhat tags does the order have

Path parameters

  • idstringRequired

    The order, by STOQ's order ID or the Shopify order ID.

Returns

The order object.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/preorders/orders/{id}
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "id": "5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30",
  "type": "preorder",
  "shopify_order_id": "gid://shopify/Order/6123456789012",
  "name": "#1047",
  "customer": {
    "id": "9b3e5f71-24c8-4d0a-b6e2-81f4c7a9d3e5",
    "shopify_customer_id": "gid://shopify/Customer/7234567890123",
    "email": "jordan.lee@example.com",
    "phone": "+14155550142",
    "name": "Jordan Lee"
  },
  "total_price": "110.00",
  "currency": "USD",
  "financial_status": "partially_paid",
  "fulfillment_status": null,
  "payment_status": "balance_pending",
  "cancelled_at": null,
  "created_at": "2026-06-12T14:32:10Z",
  "updated_at": "2026-06-12T14:32:14Z",
  "payments": {
    "currency": "USD",
    "payment_status": "balance_pending",
    "financial_status": "partially_paid",
    "subtotal_price": "110.00",
    "tax_lines": [],
    "total_price": "110.00",
    "total_outstanding": "55.00",
    "amount_paid": "55.00",
    "deferred_amount": "55.00",
    "due_at": "2026-08-01T12:00:00Z",
    "overdue": false,
    "balance_collected": false,
    "balance_collected_at": null,
    "last_payment_attempt": null,
    "payment_attempts": []
  },
  "fulfillment": {
    "fulfillment_status": null,
    "preorder_fulfillment_status": "on_hold",
    "hold_reason_note": "Waiting on stock",
    "holds_applied_at": "2026-06-12T14:32:20Z",
    "shopify_split_order_ids": [],
    "offers": [
      {
        "offer_id": "73a74948-2b57-4cc3-971f-2b441828c977",
        "handling": "hold_all"
      }
    ]
  },
  "notifications": {
    "confirmation_email": {
      "sent_count": 1,
      "last_sent_at": "2026-06-12T14:32:16Z",
      "last_triggered_by": "automatic"
    },
    "confirmation_sms": {
      "sent_count": 0,
      "last_sent_at": null,
      "last_triggered_by": null
    },
    "shipping_update_email": {
      "sent_count": 0,
      "last_sent_at": null,
      "last_triggered_by": null
    }
  },
  "tags": {
    "tags": [
      "STOQ-preorder",
      "summer-drop"
    ],
    "configured_by_offers": [
      "STOQ-preorder"
    ]
  },
  "attributed_offers": [
    {
      "offer_id": "73a74948-2b57-4cc3-971f-2b441828c977",
      "offer_name": "Summer Sneaker Drop",
      "offer_internal_name": "summer-2026",
      "current_status": "live",
      "shipping": {
        "timeline": {
          "scope": "same",
          "show_shipping_text": true,
          "shipping_text": "Shipping: {{ date }}",
          "variant_shipping_text": "Ships in August"
        },
        "delivery_timing": "exact_time",
        "ships_at": "2026-08-01T16:00:00Z",
        "days_after_checkout": null,
        "fulfillment": {
          "handling": "hold_all",
          "hold_reason": "Waiting on stock",
          "separate_orders": {
            "grouping": "offer",
            "number_format": "suffix",
            "suffix": "SPLIT",
            "hold_fulfillments": false,
            "tag": "STOQ-split-order",
            "transaction_gateway": "Prepaid",
            "original_order_hold_tag": null,
            "original_order_split_tag": null
          }
        },
        "on_hold": {
          "release_schedule": "manual",
          "release_at": null,
          "require_payment": false
        }
      },
      "shopify_line_item_ids": [
        "gid://shopify/LineItem/15873209441589"
      ],
      "attribution_url": "/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977"
    }
  ],
  "line_items": [
    {
      "id": "c41d7e2a-8f35-4b9c-a1e6-7d20b3f9e584",
      "shopify_line_item_id": "gid://shopify/LineItem/15873209441589",
      "shopify_line_item_group_id": null,
      "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
      "title": "Classic Sneaker",
      "variant_title": "Blue / Medium",
      "fulfillment_status": null,
      "preorder_fulfillment_status": "on_hold",
      "is_preorder": true,
      "offer_id": "73a74948-2b57-4cc3-971f-2b441828c977",
      "quantity": 1,
      "line_total": "110.00"
    }
  ]
}