# SOR11 - List orders

Call FrequencyRecommended usage: At each service order page displayMaximum usage: At each service order page displayPaginationThis resource supports seek pagination (see documentation)

Endpoint: GET /api/mms/orders

## Query parameters:

  - `order_id` (array)
    Order ids to include in result.

  - `commercial_order_id` (array)
    Order commercial ids to include in result.

  - `state` (array)
    Order states to include in result.
    Enum: "WAITING_SCORING", "WAITING_ACCEPTANCE", "ORDER_ACCEPTED", "ORDER_PENDING", "ORDER_CONSUMED", "ORDER_EXPIRED", "ORDER_CANCELLED", "ORDER_CLOSED"

  - `customer_id` (array)
    Order customer ids to include in result.

  - `service_code` (array)
    Order services codes to include in result.

  - `date_created_start` (string)
    Creation date to start from.

  - `date_created_end` (string)
    Creation date to end with.

  - `date_updated_start` (string)
    Last modification date to start from.

  - `date_updated_end` (string)
    Last modification date to end with.

  - `refunded` (array)
    Refund completion.
    Enum: "NO", "PARTIAL", "FULL"

  - `refund_reason_code` (array)
    Refund reason codes

  - `has_open_incident` (boolean)
    If true returns only orders with open incidents, if false returns orders without open incidents. Default to all

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

