List all locations

curl --request GET \
  --url https://app.supercycle.com/api/v1/locations \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "shopifyId": 123,
      "name": "<string>"
    }
  ],
  "nextPage": "<unknown>"
}

GET

locations

List all locations

curl --request GET \
  --url https://app.supercycle.com/api/v1/locations \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "shopifyId": 123,
      "name": "<string>"
    }
  ],
  "nextPage": "<unknown>"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

limit

integer<int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x <= 100

page

string

Cursor token to fetch next page of results.

200 - application/json

A paged array of locations

data

object[]

Show child attributes

data.shopifyId

integer<int64>

required

Numeric ID of the Shopify location.

data.name

string

required

Name of the location.

null | string

⌘I