Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
return_id
path parameter."true"
) on success, or an error object if not processable.Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
reason | string | (Optional) Reason for cancellation. |
return_id
path parameter (and optional reason
).Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
return_id
path parameter.line_item_id
values (comma-separated) to remove several items at once, but you must be prepared for the return to be closed after this call.Currently, only returns with refund outcomes allow for line items to be removed.Parameter | In | Type | Required | Description |
---|---|---|---|---|
return_id | path | integer | Yes | The unique identifier for the return. |
line_item_id | query | string | Yes | The ID(s) of the line item(s) to remove (comma-separated for multiple). |
return_id
path parameter and one or more line_item_id
query parameters.Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
reason | string | (Optional) Reason for cancellation. |
return_id
path parameter (and optional reason
).Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
return_id
path parameter.Parameter | In | Type | Required | Description |
---|---|---|---|---|
return_id | path | integer | Yes | The unique identifier for the return. |
Field | Type | Required | Description |
---|---|---|---|
note | string | Yes | The content of the note. |
return_id
path parameter is required.note
field.Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
return_id
path parameter.Parameter | Type | Description |
---|---|---|
return_id | integer | The unique identifier for the return. |
return_id
path parameter.