Shipping APIs Introduction

Required API Calls

Follow these steps for each merchant after activating the integration:

1. Create a New Delivery Option

Create a new delivery option by navigating to [Delivery option->Add Delivery Option]. You can find the API endpoint here "Add Delivery Option".

2. Send AWB & Tracking URL

After receiving the webhook call (when the order is "ready"), your system should send back the following three items to appear in the merchant's dashboard:

1. Post the Waybill (AWB Information):
- The AWB should include the customer's address and contact information.
- If the customer assigns someone else to receive the shipment, the AWB should show the receiver's (consignee) info.
- Example payload when "has_different_consignee" is true:

"consignee": {
    "name": "manal",
    "email": "sab.al-sheikh@hotmail.com",
    "mobile": "966550427396"
},
"has_different_consignee": true,

2. Tracking Number
3. Tracking URL

3. Update Order Status

Update the order status as follows:

1. In Delivery when the driver picks up the shipment.
2. Delivered when the driver delivers the shipment.
3. Cancelled when the shipment is canceled for any reason.

You can update the order status using the update_order_status endpoint (Orders->change-order-status).

4. Retrieve Supported Countries and Cities by Zid

You can either:
- Use the Retrieve Countries List endpoint to get a list of all supported countries in Zid.
- Use the Retrieve Countries & Cities endpoint to inquire about a specific country or city using its ID in Zid.

5. Payment Methods

Zid offers three payment methods: Cash on Delivery (COD), Bank Transfer, and E-payment. If the customer chooses Bank Transfer or E-payment, the total COD amount in the waybill should be zero.

Shipping APIs Introduction

Required API Calls#

1. Create a New Delivery Option#

2. Send AWB & Tracking URL#

3. Update Order Status#

4. Retrieve Supported Countries and Cities by Zid#