---
title: "v2-listOrders - List Mirakl Connect orders"
method: GET
path: "/v2/orders"
tags: ["Orders"]
---

# v2-listOrders - List Mirakl Connect orders

`GET /v2/orders`

<div class="extension-title">Description</div>

Use this API to synchronize Mirakl Connect orders with your system. We recommend integrating this API in asynchronous mode. You can retrieve all orders updated since the last call, and update your referential accordingly. To do so, schedule a task that calls this API using the <code>updated_from</code> parameter valued with the last execution time of the task.

<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>

<div class="recommended-call-frequency">Recommended usage: Asynchronous: every 5 minutes</div>
<div class="max-call-frequency">Maximum usage: Asynchronous: once per minute</div>
<div class="extension-title">Pagination</div>

<p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p>

<div class="extension-title">Sort fields</div>

<code>sort</code> field can have the following values:<ul><li><b>updated_at</b> (Default) - Sort by date time of last order modification in Mirakl Connect (desc by default)</li><li><b>created_at</b> - Sort by date time the order was created on the sales channel (desc by default)</li></ul>

</div>

## Query parameters

- `order_ids` string[]
- `statuses` string[]
- `updated_from` string, date-time
- `fulfillment_type` 'FULFILLED_BY_SELLER' | 'FULFILLED_BY_PARTNER'
- `page_token` string
- `limit` integer

## Response `200`

List of orders