## Response 200 fields (application/json):

  - `data` (array, required)
    Page of data

  - `data.booking` (object, required)
    Order booking information

  - `data.booking.type` (string, required)
    Enum: "NO_BOOKING", "DATETIME_REQUEST", "SCHEDULED_EVENTS"

  - `data.can_evaluate` (boolean, required)
    Indicates if the order can be evaluated by the customer

  - `data.commercial_order_id` (string, required)
    Order commercial ID

  - `data.commission` (object)
    Order commission

  - `data.commission.amount_excluding_taxes` (number)
    Order commission amount, shop taxes excluded

  - `data.commission.amount_including_taxes` (number)
    Order commission amount, shop taxes included

  - `data.commission.commission_taxes` (array)
    Shop commission taxes

  - `data.commission.commission_taxes.amount` (number, required)
    Tax amount

  - `data.commission.commission_taxes.code` (string, required)
    Tax code

  - `data.consumption` (object, required)
    Order consumption information

  - `data.currency_code` (string, required)
    Order currency ISO Code

  - `data.custom_attribute_values` (array, required)
    Custom attribute values defined on the order

  - `data.custom_attribute_values.code` (string, required)
    Custom attribute code

  - `data.custom_attribute_values.label` (string, required)
    Custom attribute label

  - `data.custom_attribute_values.type` (string, required)
    Custom attribute field type
    Enum: "BOOLEAN", "DATE_TIME", "INTEGER", "DECIMAL", "TEXT", "LONG_TEXT", "VALUE_LIST", "LINK", "VIDEO"

  - `data.custom_attribute_values.value` (object)
    Custom attribute field value

  - `data.customer` (object)
    Customer who purchased the service.The node customer is not present when:     the order is not yet accepted    the order is cancelled or closed and was never accepted

  - `data.customer.billing_address` (object, required)
    Billing address of the customer

  - `data.customer.billing_address.city` (string, required)
    City of the address

  - `data.customer.billing_address.civility` (string)
    Civility of the person associated with the address

  - `data.customer.billing_address.company` (string)
    Company of the person associated with the address

  - `data.customer.billing_address.complementary` (string)
    Complementary information line of the street of the address

  - `data.customer.billing_address.country` (string, required)
    Country of the address

  - `data.customer.billing_address.country_code` (string, required)
    Country ISO 3166-1 alpha-3 code of the address, used by Mirakl to format the address (back-office, delivery bill, invoices...)
    Enum: "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SUR", "SJM", "SWZ", "SWE", "CHE", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "USA", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "YEM", "ZMB", "ZWE"

  - `data.customer.billing_address.first_name` (string)
    First name of the person associated with the address

  - `data.customer.billing_address.last_name` (string, required)
    Last name of the person associated with the address

  - `data.customer.billing_address.state` (string)
    State of the address

  - `data.customer.billing_address.street1` (string, required)
    First information line of the street of the address

  - `data.customer.billing_address.street2` (string)
    Second information line of the street of the address

  - `data.customer.billing_address.zip_code` (string)
    Zip code of the address

  - `data.customer.civility` (string)
    Civility of the customer

  - `data.customer.first_name` (string)
    First name of the customer

  - `data.customer.id` (string, required)
    Identifier of the customer

  - `data.customer.last_name` (string)
    Last name of the customer

  - `data.customer.locale` (string)
    RFC 3066 code of the customer's locale

  - `data.customer.phone_number` (string)
    Phone number of the customer

  - `data.customer_notification_email` (string)
    Anonymized customer email usable for notifications that do not expect an answer

  - `data.date_accepted` (string)
    Order acceptance date

  - `data.date_created` (string, required)
    Order creation date

  - `data.date_updated` (string, required)
    Order last modification date

  - `data.has_open_incident` (boolean)
    true if order has an incident open

  - `data.id` (string, required)
    Order ID

  - `data.location` (object, required)
    Order location

  - `data.price` (object)
    Order price

  - `data.price.options` (array)
    Order pricing options. The list is ordered as configured by the operator at the time of the order.

  - `data.price.options.code` (string, required)
    Option code

  - `data.price.options.label` (string, required)
    Option label

  - `data.refunds` (array)
    The list of refunds, sorted by creation date in ascending order

  - `data.refunds.amount` (number, required)
    Amount which was refunded. If taxes or options are also present, this amount is considered as 'excluding taxes and options' and the total amount of the refund can be determined by adding this amount, all tax amounts and all options amounts.

  - `data.refunds.commission` (object, required)
    Refunded commission

  - `data.refunds.creation_date` (string, required)
    Refund creation date

  - `data.refunds.id` (string, required)
    Refund ID

  - `data.refunds.options` (array)
    Pricing options

  - `data.refunds.reason_code` (string, required)
    Refund reason code

  - `data.refunds.state` (string, required)
    Refund state
    Enum: "WAITING", "OK"

  - `data.refunds.taxes` (array, required)
    Tax amounts

  - `data.refunds.taxes.amount` (number, required)
    Amount of the tax

  - `data.refunds.taxes.code` (string, required)
    Code of the tax

  - `data.refunds.transaction_date` (string)
    Transaction number/code

  - `data.refunds.transaction_number` (string)
    Transaction date

  - `data.service` (object, required)
    The service that was purchased

  - `data.service.category` (object, required)
    Service category

  - `data.service.category.code` (string, required)
    Category code

  - `data.service.category.label` (string, required)
    Category label

  - `data.service.code` (string, required)
    Service code

  - `data.service.custom_attribute_values` (array, required)
    Custom attribute values defined on the service

  - `data.service.description` (string)
    Service description

  - `data.service.medias` (array)
    Service medias

  - `data.service.medias.mime_type` (string, required)
    Media Mime type

  - `data.service.medias.url` (string, required)
    Media URL

  - `data.service.model` (object, required)
    Service model

  - `data.service.model.code` (string, required)
    Service model code

  - `data.service.model.label` (string, required)
    Service model label

  - `data.service.title` (string, required)
    Service title

  - `data.state` (string, required)
    Order state
    Enum: "WAITING_SCORING", "SCORING_OK", "SCORING_KO", "WAITING_ACCEPTANCE", "ORDER_ACCEPTED", "ORDER_REFUSED", "ORDER_PENDING", "ORDER_CONSUMED", "ORDER_EXPIRED", "ORDER_CLOSED", "ORDER_CANCELLED"

  - `data.warnings` (array)
    A list of warnings that should be checked before validating the order
    Enum: "PRICE_MISMATCH", "SERVICE_INACTIVE", "MAX_PER_ORDER_EXCEEDED", "STOCK_EXCEEDED", "LOCATION_MISMATCH", "LOCATION_NOT_COVERING_CLIENT_ADDRESS", "DATETIME_REQUEST_OPENING_HOURS_MISMATCH", "DATETIME_REQUEST_DURATION_MISMATCH", "DATETIME_REQUEST_IN_PAST", "PRICING_OPTION_AMOUNT_MISMATCH", "SCHEDULED_EVENT_ALREADY_STARTED", "SCHEDULED_EVENT_ALREADY_ENDED", "SCHEDULED_EVENT_FULLY_BOOKED"

  - `data.workflow` (object, required)
    Order workflow

  - `data.workflow.type` (string, required)
    Order workflow type
    Enum: "PAY_ON_ACCEPTANCE", "PAY_AFTER_CONSUMPTION"

  - `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.