Carts

Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer’s shopping cart pending a successful Order.

Subresources

Available methods

    • Add a new cart to a store

      POST /ecommerce/stores/{store_id}/carts

      Add a new cart to a store.

      Path parameters

      store_id The store id.

      Request body parameters

      id Type: String Title: Cart Foreign ID Read only: false A unique identifier for the cart.
      customer Type: Object Title: Cart Customer Read only: false Information about a specific customer. Carts 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: 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 a cart.
      checkout_url Type: String Title: Checkout URL Read only: false The URL for the cart. This parameter is required for Abandoned Cart automations.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the cart uses.
      order_total Type: Number Title: Order Total Read only: false The order total for the cart.
      tax_total Type: Number Title: Tax Total Read only: false The total tax for the cart.
      lines Type: Array Title: Cart Line Items Read only: false An array of the cart’s line items.
      Show properties
      id Type: String Title: Cart Line Item Foreign ID Read only: false A unique identifier for the cart line item.
      product_id Type: String Title: Cart Line Product Foreign ID Read only: false A unique identifier for the product associated with the cart line item.
      product_variant_id Type: String Title: Cart Line Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the cart line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of a cart line item.
      price Type: Number Title: Price Read only: false The price of a cart line item.

      Response body parameters

      id Type: String Title: Cart Foreign ID Read only: true A unique identifier for the cart.
      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 a cart.
      checkout_url Type: String Title: Checkout URL Read only: false The URL for the cart. This parameter is required for Abandoned Cart automations.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the cart uses.
      order_total Type: Number Title: Order Total Read only: false The order total for the cart.
      tax_total Type: Number Title: Tax Total Read only: false The total tax for the cart.
      lines Type: Array Title: Cart Line Items Read only: false An array of the cart’s line items.
      Show properties
      id Type: String Title: Cart Line Item Foreign ID Read only: true A unique identifier for the cart line item.
      product_id Type: String Title: Cart Line Product Foreign ID Read only: false A unique identifier for the product associated with the cart line item.
      product_title Type: String Title: Cart Line Product Title Read only: true The name of the product for the cart line item.
      product_variant_id Type: String Title: Cart Line Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the cart line item.
      product_variant_title Type: String Title: Cart Line Product Variant Title Read only: true The name of the product variant for the cart line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of a cart line item.
      price Type: Number Title: Price Read only: false The price of a cart 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.
      created_at Type: String Title: Creation Time Read only: true The date and time the cart was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the cart 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.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"id" : "cart0001", "customer" : {"id": "cust0005"}, "campaign_id" : "b03bfc273a", "checkout_url" : "freddiesjokes.com/cart/?checkout=xxxx", "currency_code" : "USD", "order_total" : 12.45, "tax_total" : 2.45, "lines" : [{"id" : "LINE001", "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: Tue, 31 May 2016 18:42:27 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 3365
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: f50d3bb8-6d2b-411d-81a0-6be766765a0b
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json>; rel="describedBy"
      
      {
        "id": "cart0001",
        "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-03-30T20:39:04+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",
        "checkout_url": "freddiesjokes.com/cart/?checkout=xxxx",
        "currency_code": "USD",
        "order_total": 12.45,
        "tax_total": 2.45,
        "lines": [
          {
            "id": "LINE001",
            "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/carts/cart0001/lines/LINE001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Lines/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE001",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Lines/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE001",
                "method": "DELETE"
              }
            ]
          }
        ],
        "created_at": "2016-05-31T18:42:27+00:00",
        "updated_at": "2016-05-31T18:42:27+00:00",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "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}/carts Get information about a store’s carts
      GET /ecommerce/stores/{store_id}/carts/{cart_id} Get information about a specific cart

      Get information about a store's carts

      GET /ecommerce/stores/{store_id}/carts

      Get information about a store’s carts.

      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.

      Response body parameters

      store_id Type: String Title: Store ID Read only: false The store id.
      carts Type: Array Title: E-commerce Store Carts Read only: false An array of objects, each representing a cart.
      Show properties
      id Type: String Title: Cart Foreign ID Read only: true A unique identifier for the cart.
      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 a cart.
      checkout_url Type: String Title: Checkout URL Read only: false The URL for the cart. This parameter is required for Abandoned Cart automations.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the cart uses.
      order_total Type: Number Title: Order Total Read only: false The order total for the cart.
      tax_total Type: Number Title: Tax Total Read only: false The total tax for the cart.
      lines Type: Array Title: Cart Line Items Read only: false An array of the cart’s line items.
      Show properties
      id Type: String Title: Cart Line Item Foreign ID Read only: true A unique identifier for the cart line item.
      product_id Type: String Title: Cart Line Product Foreign ID Read only: false A unique identifier for the product associated with the cart line item.
      product_title Type: String Title: Cart Line Product Title Read only: true The name of the product for the cart line item.
      product_variant_id Type: String Title: Cart Line Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the cart line item.
      product_variant_title Type: String Title: Cart Line Product Variant Title Read only: true The name of the product variant for the cart line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of a cart line item.
      price Type: Number Title: Price Read only: false The price of a cart 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.
      created_at Type: String Title: Creation Time Read only: true The date and time the cart was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the cart 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.
      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/carts' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 16:42:25 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2969
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 3e9b0660-25e4-4217-bcc0-68f629675f2a
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json>; rel="describedBy"
      
      {
        "store_id": "MC001",
        "carts": [
          {
            "id": "cart0001",
            "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:41:46+00:00",
              "updated_at": "2016-02-10T16:41:47+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",
            "checkout_url": "freddiesjokes.com/cart/?checkout=xxxx",
            "currency_code": "USD",
            "order_total": 12.45,
            "tax_total": 2.45,
            "lines": [
              {
                "product_id": "PROD001",
                "product_title": "Freddie's Jokes",
                "product_variant_id": "PROD001A",
                "product_variant_title": "Freddie's Jokes Volume 1",
                "quantity": 10,
                "price": 10
              }
            ],
            "created_at": "2016-02-10T16:41:47+00:00",
            "updated_at": "2016-02-10T16:41:47+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores//carts/cart0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores//carts",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores//carts/cart0001",
                "method": "DELETE"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/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/Stores/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/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 cart

      GET /ecommerce/stores/{store_id}/carts/{cart_id}

      Get information about a specific cart.

      Path parameters

      store_id The store id.
      cart_id The id for the cart.

      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: Cart Foreign ID Read only: true A unique identifier for the cart.
      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 a cart.
      checkout_url Type: String Title: Checkout URL Read only: false The URL for the cart. This parameter is required for Abandoned Cart automations.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the cart uses.
      order_total Type: Number Title: Order Total Read only: false The order total for the cart.
      tax_total Type: Number Title: Tax Total Read only: false The total tax for the cart.
      lines Type: Array Title: Cart Line Items Read only: false An array of the cart’s line items.
      Show properties
      id Type: String Title: Cart Line Item Foreign ID Read only: true A unique identifier for the cart line item.
      product_id Type: String Title: Cart Line Product Foreign ID Read only: false A unique identifier for the product associated with the cart line item.
      product_title Type: String Title: Cart Line Product Title Read only: true The name of the product for the cart line item.
      product_variant_id Type: String Title: Cart Line Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the cart line item.
      product_variant_title Type: String Title: Cart Line Product Variant Title Read only: true The name of the product variant for the cart line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of a cart line item.
      price Type: Number Title: Price Read only: false The price of a cart 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.
      created_at Type: String Title: Creation Time Read only: true The date and time the cart was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the cart 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.

      Example request

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

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 16:45:03 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2346
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 97fdb719-2579-4612-87af-6984d4a5045d
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json>; rel="describedBy"
      
      {
        "id": "cart0001",
        "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:41:46+00:00",
          "updated_at": "2016-02-10T16:41:47+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",
        "checkout_url": "freddiesjokes.com/cart/?checkout=xxxx",
        "currency_code": "USD",
        "order_total": 12.45,
        "tax_total": 2.45,
        "lines": [
          {
            "product_id": "PROD001",
            "product_title": "Freddie's Jokes",
            "product_variant_id": "PROD001A",
            "product_variant_title": "Freddie's Jokes Volume 1",
            "quantity": 10,
            "price": 10
          }
        ],
        "created_at": "2016-02-10T16:41:47+00:00",
        "updated_at": "2016-02-10T16:41:47+00:00",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "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 cart

      PATCH /ecommerce/stores/{store_id}/carts/{cart_id}

      Update a specific cart.

      Path parameters

      store_id The store id.
      cart_id The id for the cart.

      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 a cart.
      checkout_url Type: String Title: Checkout URL Read only: false The URL for the cart. This parameter is required for Abandoned Cart automations.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the cart uses.
      order_total Type: Number Title: Order Total Read only: false The order total for the cart.
      tax_total Type: Number Title: Tax Total Read only: false The total tax for the cart.
      lines Type: Array Title: Cart Line Items Read only: false An array of the cart’s line items.
      Show properties
      product_id Type: String Title: Cart Line Product Foreign ID Read only: false A unique identifier for the product associated with the cart line item.
      product_variant_id Type: String Title: Cart Line Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the cart line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of a cart line item.
      price Type: Number Title: Price Read only: false The price of a cart line item.

      Response body parameters

      id Type: String Title: Cart Foreign ID Read only: true A unique identifier for the cart.
      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 a cart.
      checkout_url Type: String Title: Checkout URL Read only: false The URL for the cart. This parameter is required for Abandoned Cart automations.
      currency_code Type: String Title: Currency Code Read only: false The three-letter ISO 4217 code for the currency that the cart uses.
      order_total Type: Number Title: Order Total Read only: false The order total for the cart.
      tax_total Type: Number Title: Tax Total Read only: false The total tax for the cart.
      lines Type: Array Title: Cart Line Items Read only: false An array of the cart’s line items.
      Show properties
      id Type: String Title: Cart Line Item Foreign ID Read only: true A unique identifier for the cart line item.
      product_id Type: String Title: Cart Line Product Foreign ID Read only: false A unique identifier for the product associated with the cart line item.
      product_title Type: String Title: Cart Line Product Title Read only: true The name of the product for the cart line item.
      product_variant_id Type: String Title: Cart Line Product Variant Foreign ID Read only: false A unique identifier for the product variant associated with the cart line item.
      product_variant_title Type: String Title: Cart Line Product Variant Title Read only: true The name of the product variant for the cart line item.
      quantity Type: Integer Title: Quantity Read only: false The quantity of a cart line item.
      price Type: Number Title: Price Read only: false The price of a cart 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.
      created_at Type: String Title: Creation Time Read only: true The date and time the cart was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the cart 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.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"customer" : {"id" : "cust0005"}, "campaign_id" : "b03bfc273a", "checkout_url": "freddiesjokes.com/cart/?checkout=xxxx", "currency_code": "USD", "order_total": 16.20, "tax_total": 1.20, "lines":[{"id" : "LINE001", "product_id" : "PROD001", "product_variant_id" : "PROD001A", "quantity" : 1, "price": "10"}, {"id" : "LINE002", "product_id" : "PROD001", "product_variant_id" : "PROD001B", "quantity" : 1, "price": "5"}]}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Tue, 31 May 2016 19:36:59 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 4344
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 92132d14-15e7-4c48-be12-4687f26d869a
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json>; rel="describedBy"
      
      {
        "id": "cart0001",
        "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-03-30T20:39:04+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",
        "checkout_url": "freddiesjokes.com/cart/?checkout=xxxx",
        "currency_code": "USD",
        "order_total": 16.2,
        "tax_total": 1.2,
        "lines": [
          {
            "id": "LINE001",
            "product_id": "PROD001",
            "product_title": "Freddie's Jokes",
            "product_variant_id": "PROD001A",
            "product_variant_title": "Freddie's Jokes Volume 1",
            "quantity": 1,
            "price": 10,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Lines/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE001",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Lines/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE001",
                "method": "DELETE"
              }
            ]
          },
          {
            "id": "LINE002",
            "product_id": "PROD001",
            "product_title": "Freddie's Jokes",
            "product_variant_id": "PROD001B",
            "product_variant_title": "Freddie's Jokes Volume 2",
            "quantity": 1,
            "price": 5,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE002",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Lines/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE002",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Lines/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001/lines/LINE002",
                "method": "DELETE"
              }
            ]
          }
        ],
        "created_at": "2016-05-31T18:42:27+00:00",
        "updated_at": "2016-05-31T19:36:59+00:00",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/carts/cart0001",
            "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 a cart

      DELETE /ecommerce/stores/{store_id}/carts/{cart_id}

      Delete a cart.

      Path parameters

      store_id The store id.
      cart_id The id for the cart.

      Example request

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

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Wed, 10 Feb 2016 16:45:50 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 247c6084-49ef-4f07-940a-c4ca79bbf9e6
                                      

      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.