Get Order by ID - Zid Docs

Get a specific order by its ID.

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.

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.

🔑Scopes

orders.read - Orders Read

Request

Path Params

order-id

number

required

Header Params

Authorization

string

required

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

required

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:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Single Order

application/json

Body

status

string

optional

The status of the response.

Example:

object

order

object (Order)

optional

integer

optional

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

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

optional

The URL link to the store.

Example:

https://zid.store/osama/

order_status

object (OrderStatus)

optional

currency_code

string

optional

The code representing the currency used for the order.

Example:

KWD

is_marketplace_order

boolean

optional

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.

Default:

false

customer

object (OrderCustomer)

optional

shipping

object (OrderShipping)

optional

products

object

optional

has_different_consignee

boolean

optional

Indicates if the consignee is different from the customer.

Example:

false

is_guest_customer

boolean

optional

Indicates if the order was placed by a guest customer.

Example:

false

is_gift_order

boolean

optional

Indicates if the order is a gift.

Example:

false

gift_card_details

object

optional

Details of any gift card associated with the order.

is_quick_checkout_order

boolean

required

ndicates whether the order was placed using a quick checkout feature.

Default:

false

order_total

string

optional

The total amount of the order.

Example:

6.00000000000000

order_total_string

string

optional

The total amount of the order in a human-readable format.

Example:

6.00 KWD

has_different_transaction_currency

boolean

optional

Indicates if the transaction currency is different from the order currency.

Example:

true

transaction_reference

string

optional

The reference number for the transaction.

Example:

TRN-123456

transaction_amount

number

optional

The amount of the transaction.

Example:

transaction_amount_string

string

optional

The amount of the transaction in a human-readable format.

Example:

60.00 SAR

issue_date

string

optional

The date and time when the order was issued.

Example:

04-07-2023 | 12:12 م

payment_status

enum<string>

optional

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.

Allowed values:

paidpendingrefundedvoided

Example:

paid

is_potential_fraud

boolean

required

Flags the order as potentially fraudulent.

Default:

false

payment_status_change

object

optional

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.

source

enum<string>

optional

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 "المتجر الإلكتروني".

Allowed values:

MazeedMazeed ServicesMerchant AdminOrder ApiStoreStore AppZidPOSOthers

Example:

Store

source_code

enum<string>

optional

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.

Allowed values:

poscatalogmdmazeedmazeed_marketplacemobile_appapi

Example:

catalog

is_reseller_transaction

boolean

optional

Indicates if the order was made by a reseller intending to sell the products to end consumers, rather than for personal use.

Example:

false

created_at

string

optional

The date and time when the order was created.

Example:

2023-07-04 09:12:36

updated_at

string

optional

The date and time when the order was last updated.

Example:

2023-07-04 09:14:28

is_on_demand

boolean

required

Specifies if the order is part of an on-demand request.

Default:

false

tags

array[string]

optional

Any tags associated with the order.

requires_shipping

boolean

optional

Indicates if the order requires shipping.

Example:

true

should_merchant_set_shipping_method

boolean

required

Determines whether the merchant must set the shipping method manually.

Default:

false

payment

object (OrderPayment)

optional

cod_confirmed

boolean

optional

Indicates if the Cash On Delivery (COD) payment is confirmed.

Example:

false

reverse_order_label_request

string | null

optional

Any request for a reverse order label.

Example:

null

customer_note

string | null

optional

Any note provided by the customer regarding the order.

Example:

أحتاج تغليف هدية

gift_message

string | null

optional

Any gift message associated with the order.

Example:

كل عام وأنتم بخير

payment_link

string | null

optional

The link for payment, if applicable.

Example:

https://payment.example.sa/order/123456

weight

number

optional

The weight of the order in grams.

Example:

500

weight_cost_details

object

optional

Details about the cost of the weight of the order.

currency

object (OrderCurrency)

optional

options

array[string]

required

An array of additional options or configurations applied to the product. (e.g., color, size)

coupon

string

optional

Any coupon code applied to the order.

Example:

SUMMER20

products_count

integer

optional

The total number of products in the order.

Example:

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 diplay the order's page.

Example:

histories

array[object (OrderHistory) {8}]

optional

A list of historical records associated with the order.

is_reactivated

boolean

optional

Indicates if the order was previously canceled or closed and has since been reopened or reactivated.

Example:

false

return_policy

string

optional

A human-readable string describing the return policy of the order.

Example:

Returns are accepted within 14 days of receipt.

packages_count

integer

optional

The number of packages in the order.

Example:

inventory_address

string

optional

The address of the inventory for the order.

Example:

123 King Fahd Road, Al Olaya, Riyadh 12212, Saudi Arabia

expected_shipping_method_type

null

required

Specifies the expected type of shipping method for the order.

reseller_meta

string | null

optional

Metadata associated with the reseller.

Example:

null

zidship_ticket_number

null

required

A unique reference number for tracking orders via Zidship.

edits_count

string

required

The number of edits made to the order after its creation.

Example:

delivered_at

null

required

Timestamp indicating when the order was delivered.

invoice_link

string

required

URL to the downloadable PDF invoice for the order.

Example:

https://zid-testing-907587157081.s3-accelerate.amazonaws.com/pdf/order_44834593.pdf

previous_order

integer

optional

The ID of the previous order, if any.

Example:

23874634

next_order

integer | null

optional

The ID of the next order, if any.

Example:

null

invoice_settings

object

optional

comment

string

optional

Any comments or notes about the order.

Example:

This is a VIP customer. Handle with extra care.

message

object (ResponseMessage)

optional

type

string

optional

The type of the message.

Example:

object

code

string

optional

The code associated with the message.

Example:

200

name

string

optional

The name of the message.

Example:

Success

description

string

optional

A detailed description of the message.

Example:

Order details retrieved successfully.

Example

{
    "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,
                "payment_network": "Visa"
            },
            "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,
        "invoice_link": "https://zid-testing-907587157081.s3-accelerate.amazonaws.com/pdf/order_44834593.pdf",
        "previous_order": 44827595,
        "next_order": null,
        "invoice_settings": {
            "is_order_notifications_enabled": true
        }
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}