v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Create Product

Creates new product for referenced catalog

post/sites/multiscreen/{site_name}/ecommerce/products

Path parameters

site_namestring required

The unique identifier for the target Site.

Request body

descriptionstring

Product description

external_idstring

Product external id

managed_inventoryboolean

Indicated if this product should have inventory management

namestring required

Product name

quantityinteger

Available inventory, relevant only if set on the product is managed inventory as true and product has no variations

requires_shippingboolean

Indicated if this product is shippable or not

skustring

Stock keeping unit of given product

statusstring

[ACTIVE, HIDDEN] Only entities in published state will be available to store front

stock_statusstring

[ IN_STOCK, OUT_OF_STOCK ]

typestring

[ PHYSICAL, DIGITAL, SERVICE, DONATION ]

Response

200

descriptionstring

external_idstring

idstring

managed_inventoryboolean

namestring

quantityinteger

requires_shippingboolean

skustring

statusstring

stock_statusstring

typestring

Example response

{
  "categories": [
    {
      "id": "WMd1xylGrp",
      "title": "Men shoes"
    }
  ],
  "custom_fields": [
    {
      "id": "WMd1xylGrp",
      "image": {
        "alt": "Image of fancy shirt",
        "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
      },
      "value": "string"
    }
  ],
  "description": "The most amazing t-shirt ever sold",
  "external_id": "KTP9XGbSg2",
  "id": "IakdKbiUiK",
  "images": [
    {
      "alt": "Image of fancy shirt",
      "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
    }
  ],
  "managed_inventory": true,
  "name": "Amazing T-shirt",
  "options": [
    {
      "choices": [
        {
          "id": "db3je27rg7",
          "value": "45"
        }
      ],
      "id": "WMd1xylGrp",
      "name": "Shirt size"
    }
  ],
  "prices": [
    {
      "compare_at_price": "19.99",
      "currency": "USD",
      "price": "12.34"
    }
  ],
  "quantity": 25,
  "requires_shipping": true,
  "seo": {
    "description": "Amazing T-shirt made with 100% biologic cotton",
    "product_url": "amazing-t-shirt",
    "title": "Amazing T-shirt"
  },
  "sku": "UGG-BB-PUR-06",
  "status": "HIDDEN",
  "stock_status": "IN_STOCK",
  "type": "PHYSICAL",
  "variations": [
    {
      "external_id": "KTP9XGbSg2",
      "id": "KTP9XGbSg2",
      "images": [
        {
          "alt": "Image of fancy shirt",
          "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
        }
      ],
      "options": [
        {
          "choice_id": "db3je27rg7",
          "choice_value": "45",
          "option_id": "WMd1xylGrp",
          "option_name": "Shirt size"
        }
      ],
      "price_difference": "string",
      "quantity": 25,
      "sku": "UGG-BB-PUR-06",
      "status": "ACTIVE"
    }
  ]
}