Consignments

You will need a consignment ID to create new items via the API. Note that consignment creation is handled internally by The RealReal team and is not available through the API. If you don't have any consignments, please contact support to request one.

The consignment model

Properties

Name
id
Type
string
Description
Unique identifier for the consignment.
Name
status
Type
string
Description
Consignment status.
Name
created_at
Type
timestamp
Description
Timestamp of when the consignment was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the consignment was last updated.
Name
consignment_items_count
Type
integer
Description
Number of items in the consignment.

GET/v1/consignments

List all consignments

This endpoint allows you to retrieve a paginated list of all consignments belonging to a user. This will only return a non-empty response if the bearer token belongs to a vendor user. By default, a maximum of twenty (20) consignments are shown per page.

Optional attributes

Name
page_size
Type
integer
Description
Limit the number of consignments returned.
Name
after
Type
boolean
Description
Cursor for forward pagination.
Name
before
Type
boolean
Description
Cursor for backward pagination.

Request

GET

/v1/consignments

curl -G https://vendor.trr-apps.com/v1/consignments?page_size=20 \
-H "Authorization: Bearer {token}" \
-d page_size=10

Response

{
  "consignments": [
    {
      "id": 123,
      "status": "created",
      "created_at": "2025-04-21T10:15:30Z",
      "updated_at": "2025-04-21T10:15:30Z",
      "consignment_items_count": 10
    }
    ],
    "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "start_cursor": "MTIz",
    "end_cursor": "NDU2"
  }
}

GET/v1/consignments/{consignment_id}

Get a consignment

Retrieves the details of a specific consignment.

Required attributes

Name
consignment_id
Type
string
Description
The unique identifier of the consignment to retrieve.

Request

GET

/v1/consignments/{consignment_id}

curl https://vendor.trr-apps.com/v1/consignments/{consignment_id} \
  -H "Authorization: Bearer {token}"

Response

{
  "consignment": {
    "id": 123,
    "status": "string",
    "created_at": "string",
    "updated_at": "string",
    "consignment_items_count": 10
  }
}