E-commerce Stores

Connect your E-commerce Store to MailChimp to take advantage of powerful reporting and personalization features and to learn more about your customers.

Subresources

Available methods

    • POST /ecommerce/stores Add a new store

      Add a new store

      POST /ecommerce/stores

      Add a new store to your MailChimp account.

      Request body parameters

      id Type: String Title: Store Foreign ID Read only: false The unique identifier for the store.
      list_id Type: String Title: List ID Read only: false The unique identifier for the MailChimp List associated with the store. The list_id for a specific store cannot change.
      name Type: String Title: Store Name Read only: false The name of the store.
      platform Type: String Title: Platform Read only: false The e-commerce platform of the store.
      domain Type: String Title: Domain Read only: false The store domain.
      is_syncing Type: Boolean Title: Is Syncing Read only: false Whether the e-commerce store is currently syncing.
      email_address Type: String Title: Email Address Read only: false The email address for the store.
      currency_code Type: String Title: Currency Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      money_format Type: String Title: Money Format Read only: false The currency format for the store. For example: $, £, etc.
      primary_locale Type: String Title: Primary Locale Read only: false The primary locale for the store. For example: en, de, etc.
      timezone Type: String Title: Timezone Read only: false The timezone for the store.
      phone Type: String Title: Phone Read only: false The store phone number.
      address Type: Object Title: Address Read only: false The store address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The store’s mailing address.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the store’s mailing address.
      city Type: String Title: City Read only: false The city the store is located in.
      province Type: String Title: Province Read only: false The store’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the store’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The store’s postal or zip code.
      country Type: String Title: Country Code Read only: false The store’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for to the store’s country.
      longitude Type: Number Title: Longitude Read only: false The longitude of the store location.
      latitude Type: Number Title: Latitude Read only: false The latitude of the store location.

      Response body parameters

      id Type: String Title: Store Foreign ID Read only: true The unique identifier for the store.
      list_id Type: String Title: List ID Read only: true The unique identifier for the MailChimp List that’s associated with the store. The list_id for a specific store can’t change.
      name Type: String Title: Store Name Read only: false The name of the store.
      platform Type: String Title: Platform Read only: false The e-commerce platform of the store.
      domain Type: String Title: Domain Read only: false The store domain.
      is_syncing Type: Boolean Title: Is Syncing Read only: false Whether the e-commerce store is currently syncing.
      email_address Type: String Title: Email Address Read only: false The email address for the store.
      currency_code Type: String Title: Currency Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      money_format Type: String Title: Money Format Read only: false The currency format for the store. For example: $, £, etc.
      primary_locale Type: String Title: Primary Locale Read only: false The primary locale for the store. For example: en, de, etc.
      timezone Type: String Title: Timezone Read only: false The timezone for the store.
      phone Type: String Title: Phone Read only: false The store phone number.
      address Type: Object Title: Address Read only: false The store address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The store’s mailing address.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the store’s mailing address.
      city Type: String Title: City Read only: false The city the store is located in.
      province Type: String Title: Province Read only: false The store’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the store’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The store’s postal or zip code.
      country Type: String Title: Country Code Read only: false The store’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for to the store’s country.
      longitude Type: Number Title: Longitude Read only: false The longitude of the store location.
      latitude Type: Number Title: Latitude Read only: false The latitude of the store location.
      connected_site Type: Object Title: Connected Site Read only: true The Connected Site associated with the store.
      Show properties
      site_foreign_id Type: String Title: Connected Site Foreign ID Read only: true The unique identifier for the connected site.
      site_script Type: Object Title: Script Read only: true The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: true The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: true A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: true The date and time the store was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the store 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' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"id":"MC001", "list_id" : "205d96e6b4", "name" : "Freddie'\''s Merchandise", "domain" : "freddiesjokes.com", "email_address" : "store@freddiesjokes.com", "currency_code" : "USD", "primary-locale" : "us", "timezone" : "Eastern", "address" : {"address1" : "675 Ponce de Leon Ave NE", "address2" : "Suite 5000", "city" : "Atlanta, GA 30308"}}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Tue, 09 Feb 2016 20:26:59 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2190
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 70132a7f-a920-448d-b885-96d7ecb34ef1
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json>; rel="describedBy"
      
      {
        "id": "MC001",
        "list_id": "205d96e6b4",
        "name": "Freddie's Merchandise",
        "domain": "freddiesjokes.com",
        "email_address": "store@freddiesjokes.com",
        "currency_code": "USD",
        "money_format": "",
        "primary_locale": "",
        "timezone": "Eastern",
        "phone": "",
        "address": {
          "address1": "675 Ponce de Leon Ave NE",
          "address2": "Suite 5000",
          "city": "Atlanta, GA 30308",
          "province": "",
          "province_code": "",
          "postal_code": "",
          "country": "",
          "country_code": "",
          "longitude": 0,
          "latitude": 0
        },
        "created_at": "2016-02-09T20:26:59+00:00",
        "updated_at": "2016-02-09T20:26:59+00:00",
        "_links": [
          {
            "rel": "self",
            "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": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Collection.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "upsert",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
            "method": "PUT",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
            "method": "DELETE"
          },
          {
            "rel": "customers",
            "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": "products",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
          },
          {
            "rel": "orders",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/orders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerc"
          }
        ]
      }
                                      

      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 Get information about all stores
      GET /ecommerce/stores/{store_id} Get information about a specific store

      Get information about all stores

      GET /ecommerce/stores

      Get information about all stores in the account.

      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

      stores Type: Array Title: Stores Read only: false An array of objects, each representing a store.
      Show properties
      id Type: String Title: Store Foreign ID Read only: true The unique identifier for the store.
      list_id Type: String Title: List ID Read only: true The unique identifier for the MailChimp List that’s associated with the store. The list_id for a specific store can’t change.
      name Type: String Title: Store Name Read only: false The name of the store.
      platform Type: String Title: Platform Read only: false The e-commerce platform of the store.
      domain Type: String Title: Domain Read only: false The store domain.
      is_syncing Type: Boolean Title: Is Syncing Read only: false Whether the e-commerce store is currently syncing.
      email_address Type: String Title: Email Address Read only: false The email address for the store.
      currency_code Type: String Title: Currency Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      money_format Type: String Title: Money Format Read only: false The currency format for the store. For example: $, £, etc.
      primary_locale Type: String Title: Primary Locale Read only: false The primary locale for the store. For example: en, de, etc.
      timezone Type: String Title: Timezone Read only: false The timezone for the store.
      phone Type: String Title: Phone Read only: false The store phone number.
      address Type: Object Title: Address Read only: false The store address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The store’s mailing address.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the store’s mailing address.
      city Type: String Title: City Read only: false The city the store is located in.
      province Type: String Title: Province Read only: false The store’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the store’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The store’s postal or zip code.
      country Type: String Title: Country Code Read only: false The store’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for to the store’s country.
      longitude Type: Number Title: Longitude Read only: false The longitude of the store location.
      latitude Type: Number Title: Latitude Read only: false The latitude of the store location.
      connected_site Type: Object Title: Connected Site Read only: true The Connected Site associated with the store.
      Show properties
      site_foreign_id Type: String Title: Connected Site Foreign ID Read only: true The unique identifier for the connected site.
      site_script Type: Object Title: Script Read only: true The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: true The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: true A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: true The date and time the store was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the store 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' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Tue, 09 Feb 2016 20:34:02 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2756
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 50e1f9c0-2d90-499e-b314-996106f32903
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Collection.json>; rel="describedBy"
      
      {
        "stores": [
          {
            "id": "MC001",
            "list_id": "205d96e6b4",
            "name": "Freddie's Merchandise",
            "domain": "freddiesjokes.com",
            "email_address": "store@freddiesjokes.com",
            "currency_code": "USD",
            "money_format": "",
            "primary_locale": "",
            "timezone": "Eastern",
            "phone": "",
            "address": {
              "address1": "675 Ponce de Leon Ave NE",
              "address2": "Suite 5000",
              "city": "Atlanta, GA 30308",
              "province": "",
              "province_code": "",
              "postal_code": "",
              "country": "",
              "country_code": "",
              "longitude": 0,
              "latitude": 0
            },
            "created_at": "2016-02-09T20:26:59+00:00",
            "updated_at": "2016-02-09T20:26:59+00:00",
            "_links": [
              {
                "rel": "self",
                "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": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
                "method": "DELETE"
              },
              {
                "rel": "customers",
                "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": "products",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "orders",
                "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": "carts",
                "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"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Collection.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Namespace.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/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 store

      GET /ecommerce/stores/{store_id}

      Get information about a specific store.

      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.

      Response body parameters

      id Type: String Title: Store Foreign ID Read only: true The unique identifier for the store.
      list_id Type: String Title: List ID Read only: true The unique identifier for the MailChimp List that’s associated with the store. The list_id for a specific store can’t change.
      name Type: String Title: Store Name Read only: false The name of the store.
      platform Type: String Title: Platform Read only: false The e-commerce platform of the store.
      domain Type: String Title: Domain Read only: false The store domain.
      is_syncing Type: Boolean Title: Is Syncing Read only: false Whether the e-commerce store is currently syncing.
      email_address Type: String Title: Email Address Read only: false The email address for the store.
      currency_code Type: String Title: Currency Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      money_format Type: String Title: Money Format Read only: false The currency format for the store. For example: $, £, etc.
      primary_locale Type: String Title: Primary Locale Read only: false The primary locale for the store. For example: en, de, etc.
      timezone Type: String Title: Timezone Read only: false The timezone for the store.
      phone Type: String Title: Phone Read only: false The store phone number.
      address Type: Object Title: Address Read only: false The store address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The store’s mailing address.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the store’s mailing address.
      city Type: String Title: City Read only: false The city the store is located in.
      province Type: String Title: Province Read only: false The store’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the store’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The store’s postal or zip code.
      country Type: String Title: Country Code Read only: false The store’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for to the store’s country.
      longitude Type: Number Title: Longitude Read only: false The longitude of the store location.
      latitude Type: Number Title: Latitude Read only: false The latitude of the store location.
      connected_site Type: Object Title: Connected Site Read only: true The Connected Site associated with the store.
      Show properties
      site_foreign_id Type: String Title: Connected Site Foreign ID Read only: true The unique identifier for the connected site.
      site_script Type: Object Title: Script Read only: true The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: true The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: true A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: true The date and time the store was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the store 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/MC002' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 17:04:17 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2191
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 44a19a1a-3fd9-4593-ba0e-e6b905784d8a
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json>; rel="describedBy"
      
      {
        "id": "MC002",
        "list_id": "205d96e6b4",
        "name": "Freddie's Shirt Sales",
        "domain": "freddiesjokes.com",
        "email_address": "shirts@freddiesjokes.com",
        "currency_code": "USD",
        "money_format": "",
        "primary_locale": "",
        "timezone": "Eastern",
        "phone": "",
        "address": {
          "address1": "675 Ponce de Leon Ave NE",
          "address2": "Suite 5000",
          "city": "Atlanta, GA 30308",
          "province": "",
          "province_code": "",
          "postal_code": "",
          "country": "",
          "country_code": "",
          "longitude": 0,
          "latitude": 0
        },
        "created_at": "2016-02-10T17:03:23+00:00",
        "updated_at": "2016-02-10T17:03:23+00:00",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Collection.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "upsert",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "PUT",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "DELETE"
          },
          {
            "rel": "customers",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/customers",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Collection.json"
          },
          {
            "rel": "products",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/products",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
          },
          {
            "rel": "orders",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/orders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
          },
          {
            "rel": "carts",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/carts",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.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.
    • Update a store

      PATCH /ecommerce/stores/{store_id}

      Update a store.

      Path parameters

      store_id The store id.

      Request body parameters

      name Type: String Title: Store Name Read only: false The name of the store.
      platform Type: String Title: Platform Read only: false The e-commerce platform of the store.
      domain Type: String Title: Domain Read only: false The store domain.
      is_syncing Type: Boolean Title: Is Syncing Read only: false Whether the e-commerce store is currently syncing.
      email_address Type: String Title: Email Address Read only: false The email address for the store.
      currency_code Type: String Title: Currency Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      money_format Type: String Title: Money Format Read only: false The currency format for the store. For example: $, £, etc.
      primary_locale Type: String Title: Primary Locale Read only: false The primary locale for the store. For example: en, de, etc.
      timezone Type: String Title: Timezone Read only: false The timezone for the store.
      phone Type: String Title: Phone Read only: false The store phone number.
      address Type: Object Title: Address Read only: false The store address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The store’s mailing address.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the store’s mailing address.
      city Type: String Title: City Read only: false The city the store is located in.
      province Type: String Title: Province Read only: false The store’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the store’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The store’s postal or zip code.
      country Type: String Title: Country Code Read only: false The store’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for to the store’s country.
      longitude Type: Number Title: Longitude Read only: false The longitude of the store location.
      latitude Type: Number Title: Latitude Read only: false The latitude of the store location.

      Response body parameters

      id Type: String Title: Store Foreign ID Read only: true The unique identifier for the store.
      list_id Type: String Title: List ID Read only: true The unique identifier for the MailChimp List that’s associated with the store. The list_id for a specific store can’t change.
      name Type: String Title: Store Name Read only: false The name of the store.
      platform Type: String Title: Platform Read only: false The e-commerce platform of the store.
      domain Type: String Title: Domain Read only: false The store domain.
      is_syncing Type: Boolean Title: Is Syncing Read only: false Whether the e-commerce store is currently syncing.
      email_address Type: String Title: Email Address Read only: false The email address for the store.
      currency_code Type: String Title: Currency Read only: false The three-letter ISO 4217 code for the currency that the store accepts.
      money_format Type: String Title: Money Format Read only: false The currency format for the store. For example: $, £, etc.
      primary_locale Type: String Title: Primary Locale Read only: false The primary locale for the store. For example: en, de, etc.
      timezone Type: String Title: Timezone Read only: false The timezone for the store.
      phone Type: String Title: Phone Read only: false The store phone number.
      address Type: Object Title: Address Read only: false The store address.
      Show properties
      address1 Type: String Title: Address Field 1 Read only: false The store’s mailing address.
      address2 Type: String Title: Address Field 2 Read only: false An additional field for the store’s mailing address.
      city Type: String Title: City Read only: false The city the store is located in.
      province Type: String Title: Province Read only: false The store’s state name or normalized province.
      province_code Type: String Title: Province Code Read only: false The two-letter code for the store’s province or state.
      postal_code Type: String Title: Postal Code Read only: false The store’s postal or zip code.
      country Type: String Title: Country Code Read only: false The store’s country.
      country_code Type: String Title: Country Code Read only: false The two-letter code for to the store’s country.
      longitude Type: Number Title: Longitude Read only: false The longitude of the store location.
      latitude Type: Number Title: Latitude Read only: false The latitude of the store location.
      connected_site Type: Object Title: Connected Site Read only: true The Connected Site associated with the store.
      Show properties
      site_foreign_id Type: String Title: Connected Site Foreign ID Read only: true The unique identifier for the connected site.
      site_script Type: Object Title: Script Read only: true The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: true The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: true A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: true The date and time the store was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the store 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/MC002' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"id" : "MC002", "list_id" : "205d96e6b4", "name" : "Freddie'\''s T-Shirt Sales", "domain" : "freddiesjokes.com", "email_address" : "shirts@freddiesjokes.com", "currency_code" : "USD", "primary-locale" : "us", "timezone" : "Eastern", "address" : {"address1" : "675 Ponce de Leon Ave NE", "address2" : "Suite 5000", "city" : "Atlanta, GA 30308"}}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 17:05:28 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2193
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: d7b7933f-e920-4809-a103-c399ea651a2f
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json>; rel="describedBy"
      
      {
        "id": "MC002",
        "list_id": "205d96e6b4",
        "name": "Freddie's T-Shirt Sales",
        "domain": "freddiesjokes.com",
        "email_address": "shirts@freddiesjokes.com",
        "currency_code": "USD",
        "money_format": "",
        "primary_locale": "",
        "timezone": "Eastern",
        "phone": "",
        "address": {
          "address1": "675 Ponce de Leon Ave NE",
          "address2": "Suite 5000",
          "city": "Atlanta, GA 30308",
          "province": "",
          "province_code": "",
          "postal_code": "",
          "country": "",
          "country_code": "",
          "longitude": 0,
          "latitude": 0
        },
        "created_at": "2016-02-10T17:03:23+00:00",
        "updated_at": "2016-02-10T17:05:28+00:00",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Collection.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "upsert",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "PUT",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002",
            "method": "DELETE"
          },
          {
            "rel": "customers",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/customers",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Customers/Collection.json"
          },
          {
            "rel": "products",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/products",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
          },
          {
            "rel": "orders",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/orders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Orders/Collection.json"
          },
          {
            "rel": "carts",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC002/carts",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Carts/Collection.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.
    • Delete a store

      DELETE /ecommerce/stores/{store_id}

      Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.

      Path parameters

      store_id The store id.

      Example request

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

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Wed, 10 Feb 2016 17:06:05 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: ea68b1b9-3f56-4322-ae68-9ee83d3e52a1
                                      

      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.