--- title: "Replaces the Product resource." method: PUT path: "/products/{id}" tags: ["Product"] --- # Replaces the Product resource. `PUT /products/{id}` Replaces the Product resource. ## Path parameters - `id` string, required ## Request body - Product — Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online. - `id` string - `integration` string — The key of the integration source e.g. "quickbooks", or "xero" - `additionalType` string, nullable — An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. - `alternateName` string, nullable — an alias for the item - `award` string, nullable — an award won by or for this item - `categories` string[], nullable — A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. - `color` string, nullable — the color of the product - `description` string, nullable — a description of the item - `disambiguatingDescription` string, nullable — A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. - `gtin12` string, nullable — The \[GTIN-12\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `gtin13s` string[], nullable — The \[GTIN-13\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `gtin14s` string[], nullable — The \[GTIN-14\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `gtin8s` string[], nullable — The \[GTIN-8\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `image` string, nullable — An image of the item. This can be a \[\[URL\]\] or a fully described \[\[ImageObject\]\]. - `isAccessoryOrSparePartFors` string[], nullable — a pointer to another product (or multiple products) for which this product is an accessory or spare part - `isConsumableFors` string[], nullable — a pointer to another product (or multiple products) for which this product is a consumable - `isRelatedTo` string, iri-reference, nullable — a pointer to another, somehow related product (or multiple products) - `isSimilarTos` string[], nullable — a pointer to another, functionally similar product (or multiple products) - `itemCondition` string, nullable — a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer - `model` string, nullable — The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties. - `mpns` string[], nullable — the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers - `manufacturer` string, nullable — the manufacturer of the product - `name` string, nullable — the name of the item - `productID` string, nullable — The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```. - `releaseDate` string, date-time, nullable — The release date of a product or product model. This can be used to distinguish the exact variant of a product. - `sameA` string, nullable — URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. - `skus` string[], nullable — The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. - `url` string, nullable — URL of the item - `material` string, nullable — A material that something is made from, e.g. leather, wool, cotton, paper. - `productionDate` string, date-time, nullable — The date of production of the item, e.g. vehicle. - `purchaseDate` string, date-time, nullable — The date the item e.g. vehicle was purchased by the current owner. - `identifier` string, nullable — The identifier property represents any kind of identifier for any kind of \[\[Thing\]\], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See \[background notes\](/docs/datamodel.html#identifierBg) for more details. - `srcId` string — Unique identifier for a product - `isActive` string, nullable — Whether the product is active or not - `height` integer, nullable — The height of the product - `width` integer, nullable — Width of the product - `weight` integer, nullable — Weight of the product - `quantity` integer, nullable — Quantity of product available - `availableForPurchase` boolean, nullable — Whether the product is available for purchase or not - `updated` string, nullable — The date and time the product was last modified - `price` integer, nullable — The price of the product - `weightUnit` string, nullable — The unit weight is measured in - `heightUnit` string, nullable — The unit height is measured in - `widthUnit` string, nullable — The unit width is measured in ## Response `200` Product resource updated - Product — Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online. - `id` string - `integration` string — The key of the integration source e.g. "quickbooks", or "xero" - `additionalType` string, nullable — An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. - `alternateName` string, nullable — an alias for the item - `award` string, nullable — an award won by or for this item - `categories` string[], nullable — A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. - `color` string, nullable — the color of the product - `description` string, nullable — a description of the item - `disambiguatingDescription` string, nullable — A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. - `gtin12` string, nullable — The \[GTIN-12\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `gtin13s` string[], nullable — The \[GTIN-13\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `gtin14s` string[], nullable — The \[GTIN-14\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `gtin8s` string[], nullable — The \[GTIN-8\](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See \[GS1 GTIN Summary\](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. - `image` string, nullable — An image of the item. This can be a \[\[URL\]\] or a fully described \[\[ImageObject\]\]. - `isAccessoryOrSparePartFors` string[], nullable — a pointer to another product (or multiple products) for which this product is an accessory or spare part - `isConsumableFors` string[], nullable — a pointer to another product (or multiple products) for which this product is a consumable - `isRelatedTo` string, iri-reference, nullable — a pointer to another, somehow related product (or multiple products) - `isSimilarTos` string[], nullable — a pointer to another, functionally similar product (or multiple products) - `itemCondition` string, nullable — a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer - `model` string, nullable — The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties. - `mpns` string[], nullable — the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers - `manufacturer` string, nullable — the manufacturer of the product - `name` string, nullable — the name of the item - `productID` string, nullable — The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```. - `releaseDate` string, date-time, nullable — The release date of a product or product model. This can be used to distinguish the exact variant of a product. - `sameA` string, nullable — URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. - `skus` string[], nullable — The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. - `url` string, nullable — URL of the item - `material` string, nullable — A material that something is made from, e.g. leather, wool, cotton, paper. - `productionDate` string, date-time, nullable — The date of production of the item, e.g. vehicle. - `purchaseDate` string, date-time, nullable — The date the item e.g. vehicle was purchased by the current owner. - `identifier` string, nullable — The identifier property represents any kind of identifier for any kind of \[\[Thing\]\], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See \[background notes\](/docs/datamodel.html#identifierBg) for more details. - `srcId` string — Unique identifier for a product - `isActive` string, nullable — Whether the product is active or not - `height` integer, nullable — The height of the product - `width` integer, nullable — Width of the product - `weight` integer, nullable — Weight of the product - `quantity` integer, nullable — Quantity of product available - `availableForPurchase` boolean, nullable — Whether the product is available for purchase or not - `updated` string, nullable — The date and time the product was last modified - `price` integer, nullable — The price of the product - `weightUnit` string, nullable — The unit weight is measured in - `heightUnit` string, nullable — The unit height is measured in - `widthUnit` string, nullable — The unit width is measured in ## Other responses - `400` — Invalid input - `404` — Resource not found - `422` — Unprocessable entity --- [API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)