v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Return Actions

Remove Line Items

Remove line items from a return and process the return.

Currently, only line items tied to a refund or store credit outcome allow for line items to be removed programmatically.

Required API key scope

  • Returns
post/warehouse/return/{id}/remove

Path parameters

idinteger required

The unique identifier associated with the return.

Query parameters

line_item_idstring required

The ID of the line item to remove. Optionally, you can include more than one using comma separated values.

Response

Success

boolean required

The value returned when the return action succeeds.

OR

Example response

true