Skip to main content

Create Disposition Policy

POST 
/api/return-disposition-policies

Create a new return disposition policy.

Authentication: Requires Bearer token.

Fields:

  • name (string, required, max 255) — human-readable policy name
  • action (string, required) — disposition to apply when this policy matches. One of: added_to_stock, discarded, new_blemished_sku
  • is_active (boolean, optional, default true) — only active policies are evaluated at resolve time
  • priority (integer, optional, min 0) — lower numbers are evaluated first; ties broken by id
  • match_product_id (integer, optional, nullable) — restrict to a single product
  • match_product_category_id (integer, optional, nullable) — restrict to a product category (matches the product's category and any ancestor category)
  • match_return_reason_id (integer, optional, nullable) — restrict to a return reason
  • match_warehouse_id (integer, optional, nullable) — restrict to a warehouse
  • match_condition_grade (string, optional, nullable) — restrict to a condition grade. One of: A, B, C, unsellable
  • blemished_condition (string, optional, nullable, max 255) — condition note applied when action is new_blemished_sku
Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Request​

Responses​

Created

Response Headers
    Content-Type