Products Import Format

This section describes how to provide product data to the import service.

{
  "$ref": "#/definitions/productSchema",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "productSchema": {
      "type": "object",
      "properties": {
        "products": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "sku": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "title": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 256
              },
              "listPrice": {
                "type": "number",
                "minimum": 0,
                "multipleOf": 0.01
              }
            },
            "required": ["sku", "title", "description", "listPrice"],
            "additionalProperties": false
          },
          "minItems": 1,
          "description": "A list of products available to assign to orders"
        }
      },
      "required": ["products"],
      "additionalProperties": false
    }
  }
}

Field Descriptions

• sku - the unique ID for the product used in in its current platform. Must match up with the skus provided when creating Orders.

• title - the name of the product.

• description - a short description of the product.

• listPrice - the price of the product, up to 2 decimal places.

Example

{
  "products": [
    {
      "sku": "968616db-495b-4aae-a4fa-129914210d6d",
      "title": "My amazing product",
      "description": "One of the best products of all time",
      "listPrice": 59.99
    },
    {
      "sku": "b188d947-9590-445f-b9c3-b47b2ae7e537",
      "title": "My average product",
      "description": "One of the products of all time",
      "listPrice": 29.99
    }
  ]
}