Products

E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant.

Subresources

Available methods

    • Add a new product to a store

      POST /ecommerce/stores/{store_id}/products

      Add a new product to a store.

      Path parameters

      store_id The store id.

      Request body parameters

      id Type: String Title: Product Foreign ID Read only: false A unique identifier for the product.
      title Type: String Title: Title Read only: false The title of a product.
      handle Type: String Title: Handle Read only: false The handle of a product.
      url Type: String Title: Product URL Read only: false The URL for a product.
      description Type: String Title: Description Read only: false The description of a product.
      type Type: String Title: Type Read only: false The type of product.
      vendor Type: String Title: Vendor Read only: false The vendor for a product.
      image_url Type: String Title: Product Image URL Read only: false The image URL for a product.
      variants Type: Array Title: Product Variants Read only: false An array of the product’s variants. At least one variant is required for each product. A variant can use the same id and title as the parent product.
      Show properties
      id Type: String Title: Product Variant Foreign ID Read only: false A unique identifier for the product variant.
      title Type: String Title: Title Read only: false The title of a product variant.
      url Type: String Title: URL Read only: false The URL for a product variant.
      sku Type: String Title: SKU Read only: false The stock keeping unit (SKU) of a product variant.
      price Type: Number Title: Price Read only: false The price of a product variant.
      inventory_quantity Type: Integer Title: Inventory Quantity Read only: false The inventory quantity of a product variant.
      image_url Type: String Title: Image URL Read only: false The image URL for a product variant.
      backorders Type: String Title: Backorders Read only: false The backorders of a product variant.
      visibility Type: String Title: Visibility Read only: false The visibility of a product variant.
      images Type: Array Title: Product Images Read only: false An array of the product’s images.
      Show properties
      id Type: String Title: Image Foreign ID Read only: false A unique identifier for the product image.
      url Type: String Title: URL Read only: false The URL for a product image.
      variant_ids Type: Array Title: Product Variants Read only: false The list of product variants using the image.
      published_at_foreign Type: String Title: Foreign Publish Time Read only: false The date and time the product was published.

      Response body parameters

      id Type: String Title: Product Foreign ID Read only: true A unique identifier for the product.
      title Type: String Title: Title Read only: false The title of a product.
      handle Type: String Title: Handle Read only: false The handle of a product.
      url Type: String Title: Product URL Read only: false The URL for a product.
      description Type: String Title: Description Read only: false The description of a product.
      type Type: String Title: Type Read only: false The type of product.
      vendor Type: String Title: Vendor Read only: false The vendor for a product.
      image_url Type: String Title: Product Image URL Read only: false The image URL for a product.
      variants Type: Array Title: Product Variants Read only: false An array of the product’s variants.
      Show properties
      id Type: String Title: Product Variant Foreign ID Read only: true A unique identifier for the product variant.
      title Type: String Title: Title Read only: false The title of a product variant.
      url Type: String Title: URL Read only: false The URL for a product variant.
      sku Type: String Title: SKU Read only: false The stock keeping unit (SKU) of a product variant.
      price Type: Number Title: Price Read only: false The price of a product variant.
      inventory_quantity Type: Integer Title: Inventory Quantity Read only: false The inventory quantity of a product variant.
      image_url Type: String Title: Image URL Read only: false The image URL for a product variant.
      backorders Type: String Title: Backorders Read only: false The backorders of a product variant.
      visibility Type: String Title: Visibility Read only: false The visibility of a product variant.
      created_at Type: String Title: Creation Time Read only: true The date and time the product was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the product 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.
      images Type: Array Title: Product Images Read only: false An array of the product’s images.
      Show properties
      id Type: String Title: Image Foreign ID Read only: false A unique identifier for the product image.
      url Type: String Title: URL Read only: false The URL for a product image.
      variant_ids Type: Array Title: Product Variants Read only: false The list of product variants using the image.
      _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.
      published_at_foreign Type: String Title: Foreign Publish Time Read only: false The date and time the product was published.
      _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/products' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"id": "PROD001", "title": "Freddie'\''s Jokes", "handle": "freddie_jokes", "url": "freddiesjokes.com", "description": "A collection of Freddie'\''s favorite jokes.", "type": "Book",
      "vendor": "MailChimp", "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_OG.png", "variants": [{"id": "PROD001A", "title": "Freddie'\''s Jokes Volume 1", "url": "", "sku": "Jokes001A", "price": 5, "inventory_quantity": 100, "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png", "backorders": "0", "visibility": "visible", "created_at": "2016-02-08T13:06:44+00:00", "updated_at": "2016-02-08T13:06:44+00:00"},{
      "id": "PROD001B", "title": "Freddie'\''s Jokes Volume 2", "url": "", "sku": "Jokes002", "price": 5, "inventory_quantity": 99, "image_url": "https://static.mailchimp.com/web/brand-assets/bro_freddie.png", "backorders": "0", "visibility": "true", "created_at": "2016-02-08T22:14:37+00:00", "updated_at": "2016-02-08T22:22:38+00:00"}]}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 15:33:50 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 3828
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 549c2f68-5c6b-4e34-9fbc-e1983bded7db
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json>; rel="describedBy"
      
      {
        "id": "PROD001",
        "title": "Freddie's Jokes",
        "handle": "freddie_jokes",
        "url": "freddiesjokes.com",
        "description": "A collection of Freddie's favorite jokes.",
        "type": "Book",
        "vendor": "MailChimp",
        "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_OG.png",
        "variants": [
          {
            "id": "PROD001A",
            "title": "Freddie's Jokes Volume 1",
            "url": "",
            "sku": "Jokes001A",
            "price": 5,
            "inventory_quantity": 100,
            "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png",
            "backorders": "0",
            "visibility": "visible",
            "created_at": "2016-02-10T15:33:49+00:00",
            "updated_at": "2016-02-10T15:33:49+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "DELETE"
              }
            ]
          },
          {
            "id": "PROD001B",
            "title": "Freddie's Jokes Volume 2",
            "url": "",
            "sku": "Jokes002",
            "price": 5,
            "inventory_quantity": 99,
            "image_url": "https://static.mailchimp.com/web/brand-assets/bro_freddie.png",
            "backorders": "0",
            "visibility": "true",
            "created_at": "2016-02-10T15:33:50+00:00",
            "updated_at": "2016-02-10T15:33:50+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "DELETE"
              }
            ]
          }
        ],
        "published_at_foreign": "",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001",
            "method": "DELETE"
          },
          {
            "rel": "variants",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001/variants",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/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.
    • GET /ecommerce/stores/{store_id}/products Get information about a store’s products.
      GET /ecommerce/stores/{store_id}/products/{product_id} Get information about a specific product

      Get information about a store's products.

      GET /ecommerce/stores/{store_id}/products

      Get information about a store’s products.

      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.
      products Type: Array Title: Products Read only: false An array of objects, each representing a store product.
      Show properties
      id Type: String Title: Product Foreign ID Read only: true A unique identifier for the product.
      title Type: String Title: Title Read only: false The title of a product.
      handle Type: String Title: Handle Read only: false The handle of a product.
      url Type: String Title: Product URL Read only: false The URL for a product.
      description Type: String Title: Description Read only: false The description of a product.
      type Type: String Title: Type Read only: false The type of product.
      vendor Type: String Title: Vendor Read only: false The vendor for a product.
      image_url Type: String Title: Product Image URL Read only: false The image URL for a product.
      variants Type: Array Title: Product Variants Read only: false An array of the product’s variants.
      Show properties
      id Type: String Title: Product Variant Foreign ID Read only: true A unique identifier for the product variant.
      title Type: String Title: Title Read only: false The title of a product variant.
      url Type: String Title: URL Read only: false The URL for a product variant.
      sku Type: String Title: SKU Read only: false The stock keeping unit (SKU) of a product variant.
      price Type: Number Title: Price Read only: false The price of a product variant.
      inventory_quantity Type: Integer Title: Inventory Quantity Read only: false The inventory quantity of a product variant.
      image_url Type: String Title: Image URL Read only: false The image URL for a product variant.
      backorders Type: String Title: Backorders Read only: false The backorders of a product variant.
      visibility Type: String Title: Visibility Read only: false The visibility of a product variant.
      created_at Type: String Title: Creation Time Read only: true The date and time the product was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the product 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.
      images Type: Array Title: Product Images Read only: false An array of the product’s images.
      Show properties
      id Type: String Title: Image Foreign ID Read only: false A unique identifier for the product image.
      url Type: String Title: URL Read only: false The URL for a product image.
      variant_ids Type: Array Title: Product Variants Read only: false The list of product variants using the image.
      _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.
      published_at_foreign Type: String Title: Foreign Publish Time Read only: false The date and time the product was published.
      _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/products' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 15:35:38 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 4474
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: bd0c7af3-a296-44b9-a276-f1885d43df4e
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json>; rel="describedBy"
      
      {
        "store_id": "MC001",
        "products": [
          {
            "id": "PROD001",
            "title": "Freddie's Jokes",
            "handle": "freddie_jokes",
            "url": "freddiesjokes.com",
            "description": "A collection of Freddie's favorite jokes.",
            "type": "Book",
            "vendor": "MailChimp",
            "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_OG.png",
            "variants": [
              {
                "id": "PROD001A",
                "title": "Freddie's Jokes Volume 1",
                "url": "",
                "sku": "Jokes001A",
                "price": 5,
                "inventory_quantity": 100,
                "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png",
                "backorders": "0",
                "visibility": "visible",
                "created_at": "2016-02-10T15:33:49+00:00",
                "updated_at": "2016-02-10T15:33:49+00:00",
                "_links": [
                  {
                    "rel": "self",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                    "method": "GET",
                    "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
                  },
                  {
                    "rel": "parent",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                    "method": "GET",
                    "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
                  },
                  {
                    "rel": "update",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                    "method": "PATCH",
                    "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
                  },
                  {
                    "rel": "upsert",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                    "method": "PUT",
                    "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
                  },
                  {
                    "rel": "delete",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                    "method": "DELETE"
                  }
                ]
              },
              {
                "id": "PROD001B",
                "title": "Freddie's Jokes Volume 2",
                "url": "",
                "sku": "Jokes002",
                "price": 5,
                "inventory_quantity": 99,
                "image_url": "https://static.mailchimp.com/web/brand-assets/bro_freddie.png",
                "backorders": "0",
                "visibility": "true",
                "created_at": "2016-02-10T15:33:50+00:00",
                "updated_at": "2016-02-10T15:33:50+00:00",
                "_links": [
                  {
                    "rel": "self",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                    "method": "GET",
                    "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
                  },
                  {
                    "rel": "parent",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                    "method": "GET",
                    "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
                  },
                  {
                    "rel": "update",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                    "method": "PATCH",
                    "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
                  },
                  {
                    "rel": "upsert",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                    "method": "PUT",
                    "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
                  },
                  {
                    "rel": "delete",
                    "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                    "method": "DELETE"
                  }
                ]
              }
            ],
            "published_at_foreign": "",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001",
                "method": "DELETE"
              },
              {
                "rel": "variants",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001/variants",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Collection.json"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "self",
            "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": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/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 product

      GET /ecommerce/stores/{store_id}/products/{product_id}

      Get information about a specific product.

      Path parameters

      store_id The store id.
      product_id The id for the product of a store.

      Query string parameters

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

      Response body parameters

      id Type: String Title: Product Foreign ID Read only: true A unique identifier for the product.
      title Type: String Title: Title Read only: false The title of a product.
      handle Type: String Title: Handle Read only: false The handle of a product.
      url Type: String Title: Product URL Read only: false The URL for a product.
      description Type: String Title: Description Read only: false The description of a product.
      type Type: String Title: Type Read only: false The type of product.
      vendor Type: String Title: Vendor Read only: false The vendor for a product.
      image_url Type: String Title: Product Image URL Read only: false The image URL for a product.
      variants Type: Array Title: Product Variants Read only: false An array of the product’s variants.
      Show properties
      id Type: String Title: Product Variant Foreign ID Read only: true A unique identifier for the product variant.
      title Type: String Title: Title Read only: false The title of a product variant.
      url Type: String Title: URL Read only: false The URL for a product variant.
      sku Type: String Title: SKU Read only: false The stock keeping unit (SKU) of a product variant.
      price Type: Number Title: Price Read only: false The price of a product variant.
      inventory_quantity Type: Integer Title: Inventory Quantity Read only: false The inventory quantity of a product variant.
      image_url Type: String Title: Image URL Read only: false The image URL for a product variant.
      backorders Type: String Title: Backorders Read only: false The backorders of a product variant.
      visibility Type: String Title: Visibility Read only: false The visibility of a product variant.
      created_at Type: String Title: Creation Time Read only: true The date and time the product was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the product 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.
      images Type: Array Title: Product Images Read only: false An array of the product’s images.
      Show properties
      id Type: String Title: Image Foreign ID Read only: false A unique identifier for the product image.
      url Type: String Title: URL Read only: false The URL for a product image.
      variant_ids Type: Array Title: Product Variants Read only: false The list of product variants using the image.
      _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.
      published_at_foreign Type: String Title: Foreign Publish Time Read only: false The date and time the product was published.
      _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/products/PROD001' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 10 Feb 2016 15:38:46 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 3828
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 68f6ee05-3df0-4dc2-923c-a6d803fead83
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json>; rel="describedBy"
      
      {
        "id": "PROD001",
        "title": "Freddie's Jokes",
        "handle": "freddie_jokes",
        "url": "freddiesjokes.com",
        "description": "A collection of Freddie's favorite jokes.",
        "type": "Book",
        "vendor": "MailChimp",
        "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_OG.png",
        "variants": [
          {
            "id": "PROD001A",
            "title": "Freddie's Jokes Volume 1",
            "url": "",
            "sku": "Jokes001A",
            "price": 5,
            "inventory_quantity": 100,
            "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png",
            "backorders": "0",
            "visibility": "visible",
            "created_at": "2016-02-10T15:33:49+00:00",
            "updated_at": "2016-02-10T15:33:49+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "DELETE"
              }
            ]
          },
          {
            "id": "PROD001B",
            "title": "Freddie's Jokes Volume 2",
            "url": "",
            "sku": "Jokes002",
            "price": 5,
            "inventory_quantity": 99,
            "image_url": "https://static.mailchimp.com/web/brand-assets/bro_freddie.png",
            "backorders": "0",
            "visibility": "true",
            "created_at": "2016-02-10T15:33:50+00:00",
            "updated_at": "2016-02-10T15:33:50+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "DELETE"
              }
            ]
          }
        ],
        "published_at_foreign": "",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001",
            "method": "DELETE"
          },
          {
            "rel": "variants",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/9/products/PROD001/variants",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/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 specific product

      PATCH /ecommerce/stores/{store_id}/products/{product_id}

      Update a specific product.

      Path parameters

      store_id The store id.
      product_id The id for the product of a store.

      Request body parameters

      title Type: String Title: Title Read only: false The title of a product.
      handle Type: String Title: Handle Read only: false The handle of a product.
      url Type: String Title: Product URL Read only: false The URL for a product.
      description Type: String Title: Description Read only: false The description of a product.
      type Type: String Title: Type Read only: false The type of product.
      vendor Type: String Title: Vendor Read only: false The vendor for a product.
      image_url Type: String Title: Product Image URL Read only: false The image URL for a product.
      variants Type: Array Title: Product Variants Read only: false An array of the product’s variants. At least one variant is required for each product. A variant can use the same id and title as the parent product.
      Show properties
      title Type: String Title: Title Read only: false The title of a product variant.
      url Type: String Title: URL Read only: false The URL for a product variant.
      sku Type: String Title: SKU Read only: false The stock keeping unit (SKU) of a product variant.
      price Type: Number Title: Price Read only: false The price of a product variant.
      inventory_quantity Type: Integer Title: Inventory Quantity Read only: false The inventory quantity of a product variant.
      image_url Type: String Title: Image URL Read only: false The image URL for a product variant.
      backorders Type: String Title: Backorders Read only: false The backorders of a product variant.
      visibility Type: String Title: Visibility Read only: false The visibility of a product variant.
      images Type: Array Title: Product Images Read only: false An array of the product’s images.
      Show properties
      id Type: String Title: Image Foreign ID Read only: false A unique identifier for the product image.
      url Type: String Title: URL Read only: false The URL for a product image.
      variant_ids Type: Array Title: Product Variants Read only: false The list of product variants using the image.
      published_at_foreign Type: String Title: Foreign Publish Time Read only: false The date and time the product was published.

      Response body parameters

      id Type: String Title: Product Foreign ID Read only: true A unique identifier for the product.
      title Type: String Title: Title Read only: false The title of a product.
      handle Type: String Title: Handle Read only: false The handle of a product.
      url Type: String Title: Product URL Read only: false The URL for a product.
      description Type: String Title: Description Read only: false The description of a product.
      type Type: String Title: Type Read only: false The type of product.
      vendor Type: String Title: Vendor Read only: false The vendor for a product.
      image_url Type: String Title: Product Image URL Read only: false The image URL for a product.
      variants Type: Array Title: Product Variants Read only: false An array of the product’s variants.
      Show properties
      id Type: String Title: Product Variant Foreign ID Read only: true A unique identifier for the product variant.
      title Type: String Title: Title Read only: false The title of a product variant.
      url Type: String Title: URL Read only: false The URL for a product variant.
      sku Type: String Title: SKU Read only: false The stock keeping unit (SKU) of a product variant.
      price Type: Number Title: Price Read only: false The price of a product variant.
      inventory_quantity Type: Integer Title: Inventory Quantity Read only: false The inventory quantity of a product variant.
      image_url Type: String Title: Image URL Read only: false The image URL for a product variant.
      backorders Type: String Title: Backorders Read only: false The backorders of a product variant.
      visibility Type: String Title: Visibility Read only: false The visibility of a product variant.
      created_at Type: String Title: Creation Time Read only: true The date and time the product was created.
      updated_at Type: String Title: Update Time Read only: true The date and time the product 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.
      images Type: Array Title: Product Images Read only: false An array of the product’s images.
      Show properties
      id Type: String Title: Image Foreign ID Read only: false A unique identifier for the product image.
      url Type: String Title: URL Read only: false The URL for a product image.
      variant_ids Type: Array Title: Product Variants Read only: false The list of product variants using the image.
      _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.
      published_at_foreign Type: String Title: Foreign Publish Time Read only: false The date and time the product was published.
      _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/products/PROD001' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"variants": [{"id": "PROD001A", "title": "Freddie'\''s Jokes Volume 1", "url": "", "sku": "Jokes001A", "price": 5, "inventory_quantity": 100, "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png", "backorders": "0", "visibility": "visible", "created_at": "2016-02-08T13:06:44+00:00", "updated_at": "2016-02-08T13:06:44+00:00"},{
      "id": "PROD001B", "title": "Freddie'\''s Jokes Volume 2", "url": "", "sku": "Jokes002", "price": 5, "inventory_quantity": 0, "image_url": "https://static.mailchimp.com/web/brand-assets/bro_freddie.png", "backorders": "0", "visibility": "true", "created_at": "2016-02-08T22:14:37+00:00", "updated_at": "2016-02-08T22:22:38+00:00"}]}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: openresty
      Date: Wed, 26 Oct 2016 18:08:04 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 5435
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 0caec61d-207d-4d2c-b333-276a89d265b6
      Link: <https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json>; rel="describedBy"
      
      {
        "id": "PROD001",
        "title": "Freddie's Jokes",
        "handle": "freddie_jokes",
        "url": "freddiesjokes.com",
        "description": "A collection of Freddie's favorite jokes.",
        "type": "Book",
        "vendor": "MailChimp",
        "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_OG.png",
        "variants": [
          {
            "id": "PROD001A",
            "title": "Freddie's Jokes Volume 1",
            "url": "",
            "sku": "Jokes001A",
            "price": 5,
            "inventory_quantity": 100,
            "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png",
            "backorders": "0",
            "visibility": "visible",
            "created_at": "2016-02-10T15:33:49+00:00",
            "updated_at": "2016-10-26T18:08:04+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001A",
                "method": "DELETE"
              }
            ]
          },
          {
            "id": "PROD001B",
            "title": "Freddie's Jokes Volume 2",
            "url": "",
            "sku": "Jokes002",
            "price": 5,
            "inventory_quantity": 0,
            "image_url": "https://static.mailchimp.com/web/brand-assets/bro_freddie.png",
            "backorders": "0",
            "visibility": "true",
            "created_at": "2016-02-10T15:33:50+00:00",
            "updated_at": "2016-10-26T18:08:04+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001B",
                "method": "DELETE"
              }
            ]
          },
          {
            "id": "PROD001C",
            "title": "Freddie's Jokes Volume 3",
            "url": "",
            "sku": "Jokes001C",
            "price": 5,
            "inventory_quantity": 50,
            "image_url": "https://static.mailchimp.com/web/brand-assets/Freddie_wink.png",
            "backorders": "1",
            "visibility": "visible",
            "created_at": "2016-02-10T15:54:14+00:00",
            "updated_at": "2016-02-10T15:54:14+00:00",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001C",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Collection.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001C",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001C",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants/PROD001C",
                "method": "DELETE"
              }
            ]
          }
        ],
        "published_at_foreign": "",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json"
          },
          {
            "rel": "parent",
            "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": "update",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001",
            "method": "DELETE"
          },
          {
            "rel": "variants",
            "href": "https://usX.api.mailchimp.com/3.0/ecommerce/stores/MC001/products/PROD001/variants",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Stores/Products/Variants/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 product

      DELETE /ecommerce/stores/{store_id}/products/{product_id}

      Delete a product.

      Path parameters

      store_id The store id.
      product_id The id for the product of a store.

      Example request

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

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Wed, 10 Feb 2016 15:41:37 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 5cbfbc36-1937-4e58-b27a-4a7a482d32af
                                      

      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.