Importing Products

Triggering `import_product_from_url` from the UI

Preconditions

You have Setup Test Environment
You created a Store (Integration) and implemented Authentication
The Store you’re importing from is Healthy and Enabled
1. Verify by visiting the stores’s edit screen. (Settings, Stores, Store)

Steps

Click on “Products“ - left menu
Click on “Import“ - button, top right
You are presented with Stores you can import products from
Paste product URL into the input box and
Navigate to settings, stores, the store you’re developing for
See the directive in logs

Servicing the `import_product_from_url` directive

A Katalys platform user wants to import a new product from the Merchant’s store.

JSON

// POST <https://yourhost/.../path/INTEGRATION_ID>
{
  "directives": [
    {
      "args": {
        "product_url": "https://mertchants-store.com/products/some-product-id"
      },
      "directive": "import_product_from_url",
      "id": "47e92567-e45f-4f35-a0e3-4d6322340c82"
    }
  ]
}

Success response

“result“ (line 4) below should contains Katalys’ product ID.

CODE

{
  "results": [
    {
      "result": "042bd63f-02d2-43d2-8446-46f0a12ce076", // katalys product id
      "source_directive": "import_product_from_url",
      "source_id": "47e92567-e45f-4f35-a0e3-4d6322340c82",
      "status": "ok"
    }
  ]
}

Error response

Set the the status to “error“ and write your own error message.

CODE

{
  "results": [
    {
      "error": "Unusable URL: https://unusable.com/products/wrong",
      "source_directive": "import_product_from_url",
      "source_id": "47e92567-e45f-4f35-a0e3-4d6322340c82",
      "status": "error"
    }
  ]
}

Use the received product_url to work out which product to import. Ideally we’d like to be able to process public product pages, so a Katalys platform user can just grab a public url and turn it into a functional Katalys shop. This does not mean you should be scraping data from the public page, but identify the product and import it properly. For example in some integrations we support importing from a public page and an admin page.

Creating the product

GRAPHQL

mutation Create($input: ProductInput!) {
  createProduct(input: $input) {
    id
  }
}

Below we specify an example of how variables for the above mutation can look like. It is important to understand the following concepts:

A product can have zero, one, or many variants.
When a shop offers a product with variants, a buyer will only be able to purchases one of the variants — never the parent product. The Checkout flow preselects a variant and the buyer is able to switch between the rest of the variants.
Both variants and products share the same attributes and are represented with the Product. During the checkout process, a variant inherits attributes from the parent product. Therefore the variant only needs to specify values that make it different from the parent product.
The external_id attribute is free form text and it’s your decision what to put in there, it should allow you to find the product/variant in the merchant’s store
option_names is present on the product and defines available options for the user to chose from.
option_1_names_path and option_2_names_path are present on the variant and define which options need to be selected for the variant to be chosen.

Example variables for the createOrder() input value.