Location

Area Resource

Key	Type	Description
id	Integer	the unique identifier for the area.
name	String	the name of the area in English.
city_id	Integer	the unique identifier for the city to which the area belongs.
active	Boolean	a boolean indicating whether the area is currently active or not.
deactivation_notes	String	the notes related to deactivating the area (if any).
delivery_fees	String	the delivery fees for the area.
name_ar	String	the name of the area in Arabic.
aramex_area_name	String	the name of the area in Aramex shipping service.
movex_name	String	the name of the area in Movex shipping service (if any).
bosta_name	String	the name of the area in Bosta shipping service (if any).
delivery_fees_type	Integer	the type of delivery fees (e.g. flat rate, percentage).
minimum_for_free_delivery	Integer	the minimum order value required for free delivery.
minimum_override_provider	Integer	the minimum order value required for overriding the provider's minimum order value (if any).
geometry	Object	the geometry of the area (if available).
coordinates	Object	the coordinates of the area (if available).
inventory	Object	the inventory of the area (if any).

City Resource

Key	Type	Description
id	Integer	a unique identifier for the city.
name	String	the name of the city in English.
name_ar	String	the name of the city in Arabic.
active	Integer	a boolean indicating whether the city is currently active or not.
deactivation_notes	String	any notes about why the city was deactivated.
delivery_fees	String	a indicating the delivery fees for the city.
aramex_city_name	String	the name of the city according to the Aramex provider.
movex_name	String	the name of the city according to the Movex provider.
bosta_name	String	the name of the city according to the Bosta provider.
delivery_fees_type	Integer	an indicating the type of delivery fees (e.g., fixed, based on distance, etc.).
minimum_for_free_delivery	Integer	the minimum amount for free delivery in the city.
minimum_override_provider	Integer	the minimum amount for free delivery as overridden by the provider.

City Details Resource

Key	Type	Description
id	Integer unique identifier for the city.
name	String	the name of the city in English.
name_ar	String	the name of the city in Arabic.
areas	Array	The "areas" key is an array that could contain information about specific areas within the city.
active	Boolea	The "active" key is a boolean value (1 or 0) that indicates whether the city is currently active or not.
fees_type	Integer	The "fees_type" key represents the type of delivery fees applied in this city. Fees Types (1): Get delivery fees direct from delivery_fees key. (2): Get delivery fees from the fees_range key, which represents a range of fees.
delivery_fees	String	The "delivery_fees" key stores the actual delivery fee value for this city.
fees_range	Array	The "fees_range" key is an array that could contain fee ranges, depending on the fees_type However, in this example, the array seems to be empty, suggesting that no specific fee ranges are defined for the city.

Area Details Resource

Key	Type	Description
id	Integer	This key stores a unique identifier for the area. It is typically used as a reference to distinguish the area from others in the system.
name	String	The name of the area in English.
name_ar	String	The name of the area in Arabic.
city_id	Integer	The city to which this area belongs.
districts	Array	An array that could contain information about specific districts within the area.
active	Boolean	A boolean value that indicates whether the area is currently active or not.
fees_type	Integer	The "fees_type" key represents the type of delivery fees applied in this city. Fees Types (1): Get delivery fees direct from delivery_fees key. (2): Get delivery fees from the fees_range key, which represents a range of fees.
delivery_fees	String	The "delivery_fees" key stores the actual delivery fee value for this area.
fees_range	Array	The "fees_range" key is an array that could contain fee ranges, depending on the fees_type However, in this example, the array seems to be empty, suggesting that no specific fee ranges are defined for the city.
aramex_area_name	String	The "aramex_area_name" key represents the area name used specifically by the shipping or logistics provider Aramex. This field can be useful when integrating with external shipping services.
available	Boolean	The "available" key is a boolean value (true or false) that indicates whether this area is available for service. If the value is true, it means the area is available; if it's false, the area might not be serviceable or might be temporarily unavailable.
inventory	Object	The "inventory" key stores data related to the inventory or stock availability for this area. In this example, the object appears to be empty, indicating that there is no specific inventory information available for this area.