شركة الوسيط للنقل العام والبريد السريع

Merchant APIs : Integration Guide

Changelog

Workflow Overview

2. Supplementary data for order creation

3. Order Creation

4. Edit an Order

5. Retrieve Orders

6. Get Orders Statuses

7. Retrieve Specific Orders by IDs (batch)

8. Invoice Management (Finance)

9. Response Handling

Merchant APIs : Integration Guide V2.3

Welcome to our Merchant API Documentation!

We’re thrilled to have you here. Our API is designed to provide seamless integration and powerful functionality to help you achieve your goals. Whether you’re building a new application, integrating an existing one, or just exploring what our API can do, you’ll find everything you need right here.

Note: The APIs in this documentation are intended for external system integration and are not a substitute for the application APIs. Each API serves a specific purpose and differs from those used within the application.

What's new in V2.3 - 2025/1/18

1. Changed Get Orders Statuses API :

The Get Orders Statuses API now returns all possible order statuses.

V2.2 - 2024/12/31

1. Changed create order API name :

Renamed the "Create Order" API to "Order Creation".
Note : The functionality of the API remains unchanged.

2. Added clearer explanations for each endpoint :

- Added clearer explanations for each endpoint, providing more detailed information on their usage and expected responses.
- Clarified the authentication requirements for the Invoice API to ensure proper integration.

API Rate Limit :

To ensure fair usage and optimal performance of our API, we have implemented a rate limit of

30 requests per 30 seconds

for each user.
This limit is enforced across all endpoints.

If the rate limit is exceeded, the API will return a JSON-formatted error response, consistent with all other returned errors, containing the appropriate error message.

Endpoints :

Before delving into our endpoints, please import our collection to your postman via the following URL:

https://documenter.getpostman.com/view/5889333/
2sA3QpCtuw

Workflow Overview — How the API is organized

Our Merchant API is organized around workflows rather than isolated endpoints. Most real-world tasks (creating an order, getting paid, tracking deliveries) require a short chain of requests, because the input to a later call depends on the output of an earlier one. For example, we cannot return the list of regions until you tell us which city you have chosen, and we cannot return invoice orders until you know which invoice to ask about.

The sections that follow document each endpoint in detail. Before diving in, the table below shows the workflows you will typically implement, their purpose, and the order in which the endpoints should be called. Every workflow except Authentication assumes you already hold a valid token from the Login endpoint.

Workflow summary

#	Workflow	Purpose	Endpoints (in order)	Notes
1	Authentication	Obtain a token that authorizes every other call.	Login	Run once per session. The token resets after a password change. Invoice APIs require a merchant token (not a merchant-user token).
2	Reference data (setup)	Fetch the lookup values needed to create an order: cities, regions and package sizes.	Cities → Regions (city_id) → Package Sizes	Regions depends on a city_id returned by Cities. These values change rarely and can be cached on the client side.
3	Order creation	Submit a new delivery order and receive its QR identifier and receipt link.	(Reference data) → Order Creation	Requires city_id, region_id and package_size from workflow 2. Returns qr_id (your main identifier) and qr_link (printable receipt).
4	Order modification	Update an order that is still in the merchant's possession.	Edit an Order	Only valid before the order has been picked up by a driver. Requires the qr_id from workflow 3.
5	Order tracking	List your orders, or look up specific ones, and interpret their status.	Retrieve Orders or Retrieve Specific Orders by IDs + Get Order Statuses	Get Order Statuses provides the mapping from status_id to human-readable status text. The batch endpoint accepts up to 25 IDs per call.
6	Finance / invoices	Review the invoices generated for your delivered orders, inspect their contents, and confirm receipt.	Get Merchant Invoices → Get Orders for an Invoice (invoice_id) → Receive an Invoice (invoice_id)	All Invoice endpoints require a merchant token; a merchant-user token will return an authentication error.

Dependency map

