Elastic Path Commerce Cloud Product Import

The Elastic Path Commerce Cloud Product Import is a utility in the Integrations Hub in Commerce Manager that enables you to import Elastic Path Commerce Cloud product data from one Elastic Path Commerce Cloud store to another. The Elastic Path Commerce Cloud Product Import utility can import:

• Product data files of any size.
• Product variations.
• Any media files available with products.
• Localized product names and descriptions.

For more information, watch a video.

An example of how product data is imported using a Product Import integration is described below.

1. Create a JSON file with the product data you want to import. You can have more than one JSON file, depending on your requirements. See Product Import Integration File Format.

2. Configure a Product Import integration in the store where you want to import the product data. This creates the webhooks that consumes the message and JSON files when you send the API request to import the product data.

3. In Postman, run POST {{gzip-file-url-handler-webhook-url}} request. As part of the request, you must supply the Gzip file URLs for the JSON files you want to process as part of the import. See Using Product Import Integration Files.

   • The Product Import integration processes your Gzip files.
   • The products are imported to the store.

The data that you provide to the Product Import Integration must conform to JSON Lines text format and conform to the following product model. The Product Import JSON Schema can be used to validate that your individual product objects are in the correct format.

Locales must be specified for product names and descriptions. You can have as many localized names and descriptions as needed.

{
  name: [
    {
      locale: "en",
      value: "en-name",
    },
  ],
  description: [
    {
      locale: "en",
      value: "en-description",
    },
  ],
  slug: "slug",
  sku: "sku",
  productType: "product",
  status: "draft",
  commodityType: "digital",
  mpn: "mpn",
  attributes: [
    {
      templateSlug: "products(ps)",
      templateAttributes: [
        {
          fieldSlug: "dateAttribute",
          type: "date",
          value: "2021-05-28T15:59:48.790Z",
        },
        {
          fieldSlug: "integerAttribute",
          type: "integer",
          value: 1,
        },
        {
          fieldSlug: "stringAttribute",
          type: "string",
          value: "dolore pariatur enim cillum",
        },
      ],
    },
  ],
}

{
  name: [
    {
      locale: "en",
      value: "en-name",
    },
  ],
  slug: "slug",
  sku: "sku",
  productType: "product",
  status: "draft",
  commodityType: "digital",
  skuProducts: [
    {
      slug: "skuSlug",
      sku: "skuSku",
      productType: "sku",
      name: [
        {
          locale: "skuLocale",
          value: "skuName",
        },
      ],
      status: "live",
      commodityType: "digital",
      variation: [
        {
          variantSlug: "variantSlug1",
          optionName: "optionName",
        },
      ],
    },
  ],
}

To invoke the product import, you must invoke the webhook created when you configure the Product Import integration and supply the Gzip file URLs as part of the payload. See Importing your Product Data. We recommend that URLs are signed with an expiration date. See Sharing objects using presigned URLs.

{
    "gzipFileUrls": [
        "https://{path}/products.json.gz"
    ],
    "fileIndex": 0,
    "page": 0,
    "pageSize": 1000
}

1. The store that you are importing your product data set into must meet the following prerequisites:

   • The templates and attributes defined in the product data that you are importing must exist in the store that you are importing the product data into.
   • The variations defined in the product data that you are importing must exist in the store that you are importing the product data into. If the variations defined in the product data import have options, you do not need to create those options in your store. The Product Import automatically creates the options for you as part of the product import.

2. You must have a JSON file configured that defines the product data you want to import. See Product Import Integration File Formats.

Once you have met the Prerequistes, you are ready to configure the product import integration in Integrations Hub.

1. In Commerce Manager, go to the store where you want to import product data.

2. Go to COMPOSER > Integrations Hub.

3. Under Store Management & Configuration, click Elastic Path Commerce Cloud Product Import. The Elastic Path Commerce Cloud Product Import integration guides you through the steps you need to follow to complete the integration.

4. Click Configure. The Trigger details are displayed. Note: These fields are blank the first time you configure the integration.

   • Gzip File URL Handler - The webhook that consumes your Gzip files.
   • Page Product Loader - The webhook that processes each page of products until all pages are processed.

5. Click Next. The Elastic Path Commerce Cloud Connection page is displayed.

6. Complete the information in the Elastic Path Commerce Cloud Connection page. You can find this information in SYSTEM > Application Keys in Commerce Manager when logged in as a user with Seller Admin privileges. See Application Keys.

   • Client-ID - Your Elastic Path Commerce Cloud Client ID.
   • Client-Secret - Your Elastic Path Commerce Cloud Client Secret.

   The table below describes the options you can configure.

   Option	Description
   Keep Alive Flag	Turn on the Keep Alive Flag toggle if you want to specify keep alive intervals for this integration.
   Keep Alive Interval	Specify keep alive interval for this integration. Default value is 10000.
   Throttle Interval	Specify throttle interval for this integration. Default value is 125. This supports staying within rate limits.
   Throttle Limit	Specify throttle request limit interval for this integration. Default value is 3. This supports staying within rate limits.
   Token URL	Your Elastic Path Commerce Cloud API Token URL. For example, api.motlin.com/oauth/<access_token> (EU) or useast.api.elasticpath.com/oauth/<access_token> (US).

7. Click Connect.

8. Once you have successfully connected to Elastic Path Commerce Cloud, you can configure the following:

   Option	Description
   Elapsed Execution Time Cutoff	The number of seconds to wait before the product import is stopped, if page processing has halted for any reason. This may need to be increased if the number of products being processed for the store is exceptionally large.
   Default Page Size	The default page size processed when importing.
   Log Level	From Log Level list, select the level of logging.

9. Click Finish. Your integration is enabled. You must enable a Product Import integration on each store where you want to import your product data set.

You can perform the product import using Postman.

1. Go to a store.
2. Go to COMPOSER > Integrations Hub.
3. Under Store Management & Configuration, select Elastic Path Commerce Cloud Product Import. You must have configured a Product Import integration before you can import any resources into this store. See Configuring the Product Import Integration.
4. From Summary > Trigger Details, click Gzip File URL Handler to display the webhook.
5. Select Copy to Clipboard to copy the URL.
6. Go to Postman.
7. Open POST {{gzip-file-url-handler-webhook-url}} where gzip-file-url-handler-webhook-url is the webhook you copied in step 5.
8. In Body, add the list of Gzip file URLs for the JSON files you want to import. See Product Import Integration File Format.
9. Run POST {{gzip-file-url-handler-webhook-url}}.
10. When the import has finished, if you go to your store, you should see all the resources you just imported.

You can debug any issues in Executions. Click an execution to see the execution details. The Logs shows the output and any errors or warnings.

Select Retry to initiate an execution again.