Skip to main content

Create RMA

POST 
/api/rmas

Create a new RMA for a fulfilled sales order.

Required scope: returns:write

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

Authentication: Requires Bearer token.

Validation rules:

  • sales_order_id: required, must be an order that has been fulfilled (unless sales_credit_id is provided)
  • warehouse_id: required
  • status: optional, allowed values: draft, approved
  • notes: optional, max 1000 chars
  • sales_credit_id: optional, if provided skips fulfillment and quantity validation
  • rma_lines: required array with at least 1 line
    • product_id: required
    • expected_quantity: required, min 1, cannot exceed fulfilled minus already RMA'd quantity
    • sales_order_line_id: optional, must belong to the specified sales order and match the product
    • return_reason_id: optional
    • notes: optional, max 500 chars

Requires permission: returns.create

Request​

Responses​

Created

Response Headers
    Content-Type