Zid Docs
Merchant APIPayment APIAppsThemes
Merchant APIPayment APIAppsThemes
Help Center
Slack
  1. Orders
  • Start Here 🚀
  • Overview to Zid Apps
  • Authorization
  • Responses
  • Webhooks
  • Rate Limiting
  • APIs
    • Orders
      • Update Order by ID
        POST
      • Get Order Credit Notes
        GET
      • Get Order by ID
        GET
      • List of Orders
        GET
      • Order Notes
        POST
    • Reverse Orders
      • Reverse Order Reasons
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
    • Carts
      • Get Abandoned Cart Details
      • List Abandoned Carts
    • Products
      • Managing Products
        • Get a Product by ID
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • Digital Vouchers
        • Product Vouchers
        • Order Voucher
        • Add Product Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Product Voucher
        • Remove Product Voucher
      • Product Categories
        • Get Single Category Details
        • Get all categories
        • Create Store Category
        • Update a Store Category
        • Add a product to a certain category
        • Publish/Unpublish a Category
        • Detach Category from All Products
        • Remove Category from Product
      • Product Badge
        • Product Badge
      • Product Attributes
        • Get Product Attributes
        • Get Product Attributes
        • Retrieve a product attribute
        • Add a New Product Attribute
        • Add a New Product Attribute
        • Update a product attribute
        • Delete a product attribute
      • Product Attribute Presets
        • Get attribute presets
        • Create Attribute Preset
        • Update Attribute Preset
        • Delete an attribute preset
      • Product Customizations
        • Add Product Variants
        • Insert Custom Options to a Product
        • Insert Custom User-Input Fields to a Product
      • Product Manual Sorting
        • Set Custom Product Order
        • Reset the manual sorting of all products
      • Product Images
        • Get List of images of a product.
        • Add an image to a product
        • Update a product Image Order
        • Delete a product image
      • Product Notifications
        • Availability Notification Stats
        • Availability Notifications Settings
        • List Availability Notifications
        • Add Availability Notification
        • Save Availability Notifications Settings
        • Manually Send Availability Notification Email
        • Export Availability Notifications
      • Product Import
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock (Multi-Inventory)
        • Get Product Stock by ID
        • List Product Stocks
        • Add Product Stock
        • Update Single Product Stock
        • Bulk Update Product Stocks
      • Product Questions & Answers
        • Get Question
        • Get Answer
        • Get All Questions
        • List Question Answers
        • Create Question
        • Create Answer
        • Update Question
        • Update Answer
        • Delete Question
        • Delete Answer
      • Product Reviews
        • List Reviews
        • New Reviews Total
      • Digital Products
        • Create Downloadable Product
        • Generate an Upload URL
        • Upload File to S3
        • Create Product Downloadables
        • Get Product Downloadables
        • Delete Product Downloadables
        • Get Store Downloadables
        • Create Store Downloadables
        • Delete Store Downloadables
    • Inventories
      • Get Store Location by ID
      • List Store Locations
      • Add a New Location
      • Update a Location by ID
      • Update Products Stock by Location ID
    • Shipping
      • List Store Delivery Options
      • Add Shipping Option
    • Marketing
      • Gift Cards
        • Get Store Settings
        • Add gift card to the cart
        • Update Store Settings
        • Upload gift card designs
        • Remove gift card from the cart
      • Coupons
        • Create a New Coupon
        • List Coupons
        • Get Coupon Details
        • Update Coupon
        • Delete Coupon
      • Bundle Offers
        • Retrieve all Bundle Offers
      • Loyalty Program
        • Loyalty Program Points per Order
        • Store Loyalty Status
        • Info Page
        • Loyalty Program Activation
        • Loyalty Status
        • Set Points Expiration
        • Cashback Rule Method Update
        • Cashback Rule Method Update Status
        • Add Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Toggle Redemption Method Status
        • Show Loyalty Points Info for Specific Customer
        • Customer Profile
        • List Data
        • Customer Points History
        • Info Page - Managers
        • Update Info Page
        • Adjust Customer Points
    • Customers
      • List of Customers
      • Get Customer by ID
    • Store Settings
      • 📄 User Roles and Permissions
      • Get Manager's Profile
      • Get VAT Settings
      • List of Payment Method
    • Countries and Cities
      • Retrieve Store Operating Countries
      • Retrieve Cities by Country ID
      • Countries List
    • Webhook
      • List of Webhooks
      • Create a Webhook
      • Delete a Webhook by OriginalId
      • Delete a Webhook by Subscriber
  • Store Events
    • Order
    • Product
    • Abandoned Cart
    • Customer
    • Product Category
  1. Orders

Order Notes

POST
https://api.zid.sa/v1/managers/store/orders/{order_Id}/add-order-comment
The Add Order Comment API allows shipping and fulfilment partners to post real-time shipment updates directly to an order’s activity.
Partners can add up to 20 comments per order, each limited to 100 characters.
Comments are non-editable and include the app name for clarity.
These updates are visible to merchants in the order activity dashboard, improving communication and speeding up fulfilment-related issue resolution.
🔑Scopes
orders.read_write - Orders Read & Write

