Skip to main content

Purple Dot

📄️Preview Purple Dot Connection

Starts a dry-run in the background. It builds the planned inventory the first push would send, reads every held pre-order from Purple Dot with the purchase order line that would cover it (or shelf stock, or nothing, or no matching product), and the release budget per SKU. Nothing is sent to Purple Dot and no SKU.io demand is created; only `GET /pre-orders` is read. Replaces the previous dry-run. The connection's `preview` block (`state`: none / running / succeeded / stale / failed, `tracked_job_log_id`, `succeeded_at`) records the result; Go live requires `succeeded` for the current settings. Returns the id of the background job to follow; read the rows with List Purple Dot Preview Rows when it completes. 422 `no_token` when no access token is stored. Requires integrations.sync.

📄️List Purple Dot Preview Rows

Lists the rows of the latest dry-run, oldest first. The `payload` depends on `kind`: `planned_inventory` (product, purchase_order, source_label, quantity_expected net of backorders, quantity_arrived, date_expected, location_name), `preorder` (reference, customer_name, sku, quantity, coverage = covered | shelf | uncovered | unmapped, purchase_order with eta; a pre-order line split across purchase orders gives one row per part) or `release` (sku, product, held_units, available_units). Rows are dropped when the connection goes live. Requires integrations.show.

📄️Go Live with Purple Dot

Puts a pending (or paused) connection live: the dry-run rows are dropped and the initial sync starts in the background — every held pre-order is imported as backorder demand, then planned inventory is pushed, then every release budget. Returns the id of the background job and the updated connection. 422 `already_live` when the connection is live; `not_allowed` when it has no access token or no supply warehouse, or — for a connection that never went live — when no dry-run has succeeded for its current settings (the dry-run is still running, failed, or the supply / matching / budget settings changed since; the message says which). The connection's `preview.state` shows the same check. Requires integrations.sync.

📄️List Purple Dot Planned Inventory

The planned inventory SKU.io last sent to Purple Dot, one row per supply source: a purchase order line, an inbound shipment carrying it, or an inbound warehouse transfer line into a supply warehouse. Quantities and `date_expected` are what Purple Dot last accepted; `pending_date_expected` and `eta_review_id` describe an ETA slip waiting for review. `netted_backorder_units` are units held back for SKU.io's own backorders. `status` pending = Purple Dot did not acknowledge the last push (5xx, 429 or network); the item is retried automatically with backoff using the values computed at retry time, `last_error` shows the failure and `next_retry_at` when it is next tried (null for any other status). error = Purple Dot rejected the item (4xx); it is not retried automatically.

📄️Push Purple Dot Planned Inventory

Starts a background push of planned inventory to Purple Dot for the given products, or every product when `product_ids` is empty. Items are re-sent even when unchanged since the last push (the automatic pushes skip those); ETA slips over the connection's review threshold are held for review instead of being pushed. Returns the id of the background job to follow. 422 `not_live` when the connection is not live, `push_disabled` when the planned-inventory push is off.

📄️List Purple Dot Waitlists

Purple Dot Waitlists mirrored into SKU.io, compared with SKU.io inbound. `cap`, `committed` and `available` sum the Waitlist's variants. `sku_io_inbound` is the open supply last sent as planned inventory for the Waitlist's products arriving by its latest ship date; `is_over_committed` is true when the cap is larger (pre-selling more than is coming). `is_managed` Waitlists carry the `sku-io` label and can be paused, resumed or closed; others link to the Purple Dot Merchant Portal (`merchant_portal_url`). `state` is OPEN, SCHEDULED, PAUSED, DRAFT or CLOSED.

📄️List Purple Dot Release Budgets

Per external Purple Dot SKU (several Purple Dot SKUs can map to one SKU.io product; each pre-order line's allocated units count toward its own SKU): the number of held pre-order units Purple Dot may export now as SKU.io computes it (`computed_units`), the value Purple Dot last acknowledged (`available_units`, null before the first acknowledged push), and the held and allocated units behind it. In allocation release mode the budget is the units SKU.io has set aside from stock in the supply warehouses; in shelf mode it is their sellable on-hand. A bundle's budget is the minimum across its components.

📄️Get Refund Preview

Returns what can be refunded through Purple Dot on an exported order: each Purple Dot line with its unit price, the quantity on the given return (received, or expected while nothing is received, less what was already refunded for that return) and the most that can still be refunded, plus the shipping still refundable (0 once shipping was refunded), currency and the connection's refund mode (`ask`, `auto`, `off`). A bundle is ONE line (`is_bundle: true`) keyed by its first component line and counted in purchased bundles; its unit price is the bundle's price.

📄️Get Purple Dot Summary

Returns the dashboard numbers of a Purple Dot connection: held pre-orders, units and shoppers; units covered by open purchase orders, uncovered, allocated and waiting for Purple Dot to export, and on unmapped variants; pre-orders exported, cancelled and refunded in the last 30 days; per purchase order, the units pre-sold next to its open quantity and other backorders; the counts that need attention (pending ETA reviews, exported orders unmatched for over an hour, unmapped variants, over-committed Waitlists, failed refunds, errors in the last 24 hours); and the last release-budget push and reconcile. Dates are Y-m-d in the account timezone; times are ISO 8601 UTC. Requires integrations.show.

📄️List Purple Dot Activity

Lists the connection's activity log, newest first: planned-inventory and release-budget pushes, pre-order polls, export handoffs, cancellations, refunds, reconciles, webhooks, connection changes and errors. `response_code` is Purple Dot's HTTP status when the row came from a call; `is_error` marks error rows and answers of 400 or more. `detail` carries the payload summary and Purple Dot's error text. Rows are kept for 90 days. Requires integrations.show. Search with `filter[search]`, narrowed by `search_columns` (id, reference, sku, summary) and `search_strict_columns`; `filter[id.<operator>]` filters on the row id.

📄️Reconcile Purple Dot

Starts a reconcile in the background (it also runs nightly at 03:00 account time): for each SKU with held pre-orders it compares Purple Dot's open pre-order units with SKU.io's and re-reads that SKU's pre-orders when they differ; it checks that no purchase order line covers more backorders than it still has open; then it re-pushes every release budget and the planned inventory. Differences appear in the activity log and the summary. Returns the id of the background job to follow. 422 `not_live` when the connection is not live. Requires integrations.sync.