Multi-Inventory

Overview

ZAM API introduces a new feature: the Multi-Inventory, currently in the piloting stage. This feature enables a store to manage the inventory of products across multiple physical or virtual locations.

Accessing the Feature

To determine if your store has access to this feature, you need to check the has_multi_product_inventory flag on your store object. This flag can be retrieved by calling the GET /managers/account/profile endpoint. If has_multi_product_inventory is true, your store has access to the Multi-Inventory feature.

New Workflow for Shipping Apps

If has_multi_product_inventory is true, you will no longer need to call the /managers/store/inventory-addresses endpoint. Instead, you will use the inventory_address field from the order details payload, which will be the pickup location for that particular order.

Here is an example of what an inventory_address object may look like in the order details payload:

"inventory_address": {
  "id": "2b7c1bfec96c49c38c4e9f6a68bdc4ad",
  "city": {
    "id": 1,
    "name": "الرياض",
    "country_id": 184,
    "country_name": "السعودية",
    "country_code": "SA",
    "ar_name": "الرياض",
    "en_name": "Riyadh"
  },
  "full_address": "RHWA6482, 6482 Al Ulaya, 2901، حي الورود، Riyadh 12215, Saudi Arabia",
  "coordinates": {
    "lat": 24.7161275903987,
    "lon": 46.67312344466154
  },
  "working_hours": []
}

Restrictions

If the has_multi_product_inventory flag is set to false and the token has scopes allowing for operations on Multi-Inventory, any attempt to call the new inventory API endpoints will still not be successful. Specifically, a GET /locations/ request will return an empty response, and a POST /locations/ request to create a new location will return a 403 response.

Availability

This feature is available for stores with Professional and Enterprise packages only.

We hope you find the new Multi-Inventory feature useful for managing your store's inventory across multiple locations. If you have any questions, don't hesitate to get in touch with us.