Skip to main content

Create Closeout Catalog

POST 

/api/v2/closeout/catalog

Create a customer portal catalog that shows only products in the chosen lifecycle states (for example Discontinued) - kept up to date as products change state - or only a fixed list of products (product_ids), and optionally assign it to customers. When product_pricing_tier_id is sent, every assigned customer is also moved onto that pricing tier (typically a clearance price list), replacing their current tier.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body:

  • name (required, string, max 255)
  • lifecycle_states (optional, array, at least 1 when sent): existing lifecycle state keys. Default: ["discontinued"].
  • product_ids (optional, array of existing product ids, max 2000): make the catalog from exactly these products instead of lifecycle states. When sent, lifecycle_states is ignored and the catalog gets one include_product rule per product (a fixed list that does not follow state changes).
  • product_pricing_tier_id (optional, integer, existing pricing tier id): pricing tier to set on the assigned customers. Sending it together with customer_ids edits those customers, so it also needs the customers.update permission.
  • customer_ids (optional, array of existing customer ids, max 500): customers to assign the catalog to.

Response data: id and name of the new catalog, rules (rule_type, ref_key — one include_lifecycle_state rule per state, or one include_product rule per product), product_count (number of products in a fixed-list catalog; 0 for a lifecycle-state catalog), customers_assigned (number of customer ids sent).

Returns 422 when neither lifecycle_states nor product_ids is given ("Choose at least one lifecycle state."), when product_ids has more than 2,000 entries, or when a product no longer exists ("One of the selected products no longer exists.").

Requires a Bearer token with the products and customers read/write scopes and the products.manage_lifecycle and portal.manage permissions, because it creates a customer portal catalog and assigns customers to it. Changing the assigned customers' pricing tier also needs customers.update; without it the request returns 403.

Request​

Responses​

OK

Response Headers
    Content-Type