A simplified view of how the workflows connect:

                 ┌─────────────┐
                 │   Login     │  (1) Authentication
                 └──────┬──────┘
                        │ token
        ┌───────────────┼─────────────────────────────┐
        ▼               ▼                             ▼
 ┌─────────────┐ ┌──────────────┐              ┌────────────────┐
 │   Cities    │ │ Package Sizes│              │ Get Merchant   │
 └──────┬──────┘ └──────┬───────┘              │   Invoices     │ (6)
        │ city_id       │                      └────────┬───────┘
        ▼               │                               │ invoice_id
 ┌─────────────┐        │                      ┌────────────────┐
 │   Regions   │        │                      │ Get Invoice    │
 └──────┬──────┘        │                      │    Orders      │
        │               │                      └────────┬───────┘
        └──────┬────────┘                               │
               ▼   (2) Reference data                   ▼
        ┌─────────────┐                        ┌────────────────┐
        │Order Creation│ (3)                   │ Receive Invoice│
        └──────┬──────┘                        └────────────────┘
               │ qr_id
        ┌──────┴──────────────┐
        ▼                     ▼
 ┌─────────────┐      ┌──────────────────┐
 │  Edit Order │ (4)  │ Retrieve Orders  │ (5)
 └─────────────┘      │  / by IDs +      │
                      │  Get Statuses    │
                      └──────────────────┘

One-time vs. recurring calls

To keep your integration efficient and to stay within the rate limit of 30 requests per 30 seconds, we recommend treating the workflows differently:

One-time / cacheable: Cities, Regions, Package Sizes, Get Order Statuses. These rarely change. Fetch them once on startup (or on a daily refresh) and reuse the values from your local cache when creating orders.
Runtime / per-task: Login (per session), Order Creation, Edit an Order, Retrieve Orders, Retrieve Specific Orders by IDs, and the Invoice endpoints. These reflect live data and should be called when the corresponding business event occurs.

How to read the rest of this document

Each endpoint section below follows the same structure: URL, Method, Content-Type, Purpose, Required Parameters, Response, and a Request / Response sample. When an endpoint participates in one of the workflows above, its parameters will refer back to fields produced by earlier endpoints (for example, city_id from Cities, or invoice_id from Get Merchant Invoices). If you ever feel that an endpoint is missing information, check the workflow table — the missing value is almost always produced by the endpoint immediately before it in the chain.

Submit your username and password to authenticate and receive an auth token for all subsequent API requests. Log in with a merchant account to get a merchant token (required for financial APIs), or with a merchant user account to get a merchant user token (not valid for financial APIs — use the merchant token instead).
Note: all API communication depends on this auth token.

URL : https://api.alwaseet-iq.net/v1/merchant/login

Method :

POST

Content-Type :

multipart/form-data

Purpose :

To authenticate a merchant and receive a token.

Login token resets after password change
Login with merchant account to get merchant token (merchant token is required for financial APIs), or with merchant user account to get merchant user token (merchant user token will not work for financial APIs you will need to use the merchant token instead)
Financial APIs strictly require Merchant token and will return authentication error if merchant user token is used.

Required Parameters :

username

(string)

[Required] :

The merchant's username.
password

(string)

[Required] :

The merchant's password.

Response :

On success : Returns a token to be used for future API calls.
On failure : Provides an error code and message.

Request Samples :

Query Parameters : No parameters
Request Body :

"username":"username"
"password":"password"

Response Samples :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": {
    "token": "@@d71480ycdmp9....", the login token (string)
 }
}

Response body on failure:

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Supplementary data for order creation :

To create an order in our API, couple of parameters have to be specified (region-id, city-id, package-size).

Each of these values has its own API as shown below:

Several endpoints are used to get necessary data before creating an order :

Cities :

Returns a list of cities by name and ID.

URL : https://api.alwaseet-iq.net/v1/merchant/citys
Method :
GET
Content-Type :
N/A
Response : A list of cities in the format [{id: 1, city_name: 'name'}].
Request Sample :

Query Parameters : No parameters
Request Body : No body

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned 
 "msg": "ok", // Success message
 "data": [
  {
    "id": "1", the id of the city (string)
    "city_name": "name" the text of the city (string)
  } 
 ]
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Regions :

Returns the list of regions by name and id for a given city-id.

URL : https://api.alwaseet-iq.net/v1/merchant/regions?city_id=ID
Method :
GET
Content-Type :
N/A
Parameter : city_id (int) [Required] : Specifies the city for which regions are retrieved.
Response : A list of regions within the specified city in the format [{id: 1, region_name: 'name'}].
Request Sample :

