@rapharacing/schemas
Version:
OpenAPI to JSON Schema to be used with middy for CC response validation
242 lines • 6.64 kB
JSON
{
"type": "object",
"properties": {
"accessGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedOnWishlist": {
"type": "boolean",
"description": "Indicates if the product is allowed to be included in the wishlist"
},
"availableForPickup": {
"type": "boolean",
"description": "Flag defining if product is available for pickup"
},
"averageRating": {
"type": "number",
"format": "double",
"description": "Rating number of average value"
},
"baseOptions": {
"type": "array",
"description": "List of base options related to the product",
"items": {
"$ref": "_definitions.json#/definitions/BaseOption",
"originalRef": "BaseOption"
}
},
"baseProduct": {
"type": "string",
"description": "Information about base product"
},
"breadcrumb": {
"description": "Breadcrumb category",
"$ref": "_definitions.json#/definitions/Category",
"originalRef": "Category"
},
"categories": {
"type": "array",
"description": "List of categories product belongs to",
"items": {
"$ref": "_definitions.json#/definitions/Category",
"originalRef": "Category"
}
},
"classifications": {
"type": "array",
"description": "List of classifications related to the product",
"items": {
"$ref": "_definitions.json#/definitions/Classification",
"originalRef": "Classification"
}
},
"code": {
"type": "string",
"description": "Code of the product"
},
"colors": {
"type": "array",
"items": {
"$ref": "_definitions.json#/definitions/RaphaColor",
"originalRef": "RaphaColor"
}
},
"configurable": {
"type": "boolean",
"description": "Flag stating if product is configurable"
},
"configuratorType": {
"type": "string",
"description": "Configurator type related to the product"
},
"description": {
"type": "string",
"description": "Description of the product"
},
"futureStocks": {
"type": "array",
"description": "List of future stocks",
"items": {
"$ref": "_definitions.json#/definitions/FutureStock",
"originalRef": "FutureStock"
}
},
"hasImportDuty": {
"type": "boolean"
},
"images": {
"type": "array",
"description": "List of images linked to product",
"items": {
"$ref": "_definitions.json#/definitions/Image",
"originalRef": "Image"
}
},
"manufacturer": {
"type": "string",
"description": "Data of product manufacturer"
},
"marketingMessage": {
"type": "string"
},
"maxOrderQuantity": {
"type": "integer",
"format": "int32"
},
"multidimensional": {
"type": "boolean",
"description": "Flag stating if product is multidimentional"
},
"name": {
"type": "string",
"description": "Name of the product"
},
"numberOfReviews": {
"type": "integer",
"format": "int32",
"description": "Number of reviews associated with the product"
},
"potentialPromotions": {
"type": "array",
"description": "List of potential promotions related to the product",
"items": {
"$ref": "_definitions.json#/definitions/Promotion",
"originalRef": "Promotion"
}
},
"price": {
"description": "Price of the product",
"$ref": "_definitions.json#/definitions/Price",
"originalRef": "Price"
},
"priceRange": {
"description": "Price range assigned to the product",
"$ref": "_definitions.json#/definitions/PriceRange",
"originalRef": "PriceRange"
},
"productReferences": {
"type": "array",
"description": "List of product references",
"items": {
"$ref": "_definitions.json#/definitions/ProductReference",
"originalRef": "ProductReference"
}
},
"purchasable": {
"type": "boolean",
"description": "Flag defining if product is purchasable"
},
"rating": {
"$ref": "_definitions.json#/definitions/CustomerFeedback",
"originalRef": "CustomerFeedback"
},
"reviews": {
"type": "array",
"description": "List of reviews associated with the product",
"items": {
"$ref": "_definitions.json#/definitions/Review",
"originalRef": "Review"
}
},
"rootProduct": {
"type": "string"
},
"slug": {
"type": "string"
},
"stock": {
"description": "Stock value of the product",
"$ref": "_definitions.json#/definitions/Stock",
"originalRef": "Stock"
},
"stockValue": {
"type": "integer",
"format": "int32",
"description": "-1(out of stock), 0 (low stock), 1 (in stock), 2 (coming soon)"
},
"summary": {
"type": "string",
"description": "Product summary"
},
"swatchColor": {
"type": "string",
"description": "Swatch Color (Hex styling of colour)"
},
"tags": {
"type": "array",
"description": "Tags associated with the product",
"items": {
"type": "string"
}
},
"type": {
"type": "string"
},
"url": {
"type": "string",
"description": "Url address of the product"
},
"variantMatrix": {
"type": "array",
"description": "List of variant matrixes associated with the product",
"items": {
"$ref": "_definitions.json#/definitions/VariantMatrixElement",
"originalRef": "VariantMatrixElement"
}
},
"variantOptions": {
"type": "array",
"description": "List of variant options related to the product",
"items": {
"$ref": "_definitions.json#/definitions/VariantOption",
"originalRef": "VariantOption"
}
},
"variantType": {
"type": "string",
"description": "Variant type of the product"
},
"volumePrices": {
"type": "array",
"description": "List of volume prices",
"items": {
"$ref": "_definitions.json#/definitions/Price",
"originalRef": "Price"
}
},
"volumePricesFlag": {
"type": "boolean",
"description": "Flag stating if volume price should be displayed"
},
"wasPrice": {
"$ref": "_definitions.json#/definitions/Price",
"originalRef": "Price"
}
},
"title": "Product",
"description": "Representation of a Product",
"$schema": "http://json-schema.org/schema#"
}