Properties
| Name | Type | Description |
|---|---|---|
| IsPersisted | boolean | Defines if the SKU is persisted. |
| IsRemoved | boolean | Defines if the SKU is removed. |
| Id | integer | SKU ID. |
| ProductId | integer | Product ID. |
| IsActive | boolean | Defines if the SKU is active or not. |
| Name | string | SKU name. |
| Height | number | SKU height. |
| RealHeight | number | Real SKU height. |
| Width | number | SKU width. |
| RealWidth | number | Real SKU width. |
| Length | number | SKU length. |
| RealLength | number | Real SKU length. |
| WeightKg | number | Weight of the SKU in the measurement [configured in the store](https://help.vtex.com/en/tutorial/filling-in-system-settings--tutorials_269), which by default is in grams. |
| RealWeightKg | number | Real weight of the SKU in the measurement unit [configured in the store](https://help.vtex.com/en/tutorial/filling-in-system-settings--tutorials_269), which by default is in grams. |
| ModalId | integer | Delivery method (modal type) ID. |
| RefId | string | Product reference ID. |
| CubicWeight | number | [Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128). |
| IsKit | boolean | Defines whether the SKU is made up of one or more SKUs (part of a kit) (`true`) or not (`false`). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted. |
| IsDynamicKit | string | Deprecated field. |
| InternalNote | string | Internal note. |
| DateUpdated | string | Date when the product was updated for the most recent time. |
| RewardValue | number | Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with `1`, the customer receives credit on the site in the selected currency, e.g. U$ 1. |
| CommercialConditionId | integer | Commercial condition ID, used to define SKU specific promotions or installment rules. In case of no specific condition, use `1` (default value). This field does not accept `0`. Learn more at [Register |
| EstimatedDateArrival | string | SKU estimated arrival date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the product is on pre-sale. You must take into consideration both the launch date and the freight calculat |
| FlagKitItensSellApart | boolean | Defines if the SKU bundle items can be sold separately. |
| ManufacturerCode | string | Identifier provided by the manufacturers to identify their product. This field should be filled in if the product has a specific manufacturer's code. |
| ReferenceStockKeepingUnitId | string | SKU reference ID. |
| Position | integer | SKU position. |
| ActivateIfPossible | boolean | When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component. |
| MeasurementUnit | string | Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m |
| UnitMultiplier | number | Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward. |
| IsInventoried | boolean | Deprecated field. |
| IsTransported | boolean | Deprecated field. |
| IsGiftCardRecharge | boolean | Defines if the purchase of the SKU will generate reward value for the customer. |
| ModalType | string | Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, to a carrier specialized in delivering it. This field should be filled in with the name of the modal |
| isKitOptimized | boolean | Defines if the SKU is an optimized bundle. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/SkulistbyProductId",
"title": "SkulistbyProductId",
"type": "object",
"properties": {
"IsPersisted": {
"type": "boolean",
"description": "Defines if the SKU is persisted."
},
"IsRemoved": {
"type": "boolean",
"deprecated": true,
"description": "Defines if the SKU is removed."
},
"Id": {
"type": "integer",
"format": "int32",
"description": "SKU ID."
},
"ProductId": {
"type": "integer",
"format": "int32",
"description": "Product ID."
},
"IsActive": {
"type": "boolean",
"description": "Defines if the SKU is active or not."
},
"Name": {
"type": "string",
"description": "SKU name."
},
"Height": {
"type": "number",
"description": "SKU height."
},
"RealHeight": {
"type": "number",
"nullable": true,
"description": "Real SKU height."
},
"Width": {
"type": "number",
"description": "SKU width."
},
"RealWidth": {
"type": "number",
"nullable": true,
"description": "Real SKU width."
},
"Length": {
"type": "number",
"description": "SKU length."
},
"RealLength": {
"type": "number",
"nullable": true,
"description": "Real SKU length."
},
"WeightKg": {
"type": "number",
"nullable": true,
"description": "Weight of the SKU in the measurement [configured in the store](https://help.vtex.com/en/tutorial/filling-in-system-settings--tutorials_269), which by default is in grams."
},
"RealWeightKg": {
"type": "number",
"nullable": true,
"description": "Real weight of the SKU in the measurement unit [configured in the store](https://help.vtex.com/en/tutorial/filling-in-system-settings--tutorials_269), which by default is in grams."
},
"ModalId": {
"type": "integer",
"format": "int32",
"description": "Delivery method (modal type) ID."
},
"RefId": {
"type": "string",
"description": "Product reference ID."
},
"CubicWeight": {
"type": "number",
"description": "[Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)."
},
"IsKit": {
"type": "boolean",
"description": "Defines whether the SKU is made up of one or more SKUs (part of a kit) (`true`) or not (`false`). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted."
},
"IsDynamicKit": {
"type": "string",
"nullable": true,
"deprecated": true,
"description": "Deprecated field."
},
"InternalNote": {
"type": "string",
"nullable": true,
"description": "Internal note."
},
"DateUpdated": {
"type": "string",
"description": "Date when the product was updated for the most recent time."
},
"RewardValue": {
"type": "number",
"nullable": true,
"description": "Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with `1`, the customer receives credit on the site in the selected currency, e.g. U$ 1."
},
"CommercialConditionId": {
"type": "integer",
"format": "int32",
"description": "Commercial condition ID, used to define SKU specific promotions or installment rules. In case of no specific condition, use `1` (default value). This field does not accept `0`. Learn more at [Registering a commercial condition](https://help.vtex.com/tutorial/registering-a-commercial-condition--tutorials_445).",
"default": 1
},
"EstimatedDateArrival": {
"type": "string",
"nullable": true,
"description": "SKU estimated arrival date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the product is on pre-sale. You must take into consideration both the launch date and the freight calculation for the arrival date."
},
"FlagKitItensSellApart": {
"type": "boolean",
"description": "Defines if the SKU bundle items can be sold separately."
},
"ManufacturerCode": {
"type": "string",
"description": "Identifier provided by the manufacturers to identify their product. This field should be filled in if the product has a specific manufacturer's code."
},
"ReferenceStockKeepingUnitId": {
"type": "string",
"nullable": true,
"description": "SKU reference ID."
},
"Position": {
"type": "integer",
"format": "int32",
"description": "SKU position."
},
"ActivateIfPossible": {
"type": "boolean",
"description": "When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component."
},
"MeasurementUnit": {
"type": "string",
"description": "Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m\u00b2). In common cases, use `\"un\"`."
},
"UnitMultiplier": {
"type": "number",
"description": "Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward."
},
"IsInventoried": {
"type": "boolean",
"nullable": true,
"deprecated": true,
"description": "Deprecated field."
},
"IsTransported": {
"type": "boolean",
"nullable": true,
"deprecated": true,
"description": "Deprecated field."
},
"IsGiftCardRecharge": {
"type": "boolean",
"nullable": true,
"description": "Defines if the purchase of the SKU will generate reward value for the customer."
},
"ModalType": {
"type": "string",
"nullable": true,
"description": "Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, to a carrier specialized in delivering it. This field should be filled in with the name of the modal (e.g. \"Chemicals\" or \"Refrigerated products\"). To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy)."
},
"isKitOptimized": {
"type": "boolean",
"description": "Defines if the SKU is an optimized bundle."
}
},
"example": {
"IsPersisted": true,
"Id": 1,
"ProductId": 1,
"IsActive": true,
"Name": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"Height": 6.5,
"RealHeight": 2.2,
"Width": 14.0,
"RealWidth": 3.3,
"Length": 24.0,
"RealLength": 4.4,
"WeightKg": 550.0,
"RealWeightKg": 1.1,
"ModalId": 1,
"RefId": "0001",
"CubicWeight": 1.0,
"IsKit": false,
"InternalNote": null,
"DateUpdated": "2021-10-29T18:25:00",
"RewardValue": null,
"CommercialConditionId": 1,
"EstimatedDateArrival": null,
"FlagKitItensSellApart": false,
"ManufacturerCode": "",
"ReferenceStockKeepingUnitId": null,
"Position": 1,
"ActivateIfPossible": true,
"MeasurementUnit": "un",
"UnitMultiplier": 300.0,
"IsInventoried": true,
"IsTransported": true,
"IsGiftCardRecharge": false,
"ModalType": null,
"isKitOptimized": false
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-skulistbyproductid"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.