Query Parameters :

"city_id":"ID"

Request Body: No body

Response Sample :

Response body on success:

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": [ 
  {
     "id": "1", the id of the region (string)
     "region_name": "name" the text of the region (string)
  }
 ] 
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Package Sizes :

Returns a list of supported sizes by name and ID.

URL : https://api.alwaseet-iq.net/v1/merchant/package-sizes
Method :
GET
Content-Type :
N/A
Response : A list of available package sizes in the format [{id: 1 ,size: 'name'}].
Request Sample :

Query Parameters : No parameters
Request Body : No body

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned "msg": "ok", // Success message
 "data": [
  {
    "id": "1", the id of the package size (string)
    "size": "name" the text of the package size (string)
  } 
 ]
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Order Creation:

After preparing all the order info (city-id, region-id, package-size, customer-phone, price, client-name, location description etc.) you can proceed and submit your order-creation info to the API.

URL : https://api.alwaseet-iq.net/v1/merchant/create-order?token=loginToken

Method :

POST

Content-Type :

multipart/form-data

Order Printing:

After creating an order, you will receive a link (qr_link) to generate a PDF containing the order receipt (sticker). This receipt can be printed and attached to the package for use during delivery.
Alternatively, if you prefer to use your own receipt design, you can extract the generated order QR number (qr_id) and include it on your custom receipt both as a QR code and as plain text.

Required Parameters (in body) :

client_name

(string)

[Required] :

Name of the client.
client_mobile

(string)

[Required] :

The client’s mobile number. Must be in this format “+9647000000000“, iraq country code followed by 10 numbers
client_mobile2

(string)

[Optional] :

The client’s mobile number. Must be in this format “+9647000000000“, iraq country code followed by 10 numbers
city_id

(int)

[Required] :

ID of the client’s city (from the Cities API).
region_id

(int)

[Required] :

ID of the client’s region (from the Regions API).
location

(string)

[Required] :

Description of the client’s location.
type_name

(string)

[Required] :

Description of the type of goods in the order.
items_number

(int)

[Required] :

Number of items in the order.
price

(int)

[Required] :

Total price of the order, including delivery.
package_size

(int)

[Required] :

The size of the order package (from the Package Sizes API).
merchant_notes

(string)

[Optional] :

A general note or instruction about the order.
replacement

(0 or 1)

[Required] :

Specifies if the order is a replacement.

Response :

On success : A success message and the order data.
On failure : An error message.

Request Sample :

Query Parameters :

"token":"token"

Request Body :


"client_name":"name",
"client_mobile":"+9647000000000",
"client_mobile2":"+9647000000000",
"city_id":ID,
"region_id":ID,
"location":"text",
"type_name":"text",
"items_number":number,
"price":number,
"package_size":ID,
"merchant_notes":"text",
"replacement":0 or 1

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": [
  {
    "client_name":"client name" (the name of the client),
    "client_mobile":"+9647700000000" (client phone number),
    "client_mobile2":"+9647700000000"(client second phone number),
    "city_id":"5" (the city id of the client),
    "region_id":"2" (the region id of the client),
    "merchant_mobile":"07700000000" (set from merchant info),
    "items_number":"1" (number of items in the order),
    "price":"25000" (price of the order including delivery fee),
    "package_size":"1" (the size of the order),
    "cash_fee":0 (extra fee in IQD applied when total order price exceeds 1,000,000 IQD; otherwise 0)
    "location":"market" (client delivery location description), 
    "merchant_id":"5" (set from merchant info),
    "current_city":"1" (set automatically by the system),
    "merchant_city":"1" (set from merchant info),
    "company_price":4000 (the delivery fee of this order),
    "city_fees":0 (set automatically by the system),
    "merchant_price":21000 (the order price without delivery fee),
    "type_name":"ملابس" (orders goods type),
    "merchant_created_at":"2024-08-10 23:59:59" (set automatically by the system),
    "merchant_notes":"عدم فتح القطعة" (set by the merchant),
    "qr_id": 38799216 (the QR id of this order, this will be the main identifier of the order),
    "pickup_id": "1" (the pickup driver assigned to this order),
    "pickup_created_at": "2024-08-10 04:30:10" (set automatically by the system),
    "id": ID (set automatically by the system),
    "qr_link": "https://alwaseet-iq.net/merchant/print-single-tcpdf?id=ID&token=token" (the receipt PDF link)
  } 
 ]
}

