Skip to content
Products
/
/
/
OR11 - List orders with p...

OR11 - List orders with pagination

Request

Description

Pagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead.

Call Frequency
Default:
Recommended usage:
- Asynchronous: every 5 minutes
- Synchronous: at each order page display
Maximum usage:
- Asynchronous: once per minute
- Synchronous: at each order page display
External Partner:
Recommended usage:
- Asynchronous: every 15 minutes
- Synchronous: at each order page display
Maximum usage:
- Asynchronous: every 15 minutes
- Synchronous: at each order page display
Pagination

This resource supports offset pagination (see documentation)

Sort fields

sort field can have the following values:

  • dateCreated (Default) - Sort by creation date, and then by order identifier (asc by default)

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_READ)
Query
order_idsstring, <= 100

A comma-separated list of order's identifiers

order_references_for_customerstring, <= 100

A comma-separated list of order references for customer

order_references_for_sellerstring, <= 100

A comma-separated list of order references for seller

order_state_codesstring

A comma-separated list of order state's codes

Enum:"STAGING""WAITING_ACCEPTANCE""WAITING_DEBIT""WAITING_DEBIT_PAYMENT""SHIPPING""SHIPPED""TO_COLLECT""RECEIVED""CLOSED""REFUSED"
channel_codesstring, <= 100

A comma-separated list of channel codes

only_null_channelboolean

Return only orders without channel. If true, ignore the channel_codes

Default:false
start_datestring, (date-time)

Start creation date for filtering

end_datestring, (date-time)

End creation date for filtering

start_update_datestring, (date-time)

Start update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency.

end_update_datestring, (date-time)

End update date for filtering

customer_debitedboolean

Order paid by customer

payment_workflowstring

Payment workflow of an order

Enum:"PAY_ON_ACCEPTANCE""PAY_ON_DELIVERY""PAY_ON_DUE_DATE""PAY_ON_SHIPMENT""NO_CUSTOMER_PAYMENT_CONFIRMATION"
has_incidentboolean

If true returns only orders with incidents in progress, if false returns orders without incidents in progress. If not provided, all orders with or without incident will be returned

fulfillment_center_codeArray of strings, <= 100

Code of the fulfillment center

order_tax_modestring

Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
Possible values:

  • TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes.
  • TAX_INCLUDED: the price fields include the tax amount.
  • If this query parameter is not specified, the default order tax mode of the platform is used.

    • Enum:"TAX_INCLUDED""TAX_EXCLUDED"
    shop_idinteger, (int64)

    Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

    curl -i -X GET \
  'https://your-instance.mirakl.net/api/orders?order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=STAGING&channel_codes=string&only_null_channel=false&start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z&start_update_date=2019-08-24T14%3A15%3A22Z&end_update_date=2019-08-24T14%3A15%3A22Z&customer_debited=true&payment_workflow=PAY_ON_ACCEPTANCE&has_incident=true&fulfillment_center_code=string&order_tax_mode=TAX_INCLUDED&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

    Responses

    OK

    Bodyapplication/json
    ordersArray of objectsrequired

    List of orders

    total_countinteger, (int32)required

    Total count of orders

    Response
    {
  "orders": [
    { … }
  ],
  "total_count": 1
}