Retrieve a single location By location id

GET

/api/locations/{id}

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

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://platform.shopranos.eu/api/locations/loc-123456789' \
--header 'x-companyId: b3e68ad4-06c8-4e70-965b-c02b38f66ef2'

Responses

🟢200Success. The location record was retrieved.

application/json

Body

Example

{
    "id": "f0ea3f16-5b88-45c2-b061-9599769e1ebe",
    "companyId": "b3e68ad4-06c8-4e70-965b-c02b38f66ef2",
    "name": "Central Location",
    "isActive": true,
    "address": {
        "address1": "Kifisias 44",
        "address2": "5th floor",
        "city": "Athens",
        "state": "Attica",
        "country": "Greece",
        "postalCode": "12345"
    },
    "updateDate": "2025-02-18T07:54:25.7019501+00:00",
    "insertDate": "2025-02-18T07:54:25.7019504+00:00"
}

🟠401Unauthorized. The user is not authenticated.

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

🟠404Not Found. No location found for the given ID.

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

Imports Locations.

Location Delete