Response body on error :

{
"status": false,
"errNum": "999", // Error code
"msg": "error message", // Error message
}

Edit an Order :

In scenarios where the order info needs to be updated and the order is still at the merchant possession (status_id = 1), this endpoint provides the ability to do so:

URL : https://api.alwaseet-iq.net/v1/merchant/edit-order?token=loginToken

Method :

POST

Content-Type :

multipart/form-data

Required Parameters (in body) :

qr_id

(string)

[Required] :

Order number
client_name

(string)

[Required] :

Name of the client.
client_mobile

(string)

[Required] :

The client’s mobile number. Must be in this format “+9647000000000“, iraq country code followed by 10 numbers
client_mobile2

(string)

[Optional] :

The client’s mobile number. Must be in this format “+9647000000000“, iraq country code followed by 10 numbers
city_id

(int)

[Required] :

ID of the client’s city (from the Cities API).
region_id

(int)

[Required] :

ID of the client’s region (from the Regions API).
location

(string)

[Required] :

Description of the client’s location.
type_name

(string)

[Required] :

Description of the type of goods in the order.
items_number

(int)

[Required] :

Number of items in the order.
price

(int)

[Required] :

Total price of the order, including delivery.
package_size

(int)

[Required] :

The size of the order package (from the Package Sizes API).
merchant_notes

(string)

[Optional] :

A general note or instruction about the order.
replacement

(0 or 1)

[Required] :

Specifies if the order is a replacement.

Response :

On success : A success message.
On failure : An error message.

Request Sample :

Query Parameters :

"token":"token"

Request Body :

"qr_id":"6942069",
"client_name":"name",
"client_mobile":"+9647000000000",
"client_mobile2":"+9647000000000",
"city_id":ID,
"region_id":ID,
"location":"text",
"type_name":"text",
"items_number":number,
"price":number,
"package_size":ID,
"merchant_notes":"text",
"replacement":0 or 1

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000",
 "msg": "ok", // Success message
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Retrieve Orders :

Now with your order being alive in our system. You might want to inquire about order details/status.
To do so, the APIs below have been provided (basically returns a list of order(s) with their status).

Alternatively you can retrieve orders by their ids using this API (Retrieve Specific Orders by IDs).

URL : https://api.alwaseet-iq.net/v1/merchant/merchant-orders?token=loginToken

Method :

GET

Content-Type :

N/A

Response :

A list of orders related to the merchant.

Request Sample :

Query Parameters :
```
"token":"token"
```
Request Body : no body

Response Sample:

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": [
  {
    "client_name":"client name", (name of the client) 
    "client_mobile":"+9647700000000", (client mobile number) 
    "items_number":"1", (number of items in this order) 
    "created_at":"2023-08-13 22:12:18", (the date and time of when the order was created)
    "city_name":"بغداد", (city name of client) 
    "region_name":"شارع فلسطین", (region name of the client)
    "status_id":"2", (the status id of the order) 
    "status":"تم استلام الطلب من قبل المندوب", (the status text of the order)
    "price":"20000", (the order price including delivery fee) 
    "location":"market", (the description of the client location) 
    "issue_notes":"لا یوجد", (a note written by the delivery driver when there is an issue with the order)
    "merchant_notes":"لا یوجد", (a note written by the merchant) 
    "client_mobile2":"+9647700000000", (client second mobile number) 
    "updated_at":"2024-06-22 11:28:53", (the last date and time the order data was updated)
    "city_id":"13", (client city number)
    "region_id":"1043", (client region number)
    "replacement":"0", (indicate if the order is a replacement or not, 1 for replacement 0 for not)
    "type_name":"ملابس", (order goodes type)
    "id":"103", (order id)
    "has_merchant_fin_record": 0 OR 1, (indicates whether the merchant has requested accounting for the invoice this order is included in, 1 if the merchant has requsted accounting.)
    "deliver_confirmed_fin":0 OR 1, (if 1 then the order has been delivered, and the company has received payment from the delivery driver. At this stage, the merchant is eligible to request accounting for this order.)
    "delivery_price":"9000", (the delivery fee of this order) 
    "package_size":"عادي", (the order size) 
    "merchant_invoice_id":"-1" (the merchant invoice number, if the value is "-1" then this order is not included in a merchant invoice and the merchant can not request accounting for this order.)
  }    
 ] 
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Get Order Statuses :