Request

Path Params
order_Id
string 
required
The unique identifier of the order for which the comment is being added.
Example:
123456
Header Params
Accept
string 
optional
Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.
Example:
application/json
Authorization
string 
optional
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y
X-manager-Token
string 
optional
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.
Example:
eyJpdiI6ImdmbVQ5ZTFZWm5hRkdvbmFTQ2o2ZkE9PSIsInZhbHVlIjoiMDVXVU1yQWFaTDgvMEZwYW5JWGR1QVZCQ3hFUzQxQ2t3a1oxOGR2QWhEays3N28zeldtaytKU1pzL2tHQU9jT2dZMlZCcnBsUEp1TmcxTG1SWlBnMDVLc0R3dlpGZENsY0s2Y1RwNHpEbVpYbGtjYlVITVpzcy8rNHBkQmxqZExsZW01REJkZmdQb3FmZmNTWTZXZ2JWRitmRWpWSnRZU0NOcTFvRGdjRU9Obk5TZDZRL2FCRHdobytwK3JVZUsrbWJ3RmtmUHlOcEZMcENzUENxUEkrUHFZZTdPQ043S0xtczF0d1k1ekZlaz0iLCJtYWMiOiI0ZDM4MDk3NDMwZDRhZjNkOGI0MzU1ODdmZGVmNGJiNzFmYTE2ZTZjYWM1Njc0NTQ0NmIwMjY1NWMxZWY4ZDQyIiwidGFnIjoiIn0::
Accept-Language
string 
optional
Preferred language for the response. Defaults to en if not specified.
Example:
en
User-Agent
string 
optional
The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.
Example:
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36
store-id
integer 
optional
The unique identifier of the store where the order belongs (integer).
Example:
123
role
string 
optional
The role of the user initiating the request.
Example:
Manager
Body Params application/json
comment
string 
required
The detailed shipment progress message to be added to the order. This comment will be visible to merchants in the order activity.
<= 100 characters
Example:
Your detailed shipment progress message here
Example
{
    "comment": "Your detailed shipment progress message here"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zid.sa/v1/managers/store/orders/123456/add-order-comment' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'X-manager-Token:  eyJpdiI6ImdmbVQ5ZTFZWm5hRkdvbmFTQ2o2ZkE9PSIsInZhbHVlIjoiMDVXVU1yQWFaTDgvMEZwYW5JWGR1QVZCQ3hFUzQxQ2t3a1oxOGR2QWhEays3N28zeldtaytKU1pzL2tHQU9jT2dZMlZCcnBsUEp1TmcxTG1SWlBnMDVLc0R3dlpGZENsY0s2Y1RwNHpEbVpYbGtjYlVITVpzcy8rNHBkQmxqZExsZW01REJkZmdQb3FmZmNTWTZXZ2JWRitmRWpWSnRZU0NOcTFvRGdjRU9Obk5TZDZRL2FCRHdobytwK3JVZUsrbWJ3RmtmUHlOcEZMcENzUENxUEkrUHFZZTdPQ043S0xtczF0d1k1ekZlaz0iLCJtYWMiOiI0ZDM4MDk3NDMwZDRhZjNkOGI0MzU1ODdmZGVmNGJiNzFmYTE2ZTZjYWM1Njc0NTQ0NmIwMjY1NWMxZWY4ZDQyIiwidGFnIjoiIn0::' \
--header 'Accept-Language: en' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36' \
--header 'store-id: 123' \
--header 'role: Manager' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "Your detailed shipment progress message here"
}'

Responses

