Skip to main content
The Customer location entity represents a precise address of a customer. A customer can have several locations. Each location is identified by many details that helps carriers deliver the order without any delays.

Fields

id: number

Attributes: Unique
A unique identifier assigned to each location.

area: object<Area>

The Area the location belongs to. Embedded areas include every Area field except tags (id, name_ar, name_en, district, lat, long, maps_link, code, is_external, area_group). When creating or updating a location, provide area as { "id": <area_id> } — only the id is used to resolve the area.

directions: string

Extra indications to help the driver find the location more easily.

Example

The list endpoint (GET /customers/{id}/locations/) returns results wrapped in a pagination envelope: { "count", "next", "previous", "results": [ ... ] }.