POST /stocks/warehouses

Create a warehouse

This endpoint allows you to create a warehouse.

Operation ID: createStockWarehouses

lock This endpoint requires a Bearer token in the Authorization header.

Request Body

Content-Type: application/json · Required fields: code, name

code string required

Code of the warehouse.

name string required

Name of the warehouse.

associated_operators array<object>

List of associated operators.

operator_id integer required

ID of the operator.

permission string required

Permission of the operator.

manager

Responses

data array<object>

id string read-only

The unique identifier of the warehouse within the system. This ID is immutable and assigned upon creation.

Example: 1

type string read-only

The resource type, identifying this as a warehouse.

stock-warehouse

attributes object

warehouse_id string

The unique identifier of the warehouse within the system. This ID is immutable and assigned upon creation.

Example: 1

name string

The descriptive name of the warehouse, intended for readability and identification within the application's user interface.

Example: Warehouse

code string

A unique code assigned to the warehouse, intended for readability and identification within the application's user interface.

Example: WZ1

address string | null

The physical street address of the warehouse. This provides the geographical location of the storage facility.

Example: Warehouse street, 10, Country

observations string | null

Free-text field for any additional notes, specific instructions, or relevant details pertaining to this warehouse.

Example: Operational hours from 9am to 7pm, entrance by the large door on the side.

created_at string (date-time)

The timestamp indicating when the warehouse record was initially created in the system. This value is automatically set upon the creation of a new warehouse.

Example: 2025-05-27T11:44:46.000Z

updated_at string (date-time)

The timestamp indicating when the warehouse record was last modified. This value is automatically updated whenever any attribute of the warehouse is changed and saved.

Example: 2025-05-27T11:44:46.000Z

associated_operators array<object>

A list of operators associated with this warehouse. This defines the personnel linked to this storage location and their respective roles or responsibilities.

operator_id integer

The unique identifier of the operator within the system. This ID is used to reference the specific personnel associated with the warehouse.

Example: 1

permission string

The specific permission or role assigned to this operator in relation to the warehouse. This dictates the actions the operator is authorized to perform.

manager

included array<object>

List of relationships to be included

meta object

Meta model structure details

pagination object

total integer required

Total items.

Example: 1

count integer required

Total items returned for the current page.

Example: 1

per_page integer required

Maximum number of records per page.

Example: 1

current_page integer required

Number of the current page.

total_pages integer required

Number of the total pages.

links object

Requests that return multiple items include a `links` attribute, with links related to request's context.

self string required read-only

Current response link.

Example: /path?page=1

first string required read-only

Link to the first page result.

Example: /path?page=1

last string required read-only

Link to the previous page result.

Example: /path?page=1

next string read-only

Link to the next page result.

Example: /path?page=1

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Request Body

POST https://api.sandbox.infraspeak.com/v3/stocks/warehouses

curl -X POST \
  'https://api.sandbox.infraspeak.com/v3/stocks/warehouses' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -d '{
    "code": "",
    "name": "",
    "associated_operators": []
}'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/stocks/warehouses', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
  body: JSON.stringify({
    "code": "",
    "name": "",
    "associated_operators": []
}),
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->post('https://api.sandbox.infraspeak.com/v3/stocks/warehouses',
    array (
      'code' => '',
      'name' => '',
      'associated_operators' => 
      array (
      ),
    )
  );

import requests

response = requests.post(
    'https://api.sandbox.infraspeak.com/v3/stocks/warehouses',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
    json={
        {
            "code": "",
            "name": "",
            "associated_operators": []
        }
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "1",
        "type": "stock-warehouse",
        "attributes": {
            "warehouse_id": "1",
            "name": "Warehouse",
            "code": "WZ1",
            "address": "Warehouse street, 10, Country",
            "observations": "Operational hours from 9am to 7pm, entrance by the large door on the side.",
            "created_at": "2025-05-27T11:44:46.000Z",
            "updated_at": "2025-05-27T11:44:46.000Z",
            "associated_operators": {
                "operator_id": 1,
                "permission": "manager"
            }
        }
    },
    "included": [],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 1,
            "current_page": 0,
            "total_pages": 0
        }
    },
    "links": {
        "self": "/path?page=1",
        "first": "/path?page=1",
        "last": "/path?page=1",
        "next": "/path?page=1"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}