Skip to main content
GET
/
wms
/
returns
Get All Returns
curl --request GET \
  --url https://production.trackstarhq.com/wms/returns \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
import requests

url = "https://production.trackstarhq.com/wms/returns"

headers = {
"x-trackstar-api-key": "<x-trackstar-api-key>",
"x-trackstar-access-token": "<x-trackstar-access-token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'x-trackstar-access-token': '<x-trackstar-access-token>'
}
};

fetch('https://production.trackstarhq.com/wms/returns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://production.trackstarhq.com/wms/returns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-trackstar-access-token: <x-trackstar-access-token>",
"x-trackstar-api-key: <x-trackstar-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://production.trackstarhq.com/wms/returns"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")
req.Header.Add("x-trackstar-access-token", "<x-trackstar-access-token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://production.trackstarhq.com/wms/returns")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.header("x-trackstar-access-token", "<x-trackstar-access-token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://production.trackstarhq.com/wms/returns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'
request["x-trackstar-access-token"] = '<x-trackstar-access-token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "return_id",
      "warehouse_customer_id": "warehouse_customer_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "status": "open",
      "raw_status": "raw_status",
      "order_id": "order_id",
      "notes": [
        "This is a note"
      ],
      "line_items": [
        {
          "inventory_item_id": "item_id",
          "sku": "sku",
          "expected_quantity": 1,
          "received_quantity": 1,
          "restocked_quantity": 1,
          "return_reason": "Too Small"
        }
      ],
      "shipments": [
        {
          "tracking_number": "tracking_number",
          "shipped_date": "2023-02-03T02:04:06Z",
          "arrived_date": "2023-02-03T02:04:06Z",
          "warehouse_id": "warehouse_id",
          "carrier_id": "carrier_id",
          "carrier_name": "carrier_name",
          "scac": "FDXG",
          "shipping_cost": 1.23,
          "measurements": {
            "length": 1,
            "width": 1,
            "height": 1,
            "unit": "in",
            "weight": 1,
            "weight_unit": "lb"
          },
          "line_items": [
            {
              "inventory_item_id": "item_id",
              "sku": "sku",
              "quantity": 4,
              "receiving_details": [
                {
                  "quantity": 1,
                  "condition": "good",
                  "disposition": "restocked"
                },
                {
                  "quantity": 1,
                  "condition": "damaged",
                  "disposition": "scrapped"
                }
              ]
            }
          ]
        }
      ],
      "external_system_url": "https://example.com/return/123",
      "trackstar_tags": [
        "tag1",
        "tag2",
        {
          "tag3": "value3"
        }
      ],
      "additional_fields": {
        "key": "value"
      },
      "trackstar_created_date": "2023-11-07T05:31:56Z",
      "trackstar_updated_date": "2023-11-07T05:31:56Z"
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}
{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Query Parameters

page_token
string | null

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

Example:

"page_token"

limit
integer

The maximum number of items to return. The default is 1000.

Required range: 1 <= x <= 1000
Example:

1000

ids
WmsReturnIdsQueryParam · object
created_date
WmsReturnCreated_DateQueryParam · object

Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.

updated_date
WmsReturnUpdated_DateQueryParam · object

Same syntax as created_date.

trackstar_created_date
WmsReturnTrackstar_Created_DateQueryParam · object

Same syntax as created_date.

trackstar_updated_date
WmsReturnTrackstar_Updated_DateQueryParam · object

Same syntax as created_date.

trackstar_tags
WmsReturnTrackstar_Tags_FlatQueryParam · object

Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings.

status
WmsReturnStatusQueryParam · object

The status of the return. See the return information [blocked] for more details.

warehouse_customer_id
WmsReturnWarehouse_Customer_IdQueryParam · object

The ID of the customer associated with the resource

order_id
WmsReturnOrder_IdQueryParam · object

The ID of the order that the return is associated with.

Response

Successful response

data
WmsReturnApiItemSchema · object[]
required
next_token
string | null
required

See pagination for more details.

Example:

"next_token"

total_count
integer
required

The number of items returned.

Example:

1