> For the complete documentation index, see [llms.txt](https://docs.getpurpledot.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/fulfillment-orders.md).

# /fulfillment-orders

## List fulfillment orders

> Lists fulfillment orders across pre-orders that are now fulfillable. Results are paginated.

```json
{"openapi":"3.1.0","info":{"title":"Purple Dot Private API","version":"v1"},"tags":[{"name":"/fulfillment-orders"}],"servers":[{"url":"https://www.purpledotprice.com/admin/api/v1","description":"Production"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"apiKey","in":"header","name":"X-Purple-Dot-Access-Token","description":"Your store's private access token. It can also be sent as `Authorization: Bearer <token>`."}},"schemas":{"FulfillmentOrder":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Purple Dot ID."},"status":{"type":"string","description":"`UNFULFILLED` (waiting to be fulfilled), `FULFILLED` (all items fulfilled) or `VOIDED` (canceled)."},"created_at":{"type":"string","format":"date-time","description":"When Purple Dot was told the line items are ready to fulfill."},"purchased_at":{"type":"string","format":"date-time","description":"`created_at` of the originating pre-order."},"reference":{"type":"string","description":"The pre-order reference followed by the fulfillment order index."},"platform":{"type":"string","enum":["SHOPIFY","HEADLESS"]},"external_order_id":{"type":"string","description":"The order's ID in your e-commerce platform."},"shopify_order_id":{"type":"integer"},"shopify_fulfillment_order_id":{"type":"integer"},"currency":{"type":"string","description":"Presentment currency."},"customer":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"external_id":{"type":["integer","null"],"description":"The Shopify customer ID, if known."},"tags":{"type":"array","items":{"type":"string"},"description":"Shopify customer tags."},"default_address":{"type":["object","null"],"properties":{"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"province_code":{"type":["string","null"],"description":"ISO 3166 code for the second-level subdivision."},"country":{"type":["string","null"],"description":"English country name."},"country_code":{"type":["string","null"],"description":"ISO 3166 country code."},"phone":{"type":["string","null"]}},"required":["first_name","last_name","address1","address2","city","postal_code","province_code","country","country_code","phone"]}},"required":["email","first_name","last_name","external_id","tags","default_address"]},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Purple Dot ID."},"name":{"type":["string","null"],"description":"The variant name."},"product_id":{"type":["string","null"]},"variant_id":{"type":["string","null"]},"sku":{"type":["string","null"]},"quantity":{"type":"integer"},"price":{"type":"number","description":"Unit price before taxes and discounts."},"total":{"type":"number","description":"Line item cost after taxes and discounts."},"total_discount":{"type":"number"},"discount_allocations":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number"},"discount_application_index":{"type":"integer"}},"required":["amount","discount_application_index"]}},"taxable":{"type":"boolean"},"tax_lines":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"rate":{"type":["number","null"]},"title":{"type":"string"},"inclusive":{"type":"boolean"}},"required":["price","rate","title","inclusive"]}},"product_url":{"type":["string","null"]},"image_url":{"type":["string","null"]},"shopify_fulfillment_order_line_item_id":{"type":"integer"},"shopify_line_item_id":{"type":"integer"}},"required":["id","name","product_id","variant_id","sku","quantity","price","total","total_discount","discount_allocations","taxable","tax_lines","product_url","image_url","shopify_fulfillment_order_line_item_id","shopify_line_item_id"]}},"shipping_address":{"type":["object","null"],"properties":{"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"province_code":{"type":["string","null"],"description":"ISO 3166 code for the second-level subdivision."},"country":{"type":["string","null"],"description":"English country name."},"country_code":{"type":["string","null"],"description":"ISO 3166 country code."},"phone":{"type":["string","null"]}},"required":["first_name","last_name","address1","address2","city","postal_code","province_code","country","country_code","phone"]},"shipping_lines":{"type":"array","items":{"type":"object","properties":{"code":{"type":["string","null"],"description":"Carrier code."},"title":{"type":"string","description":"User-facing rate name."},"price":{"type":"number","description":"Unit cost before taxes and discounts."},"total":{"type":"number","description":"Cost after taxes and discounts."},"tax_lines":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"rate":{"type":["number","null"]},"title":{"type":"string"}},"required":["price","rate","title"]}}},"required":["code","title","price","total","tax_lines"]}},"tax_included":{"type":"boolean","description":"Whether tax is included in listed prices."},"total_shipping":{"type":"number"},"total_tax":{"type":"number"},"total_discounts":{"type":"number"},"subtotal_price":{"type":"number","description":"Line item total before taxes and shipping."},"total_price":{"type":"number"},"note":{"type":"string","description":"Optional notes from the Shopify order."}},"required":["id","status","created_at","purchased_at","reference","platform","external_order_id","shopify_order_id","shopify_fulfillment_order_id","currency","customer","line_items","shipping_address","shipping_lines","tax_included","total_shipping","total_tax","total_discounts","subtotal_price","total_price"]},"AuthErrorResponse":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]},"ErrorResponse":{"type":"object","properties":{"meta":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable message."},"errorData":{"type":"object","additionalProperties":{},"description":"Structured detail about the error."}},"required":["error","errorData"]},"data":{"type":"object","properties":{}}},"required":["meta","data"]}}},"paths":{"/fulfillment-orders":{"get":{"tags":["/fulfillment-orders"],"summary":"List fulfillment orders","description":"Lists fulfillment orders across pre-orders that are now fulfillable. Results are paginated.","parameters":[{"schema":{"type":"integer","default":50,"description":"Number of fulfillment orders to return, from 1 to 250. Defaults to 50."},"required":false,"description":"Number of fulfillment orders to return, from 1 to 250. Defaults to 50.","name":"limit","in":"query"},{"schema":{"type":"string","description":"Fulfillment orders created at or after this time."},"required":false,"description":"Fulfillment orders created at or after this time.","name":"created_at_min","in":"query"},{"schema":{"type":"string","description":"Returns fulfillment orders after the given fulfillment order ID."},"required":false,"description":"Returns fulfillment orders after the given fulfillment order ID.","name":"starting_after","in":"query"},{"schema":{"type":"string","description":"Comma-separated, URL-encoded Purple Dot fulfillment order references."},"required":false,"description":"Comma-separated, URL-encoded Purple Dot fulfillment order references.","name":"references","in":"query"}],"responses":{"200":{"description":"A page of fulfillment orders.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"result":{"type":"string","enum":["success"]}},"required":["result"]},"data":{"type":"object","properties":{"fulfillment_orders":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentOrder"}},"has_more":{"type":"boolean","description":"Whether more results are available after this page."},"starting_after":{"type":["string","null"],"format":"uuid","description":"ID of the last item returned. Pass it as `starting_after`."}},"required":["fulfillment_orders","has_more","starting_after"]}},"required":["meta","data"]}}}},"400":{"description":"Missing access token. Invalid request.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AuthErrorResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]}}}},"401":{"description":"Access token not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthErrorResponse"}}}}}}}}}
```
