Quickstart

This guide will get you all set up and ready to use the Vendor API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need in order to take full advantage of our powerful REST API.

Making your first API request

Below, you can see how to send a GET request to the Consignments endpoint to get a list of all your user's consignments. In the cURL example below, results are limited to 20 results, the default page length for each client.

In your API client (eg. Postman, Insomnia) or application platform of choice(React, Vue, etc) use the following input based on the type of action desired. More details can be found here. These require you to use the access token you generated from here.

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

HTTP/1.1 200 Ok
Content-Type: application/json

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

Common Workflows

Request details can be found in the individual resource sections of the documentation. Below are some common workflows you might want to implement using the Vendor API.

Creating a Consignment and Adding Items

• Follow the manual process (mentioned above) to create a new consignment and obtain its consignment_id
• Add items to the consignment using POST /v1/consignments/{consignment_id}/items (details)
• Monitor item status via webhooks (details)

Managing Inventory

• Update item quantities using PATCH /v1/items/{item_id} (for unapproved items, quantity can be increased and decreased, for approved items, quantity can only be decreased) (details)
• Track inventory changes through webhooks (details)

Handling Cancellations

• Vendor initiated cancellations - You send the HTTP request via POST /v1/cancellations endpoint (details)
• User initiated cancellations - Your webhook URL receives notifications about Return to Consignor (RTV) shipments (details)

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Vendor API:

• Get your access token
• Check out the Consignments endpoint
• Learn about rate limiting
• Set up your webhooks