Add a New Location

Request

Header Params

Access-Token

string

required

An Access Token is a unique string that represents the authorization granted to a client (Partner application) by a user (Merchant or Store Manager) to access their protected resources. It is part of the OAuth 2.0 standard and is used to authenticate API requests on behalf of the user. Access Tokens have a limited lifespan and must be used within their validity period. Once expired, a new Access Token can be obtained using a Refresh Token. Access Tokens should be treated as sensitive information and must be kept secure to prevent unauthorized access to the user's data. If you do not have an Access-Token, but have the older alternative instead, i.e., the X-Manager-Token, then see the instructions here on how to obtain the Access-Token.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

Store-Id

number

required

Example:

37213

Role

enum<string>

required

Role of the user.

Allowed value:

Manager

Example:

Manager

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Body Params application/json

The details necessary for creating a new inventory location

name

object

required

The name of the inventory location in both Arabic and English languages

string

required

The Arabic name of the inventory location

Example:

مخزن الرياض

string

required

The English name of the inventory location

Example:

Riyadh warehouse

coordinates

object

required

The geographic coordinates of the inventory location

longitude

number

required

The longitude coordinate of the inventory location

Example:

24.876855429417

latitude

number

required

The latitude coordinate of the inventory location

Example:

50.0887943

full_address

string

required

The full physical address of the inventory location

Example:

RHHB4094, 4094 Al Aflaj, 7377، حي الواحة، Riyadh 12442, Saudi Arabia

city

integer

required

The unique identifier of the city where the new inventory location is based. If you don't know the ID of the city, you can find it by making two API calls in the following order:

/managers/countries: This endpoint provides a list of countries, each with a unique ID. Find the ID of the country where your new inventory is located.

/managers/cities/by-country-id/{country_id}: Replace {country_id} with the ID obtained from the first step. This endpoint returns a list of cities in the given country, each with its own unique ID. Find the ID of the city where your new inventory is located.

Use this city ID here to add a new inventory location.

Example:

236

is_default

boolean

required

A flag indicating whether this inventory location is the default one for the store

Example:

true

is_private

boolean

required

A flag indicating whether this inventory location is private and not accessible to the public

Example:

false

is_enabled

boolean

required

A flag indicating whether this inventory location is currently enabled and functioning

Example:

true

Example

{
  "name": {
    "ar": "مخزن الرياض",
    "en": "Riyadh warehouse"
  },
  "coordinates": {
    "longitude": 24.876855429417,
    "latitude": 50.0887943
  },
  "full_address": "RHHB4094, 4094 Al Aflaj, 7377، حي الواحة، Riyadh 12442, Saudi Arabia",
  "city": 236,
  "is_default": true,
  "is_private": false,
  "is_enabled": true
}

Request 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: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'Store-Id;' \
--header 'Role;' \
--header 'Accept-Language;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": {
        "ar": "مخزن الرياض",
        "en": "Riyadh warehouse"
    },
    "coordinates": {
        "longitude": 24.876855429417,
        "latitude": 50.0887943
    },
    "full_address": "RHHB4094, 4094 Al Aflaj, 7377، حي الواحة، Riyadh 12442, Saudi Arabia",
    "city": 236,
    "is_default": true,
    "is_private": false,
    "is_enabled": true
}'

Responses

🟢200Successful operation.

application/json

Body

Details of a location in the system

string

optional

Unique identifier for the location

Example:

10ce520d-c14c-4fd2-aa18-e885dc8d1ae8

name

object

optional

Name of the location in multiple languages

string

optional

Name in Arabic

Example:

مخزن الرياض

string

optional

Name in English

Example:

Riyadh Warehouse

city

object

optional

Details of the city where the location is

integer

optional

Unique identifier for the city

Example:

101

name

string

optional

Name of the city in English

Example:

Riyadh

ar_name

string

optional

Name of the city in Arabic

Example:

الرياض

country

object

optional

Details of the country where the city is

type

string

optional

Type of location

Example:

PHYSICAL

coordinates

object

optional

Geographic coordinates of the location

latitude

number

optional

Latitude of the location

Example:

24.7136

longitude

number

optional

Longitude of the location

Example:

46.6753

full_address

string

optional

Full address of the location

Example:

RHHB4094, 4094 Al Aflaj, حي الواحة, Riyadh 12442, Saudi Arabia

fulfillment_priority

integer | null

optional

Priority for fulfillment operations. Null or 0 indicates no specific priority. Lower numbers indicate higher priority. Therefore, 1 is the highest priority.

Example:

null

is_default

boolean

optional

Indicates whether this is the default location

Example:

true

is_private

boolean

optional

Indicates whether this location is private

Example:

false

is_enabled

boolean

optional

Indicates whether this location is enabled

Example:

true

has_stocks

boolean

optional

Indicates whether this location has any stocks

Example:

false

channels

array[string]

optional

Channels this location is available in.
It is an array of strings, with each string representing a channel.
For example, the channels array could be ["catalog", "online", "physical_store", "direct_sales"].

Example

{
  "id": "10ce520d-c14c-4fd2-aa18-e885dc8d1ae8",
  "name": {
    "ar": "مخزن الرياض",
    "en": "Riyadh Warehouse"
  },
  "city": {
    "id": 101,
    "name": "Riyadh",
    "ar_name": "الرياض",
    "country": {
      "id": 184,
      "name": "Saudi Arabia",
      "ar_name": "السعودية",
      "iso_code_2": "SA",
      "iso_code_3": "SAU"
    }
  },
  "type": "PHYSICAL",
  "coordinates": {
    "latitude": 24.7136,
    "longitude": 46.6753
  },
  "full_address": "RHHB4094, 4094 Al Aflaj, حي الواحة, Riyadh 12442, Saudi Arabia",
  "fulfillment_priority": null,
  "is_default": true,
  "is_private": false,
  "is_enabled": true,
  "has_stocks": false,
  "channels": [
    "catalog"
  ]
}