---
title: "Get an order's fulfillment"
description: "Read an order's fulfillment: its Shopify fulfillment status and that of its preorder items, the hold note, split orders and each attributed offer's fulfillment handling."
url: https://docs.stoqapp.com/v2-reference/preorders-orders/get-an-orders-fulfillment/
api: "API v2 reference"
method: GET
path: "/preorders/orders/{id}/fulfillment"
---

# Get an order's fulfillment

`GET https://app.stoqapp.com/api/v2/external/preorders/orders/{id}/fulfillment`

Read an order's fulfillment: its Shopify fulfillment status and that of its preorder items, the hold note, split orders and each attributed offer's fulfillment handling.

**Note:** hold_reason_note is the note Shopify got with the hold, from the offer that caused it; change it on the offer.

## Path parameters

- `id` (string, required): The order, by STOQ's order ID or the Shopify order ID.

## Returns

- `fulfillment_status` (string): Shopify's fulfillment status for the whole order, lowercased, such as unfulfilled, partially_fulfilled, fulfilled, scheduled or on_hold.
- `preorder_fulfillment_status` (null): State of the fulfillment orders holding the preorder items, the most blocked one first: on_hold, scheduled or open (awaiting fulfillment). Null when nothing is left to fulfill or it hasn't been read from Shopify yet.
- `hold_reason_note` (null): The note Shopify received with the fulfillment hold, from the offer that caused it. Null when no offer on the order holds fulfillments.
- `holds_applied_at` (null): When STOQ last placed the order's fulfillments on hold (ISO 8601), or null.
- `shopify_split_order_ids` (array of anys): Shopify order gids of the separate orders STOQ moved preorder items to. Empty when the order wasn't split.
- `offers` (array of objects): The offers on the order and how each fulfills its items.
  - `offer_id` (string): The offer's id.
  - `handling` (string): How the offer fulfills preorder items: none, hold_all (holds every fulfillment), split_fulfillments (ships in-stock items first) or separate_orders (moves preorder items to their own order). One of: `none`, `hold_all`, `split_fulfillments`, `separate_orders`.

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/fulfillment" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "fulfillment_status": "string",
  "preorder_fulfillment_status": null,
  "hold_reason_note": null,
  "holds_applied_at": null,
  "shopify_split_order_ids": [
    null
  ],
  "offers": [
    {
      "offer_id": "string",
      "handling": "none"
    }
  ]
}
```

## 401

Missing or invalid `X-Auth-Token`.

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

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

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

## 429

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

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

