List of Orders

GETv1/managers/store/orders

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.

:::note[]
Data Masking for Marketplace Orders
When is_marketplace_order is true, the order is from an external provider, and certain customer information, such as customer.name, customer.email, and customer.phone, will be masked for privacy. For example, names like "John Doe" become "J*** D***", emails are masked as "t***@.", and phone numbers as "***00". Masked data may not follow proper syntax. Additionally, for marketplace orders, customer.phone may be null if not provided.
:::

Request

Query Params

payload_type

array[string]

optional

A query parameter that specifies the type and amount of data returned in the response for the "List of Orders" endpoint. To retrieve a list of orders with essential product information (product ID, name, SKU, price, and quantity) included in the response, it is recommended to set payload_type to 'default'.

Example:

[""]

page

number

required

pagination, number of page for every call

per_page

number

required

number of records for every page with max 100 records

order_status

enum<string>

optional

Filter by one of the allowed values

Allowed values:

newpreparingreadyindeliverydeliveredcanceled

Example:

new

payment_method

enum<string>

optional

Filter by payment method

Allowed values:

zid_codzid_bank_transferzid_copzid_credit_card

Example:

zid_cod

customer_id

number

optional

Enter the customer's id to retrieve only respective orders

date_from

string

optional

example: '2020-01-01T00:00:00.000+0000'

date_to

string

optional

example: '2020-01-01T00:00:00.000+0000'

sort_by

enum<string>

optional

Sort result in a specific order

Allowed values:

ascdesc

Example:

asc

shipping_method

enum<string>

optional

The selected method for delivering the order.

Allowed values:

supports: zid_delivery.option_{id}zid_pickup.option_{id}

order_by

enum<string>

optional

Allowed value:

created_at

customer_phone

string

optional

The phone number of the customer.

Example:

503187421

status

string

optional

Filter by one or multiple of the allowed values.

Examples:

preparingnewready

search_term

string

optional

Natural language lookup through (customer phone, customer email, order code, or customer name).

Example:

966503187421

date_attribute

string

optional

created_at, or updated_at

Example:

updated_at

referer_code

array[string]

optional

Order referer code.

Example:

["","YNPN79LC,string,false,,false,"]

order_id

string

optional

The unique identifier for the order.

Example:

1096,125643,2222

customer_type

string

optional

Individual or business.

Example:

individual

source

string

optional

order source.

Example:

mazeed

payment_status

string

optional

Indicates the current payment status of the order.

Example:

pending

cashier

string

optional

Filter by cashier id.

Example:

eaef9285-4df8-4300-be1e-079fab62850a

country_code

string

optional

Filter by country code.

Example:

shipping_city

string

optional

Shipping address city id.

Example:

shipping_country

string

optional

Shipping address country id.

transaction_reference

string

optional

List order transaction references.

Request samples

Responses

list of orders (Filtered as per requested parameters)(200)

list of orders (Filtered as per requested parameters)

HTTP Code: 200

Content Type : JSONapplication/json

status

string

optional

The status of the response.

Example:

object

orders

array [object {35}]

optional

A list of orders.

integer

optional

The unique identifier for the order.

Example:

25304285

code

string

optional

The code associated with the order.

Example:

8OVNEhyqcf

store_id

integer

optional

The unique identifier for the store where the order was placed.

Example:

251073

order_url

string

optional

The URL link to the order's invoice.

Example:

https://zid.store/osama/o/6IJWXOYLuR/inv

store_name

string

optional

The name of the store.

Example:

Osama's Store

shipping_method_code

string

optional

The code representing the shipping method used for the order.

Example:

custom

store_url

string

optional

The URL link to the store.

Example:

https://zid.store/osama/

order_status

object

optional

Status of the order.

currency_code

string

optional

The code representing the currency used for the order.

Example:

KWD

is_marketplace_order

boolean

optional

The is_marketplace_order property indicates whether the order originates from a marketplace. When set to true, it signifies that the order was placed through a third-party marketplace platform rather than directly through the store's website.

Default:

false

customer

object

optional

has_different_consignee

boolean

optional

Indicates if the consignee is different from the customer.

Default:

false

is_guest_customer

boolean

optional

Indicates if the order was placed by a guest customer.

Default:

false

is_gift_order

boolean

optional

Indicates if the order is a gift.

Default:

false

gift_card_details

null

optional

Details of any gift card associated with the order.

is_quick_checkout_order

boolean

optional

order_total

string

optional

The total amount of the order.

Example:

6.00000000000000

order_total_string

string

optional

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

Example:

6.00 KWD

has_different_transaction_currency

boolean

optional

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

Default:

true

transaction_reference

string | null

optional

The reference number for the transaction.

Example:

TRN-123456

transaction_amount

integer

optional

The amount of the transaction.

Example:

transaction_amount_string

string

optional

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

Example:

60.00 SAR

issue_date

string

optional

The date and time when the order was issued.

Example:

04-07-2023 | 12:12 م

payment_status

string

optional

The payment status of the order.

paid: Payment has successfully completed.
pending: Payment is still pending or hasn't been made yet.
refunded: Payment has been refunded to the Customer.
voided: Payment has been voided or canceled.

