Skip to main content

Create Size Profile

POST 

/api/merchandising/size-profiles

Create a size profile with its size run. Apparel forecasts use it to split a style's buy across sizes.

Required scope: inventory:write

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

Body:

  • name (required, string, max 255)
  • scope_type (required): global, category, brand or product — what the size run applies to
  • scope_id (optional, integer ≥ 1): the category, brand or product id; omit for global
  • derived_from_window_days (optional, integer ≥ 1): the sales-history window the shares came from, if any
  • entries (required, array, at least 1): the size run
    • entries.*.size_label (required, string, max 255), e.g. "3T"
    • entries.*.share_pct (required, number 0–100): the size's share of the style's units
    • entries.*.sort_order (optional, integer ≥ 0): display order

The shares must total 100% (±0.5).

Response fields: id, name, scope_type, scope_id, scope_label (the category or brand name, or "SKU — product name"; null for global), derived_from_window_days, source (manual, derived, or derived_in_stock_corrected), entries (id, size_label, share_pct, sort_order), total_share_pct, created_at, updated_at.

Requires a Bearer token with the inventory read/write scope.

Request​

Responses​

Created

Response Headers
    Content-Type