MAmailchimp
ecommerce

List account orders

Get information about an account's orders.

get/3.0/ecommerce/orders

Request

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

countinteger

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

offsetinteger

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

campaign_idstring

Restrict results to orders with a specific campaign_id value.

outreach_idstring

Restrict results to orders with a specific outreach_id value.

customer_idstring

Restrict results to orders made by a specific customer.

has_outreachboolean

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

Response

total_itemsinteger

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

Example response

{
  "orders": [
    {
      "billing_address": {
        "address1": "675 Ponce de Leon Ave NE",
        "address2": "Suite 5000",
        "city": "Atlanta",
        "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",
      "customer": {
        "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"
        },
        "created_at": "2015-07-15T19:28:00+00:00",
        "orders_count": 4,
        "updated_at": "2015-07-15T19:28:00+00:00"
      },
      "landing_site": "http://www.example.com?source=abc",
      "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",
      "shipping_address": {
        "address1": "675 Ponce de Leon Ave NE",
        "address2": "Suite 5000",
        "city": "Atlanta",
        "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"
      },
      "updated_at_foreign": "2015-07-15T19:28:00+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.