warehouse

Requires an authenticated session.

Returns one warehouse. Fails if it does not exist or has been deleted.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Warehouse($id: ID!) {
  warehouse(id: $id) {
    id
    code
    taxRegistrationNumber
    name
    status
    type
    address {
      postalCode
      city
      country
      latitude
      longitude
      state
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Warehouse($id: ID!) {\n  warehouse(id: $id) {\n    id\n    code\n    taxRegistrationNumber\n    name\n    status\n    type\n    address {\n      postalCode\n      city\n      country\n      latitude\n      longitude\n      state\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "warehouse": {
      "id": "id",
      "code": "string",
      "taxRegistrationNumber": "string",
      "name": "string",
      "status": "ACTIVE",
      "type": "string",
      "address": {
        "postalCode": "string",
        "city": "string",
        "country": "string",
        "latitude": 0,
        "longitude": 0,
        "state": "string"
      }
    }
  }
}

warehouse(
  id: ID!
): Warehouse!

Arguments

warehouse.id ● ID! non-null scalar

The ID of the warehouse.

Type

Warehouse object

A location where stock is held.