Skip to main content
GET
/
inventory
/
transfers
List transfers
curl --request GET \
  --url https://api.retrac.co/inventory/transfers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "fromLocationId": "<string>",
    "toLocationId": "<string>",
    "note": "<string>",
    "lines": [
      {
        "id": "<string>",
        "itemId": "<string>",
        "quantity": 123,
        "note": "<string>",
        "item": {
          "id": "<string>",
          "sku": "<string>",
          "description": "<string>"
        }
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "fromLocation": {
      "id": "<string>",
      "name": "<string>"
    },
    "toLocation": {
      "id": "<string>",
      "name": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer API key from Settings → API Keys. Use restricted keys (prefix retrac_) with the minimum scopes required.

Query Parameters

​
workspaceId
string
required

The ID of the workspace.

Example:

"ws_cluuwcv0r..."

​
projectSlug
string
deprecated

The slug of the project. This field is deprecated – use workspaceId instead.

​
fromLocationId
string
​
toLocationId
string
​
locationId
string
​
createdByUserId
string
​
status
enum<string>
Available options:
completed,
reverted
​
search
string
​
interval
enum<string>
Available options:
24h,
7d,
30d,
90d,
ytd,
1y,
all,
all_unfiltered
​
start
string<date-time>
​
end
string<date-time>
​
sortBy
enum<string>
default:createdAt
Available options:
createdAt
​
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 200

Response

A list of transfer orders

​
id
string
required
​
fromLocationId
string
required
​
toLocationId
string
required
​
status
enum<string>
required
Available options:
completed,
reverted
​
note
string | null
required
​
lines
object[]
required
​
createdAt
string<date-time>
required
​
fromLocation
object
​
toLocation
object