List warehouses

The list holds the warehouses of the team and the shared ones. A shared warehouse is read only.

get/api/v1/sa/inventory/warehouses

Request

Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
URL: https://app.sellerassistant.app/api/v1/sa/inventory/warehouses
Auth: one of:
- API key in query parameter api_key
- API key in header X-Api-Key

Query parameters

searchstring

A term the list looks for. Each list names the columns it reads.

sortstring

Example:-created_at

The column to order by: created_at, name, location, status. A minus sign in front of the name orders from the highest down. Without a sort the order is -created_at. Another name answers 400. The primary warehouse comes first whatever the column.

pageinteger

Example:1

The page to read. It starts at 1.

per_pageinteger

Example:25

The rows a page carries. The maximum is 200.

Response

One page of the warehouses

Example response

{
  "data": [
    {
      "id": 3,
      "name": "East Coast Prep",
      "website": "eastcoastprep.com",
      "status": "active"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 137,
      "last_page": 6
    },
    "trial_limit": {
      "max_rows": 25,
      "total": 137,
      "code": "trial_list_limited",
      "message": "The trial shows only the first rows of a list. Subscribe to see all rows.",
      "subscribe_url": "https://app.sellerassistant.app/subscription"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.