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

Create Location

POST

https://api.zid.sa/v1/locations/

Adds a new location to the store.

🔑Scopes

inventories.read_write - Inventories Read & Write

Request

Header Params

Body Params application/json

Example

{
    "store_id": 3,
    "name": "test 3",
    "city": 1,
    "coordinates": {
        "latitude": "23.2532",
        "longitude": "23.3232"
    },
    "full_address": "RHHB4094, 4094 Al Aflaj, 7377، حي الواحة، Riyadh 12442, Saudi Arabia",
    "is_default": false,
    "is_private": true,
    "is_enabled": false,
    "channels": [
        "catalog"
    ],
    "short_address": "RHHB4094"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/locations/' \
--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 '{
    "store_id": 3,
    "name": "test 3",
    "city": 1,
    "coordinates": {
        "latitude": "23.2532",
        "longitude": "23.3232"
    },
    "full_address": "RHHB4094, 4094 Al Aflaj, 7377، حي الواحة، Riyadh 12442, Saudi Arabia",
    "is_default": false,
    "is_private": true,
    "is_enabled": false,
    "channels": [
        "catalog"
    ],
    "short_address": "RHHB4094"
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "0b602ebc-1bbe-4905-b010-51599615ce82",
    "name": {
        "en": "test 2"
    },
    "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": 23.2532,
        "longitude": 23.3232
    },
    "full_address": "RHHB4094, 4094 Al Aflaj, 7377، حي الواحة، Riyadh 12442, Saudi Arabia",
    "short_address": "RHHB4094",
    "district": null,
    "street": null,
    "fulfillment_priority": null,
    "is_default": false,
    "is_private": true,
    "is_enabled": false,
    "has_stocks": false,
    "channels": [
        "catalog"
    ],
    "linked_users": []
}

🟠401Unauthorized

🟠400Bad Request

🔴500Internal Server error

Modified at 2026-02-01 20:10:02

Inventories

Update Location