Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Create an Address

Developing

POST

https://api.zid.sa//account/addresses

Creates a new customer address and optionally sets it as the shipping address for the current cart/session.

This endpoint is typically used to:

Add a new shipping or billing address

Save addresses to the customer’s address book

Optionally select the address for immediate checkout use

Request

Query Params

Body Params application/jsonRequired

Example

{
    "address_district": "Al Olaya",
    "address_city_id": 1,
    "address_country_id": 183,
    "address_type": "general",
    "name": "Ahmed Al Saud",
    "mobile": "+966501234567",
    "address_street": "King Fahd Road",
    "address_formatted": "King Fahd Rd, Al Olaya, Riyadh, Saudi Arabia",
    "short_address": "Al Olaya, Riyadh",
    "address_lat": "24.7136",
    "address_lng": "46.6753",
    "meta": {
        "city_name": "Riyadh",
        "postcode": "11564",
        "building_number": "12A",
        "additional_number": "9876",
        "property1": "string",
        "property2": "string"
    },
    "is_default": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa//account/addresses?set_shipping_address=false' \
--header 'Content-Type: application/json' \
--data-raw '{
    "address_district": "Al Olaya",
    "address_city_id": 1,
    "address_country_id": 183,
    "address_type": "general",
    "name": "Ahmed Al Saud",
    "mobile": "+966501234567",
    "address_street": "King Fahd Road",
    "address_formatted": "King Fahd Rd, Al Olaya, Riyadh, Saudi Arabia",
    "short_address": "Al Olaya, Riyadh",
    "address_lat": "24.7136",
    "address_lng": "46.6753",
    "meta": {
        "city_name": "Riyadh",
        "postcode": "11564",
        "building_number": "12A",
        "additional_number": "9876",
        "property1": "string",
        "property2": "string"
    },
    "is_default": true
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": 55,
    "name": "Ahmed Al Saud",
    "mobile": "+966501234567",
    "address_street": "King Fahd Road",
    "address_district": "Al Olaya",
    "address_formatted": "King Fahd Rd, Al Olaya, Riyadh, Saudi Arabia",
    "short_address": "Al Olaya, Riyadh",
    "address_lat": "24.7136",
    "address_lng": "46.6753",
    "address_type": "home",
    "city": {
        "id": 1,
        "ar_name": "الرياض",
        "en_name": "Riyadh",
        "property1": "string",
        "property2": "string"
    },
    "country": {
        "id": 183,
        "name": "Saudi Arabia",
        "code": "SA",
        "country_code": "+966",
        "property1": "string",
        "property2": "string"
    },
    "meta": {
        "property1": "string",
        "property2": "string"
    },
    "is_customer_default": true,
    "is_default": true,
    "property1": "string",
    "property2": "string"
}

🟠422

Modified at 2026-01-12 07:33:42

Get Addresses

Get an Address by ID