Example:

paid

source

string

optional

The human-readable name indicating the source where the order was created. This field is localized and provides a description of the sale channel, e.g., "Store" or "المتجر الإلكتروني".

Example:

Store

source_code

string

optional

The code indicating the source or channel of the order. This can be one of several predefined values:

pos: Point of Sale (typically used in physical stores).
catalog: Order was made through a product catalog or online storefront.
md. Order was made from the Merchant Dashboard.
mazeed_marketplace: Order was made through Mazeed.
mazeed: Order was made at the Merchant's Store, but the Customer was redirected from Mazeed to the Merchant's Store.
mobile_app: Order was made through the store's mobile application.
api: Order was made through an API call, typically from third-party integrations or apps.

Example:

catalog

is_reseller_transaction

boolean

optional

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

Default:

false

created_at

string

optional

The date and time when the order was created.

Example:

2023-07-04 09:12:36

updated_at

string

optional

The date and time when the order was last updated.

Example:

2023-07-04 09:14:28

tags

array [object]

optional

Any tags associated with the order.

requires_shipping

boolean

optional

Indicates if the order requires shipping.

Default:

true

shipping

object

optional

payment

object

optional

cod_confirmed

boolean

optional

reverse_order_label_request

null

optional

total_order_count

integer

optional

The total number of orders.

Example:

887

total_order_count_per_status

object

optional

A breakdown of the number of orders based on their statuses.

new

integer

optional

Number of orders with 'new' status.

Example:

323

preparing

integer

optional

Number of orders being prepared.

Example:

indelivery

integer

optional

Number of orders in delivery.

Example:

delivered

integer

optional

Number of orders that have been delivered.

Example:

178

cancelled

integer

optional

Number of orders that have been cancelled.

Example:

135

reversed

integer

optional

Number of orders that have been reversed.

Example:

ready

integer

optional

Number of orders that are ready.

Example:

138

reverse_in_progress

integer

optional

Number of orders that are processing a reversal.

Example:

partially_reversed

integer

optional

Example:

initial

integer

optional

Example:

tax_settings

array [object]

optional

Settings related to tax.

storeColors

object

optional

Color configurations for various store UI elements.

btn_default_background_color

string

optional

Default background color for buttons.

Example:

#b053ac

btn_default_text_color

string

optional

Default text color for buttons.

Example:

#ffffff

btn_default_border_color

string

optional

Default border color for buttons.

Example:

#a04b9c

btn_hover_background_color

string

optional

Background color for buttons on hover.

Example:

#bf5abb

btn_pressed_background_color

string

optional

Background color for buttons when pressed.

Example:

#a04b9c

btn_pressed_text_color

string

optional

Text color for buttons when pressed.

Example:

#ffffff

btn_pressed_border_color

string

optional

Border color for buttons when pressed.

Example:

#a04b9c

printed_invoice_settings

object

optional

Settings related to the content and appearance of printed invoices.

is_tax_number_active

boolean

optional

Indicates if the tax number is active on the printed invoice.

Default:

true

is_return_policy_active

boolean

optional

Indicates if the return policy is active on the printed invoice.

Default:

true

is_products_weight_active

boolean

optional

Indicates if the products' weight is displayed on the printed invoice.

Default:

true

is_barcode_active

boolean

optional

Indicates if a barcode is displayed on the printed invoice.

Default:

true

is_qr_code_active

boolean

optional

Indicates if a QR code is displayed on the printed invoice.

Default:

true

is_expected_time_active

boolean

optional

Indicates if the expected delivery time is displayed on the printed invoice.

Default:

true

is_store_address_active

boolean

optional

Indicates if the store address is displayed on the printed invoice.

Default:

true

is_vat_settings_active

boolean

optional

Indicates if VAT settings are active on the printed invoice.

Default:

true

is_sku_active

boolean

optional

Indicates if the SKU is displayed on the printed invoice.

Default:

true

is_thanks_msg_active

boolean

optional

Indicates if a thank you message is displayed on the printed invoice.

Default:

true

is_order_status_active

boolean

optional

Indicates if the order status is displayed on the printed invoice.

Default:

true

is_discount_coupon_active

boolean

optional

Indicates if any discount coupon is displayed on the printed invoice.

Default:

true

config_logo

string

optional

The URL of the logo displayed on the printed invoice.

Example:

https://example.com/logo-200x.png

store_business_address

string

optional

The business address of the store displayed on the printed invoice.

Example:

Example Address, Riyadh, Saudi Arabia

store_business_name

string

optional

The business name of the store displayed on the printed invoice.

Example:

ExampleStore

store_business_type

string

optional

The type of business of the store.

Example:

establishment

commercial_number

string

optional

The commercial number of the store.

Example:

1234567890

is_payment_stamp_active

boolean

optional

Indicates if a payment stamp is displayed on the printed invoice.

Default:

true

is_order_notifications_enabled

boolean

optional

Indicates if order notifications are enabled.

Default:

true

is_product_description_active

boolean

optional

Default:

false

orders_list_view_settings

object

optional

order_number_column

boolean

optional

Default:

true

customer_column

