Zid Docs
Get Order by ID
GETv1/managers/store/orders/{order-id}/viewGet a specific order by its ID.
:::info[]
Currency Handling for Orders
When the store currency, order currency, and the currency of the shipping address (for cash on delivery) are different, partners must convert the order total to the appropriate currency. The order details already provide both the currency type and the conversion rate, making it easy to apply the conversion when necessary. This ensures that the correct amount is processed smoothly, even when multiple currencies are involved.
:::
:::note[]
Data Masking for Marketplace Orders
When is_marketplace_order is true, the order is from an external provider, and certain customer information, such as customer.name, customer.email, and customer.phone, will be masked for privacy. For example, names like "John Doe" become "J*** D***", emails are masked as "t***@.", and phone numbers as "***00". Masked data may not follow proper syntax. Additionally, for marketplace orders, customer.phone may be null if not provided.
:::
Request
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.
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.
Preferred language for the response. Defaults to en if not specified.
Request samples
Responses
The status of the response.
The unique identifier for the order.
The code associated with the order.
The unique identifier for the store where the order was placed.
The URL link to the order's invoice.
The name of the store.
The code representing the shipping method used for the order.
The URL link to the store.
The code representing the currency used for the order.
The is_marketplace_order property indicates whether the order originates from a marketplace. When set to true, it signifies that the order was placed through a third-party marketplace platform rather than directly through the store's website.
Indicates if the consignee is different from the customer.
Indicates if the order was placed by a guest customer.
Indicates if the order is a gift.
Details of any gift card associated with the order.
ndicates whether the order was placed using a quick checkout feature.
The total amount of the order.
The total amount of the order in a human-readable format.
Indicates if the transaction currency is different from the order currency.
The reference number for the transaction.
The amount of the transaction.
The amount of the transaction in a human-readable format.
The date and time when the order was issued.
The payment status of the order.
paid: Payment has successfully completed.pending: Payment is still pending or hasn't been made yet.refunded: Payment has been refunded to the Customer.voided: Payment has been voided or canceled.
Flags the order as potentially fraudulent.
Indicates the most recent change in the payment status of the order,
by specifiying the previous (old) and the updated (new) payment statuses.
This field is particularly relevant for webhook events like order.payment_status.update.
The new status will be paid for successful payments.
The unpaid status represents any payment status other than paid,
including pending, refunded, and voided.
This categorization aligns with the merchant's view of payment statuses
on the Merchant Dashboard.
The human-readable name indicating the source where the order was created. This field is localized and provides a description of the sale channel, e.g., "Store" or "المتجر الإلكتروني".
The code indicating the source or channel of the order. This can be one of several predefined values:
- pos: Point of Sale (typically used in physical stores).
- catalog: Order was made through a product catalog or online storefront.
- md. Order was made from the Merchant Dashboard.
- mazeed_marketplace: Order was made through Mazeed.
- mazeed: Order was made at the Merchant's Store, but the Customer was redirected from Mazeed to the Merchant's Store.
- mobile_app: Order was made through the store's mobile application.
- api: Order was made through an API call, typically from third-party integrations or apps.
Indicates if the order was made by a reseller intending to sell the products to end consumers, rather than for personal use.
The date and time when the order was created.
The date and time when the order was last updated.
Specifies if the order is part of an on-demand request.
Any tags associated with the order.
Indicates if the order requires shipping.
Determines whether the merchant must set the shipping method manually.
Indicates if the Cash On Delivery (COD) payment is confirmed.
Any request for a reverse order label.
Any note provided by the customer regarding the order.
Any gift message associated with the order.
The link for payment, if applicable.
The weight of the order in grams.
Details about the cost of the weight of the order.
An array of additional options or configurations applied to the product. (e.g., color, size)
Any coupon code applied to the order.
The total number of products in the order.
The total sum of all products in the order in a human-readable format.
The language used to diplay the order's page.
A list of historical records associated with the order.
Indicates if the order was previously canceled or closed and has since been reopened or reactivated.
A human-readable string describing the return policy of the order.
The number of packages in the order.
The address of the inventory for the order.
Specifies the expected type of shipping method for the order.
Metadata associated with the reseller.
A unique reference number for tracking orders via Zidship.
The number of edits made to the order after its creation.
Timestamp indicating when the order was delivered.
The ID of the previous order, if any.
The ID of the next order, if any.
Any comments or notes about the order.
The type of the message.
The code associated with the message.
The name of the message.
A detailed description of the message.
{
"status": "object",
"order": {
"id": 44834593,
"code": "dyV6hS0VZi",
"store_id": 3,
"order_url": "https://osama.zid.store/o/dyV6hS0VZi/inv",
"store_name": "Elite Backpacks",
"shipping_method_code": "zid_app_market.2159",
"store_url": "https://osama.zid.store/",
"order_status": {
"name": "جديد",
"code": "new"
},
"currency_code": "KWD",
"customer": {
"id": 2083543,
"name": "AbdulrhmanEssa",
"email": "abdulrhmanaissa@hotmail.com",
"mobile": "966550448447",
"note": "",
"verified": 1,
"type": "individual"
},
"has_different_consignee": 0,
"is_guest_customer": 0,
"is_gift_order": 0,
"gift_card_details": null,
"is_quick_checkout_order": false,
"order_total": "0.00000000000000",
"order_total_string": "0.000 KWD",
"has_different_transaction_currency": true,
"transaction_reference": null,
"transaction_amount": 0,
"transaction_amount_string": "0.00 SAR",
"issue_date": "05-12-2024 | 03:27 م",
"payment_status": "paid",
"is_potential_fraud": false,
"source": "المتجر الإلكتروني",
"source_code": "catalog",
"is_reseller_transaction": false,
"created_at": "2024-12-05 12:27:15",
"updated_at": "2024-12-05 12:27:22",
"is_on_demand": false,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": 613287,
"name": "أرابيكسا",
"code": "zid_app_market",
"estimated_delivery_time": "",
"icon": "https://media.zid.store/apps/f19ab38d-8f5c-48b2-9124-5577803b9ae7.jpg",
"is_system_option": true,
"waybill": null,
"had_errors_while_fetching_waybill": false,
"waybill_tracking_id": null,
"has_waybill_and_packing_list": false,
"tracking": {
"number": null,
"status": "N/A",
"url": null
},
"order_shipping_status": null,
"inventory_address": [],
"courier": null,
"return_shipment": null
},
"address": {
"formatted_address": "N/A",
"street": "",
"district": "fgf",
"lat": null,
"lng": null,
"short_address": null,
"meta": null,
"city": {
"id": 365,
"name": "أبرق خيطان"
},
"country": {
"id": 114,
"name": "الكويت"
}
}
},
"payment": {
"method": {
"name": "بطاقة مدى البنكية",
"code": "zidpay",
"type": "cc",
"cart_payment_request_token": null
},
"invoice": [
{
"code": "sub_totals_before_vat",
"value": "0.00000000000000",
"value_string": "0.000 KWD",
"title": "المجموع غير شامل الضريبة"
},
{
"code": "taxable_amount",
"value": "0.00000000000000",
"value_string": "0.000 KWD",
"title": "المبلغ الخاضع للضريبة"
},
{
"code": "vat",
"value": "0.00000000000000",
"value_string": "0.000 KWD",
"title": "ضريبة القيمة المضافة (12%)"
},
{
"code": "sub_totals_after_vat",
"value": "0.00000000000000",
"value_string": "0.000 KWD",
"title": "مجموع المنتجات شامل ضريبة القيمة المضافة"
},
{
"code": "total",
"value": "0.00000000000000",
"value_string": "0.000 KWD",
"title": "المجموع الكلي"
}
]
},
"cod_confirmed": false,
"reverse_order_label_request": null,
"customer_note": "",
"gift_message": null,
"payment_link": null,
"weight": 0,
"weight_cost_details": [],
"currency": {
"order_currency": {
"id": 5,
"code": "KWD",
"exchange_rate": 0.307533
},
"order_store_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": 3.757626
}
},
"coupon": null,
"products": [
{
"id": "ea9f6732-81fe-488a-b8ac-2dbbcba505ca",
"parent_id": null,
"parent_name": null,
"product_class": null,
"name": "hh",
"short_description": null,
"sku": "Z.3.1726750799757576",
"barcode": null,
"custom_fields": [],
"quantity": 1,
"weight": null,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"is_external_product": false,
"net_price_with_additions": 0,
"net_price_with_additions_string": "0.000 KWD",
"price_with_additions": 0,
"price_with_additions_string": "0.000 KWD",
"net_price": 0,
"net_price_string": "0.000 KWD",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 0,
"gross_price_string": "0.000 KWD",
"gross_sale_price": null,
"gross_sale_price_string": null,
"price_before": null,
"price_before_string": null,
"total_before": null,
"total_before_string": null,
"gross_additions_price": 0,
"gross_additions_price_string": null,
"tax_percentage": 0.12,
"tax_amount": "0.00000000000000",
"tax_amount_string": "0.000 KWD",
"tax_amount_string_per_item": "0.000 KWD",
"price": 0,
"price_string": "0.000 KWD",
"additions_price": 0,
"additions_price_string": "0.000 KWD",
"total": 0,
"total_string": "0.000 KWD",
"images": [
{
"id": "static",
"origin": "https://media.zid.store/static/missing_image.png",
"thumbs": {
"fullSize": "https://media.zid.store/static/missing_image.png",
"thumbnail": "https://media.zid.store/static/missing_image.png",
"small": "https://media.zid.store/static/missing_image.png",
"medium": "https://media.zid.store/static/missing_image.png",
"large": "https://media.zid.store/static/missing_image.png"
}
}
],
"options": []
}
],
"products_count": 1,
"products_sum_total_string": "0.000 KWD",
"language": "ar",
"histories": [
{
"order_status_id": 1,
"order_status_name": "جديد",
"changed_by_id": 2083543,
"changed_by_type": "عميل",
"changed_by_details": {
"action": "تم إنشاء الطلب .",
"by": "AbdulrhmanEssa",
"comment": ""
},
"comment": "تم إنشاء الطلب .",
"created_at": "2024-12-05 12:27:15",
"humanized_created_at": "منذ يومين"
}
],
"is_reactivated": false,
"return_policy": "ojghwriojgbwriojgwergiou",
"packages_count": 1,
"inventory_address": null,
"expected_shipping_method_type": null,
"reseller_meta": null,
"zidship_ticket_number": null,
"edits_count": 0,
"delivered_at": null,
"is_marketplace_order": false,
"previous_order": 44827595,
"next_order": null,
"invoice_settings": {
"is_order_notifications_enabled": true
}
},
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}