This API provides a list of order statuses, each associated with a unique status ID and a descriptive status text.

URL : https://api.alwaseet-iq.net/v1/merchant/statuses?token=loginToken

Method :

GET

Content-Type :

N/A

Response : A list of order statuses in the format [{id: 1, status: 'status text'}].

Request Sample :

Query Parameters :
```
"token":"token"
```
Request Body: No body

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": [
  {
    "id": "2",
    "status": "تم الاستلام من قبل المندوب"
  } 
 ]
}

Response body on error :

{
    "status": false,
    "errNum": "999", // Error code
    "msg": "error message", // Error message
}

                            
                                07
                            
                            
                            
                        
Retrieve Specific Orders by IDs (batch)
 :

                            This endpoint allows you to retrieve specific orders by providing a comma-separated list of order IDs. 
                            

                            Unlike the "Retrieve Orders" endpoint, which returns all orders, 
                            

                            this batch retrieval is limited to a maximum of 25 order IDs per request.
                        
URL :https://api.alwaseet-iq.net/v1/merchant/get-orders-by-ids-bulk?token=loginToken
Method :POST
Content-Type :multipart/form-data
Parameter :ids
(string)
[Required] :

                            A comma-separated string of order IDs to retrieve. 
                            A maximum of 25 IDs is allowed—any additional IDs beyond this limit will be discarded. 
                        
Response :Details of the selected orders.

                            Request Sample :
                        

                                Query Parameters :
                            
"token":"token"

                                Request Body :
                            
"ids":"11,23,75,29" (string of comma separated values, max 25 ids)

                            Response Sample :
                        

                                Response body on success :
                            
{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": [
  {
    "client_name":"client name", (name of the client)
    "client_mobile":"+9647700000000", (client mobile number)
    "items_number":"1", (number of items in this order)
    "created_at":"2023-08-13 22:12:18", (the date and time of when the order was created)
    "city_name":"بغداد", (city name of client)
    "region_name":"شارع فلسطین", (region name of the client)
    "status_id":"2", (the status id of the order)
    "status":"تم استلام الطلب من قبل المندوب", (the status text of the order)
    "price":"20000", (the order price including delivery fee)
    "location":"market", (the description of the client location)
    "issue_notes":"لا یوجد", (a note written by the delivery driver when there is an issue with the order)
    "merchant_notes":"لا یوجد", (a note written by the merchant)
    "client_mobile2":"+9647700000000", (client second mobile number)
    "updated_at":"2024-06-22 11:28:53", (the last date and time the order data was updated)
    "city_id":"13", (client city number)
    "region_id":"1043", (client region number)
    "replacement":"0", (indicate if the order is a replacement or not, 1 for replacement 0 for not)
    "type_name":"ملابس", (order goodes type)
    "id":"103", (order id)
    "has_merchant_fin_record": 0 OR 1, (indicates whether the merchant has requested accounting for the invoice this order is included in, 1 if the merchant has requsted accounting.)
    "deliver_confirmed_fin":0 OR 1, (if 1 then the order has been delivered, and the company has received payment from the delivery driver. At this stage, the merchant is eligible to request accounting for this order.)
    "delivery_price":"9000", (the delivery fee of this order)
    "package_size":"عادي", (the order size)
    "merchant_invoice_id":"-1" (the merchant invoice number, if the value is "-1" then this order is not included in a merchant invoice and the merchant can not request accounting for this order.)
  }    
 ] 
}

                                Response body on error :
                            
