Location Create

POST

/api/locations

Authorization Policies Required:

md_inventory: Ensures the tenant has purchased or subscribed to the inventory module.

manage_inventory: Ensures the user has the required permissions to manage inventory.

Request

Header Params

Body Params application/json

Example

{
    "name": "Warehouse 1",
    "isActive": true,
    "address": {
        "address1": "123 Main St",
        "address2": "Suite 100",
        "city": "Albany",
        "state": "NY",
        "country": "USA",
        "postalCode": "12345"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://platform.shopranos.eu/api/locations' \
--header 'x-companyId: b3e68ad4-06c8-4e70-965b-c02b38f66ef2' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Warehouse 1",
    "isActive": true,
    "address": {
        "address1": "123 Main St",
        "address2": "Suite 100",
        "city": "Albany",
        "state": "NY",
        "country": "USA",
        "postalCode": "12345"
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "id": "string"
}

🟢201Created. The location record was successfully created.

🟠400Bad Request. The provided location data is invalid.

🟠401Unauthorized. The user is not authenticated.

🟠403Forbidden. Either the module is not purchased or the user lacks necessary permissions.

Modified at 2025-07-08 13:29:55

Retrieve all locations for the specified company.

Customer creates a new Quote