Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Grade Items

Grade Items

Grade the condition of return line items.

Required API key scope

  • Returns
post/dispositioning/grade

Request body

Example request

{
  "items": [
    {
      "line_item_id": 1,
      "description": "Grade A: No refurbishment needed",
      "return_processor": "warehouse-operator@example.com",
      "note": "This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item.\n",
      "images": [
        "https://example.com/image.jpg"
      ],
      "inspected_at": "2024-03-31T23:59:59+00:00"
    }
  ]
}

Response

Success

line_item_idinteger required

The unique identifier associated with the line item.

descriptionstring required

The description of the item's condition.

return_processorstring

The email address of the warehouse partner used to process returns.

notestring

Any additional notes on the item's condition.

imagesImage[]

An array of links to images of the item.

inspected_atstring date-time

The date and time at which the item was inspected, in RFC 3339 (ISO 8601) format with a UTC offset (DATE_ATOM), e.g. 2024-03-31T23:59:59+00:00.

Example response

[
  {
    "line_item_id": 1,
    "description": "Grade A: No refurbishment needed",
    "return_processor": "warehouse-operator@example.com",
    "note": "This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item.\n",
    "images": [
      "https://example.com/image.jpg"
    ],
    "inspected_at": "2024-03-31T23:59:59+00:00"
  }
]