POST
/
vendor
/
returns
/
{id}
/
dismiss-items
/
{action_id}
{
  "return": {
    "id": "<string>",
    "status": "canceled",
    "refund_amount": 123,
    "order_id": "<string>",
    "items": [
      {
        "id": "<string>",
        "quantity": 123,
        "received_quantity": 123,
        "damaged_quantity": 123,
        "reason_id": "<string>",
        "note": "<string>",
        "item_id": "<string>",
        "return_id": "<string>",
        "metadata": {}
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "canceled_at": "2023-11-07T05:31:56Z",
    "exchange_id": "<string>",
    "location_id": "<string>",
    "claim_id": "<string>",
    "order_version": 123,
    "display_id": 123,
    "no_notification": true,
    "received_at": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the return.

​
action_id
string
required

The ID of the damaged item's RECEIVE_DAMAGED_RETURN_ITEM action.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data.

Body

application/json

The return receival details.

Response

200 - application/json

OK

The response is of type object.