Skip to main content

Update RMA Dropship Credit

PUT 
/api/rmas/:rma/dropship-credit

Choose whether the SUGGESTED credit for a dropship-for-customer return includes the per-order dropship fee, and get the recalculated suggested breakdown. The choice is stored on the RMA and recorded in its activity log. Advisory only: no sales credit is created or changed — issue the credit note yourself at the suggested amount.

Required scope: returns:write

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

Authentication: Requires Bearer token. Scope: returns (write). Requires the returns.update permission.

Path parameters:

  • rma (integer, required): RMA ID.

Body:

  • refund_dropship_fee (boolean, required): true to include the order's dropship fee in the suggested credit, false to leave it out.

Response data:

  • goods (number): value of the RMA's expected lines at the sales order line prices.
  • restocking_fee_percent (number): the retailer's restocking fee percentage from its dropship terms.
  • restocking_fee (number): goods x restocking_fee_percent / 100, rounded to 2 decimals.
  • refund_dropship_fee (boolean): whether the suggested credit includes the per-order dropship fee charged on the sales order. Off by default.
  • dropship_fee_refund (number): the dropship fee included in the suggestion (0 when refund_dropship_fee is false).
  • net_credit (number): goods - restocking_fee + dropship_fee_refund — the suggested credit amount (not applied to any sales credit).

Errors: 422 when refund_dropship_fee is missing or not a boolean, or when the RMA is not for a dropship-for-customer order (error on rma); 403 without the returns.update permission; 404 when the RMA does not exist.

Request​

Responses​

OK

Response Headers
    Content-Type