integer

optional

Example:

created_at_column

integer

optional

Example:

updated_at_column

integer

optional

Example:

source_column

integer

optional

Example:

shipping_method_column

integer

optional

Example:

payment_method_column

integer

optional

Example:

customer_note_column

integer

optional

Example:

tags_column

integer

optional

Example:

order_status_column

integer

optional

Example:

payment_status_column

integer

optional

Example:

totals_column

integer

optional

Example:

action_buttons

boolean

optional

Default:

true

all_columns

integer

optional

Example:

order_number

integer

optional

Example:

message

object

optional

type

string

optional

The type of the message.

Example:

object

code

string | null

optional

The code associated with the message.

Example:

200

name

string | null

optional

The name of the message.

Example:

Success

description

string | null

optional

A detailed description of the message.

Example:

Order details retrieved successfully.

{
  "status": "object",
  "orders": [
    {
      "id": 25304285,
      "code": "8OVNEhyqcf",
      "store_id": 251073,
      "order_url": "https://zid.store/osama/o/6IJWXOYLuR/inv",
      "store_name": "Osama's Store",
      "shipping_method_code": "custom",
      "store_url": "https://zid.store/osama/",
      "order_status": {
        "name": "Delivery in progress",
        "code": "delivered"
      },
      "currency_code": "KWD",
      "is_marketplace_order": false,
      "customer": {
        "id": 0,
        "name": "osama",
        "email": "example.user@email.com",
        "mobile": "+966501234567",
        "verified": 0,
        "note": "string",
        "type": "string"
      },
      "has_different_consignee": false,
      "is_guest_customer": false,
      "is_gift_order": false,
      "gift_card_details": null,
      "is_quick_checkout_order": true,
      "order_total": "6.00000000000000",
      "order_total_string": "6.00 KWD",
      "has_different_transaction_currency": true,
      "transaction_reference": "TRN-123456",
      "transaction_amount": 60,
      "transaction_amount_string": "60.00 SAR",
      "issue_date": "04-07-2023 | 12:12 م",
      "payment_status": "paid",
      "source": "Store",
      "source_code": "catalog",
      "is_reseller_transaction": false,
      "created_at": "2023-07-04 09:12:36",
      "updated_at": "2023-07-04 09:14:28",
      "tags": [
        {}
      ],
      "requires_shipping": true,
      "shipping": {
        "method": {
          "id": 1,
          "name": "string",
          "code": "zid_cod",
          "estimated_delivery_time": "string",
          "icon": "string",
          "is_system_option": true,
          "waybill": null,
          "had_errors_while_fetching_waybill": true,
          "waybill_tracking_id": null,
          "has_waybill_and_packing_list": true,
          "tracking": {
            "number": null,
            "status": null,
            "url": null
          },
          "order_shipping_status": null,
          "inventory_address": [
            {}
          ],
          "courier": null,
          "return_shipment": null,
          "address": {
            "street": "king Abdulaziz Road",
            "district": "Al Olaya District",
            "formatted_address": "King Abdulaziz Road, Al Olaya District, Riyadh, Saudi Arabia",
            "city": {
              "id": "1",
              "national_id": "3",
              "name": "other",
              "priority": "10",
              "country_id": "184",
              "country_name": "Saudi Arabia",
              "country_code": "SA"
            }
          }
        }
      },
      "payment": {
        "method": {
          "name": "string",
          "code": "zid_cod",
          "type": "zid_cod",
          "transaction_status": "string",
          "transaction_status_name": "string"
        }
      },
      "cod_confirmed": true,
      "reverse_order_label_request": null
    }
  ],
  "total_order_count": 887,
  "total_order_count_per_status": {
    "new": 323,
    "preparing": 21,
    "indelivery": 88,
    "delivered": 178,
    "cancelled": 135,
    "reversed": 1,
    "ready": 138,
    "reverse_in_progress": 6,
    "partially_reversed": 3,
    "initial": 0
  },
  "tax_settings": [
    {}
  ],
  "storeColors": {
    "btn_default_background_color": "#b053ac",
    "btn_default_text_color": "#ffffff",
    "btn_default_border_color": "#a04b9c",
    "btn_hover_background_color": "#bf5abb",
    "btn_pressed_background_color": "#a04b9c",
    "btn_pressed_text_color": "#ffffff",
    "btn_pressed_border_color": "#a04b9c"
  },
  "printed_invoice_settings": {
    "is_tax_number_active": true,
    "is_return_policy_active": true,
    "is_products_weight_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://example.com/logo-200x.png",
    "store_business_address": "Example Address, Riyadh, Saudi Arabia",
    "store_business_name": "ExampleStore",
    "store_business_type": "establishment",
    "commercial_number": "1234567890",
    "is_payment_stamp_active": true,
    "is_order_notifications_enabled": true,
    "is_product_description_active": false
  },
  "orders_list_view_settings": {
    "order_number_column": true,
    "customer_column": 0,
    "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": 0,
    "order_number": 10
  },
  "message": {
    "type": "object",
    "code": "200",
    "name": "Success",
    "description": "Order details retrieved successfully."
  }
}

Last modified: a month ago