The Warehouse Type object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

description string
The Warehouse Type object 
{
  "id": "warehouse-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
GET /api/stock/warehouse-type/{id}

Retrieve a warehouse type

Retrieves the details of an existing warehouse type. Supply the unique warehouse type ID that was returned from a previous request.

Path parameters

id string required

The identifier of the warehouse type to retrieve.

Returns

Returns the warehouse type object if a valid identifier was provided.

GET /api/stock/warehouse-type/{id} 
curl https://api.overplane.dev/api/stock/warehouse-type/warehouse-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "warehouse-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
GET /api/stock/warehouse-type

List all warehouse types

Returns a list of warehouse types. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of warehouse type objects.

GET /api/stock/warehouse-type 
curl https://api.overplane.dev/api/stock/warehouse-type \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "warehouse-type_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/warehouse-type

Create a warehouse type

Creates a new warehouse type object.

Body parameters

description string

Returns

Returns the newly created warehouse type object if the call succeeded.

POST /api/stock/warehouse-type 
curl https://api.overplane.dev/api/stock/warehouse-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "warehouse-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
PATCH /api/stock/warehouse-type/{id}

Update a warehouse type

Updates the specified warehouse type by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the warehouse type to update.

Body parameters

description string

Returns

Returns the updated warehouse type object.

PATCH /api/stock/warehouse-type/{id} 
curl https://api.overplane.dev/api/stock/warehouse-type/warehouse-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"description":"description_example"}'
Response 
{
  "id": "warehouse-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
DELETE /api/stock/warehouse-type/{id}

Delete a warehouse type

Permanently deletes a warehouse type. This cannot be undone.

Path parameters

id string required

The identifier of the warehouse type to delete.

Returns

Returns a confirmation that the warehouse type has been deleted.

DELETE /api/stock/warehouse-type/{id} 
curl https://api.overplane.dev/api/stock/warehouse-type/warehouse-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "warehouse-type_abc123",
  "deleted": true
}