Product
| Field | Type | Required | Description |
|---|---|---|---|
parentProductCode |
ParentProductCode | Code of parent product max length 255 · min length 1 |
|
modelType |
ModelType | Product Model Type one of: standard, configurable, bundle, bundleItem, variant |
|
identifiers |
ProductIdentifiers | ||
price |
PriceGet | ||
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 | ||
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 | Code of the product max length 255 · min length 1 |
|
name |
NameResolved | Short name of the product max length 255 |
|
longName |
LongNameResolved | Long name of the product max length 255 |
|
categories |
CategoriesResolved | ||
properties |
PropertiesResolved | ||
media |
MediaResolved | ||
externalUpdateDate |
ExternalUpdateDate | format: date-time |
|
visibility |
string |
Indicates if the products should be visibility for the customer. This flag is based on different condition. one of: visible, hidden |
|
goodType |
GoodType | one of: physical, digital, warranty, insurance · default: "physical" |
Example
Section titled “Example”{ "parentProductCode": "\"55585\"", "modelType": "standard", "identifiers": {}, "price": { "pricePerMeasureUnit": 1.5 }, "fulfillmentMethods": [ "simplePickUpInStore" ], "unit": "g", "unitValue": 250, "unitPriceRefUom": "g", "unitPriceRefValue": 100, "hasCatchWeight": true, "isSerialized": true, "status": "active"}