🟢200OK
application/json
Body
status
string  | null 
optional
The status of the response.
Example:
object
order
object 
required
Detailed information about the order.
id
integer 
required
The unique identifier for the order.
Example:
25304285
code
string 
optional
The code associated with the order.
Example:
8OVNEhyqcf
store_id
integer 
optional
The unique identifier for the store where the order was placed.
Example:
251073
order_url
string <uri>
optional
The URL link to the order's invoice.
Example:
https://zid.store/osama/o/6IJWXOYLuR/inv
store_name
string 
optional
The name of the store.
Example:
Osama's Store
shipping_method_code
string 
optional
The code representing the shipping method used for the order.
Example:
custom
store_url
string <uri>
optional
The URL link to the store.
Example:
https://zid.store/osama/
order_status
object 
required
The current status of the order.
currency_code
string 
optional
The code representing the currency used for the order.
Example:
KWD
is_marketplace_order
boolean 
optional
Indicates whether the order originates from a marketplace platform.
Default:
false
customer
object 
required
Information about the customer who placed the order.
shipping
object 
required
Shipping details for the order.
payment
object 
required
Payment details for the order.
is_potential_fraud
boolean 
optional
Flags the order as potentially fraudulent.
Default:
false
created_at
string <date-time>
optional
The date and time when the order was created.
Example:
2023-07-04 09:12:36
updated_at
string <date-time>
optional
The date and time when the order was last updated.
Example:
2023-07-04 09:14:28
invoice_link
string <uri>
optional
URL to the downloadable PDF invoice for the order.
Example:
https://zid-testing-907587157081.s3-accelerate.amazonaws.com/pdf/order_44834593.pdf
products_count
integer 
optional
The total number of products in the order.
Example:
1
products_sum_total_string
string 
optional
The total sum of all products in the order in a human-readable format.
Example:
30.00 SAR
language
string 
optional
The language used to display the order's page.
Example:
ar
histories
array [object {8}] 
optional
A list of historical records associated with the order.
is_reactivated
boolean 
optional
Indicates if the order was previously canceled and reactivated.
Example:
false
return_policy
string 
optional
Description of the return policy.
Example:
Returns are accepted within 14 days of receipt.
packages_count
integer 
optional
The number of packages in the order.
Example:
1
invoice_settings
object 
optional
message
object 
optional
Message about the response status.
type
string 
optional
The type of the message.
Example:
object
code
string  | null 
optional
The code associated with the message.
Example:
200
name
string  | null 
optional
The name of the message.
Example:
Success
description
string  | null 
optional
A detailed description of the message.
Example:
Order details retrieved successfully.
Example
{
    "status": "object",
    "order": {
        "id": 25304285,
        "code": "8OVNEhyqcf",
        "store_id": 251073,
        "order_url": "https://zid.store/osama/o/6IJWXOYLuR/inv",
        "store_name": "Osama's Store",
        "shipping_method_code": "custom",
        "store_url": "https://zid.store/osama/",
        "order_status": {
            "name": "Delivery in progress",
            "code": "new"
        },
        "currency_code": "KWD",
        "is_marketplace_order": false,
        "customer": {
            "id": "2083543",
            "name": "Osama",
            "email": "example.user@email.com",
            "mobile": "+966501234567",
            "note": " ",
            "verified": "1",
            "type": "individual"
        },
        "shipping": {
            "method": {
                "id": "SHM-123456",
                "name": "Express Delivery",
                "code": "EXP_DEL",
                "estimated_delivery_time": "3-5 Business Days",
                "icon": "https://cdn.example.com/icons/shipping/express_delivery.png",
                "is_system_option": false,
                "waybill": "WB-12345678",
                "had_errors_while_fetching_waybill": false,
                "waybill_tracking_id": "TRACK-12345678",
                "has_waybill_and_packing_list": false,
                "tracking": {
                    "number": "TRACK-12345678",
                    "status": "In Transit",
                    "url": "https://example.com/track?number=TRACK-12345678"
                },
                "order_shipping_status": null,
                "inventory_address": [
                    "string"
                ],
                "courier": "FedEx",
                "return_shipment": "RET-12345678"
            },
            "address": {
                "formatted_address": "Masked Address",
                "street": "Masked Street",
                "district": "Masked District",
                "city": {
                    "id": 1,
                    "name": "Other"
                },
                "country": {
                    "id": 184,
                    "name": "السعودية",
                    "code": "SA"
                }
            }
        },
        "payment": {
            "method": {
                "name": "بطاقة مدى البنكية",
                "code": "zidpay",
                "type": "cc",
                "payment_network": "Visa"
            },
            "invoice": [
                {
                    "code": "sub_totals_before_vat",
                    "value": "0.00000000000000",
                    "value_string": "0.000 KWD",
                    "title": "المجموع غير شامل الضريبة"
                }
            ]
        },
        "is_potential_fraud": false,
        "created_at": "2023-07-04 09:12:36",
        "updated_at": "2023-07-04 09:14:28",
        "invoice_link": "https://zid-testing-907587157081.s3-accelerate.amazonaws.com/pdf/order_44834593.pdf",
        "products_count": 1,
        "products_sum_total_string": "30.00 SAR",
        "language": "ar",
        "histories": [
            {
                "order_status_id": 1,
                "order_status_name": "جديد",
                "changed_by_id": 37,
                "changed_by_type": "عميل",
                "changed_by_details": {
                    "action": "تم إنشاء الطلب .",
                    "by": "Ahmed Al-Saud",
                    "comment": "Manually created after size-change request."
                },
                "comment": "تم إنشاء الطلب .",
                "created_at": "2023-07-04 09:12:36",
                "humanized_created_at": "منذ شهر"
            }
        ],
        "is_reactivated": false,
        "return_policy": "Returns are accepted within 14 days of receipt.",
        "packages_count": 1,
        "invoice_settings": {
            "is_order_notifications_enabled": true
        }
    },
    "message": {
        "type": "object",
        "code": "200",
        "name": "Success",
        "description": "Order details retrieved successfully."
    }
}
Previous
List of Orders
Next
Reverse Orders
Built with