Orders

Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your MailChimp account.

Subresources

Available methods

    • Add a new order to a store

      POST /ecommerce/stores/{store_id}/orders

      Add a new order to a store.

      Path parameters

      store_id The store id.

      Request body parameters

      id Type: String Title: Order Foreign ID Read only: false A unique identifier for the order.
      customer Type: Object Title: Customer Read only: false Information about a specific customer. This information will update any existing customer. If the customer doesn’t exist in the store, a new customer will be created.
      Show properties
      id Type: String Title: Customer Foreign ID Read only: false A unique identifier for the customer.
      email_address Type: String Title: Email Address Read only: false The customer’s email address.
      opt_in_status Type: Boolean Title: Opt-in Status Read only: false 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.
      company Type: String Title: Company Read only: false The customer’s company.
      first_name Type: String Title: First Name Read only: false The customer’s first name.
      last_name Type: String Title: Last Name Read only: false The customer’s last name.
      orders_count Type: Integer Title: Orders Count Read only: false The customer’s total order count. Learn More about using this data.
      total_spent Type: Number Title: Total Spent Read only: false The total amount the customer has spent. Learn More about using this data.
      address Type: Object Title: Address Read only: false The customer’s address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The mailing address of the customer.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the customer’s mailing address.
      city Type: String Title: City Read only: false The city the customer is located in.
      province Type: String Title: Province Read only: false The customer’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the customer’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The customer’s postal or zip code.
      country Type: String Title: Country Code Read only: false The customer’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the customer’s country.
      campaign_id Type: String Title: Campaign ID Read only: false A string that uniquely identifies the campaign for an order.
      landing_site Type: String Title: Landing Site Read only: false The URL for the page where the buyer landed when entering the shop.
      financial_status Type: String Title: Financial Status Read only: false The order status. Use this parameter to trigger Order Notifications.
      fulfillment_status Type: String Title: Fulfillment Status Read only: false The fulfillment status for the order. Use this parameter to trigger Order Notifications.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      order_total Type: Number Title: Order Total Read only: false The total for the order.
      order_url Type: String Title: Order URL Read only: false The URL for the order.
      discount_total Type: Number Title: Discount Total Read only: false The total amount of the discounts to be applied to the price of the order.
      tax_total Type: Number Title: Tax Total Read only: false The tax total for the order.
      shipping_total Type: Number Title: Shipping Total Read only: false The shipping total for the order.
      tracking_code Type: String Title: Tracking Code Read only: false The MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in E-Commerce tracking URLs.
      Possible Values:
      • prec
      processed_at_foreign Type: String Title: Foreign Processed Time Read only: false The date and time the order was processed.
      cancelled_at_foreign Type: String Title: Foreign Cancel Time Read only: false The date and time the order was cancelled.
      updated_at_foreign Type: String Title: Foreign Update Time Read only: false The date and time the order was updated.
      shipping_address Type: Object Title: Shipping Address Read only: false The shipping address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s shipping address.
      address1 Type: String Title: Address Field 1 Read only: false The shipping address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the shipping address.
      city Type: String Title: City Read only: false The city in the order’s shipping address.
      province Type: String Title: Province Read only: false The state or normalized province in the order’s shipping address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state in the shipping address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the shipping address.
      country Type: String Title: Country Code Read only: false The country in the shipping address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the shipping address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the shipping address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the shipping address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the order’s shipping address.
      company Type: String Title: Company Read only: false The company associated with the shipping address.
      billing_address Type: Object Title: Billing Address Read only: false The billing address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with the billing address.
      address1 Type: String Title: Address Field 1 Read only: false The billing address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the billing address.
      city Type: String Title: City Read only: false The city in the billing address.
      province Type: String Title: Province Read only: false The state or normalized province in the billing address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province in the billing address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the billing address.
      country Type: String Title: Country Code Read only: false The country in the billing address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the billing address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the billing address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the billing address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the billing address
      company Type: String Title: Company Read only: false The company associated with the billing address.
      lines Type: Array Title: Order Line Items Read only: false An array of the order’s line items.
      Show properties
      id Type: String Title: Order Line Item Foreign ID Read only: false A unique identifier for the order line item.
      product_id Type: String Title: Order Line Item Product Foreign ID Read only: false A unique identifier for the product associated with the order line item.
      product_variant_id Type: String Title: Order Line Item Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the order line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of an order line item.
      price Type: Number Title: Price Read only: false The price of an order line item.
      discount Type: Number Title: Discount Read only: false The total discount amount applied to this line item.

      Response body parameters

      id Type: String Title: Order Foreign ID Read only: true A unique identifier for the order.
      customer Type: Object Title: E-commerce Customer Read only: false Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
      Show properties
      id Type: String Title: Customer Foreign ID Read only: true A unique identifier for the customer.
      email_address Type: String Title: Email Address Read only: true The customer’s email address.
      opt_in_status Type: Boolean Title: Opt-in Status Read only: false 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.
      company Type: String Title: Company Read only: false The customer’s company.
      first_name Type: String Title: First Name Read only: false The customer’s first name.
      last_name Type: String Title: Last Name Read only: false The customer’s last name.
      orders_count Type: Integer Title: Orders Count Read only: false The customer’s total order count. Learn More about using this data.
      total_spent Type: Number Title: Total Spent Read only: false The total amount the customer has spent. Learn More about using this data.
      address Type: Object Title: Address Read only: false The customer’s address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The mailing address of the customer.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the customer’s mailing address.
      city Type: String Title: City Read only: false The city the customer is located in.
      province Type: String Title: Province Read only: false The customer’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the customer’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The customer’s postal or zip code.
      country Type: String Title: Country Code Read only: false The customer’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the customer’s country.
      created_at Type: String Title: Creation Time Read only: true The date and time the customer was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the customer was last updated.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      campaign_id Type: String Title: Campaign ID Read only: false A string that uniquely identifies the campaign associated with an order.
      landing_site Type: String Title: Landing Site Read only: false The URL for the page where the buyer landed when entering the shop.
      financial_status Type: String Title: Financial Status Read only: false The order status. Use this parameter to trigger Order Notifications.
      fulfillment_status Type: String Title: Fulfillment Status Read only: false The fulfillment status for the order. Use this parameter to trigger Order Notifications.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      order_total Type: Number Title: Order Total Read only: false The order total associated with an order.
      order_url Type: String Title: Order URL Read only: false The URL for the order.
      discount_total Type: Number Title: Discount Total Read only: false The total amount of the discounts to be applied to the price of the order.
      tax_total Type: Number Title: Tax Total Read only: false The tax total associated with an order.
      shipping_total Type: Number Title: Shipping Total Read only: false The shipping total for the order.
      tracking_code Type: String Title: Tracking Code Read only: false The MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in E-Commerce tracking URLs.
      Possible Values:
      • prec
      processed_at_foreign Type: String Title: Foreign Processed Time Read only: false The date and time the order was processed.
      cancelled_at_foreign Type: String Title: Foreign Cancel Time Read only: false The date and time the order was cancelled.
      updated_at_foreign Type: String Title: Foreign Update Time Read only: false The date and time the order was updated.
      shipping_address Type: Object Title: Shipping Address Read only: false The shipping address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s shipping address.
      address1 Type: String Title: Address Field 1 Read only: false The shipping address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the shipping address.
      city Type: String Title: City Read only: false The city in the order’s shipping address.
      province Type: String Title: Province Read only: false The state or normalized province in the order’s shipping address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state the order’s shipping address is located in.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the order’s shipping address.
      country Type: String Title: Country Code Read only: false The country in the order’s shipping address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the shipping address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the shipping address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the shipping address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the order’s shipping address
      company Type: String Title: Company Read only: false The company associated with an order’s shipping address.
      billing_address Type: Object Title: Billing Address Read only: false The billing address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s billing address.
      address1 Type: String Title: Address Field 1 Read only: false The billing address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the billing address.
      city Type: String Title: City Read only: false The city in the billing address.
      province Type: String Title: Province Read only: false The state or normalized province in the billing address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state in the billing address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the billing address.
      country Type: String Title: Country Code Read only: false The country in the billing address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the billing address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the billing address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the billing address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the billing address.
      company Type: String Title: Company Read only: false The company associated with the billing address.
      lines Type: Array Title: Order Line Items Read only: false An array of the order’s line items.
      Show properties
      id Type: String Title: Order Line Item Foreign ID Read only: true A unique identifier for the order line item.
      product_id Type: String Title: Order Line Item Product Foreign ID Read only: false A unique identifier for the product associated with the order line item.
      product_title Type: String Title: Order Line Item Product Title Read only: true The name of the product for the order line item.
      product_variant_id Type: String Title: Order Line Item Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the order line item.
      product_variant_title Type: String Title: Order Line Item Product Variant Title Read only: true The name of the product variant for the order line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of an order line item.
      price Type: Number Title: Price Read only: false The price of an order line item.
      discount Type: Number Title: Discount Read only: false The total discount amount applied to this line item.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"id" : "ord0001", "customer" : {"id": "cust0005", "email_address": "freddy@freddiesjokes.com", "opt_in_status": true, "company": "MailChimp", "first_name": "Freddy", "last_name": "Von Chimpenheimer", "orders_count": 1, "total_spent": 10.25}, "campaign_id" : "b03bfc273a", "checkout_url" : "freddiesjokes.com/cart/?checkout=xxxx", "currency_code" : "USD", "order_total" : 12.45, "tax_total" : 2.45, "lines" : [{"id": "L001", "product_id" : "PROD001", "product_title" : "Freddie'\''s Jokes", "product_variant_id" : "PROD001A", "product_variant_title" : "Freddie'\''s Jokes Volume 1", "quantity" : 2, "price" : "10"}]}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 16:49:36 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2790
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: b6287152-5415-45e0-a683-97b95250752b
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Instance.json>; rel="describedBy"
      
      {
        "id": "ord0001",
        "customer": {
          "id": "cust0005",
          "email_address": "freddy@freddiesjokes.com",
          "opt_in_status": true,
          "company": "MailChimp",
          "first_name": "Freddy",
          "last_name": "Von Chimpenheimer",
          "orders_count": 1,
          "total_spent": 10.25,
          "address": {
            "address1": "",
            "address2": "",
            "city": "",
            "province": "",
            "province_code": "",
            "postal_code": "",
            "country": "",
            "country_code": ""
          },
          "created_at": "2016-02-10T16:49:36+00:00",
          "updated_at": "2016-02-10T16:49:36+00:00",
          "_links": [
            {
              "rel": "self",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "GET",
              "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
            },
            {
              "rel": "parent",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers",
              "method": "GET",
              "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Collection.json"
            },
            {
              "rel": "update",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "PATCH",
              "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
            },
            {
              "rel": "upsert",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "PUT",
              "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
            },
            {
              "rel": "delete",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "DELETE"
            }
          ]
        },
        "campaign_id": "b03bfc273a",
        "financial_status": "",
        "fulfillment_status": "",
        "currency_code": "USD",
        "order_total": 12.45,
        "tax_total": 2.45,
        "processed_at_foreign": "",
        "cancelled_at_foreign": "",
        "updated_at_foreign": "",
        "lines": [
          {
            "id": "L001",
            "product_id": "PROD001",
            "product_title": "Freddie's Jokes",
            "product_variant_id": "PROD001A",
            "product_variant_title": "Freddie's Jokes Volume 1",
            "quantity": 2,
            "price": 10,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Lines/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
              }
            ]
          }
        ],
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
            "method": "DELETE"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /ecommerce/stores/{store_id}/orders Get information about a store’s orders
      GET /ecommerce/stores/{store_id}/orders/{order_id} Get information about a specific order

      Get information about a store's orders

      GET /ecommerce/stores/{store_id}/orders

      Get information about a store’s orders.

      Path parameters

      store_id The store id.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
      customer_id Type: String Title: Customer ID Read only: false Restrict results to orders made by a specific customer.
      campaign_id Type: String Title: Campaign ID Read only: false Restrict results to orders with a specific campaign_id value.

      Response body parameters

      store_id Type: String Title: Store ID Read only: false The store id.
      orders Type: Array Title: Orders Read only: false An array of objects, each representing an order in a store.
      Show properties
      id Type: String Title: Order Foreign ID Read only: true A unique identifier for the order.
      customer Type: Object Title: E-commerce Customer Read only: false Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
      Show properties
      id Type: String Title: Customer Foreign ID Read only: true A unique identifier for the customer.
      email_address Type: String Title: Email Address Read only: true The customer’s email address.
      opt_in_status Type: Boolean Title: Opt-in Status Read only: false 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.
      company Type: String Title: Company Read only: false The customer’s company.
      first_name Type: String Title: First Name Read only: false The customer’s first name.
      last_name Type: String Title: Last Name Read only: false The customer’s last name.
      orders_count Type: Integer Title: Orders Count Read only: false The customer’s total order count. Learn More about using this data.
      total_spent Type: Number Title: Total Spent Read only: false The total amount the customer has spent. Learn More about using this data.
      address Type: Object Title: Address Read only: false The customer’s address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The mailing address of the customer.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the customer’s mailing address.
      city Type: String Title: City Read only: false The city the customer is located in.
      province Type: String Title: Province Read only: false The customer’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the customer’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The customer’s postal or zip code.
      country Type: String Title: Country Code Read only: false The customer’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the customer’s country.
      created_at Type: String Title: Creation Time Read only: true The date and time the customer was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the customer was last updated.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      campaign_id Type: String Title: Campaign ID Read only: false A string that uniquely identifies the campaign associated with an order.
      landing_site Type: String Title: Landing Site Read only: false The URL for the page where the buyer landed when entering the shop.
      financial_status Type: String Title: Financial Status Read only: false The order status. Use this parameter to trigger Order Notifications.
      fulfillment_status Type: String Title: Fulfillment Status Read only: false The fulfillment status for the order. Use this parameter to trigger Order Notifications.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      order_total Type: Number Title: Order Total Read only: false The order total associated with an order.
      order_url Type: String Title: Order URL Read only: false The URL for the order.
      discount_total Type: Number Title: Discount Total Read only: false The total amount of the discounts to be applied to the price of the order.
      tax_total Type: Number Title: Tax Total Read only: false The tax total associated with an order.
      shipping_total Type: Number Title: Shipping Total Read only: false The shipping total for the order.
      tracking_code Type: String Title: Tracking Code Read only: false The MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in E-Commerce tracking URLs.
      Possible Values:
      • prec
      processed_at_foreign Type: String Title: Foreign Processed Time Read only: false The date and time the order was processed.
      cancelled_at_foreign Type: String Title: Foreign Cancel Time Read only: false The date and time the order was cancelled.
      updated_at_foreign Type: String Title: Foreign Update Time Read only: false The date and time the order was updated.
      shipping_address Type: Object Title: Shipping Address Read only: false The shipping address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s shipping address.
      address1 Type: String Title: Address Field 1 Read only: false The shipping address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the shipping address.
      city Type: String Title: City Read only: false The city in the order’s shipping address.
      province Type: String Title: Province Read only: false The state or normalized province in the order’s shipping address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state the order’s shipping address is located in.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the order’s shipping address.
      country Type: String Title: Country Code Read only: false The country in the order’s shipping address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the shipping address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the shipping address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the shipping address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the order’s shipping address
      company Type: String Title: Company Read only: false The company associated with an order’s shipping address.
      billing_address Type: Object Title: Billing Address Read only: false The billing address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s billing address.
      address1 Type: String Title: Address Field 1 Read only: false The billing address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the billing address.
      city Type: String Title: City Read only: false The city in the billing address.
      province Type: String Title: Province Read only: false The state or normalized province in the billing address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state in the billing address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the billing address.
      country Type: String Title: Country Code Read only: false The country in the billing address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the billing address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the billing address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the billing address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the billing address.
      company Type: String Title: Company Read only: false The company associated with the billing address.
      lines Type: Array Title: Order Line Items Read only: false An array of the order’s line items.
      Show properties
      id Type: String Title: Order Line Item Foreign ID Read only: true A unique identifier for the order line item.
      product_id Type: String Title: Order Line Item Product Foreign ID Read only: false A unique identifier for the product associated with the order line item.
      product_title Type: String Title: Order Line Item Product Title Read only: true The name of the product for the order line item.
      product_variant_id Type: String Title: Order Line Item Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the order line item.
      product_variant_title Type: String Title: Order Line Item Product Variant Title Read only: true The name of the product variant for the order line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of an order line item.
      price Type: Number Title: Price Read only: false The price of an order line item.
      discount Type: Number Title: Discount Read only: false The total discount amount applied to this line item.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 16:50:56 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 3401
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 729316ce-4d20-4816-a7d0-5c7296fb6685
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json>; rel="describedBy"
      
      {
        "store_id": "MC001",
        "orders": [
          {
            "id": "ord0001",
            "customer": {
              "id": "cust0005",
              "email_address": "freddy@freddiesjokes.com",
              "opt_in_status": true,
              "company": "MailChimp",
              "first_name": "Freddy",
              "last_name": "Von Chimpenheimer",
              "orders_count": 1,
              "total_spent": 10.25,
              "address": {
                "address1": "",
                "address2": "",
                "city": "",
                "province": "",
                "province_code": "",
                "postal_code": "",
                "country": "",
                "country_code": ""
              },
              "created_at": "2016-02-10T16:49:36+00:00",
              "updated_at": "2016-02-10T16:49:36+00:00",
              "_links": [
                {
                  "rel": "self",
                  "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
                  "method": "GET",
                  "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
                },
                {
                  "rel": "parent",
                  "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers",
                  "method": "GET",
                  "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Collection.json"
                },
                {
                  "rel": "update",
                  "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
                  "method": "PATCH",
                  "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
                },
                {
                  "rel": "upsert",
                  "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
                  "method": "PUT",
                  "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
                },
                {
                  "rel": "delete",
                  "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
                  "method": "DELETE"
                }
              ]
            },
            "campaign_id": "",
            "financial_status": "",
            "fulfillment_status": "",
            "currency_code": "USD",
            "order_total": 12.45,
            "tax_total": 2.45,
            "processed_at_foreign": "",
            "cancelled_at_foreign": "",
            "updated_at_foreign": "",
            "lines": [
              {
                "id": "L001",
                "product_id": "PROD001",
                "product_title": "Freddie's Jokes",
                "product_variant_id": "PROD001A",
                "product_variant_title": "Freddie's Jokes Volume 1",
                "quantity": 2,
                "price": 10,
                "_links": [
                  {
                    "rel": "self",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L001",
                    "method": "GET",
                    "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Lines/Instance.json"
                  },
                  {
                    "rel": "parent",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
                    "method": "GET",
                    "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
                  }
                ]
              }
            ],
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores//orders/ord0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores//orders",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores//orders/ord0001",
                "method": "DELETE"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get information about a specific order

      GET /ecommerce/stores/{store_id}/orders/{order_id}

      Get information about a specific order.

      Path parameters

      store_id The store id.
      order_id The id for the order in a store.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: String Title: Order Foreign ID Read only: true A unique identifier for the order.
      customer Type: Object Title: E-commerce Customer Read only: false Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
      Show properties
      id Type: String Title: Customer Foreign ID Read only: true A unique identifier for the customer.
      email_address Type: String Title: Email Address Read only: true The customer’s email address.
      opt_in_status Type: Boolean Title: Opt-in Status Read only: false 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.
      company Type: String Title: Company Read only: false The customer’s company.
      first_name Type: String Title: First Name Read only: false The customer’s first name.
      last_name Type: String Title: Last Name Read only: false The customer’s last name.
      orders_count Type: Integer Title: Orders Count Read only: false The customer’s total order count. Learn More about using this data.
      total_spent Type: Number Title: Total Spent Read only: false The total amount the customer has spent. Learn More about using this data.
      address Type: Object Title: Address Read only: false The customer’s address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The mailing address of the customer.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the customer’s mailing address.
      city Type: String Title: City Read only: false The city the customer is located in.
      province Type: String Title: Province Read only: false The customer’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the customer’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The customer’s postal or zip code.
      country Type: String Title: Country Code Read only: false The customer’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the customer’s country.
      created_at Type: String Title: Creation Time Read only: true The date and time the customer was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the customer was last updated.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      campaign_id Type: String Title: Campaign ID Read only: false A string that uniquely identifies the campaign associated with an order.
      landing_site Type: String Title: Landing Site Read only: false The URL for the page where the buyer landed when entering the shop.
      financial_status Type: String Title: Financial Status Read only: false The order status. Use this parameter to trigger Order Notifications.
      fulfillment_status Type: String Title: Fulfillment Status Read only: false The fulfillment status for the order. Use this parameter to trigger Order Notifications.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      order_total Type: Number Title: Order Total Read only: false The order total associated with an order.
      order_url Type: String Title: Order URL Read only: false The URL for the order.
      discount_total Type: Number Title: Discount Total Read only: false The total amount of the discounts to be applied to the price of the order.
      tax_total Type: Number Title: Tax Total Read only: false The tax total associated with an order.
      shipping_total Type: Number Title: Shipping Total Read only: false The shipping total for the order.
      tracking_code Type: String Title: Tracking Code Read only: false The MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in E-Commerce tracking URLs.
      Possible Values:
      • prec
      processed_at_foreign Type: String Title: Foreign Processed Time Read only: false The date and time the order was processed.
      cancelled_at_foreign Type: String Title: Foreign Cancel Time Read only: false The date and time the order was cancelled.
      updated_at_foreign Type: String Title: Foreign Update Time Read only: false The date and time the order was updated.
      shipping_address Type: Object Title: Shipping Address Read only: false The shipping address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s shipping address.
      address1 Type: String Title: Address Field 1 Read only: false The shipping address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the shipping address.
      city Type: String Title: City Read only: false The city in the order’s shipping address.
      province Type: String Title: Province Read only: false The state or normalized province in the order’s shipping address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state the order’s shipping address is located in.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the order’s shipping address.
      country Type: String Title: Country Code Read only: false The country in the order’s shipping address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the shipping address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the shipping address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the shipping address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the order’s shipping address
      company Type: String Title: Company Read only: false The company associated with an order’s shipping address.
      billing_address Type: Object Title: Billing Address Read only: false The billing address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s billing address.
      address1 Type: String Title: Address Field 1 Read only: false The billing address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the billing address.
      city Type: String Title: City Read only: false The city in the billing address.
      province Type: String Title: Province Read only: false The state or normalized province in the billing address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state in the billing address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the billing address.
      country Type: String Title: Country Code Read only: false The country in the billing address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the billing address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the billing address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the billing address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the billing address.
      company Type: String Title: Company Read only: false The company associated with the billing address.
      lines Type: Array Title: Order Line Items Read only: false An array of the order’s line items.
      Show properties
      id Type: String Title: Order Line Item Foreign ID Read only: true A unique identifier for the order line item.
      product_id Type: String Title: Order Line Item Product Foreign ID Read only: false A unique identifier for the product associated with the order line item.
      product_title Type: String Title: Order Line Item Product Title Read only: true The name of the product for the order line item.
      product_variant_id Type: String Title: Order Line Item Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the order line item.
      product_variant_title Type: String Title: Order Line Item Product Variant Title Read only: true The name of the product variant for the order line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of an order line item.
      price Type: Number Title: Price Read only: false The price of an order line item.
      discount Type: Number Title: Discount Read only: false The total discount amount applied to this line item.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 16:51:50 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2790
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 78eea0ff-32db-4da2-a95d-1c470c322f22
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Instance.json>; rel="describedBy"
      
      {
        "id": "ord0001",
        "customer": {
          "id": "cust0005",
          "email_address": "freddy@freddiesjokes.com",
          "opt_in_status": true,
          "company": "MailChimp",
          "first_name": "Freddy",
          "last_name": "Von Chimpenheimer",
          "orders_count": 1,
          "total_spent": 10.25,
          "address": {
            "address1": "",
            "address2": "",
            "city": "",
            "province": "",
            "province_code": "",
            "postal_code": "",
            "country": "",
            "country_code": ""
          },
          "created_at": "2016-02-10T16:49:36+00:00",
          "updated_at": "2016-02-10T16:49:36+00:00",
          "_links": [
            {
              "rel": "self",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "GET",
              "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
            },
            {
              "rel": "parent",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers",
              "method": "GET",
              "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Collection.json"
            },
            {
              "rel": "update",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "PATCH",
              "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
            },
            {
              "rel": "upsert",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "PUT",
              "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Instance.json"
            },
            {
              "rel": "delete",
              "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/customers/cust0005",
              "method": "DELETE"
            }
          ]
        },
        "campaign_id": "b03bfc273a",
        "financial_status": "",
        "fulfillment_status": "",
        "currency_code": "USD",
        "order_total": 12.45,
        "tax_total": 2.45,
        "processed_at_foreign": "",
        "cancelled_at_foreign": "",
        "updated_at_foreign": "",
        "lines": [
          {
            "id": "L001",
            "product_id": "PROD001",
            "product_title": "Freddie's Jokes",
            "product_variant_id": "PROD001A",
            "product_variant_title": "Freddie's Jokes Volume 1",
            "quantity": 2,
            "price": 10,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Lines/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
              }
            ]
          }
        ],
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
            "method": "DELETE"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Update a specific order

      PATCH /ecommerce/stores/{store_id}/orders/{order_id}

      Update a specific order.

      Path parameters

      store_id The store id.
      order_id The id for the order in a store.

      Request body parameters

      customer Type: Object Title: E-commerce Customer Read only: false Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
      Show properties
      opt_in_status Type: Boolean Title: Opt-in Status Read only: false 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.
      company Type: String Title: Company Read only: false The customer’s company.
      first_name Type: String Title: First Name Read only: false The customer’s first name.
      last_name Type: String Title: Last Name Read only: false The customer’s last name.
      orders_count Type: Integer Title: Orders Count Read only: false The customer’s total order count. Learn More about using this data.
      total_spent Type: Number Title: Total Spent Read only: false The total amount the customer has spent. Learn More about using this data.
      address Type: Object Title: Address Read only: false The customer’s address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The mailing address of the customer.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the customer’s mailing address.
      city Type: String Title: City Read only: false The city the customer is located in.
      province Type: String Title: Province Read only: false The customer’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the customer’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The customer’s postal or zip code.
      country Type: String Title: Country Code Read only: false The customer’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the customer’s country.
      campaign_id Type: String Title: Campaign ID Read only: false A string that uniquely identifies the campaign associated with an order.
      landing_site Type: String Title: Landing Site Read only: false The URL for the page where the buyer landed when entering the shop.
      financial_status Type: String Title: Financial Status Read only: false The order status. Use this parameter to trigger Order Notifications.
      fulfillment_status Type: String Title: Fulfillment Status Read only: false The fulfillment status for the order. Use this parameter to trigger Order Notifications.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      order_total Type: Number Title: Order Total Read only: false The order total associated with an order.
      order_url Type: String Title: Order URL Read only: false The URL for the order.
      discount_total Type: Number Title: Discount Total Read only: false The total amount of the discounts to be applied to the price of the order.
      tax_total Type: Number Title: Tax Total Read only: false The tax total associated with an order.
      shipping_total Type: Number Title: Shipping Total Read only: false The shipping total for the order.
      tracking_code Type: String Title: Tracking Code Read only: false The MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in E-Commerce tracking URLs.
      Possible Values:
      • prec
      processed_at_foreign Type: String Title: Foreign Processed Time Read only: false The date and time the order was processed.
      cancelled_at_foreign Type: String Title: Foreign Cancel Time Read only: false The date and time the order was cancelled.
      updated_at_foreign Type: String Title: Foreign Update Time Read only: false The date and time the order was updated.
      shipping_address Type: Object Title: Shipping Address Read only: false The shipping address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s shipping address.
      address1 Type: String Title: Address Field 1 Read only: false The shipping address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the shipping address.
      city Type: String Title: City Read only: false The city in the order’s shipping address.
      province Type: String Title: Province Read only: false The state or normalized province in the order’s shipping address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state the order’s shipping address is located in.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the order’s shipping address.
      country Type: String Title: Country Code Read only: false The country in the order’s shipping address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the shipping address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the shipping address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the shipping address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the order’s shipping address
      company Type: String Title: Company Read only: false The company associated with an order’s shipping address.
      billing_address Type: Object Title: Billing Address Read only: false The billing address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s billing address.
      address1 Type: String Title: Address Field 1 Read only: false The billing address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the billing address.
      city Type: String Title: City Read only: false The city in the billing address.
      province Type: String Title: Province Read only: false The state or normalized province in the billing address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state in the billing address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the billing address.
      country Type: String Title: Country Code Read only: false The country in the billing address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the billing address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the billing address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the billing address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the billing address.
      company Type: String Title: Company Read only: false The company associated with the billing address.
      lines Type: Array Title: Order Line Items Read only: false An array of the order’s line items.
      Show properties
      product_id Type: String Title: Order Line Item Product Foreign ID Read only: false A unique identifier for the product associated with the order line item.
      product_variant_id Type: String Title: Order Line Item Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the order line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of an order line item.
      price Type: Number Title: Price Read only: false The price of an order line item.
      discount Type: Number Title: Discount Read only: false The total discount amount applied to this line item.

      Response body parameters

      id Type: String Title: Order Foreign ID Read only: true A unique identifier for the order.
      customer Type: Object Title: E-commerce Customer Read only: false Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
      Show properties
      id Type: String Title: Customer Foreign ID Read only: true A unique identifier for the customer.
      email_address Type: String Title: Email Address Read only: true The customer’s email address.
      opt_in_status Type: Boolean Title: Opt-in Status Read only: false 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.
      company Type: String Title: Company Read only: false The customer’s company.
      first_name Type: String Title: First Name Read only: false The customer’s first name.
      last_name Type: String Title: Last Name Read only: false The customer’s last name.
      orders_count Type: Integer Title: Orders Count Read only: false The customer’s total order count. Learn More about using this data.
      total_spent Type: Number Title: Total Spent Read only: false The total amount the customer has spent. Learn More about using this data.
      address Type: Object Title: Address Read only: false The customer’s address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The mailing address of the customer.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the customer’s mailing address.
      city Type: String Title: City Read only: false The city the customer is located in.
      province Type: String Title: Province Read only: false The customer’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the customer’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The customer’s postal or zip code.
      country Type: String Title: Country Code Read only: false The customer’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the customer’s country.
      created_at Type: String Title: Creation Time Read only: true The date and time the customer was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the customer was last updated.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      campaign_id Type: String Title: Campaign ID Read only: false A string that uniquely identifies the campaign associated with an order.
      landing_site Type: String Title: Landing Site Read only: false The URL for the page where the buyer landed when entering the shop.
      financial_status Type: String Title: Financial Status Read only: false The order status. Use this parameter to trigger Order Notifications.
      fulfillment_status Type: String Title: Fulfillment Status Read only: false The fulfillment status for the order. Use this parameter to trigger Order Notifications.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      order_total Type: Number Title: Order Total Read only: false The order total associated with an order.
      order_url Type: String Title: Order URL Read only: false The URL for the order.
      discount_total Type: Number Title: Discount Total Read only: false The total amount of the discounts to be applied to the price of the order.
      tax_total Type: Number Title: Tax Total Read only: false The tax total associated with an order.
      shipping_total Type: Number Title: Shipping Total Read only: false The shipping total for the order.
      tracking_code Type: String Title: Tracking Code Read only: false The MailChimp tracking code for the order. Uses the ‘mc_tc’ parameter in E-Commerce tracking URLs.
      Possible Values:
      • prec
      processed_at_foreign Type: String Title: Foreign Processed Time Read only: false The date and time the order was processed.
      cancelled_at_foreign Type: String Title: Foreign Cancel Time Read only: false The date and time the order was cancelled.
      updated_at_foreign Type: String Title: Foreign Update Time Read only: false The date and time the order was updated.
      shipping_address Type: Object Title: Shipping Address Read only: false The shipping address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s shipping address.
      address1 Type: String Title: Address Field 1 Read only: false The shipping address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the shipping address.
      city Type: String Title: City Read only: false The city in the order’s shipping address.
      province Type: String Title: Province Read only: false The state or normalized province in the order’s shipping address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state the order’s shipping address is located in.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the order’s shipping address.
      country Type: String Title: Country Code Read only: false The country in the order’s shipping address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the shipping address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the shipping address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the shipping address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the order’s shipping address
      company Type: String Title: Company Read only: false The company associated with an order’s shipping address.
      billing_address Type: Object Title: Billing Address Read only: false The billing address for the order.
      Show properties
      name Type: String Title: Name Read only: false The name associated with an order’s billing address.
      address1 Type: String Title: Address Field 1 Read only: false The billing address for the order.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the billing address.
      city Type: String Title: City Read only: false The city in the billing address.
      province Type: String Title: Province Read only: false The state or normalized province in the billing address.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the province or state in the billing address.
      postal_code Type: String Title: Postal Code Read only: false The postal or zip code in the billing address.
      country Type: String Title: Country Code Read only: false The country in the billing address.
      country_code Type: String Title: Country Code Read only: false The two-letter code for the country in the billing address.
      longitude Type: Number Title: Longitude Read only: false The longitude for the billing address location.
      latitude Type: Number Title: Latitude Read only: false The latitude for the billing address location.
      phone Type: String Title: Phone Number Read only: false The phone number for the billing address.
      company Type: String Title: Company Read only: false The company associated with the billing address.
      lines Type: Array Title: Order Line Items Read only: false An array of the order’s line items.
      Show properties
      id Type: String Title: Order Line Item Foreign ID Read only: true A unique identifier for the order line item.
      product_id Type: String Title: Order Line Item Product Foreign ID Read only: false A unique identifier for the product associated with the order line item.
      product_title Type: String Title: Order Line Item Product Title Read only: true The name of the product for the order line item.
      product_variant_id Type: String Title: Order Line Item Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the order line item.
      product_variant_title Type: String Title: Order Line Item Product Variant Title Read only: true The name of the product variant for the order line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of an order line item.
      price Type: Number Title: Price Read only: false The price of an order line item.
      discount Type: Number Title: Discount Read only: false The total discount amount applied to this line item.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L002' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"id":"L002", "product_id":"PROD001", "product_variant_id":"PROD001B", "quantity":2,"price":"10"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Thu, 12 May 2016 13:49:09 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 972
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: ceb6e103-30df-4638-ae1b-b11f4f04b05f
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Lines/Instance.json>; rel="describedBy"
      
      {
        "id": "L002",
        "product_id": "PROD001",
        "product_title": "Freddie's Jokes",
        "product_variant_id": "PROD001B",
        "product_variant_title": "Freddie's Jokes Volume 2",
        "quantity": 2,
        "price": 10,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L002",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Lines/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L002",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Lines/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001/lines/L002",
            "method": "DELETE"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Delete an order

      DELETE /ecommerce/stores/{store_id}/orders/{order_id}

      Delete an order.

      Path parameters

      store_id The store id.
      order_id The id for the order in a store.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders/ord0001' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Wed, 10 Feb 2016 16:55:17 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 9b376953-bcf2-43bc-aa09-61ca35c0fd3a
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.