Warehouse

The warehouse resource.

Basehttps://rest.carbon.ms/warehouse

GET/warehouse

List warehouses

Retrieve a paginated list of warehouses. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/warehouse

curl --request GET \
  --url 'https://rest.carbon.ms/warehouse?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "locationId": "xyz789",
    "requiresPick": true,
    "requiresPutAway": true,
    "requiresBin": true,
    "requiresReceive": true,
    "requiresShipment": true
  }
]

GET/warehouse

Retrieve a warehouse

Fetch a single warehouse by filtering on `id`.

Query parameters

idstring

Match on the warehouse's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/warehouse

curl --request GET \
  --url 'https://rest.carbon.ms/warehouse?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "locationId": "xyz789",
  "requiresPick": true,
  "requiresPutAway": true,
  "requiresBin": true,
  "requiresReceive": true,
  "requiresShipment": true
}

POST/warehouse

Create a warehouse

Create a new warehouse.

Body parameters

namestringrequired

locationIdstringrequired

References location.id

requiresPickbooleanrequired

requiresPutAwaybooleanrequired

requiresBinbooleanrequired

requiresReceivebooleanrequired

requiresShipmentbooleanrequired

activebooleanrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/warehouse

curl --request POST \
  --url https://rest.carbon.ms/warehouse \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","locationId":"xyz789","requiresPick":true,"requiresPutAway":true,"requiresBin":true,"requiresReceive":true,"requiresShipment":true,"active":true,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "locationId": "xyz789",
  "requiresPick": true,
  "requiresPutAway": true,
  "requiresBin": true,
  "requiresReceive": true,
  "requiresShipment": true
}

PATCH/warehouse

Update a warehouse

Update an existing warehouse, matched on `id`.

Body parameters

namestringrequired

locationIdstringrequired

References location.id

requiresPickbooleanrequired

requiresPutAwaybooleanrequired

requiresBinbooleanrequired

requiresReceivebooleanrequired

requiresShipmentbooleanrequired

activebooleanrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/warehouse

curl --request PATCH \
  --url 'https://rest.carbon.ms/warehouse?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "locationId": "xyz789",
  "requiresPick": true,
  "requiresPutAway": true,
  "requiresBin": true,
  "requiresReceive": true,
  "requiresShipment": true
}

DELETE/warehouse

Delete a warehouse

Delete a warehouse, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the warehouse to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/warehouse

curl --request DELETE \
  --url 'https://rest.carbon.ms/warehouse?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content