{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Invoice Management (Finance) :

Several APIs are available for managing merchant invoices:

Authentication Requirements for Invoice APIs

To use the Invoice APIs, only the Merchant token is accepted for authentication. If a Merchant user token is used instead, an authentication error will be returned. Please ensure that the correct token is used to avoid authentication issues.

To inquire about invoices, you can use the get merchant invoices API and retrieve invoices. Then get invoice orders from the following APIs.

receive an invoice using the following APIs.

Get Merchant Invoices :

URL : https://api.alwaseet-iq.net/v1/merchant/get_merchant_invoices?token=loginToken
Method :
GET
Content-Type :
N/A
Response :
Returns all invoices related to the merchant.
Request Sample:

Query Parameters :

"token":"token"

Request Body : No body

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data": [
  {    
    "id": "3", (invoice id)
    "merchant_price": "170000", (total price to be received from this invoice)
    "delivered_orders_count": "7", (number of delivered orders for this invoice)
    "replacement_delivered_orders_count": "0", (number of replacement delivered orders)
    "status": "تم الاستلام من قبل التاجر", (invoice status text)
    "merchant_id": "5", (merchant id)
    "updated_at": "2023-12-20 17:01:46" (last date and time the invoice was updated)
  }    
 ] 
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Get Orders for an Invoice :

URL : https://api.alwaseet-iq.net/v1/merchant/get_merchant_invoice_orders?token=loginToken&invoice_id=invoiceID
Method :
GET
Content-Type :
N/A
Parameter:

invoice_id
(string): The ID of the invoice.
Response :
Returns all orders associated with a particular invoice.
Request Sample :

Query Parameters :

"token":"token"
"invoice_id":"ID"

Request Body : No body

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
 "data":{
    "invoice" : [
    {
        "id": "3", (invoice id)
        "merchant_price": "170000", (total price to be received from this invoice)
        "delivered_orders_count": "7", (number of delivered orders for this invoice)
        "replacement_delivered_orders_count": "0", (number of replacement delivered orders)
        "status": "تم الاستلام من قبل التاجر", (invoice status text)
        "merchant_id": "5", (merchant id)
        "updated_at": "2023-12-20 17:01:46" (last date and time the invoice was updated)
    }    
    ]  
    "orders" : [
    {
        "client_name":"محمد", (name of the client)
        "client_mobile":"+9647704723599", (client mobile number)
        "items_number":"1", (number of items in this order)
        "created_at":"2023-08-13 22:12:18", (the date and time of when the order was created)
        "city_name":"بغداد", (city name of client)
        "region_name":"شارع فلسطین", (region name of the client)
        "status_id":"2", (the status id of the order)
        "status":"تم استلام الطلب من قبل المندوب", (the status text of the order)
        "price":"20000", (the order price including delivery fee)
        "location":"market", (the description of the client location)
        "issue_notes":"لا یوجد", (a note written by the delivery driver when there is an issue with the order)
        "merchant_notes":"لا یوجد", (a note written by the merchant)
        "client_mobile2":"07", (client second mobile number)
        "updated_at":"2024-06-22 11:28:53", (the last date and time the order data was updated)
        "city_id":"13", (client city number)
        "region_id":"1043", (client region number)
        "replacement":"0", (indicate if the order is a replacement or not, 1 for replacement 0 for not)
        "type_name":"ملابس", (order goodes type)
        "id":"103", (order id)
        "delivery_price":"9000", (the delivery fee of this order)
        "package_size":"عادي", (the order size)
        "merchant_invoice_id":"8" (the merchant invoice number)
    }
    ]
  }
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Receive an Invoice :

When the invoice is sent to the merchant he has to confirm the receipt by scanning the invoice's QR-code via the merchant-app.
Alternatively, the invoice can be confirmed (received) by the API below.

URL : https://api.alwaseet-iq.net/v1/merchant/receive_merchant_invoice?token=loginToken&invoice_id=invoiceID
Method :
GET
Content-Type :
N/A
Parameter:

invoice_id
(string): The ID of the invoice.
Response :
Marks the invoice as received.
Request Sample :

Query Parameters :

"token":"token"
"invoice_id":"ID"

Request Body : No body

Response Sample :

Response body on success :

{
 "status": true,
 "errNum": "S000", // On success "S000" will be returned
 "msg": "ok", // Success message
}

Response body on error :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message", // Error message
}

Response Handling :

In case of an error, the API will return a response with the following structure :

{
 "status": false,
 "errNum": "999", // Error code
 "msg": "error message" // Error message
}

A successful response typically looks like this :

{
 "status": true,
 "errNum": "S000", // Success code
 "msg": "ok", // Success message
 "data": [ ... ] // Relevant data
}