- OrdersPageResponse
  - `next_page_token` string — Token to access the next page. Absent if the current page is the last one.
  - `previous_page_token` string — Token to access the previous page. Absent if the current page is the first one.
  - `data` OrderResponse[], required — Page of orders corresponding to the filter parameters
    - `anonymized_at` string, date-time — Date time the order has been anonymized. This value is null as long as the order is not anonymized.
    - `billing_info` BillingInfo
      - `address` Address
        - `additional_info` string — Additional information related to the address
        - `city` string, required — City
        - `company` string — Company of the person associated with the address
        - `country` string — Country
        - `country_iso_code` string, iso-3166-1 alpha-3 — Country ISO code
        - `first_name` string — First name of the person associated with the address
        - `last_name` string, required — Last name of the person associated with the address
        - `phone` string — Phone number of the person associated with the address
        - `state` string — State
        - `street` string, required — Street information
        - `street_additional_info` string — Additional street information
        - `zip_code` string — Postal code
    - `channel_order_id` string, required — Order identifier on the sales channel. This identifier is not guaranteed to be unique as multiple channels can use the same identifier.
    - `channel_updated_at` string, date-time — Date time the order was last updated on the sales channel (can differ from the modification date time in Connect).
    - `created_at` string, date-time, required — Date time the order was created on the sales channel.
    - `custom_attributes` CustomAttributeResponse[], required — Custom attributes
      - `id` string, required — Attribute's id
      - `type` string, required — The attribute's type Enum: `"STRING"`, `"NUMERIC"`, `"BOOLEAN"`, `"DATE"`, `"LIST"`
      - `value` object, required
    - `fulfillment` Fulfillment, required
      - `code` string — The code of the fulfillment partner when type is FULFILLED_BY_PARTNER. null when type is FULFILLED_BY_SELLER.
      - `type` string, required — Indicates how an order is fulfilled. Enum: `"FULFILLED_BY_SELLER"`, `"FULFILLED_BY_PARTNER"`
    - `id` string, required — Unique order identifier used by Mirakl Connect. This identifier can be used as a primary key, but it must not be shared with final users.
    - `order_lines` OrderLineResponse[], required — Information about ordered products
      - `adjustments` Adjustment[], required — Cancelation or refund details related to an order line
        - `adjustment_id` string, required — Unique adjustment identifier used by Mirakl Connect.
        - `created_at` string, date-time, required — Adjustment date
        - `id` string, required — Unique identifier by adjustment type. Deprecated, use adjustment_id instead.
        - `price` Money, required
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
        - `quantity` integer, required — Product quantity adjusted.
        - `reason` string, required — The reason why the order line is adjusted. Enum: `"CUSTOMER_CANCELATION"`, `"OUT_OF_STOCK"`, `"RETURN"`, `"ITEM_NOT_RECEIVED"`, `"AGREEMENT"`, `"DEFECT"`, `"UNABLE_TO_DELIVER"`, `"CHANNEL_SPECIFIC"`
        - `shipping_price` Money, required
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
        - `shipping_taxes` TaxAdjustment[] — Shipping taxes adjusted
          - `amount` Money, required
            - `amount` number, required — Price amount
            - `currency` string, iso-4217, required — Currency ISO code
          - `code` string, required — Tax code on the sales channel
        - `taxes` TaxAdjustment[] — Taxes adjusted
          - `amount` Money, required
            - `amount` number, required — Price amount
            - `currency` string, iso-4217, required — Currency ISO code
          - `code` string, required — Tax code on the sales channel
        - `type` string, required — The type of adjustment. Enum: `"REFUND"`, `"CANCELATION"`
      - `can_cancel` boolean, required — Indicate whether the order line can be cancelled
      - `can_refund` boolean, required — Indicate whether the order line can be refunded
      - `channel_order_line_id` string, required — Order line identifier on the sales channel. This identifier is not guaranteed to be unique as different channels can use the same identifier.
      - `custom_attributes` CustomAttributeResponse[], required — Custom attributes
        - `id` string, required — Attribute's id
        - `type` string, required — The attribute's type Enum: `"STRING"`, `"NUMERIC"`, `"BOOLEAN"`, `"DATE"`, `"LIST"`
        - `value` object, required
      - `id` string, required — Unique order line identifier used by Mirakl Connect. This identifier can be used as a primary key, but it must not be shared with final users.
      - `price` Money, required
        - `amount` number, required — Price amount
        - `currency` string, iso-4217, required — Currency ISO code
      - `product` OrderProduct, required
        - `id` string, required — Seller product identifier
        - `title` string, required — Product title
      - `quantity` integer, required — Quantity of the ordered product after cancelations. Refunds and rejects do not change this field.
      - `shipping_taxes` Tax[], required — Taxes applied to shipping prices
        - `amount` Money, required
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
        - `channel_collectible` Money
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
        - `code` string, required — Tax code on the sales channel
        - `rate` number — Tax rate
        - `seller_collectible` Money
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
      - `status` string, required — Order line status Enum: `"AWAITING_FRAUD_CHECK"`, `"AWAITING_ACCEPTANCE"`, `"AWAITING_PAYMENT"`, `"AWAITING_SHIPMENT"`, `"SHIPPED"`, `"DELIVERED"`, `"CLOSED"`, `"CHANNEL_SPECIFIC"`
      - `status_reason` string — Additional reason about the order line status. Availability depends on the order line status. Enum: `"REFUSED"`, `"ACCEPTANCE_TIMEOUT"`, `"FRAUD_CHECK_FAILED"`, `"FRAUD_CHECK_TIMEOUT"`, `"REFUSED_PAYMENT"`, `"PAYMENT_TIMEOUT"`, `"CANCELED"`, `"REFUNDED"`, `"AUTOMATICALLY_CLOSED"`
      - `taxes` Tax[], required — Taxes applied to product prices
        - `amount` Money, required
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
        - `channel_collectible` Money
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
        - `code` string, required — Tax code on the sales channel
        - `rate` number — Tax rate
        - `seller_collectible` Money
          - `amount` number, required — Price amount
          - `currency` string, iso-4217, required — Currency ISO code
      - `total_shipping_price` Money, required
        - `amount` number, required — Price amount
        - `currency` string, iso-4217, required — Currency ISO code
    - `origin` Origin, required
      - `channel_id` string, required — Unique identifier of the sales channel
      - `channel_name` string — Name of the sales channel
      - `channel_store_id` string — Store identifier on the sales channel. This identifier is not guaranteed to be unique as multiple channels can use the same identifier.
      - `channel_store_name` string — Store public name on the sales channel
      - `sub_channel_code` string — Code of the sub-channel
      - `sub_channel_name` string — Name of the sub-channel
    - `shipping_info` ShippingInfo, required
      - `address` Address
        - `additional_info` string — Additional information related to the address
        - `city` string, required — City
        - `company` string — Company of the person associated with the address
        - `country` string — Country
        - `country_iso_code` string, iso-3166-1 alpha-3 — Country ISO code
        - `first_name` string — First name of the person associated with the address
        - `last_name` string, required — Last name of the person associated with the address
        - `phone` string — Phone number of the person associated with the address
        - `state` string — State
        - `street` string, required — Street information
        - `street_additional_info` string — Additional street information
        - `zip_code` string — Postal code
      - `carrier` string — Carrier company name
      - `delivery_date` object — Expected order delivery date
        - `earliest` string, date-time, required — Earliest order delivery date
        - `latest` string, date-time, required — Latest order delivery date
      - `email` string — Customer email
      - `method` string — Shipping method name on the sales channel. Shipping methods can have different names on different sales channels.
      - `pudo_id` string — PickUp DropOff (PUDO) point identifier
      - `shipping_deadline` string, date-time — Date time by which the store must send the order to the customer.
    - `status` string, required — Current order status Enum: `"AWAITING_FRAUD_CHECK"`, `"AWAITING_ACCEPTANCE"`, `"AWAITING_PAYMENT"`, `"AWAITING_SHIPMENT"`, `"SHIPPED"`, `"DELIVERED"`, `"CLOSED"`, `"CHANNEL_SPECIFIC"`
    - `status_reason` string — Additional reason about the order status. Availability depends on the order status. Enum: `"REFUSED"`, `"ACCEPTANCE_TIMEOUT"`, `"FRAUD_CHECK_FAILED"`, `"FRAUD_CHECK_TIMEOUT"`, `"REFUSED_PAYMENT"`, `"PAYMENT_TIMEOUT"`, `"CANCELED"`, `"REFUNDED"`, `"AUTOMATICALLY_CLOSED"`
    - `updated_at` string, date-time, required — Date time the order was last updated in Mirakl Connect.

---

[API](https://skmtc.net/mirakl/apis/mirakl-connect-apis.md) · [All operations](https://skmtc.net/mirakl/apis/mirakl-connect-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mirakl/mirakl-connect-apis/revisions/cc009fec5cdd/schema)