Zid Docs

List Inventory Addresses

GET/managers/store/inventory-addresses

This endpoint returns the physical addresses of Merchant inventory and product stock.
It applies when the merchant is using a single inventory system.

Note: If the merchant has activated the Multi-Inventory feature,
then the corresponding multi-inventory endpoint (List Store Locations) should be used instead of this endpoint in order
to retrieve inventory addresses.

Request

Header Params

Accept-Language

enum<string>

optional

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

Allowed values:

enar

Example:

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

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Request samples

Responses

Successfully retrieved the list of inventory addresses.(200)

Successfully retrieved the list of inventory addresses.

HTTP Code: 200

Content Type : JSONapplication/json

status

enum<string>

optional

Indicates the status of the API response. The value object implies a successful response with the requested data object. The value error indicates that an error occurred during the request processing.

Allowed values:

objecterror

Example:

object

inventory_addresses

array[object (InventoryAddress) {9}]

optional

integer

optional

Unique identifier for the inventory location in the Zid database.

Example:

102

city

object (City)

optional

street

string

optional

Street address of the inventory location.

Example:

King Fahd Road

is_pickup_option

boolean

optional

Indicates if this inventory location is a valid pickup location or is used for storage only.

Example:

true

extra_data

object

optional

Additional data related to the inventory location.

name

string

optional

Name of the inventory location.

Example:

Central Warehouse

postal_code

string

optional

Postal code of the inventory location.

Example:

21371

coordinates

object

optional

Geographical coordinates of the inventory location.

cop_enabled

boolean

optional

Indicates if Cash On Pickup is enabled for this inventory location.

Example:

false

message

object (ResponseMessage)

optional

type

string

optional

The type of the message.

Example:

object

code

string

optional

The code associated with the message.

Example:

200

name

string

optional

The name of the message.

Example:

Success

description

string

optional

A detailed description of the message.

Example:

Order details retrieved successfully.

{
  "status": "object",
  "inventory_addresses": [
    {
      "id": 102,
      "city": {
        "name": "Other",
        "id": 1,
        "national_id": 3,
        "priority": 10,
        "country_id": 184,
        "country_name": "السعودية",
        "country_code": "SA",
        "ar_name": "الرياض",
        "en_name": "Riyadh"
      },
      "street": "King Fahd Road",
      "is_pickup_option": true,
      "extra_data": {
        "zid_front_point": {
          "pickupPointId": "ZID1234"
        }
      },
      "name": "Central Warehouse",
      "postal_code": "21371",
      "coordinates": {
        "lat": 24.7136,
        "lon": 46.6753
      },
      "cop_enabled": false
    }
  ],
  "message": {
    "type": "object",
    "code": "200",
    "name": "Success",
    "description": "Order details retrieved successfully."
  }
}

Last modified: 3 months ago