Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

View Location

GET

https://api.zid.sa/v1/locations/{location_id}/

Retrieves details about a specified location.

🔑Scopes

inventories.read - Inventories Read

Request

Path Params

Header Params

Body Params application/json

Example

{
    "short_address": "RHHB4094"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/locations/056e7f7f-85e2-42fc-a630-3a7ba839231e/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Authorization: {{Autherization}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Role: Manager' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
    "short_address": "RHHB4094"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "id": "8ee590fe-d02d-4c50-9184-f628bb8b115a",
    "name": {
        "ar": "الرياض - فرع عبد العزيز"
    },
    "city": {
        "id": 1,
        "name": "Riyadh",
        "ar_name": "الرياض",
        "country": {
            "id": 184,
            "name": "Saudi Arabia",
            "ar_name": "السعودية",
            "iso_code_2": "SA",
            "iso_code_3": "SAU",
            "code": "SA"
        },
        "country_code": "SA"
    },
    "type": "PHYSICAL",
    "coordinates": {
        "latitude": 24.77208405941104,
        "longitude": 46.66803359985352
    },
    "full_address": "6137 King Abdul Aziz Branch Rd, An Nafal, Riyadh 13312, Saudi Arabia",
    "short_address": null,
    "district": "King Abdul Aziz",
    "street": "نفال",
    "fulfillment_priority": 9,
    "is_default": false,
    "is_private": false,
    "is_enabled": true,
    "has_stocks": true,
    "channels": [
        "pos",
        "catalog"
    ],
    "linked_users": [
        {
            "user_uuid": "6675a8a4-ad6e-4663-b53e-6852e63f48c7",
            "full_name": "Osama"
        }
    ]
}

🟠401Unauthorized

🟠404Not found

🔴500Internal Server error

Modified at 2026-02-01 20:47:34

List Locations

Shipping