List orders

GET

https://api.mailchimp.com/3.0/ecommerce/stores/:store_id/orders

GET

/3.0/ecommerce/stores/:store_id/orders

curl https://api.mailchimp.com/3.0/ecommerce/stores/store_id/orders \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "store_id": "string",
  "orders": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "billing_address": {
        "address1": "675 Ponce de Leon Ave NE",
        "address2": "Suite 5000",
        "city": "Atlanta",
        "company": "string",
        "country": "United States",
        "country_code": "US",
        "latitude": 45.427408,
        "longitude": -75.68903,
        "name": "Freddie Chimpenheimer",
        "phone": "8675309",
        "postal_code": "30308",
        "province": "Georgia",
        "province_code": "GA"
      },
      "campaign_id": "839488a60b",
      "cart_id": "cart-123",
      "cancelled_at_foreign": "2015-07-15T19:28:00+00:00",
      "currency_code": "string",
      "customer": {
        "_links": [
          {
            "href": "string",
            "method": "GET",
            "rel": "string",
            "schema": "string",
            "targetSchema": "string"
          }
        ],
        "address": {
          "address1": "675 Ponce de Leon Ave NE",
          "address2": "Suite 5000",
          "city": "Atlanta",
          "country": "United States",
          "country_code": "US",
          "postal_code": "30308",
          "province": "Georgia",
          "province_code": "GA"
        },
        "company": "string",
        "created_at": "2015-07-15T19:28:00+00:00",
        "email_address": "string",
        "first_name": "string",
        "id": "string",
        "last_name": "string",
        "opt_in_status": true,
        "orders_count": 4,
        "sms_phone_number": "string",
        "total_spent": 1.1,
        "updated_at": "2015-07-15T19:28:00+00:00"
      },
      "discount_total": 1.1,
      "financial_status": "string",
      "fulfillment_status": "string",
      "id": "string",
      "landing_site": "http://www.example.com?source=abc",
      "lines": [
        {
          "_links": [
            {
              "href": "string",
              "method": "GET",
              "rel": "string",
              "schema": "string",
              "targetSchema": "string"
            }
          ],
          "discount": 1.1,
          "id": "string",
          "image_url": "string",
          "price": 1.1,
          "product_id": "string",
          "product_title": "string",
          "product_variant_id": "string",
          "product_variant_title": "string",
          "quantity": 1
        }
      ],
      "order_total": 1.1,
      "order_url": "string",
      "outreach": {
        "id": "839488a60b",
        "name": "Freddie's Jokes",
        "published_time": "2017-06-06T13:56:12+00:00",
        "type": "regular"
      },
      "processed_at_foreign": "2015-07-15T19:28:00+00:00",
      "promos": [
        {
          "amount_discounted": 1.1,
          "code": "string",
          "type": "fixed"
        }
      ],
      "shipping_address": {
        "address1": "675 Ponce de Leon Ave NE",
        "address2": "Suite 5000",
        "city": "Atlanta",
        "company": "string",
        "country": "United States",
        "country_code": "US",
        "latitude": 45.427408,
        "longitude": -75.68903,
        "name": "Freddie Chimpenheimer",
        "phone": "8675309",
        "postal_code": "30308",
        "province": "Georgia",
        "province_code": "GA"
      },
      "shipping_total": 1.1,
      "store_id": "string",
      "tax_total": 1.1,
      "tracking_carrier": "string",
      "tracking_code": "prec",
      "tracking_number": "string",
      "tracking_url": "string",
      "updated_at_foreign": "2015-07-15T19:28:00+00:00"
    }
  ],
  "total_items": 1,
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ]
}

Get information about a store’s orders.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

store_idstringRequired

The store id.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

customer_idstringOptional

Restrict results to orders made by a specific customer.

has_outreachbooleanOptional

Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.

campaign_idstringOptional

Restrict results to orders with a specific campaign_id value.

outreach_idstringOptional

Restrict results to orders with a specific outreach_id value.

Response

This endpoint returns an object.

store_idstringOptional

The store id.

orderslist of objectsOptional

An array of objects, each representing an order in a store.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.