> 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/planned_inventory.md).

# /planned\_inventory

## Sync planned inventory

> Reports inbound stock by SKU so Purple Dot creates and updates Waitlists to match. Returns the affected Waitlists.

```json
{"openapi":"3.1.0","info":{"title":"Purple Dot Private API","version":"v1"},"tags":[{"name":"/planned_inventory"}],"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":{"Waitlist":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","description":"When the Waitlist was created."},"updated_at":{"type":"string","format":"date-time","description":"When the Waitlist was last updated."},"earliest_ship_date":{"type":"string","format":"date-time","description":"The earliest ship date."},"latest_ship_date":{"type":"string","format":"date-time","description":"The latest ship date."},"state":{"type":"string","enum":["Live","Paused","Closed","Scheduled","Draft"],"description":"The Waitlist’s state."},"launch_date":{"type":["string","null"]},"scheduled_pause_date":{"type":["string","null"]},"labels":{"type":"array","items":{"type":"string"}},"availability":{"type":"object","properties":{"product":{"type":"object","properties":{"product_id":{"type":"string"},"buy_size":{"type":["number","null"]},"committed":{"type":"number","description":"Units sold."},"available":{"type":["number","null"],"description":"Units still available. `null` for variant-level figures a per-product Waitlist does not allocate."}},"required":["product_id","buy_size","committed","available"]},"variants":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"sku":{"type":["string","null"]},"buy_size":{"type":["number","null"]},"committed":{"type":"number","description":"Units sold."},"available":{"type":["number","null"],"description":"Units still available. `null` for variant-level figures a per-product Waitlist does not allocate."}},"required":["variant_id","sku","buy_size","committed","available"]}}},"required":["product","variants"]}},"required":["id","created_at","updated_at","earliest_ship_date","latest_ship_date","state","launch_date","scheduled_pause_date","labels","availability"]},"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":{"/planned_inventory":{"post":{"tags":["/planned_inventory"],"summary":"Sync planned inventory","description":"Reports inbound stock by SKU so Purple Dot creates and updates Waitlists to match. Returns the affected Waitlists.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"object","properties":{"sku":{"type":"string","minLength":1}},"required":["sku"]},{"type":"object","properties":{"barcode":{"type":"string","minLength":1}},"required":["barcode"]},{"type":"object","properties":{"shopifyVariantGid":{"type":"string","minLength":1}},"required":["shopifyVariantGid"]}]},"source_uri":{"type":"string","minLength":1},"labels":{"type":"array","items":{"type":"string"}},"quantity_expected":{"type":"integer","minimum":0},"quantity_arrived":{"type":"integer","minimum":0},"date_expected":{"type":"string"},"inventory_location":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["name"]},"name":{"type":"string","minLength":1}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["shopifyInventoryLocationGid"]},"shopifyInventoryLocationGid":{"type":"string","minLength":1}},"required":["type","shopifyInventoryLocationGid"]},{"type":"null"}]}},"required":["id","source_uri","labels","quantity_expected","quantity_arrived","date_expected","inventory_location"]},"minItems":1}},"required":["items"]}}}},"responses":{"200":{"description":"The affected Waitlists.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"result":{"type":"string","enum":["success"]}},"required":["result"]},"data":{"type":"object","properties":{"waitlists":{"type":"array","items":{"$ref":"#/components/schemas/Waitlist"}}},"required":["waitlists"]}},"required":["meta","data"]}}}},"400":{"description":"Missing access token. Invalid or missing fields.","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"}}}},"404":{"description":"An item could not be matched to a product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
