--- title: "List account orders" method: GET path: "/3.0/ecommerce/orders" tags: ["ecommerce"] --- # List account orders `GET /3.0/ecommerce/orders` ## Request - Base URL: `https://api.mailchimp.com` - URL: `https://api.mailchimp.com/3.0/ecommerce/orders` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `https://login.mailchimp.com/oauth2/authorize` - Token URL: `https://login.mailchimp.com/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get information about an account's orders. ## Query parameters - `fields` string[] - `exclude_fields` string[] - `count` integer - `offset` integer - `campaign_id` string - `outreach_id` string - `customer_id` string - `has_outreach` boolean ## Response `200` - object: A collection of orders in an account. - `_links` object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `orders` object[]: An array of objects, each representing an order resource. - `_links` object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `billing_address` object: The billing address for the order. - `address1` string: The billing address for the order. - `address2` string: An additional field for the billing address. - `city` string: The city in the billing address. - `company` string: The company associated with the billing address. - `country` string: The country in the billing address. - `country_code` string: The two-letter code for the country in the billing address. - `latitude` number: The latitude for the billing address location. - `longitude` number: The longitude for the billing address location. - `name` string: The name associated with an order's billing address. - `phone` string: The phone number for the billing address. - `postal_code` string: The postal or zip code in the billing address. - `province` string: The state or normalized province in the billing address. - `province_code` string: The two-letter code for the province or state in the billing address. - `campaign_id` string: A string that uniquely identifies the campaign associated with an order. - `cart_id` string: A cart id that the order was placed for. - `cancelled_at_foreign` string, date-time: The date and time the order was cancelled in ISO 8601 format. - `currency_code` string: The three-letter ISO 4217 code for the currency that the store accepts. - `customer` object: Information about a specific customer. - `_links` object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `address` object: The customer's address. - `address1` string: The mailing address of the customer. - `address2` string: An additional field for the customer's mailing address. - `city` string: The city the customer is located in. - `country` string: The customer's country. - `country_code` string: The two-letter code for the customer's country. - `postal_code` string: The customer's postal or zip code. - `province` string: The customer's state name or normalized province. - `province_code` string: The two-letter code for the customer's province or state. - `company` string: The customer's company. - `created_at` string, date-time: The date and time the customer was created in ISO 8601 format. - `email_address` string: The customer's email address. - `first_name` string: The customer's first name. - `id` string: A unique identifier for the customer. - `last_name` string: The customer's last name. - `opt_in_status` boolean: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). - `orders_count` integer: The customer's total order count. - `sms_phone_number` string: A US phone number for SMS contact. - `total_spent` union - number - string - `updated_at` string, date-time: The date and time the customer was last updated in ISO 8601 format. - `discount_total` number: The total amount of the discounts to be applied to the price of the order. - `financial_status` string: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). - `fulfillment_status` string: The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). - `id` string: A unique identifier for the order. - `landing_site` string: The URL for the page where the buyer landed when entering the shop. - `lines` object[]: An array of the order's line items. - `_links` object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `discount` number: The total discount amount applied to a line item. - `id` string: A unique identifier for an order line item. - `image_url` string: The image URL for a product. - `price` union - number - string - `product_id` string: A unique identifier for the product associated with an order line item. - `product_title` string: The name of the product for an order line item. - `product_variant_id` string: A unique identifier for the product variant associated with an order line item. - `product_variant_title` string: The name of the product variant for an order line item. - `quantity` integer: The order line item quantity. - `order_total` union - number - string - `order_url` string: The URL for the order. - `outreach` object: The outreach associated with this order. For example, an email campaign or Facebook ad. - `id` string: A unique identifier for the outreach. Can be an email campaign ID. - `name` string: The name for the outreach. - `published_time` string, date-time: The date and time the Outreach was published in ISO 8601 format. - `type` string: The type of the outreach. - `processed_at_foreign` string, date-time: The date and time the order was processed in ISO 8601 format. - `promos` object[]: The promo codes applied on the order - `amount_discounted` number: The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 - `code` string: The Promo Code - `type` 'fixed' | 'percentage': Type of discount. For free shipping set type to fixed - `shipping_address` object: The shipping address for the order. - `address1` string: The shipping address for the order. - `address2` string: An additional field for the shipping address. - `city` string: The city in the order's shipping address. - `company` string: The company associated with an order's shipping address. - `country` string: The country in the order's shipping address. - `country_code` string: The two-letter code for the country in the shipping address. - `latitude` number: The latitude for the shipping address location. - `longitude` number: The longitude for the shipping address location. - `name` string: The name associated with an order's shipping address. - `phone` string: The phone number for the order's shipping address - `postal_code` string: The postal or zip code in the order's shipping address. - `province` string: The state or normalized province in the order's shipping address. - `province_code` string: The two-letter code for the province or state the order's shipping address is located in. - `shipping_total` union - number - string - `store_id` string: The unique identifier for the store. - `tax_total` union - number - string - `tracking_carrier` string: The tracking carrier associated with the order. - `tracking_code` 'prec': The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. - `tracking_number` string: The tracking number associated with the order. - `tracking_url` string: The tracking URL associated with the order. - `updated_at_foreign` string, date-time: The date and time the order was updated in ISO 8601 format. - `total_items` integer: The total number of items matching the query regardless of pagination. ## Other responses - `default`: An error generated by the Mailchimp API. --- [API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)