--- title: "List Orders" method: GET path: "/ecommerce/orders" tags: ["Orders"] --- # List Orders `GET /ecommerce/orders` List Orders ## Query parameters - `raw` boolean - `cursor` string, nullable - `limit` integer - `filter` EcommerceOrdersFilter - `email` string — Customer email address to filter on - `customer_id` string — Customer id to filter on - `updated_since` string — Minimum date the order was last modified - `created_since` string — Minimum date the order was created - `sort` OrdersSort - `by` 'created_at' | 'updated_at' | 'name' — The field on which to sort the Orders - `direction` 'asc' | 'desc' — The direction in which to sort the results - `pass_through` PassThroughQuery - `example_downstream_property` string — All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads) - `fields` string, nullable ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string ## Response `200` Orders - GetEcommerceOrdersResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` EcommerceOrder[], required - `id` string, required — A unique identifier for an object. - `order_number` string, nullable — Order number, if any. - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `discounts` EcommerceDiscount[] - `code` string, nullable — The code used to apply the discount. - `amount` string, nullable — The fixed amount of the discount. - `percentage` string, nullable — The percentage of the discount. - `sub_total` string, nullable — Sub-total amount, normally before tax. - `shipping_cost` string, nullable — Shipping cost, if any. - `coupon_discount` string, nullable — Coupon discount, if any. - `total_discount` string, nullable — Total discount, if any. - `total_tax` string, nullable — Total tax, if any. - `total_amount` string, nullable — Total amount due. - `refunded_amount` string, nullable — Refunded amount, if any. - `tax_inclusive` boolean, nullable — Indicates whether the order's monetary amounts are inclusive of tax. - `status` 'active' | 'completed' | 'cancelled' | 'archived' | 'unknown' | 'other', nullable — Current status of the order. - `payment_status` 'pending' | 'authorized' | 'paid' | 'partial' | 'refunded' | 'voided' | 'unknown' | 'partially_refunded', nullable — Current payment status of the order. - `fulfillment_status` 'pending' | 'shipped' | 'partial' | 'delivered' | 'cancelled' | 'returned' | 'unknown', nullable — Current fulfillment status of the order. - `payment_method` string, nullable — Payment method used for this order. - `customer` LinkedEcommerceCustomer — The customer this entity is linked to. - `id` string, nullable — The ID of the customer this entity is linked to. - `name` string, nullable — Full name of the customer - `first_name` string, nullable — First name of the customer - `last_name` string, nullable — Last name of the customer - `company_name` string, nullable — Company name of the customer - `phone_numbers` PhoneNumber[], nullable - `id` string, nullable — Unique identifier of the phone number - `country_code` string, nullable — The country code of the phone number, e.g. +1 - `area_code` string, nullable — The area code of the phone number, e.g. 323 - `number` string, required — The phone number - `extension` string, nullable — The extension of the phone number - `type` 'primary' | 'secondary' | 'home' | 'work' | 'office' | 'mobile' | 'assistant' | 'fax' | 'direct-dial-in' | 'personal' | 'billing' | 'other', nullable — The type of phone number - `emails` Email[], nullable - `id` string, nullable — Unique identifier for the email address - `email` string, email, nullable, required — Email address - `type` 'primary' | 'secondary' | 'work' | 'personal' | 'billing' | 'other', nullable — Email type - `billing_address` EcommerceAddress — An object representing a shipping or billing address. - `line1` string, nullable — Address line 1 of the billing address. - `line2` string, nullable — Address line 2 of the billing address. - `company_name` string, nullable — Company name of the customer - `city` string, nullable — City of the billing address. - `state` string, nullable — State/province of the billing address. - `postal_code` string, nullable — Postal/ZIP code of the billing address. - `country` string, nullable — Country of the billing address. - `shipping_address` EcommerceAddress — An object representing a shipping or billing address. - `line1` string, nullable — Address line 1 of the billing address. - `line2` string, nullable — Address line 2 of the billing address. - `company_name` string, nullable — Company name of the customer - `city` string, nullable — City of the billing address. - `state` string, nullable — State/province of the billing address. - `postal_code` string, nullable — Postal/ZIP code of the billing address. - `country` string, nullable — Country of the billing address. - `tracking` TrackingItem[] - `provider` string, nullable, required — The name or code of the carrier or shipping company that is handling the shipment. - `number` string, nullable, required — The tracking number associated with the shipment, which can be used to track the progress of the delivery. - `url` string, nullable — The URL of the carrier's tracking page, which can be used to view detailed information about the shipment's progress. - `updated_at` string, date-time, nullable — The date and time when the object was last updated. - `line_items` EcommerceOrderLineItem[] - `id` string, nullable — A unique identifier for an object. - `product_id` string, nullable — A unique identifier for the product associated with the line item. - `variant_id` string, nullable — A unique identifier for the variant of the product associated with the line item, if applicable. - `sku` string, nullable — The SKU of the product or variant associated with the line item. - `name` string, nullable — The name of the product or variant associated with the line item. - `description` string, nullable — The description of the product or variant associated with the line item. - `options` object[] - `id` string, nullable — A unique identifier for the option. - `name` string, nullable — The name of the option. - `value` string, nullable — The value of the option. - `quantity` string, nullable, required — The quantity of the product or variant associated with the line item. - `unit_price` string, nullable — The unit price of the product or variant associated with the line item. - `tax_rate` string, nullable — The tax rate applied to the product or variant associated with the line item. - `tax_amount` string, nullable — The total tax amount applied to the product or variant associated with the line item. - `is_refunded` boolean, nullable — Whether the line item has been refunded. - `refunded_amount` string, nullable — The amount of the line item that has been refunded. - `refunded_quantity` string, nullable — The quantity of the line item that has been refunded. - `sub_total` string, nullable — The sub total for the product(s) or variant associated with the line item, excluding taxes and discounts. - `total_amount` string, nullable — The total amount for the product(s) or variant associated with the line item, including taxes and discounts. - `discounts` EcommerceDiscount[] - `code` string, nullable — The code used to apply the discount. - `amount` string, nullable — The fixed amount of the discount. - `percentage` string, nullable — The percentage of the discount. - `note` string, nullable — Note for the order. - `refunds` EcommerceOrderRefund[] - `id` string, nullable — A unique identifier for an object. - `amount` string — The amount of the refund. - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `reason` string — The reason for the refund. - `created_at` string, date-time, nullable — The date and time when the object was created. - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here. - `created_at` string, date-time, nullable — The date and time when the object was created. - `updated_at` string, date-time, nullable — The date and time when the object was last updated. - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. - `links` Links — Links to navigate to previous or next pages through the API - `previous` string, nullable — Link to navigate to the previous page through the API - `current` string — Link to navigate to the current page through the API - `next` string, nullable — Link to navigate to the previous page through the API ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.dev/apideck-libraries/apis/ecommerce-api.md) · [All operations](https://skmtc.dev/apideck-libraries/apis/ecommerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apideck-libraries/ecommerce-api/revisions/134a8d369b74/schema)