# List Orders ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/managers/store/orders: get: summary: List Orders deprecated: false description: >- Orders can be created either by the customers from the storefronts or by the merchants from their dashboard. Use this endpoint to retrieve a list of orders filtered by specific parameters. :::info[] **Important Note** To retrieve products inside each order in the List Orders API, you must use the query parameter: ```js payload_type=default ``` Without this parameter, the API defaults to "`simple`", which does not include products. ::: :::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. ::: `orders.read` - Orders Read operationId: get-list-of-orders tags: - Default module/Apps/Merchant APIs/Orders - Orders parameters: - name: payload_type in: query description: > Controls the size and details of the order response. When set to "default", products are included inside each order. Other payload types return lighter responses for performance reasons. *Allowed Values* `default` | Full response including products and detailed data. (Slowest) `simple` | Lightweight response without products. *(current default)* `tiny` | Minimal response, essential identifiers only. `pos` | Optimized response for POS systems. `print` | Detailed response intended for printed invoices. `print_summary` | Summary response for printing concise receipts. required: false example: simple schema: type: string enum: - simple - tiny - pos - print - print_summary - default x-apidog-enum: - value: simple name: '' description: '' - value: tiny name: '' description: '' - value: pos name: '' description: '' - value: print name: '' description: '' - value: print_summary name: '' description: '' - value: default name: '' description: '' default: simple examples: - simple - name: page in: query description: pagination, number of page for every call required: true example: 1 schema: type: number - name: per_page in: query description: number of records for every page with max 100 records required: true example: 15 schema: type: number - name: order_status in: query description: Filter by one of the allowed values required: false example: new schema: type: string enum: - new - preparing - ready - indelivery - delivered - canceled examples: - new - name: payment_method in: query description: Filter by payment method required: false example: '' schema: type: string enum: - zid_cod - zid_bank_transfer - zid_cop - zid_credit_card examples: - zid_cod - name: customer_id in: query description: Enter the customer's id to retrieve only respective orders required: false example: 0 schema: type: number - name: date_from in: query description: 'example: ''2020-01-01T00:00:00.000+0000''' required: false example: '' schema: type: string - name: date_to in: query description: 'example: ''2020-01-01T00:00:00.000+0000''' required: false example: '' schema: type: string - name: sort_by in: query description: Sort result in a specific order required: false example: '' schema: type: string enum: - asc - desc examples: - asc - name: shipping_method in: query description: The selected method for delivering the order. required: false example: '' schema: type: string enum: - 'supports: zid_delivery.option_{id}' - zid_pickup.option_{id} - name: order_by in: query description: '' required: false example: '' schema: type: string enum: - created_at - name: status in: query description: Filter by one or multiple of the allowed values. required: false example: '' schema: type: string examples: - preparing - new - ready - name: search_term in: query description: >- Natural language lookup through (customer phone, customer email, order code, or customer name). required: false example: '966500000005' schema: type: string - name: date_attribute in: query description: created_at, or updated_at required: false example: created_at schema: type: string enum: - created_at - updated_at x-apidog-enum: - value: created_at name: '' description: '' - value: updated_at name: '' description: '' default: created_at examples: - created_at - name: referer_code in: query description: Order referer code. required: false example: - '' - YNPN79LC,string,false,,false, schema: type: array items: type: string - name: order_id in: query description: The unique identifier for the order. required: false example: 1096,125643,2222 schema: type: string - name: customer_type in: query description: Individual or business. required: false example: individual schema: type: string enum: - individual - business x-apidog-enum: - value: individual name: '' description: '' - value: business name: '' description: '' examples: - individual - name: source in: query description: order source. required: false example: mazeed schema: type: string enum: - Mazeed - Mazeed Services - Merchant Admin - Order Api - Store - Store App - ZidPOS - Others x-apidog-enum: - value: Mazeed name: '' description: Refers to operations originating from the Mazeed platform. - value: Mazeed Services name: '' description: >- Indicates services or features provided under the Mazeed Services umbrella. - value: Merchant Admin name: '' description: >- Represents actions taken through the Merchant Admin interface or portal. - value: Order Api name: '' description: >- Denotes requests made via the Order API, typically for order management and processing. - value: Store name: '' description: >- Refers to activities initiated directly from an individual store or storefront. - value: Store App name: '' description: >- Represents operations triggered from the Store mobile application. - value: ZidPOS name: '' description: >- Indicates actions originating from the ZidPOS system, typically related to point-of-sale transactions. - value: Others name: '' description: >- A generic value for sources that do not fall under predefined categories. - name: payment_status in: query description: Indicates the current payment status of the order. required: false example: pending schema: type: string enum: - pending - paid - refunded - voided x-apidog-enum: - value: pending name: '' description: Order is waiting to be paid by the customer - value: paid name: '' description: Order is already paid by the customer - value: refunded name: '' description: Order amount was refunded - value: voided name: '' description: Order was not processed and amount was not processed - name: cashier in: query description: Filter by cashier id. required: false example: eaef9285-4df8-4300-be1e-079fab62850a schema: type: string - name: country_code in: query description: Filter by country code. required: false example: sa schema: type: string - name: shipping_city in: query description: Shipping address city id. required: false example: '1' schema: type: string - name: shipping_country in: query description: Shipping address country id. required: false example: '184' schema: type: string - name: transaction_reference in: query description: 'List order transaction references. ' required: false example: '' schema: type: string - name: tags in: query description: List of order tags ids. required: false example: 02b464ec-86aa-453b-9c4e-d9e21b108c0f,string,false,,false, schema: type: string - name: coupon_id in: query description: The ID of the applied coupon. required: false example: '231' schema: type: string - name: sku in: query description: Any of the order's product sku. required: false example: ProductSku122 schema: type: string - name: is_gift_order in: query description: Indicates if the order is a gift. required: false example: '' schema: type: boolean default: false - name: Authorization in: header description: >- 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. required: true example: '{{Autherization}}' schema: type: string - name: X-Manager-Token in: header description: >- 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. required: false example: '{{Access-Token}}' schema: type: string - name: Accept-Language in: header description: >- Preferred language for the response. Defaults to `en` if not specified. required: false example: en schema: type: string enum: - en - ar examples: - en responses: '200': description: '' content: application/json: schema: type: object description: >- Orders list response including orders data, totals, UI settings, and invoice configuration. properties: status: type: string description: Response status indicator. examples: - object orders: type: array description: List of orders returned in the response. items: &ref_1 $ref: '#/components/schemas/ShortOrderSerializer' grand_total: type: integer description: Total number of orders across all pages. examples: - 517 total_order_count: type: integer description: Total number of orders in the current result. examples: - 517 total_order_count_per_status: type: object description: Order count grouped by order status. properties: ready: type: integer description: Number of orders with ready status. examples: - 517 initial: type: integer description: Number of orders with initial status. examples: - 0 new: type: integer description: Number of orders with new status. examples: - 0 preparing: type: integer description: Number of orders with preparing status. examples: - 0 indelivery: type: integer description: Number of orders with in-delivery status. examples: - 0 delivered: type: integer description: Number of orders with delivered status. examples: - 0 reversed: type: integer description: Number of orders with reversed status. examples: - 0 partially_reversed: type: integer description: Number of orders with partially reversed status. examples: - 0 reverse_in_progress: type: integer description: Number of orders with reverse in progress status. examples: - 0 canceled: type: integer description: Number of orders with canceled status. examples: - 0 cancelled: type: integer description: Number of orders with cancelled status. examples: - 0 x-apidog-orders: - ready - initial - new - preparing - indelivery - delivered - reversed - partially_reversed - reverse_in_progress - canceled - cancelled x-apidog-ignore-properties: [] tax_settings: type: array description: Tax configuration settings applied to the store. items: type: string description: Tax setting value. examples: - vat examples: - [] storeColors: type: object description: Store UI color configuration. properties: btn_default_background_color: type: string description: Default button background color. examples: - '#982abc' btn_default_text_color: type: string description: Default button text color. examples: - '#ffffff' btn_default_border_color: type: string description: Default button border color. examples: - '#982abc' btn_hover_background_color: type: string description: Button background color when hovered. examples: - '#7d229b' btn_pressed_background_color: type: string description: Button background color when pressed. examples: - '#641b7c' btn_pressed_text_color: type: string description: Button text color when pressed. examples: - '#ffffff' btn_pressed_border_color: type: string description: Button border color when pressed. examples: - '#641b7c' required: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-orders: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-ignore-properties: [] printed_invoice_settings: type: object description: Printed invoice configuration settings. properties: is_zid_invoice_generation_enabled: type: boolean description: Indicates whether Zid invoice generation is enabled. examples: - true is_tax_number_active: type: boolean description: >- Indicates whether the tax number is shown on printed invoices. examples: - true is_return_policy_active: type: boolean description: >- Indicates whether the return policy is shown on printed invoices. examples: - true is_products_weight_active: type: boolean description: >- Indicates whether product weight is shown on printed invoices. examples: - true is_products_image_active: type: boolean description: >- Indicates whether product images are shown on printed invoices. examples: - true is_barcode_active: type: boolean description: >- Indicates whether the barcode is shown on printed invoices. examples: - true is_qr_code_active: type: boolean description: >- Indicates whether the QR code is shown on printed invoices. examples: - true is_expected_time_active: type: boolean description: >- Indicates whether the expected delivery time is shown on printed invoices. examples: - true is_store_address_active: type: boolean description: >- Indicates whether the store address is shown on printed invoices. examples: - true is_vat_settings_active: type: boolean description: >- Indicates whether VAT settings are shown on printed invoices. examples: - true is_sku_active: type: boolean description: >- Indicates whether product SKU is shown on printed invoices. examples: - true is_thanks_msg_active: type: boolean description: >- Indicates whether the thank-you message is shown on printed invoices. examples: - true is_order_status_active: type: boolean description: >- Indicates whether the order status is shown on printed invoices. examples: - true is_discount_coupon_active: type: boolean description: >- Indicates whether discount coupon details are shown on printed invoices. examples: - true config_logo: type: string description: URL of the logo displayed on printed invoices. examples: - https://media.zid.store/.../logo.jpg store_business_address: type: boolean description: >- Indicates whether the store business address is shown on printed invoices. examples: - false store_business_name: type: boolean description: >- Indicates whether the store business name is shown on printed invoices. examples: - false store_business_type: type: boolean description: >- Indicates whether the store business type is shown on printed invoices. examples: - false commercial_number: type: boolean description: >- Indicates whether the commercial number is shown on printed invoices. examples: - true is_payment_stamp_active: type: boolean description: >- Indicates whether the payment stamp is shown on printed invoices. examples: - true is_order_notifications_enabled: type: boolean description: Indicates whether order notifications are enabled. examples: - true is_owner_email_notifications_enabled: type: boolean description: >- Indicates whether owner email notifications are enabled. examples: - true is_product_description_active: type: boolean description: >- Indicates whether product descriptions are shown on printed invoices. examples: - true x-apidog-orders: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-ignore-properties: [] orders_list_view_settings: type: object description: Orders list view column visibility configuration. properties: order_number_column: type: integer description: Visibility setting for the order number column. examples: - 1 customer_column: type: integer description: Visibility setting for the customer column. examples: - 1 created_at_column: type: integer description: Visibility setting for the created at column. examples: - 1 updated_at_column: type: integer description: Visibility setting for the updated at column. examples: - 1 source_column: type: integer description: Visibility setting for the source column. examples: - 1 shipping_method_column: type: integer description: Visibility setting for the shipping method column. examples: - 1 payment_method_column: type: integer description: Visibility setting for the payment method column. examples: - 1 customer_note_column: type: integer description: Visibility setting for the customer note column. examples: - 1 tags_column: type: integer description: Visibility setting for the tags column. examples: - 1 order_status_column: type: integer description: Visibility setting for the order status column. examples: - 1 payment_status_column: type: integer description: Visibility setting for the payment status column. examples: - 1 totals_column: type: integer description: Visibility setting for the totals column. examples: - 1 action_buttons: type: boolean description: >- Indicates whether action buttons are visible in the orders list. examples: - true all_columns: type: integer description: Visibility setting for all columns. examples: - 1 order_number: type: integer description: Order number display setting. examples: - 1 x-apidog-orders: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-ignore-properties: [] message: &ref_0 $ref: '#/components/schemas/ResponseEnvelopMessage' description: Additional response message details. required: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-orders: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: Simple '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '2': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '3': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '4': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: *ref_0 required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error x-200:Tiny: description: '' content: application/json: schema: type: object properties: status: type: string orders: type: array items: $ref: '#/components/schemas/TinyOrderSerializer' grand_total: type: integer total_order_count: type: integer total_order_count_per_status: type: object properties: new: type: integer preparing: type: integer indelivery: type: integer delivered: type: integer cancelled: type: integer reversed: type: integer ready: type: integer reverse_in_progress: type: integer partially_reversed: type: integer initial: type: integer required: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-orders: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-ignore-properties: [] tax_settings: type: array items: type: string storeColors: type: object properties: btn_default_background_color: type: string btn_default_text_color: type: string btn_default_border_color: type: string btn_hover_background_color: type: string btn_pressed_background_color: type: string btn_pressed_text_color: type: string btn_pressed_border_color: type: string required: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-orders: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-ignore-properties: [] printed_invoice_settings: type: object properties: is_zid_invoice_generation_enabled: type: boolean is_tax_number_active: type: boolean is_return_policy_active: type: boolean is_products_weight_active: type: boolean is_products_image_active: type: boolean is_barcode_active: type: boolean is_qr_code_active: type: boolean is_expected_time_active: type: boolean is_store_address_active: type: boolean is_vat_settings_active: type: boolean is_sku_active: type: boolean is_thanks_msg_active: type: boolean is_order_status_active: type: boolean is_discount_coupon_active: type: boolean config_logo: type: string store_business_address: type: boolean store_business_name: type: boolean store_business_type: type: boolean commercial_number: type: boolean is_payment_stamp_active: type: boolean is_order_notifications_enabled: type: boolean is_owner_email_notifications_enabled: type: boolean is_product_description_active: type: boolean required: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-orders: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-ignore-properties: [] orders_list_view_settings: type: object properties: order_number_column: type: integer customer_column: type: integer created_at_column: type: integer updated_at_column: type: integer source_column: type: integer shipping_method_column: type: integer payment_method_column: type: integer customer_note_column: type: integer tags_column: type: integer order_status_column: type: integer payment_status_column: type: integer totals_column: type: integer action_buttons: type: boolean all_columns: type: integer order_number: type: integer required: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-orders: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-ignore-properties: [] message: *ref_0 required: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-orders: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: Tiny x-200:POS: description: '' content: application/json: schema: type: object properties: status: type: string orders: type: array items: *ref_1 grand_total: type: integer total_order_count: type: integer total_order_count_per_status: type: object properties: new: type: integer preparing: type: integer indelivery: type: integer delivered: type: integer cancelled: type: integer reversed: type: integer ready: type: integer reverse_in_progress: type: integer partially_reversed: type: integer initial: type: integer required: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-orders: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-ignore-properties: [] tax_settings: type: array items: type: string storeColors: type: object properties: btn_default_background_color: type: string btn_default_text_color: type: string btn_default_border_color: type: string btn_hover_background_color: type: string btn_pressed_background_color: type: string btn_pressed_text_color: type: string btn_pressed_border_color: type: string required: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-orders: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-ignore-properties: [] printed_invoice_settings: type: object properties: is_zid_invoice_generation_enabled: type: boolean is_tax_number_active: type: boolean is_return_policy_active: type: boolean is_products_weight_active: type: boolean is_products_image_active: type: boolean is_barcode_active: type: boolean is_qr_code_active: type: boolean is_expected_time_active: type: boolean is_store_address_active: type: boolean is_vat_settings_active: type: boolean is_sku_active: type: boolean is_thanks_msg_active: type: boolean is_order_status_active: type: boolean is_discount_coupon_active: type: boolean config_logo: type: string store_business_address: type: boolean store_business_name: type: boolean store_business_type: type: boolean commercial_number: type: boolean is_payment_stamp_active: type: boolean is_order_notifications_enabled: type: boolean is_owner_email_notifications_enabled: type: boolean is_product_description_active: type: boolean required: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-orders: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-ignore-properties: [] orders_list_view_settings: type: object properties: order_number_column: type: integer customer_column: type: integer created_at_column: type: integer updated_at_column: type: integer source_column: type: integer shipping_method_column: type: integer payment_method_column: type: integer customer_note_column: type: integer tags_column: type: integer order_status_column: type: integer payment_status_column: type: integer totals_column: type: integer action_buttons: type: boolean all_columns: type: integer order_number: type: integer required: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-orders: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-ignore-properties: [] message: type: object properties: type: type: string code: type: 'null' name: type: 'null' description: type: 'null' required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-orders: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: POS x-200:Print: description: '' content: application/json: schema: type: object properties: status: type: string orders: type: array items: $ref: '#/components/schemas/PrintedAuditedOrderSerializer' grand_total: type: integer total_order_count: type: integer total_order_count_per_status: type: object properties: new: type: integer preparing: type: integer indelivery: type: integer delivered: type: integer cancelled: type: integer reversed: type: integer ready: type: integer reverse_in_progress: type: integer partially_reversed: type: integer initial: type: integer required: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-orders: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-ignore-properties: [] tax_settings: type: object properties: can_use_vat: type: boolean vat_activate: type: boolean is_vat_self_paid: type: boolean is_vat_included_in_product_price: type: boolean is_shipping_fee_included_in_vat: type: boolean other_countries_tax_percentage: type: integer countries: type: array items: type: object properties: id: type: string country: type: object properties: id: type: integer name: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] iso_code_2: type: string iso_code_3: type: string required: - id - name - iso_code_2 - iso_code_3 x-apidog-orders: - id - name - iso_code_2 - iso_code_3 x-apidog-ignore-properties: [] tax_percentage: type: number vat_number: type: string tax_registration_certificate: type: string nullable: true settings: type: array items: type: string is_certificate_visible: type: boolean is_vat_number_visible: type: boolean required: - id - country - tax_percentage - vat_number - tax_registration_certificate - settings - is_certificate_visible - is_vat_number_visible x-apidog-orders: - id - country - tax_percentage - vat_number - tax_registration_certificate - settings - is_certificate_visible - is_vat_number_visible x-apidog-ignore-properties: [] required: - can_use_vat - vat_activate - is_vat_self_paid - is_vat_included_in_product_price - is_shipping_fee_included_in_vat - other_countries_tax_percentage - countries x-apidog-orders: - can_use_vat - vat_activate - is_vat_self_paid - is_vat_included_in_product_price - is_shipping_fee_included_in_vat - other_countries_tax_percentage - countries x-apidog-ignore-properties: [] storeColors: type: object properties: btn_default_background_color: type: string btn_default_text_color: type: string btn_default_border_color: type: string btn_hover_background_color: type: string btn_pressed_background_color: type: string btn_pressed_text_color: type: string btn_pressed_border_color: type: string required: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-orders: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-ignore-properties: [] printed_invoice_settings: type: object properties: is_zid_invoice_generation_enabled: type: boolean is_tax_number_active: type: boolean is_return_policy_active: type: boolean is_products_weight_active: type: boolean is_products_image_active: type: boolean is_barcode_active: type: boolean is_qr_code_active: type: boolean is_expected_time_active: type: boolean is_store_address_active: type: boolean is_vat_settings_active: type: boolean is_sku_active: type: boolean is_thanks_msg_active: type: boolean is_order_status_active: type: boolean is_discount_coupon_active: type: boolean config_logo: type: string store_business_address: type: boolean store_business_name: type: boolean store_business_type: type: boolean commercial_number: type: boolean is_payment_stamp_active: type: boolean is_order_notifications_enabled: type: boolean is_owner_email_notifications_enabled: type: boolean is_product_description_active: type: boolean required: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-orders: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-ignore-properties: [] orders_list_view_settings: type: object properties: order_number_column: type: integer customer_column: type: integer created_at_column: type: integer updated_at_column: type: integer source_column: type: integer shipping_method_column: type: integer payment_method_column: type: integer customer_note_column: type: integer tags_column: type: integer order_status_column: type: integer payment_status_column: type: integer totals_column: type: integer action_buttons: type: boolean all_columns: type: integer order_number: type: integer required: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-orders: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-ignore-properties: [] message: type: object properties: type: type: string code: type: 'null' name: type: 'null' description: type: 'null' required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-orders: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: Print x-200:Print Summary: description: '' content: application/json: schema: type: object properties: status: type: string orders: type: array items: $ref: '#/components/schemas/PrintedOrderSerializer' grand_total: type: integer total_order_count: type: integer total_order_count_per_status: type: object properties: new: type: integer preparing: type: integer indelivery: type: integer delivered: type: integer cancelled: type: integer reversed: type: integer ready: type: integer reverse_in_progress: type: integer partially_reversed: type: integer initial: type: integer required: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-orders: - new - preparing - indelivery - delivered - cancelled - reversed - ready - reverse_in_progress - partially_reversed - initial x-apidog-ignore-properties: [] tax_settings: type: object properties: can_use_vat: type: boolean vat_activate: type: boolean is_vat_self_paid: type: boolean is_vat_included_in_product_price: type: boolean is_shipping_fee_included_in_vat: type: boolean other_countries_tax_percentage: type: integer countries: type: array items: type: object properties: id: type: string country: type: object properties: id: type: integer name: type: object properties: ar: type: string en: type: string required: - ar - en x-apidog-orders: - ar - en x-apidog-ignore-properties: [] iso_code_2: type: string iso_code_3: type: string required: - id - name - iso_code_2 - iso_code_3 x-apidog-orders: - id - name - iso_code_2 - iso_code_3 x-apidog-ignore-properties: [] tax_percentage: type: number vat_number: type: string tax_registration_certificate: type: string nullable: true settings: type: array items: type: string is_certificate_visible: type: boolean is_vat_number_visible: type: boolean required: - id - country - tax_percentage - vat_number - tax_registration_certificate - settings - is_certificate_visible - is_vat_number_visible x-apidog-orders: - id - country - tax_percentage - vat_number - tax_registration_certificate - settings - is_certificate_visible - is_vat_number_visible x-apidog-ignore-properties: [] required: - can_use_vat - vat_activate - is_vat_self_paid - is_vat_included_in_product_price - is_shipping_fee_included_in_vat - other_countries_tax_percentage - countries x-apidog-orders: - can_use_vat - vat_activate - is_vat_self_paid - is_vat_included_in_product_price - is_shipping_fee_included_in_vat - other_countries_tax_percentage - countries x-apidog-ignore-properties: [] storeColors: type: object properties: btn_default_background_color: type: string btn_default_text_color: type: string btn_default_border_color: type: string btn_hover_background_color: type: string btn_pressed_background_color: type: string btn_pressed_text_color: type: string btn_pressed_border_color: type: string required: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-orders: - btn_default_background_color - btn_default_text_color - btn_default_border_color - btn_hover_background_color - btn_pressed_background_color - btn_pressed_text_color - btn_pressed_border_color x-apidog-ignore-properties: [] printed_invoice_settings: type: object properties: is_zid_invoice_generation_enabled: type: boolean is_tax_number_active: type: boolean is_return_policy_active: type: boolean is_products_weight_active: type: boolean is_products_image_active: type: boolean is_barcode_active: type: boolean is_qr_code_active: type: boolean is_expected_time_active: type: boolean is_store_address_active: type: boolean is_vat_settings_active: type: boolean is_sku_active: type: boolean is_thanks_msg_active: type: boolean is_order_status_active: type: boolean is_discount_coupon_active: type: boolean config_logo: type: string store_business_address: type: boolean store_business_name: type: boolean store_business_type: type: boolean commercial_number: type: boolean is_payment_stamp_active: type: boolean is_order_notifications_enabled: type: boolean is_owner_email_notifications_enabled: type: boolean is_product_description_active: type: boolean required: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-orders: - is_zid_invoice_generation_enabled - is_tax_number_active - is_return_policy_active - is_products_weight_active - is_products_image_active - is_barcode_active - is_qr_code_active - is_expected_time_active - is_store_address_active - is_vat_settings_active - is_sku_active - is_thanks_msg_active - is_order_status_active - is_discount_coupon_active - config_logo - store_business_address - store_business_name - store_business_type - commercial_number - is_payment_stamp_active - is_order_notifications_enabled - is_owner_email_notifications_enabled - is_product_description_active x-apidog-ignore-properties: [] orders_list_view_settings: type: object properties: order_number_column: type: integer customer_column: type: integer created_at_column: type: integer updated_at_column: type: integer source_column: type: integer shipping_method_column: type: integer payment_method_column: type: integer customer_note_column: type: integer tags_column: type: integer order_status_column: type: integer payment_status_column: type: integer totals_column: type: integer action_buttons: type: boolean all_columns: type: integer order_number: type: integer required: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-orders: - order_number_column - customer_column - created_at_column - updated_at_column - source_column - shipping_method_column - payment_method_column - customer_note_column - tags_column - order_status_column - payment_status_column - totals_column - action_buttons - all_columns - order_number x-apidog-ignore-properties: [] message: *ref_0 required: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-orders: - status - orders - grand_total - total_order_count - total_order_count_per_status - tax_settings - storeColors - printed_invoice_settings - orders_list_view_settings - message x-apidog-ignore-properties: [] example: status: object orders: - id: 64102971 invoice_number: 64102971 code: gsQNlvfHmT store_id: 3 order_url: https://osama.zid.store/o/gsQNlvfHmT/inv store_name: متجر أسامة. shipping_method_code: zid_app_market.2323 store_url: https://osama.zid.store/ order_status: name: New code: new display_status: id: 1 code: new color: '#3498db' name: New currency_code: SAR customer: id: 59292 name: new test sokolov 6 email: b.alenezi@zid.sa mobile: '966591555966' 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: '100003.44948170000000' order_total_string: 100,003.45 SAR has_different_transaction_currency: false transaction_reference: null transaction_amount: 100003.4494817 transaction_amount_string: 100,003.45 SAR issue_date: 29-01-2026 | 12:20 ص payment_status: paid is_potential_fraud: false source: Merchant Admin source_code: md is_reseller_transaction: false created_at: '2026-01-28 21:20:01' updated_at: '2026-01-28 21:20:04' is_on_demand: false import_id: null products: - id: 36a8ecc9-e5b2-4cda-ae51-3e7606cf5ebd order_product_id: 110199370 parent_id: null parent_name: null product_class: dynamic_bundle name: sdfd short_description: null sku: Z.17654467807426183 barcode: null custom_fields: [] quantity: 1 weight: null is_taxable: true is_discounted: false meta: null is_external_product: false discounts: [] net_price_with_additions: 86956.521288434 net_price_with_additions_string: 86,956.52 SAR price_with_additions: 99999.999481699 price_with_additions_string: 100,000.00 SAR net_price: 86956.521288434 net_price_string: 86,956.52 SAR net_sale_price: null net_sale_price_string: null net_additions_price: 0 net_additions_price_string: null gross_price: 99999.999481699 gross_price_string: 100,000.00 SAR 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 discount_percentage: 0 tax_percentage: 0.15 tax_amount: '13043.47819326500000' tax_amount_string: 13,043.48 SAR tax_amount_string_per_item: 13,043.47 SAR discounted_tax_amount: 13043.4781932651 discounted_tax_amount_string: 13,043.48 SAR discounted_tax_amount_string_per_item: 13,043.48 SAR price: 99999.999481699 price_string: 100,000.00 SAR additions_price: 0 additions_price_string: 0.00 SAR total: 99999.999481699 total_string: 100,000.00 SAR discounted_total: 99999.9994816991 discounted_total_string: 100,000.00 SAR 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: [] inventory_allocations: [] bundle_products: Selection 1: - id: 19b603a8-3134-4fb8-ac41-c4c8eabee6fd name: otro sku: Z.3.17436018386870754 quantity: 1 images: - id: d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b origin: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b-thumbnail-500x500-70.jpg thumbs: fullSize: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b.jpg thumbnail: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b-thumbnail-370x370-70.jpg small: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b-thumbnail-500x500-70.jpg medium: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b-thumbnail-770x770-70.jpg large: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/d76d65f4-c5ae-4ef1-af03-1ea6a3f6741b-thumbnail-1000x1000-70.jpg shipping: address: formatted_address: N/A street: Ee district: Ee lat: null lng: null short_address: null meta: building_number: Ee postcode: '33' city: id: 24 name: Dammam country: id: 184 name: Saudi Arabia method: code: zid_app_market.2323 name: 3rd Partner estimated_delivery_time: '' tracking_number: null payment: invoice: - code: sub_totals_before_vat value: '86956.52128843400000' value_string: 86,956.52 SAR title: Total without VAT - code: shipping value: '3.00000000000000' value_string: 3.00 SAR title: Shipping - code: taxable_amount value: '86959.52128843400000' value_string: 86,959.52 SAR title: Taxable amount - code: vat value: '13043.92819326500000' value_string: 13,043.93 SAR title: VAT (%15) - code: sub_totals_after_vat value: '100003.44948170000000' value_string: 100,003.45 SAR title: Total Inc. VAT - code: total value: '100003.44948170000000' value_string: 100,003.45 SAR title: Total method: zid_bank_transfer invoice_link: null payment_method: name: Bank Transfer customer_note: '' return_policy: ojghwriojgbwriojgwergiou store_address: ' Saudi Arabia Riyadh 1 1' cod_confirmed: false store_vat_settings: id: d67b7b57-f2af-47fb-980c-036904c9389f country: id: 184 name: ar: السعودية en: Saudi Arabia iso_code_2: SA iso_code_3: SAU tax_percentage: 0.15 vat_number: '311111111111113' tax_registration_certificate: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/c9cffe44-cea7-4103-851c-6309e5660921.png settings: [] is_certificate_visible: false is_vat_number_visible: true can_use_vat: true vat_activate: true is_vat_self_paid: true is_vat_included_in_product_price: true is_shipping_fee_included_in_vat: true other_countries_tax_percentage: 0 products_sum_total_string: 100,000.00 SAR coupon: null is_marketplace_order: false - id: 64086815 invoice_number: 64086815 code: hK0w7KCJzo store_id: 3 order_url: https://osama.zid.store/o/hK0w7KCJzo/inv store_name: متجر أسامة. shipping_method_code: custom store_url: https://osama.zid.store/ order_status: name: New code: new display_status: id: 1 code: new color: '#3498db' name: New currency_code: SAR customer: id: 15141670 name: Zid Test Customer email: a.alkallas@zid.sa mobile: '966500000005' note: >- This is a demo order for the purpose of testing the system. Please cancel this order. 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: '201.85999896568000' order_total_string: 201.86 SAR has_different_transaction_currency: false transaction_reference: null transaction_amount: 201.85999896568 transaction_amount_string: 201.86 SAR issue_date: 28-01-2026 | 07:52 م payment_status: pending is_potential_fraud: false source: Order API source_code: api is_reseller_transaction: false created_at: '2026-01-28 16:52:58' updated_at: '2026-01-28 16:53:04' is_on_demand: false import_id: null products: - id: 003140e2-9d8e-462d-b823-373407746871 order_product_id: 110168319 parent_id: null parent_name: null product_class: null name: طقم سفر للحواجب سوبرستار من بنفت short_description: ar: '' en: '' sku: Z.217795.169603646831188 barcode: null custom_fields: [] quantity: 1 weight: null is_taxable: true is_discounted: false meta: null is_external_product: false discounts: [] net_price_with_additions: 173.5304338832 net_price_with_additions_string: 173.53 SAR price_with_additions: 199.55999896568 price_with_additions_string: 199.56 SAR net_price: 173.5304338832 net_price_string: 173.53 SAR net_sale_price: null net_sale_price_string: null net_additions_price: 0 net_additions_price_string: null gross_price: 199.55999896568 gross_price_string: 199.56 SAR 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 discount_percentage: 0 tax_percentage: 0.15 tax_amount: '26.02956508248000' tax_amount_string: 26.03 SAR tax_amount_string_per_item: 26.02 SAR discounted_tax_amount: 26.02956508248 discounted_tax_amount_string: 26.03 SAR discounted_tax_amount_string_per_item: 26.03 SAR price: 199.55999896568 price_string: 199.56 SAR additions_price: 0 additions_price_string: 0.00 SAR total: 199.55999896568 total_string: 199.56 SAR discounted_total: 199.55999896568 discounted_total_string: 199.56 SAR images: - id: 88e42c96-ad48-4519-9ea9-1e4632eec3c7 origin: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-500x500-70.jpg thumbs: fullSize: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7.jpg thumbnail: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-370x370-70.jpg small: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-500x500-70.jpg medium: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-770x770-70.jpg large: >- https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-1000x1000-70.jpg options: [] inventory_allocations: [] shipping: address: formatted_address: N/A street: King Fahd Road district: Building 12 lat: null lng: null short_address: null meta: null city: id: 1 name: Riyadh country: id: 184 name: Saudi Arabia method: code: custom name: ارامكس estimated_delivery_time: '' tracking_number: null payment: invoice: - code: sub_totals_before_vat value: '173.53043388320000' value_string: 173.53 SAR title: Total without VAT - code: shipping value: '2.00000000000000' value_string: 2.00 SAR title: Shipping - code: taxable_amount value: '175.53043388320000' value_string: 175.53 SAR title: Taxable amount - code: vat value: '26.32956508248000' value_string: 26.33 SAR title: VAT (%15) - code: sub_totals_after_vat value: '201.85999896568000' value_string: 201.86 SAR title: Total Inc. VAT - code: total value: '201.85999896568000' value_string: 201.86 SAR title: Total method: zid_cod invoice_link: null payment_method: name: Cash on Delivery customer_note: >- This is a demo order for the purpose of testing the system. Please cancel this order. return_policy: ojghwriojgbwriojgwergiou store_address: ' Saudi Arabia Riyadh 1 1' cod_confirmed: false store_vat_settings: id: d67b7b57-f2af-47fb-980c-036904c9389f country: id: 184 name: ar: السعودية en: Saudi Arabia iso_code_2: SA iso_code_3: SAU tax_percentage: 0.15 vat_number: '311111111111113' tax_registration_certificate: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/c9cffe44-cea7-4103-851c-6309e5660921.png settings: [] is_certificate_visible: false is_vat_number_visible: true can_use_vat: true vat_activate: true is_vat_self_paid: true is_vat_included_in_product_price: true is_shipping_fee_included_in_vat: true other_countries_tax_percentage: 0 products_sum_total_string: 199.56 SAR coupon: null is_marketplace_order: false grand_total: 10444 total_order_count: 10444 total_order_count_per_status: new: 6482 preparing: 566 indelivery: 25 delivered: 1861 cancelled: 884 reversed: 44 ready: 517 reverse_in_progress: 63 partially_reversed: 2 initial: 0 tax_settings: can_use_vat: true vat_activate: true is_vat_self_paid: true is_vat_included_in_product_price: true is_shipping_fee_included_in_vat: true other_countries_tax_percentage: 0 countries: - id: e108f033-5c13-45d3-80fb-926567c29dd3 country: id: 114 name: ar: الكويت en: Kuwait iso_code_2: KW iso_code_3: KWT tax_percentage: 0.12 vat_number: '3123122' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: true - id: 3d9326bc-6b48-4a18-a8fe-f6cac859cbd2 country: id: 17 name: ar: البحرين en: Bahrain iso_code_2: BH iso_code_3: BHR tax_percentage: 0.02 vat_number: '32432' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: true - id: 991e4367-46af-4dd2-bced-9ecdcae9e7f3 country: id: 63 name: ar: مصر en: Egypt iso_code_2: EG iso_code_3: EGY tax_percentage: 0.5 vat_number: '7714' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: false - id: d67b7b57-f2af-47fb-980c-036904c9389f country: id: 184 name: ar: السعودية en: Saudi Arabia iso_code_2: SA iso_code_3: SAU tax_percentage: 0.15 vat_number: '311111111111113' tax_registration_certificate: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/c9cffe44-cea7-4103-851c-6309e5660921.png settings: [] is_certificate_visible: false is_vat_number_visible: true - id: 2f87d835-df91-4a38-a4b2-12c5b8ca4616 country: id: 161 name: ar: عمان en: Oman iso_code_2: OM iso_code_3: OMN tax_percentage: 0.15 vat_number: '2323' tax_registration_certificate: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/88732f5e-ff45-422b-823a-f2495a0d3bec.jpg settings: [] is_certificate_visible: true is_vat_number_visible: true - id: 8839f2b7-6de5-4251-8cac-552f14ee751e country: id: 215 name: ar: تركيا en: Turkey iso_code_2: TR iso_code_3: TUR tax_percentage: 0.15 vat_number: '8575775585885' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: true - id: aabb35c8-aebe-4867-8c0b-4c8b63239822 country: id: 221 name: ar: الإمارات العربية المتحدة en: UAE iso_code_2: AE iso_code_3: ARE tax_percentage: 0 vat_number: '111111111111' tax_registration_certificate: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/678a3974-f59b-451d-991a-fbc06c464dee.jpg settings: [] is_certificate_visible: false is_vat_number_visible: false - id: 72ad3ca4-cf2d-441e-9d93-78e730878822 country: id: 121 name: ar: ليبيا en: Libya iso_code_2: LY iso_code_3: LBY tax_percentage: 0.1 vat_number: 1fgfef tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: false - id: 663c9fe0-2095-4350-b084-d58191394a5b country: id: 2 name: ar: ألبانيا en: Albania iso_code_2: AL iso_code_3: ALB tax_percentage: 0.5 vat_number: '7714' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: false - id: f04d199f-e590-4666-92b7-1a3b813bfb34 country: id: 144 name: ar: المغرب en: Morocco iso_code_2: MA iso_code_3: MAR tax_percentage: 0.23 vat_number: '2793' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: false - id: bf9959ec-c333-41c4-bd6b-52e3927caf70 country: id: 173 name: ar: قطر en: Qatar iso_code_2: QA iso_code_3: QAT tax_percentage: 0.99 vat_number: '123' tax_registration_certificate: null settings: [] is_certificate_visible: false is_vat_number_visible: false storeColors: btn_default_background_color: '#965aaa' btn_default_text_color: '#502a2a' btn_default_border_color: '#7d0909' btn_hover_background_color: '#960a0a' btn_pressed_background_color: '#7d0909' btn_pressed_text_color: '#f8d3d3' btn_pressed_border_color: '#7d0909' printed_invoice_settings: is_zid_invoice_generation_enabled: true is_tax_number_active: true is_return_policy_active: true is_products_weight_active: true is_products_image_active: true is_barcode_active: true is_qr_code_active: true is_expected_time_active: true is_store_address_active: true is_vat_settings_active: true is_sku_active: true is_thanks_msg_active: true is_order_status_active: true is_discount_coupon_active: true config_logo: >- https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/0e959ed7-ced5-47df-b839-16969940db08-200x.jpg store_business_address: false store_business_name: false store_business_type: false commercial_number: true is_payment_stamp_active: true is_order_notifications_enabled: true is_owner_email_notifications_enabled: true is_product_description_active: true orders_list_view_settings: order_number_column: 1 customer_column: 1 created_at_column: 1 updated_at_column: 1 source_column: 1 shipping_method_column: 1 payment_method_column: 1 customer_note_column: 1 tags_column: 1 order_status_column: 1 payment_status_column: 1 totals_column: 1 action_buttons: true all_columns: 1 order_number: 1 message: type: object code: null name: null description: null headers: {} x-apidog-name: Print Summary security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Orders x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9148543-run components: schemas: ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' ShortOrderSerializer: type: object properties: id: type: integer examples: - 60407024 description: Unique identifier of the order. invoice_number: type: integer examples: - 60407024 description: The invoice number associated with the order. code: type: string examples: - YMK3VPgkhy description: Unique order code generated for the order. nullable: true store_id: type: integer examples: - 3 description: Unique identifier of the store where the order was placed. order_url: type: string examples: - https://osama.zid.store/o/YMK3VPgkhy/inv description: URL of the order details page. store_name: type: string examples: - متجر أسامة description: Name of the store associated with the order. shipping_method_code: type: string examples: - zid_zidship.level_2 description: Code of the shipping method selected for the order. nullable: true store_url: type: string examples: - https://osama.zid.store/ description: Store domain or URL. currency_code: type: string examples: - SAR description: Currency code used for the order amount (e.g., SAR, USD). nullable: true order_status: &ref_5 $ref: '#/components/schemas/OrderStatus' description: The status of the order. display_status: &ref_6 $ref: '#/components/schemas/OrderDisplayStatus' description: Display status of the order. customer: &ref_3 $ref: '#/components/schemas/DefaultOrderCustomerSerializer' description: Customer information associated with the order. has_different_consignee: type: integer description: >- Indicates whether the consignee information differs from the customer information. nullable: true is_guest_customer: type: integer description: >- Indicates whether the order was placed by a guest customer without a registered account. nullable: true is_gift_order: type: integer description: Indicates whether the order is marked as a gift order. gift_card_details: type: object properties: {} x-apidog-orders: [] description: >- Contains gift card-related details associated with the order. Returns null if the order does not include a gift card. x-apidog-ignore-properties: [] nullable: true is_quick_checkout_order: type: boolean description: >- Indicates whether the order was placed using the quick checkout flow. order_total: anyOf: - type: string description: String representation of the total order amount. - type: number description: Numeric value of the total order amount. description: Raw order total value. order_total_string: type: string examples: - 124.15 SAR description: >- Formatted order total amount as a string, including currency formatting if applicable. has_different_transaction_currency: type: boolean description: >- Indicates whether the transaction currency differs from the store currency. transaction_reference: type: string description: >- Reference number or identifier associated with the payment transaction. nullable: true transaction_amount: type: number examples: - 124.1499994817 description: The total transaction amount paid by the customer. transaction_amount_string: type: string examples: - 124.15 SAR description: Formatted transaction amount as a string. issue_date: type: string description: Date when the order or invoice was issued. payment_status: type: string examples: - pending enum: - pending - paid - refunded - voided x-apidog-enum: - value: pending name: '' description: '' - value: paid name: '' description: '' - value: refunded name: '' description: '' - value: voided name: '' description: '' description: Current payment status of the order. is_potential_fraud: type: boolean description: >- Indicates whether the order has been flagged as potentially fraudulent. source: type: string description: >- Source from which the order was created (e.g., web, POS, mobile app). source_code: type: string description: System-defined code representing the order source. nullable: true is_reseller_transaction: type: boolean description: >- Indicates whether the transaction was created through a reseller channel. created_at: type: string examples: - '2025-11-12 08:57:35' description: Timestamp indicating when the order was created. updated_at: type: string examples: - '2026-01-26 07:18:19' description: Timestamp indicating when the order was last updated. is_on_demand: type: boolean description: Indicates whether the order contains on-demand products or services. import_id: type: string description: Identifier associated with the imported order record. nullable: true store_logo: type: string description: URL of the store logo image. nullable: true store_uuid: type: string description: Unique UUID identifier of the store. nullable: true tags: type: array items: $ref: '#/components/schemas/OrderTagPresenter' description: Collection of tag objects attached to the order. description: List of tags associated with the order. requires_shipping: type: boolean description: Indicates whether the order requires shipping fulfillment. should_merchant_set_shipping_method: type: boolean description: >- Indicates whether the merchant is required to manually select or assign the shipping method. shipping: type: object properties: method: $ref: '#/components/schemas/OrderShippingMethodPresenter' description: Shipping method details associated with the order. address: &ref_4 $ref: '#/components/schemas/DefaultOrderShippingAddressSerializer' description: Shipping address details for the order delivery. required: - method - address x-apidog-orders: - method - address description: Contains shipping-related information for the order. x-apidog-ignore-properties: [] payment: type: object properties: method: $ref: '#/components/schemas/DefaultOrderPaymentMethodSerializer' description: Payment method details used for the order transaction. split_payments: type: array items: description: Collection of split payment objects. type: object properties: name: type: string description: Display name of the split payment method. code: type: string description: System-defined code representing the split payment method. amount: type: number description: Amount paid using this split payment method. amount_string: type: string description: Formatted split payment amount as a string. near_pay_transaction_uuid: type: string description: Unique identifier of the NearPay transaction. near_pay_transaction_details: type: string description: Additional details related to the NearPay transaction. x-apidog-refs: {} x-apidog-orders: - name - code - amount - amount_string - near_pay_transaction_uuid - near_pay_transaction_details required: - name - code - amount - amount_string x-apidog-ignore-properties: [] description: List of split payment entries associated with the order. required: - method x-apidog-orders: - method - split_payments description: Contains payment-related information for the order. x-apidog-ignore-properties: [] cod_confirmed: type: boolean description: >- Indicates whether the Cash on Delivery (COD) order has been confirmed. reverse_order_label_request: &ref_2 $ref: '#/components/schemas/OrderReversePresenter' description: >- Contains reverse shipment or return label request details for the order. reverse_order_label_requests: type: array items: *ref_2 description: >- Contains reverse shipment or return label request details for the order. required: - id - invoice_number - code - store_id - order_url - store_name - shipping_method_code - store_url - currency_code - order_status - display_status - customer - has_different_consignee - is_guest_customer - is_gift_order - gift_card_details - is_quick_checkout_order - order_total - order_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - issue_date - payment_status - is_potential_fraud - source - source_code - is_reseller_transaction - created_at - updated_at - is_on_demand - import_id - tags - requires_shipping - should_merchant_set_shipping_method - shipping - payment - cod_confirmed - reverse_order_label_request - reverse_order_label_requests description: Order summary object. x-apidog-orders: - id - invoice_number - code - store_id - order_url - store_name - shipping_method_code - store_url - currency_code - order_status - display_status - customer - has_different_consignee - is_guest_customer - is_gift_order - gift_card_details - is_quick_checkout_order - order_total - order_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - issue_date - payment_status - is_potential_fraud - source - source_code - is_reseller_transaction - created_at - updated_at - is_on_demand - import_id - store_logo - store_uuid - tags - requires_shipping - should_merchant_set_shipping_method - shipping - payment - cod_confirmed - reverse_order_label_request - reverse_order_label_requests x-apidog-ignore-properties: [] x-apidog-folder: '' OrderReversePresenter: type: object properties: id: type: string description: Unique identifier of the reverse order label request. store_id: type: string description: >- Unique identifier of the store associated with the reverse label request. order_id: type: integer description: Unique identifier of the related order. is_partial: type: integer description: Indicates whether the reverse request is for a partial order return. consignee_name: type: string description: Name of the consignee associated with the reverse shipment request. consignee_mobile: type: string description: >- Mobile number of the consignee associated with the reverse shipment request. consignee_city: type: object properties: {} x-apidog-orders: [] description: >- City information of the consignee associated with the reverse shipment request. x-apidog-ignore-properties: [] nullable: true consignee_address_1: type: string description: Primary address line of the consignee (customer). consignee_address_2: type: string description: >- Secondary address line of the consignee (customer). Typically used for apartment numbers, building names, or additional location details. inventory_address_id: type: integer description: >- Unique identifier of the inventory address from which the return will be processed. nullable: true inventory_location_id: type: string description: >- Identifier of the specific inventory location (warehouse, branch, or fulfillment center) handling the reverse order. nullable: true inventory: type: object properties: {} x-apidog-orders: [] description: >- Object containing inventory-related details for the reverse process. This may include stock adjustments, warehouse metadata, or internal handling info depending on implementation. x-apidog-ignore-properties: [] nullable: true reason: type: array items: type: string description: >- List of reasons provided for returning the order or products. Multiple reasons can be included if applicable. shipping_method: type: string description: >- The shipping method used for the reverse order (return shipment). This should match supported shipping methods configured in the system. nullable: true waybill: type: object properties: {} x-apidog-orders: [] description: >- Object containing shipment tracking and logistics details for the return. x-apidog-ignore-properties: [] nullable: true products: type: array items: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] description: >- List of products included in the reverse order. Each object represents a product being returned, including quantity and identifiers. x-apidog-orders: - id - store_id - order_id - is_partial - consignee_name - consignee_mobile - consignee_city - consignee_address_1 - consignee_address_2 - inventory_address_id - inventory_location_id - inventory - reason - shipping_method - waybill - products required: - id - store_id - order_id - is_partial - consignee_name - consignee_mobile - consignee_city - consignee_address_1 - consignee_address_2 - inventory_address_id - inventory_location_id - inventory - reason - shipping_method - waybill - products x-apidog-ignore-properties: [] nullable: true x-apidog-folder: '' DefaultOrderPaymentMethodSerializer: type: object properties: name: type: string description: Display name of the payment method used for the order. nullable: true code: type: string enum: - hyperpay - payfort - paytabs - payfort_fort_sadad - payfort_visa_master_mada - gate2play_visa_master_mada - moyasar - moyasar_visa_master_mada - zidpay - payment_link.zidpay - gate2play - zid_sadad - prepaid_stcpay - tap - tap_visa_master_mada - tamara - tabby - mispay - zid_bank_transfer - bank_transfer - zid_cod - zid_cop - pos-cash - pos-terminal - pos - pos-cc - pos-nearpay - pos-split - pos-terminal-surepay - pos-pm - prepaid_mazeed - pp_standard - free_checkout - pos-tamara - emkan - pos-payment-link - prepaid_amazon - madfu - pos-tabby - prepaid_trendyol - prepaid_import - prepaid_subscription - payfort_fort - cod x-apidog-enum: - value: hyperpay name: Hyperpay description: '' - value: payfort name: Payfort description: '' - value: paytabs name: PayTabs description: '' - value: payfort_fort_sadad name: Payfort description: '' - value: payfort_visa_master_mada name: Payfort description: '' - value: gate2play_visa_master_mada name: Hyperpay description: '' - value: moyasar name: Moyasar description: '' - value: moyasar_visa_master_mada name: Moyasar description: '' - value: zidpay name: ZidPay description: '' - value: payment_link.zidpay name: ZidPay description: '' - value: gate2play name: Hyperpay description: '' - value: zid_sadad name: zid Sadad description: '' - value: prepaid_stcpay name: prepaid_stcpay description: '' - value: tap name: Tap description: '' - value: tap_visa_master_mada name: Tap description: '' - value: tamara name: Tamara description: '' - value: tabby name: Tabby description: '' - value: mispay name: Mispay description: '' - value: zid_bank_transfer name: Bank Transfer description: '' - value: bank_transfer name: bank_transfer description: '' - value: zid_cod name: Cash on Delivery description: '' - value: zid_cop name: Cash on Pickup description: '' - value: pos-cash name: POS-CASH description: '' - value: pos-terminal name: POS TERMINAL description: '' - value: pos name: POS description: '' - value: pos-cc name: POS CC description: '' - value: pos-nearpay name: POS nearpay description: '' - value: pos-split name: POS Split description: '' - value: pos-terminal-surepay name: POS Terminal Surepay description: '' - value: pos-pm name: POS-PM description: '' - value: prepaid_mazeed name: prepaid_mazeed description: '' - value: pp_standard name: pp_standard description: '' - value: free_checkout name: free_checkout description: '' - value: pos-tamara name: POS TAMARA description: '' - value: emkan name: Emkan description: '' - value: pos-payment-link name: Pos Payment Link description: '' - value: prepaid_amazon name: Prepaid Amazon description: '' - value: madfu name: Madfu description: '' - value: pos-tabby name: Pos Tabby description: '' - value: prepaid_trendyol name: Prepaid Trendyol description: '' - value: prepaid_import name: Prepaid Import description: '' - value: prepaid_subscription name: Prepaid Subscription description: '' - value: payfort_fort name: Payfort description: '' - value: cod name: COD description: '' description: >- Internal code representing the payment method. Used for integrations and system-level identification. type: type: string description: Type/category of the payment method. cart_payment_request_token: type: string description: If showing a single order and the payment method is online payment nullable: true transaction_status: type: string description: if order payment method is a banck transfer transaction_status_name: type: string description: if order payment method is a banck transfer transaction_bank: type: string description: if order payment method is a banck transfer nullable: true transaction_slip: type: string description: if order payment method is a banck transfer nullable: true transaction_sender_name: type: string description: if order payment method is a banck transfer nullable: true updated_at: type: string description: if order payment method is a banck transfer nullable: true required: - name - code - type x-apidog-orders: - name - code - type - cart_payment_request_token - transaction_status - transaction_status_name - transaction_bank - transaction_slip - transaction_sender_name - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderShippingAddressSerializer: type: object properties: formatted_address: type: string description: Formatted full shipping address. nullable: true street: type: string description: Street name or primary address line. district: type: string description: District or area of the shipping address. lat: type: number description: Latitude coordinate of the shipping address. nullable: true lng: type: number description: >- Longitude coordinate of the shipping address location. Used for mapping, delivery routing, and logistics optimization. nullable: true short_address: type: string description: >- A concise, human-readable version of the shipping address. Typically used for quick display in UI or summaries. nullable: true meta: type: object properties: building_number: type: string description: Building number of the shipping address. nullable: true postcode: type: string description: Postal or ZIP code of the address. nullable: true additional_number: type: string description: >- Additional number used in certain national addressing systems (e.g., Saudi address system). nullable: true city_name: type: string description: Name of the city as provided in the address metadata. nullable: true x-apidog-orders: - building_number - postcode - additional_number - city_name description: >- Additional structured address details, typically aligned with national addressing systems (e.g., Saudi National Address). x-apidog-ignore-properties: [] nullable: true city: type: object properties: id: type: integer description: Unique identifier of the city. name: type: string description: Name of the city. nullable: true required: - id - name x-apidog-orders: - id - name description: Object representing the city associated with the shipping address. x-apidog-ignore-properties: [] country: type: object properties: id: type: integer description: Unique identifier of the country. name: type: string description: Name of the country. nullable: true required: - id - name x-apidog-orders: - id - name description: Object representing the country of the shipping address. x-apidog-ignore-properties: [] required: - formatted_address - street - district - lat - lng - city - country x-apidog-orders: - formatted_address - street - district - lat - lng - short_address - meta - city - country x-apidog-ignore-properties: [] x-apidog-folder: '' OrderShippingMethodPresenter: type: object properties: id: type: integer description: Unique identifier of the shipping method. nullable: true name: type: string description: Display name of the shipping method. nullable: true code: type: string description: >- Internal code representing the shipping method. Used for integrations and system-level identification. nullable: true estimated_delivery_time: type: string description: Estimated delivery duration for the shipment. nullable: true icon: type: string description: URL or identifier for the shipping method icon. is_system_option: type: boolean description: >- Indicates whether the shipping method is a predefined system option or a custom method. waybill: type: string description: Waybill number associated with the shipment. nullable: true had_errors_while_fetching_waybill: type: boolean description: >- Indicates whether there were errors while retrieving the waybill from the shipping provider. waybill_tracking_id: type: string description: Tracking identifier used by the shipping provider. nullable: true has_waybill_and_packing_list: type: boolean description: Indicates whether both the waybill and packing list are available. tracking: type: object properties: number: type: string description: Shipment tracking number. nullable: true status: type: string description: Current status of the shipment. nullable: true url: type: string description: URL to track the shipment externally. nullable: true required: - number - status - url x-apidog-orders: - number - status - url description: Object containing shipment tracking details. x-apidog-ignore-properties: [] order_shipping_status: type: string description: High-level shipping status of the order. nullable: true inventory_address: anyOf: - type: array items: type: string nullable: true - type: object properties: street: type: string nullable: true lat: type: number nullable: true lng: type: number nullable: true x-apidog-orders: - street - lat - lng required: - street - lat - lng x-apidog-ignore-properties: [] description: |- Represents the inventory address associated with the shipment. Can either be: - A list of address lines, or - A structured object containing location details. courier: $ref: '#/components/schemas/ShippingMethodCourier' description: Information about the courier service provider. return_shipment: type: array items: type: string description: List of return shipment identifiers or references. nullable: true packages_count: type: integer description: Number of packages included in the shipment. nullable: true required: - id - name - code - estimated_delivery_time - icon - is_system_option - waybill - had_errors_while_fetching_waybill - waybill_tracking_id - has_waybill_and_packing_list - tracking - courier - return_shipment - packages_count x-apidog-orders: - id - name - code - estimated_delivery_time - icon - is_system_option - waybill - had_errors_while_fetching_waybill - waybill_tracking_id - has_waybill_and_packing_list - tracking - order_shipping_status - inventory_address - courier - return_shipment - packages_count x-apidog-ignore-properties: [] x-apidog-folder: '' ShippingMethodCourier: type: object properties: name: type: object properties: ar: type: string nullable: true en: type: string nullable: true x-apidog-orders: - ar - en description: Localized name of the courier. x-apidog-ignore-properties: [] nullable: true code: type: string description: Internal courier code. nullable: true logo: type: string description: URL of the courier logo. nullable: true identifier: type: string description: Unique identifier of the courier in the system. nullable: true x-apidog-orders: - name - code - logo - identifier x-apidog-ignore-properties: [] nullable: true x-apidog-folder: '' OrderTagPresenter: type: object properties: id: type: string description: Unique identifier of the tag. name: type: string description: Name of the tag used to label orders. store_id: type: string description: Identifier of the store to which this tag belongs. user_id: type: string description: Identifier of the user who created or owns the tag. orders: type: array items: type: string description: List of order identifiers associated with this tag. nullable: true x-apidog-orders: - id - name - store_id - user_id - orders required: - id - name - store_id - user_id - orders x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderCustomerSerializer: type: object properties: id: type: integer examples: - 1441 description: Unique identifier of the customer. name: type: string examples: - John Doe description: Full name of the customer. email: type: string examples: - test@mail.com description: Email address of the customer. nullable: true mobile: type: string examples: - '966123456789' description: Mobile phone number of the customer. nullable: true note: type: string examples: - '' description: >- Additional notes or instructions provided by the customer during checkout. verified: type: integer description: >- Indicates whether the customer is verified, 1 means customer is verified, 0 means is not verified enum: - 1 - 0 x-apidog-enum: - value: 1 name: verified description: '' - value: 0 name: unverified description: '' type: type: string description: Type of customer. examples: - individual enum: - individual - business x-apidog-enum: - value: individual name: '' description: '' - value: business name: '' description: '' nullable: true business_name: type: string description: >- Business name of the customer. Only applicable when type = "business". nullable: true tax_number: type: string description: >- Tax identification number of the customer. Applicable for business customers. nullable: true commercial_registration: type: string description: >- Commercial registration number of the business. Applicable when type = "business". nullable: true required: - id - name - email - mobile - note - type description: Customer information associated with the draft order. x-apidog-orders: - id - name - email - mobile - note - verified - type - business_name - tax_number - commercial_registration x-apidog-ignore-properties: [] x-apidog-folder: '' OrderDisplayStatus: type: object properties: id: type: integer description: Display status identifier. examples: - 1 code: type: string description: Display status code. examples: - new color: type: string description: Hex color used for displaying status in UI. examples: - '#3498db' nullable: true name: type: string description: Display name of the status. examples: - جديد nullable: true required: - id - code - color - name description: Display configuration for the order status. x-apidog-orders: - id - code - color - name x-apidog-ignore-properties: [] x-apidog-folder: '' OrderStatus: type: object properties: name: type: string description: Human-readable order status. examples: - جديد code: type: string description: Order status code. examples: - new required: - name - code description: Current status of the draft order. x-apidog-orders: - name - code x-apidog-ignore-properties: [] x-apidog-folder: '' TinyOrderSerializer: type: object properties: id: type: integer description: Unique identifier of the order. invoice_number: type: integer description: Invoice number associated with the order. currency: type: string description: Currency code used for the order (e.g., SAR, USD). customer: *ref_3 status: type: string description: Current status of the order. source: type: string description: >- Source from which the order was created (e.g., web, POS, mobile app). shipping_method: type: string description: Name or code of the shipping method selected for the order. nullable: true shipping_address: *ref_4 payment: type: string description: Payment method used for the order. payment_status: type: string enum: - pending - paid - refunded - voided x-apidog-enum: - value: pending name: '' description: '' - value: paid name: '' description: '' - value: refunded name: '' description: '' - value: voided name: '' description: '' description: Current payment status of the order. transaction_reference: type: string description: Reference identifier associated with the payment transaction. nullable: true total: type: string description: Total order amount. created_at: type: string description: Timestamp indicating when the order was created. updated_at: type: string description: Timestamp indicating when the order was last updated. required: - id - invoice_number - currency - customer - status - source - shipping_method - shipping_address - payment - payment_status - transaction_reference - total - created_at - updated_at x-apidog-orders: - id - invoice_number - currency - customer - status - source - shipping_method - shipping_address - payment - payment_status - transaction_reference - total - created_at - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' PrintedAuditedOrderSerializer: type: object properties: id: type: integer invoice_number: type: integer code: type: string nullable: true store_id: type: integer order_url: type: string store_name: type: string shipping_method_code: type: string nullable: true store_url: type: string order_status: *ref_5 display_status: *ref_6 currency_code: type: string nullable: true customer: *ref_3 has_different_consignee: type: integer is_guest_customer: type: integer is_gift_order: type: integer is_quick_checkout_order: type: boolean gift_card_details: type: array items: type: string nullable: true order_total: anyOf: - type: number - type: string order_total_string: type: string has_different_transaction_currency: type: boolean transaction_reference: type: string nullable: true transaction_amount: anyOf: - type: string - type: number transaction_amount_string: type: string issue_date: type: string payment_status: type: string enum: - pending - paid - refunded - voided x-apidog-enum: - value: pending name: '' description: '' - value: paid name: '' description: '' - value: refunded name: '' description: '' - value: voided name: '' description: '' is_potential_fraud: type: boolean source: type: string source_code: type: string nullable: true is_reseller_transaction: type: boolean created_at: type: string updated_at: type: string is_on_demand: type: boolean import_id: type: string nullable: true store_logo: type: string store_uuid: type: string product_ids: type: array items: type: string products_count: type: integer payment: type: object properties: split_payments: &ref_11 $ref: '#/components/schemas/SplitPayments' invoice: type: array items: &ref_12 $ref: '#/components/schemas/DefaultOrderInvoiceItemSerializer' nullable: true method: anyOf: - type: string - &ref_13 $ref: '#/components/schemas/OrderAuditPaymentMethodPresenter' x-apidog-orders: - split_payments - invoice - method required: - method x-apidog-ignore-properties: [] invoice_link: type: string nullable: true payment_method: type: object properties: name: type: string x-apidog-orders: - name required: - name x-apidog-ignore-properties: [] shipping: type: object properties: address: type: object properties: formatted_address: type: string nullable: true street: type: string district: type: string lat: type: number nullable: true lng: type: number nullable: true short_address: type: string nullable: true meta: type: object properties: building_number: type: string nullable: true postcode: type: string nullable: true additional_number: type: string nullable: true city_name: type: string nullable: true x-apidog-orders: - building_number - postcode - additional_number - city_name x-apidog-ignore-properties: [] nullable: true city: type: object properties: id: type: integer name: type: string nullable: true required: - id - name x-apidog-orders: - id - name x-apidog-ignore-properties: [] country: type: object properties: id: type: integer name: type: string nullable: true required: - id - name x-apidog-orders: - id - name x-apidog-ignore-properties: [] x-apidog-refs: {} x-apidog-orders: - formatted_address - street - district - lat - lng - short_address - meta - city - country required: - street - district x-apidog-ignore-properties: [] method: type: object properties: id: type: integer type: type: string enum: - pickup - delivery x-apidog-enum: - value: pickup name: '' description: '' - value: delivery name: '' description: '' is_system_option: type: boolean icon: type: string code: type: string nullable: true name: type: string nullable: true estimated_delivery_time: type: string nullable: true tracking_number: type: string nullable: true x-apidog-refs: {} x-apidog-orders: - id - type - is_system_option - icon - code - name - estimated_delivery_time - tracking_number required: - code - name - estimated_delivery_time - tracking_number x-apidog-ignore-properties: [] x-apidog-orders: - address - method required: - address - method x-apidog-ignore-properties: [] consignee: &ref_7 $ref: '#/components/schemas/DefaultOrderConsigneeSerializer' products: type: array items: $ref: '#/components/schemas/PrintedAuditedOrderProductSerializer' customer_note: type: string return_policy: type: string nullable: true store_address: type: string nullable: true cod_confirmed: type: boolean store_vat_settings: &ref_15 $ref: '#/components/schemas/StoreVatSettings' products_sum_total_string: type: string coupon: anyOf: - &ref_16 $ref: '#/components/schemas/DefaultOrderCouponSerializer' - type: 'null' zatca: type: object properties: qr_code_data: type: string nullable: true x-apidog-orders: - qr_code_data required: - qr_code_data x-apidog-ignore-properties: [] order_credit_notes: type: array items: &ref_17 $ref: '#/components/schemas/OrderCreditNotePresenter' is_marketplace_order: type: boolean pos_invoice_number: type: string x-apidog-orders: - id - invoice_number - code - store_id - order_url - store_name - shipping_method_code - store_url - order_status - display_status - currency_code - customer - has_different_consignee - is_guest_customer - is_gift_order - is_quick_checkout_order - gift_card_details - order_total - order_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - issue_date - payment_status - is_potential_fraud - source - source_code - is_reseller_transaction - created_at - updated_at - is_on_demand - import_id - store_logo - store_uuid - product_ids - products_count - payment - invoice_link - payment_method - shipping - consignee - products - customer_note - return_policy - store_address - cod_confirmed - store_vat_settings - products_sum_total_string - coupon - zatca - order_credit_notes - is_marketplace_order - pos_invoice_number required: - id - invoice_number - code - store_id - order_url - store_name - shipping_method_code - store_url - order_status - currency_code - customer - has_different_consignee - is_guest_customer - order_total - order_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - issue_date - payment_status - is_reseller_transaction - created_at - updated_at - payment - invoice_link - payment_method - shipping - products - customer_note - return_policy - store_address - cod_confirmed - store_vat_settings - products_sum_total_string - coupon x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNotePresenter: type: object properties: id: type: string order_id: type: integer store_id: type: integer invoice_type: type: string nullable: true translated_invoice_type: type: string original_invoice_number: type: integer invoice_number: type: integer issue_reason: type: string nullable: true invoice_title: type: string nullable: true translated_issue_reason: type: string nullable: true store_name: type: string shipping_method_code: type: string nullable: true store_url: type: string order_status: *ref_5 payment_status: type: string nullable: true currency_code: type: string nullable: true customer: *ref_3 has_different_consignee: type: integer order_total: type: string nullable: true order_total_string: type: string products_sum_total_string: type: string has_different_transaction_currency: type: boolean transaction_reference: type: string nullable: true transaction_amount: type: string transaction_amount_string: type: string return_policy: type: string nullable: true items: type: array items: $ref: '#/components/schemas/OrderCreditNoteItemPresenter' shipping: type: object properties: address: $ref: '#/components/schemas/OrderCreditNoteShippingAddressPresenter' method: $ref: '#/components/schemas/OrderCreditNoteShippingMethod' x-apidog-orders: - address - method required: - address - method x-apidog-ignore-properties: [] payment: type: object properties: invoice: type: array items: $ref: '#/components/schemas/OrderCreditNoteInvoiceItemPresenter' method: $ref: '#/components/schemas/OrderCreditNotePaymentMethodPresenter' x-apidog-orders: - invoice - method required: - invoice - method x-apidog-ignore-properties: [] payment_method: type: object properties: name: type: string x-apidog-orders: - name required: - name x-apidog-ignore-properties: [] is_consignee_notifiable: anyOf: - type: boolean - type: integer enum: - 0 - 1 x-apidog-enum: - value: 0 name: '' description: '' - value: 1 name: '' description: '' consignee: *ref_7 customer_note: type: string currency: $ref: '#/components/schemas/DefaultOrderCurrencySerializer' coupon: anyOf: - $ref: '#/components/schemas/OrderCreditNoteCouponPresenter' - type: 'null' items_count: type: integer original_order_date: type: string issue_date: type: string created_at: type: string updated_at: type: string zatca: type: object properties: qr_code_data: type: string nullable: true x-apidog-orders: - qr_code_data required: - qr_code_data x-apidog-ignore-properties: [] x-apidog-orders: - id - order_id - store_id - invoice_type - translated_invoice_type - original_invoice_number - invoice_number - issue_reason - invoice_title - translated_issue_reason - store_name - shipping_method_code - store_url - order_status - payment_status - currency_code - customer - has_different_consignee - order_total - order_total_string - products_sum_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - return_policy - items - shipping - payment - payment_method - is_consignee_notifiable - consignee - customer_note - currency - coupon - items_count - original_order_date - issue_date - created_at - updated_at - zatca required: - id - order_id - store_id - invoice_type - translated_invoice_type - original_invoice_number - invoice_number - issue_reason - invoice_title - translated_issue_reason - store_name - shipping_method_code - store_url - order_status - payment_status - currency_code - customer - has_different_consignee - order_total - order_total_string - products_sum_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - return_policy - items - shipping - payment - payment_method - customer_note - currency - coupon - items_count - original_order_date - issue_date - created_at - updated_at - zatca x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNoteCouponPresenter: type: object properties: code: type: string name: type: string discount: type: number discount_string: type: string x-apidog-orders: - code - name - discount - discount_string required: - code - name - discount - discount_string x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderCurrencySerializer: type: object properties: order_currency: type: object properties: id: type: integer description: Unique identifier of the currency. code: type: string description: ISO currency code (e.g., SAR, USD, AED). exchange_rate: type: number description: >- Exchange rate applied to the order currency relative to the store currency. nullable: true required: - id - code - exchange_rate x-apidog-orders: - id - code - exchange_rate description: Represents the currency in which the order was placed and paid. x-apidog-ignore-properties: [] order_store_currency: type: object properties: id: type: integer description: Unique identifier of the store currency. code: type: string description: ISO currency code of the store. exchange_rate: type: number description: >- Exchange rate of the store currency relative to the order currency. Typically 1 when both currencies are the same. nullable: true required: - id - code - exchange_rate x-apidog-orders: - id - code - exchange_rate description: Represents the store’s base currency. x-apidog-ignore-properties: [] required: - order_currency - order_store_currency x-apidog-orders: - order_currency - order_store_currency x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNotePaymentMethodPresenter: type: object properties: id: type: integer name: type: string code: type: string type: type: string x-apidog-orders: - id - name - code - type required: - id - name - code - type x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNoteInvoiceItemPresenter: type: object properties: code: type: string value: type: string value_string: type: string title: type: string x-apidog-orders: - code - value - value_string - title required: - code - value - value_string - title x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNoteShippingMethod: type: object properties: id: type: integer type: type: string enum: - pickup - delivery x-apidog-enum: - value: pickup name: '' description: '' - value: delivery name: '' description: '' is_system_option: type: boolean name: type: string nullable: true estimated_delivery_time: type: string nullable: true code: type: string nullable: true icon: type: string nullable: true tracking_number: type: string nullable: true x-apidog-orders: - id - type - is_system_option - name - estimated_delivery_time - code - icon - tracking_number required: - id - type - is_system_option - name - estimated_delivery_time - code - icon - tracking_number x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNoteShippingAddressPresenter: type: object properties: district: type: string street: type: string city: $ref: '#/components/schemas/City' country: $ref: '#/components/schemas/Country' meta: type: object properties: editable_order_cart_id: type: string shipping_address_meta: type: object properties: building_number: type: string short_address: type: string postcode: type: string additional_number: type: string city_name: type: string x-apidog-orders: - building_number - short_address - postcode - additional_number - city_name x-apidog-ignore-properties: [] x-apidog-orders: - editable_order_cart_id - shipping_address_meta required: - editable_order_cart_id - shipping_address_meta x-apidog-ignore-properties: [] nullable: true x-apidog-orders: - district - street - city - country - meta required: - district - street - city - country - meta x-apidog-ignore-properties: [] x-apidog-folder: '' Country: type: object properties: id: type: integer description: Unique identifier of the country examples: - 184 name: type: string description: >- Name of the country, written in the language specified by the _Accept-Language_ header parameter; defaults to Arabic if _Accept-Language_ is not specified. examples: - السعودية x-apidog-refs: {} x-apidog-orders: - id - name required: - id - name x-apidog-ignore-properties: [] x-apidog-folder: '' City: type: object properties: id: type: integer name: type: string required: - id - name x-apidog-orders: - id - name x-apidog-ignore-properties: [] x-apidog-folder: '' OrderCreditNoteItemPresenter: type: object properties: id: type: string product_id: type: string nullable: true code: type: string nullable: true name: type: string nullable: true custom_fields: type: array items: &ref_8 $ref: '#/components/schemas/ProductCustomFieldsSerializer' sku: type: string nullable: true quantity: type: integer is_taxable: type: boolean is_discounted: type: boolean meta: type: array items: type: string nullable: true weight: anyOf: - &ref_9 $ref: '#/components/schemas/ProductWeight' - type: 'null' net_price_with_additions: anyOf: - type: number - type: string net_price_with_additions_string: type: string price_with_additions: type: number price_with_additions_string: type: string net_price: anyOf: - type: number nullable: true - type: string nullable: true net_price_string: type: string net_sale_price: anyOf: - type: string nullable: true - type: number nullable: true net_sale_price_string: type: string nullable: true net_additions_price: type: number nullable: true net_additions_price_string: type: string nullable: true original_price: type: number nullable: true original_price_string: type: string nullable: true gross_price: type: number gross_price_string: type: string gross_sale_price: anyOf: - type: number nullable: true - type: string nullable: true gross_sale_price_string: type: string nullable: true price_before: type: number nullable: true price_before_string: type: string nullable: true total_before: type: number nullable: true total_before_string: type: string nullable: true gross_additions_price: type: number nullable: true gross_additions_price_string: type: string nullable: true tax_percentage: type: number tax_amount: type: number tax_amount_string: type: string tax_amount_string_per_item: type: string sale_price: type: number nullable: true sale_price_string: type: string nullable: true price: type: number price_string: type: string additions_price: type: number additions_price_string: type: string total: type: number total_string: type: string images: type: array items: $ref: '#/components/schemas/ProductImageObject' shipping: type: boolean options: type: array items: type: string nullable: true nullable: true barcode: type: string nullable: true x-apidog-orders: - id - product_id - code - name - custom_fields - sku - quantity - is_taxable - is_discounted - meta - weight - net_price_with_additions - net_price_with_additions_string - price_with_additions - price_with_additions_string - net_price - net_price_string - net_sale_price - net_sale_price_string - net_additions_price - net_additions_price_string - original_price - original_price_string - gross_price - gross_price_string - gross_sale_price - gross_sale_price_string - price_before - price_before_string - total_before - total_before_string - gross_additions_price - gross_additions_price_string - tax_percentage - tax_amount - tax_amount_string - tax_amount_string_per_item - sale_price - sale_price_string - price - price_string - additions_price - additions_price_string - total - total_string - images - shipping - options - barcode required: - id - product_id - code - name - custom_fields - sku - quantity - is_taxable - is_discounted - meta - weight - net_price_with_additions - net_price_with_additions_string - price_with_additions - price_with_additions_string - net_price - net_price_string - net_sale_price - net_sale_price_string - net_additions_price - net_additions_price_string - original_price - original_price_string - gross_price - gross_price_string - gross_sale_price - gross_sale_price_string - price_before - price_before_string - total_before - total_before_string - gross_additions_price - gross_additions_price_string - tax_percentage - tax_amount - tax_amount_string - tax_amount_string_per_item - sale_price - sale_price_string - price - price_string - additions_price - additions_price_string - total - total_string - images - shipping - options - barcode x-apidog-ignore-properties: [] x-apidog-folder: '' ProductImageObject: type: object properties: id: type: string origin: type: string thumbs: type: object properties: fullSize: type: string thumbnail: type: string small: type: string medium: type: string large: type: string required: - fullSize - thumbnail - small - medium - large x-apidog-orders: - fullSize - thumbnail - small - medium - large x-apidog-ignore-properties: [] required: - id - origin - thumbs x-apidog-orders: - id - origin - thumbs x-apidog-ignore-properties: [] x-apidog-folder: '' ProductWeight: type: object description: Weight of the product. properties: value: type: number description: The numerical value of the weight. examples: - 1.2 unit: type: string description: The unit of measurement for the weight. examples: - kg x-stoplight: id: kkyu2p7mpw77s x-apidog-orders: - value - unit x-apidog-ignore-properties: [] x-apidog-folder: '' ProductCustomFieldsSerializer: type: object properties: type: type: string description: >- Defines the data type of the custom field value. This determines how the value should be interpreted and displayed. value: type: string description: >- Raw value of the custom field as stored in the system. This value is typically unformatted and should be used for logic or processing. formatted_value: type: string description: >- Human-readable version of the value, formatted for display in UI. May include localization, labels, or formatting applied based on the field type. Example: name: type: string description: >- Internal name or key of the custom field. Used for system-level identification and integrations. nullable: true label: type: string description: Display label of the custom field shown to end users. nullable: true x-apidog-orders: - type - value - formatted_value - name - label required: - type - value - formatted_value - name - label x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderCouponSerializer: type: object properties: id: type: integer description: >- Unique identifier of the coupon applied to the order. Used internally to reference the coupon. nullable: true code: type: string description: Coupon code entered by the customer during checkout. name: type: string description: >- Display name of the coupon. This may be shown in the UI or order summary. discount: type: string description: >- Raw discount value applied by the coupon. Typically represents a numeric amount or percentage, returned as a string for consistency. discount_string: type: string description: >- Formatted version of the discount value for display purposes. Includes currency symbols or percentage formatting. x-apidog-orders: - id - code - name - discount - discount_string required: - id - code - name - discount - discount_string x-apidog-ignore-properties: [] x-apidog-folder: '' StoreVatSettings: type: object description: Store VAT settings and tax configurations. properties: status: type: string description: The status of the VAT settings for the store. examples: - active tax_settings: type: object description: Detailed tax settings for the store. properties: countries: type: array description: List of all countries that have VAT settings configured. items: type: object properties: id: type: string description: VAT settings ID. examples: - vat_123 country: $ref: '#/components/schemas/Country1' tax_percentage: type: integer description: The percentage of VAT for this country. examples: - 15 vat_number: type: string description: VAT number in this country. examples: - SA123456789 tax_registration_certificate_copy: type: string description: >- URL containing the registration certificate for this store. examples: - https://example.com/certificate.jpg x-apidog-orders: - id - country - tax_percentage - vat_number - tax_registration_certificate_copy x-apidog-ignore-properties: [] can_use_vat: type: boolean description: Indicates if this store is allowed to configure VAT settings. examples: - true vat_activate: type: boolean description: Indicates if the store has VAT settings activated. examples: - true is_vat_self_paid: type: boolean description: Indicates if the VAT is self-paid by the store. examples: - false is_vat_included_in_product_price: type: boolean description: Indicates if VAT is included in the product's final price. examples: - true is_shipping_fee_included_in_vat: type: boolean description: Indicates if VAT is applied to the shipping fee. examples: - false other_countries_tax_percentage: type: integer description: VAT percentage for other countries, if different. examples: - 10 x-apidog-orders: - countries - can_use_vat - vat_activate - is_vat_self_paid - is_vat_included_in_product_price - is_shipping_fee_included_in_vat - other_countries_tax_percentage x-apidog-ignore-properties: [] message: $ref: '#/components/schemas/ResponseMessage' x-stoplight: id: il83cafthj4aa x-apidog-orders: - status - tax_settings - message x-apidog-ignore-properties: [] x-apidog-folder: '' ResponseMessage: type: object properties: type: type: string description: The type of the message. examples: - object code: type: string description: The code associated with the message. examples: - '200' name: type: string description: The name of the message. examples: - Success description: type: string description: A detailed description of the message. examples: - Order details retrieved successfully. x-stoplight: id: q8z3lhov5uas0 x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' Country1: type: object properties: id: type: integer description: Unique identifier of the country examples: - 184 name: type: string description: >- Name of the country, written in the language specified by the _Accept-Language_ header parameter; defaults to Arabic if _Accept-Language_ is not specified. examples: - السعودية code: type: string description: Two-letter country code according to ISO 3166-1 alpha-2 examples: - SA country_code: type: string description: Three-letter country code according to ISO 3166-1 alpha-3 examples: - SAU flag: type: string description: URL to the country's flag image examples: - https://media.zid.store/static/sa.svg required: - id - name x-stoplight: id: 2vnjb9zvrn2ks x-apidog-orders: - id - name - code - country_code - flag x-apidog-ignore-properties: [] x-apidog-folder: '' PrintedAuditedOrderProductSerializer: type: object properties: id: type: string examples: - 003140e2-9d8e-462d-b823-373407746871 nullable: true order_product_id: type: integer nullable: true parent_id: type: string nullable: true parent_name: type: string nullable: true product_class: type: string nullable: true name: type: string description: Product name. examples: - طقم سفر للحواجب سوبرستار من بنفت short_description: type: object properties: ar: type: string en: type: string x-apidog-orders: - ar - en required: - ar - en x-apidog-ignore-properties: [] nullable: true sku: type: string description: Product SKU. examples: - Z.217795.169603646831188 barcode: type: string nullable: true custom_fields: type: array items: *ref_8 quantity: type: integer description: Quantity of the product in the draft order. examples: - 1 weight: anyOf: - *ref_9 - type: 'null' is_taxable: type: boolean is_discounted: type: boolean vouchers: type: array items: &ref_18 $ref: '#/components/schemas/ProductVouchersSerializer' downloadables: type: array items: &ref_10 properties: download_url: type: string download_limit: type: integer nullable: true download_requests_count: type: integer nullable: true expiration_period: type: integer nullable: true is_external: type: boolean display_name: type: string x-apidog-orders: - download_url - download_limit - download_requests_count - expiration_period - is_external - display_name required: - download_url - download_limit - download_requests_count - expiration_period - is_external - display_name $ref: '#/components/schemas/ProductDownloadablesSerializer' downloadables_zipped: type: array items: *ref_10 meta: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] nullable: true is_external_product: type: boolean discounts: anyOf: - type: array items: type: string - type: object properties: coupon: &ref_19 $ref: '#/components/schemas/ProductCouponDiscout' x-apidog-orders: - coupon x-apidog-ignore-properties: [] net_price_with_additions: type: number net_price_with_additions_string: type: string price_with_additions: type: number price_with_additions_string: type: string net_price: anyOf: - type: string - type: number net_price_string: type: string net_sale_price: type: number nullable: true net_sale_price_string: type: string nullable: true net_additions_price: type: integer nullable: true net_additions_price_string: type: string nullable: true gross_price: type: number gross_price_string: type: string gross_sale_price: type: number nullable: true gross_sale_price_string: type: string nullable: true price_before: type: number nullable: true price_before_string: type: string nullable: true total_before: type: number nullable: true total_before_string: type: string nullable: true gross_additions_price: type: integer nullable: true gross_additions_price_string: type: string nullable: true discount_percentage: type: number tax_percentage: type: number description: Tax percentage applied to the product. examples: - 0.15 tax_amount: anyOf: - type: string nullable: true - type: number nullable: true tax_amount_string: type: string description: Formatted tax amount. examples: - 26.03 SAR nullable: true tax_amount_string_per_item: type: string discounted_tax_amount: type: number discounted_tax_amount_string: type: string discounted_tax_amount_string_per_item: type: string price: type: number description: Unit price including VAT. examples: - 199.55999896568 price_string: type: string description: Formatted unit price. examples: - 199.56 SAR additions_price: type: number additions_price_string: type: string total: type: number total_string: type: string discounted_total: type: number discounted_total_string: type: string images: type: array items: type: object properties: id: type: string origin: type: string thumbs: type: object properties: fullSize: type: string thumbnail: type: string small: type: string medium: type: string large: type: string required: - fullSize - thumbnail - small - medium - large x-apidog-orders: - fullSize - thumbnail - small - medium - large x-apidog-ignore-properties: [] x-apidog-orders: - id - origin - thumbs x-apidog-ignore-properties: [] options: type: array items: type: string x-apidog-orders: - id - order_product_id - parent_id - parent_name - product_class - name - short_description - sku - barcode - custom_fields - quantity - weight - is_taxable - is_discounted - vouchers - downloadables - downloadables_zipped - meta - is_external_product - discounts - net_price_with_additions - net_price_with_additions_string - price_with_additions - price_with_additions_string - net_price - net_price_string - net_sale_price - net_sale_price_string - net_additions_price - net_additions_price_string - gross_price - gross_price_string - gross_sale_price - gross_sale_price_string - price_before - price_before_string - total_before - total_before_string - gross_additions_price - gross_additions_price_string - discount_percentage - tax_percentage - tax_amount - tax_amount_string - tax_amount_string_per_item - discounted_tax_amount - discounted_tax_amount_string - discounted_tax_amount_string_per_item - price - price_string - additions_price - additions_price_string - total - total_string - discounted_total - discounted_total_string - images - options required: - id - product_class - name - short_description - custom_fields - meta - net_price_with_additions - net_price_with_additions_string - price_with_additions - price_with_additions_string - net_price - net_price_string - net_sale_price - net_sale_price_string - net_additions_price - net_additions_price_string - gross_price - gross_price_string - gross_sale_price - gross_sale_price_string - price_before - price_before_string - total_before - total_before_string - gross_additions_price - gross_additions_price_string - tax_percentage - tax_amount - tax_amount_string - tax_amount_string_per_item - price - price_string - additions_price - additions_price_string - total - total_string x-apidog-ignore-properties: [] x-apidog-folder: '' ProductCouponDiscout: type: object properties: amount: type: number description: Total discount amount applied to the product. percentage: type: number description: Discount percentage applied to the product. unit_amount: type: number description: Discount amount applied per unit of the product. x-apidog-orders: - amount - percentage - unit_amount required: - amount - percentage - unit_amount x-apidog-ignore-properties: [] x-apidog-folder: '' ProductDownloadablesSerializer: type: object properties: download_url: type: string description: File URL download_limit: type: integer description: Max downloads allowed nullable: true download_requests_count: type: integer description: Current usage nullable: true expiration_period: type: integer description: Expiry in days nullable: true is_external: type: boolean description: External link flag display_name: type: string description: File name x-apidog-orders: - download_url - download_limit - download_requests_count - expiration_period - is_external - display_name required: - download_url - download_limit - download_requests_count - expiration_period - is_external - display_name x-apidog-ignore-properties: [] x-apidog-folder: '' ProductVouchersSerializer: type: object properties: id: type: string description: Voucher ID product_id: type: string description: Related product ID status: type: string description: Voucher status order: type: integer description: Order ID nullable: true serial_number: type: string description: Unique serial nullable: true key: type: string description: Activation key pin_code: type: string description: PIN (if applicable) nullable: true expires_at: type: string description: Expiry timestamp nullable: true updated_at: type: string description: updated timestamps created_at: type: string description: created timestamps expires_at_formatted: type: string description: expiry timestamps nullable: true x-apidog-orders: - id - product_id - status - order - serial_number - key - pin_code - expires_at - updated_at - created_at - expires_at_formatted required: - id - product_id - status - order - serial_number - key - pin_code - expires_at - updated_at - created_at x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderConsigneeSerializer: type: object properties: name: type: string description: >- Full name of the consignee (customer) receiving the order. This should match the name used for delivery and verification purposes. email: type: string description: >- Email address of the consignee. Used for order notifications, updates, and communication related to the delivery or return process. mobile: type: string description: >- Mobile phone number of the consignee, including country code if applicable. This is used by shipping providers for delivery coordination and contact. x-apidog-orders: - name - email - mobile required: - name - email - mobile x-apidog-ignore-properties: [] x-apidog-folder: '' OrderAuditPaymentMethodPresenter: type: object properties: id: type: integer name: type: string nullable: true code: type: string nullable: true type: type: string x-apidog-orders: - id - name - code - type required: - id - name - code - type x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderInvoiceItemSerializer: type: object properties: code: type: string description: >- Internal identifier for the invoice item. Used to categorize or reference the type of charge or value (e.g., subtotal, tax, discount). nullable: true value: type: string description: >- Raw value of the invoice item. Typically represents a numeric amount but returned as a string for consistency. value_string: type: string description: >- Formatted version of the value for display purposes, including currency symbols or localization. title: type: string description: >- Human-readable label for the invoice item, typically used in UI or invoices. required: - code - value - value_string - title x-apidog-orders: - code - value - value_string - title x-apidog-ignore-properties: [] x-apidog-folder: '' SplitPayments: type: object properties: name: type: string code: type: string amount: type: number amount_string: type: string near_pay_transaction_uuid: type: string near_pay_transaction_details: type: string x-apidog-orders: - name - code - amount - amount_string - near_pay_transaction_uuid - near_pay_transaction_details required: - name - code - amount - amount_string x-apidog-ignore-properties: [] x-apidog-folder: '' PrintedOrderSerializer: type: object properties: id: type: integer invoice_number: type: integer code: type: string nullable: true store_id: type: integer order_url: type: string store_name: type: string shipping_method_code: type: string nullable: true store_url: type: string order_status: *ref_5 display_status: *ref_6 currency_code: type: string nullable: true customer: *ref_3 has_different_consignee: type: integer is_guest_customer: type: integer is_gift_order: type: integer is_quick_checkout_order: type: boolean gift_card_details: type: array items: type: string nullable: true order_total: type: string order_total_string: type: string has_different_transaction_currency: type: boolean transaction_reference: type: string nullable: true transaction_amount: type: number transaction_amount_string: type: string issue_date: type: string payment_status: type: string enum: - pending - paid - refunded - voided x-apidog-enum: - value: pending name: '' description: '' - value: paid name: '' description: '' - value: refunded name: '' description: '' - value: voided name: '' description: '' is_potential_fraud: type: boolean source: type: string source_code: type: string nullable: true is_reseller_transaction: type: boolean created_at: type: string updated_at: type: string is_on_demand: type: boolean import_id: type: string nullable: true store_logo: type: string store_uuid: type: string product_ids: type: array items: type: string products_count: type: integer payment: type: object properties: split_payments: *ref_11 invoice: type: array items: *ref_12 nullable: true method: anyOf: - type: string - *ref_13 x-apidog-orders: - split_payments - invoice - method required: - method x-apidog-ignore-properties: [] invoice_link: type: string nullable: true payment_method: type: object properties: name: type: string x-apidog-orders: - name required: - name x-apidog-ignore-properties: [] shipping: type: object properties: address: &ref_14 $ref: '#/components/schemas/SimpleOrderShippingMethodSerializer' method: *ref_14 x-apidog-orders: - address - method required: - address - method x-apidog-ignore-properties: [] consignee: *ref_7 products: type: array items: $ref: '#/components/schemas/DefaultOrderProductSerializer' customer_note: type: string return_policy: type: string nullable: true store_address: type: string nullable: true cod_confirmed: type: boolean store_vat_settings: *ref_15 products_sum_total_string: type: string coupon: anyOf: - *ref_16 - type: 'null' zatca: type: object properties: qr_code_data: type: string nullable: true x-apidog-orders: - qr_code_data required: - qr_code_data x-apidog-ignore-properties: [] order_credit_notes: type: array items: *ref_17 is_marketplace_order: type: boolean pos_invoice_number: type: string x-apidog-orders: - id - invoice_number - code - store_id - order_url - store_name - shipping_method_code - store_url - order_status - display_status - currency_code - customer - has_different_consignee - is_guest_customer - is_gift_order - is_quick_checkout_order - gift_card_details - order_total - order_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - issue_date - payment_status - is_potential_fraud - source - source_code - is_reseller_transaction - created_at - updated_at - is_on_demand - import_id - store_logo - store_uuid - product_ids - products_count - payment - invoice_link - payment_method - shipping - consignee - products - customer_note - return_policy - store_address - cod_confirmed - store_vat_settings - products_sum_total_string - coupon - zatca - order_credit_notes - is_marketplace_order - pos_invoice_number required: - id - invoice_number - code - store_id - order_url - store_name - shipping_method_code - store_url - order_status - currency_code - customer - has_different_consignee - is_guest_customer - order_total - order_total_string - has_different_transaction_currency - transaction_reference - transaction_amount - transaction_amount_string - issue_date - payment_status - is_reseller_transaction - created_at - updated_at - payment - invoice_link - payment_method - shipping - products - customer_note - return_policy - store_address - cod_confirmed - store_vat_settings - products_sum_total_string - coupon x-apidog-ignore-properties: [] x-apidog-folder: '' DefaultOrderProductSerializer: type: object properties: id: type: string examples: - 003140e2-9d8e-462d-b823-373407746871 description: Unique identifier of the product (variant-level). nullable: true order_product_id: type: integer description: Unique identifier of the product within the order. parent_id: type: string description: ID of the parent product (for variants). nullable: true parent_name: type: string description: Name of the parent product. nullable: true product_class: type: string description: Product classification (e.g., simple, variable, digital). nullable: true name: type: string description: Product name. examples: - طقم سفر للحواجب سوبرستار من بنفت short_description: type: object properties: ar: type: string description: Arabic description en: type: string description: English description x-apidog-orders: - ar - en required: - ar - en description: Localized short description. x-apidog-ignore-properties: [] nullable: true sku: type: string description: Product Stock Keeping Unit. examples: - Z.217795.169603646831188 nullable: true barcode: type: string description: Product barcode (EAN/UPC). nullable: true custom_fields: type: array items: *ref_8 description: Custom fields attached to the product. quantity: type: integer description: Quantity of the product in the draft order. examples: - 1 weight: anyOf: - *ref_9 - type: 'null' description: Product weight details. is_taxable: type: boolean description: Indicates whether tax applies. is_discounted: type: boolean description: Indicates if product has discount applied. vouchers: type: array items: *ref_18 description: Voucher details for digital products. downloadables: type: array items: *ref_10 description: Downloadable files linked to the product. downloadables_zipped: type: array items: *ref_10 description: Same structure as downloadables, but provided as compressed bundle. meta: type: object properties: {} x-apidog-orders: [] description: Additional product metadata. x-apidog-ignore-properties: [] nullable: true is_external_product: type: boolean description: Indicates if product is externally managed. discounts: anyOf: - type: array items: type: string - type: object properties: coupon: *ref_19 x-apidog-orders: - coupon x-apidog-ignore-properties: [] description: >- Discount breakdown applied to the product. The structure varies depending on the discount type. net_price_with_additions: type: number description: >- Product price excluding tax, including any additional charges (e.g., options, add-ons). net_price_with_additions_string: type: string description: Formatted version of net_price_with_additions. price_with_additions: type: number description: Product price including tax and additional charges. price_with_additions_string: type: string description: Formatted version of price_with_additions. net_price: anyOf: - type: string - type: number description: Product price excluding tax. net_price_string: type: string description: Formatted net price. net_sale_price: type: string description: Discounted net price. nullable: true net_sale_price_string: type: string description: Formatted version of net_sale_price. nullable: true net_additions_price: type: integer description: Additions excluding tax. nullable: true net_additions_price_string: type: string description: Formatted version of net_additions_price nullable: true gross_price: type: number description: Price including tax. gross_price_string: type: string description: Discounted gross price. gross_sale_price: type: string description: Discounted price including tax (gross) after applying all discounts. nullable: true gross_sale_price_string: type: string description: ormatted version of gross_sale_price for display. nullable: true price_before: type: number description: Original unit price before discount. nullable: true price_before_string: type: string description: Formatted version of the original unit price. nullable: true total_before: type: number description: Total before discount. nullable: true total_before_string: type: string description: Additions including tax. nullable: true gross_additions_price: type: integer description: >- Total additional charges including tax (e.g., add-ons, customization). nullable: true gross_additions_price_string: type: string description: Formatted version of gross_additions_price. nullable: true discount_percentage: type: number description: Percentage discount applied to the product. tax_percentage: type: number description: Tax percentage applied to the product. examples: - 0.15 tax_amount: anyOf: - type: string nullable: true - type: number nullable: true description: Total tax amount. tax_amount_string: type: string description: Formatted tax amount. examples: - 26.03 SAR nullable: true tax_amount_string_per_item: type: string description: Tax per item (formatted). discounted_tax_amount: type: number description: Tax amount after applying discounts. discounted_tax_amount_string: type: string description: Formatted version of discounted tax. discounted_tax_amount_string_per_item: type: string description: Discounted tax per item (formatted). price: type: number description: Unit price including VAT. examples: - 199.55999896568 price_string: type: string description: Formatted unit price. examples: - 199.56 SAR additions_price: type: number description: Additional charges (e.g., options). additions_price_string: type: string description: >- Formatted value of additional charges applied to the product (e.g., options or add-ons). total: type: number description: Total price (price × quantity). total_string: type: string description: Formatted total. discounted_total: type: number description: Final total price after applying all discounts. discounted_total_string: type: string description: Formatted version of the discounted total. images: type: array items: type: object properties: id: type: string description: Unique identifier of the image. origin: type: string description: URL of the original image. thumbs: type: object properties: fullSize: type: string description: URL of the full-size image. thumbnail: type: string description: URL of the thumbnail-sized image. small: type: string description: URL of the small-sized image. medium: type: string description: URL of the medium-sized image. large: type: string description: URL of the large-sized image. required: - fullSize - thumbnail - small - medium - large x-apidog-orders: - fullSize - thumbnail - small - medium - large description: Object containing multiple resized versions of the image. x-apidog-ignore-properties: [] x-apidog-orders: - id - origin - thumbs x-apidog-ignore-properties: [] description: List of product images. options: type: array items: type: string description: Selected product options (e.g., size, color). x-apidog-orders: - id - order_product_id - parent_id - parent_name - product_class - name - short_description - sku - barcode - custom_fields - quantity - weight - is_taxable - is_discounted - vouchers - downloadables - downloadables_zipped - meta - is_external_product - discounts - net_price_with_additions - net_price_with_additions_string - price_with_additions - price_with_additions_string - net_price - net_price_string - net_sale_price - net_sale_price_string - net_additions_price - net_additions_price_string - gross_price - gross_price_string - gross_sale_price - gross_sale_price_string - price_before - price_before_string - total_before - total_before_string - gross_additions_price - gross_additions_price_string - discount_percentage - tax_percentage - tax_amount - tax_amount_string - tax_amount_string_per_item - discounted_tax_amount - discounted_tax_amount_string - discounted_tax_amount_string_per_item - price - price_string - additions_price - additions_price_string - total - total_string - discounted_total - discounted_total_string - images - options required: - id - order_product_id - parent_id - parent_name - product_class - name - short_description - sku - custom_fields - quantity - weight - is_taxable - is_discounted - meta - discounts - net_price_with_additions - net_price_with_additions_string - price_with_additions - price_with_additions_string - net_price - net_price_string - net_sale_price - net_sale_price_string - net_additions_price - net_additions_price_string - gross_price - gross_price_string - gross_sale_price - gross_sale_price_string - price_before - price_before_string - total_before - total_before_string - gross_additions_price - gross_additions_price_string - tax_percentage - tax_amount - tax_amount_string - tax_amount_string_per_item - discounted_tax_amount - discounted_tax_amount_string - discounted_tax_amount_string_per_item - price - price_string - additions_price - additions_price_string - total - total_string - discounted_total - discounted_total_string - images - options x-apidog-ignore-properties: [] x-apidog-folder: '' SimpleOrderShippingMethodSerializer: type: object properties: code: type: string nullable: true name: type: string nullable: true estimated_delivery_time: type: string nullable: true tracking_number: type: string nullable: true x-apidog-orders: - code - name - estimated_delivery_time - tracking_number x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```