ProductCreate

Field	Type	Required	Description
name	LocalizationShort	yes	Localization object, see Entity Localization for further information.
longName	OptionalLocalizationShort		Localization object, see Entity Localization for further information.
shortDescription	OptionalLocalization		Localization object, see Entity Localization for further information.
longDescription	LocalizationDescriptionLong		Localization object, see Entity Localization for further information.
categories	CategoriesMappingCreate
properties	ProductPropertiesCreate
media	LocalizationMedia		Localization object, see Entity Localization for further information. We support type image, video, or pdf. In case of type video, we currently support vimeo and youtube urls
options	ProductOptionsCreate
extras	ProductExtrasCreate
parentProductCode	ParentProductCode		Code of parent product max length 255 · min length 1
modelType	ModelType	yes	Product Model Type one of: standard, configurable, bundle, bundleItem, variant
identifiers	ProductIdentifiers
price	Price
fulfillmentMethods	FulfillmentMethods
unit	Unit		The unit this is product is measured in. one of: null, mg, g, kg, ml, l, cm, m, m2, m3, unit, piece, each, oz, lb, floz, pt, qt, gal, in, ft, yd, ft2 · max length 50
unitValue	UnitValue		The value of units this product represents. Example: 250, in combination with ‘unit’ set to ‘g’ indicates that this product weighs 250 grams. format: float · max length 50
unitPriceRefUom	UnitPriceRefUom		The unit this is product is measured in for base price reference. one of: null, mg, g, kg, ml, l, cm, m, m2, m3, piece, unit, each
unitPriceRefValue	UnitPriceRefValue		The value of units this product’s base price represents. Example: 100, in combination with ‘unitPriceRefUom’ set to ‘g’ indicates that the base price of this product is per 100 grams. format: float · max length 50
hasCatchWeight	HasCatchWeight		Indicates if the product has catch weight default: false
isSerialized	IsSerialized		Indicates if a product has serial numbers
status	Status		‘scheduled’ is deprecated and should not be used anymore. one of: active, inactive, scheduled · default: "active"
startDate	StartDate		Start date when the product should be visible (switch to the “active” status) format: date-time
endDate	EndDate		End date when the product should no longer be visible (switch to the “inactive” status) format: date-time
firstAvailableDate	FirstAvailableDate		Date when the product is buyable (marketing use cases) format: date-time
eolDate	EOLDate		Date when the product is no longer buyable (marketing use cases) format: date-time
isInventoryManaged	IsInventoryManaged	yes
inventoryTreatment	InventoryTreatment		one of: showOutOfStock, allowBackOrders, preOrder, hideInStorefront
shippingInformation	ShippingInformation
rating	Rating		Ratings from (1-5). To save fractions of a rating, pass in e.g. 0.5 for a “1/2 star” representation.
url	Url		max length 500
isTaxed	IsTaxed		default: true
taxClass	TaxClass		max length 255
minQty	MinQty		Minimal amount of product that could be purchased at a single time
maxQty	MaxQty		Maximal amount of product that could be purchased at a single time
code	ProductCode	yes	Code of the product max length 255 · min length 1
externalUpdateDate	ExternalUpdateDate		format: date-time
goodType	GoodType		one of: physical, digital, warranty, insurance · default: "physical"

Example

{
  "name": {
    "en-us": "string in english",
    "de-de": "Zeichenkette auf Deutsch"
  },
  "longName": {
    "en-us": "string in english",
    "de-de": "Zeichenkette auf Deutsch"
  },
  "shortDescription": {
    "en-us": "string in english",
    "de-de": "Zeichenkette auf Deutsch"
  },
  "longDescription": {
    "en-us": "string in english",
    "de-de": "Zeichenkette auf Deutsch"
  },
  "categories": [
    {}
  ],
  "properties": [
    {
      "code": "abc123",
      "name": {
        "en-us": "Color"
      },
      "value": {
        "en-us": [
          "red",
          "white",
          "blue"
        ]
      },
      "type": "simple",
      "displayGroup": "properties",
      "subDisplayGroup": {
        "en-us": "Appearance"
      },
      "isPriced": true,
      "attributePrice": 5.5,
      "unit": "number"
    },
    {
      "code": "attributeCode",
      "value": [
        "attributeValueCode1",
        "attributeValueCode2",
        "attributeValueCode3"
      ],
      "type": "attribute",
      "displayGroup": "properties",
      "subDisplayGroup": {
        "en-us": "Appearance"
      }
    }
  ],
  "media": {
    "en-us": [
      {
        "code": "gdt5-c",
        "url": "https://myAwesomeShop.com/image01.jpg",
        "type": "image",
        "altText": "a translated string",
        "title": "a translated string",
        "sequenceId": 1
      }
    ]
  },
  "options": [
    {
      "values": []
    }
  ],
  "extras": [
    {
      "values": []
    }
  ],
  "parentProductCode": "\"55585\"",
  "modelType": "standard",
  "identifiers": {}
}