List your locations

​

Returns every location in your account, each with its name and optional display colour and icon.

Locations are labels for where you keep your stock. A line has at most one location. Set and clear a line's location through the inventory write endpoints (POST /v1/inventory, PATCH /v1/inventory/{inventoryId}, and the bulk endpoints).

Requires the inventory:read scope.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/inventory/locations
curl https://public-api.cardnexus.com/v1/inventory/locations \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

[
  {
    "name": "Trade binder",
    "color": "#22c55e",
    "icon": "star"
  }
]

Your locations.