{ "format": "karqa-shop-export", "version": 1, "conventions": "A ZIP archive. JSON files are UTF-8 (RFC 8259), with property names in camelCase; a property whose value is empty is left out. CSV files are UTF-8 with a byte order mark, comma-separated, quoted as RFC 4180 describes, with CRLF line ends and a header row; a cell that would start with =, \u002B, -, @ or a tab and is not a number is prefixed with an apostrophe, so a spreadsheet does not run it. Amounts use a full stop for decimals. Dates are UTC: ISO 8601 in JSON, \u0022yyyy-MM-dd HH:mm\u0022 in CSV. Stored files keep the bytes and format they were uploaded in.", "files": [ { "path": "README.txt", "format": "Plain text (UTF-8)", "description": "What the archive holds, in brief." }, { "path": "manifest.json", "format": "JSON", "description": "When the archive was made, the format and its version, and how many records each part holds.", "schema": { "type": [ "object", "null" ], "properties": { "format": { "type": "string" }, "version": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "shop": { "type": "string" }, "shopName": { "type": [ "string", "null" ] }, "exportedAt": { "type": "string", "format": "date-time" }, "records": { "type": "object", "additionalProperties": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } }, "required": [ "format", "version", "shop", "shopName", "exportedAt", "records" ] } }, { "path": "catalogue/products.json", "format": "JSON", "description": "Every product, with its variants, options, attributes, categories, prices and images.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "metaTitle": { "type": [ "string", "null" ] }, "metaDescription": { "type": [ "string", "null" ] }, "metaKeywords": { "type": [ "string", "null" ] }, "minimumOrderQuantity": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "subtractStock": { "type": [ "boolean", "null" ] }, "requiresShipping": { "type": [ "boolean", "null" ] }, "primaryImageUrl": { "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string" }, "fileName": { "type": "string" }, "ratio": { "type": "string" }, "isPrimary": { "type": "boolean" }, "productId": { "type": [ "string", "null" ], "format": "uuid" }, "productVariantId": { "type": [ "string", "null" ], "format": "uuid" } } } }, "isActive": { "type": "boolean" }, "slug": { "type": [ "string", "null" ] }, "categories": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "metaKeywords": { "type": "string" }, "isActive": { "type": "boolean" }, "parentCategoryId": { "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "sortOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "taxClass": { "type": "string", "enum": [ "Standard", "Books \u0026 publications", "Food \u0026 drink", "Medicines", "Medical equipment", "Children\u0027s clothing \u0026 footwear", "Children\u0027s car seats", "Plants \u0026 cut flowers" ] }, "weightClass": { "type": "string", "enum": [ "Milligram", "Gram", "Kilogram", "Ounce", "Pound" ] }, "lengthClass": { "type": [ "string", "null" ], "enum": [ "Millimeter", "Centimeter", "Meter", "Inch", "Foot", "Yard", null ] }, "sortOrder": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "brand": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "upc": { "type": [ "string", "null" ] }, "ean": { "type": [ "string", "null" ] }, "isbn": { "type": [ "string", "null" ] }, "mpn": { "type": [ "string", "null" ] }, "jan": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "salePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "saleEndsAt": { "type": [ "string", "null" ], "format": "date-time" }, "priorPrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "stockQuantity": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "outOfStockStatus": { "type": [ "string", "null" ], "enum": [ "In Stock", "Out of Stock", "Pre-Order", "Back Order", "Discontinued Product", "Low Stock", "On The Way", "Temporarily Unavailable", null ] }, "isInStock": { "type": [ "boolean", "null" ] }, "weight": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "handlingTimeDays": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "length": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "width": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "height": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "attributeValues": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "productAttributeGroupId": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "sortOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "hasVariants": { "type": "boolean" }, "variants": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "metaTitle": { "type": [ "string", "null" ] }, "metaDescription": { "type": [ "string", "null" ] }, "metaKeywords": { "type": [ "string", "null" ] }, "minimumOrderQuantity": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "subtractStock": { "type": [ "boolean", "null" ] }, "requiresShipping": { "type": [ "boolean", "null" ] }, "primaryImageUrl": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "$ref": "#/items/properties/images/items" } }, "isActive": { "type": "boolean" }, "slug": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "taxClass": { "type": "string", "enum": [ "Standard", "Books \u0026 publications", "Food \u0026 drink", "Medicines", "Medical equipment", "Children\u0027s clothing \u0026 footwear", "Children\u0027s car seats", "Plants \u0026 cut flowers" ] }, "weightClass": { "type": "string", "enum": [ "Milligram", "Gram", "Kilogram", "Ounce", "Pound" ] }, "lengthClass": { "type": [ "string", "null" ], "enum": [ "Millimeter", "Centimeter", "Meter", "Inch", "Foot", "Yard", null ] }, "sortOrder": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "sku": { "type": [ "string", "null" ] }, "upc": { "type": [ "string", "null" ] }, "ean": { "type": [ "string", "null" ] }, "isbn": { "type": [ "string", "null" ] }, "mpn": { "type": [ "string", "null" ] }, "jan": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "salePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "saleEndsAt": { "type": [ "string", "null" ], "format": "date-time" }, "priorPrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "stockQuantity": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "outOfStockStatus": { "type": [ "string", "null" ], "enum": [ "In Stock", "Out of Stock", "Pre-Order", "Back Order", "Discontinued Product", "Low Stock", "On The Way", "Temporarily Unavailable", null ] }, "weight": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "length": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "width": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "height": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "productId": { "type": "string", "format": "uuid" }, "variantName": { "type": "string" }, "productOptions": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "productOptionGroupId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "value": { "type": "string" }, "sortOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productOptionGroup": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Select", "Radio", "Checkbox", "Text", "Number", "Date", "Time", "Date Time" ] }, "description": { "type": [ "string", "null" ] }, "isFilterable": { "type": "boolean" }, "required": { "type": [ "boolean", "null" ] }, "sortOrder": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productOptions": { "type": [ "array", "null" ], "items": { "$ref": "#/items/properties/variants/items/properties/productOptions/items" } } } } } } } } } }, "productOptionGroups": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Select", "Radio", "Checkbox", "Text", "Number", "Date", "Time", "Date Time" ] }, "description": { "type": [ "string", "null" ] }, "isFilterable": { "type": "boolean" }, "required": { "type": [ "boolean", "null" ] }, "sortOrder": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productOptions": { "$ref": "#/items/properties/variants/items/properties/productOptions/items/properties/productOptionGroup/properties/productOptions" } } } } } } } }, { "path": "catalogue/products.csv", "format": "CSV", "description": "One row per product and one per variant, for a spreadsheet or another shop system.", "columns": [ "Type", "Product id", "Variant id", "Name", "SKU", "Price", "Stock", "Active", "Categories", "Options", "Weight", "Weight class", "EAN", "Slug", "Images" ] }, { "path": "catalogue/categories.json", "format": "JSON", "description": "The categories.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "metaKeywords": { "type": "string" }, "isActive": { "type": "boolean" }, "parentCategoryId": { "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "sortOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } } }, { "path": "catalogue/option-groups.json", "format": "JSON", "description": "The option groups (size, colour, \u2026) and their options.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Select", "Radio", "Checkbox", "Text", "Number", "Date", "Time", "Date Time" ] }, "description": { "type": [ "string", "null" ] }, "isFilterable": { "type": "boolean" }, "required": { "type": [ "boolean", "null" ] }, "sortOrder": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productOptions": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "productOptionGroupId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "value": { "type": "string" }, "sortOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productOptionGroup": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Select", "Radio", "Checkbox", "Text", "Number", "Date", "Time", "Date Time" ] }, "description": { "type": [ "string", "null" ] }, "isFilterable": { "type": "boolean" }, "required": { "type": [ "boolean", "null" ] }, "sortOrder": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productOptions": { "$ref": "#/items/properties/productOptions" } } } } } } } } } }, { "path": "catalogue/attribute-groups.json", "format": "JSON", "description": "The attribute groups (material, \u2026) and their values.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "isFilterable": { "type": "boolean" }, "values": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "productAttributeGroupId": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "sortOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } } } } } }, { "path": "customers/customers.json", "format": "JSON", "description": "Every customer who has ordered, with what they ordered in total and their labels.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "ordersCount": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "paidOrders": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "totalSpent": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "currency": { "type": "string" }, "firstOrderAt": { "type": "string", "format": "date-time" }, "lastOrderAt": { "type": "string", "format": "date-time" }, "lastStatus": { "type": "string" }, "labels": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "name", "color" ] } } }, "required": [ "email", "name", "phone", "ordersCount", "paidOrders", "totalSpent", "currency", "firstOrderAt", "lastOrderAt", "lastStatus", "labels" ] } } }, { "path": "customers/customers.csv", "format": "CSV", "description": "The customers, one per row.", "columns": [ "Email", "Name", "Phone", "Orders", "Paid orders", "Total spent", "Currency", "First order", "Last order", "Last status", "Labels" ] }, { "path": "customers/labels.json", "format": "JSON", "description": "The labels used on customers.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } } }, { "path": "orders/orders.json", "format": "JSON", "description": "Every order, with its lines, addresses, payment, delivery, amounts and labels.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "orderNumber": { "type": "string" }, "status": { "type": "string", "enum": [ "Awaiting payment", "Processing", "Completed", "Cancelled", "Refunded", "On Hold", "Failed", "Cash on delivery" ] }, "subTotal": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "shippingCost": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "codFee": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "platformCommissionPercent": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "taxAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "taxNote": { "type": [ "string", "null" ] }, "vatRatePercent": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "vatCountry": { "type": [ "string", "null" ] }, "vatBasis": { "type": [ "string", "null" ], "enum": [ "Origin", "Destination", "SellerExempt", "DestinationUnverified", "OutsideEu", "OriginUnknown", "OriginUnverified", "IntraCommunity", null ] }, "baseGrandTotalEur": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "eurFxRate": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "eurFxRateDate": { "type": [ "string", "null" ] }, "discountAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "discountCode": { "type": [ "string", "null" ] }, "grandTotal": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "refundedAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "baseRefundedAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "currency": { "type": "string", "enum": [ "USD", "EUR", "RON", "GBP", "JPY", "CNY", "AUD", "CAD", "CHF", "INR", "BRL", "RUB", "MXN", "SGD", "NZD", "HKD", "SEK", "NOK", "DKK", "PLN", "ZAR", "TRY", "AED", "SAR", "KRW", "HUF" ] }, "baseGrandTotal": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "baseCurrency": { "type": "string", "enum": [ "USD", "EUR", "RON", "GBP", "JPY", "CNY", "AUD", "CAD", "CHF", "INR", "BRL", "RUB", "MXN", "SGD", "NZD", "HKD", "SEK", "NOK", "DKK", "PLN", "ZAR", "TRY", "AED", "SAR", "KRW", "HUF" ] }, "fxRate": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "fxRateDate": { "type": [ "string", "null" ] }, "customerEmail": { "type": "string" }, "customerPhone": { "type": "string" }, "billingFirstName": { "type": "string" }, "billingLastName": { "type": "string" }, "billingAddress1": { "type": "string" }, "billingAddress2": { "type": [ "string", "null" ] }, "billingCompanyName": { "type": [ "string", "null" ] }, "billingCompanyTaxId": { "type": [ "string", "null" ] }, "billingCompanyRegistrationNumber": { "type": [ "string", "null" ] }, "billingCompanyVerifiedAt": { "type": [ "string", "null" ], "format": "date-time" }, "billingCompanyVerificationSource": { "type": [ "string", "null" ] }, "billingCompanyVerificationRef": { "type": [ "string", "null" ] }, "billingCompanyInactive": { "type": "boolean" }, "billingCompanyRegisteredOffice": { "type": [ "object", "null" ], "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "country": { "type": "string" } }, "required": [ "street", "city", "postalCode", "region", "country" ] }, "billingCity": { "type": "string" }, "billingState": { "type": "string" }, "billingPostalCode": { "type": "string" }, "billingCountry": { "type": "string" }, "shippingFirstName": { "type": "string" }, "shippingLastName": { "type": "string" }, "shippingAddress1": { "type": "string" }, "shippingAddress2": { "type": [ "string", "null" ] }, "shippingCity": { "type": "string" }, "shippingState": { "type": "string" }, "shippingPostalCode": { "type": "string" }, "shippingCountry": { "type": "string" }, "paymentMethod": { "type": [ "string", "null" ] }, "paymentTransactionId": { "type": [ "string", "null" ] }, "paymentStatus": { "type": "string", "enum": [ "Pending", "Authorized", "Paid", "Refunded", "Failed", "Voided" ] }, "shippingMethod": { "type": [ "string", "null" ] }, "trackingNumber": { "type": [ "string", "null" ] }, "trackingUrl": { "type": [ "string", "null" ] }, "shippingStatus": { "type": "string", "enum": [ "Pending", "Processing", "Shipped", "Delivered", "Failed" ] }, "awbCost": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "lockerId": { "type": [ "string", "null" ] }, "lockerName": { "type": [ "string", "null" ] }, "lockerAddress": { "type": [ "string", "null" ] }, "returnAwbNumber": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "paidAt": { "type": [ "string", "null" ], "format": "date-time" }, "handlingTimeDays": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "shippedAt": { "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "type": [ "string", "null" ], "format": "date-time" }, "piiAnonymisedAt": { "type": [ "string", "null" ], "format": "date-time" }, "note": { "type": "string" }, "shopNote": { "type": "string" }, "liveMode": { "type": "boolean" }, "stripePaymentIntentId": { "type": [ "string", "null" ] }, "stripeCheckoutSessionId": { "type": [ "string", "null" ] }, "isPaid": { "type": "boolean" }, "items": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "orderId": { "type": [ "string", "null" ], "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "productVariantId": { "type": [ "string", "null" ], "format": "uuid" }, "sku": { "type": [ "string", "null" ] }, "productTitle": { "type": [ "string", "null" ] }, "selectedOptions": { "type": [ "string", "null" ] }, "unitPrice": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "originalUnitPrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "quantity": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "vatRatePercent": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "taxClass": { "type": [ "string", "null" ], "enum": [ "Standard", "Books \u0026 publications", "Food \u0026 drink", "Medicines", "Medical equipment", "Children\u0027s clothing \u0026 footwear", "Children\u0027s car seats", "Plants \u0026 cut flowers", null ] }, "restockedQuantity": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "subTotal": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "discountAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "taxAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "total": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "product": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "primaryImageUrl": { "type": [ "string", "null" ] } } } } } }, "labels": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "name", "color" ] } } } } } }, { "path": "orders/orders.csv", "format": "CSV", "description": "The orders, one per row.", "columns": [ "Order number", "Date", "Status", "Payment status", "Shipping status", "Payment method", "Customer email", "Customer phone", "Billing name", "Shipping name", "Shipping address", "Shipping city", "Shipping postal code", "Shipping country", "Shipping method", "Tracking number", "Subtotal", "Shipping cost", "COD fee", "Discount code", "Discount amount", "Tax", "Total", "Currency", "Total in shop currency", "Shop currency", "Labels", "Billing company", "Company fiscal code", "VAT treatment", "Company checked with", "Company checked at", "VIES consultation number" ] }, { "path": "orders/history.json", "format": "JSON", "description": "What happened to each order after it was placed, naming it by orderId.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "orderId": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "event": { "type": "string", "enum": [ "Order Created", "Order Completed", "Order Cancelled", "Order Refunded", "Order Failed", "Order Updated", "Status Changed", "Tracking Number Set", "Order Fulfilled", "Note Updated", "Dispute Opened", "Partially Refunded", "Dispute Closed", "Withdrawal Received" ] }, "note": { "type": "string" }, "previousValue": { "type": [ "string", "null" ] }, "newValue": { "type": [ "string", "null" ] }, "isCustomerNotified": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } } } } }, { "path": "orders/messages.json", "format": "JSON", "description": "The messages exchanged about each order.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "orderId": { "type": "string", "format": "uuid" }, "sender": { "type": "string", "enum": [ "Merchant", "Customer" ] }, "body": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "readAt": { "type": [ "string", "null" ], "format": "date-time" } } } } }, { "path": "orders/refunds.json", "format": "JSON", "description": "Each refund, with what it refunded.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "orderId": { "type": "string", "format": "uuid" }, "amount": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "baseAmount": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "isFull": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "creditNoteIssueStartedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": "string" }, "lines": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "refundId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "Item", "Shipping" ] }, "orderItemId": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" } } } } } } } }, { "path": "orders/return-requests.json", "format": "JSON", "description": "Each return request and what became of it.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "orderId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "Refund", "Replacement" ] }, "status": { "type": "string", "enum": [ "Requested", "Approved", "Rejected", "Refunded" ] }, "reason": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "reviewedAt": { "type": [ "string", "null" ], "format": "date-time" }, "merchantNote": { "type": [ "string", "null" ] } } } } }, { "path": "orders/labels.json", "format": "JSON", "description": "The labels used on orders.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } } }, { "path": "invoices/invoices.csv", "format": "CSV", "description": "Every invoice and credit note, with where its PDF and XML are in the archive.", "columns": [ "Number", "Type", "Issued", "Order number", "Reverses", "Total", "Currency", "Issued through", "Status", "PDF", "XML", "Provider\u0027s PDF link", "Note" ] }, { "path": "invoices/{number}.pdf", "format": "PDF", "description": "Each invoice or credit note as it was sent to the customer." }, { "path": "invoices/{number}.xml", "format": "XML (UBL 2.1, CIUS-RO for e-Factura)", "description": "Each invoice or credit note the platform issued itself, as an EN 16931 electronic invoice." }, { "path": "reviews/reviews.json", "format": "JSON", "description": "Every product review, with what the shop decided about it.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "productName": { "type": [ "string", "null" ] }, "orderId": { "type": [ "string", "null" ], "format": "uuid" }, "customerName": { "type": [ "string", "null" ] }, "customerEmail": { "type": [ "string", "null" ] }, "rating": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "comment": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "Pending", "Approved", "Rejected" ] }, "rejectionGround": { "type": [ "string", "null" ], "enum": [ "Unlawful", "Offensive", "OthersPersonalData", "NotAboutTheProduct", null ] }, "moderatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "productId", "productName", "orderId", "customerName", "customerEmail", "rating", "comment", "status", "rejectionGround", "moderatedAt", "createdAt" ] } } }, { "path": "reviews/reviews.csv", "format": "CSV", "description": "The reviews, one per row.", "columns": [ "Date", "Product", "Customer", "Rating", "Review", "Status", "Rejected because" ] }, { "path": "shop/settings.json", "format": "JSON", "description": "The shop\u0027s settings: its identity, address, branding, currencies, markets, tax, payment, delivery and invoicing choices. Stored credentials are not included.", "schema": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "customDomain": { "type": [ "string", "null" ] }, "customDomainVerificationToken": { "type": [ "string", "null" ] }, "customDomainVerifiedAt": { "type": [ "string", "null" ], "format": "date-time" }, "customDomainCheckFailingSince": { "type": [ "string", "null" ], "format": "date-time" }, "businessName": { "type": "string" }, "legalName": { "type": "string" }, "businessAddress": { "type": "string" }, "city": { "type": "string" }, "county": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "postalCode": { "type": "string" }, "businessEmail": { "type": "string" }, "businessPhone": { "type": "string" }, "showPhoneOnShop": { "type": "boolean" }, "taxId": { "type": [ "string", "null" ] }, "vatNumberVerifiedAt": { "type": [ "string", "null" ], "format": "date-time" }, "vatNumberVerificationRef": { "type": [ "string", "null" ] }, "vatRate": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "vatExempt": { "type": "boolean" }, "vatExemptionNote": { "type": [ "string", "null" ] }, "vatThreshold": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "chargesDestinationVat": { "type": "boolean" }, "chargesDestinationVatSince": { "type": [ "string", "null" ], "format": "date-time" }, "businessRegistrationNumber": { "type": [ "string", "null" ] }, "invoicingProvider": { "type": "string", "enum": [ "None", "XmlExport", "Oblio", "SmartBill" ] }, "invoicingEnabledAt": { "type": [ "string", "null" ], "format": "date-time" }, "invoiceSeries": { "type": [ "string", "null" ] }, "nextInvoiceNumber": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "invoicingApiEmail": { "type": [ "string", "null" ] }, "courierProvider": { "type": "string", "enum": [ "None", "Sameday" ] }, "samedayApiUsername": { "type": [ "string", "null" ] }, "samedaySandbox": { "type": "boolean" }, "samedayPickupPointId": { "type": [ "string", "null" ] }, "samedayHomeServiceId": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "samedayLockerServiceId": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "samedayAccountCountry": { "type": "string" }, "samedayCrossBorderHomeServiceId": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "samedayCrossBorderLockerServiceId": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "shopLanguage": { "type": "string" }, "timeZone": { "type": [ "string", "null" ] }, "effectiveTimeZone": { "type": [ "string", "null" ] }, "currency": { "type": "string", "enum": [ "USD", "EUR", "RON", "GBP", "JPY", "CNY", "AUD", "CAD", "CHF", "INR", "BRL", "RUB", "MXN", "SGD", "NZD", "HKD", "SEK", "NOK", "DKK", "PLN", "ZAR", "TRY", "AED", "SAR", "KRW", "HUF" ] }, "acceptedPaymentCurrencies": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "displayCurrencies": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "checkoutStrategy": { "type": "string", "enum": [ "NativeOnly", "StripeConversion" ] }, "codEnabled": { "type": "boolean" }, "codFee": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "codCountryCodes": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "weightClass": { "type": "string", "enum": [ "Milligram", "Gram", "Kilogram", "Ounce", "Pound" ] }, "lengthClass": { "type": "string", "enum": [ "Millimeter", "Centimeter", "Meter", "Inch", "Foot", "Yard" ] }, "website": { "type": [ "string", "null" ] }, "instagramUrl": { "type": [ "string", "null" ] }, "facebookUrl": { "type": [ "string", "null" ] }, "tiktokUrl": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "logoUrl": { "type": [ "string", "null" ] }, "aboutPageContent": { "type": [ "string", "null" ] }, "isActive": { "type": "boolean" }, "suspendedAt": { "type": [ "string", "null" ], "format": "date-time" }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "closureRequestedAt": { "type": [ "string", "null" ], "format": "date-time" }, "closureEffectiveAt": { "type": [ "string", "null" ], "format": "date-time" }, "closureReason": { "type": [ "string", "null" ] }, "suspensionReason": { "type": [ "string", "null" ] }, "isLive": { "type": "boolean" }, "wentLiveAt": { "type": [ "string", "null" ], "format": "date-time" }, "isVerified": { "type": "boolean" }, "verificationDate": { "type": [ "string", "null" ], "format": "date-time" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "paragraphFont": { "type": "string", "enum": [ "Arial", "Verdana", "Tahoma", "Trebuchet MS", "Georgia", "Times New Roman", "Courier New", "Impact", "Comic Sans MS", "Lucida Console", "Helvetica", "Arial Black", "Palatino Linotype", "Garamond", "Bookman Old Style", "Inter", "Roboto", "Open Sans", "Lato", "Montserrat", "Poppins", "Raleway", "Nunito", "Work Sans", "Rubik", "DM Sans", "Manrope", "Mulish", "Source Sans 3", "Playfair Display", "Merriweather", "Lora", "Roboto Slab", "PT Serif", "Oswald" ] }, "headingFont": { "type": "string", "enum": [ "Arial", "Verdana", "Tahoma", "Trebuchet MS", "Georgia", "Times New Roman", "Courier New", "Impact", "Comic Sans MS", "Lucida Console", "Helvetica", "Arial Black", "Palatino Linotype", "Garamond", "Bookman Old Style", "Inter", "Roboto", "Open Sans", "Lato", "Montserrat", "Poppins", "Raleway", "Nunito", "Work Sans", "Rubik", "DM Sans", "Manrope", "Mulish", "Source Sans 3", "Playfair Display", "Merriweather", "Lora", "Roboto Slab", "PT Serif", "Oswald" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "neglectedOrderCount": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "neglectedOrdersFlaggedAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastNeglectDigestAt": { "type": [ "string", "null" ], "format": "date-time" }, "onboardingCompleted": { "type": "boolean" }, "platformTermsAcceptedAt": { "type": [ "string", "null" ], "format": "date-time" }, "platformTermsVersion": { "type": [ "string", "null" ] }, "platformTermsNotifiedVersion": { "type": [ "string", "null" ] }, "dpaAcceptedAt": { "type": [ "string", "null" ], "format": "date-time" }, "dpaVersion": { "type": [ "string", "null" ] }, "stripeTestConnected": { "type": "boolean" }, "stripeLiveConnected": { "type": "boolean" }, "subscriptionChargeAmount": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "subscriptionChargeCurrency": { "type": [ "string", "null" ] }, "subscriptionFxRate": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "subscriptionFxRateDate": { "type": [ "string", "null" ] }, "subscriptionStatus": { "type": [ "string", "null" ] }, "orderPiiRetentionMonths": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "freeTextRetentionMonths": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "defaultOrderNoteTemplate": { "type": [ "string", "null" ] }, "returnWindowDays": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "handlingTimeDays": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "lowStockThreshold": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "lastLowStockDigestAt": { "type": [ "string", "null" ], "format": "date-time" }, "merchantCenterSubmitted": { "type": "boolean" }, "analyticsPropertyId": { "type": [ "string", "null" ] }, "gaMeasurementId": { "type": [ "string", "null" ] }, "gaPropertyResourceName": { "type": [ "string", "null" ] }, "gaProvisioningStatus": { "type": "string", "enum": [ "None", "Pending", "Active", "Failed", "Deleting" ] }, "analyticsEnabled": { "type": "boolean" }, "gaClaimedAt": { "type": [ "string", "null" ], "format": "date-time" }, "analyticsPropertyDeletedAt": { "type": [ "string", "null" ], "format": "date-time" } } } }, { "path": "shop/pages.json", "format": "JSON", "description": "The shop\u0027s own pages.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "title": { "type": "string" }, "slug": { "type": "string" }, "content": { "type": [ "string", "null" ] }, "isPublished": { "type": "boolean" }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, { "path": "shop/shop-front.json", "format": "JSON", "description": "Every shop front design, with its sections.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "isActive": { "type": "boolean" }, "isPublished": { "type": "boolean" }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "sourceName": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "sections": { "type": "array", "items": { "anyOf": [ { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "text": { "type": "string" }, "imageUrl": { "type": [ "string", "null" ] }, "imageFullBleed": { "type": "boolean" }, "backgroundColor": { "type": [ "string", "null" ] }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "heading": { "type": "string" }, "subtext": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "mobileText": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "sideImageUrl": { "type": [ "string", "null" ] }, "mobileImageUrl": { "type": [ "string", "null" ] }, "buttonLabel": { "type": [ "string", "null" ] }, "buttonLink": { "type": [ "string", "null" ] }, "overlay": { "type": [ "string", "null" ] }, "layout": { "type": [ "string", "null" ] }, "headingAccentEnabled": { "type": "boolean" }, "transparentNav": { "type": "boolean" }, "sideImageFullBleed": { "type": "boolean" }, "videoUrl": { "type": [ "string", "null" ] }, "videoPosterUrl": { "type": [ "string", "null" ] }, "imageMotion": { "type": [ "string", "null" ] }, "sideImageHoverZoom": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "tiles": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "bentoGridSectionId": { "type": "string", "format": "uuid" }, "imageUrl": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "text": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "size": { "type": [ "string", "null" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "columns": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "labelPlacement": { "type": [ "string", "null" ] }, "aspectRatio": { "type": [ "string", "null" ] }, "tiles": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "collectionGridSectionId": { "type": "string", "format": "uuid" }, "categoryId": { "type": [ "string", "null" ], "format": "uuid" }, "label": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "resolvedLabel": { "type": [ "string", "null" ] }, "resolvedImageUrl": { "type": [ "string", "null" ] }, "resolvedLink": { "type": [ "string", "null" ] }, "resolvedDescription": { "type": [ "string", "null" ] } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "subtext": { "type": [ "string", "null" ] }, "endsAt": { "type": "string", "format": "date-time" }, "buttonLabel": { "type": [ "string", "null" ] }, "buttonLink": { "type": [ "string", "null" ] }, "expiredBehaviour": { "type": [ "string", "null" ] }, "expiredMessage": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "faqSectionId": { "type": "string", "format": "uuid" }, "question": { "type": "string" }, "answer": { "type": "string" }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "layout": { "type": [ "string", "null" ] }, "featuredProductItems": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "productId": { "type": "string", "format": "uuid" }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "featuredProductsSectionId": { "type": "string", "format": "uuid" }, "productSummary": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "primaryImageUrl": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "salePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "saleEndsAt": { "type": [ "string", "null" ], "format": "date-time" }, "priorPrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "someOptionsOnSale": { "type": "boolean" }, "isInStock": { "type": "boolean" }, "isActive": { "type": "boolean" } } } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "style": { "type": [ "string", "null" ] }, "cards": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "highlightsSectionId": { "type": "string", "format": "uuid" }, "icon": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "text": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "productId": { "type": [ "string", "null" ], "format": "uuid" }, "eyebrow": { "type": [ "string", "null" ] }, "heading": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "layout": { "type": [ "string", "null" ] }, "buttonLabel": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "features": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "productSpotlightSectionId": { "type": "string", "format": "uuid" }, "icon": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "text": { "type": [ "string", "null" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "productSummary": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "primaryImageUrl": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "salePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "saleEndsAt": { "type": [ "string", "null" ], "format": "date-time" }, "priorPrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "someOptionsOnSale": { "type": "boolean" }, "isInStock": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "text": { "type": "string" }, "imageUrl": { "type": [ "string", "null" ] }, "imageFullBleed": { "type": "boolean" }, "backgroundColor": { "type": [ "string", "null" ] }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "layout": { "type": [ "string", "null" ] }, "maxItems": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "showAggregate": { "type": "boolean" }, "reviews": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "customerName": { "type": [ "string", "null" ] }, "rating": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "comment": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "productId", "customerName", "rating", "comment", "createdAt" ] } }, "averageRating": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "reviewCount": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "chapters": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "scrollStorySectionId": { "type": "string", "format": "uuid" }, "imageUrl": { "type": [ "string", "null" ] }, "eyebrow": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "text": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "subtext": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "hotspots": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "shopTheLookSectionId": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "x": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "y": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$" }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "productSummary": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "primaryImageUrl": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "salePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "saleEndsAt": { "type": [ "string", "null" ], "format": "date-time" }, "priorPrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "someOptionsOnSale": { "type": "boolean" }, "isInStock": { "type": "boolean" }, "isActive": { "type": "boolean" } } } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "backgroundColor": { "type": [ "string", "null" ] }, "testimonials": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "text": { "type": "string" }, "authorName": { "type": "string" }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "testimonialsSectionId": { "type": "string", "format": "uuid" } } } }, "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string", "enum": [ "AboutUs", "ProductsServices", "Testimonials", "FeaturedProducts", "Banner", "Highlights", "CollectionGrid", "Faq", "BentoGrid", "ShopTheLook", "ScrollStory", "ReviewsWall", "Countdown", "ProductSpotlight" ] }, "displayOrder": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ] } } }, "required": [ "id", "name", "description", "isActive", "isPublished", "displayOrder", "sourceName", "createdAt", "updatedAt", "sections" ] } } }, { "path": "shop/email-templates.json", "format": "JSON", "description": "The shop\u0027s email templates.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "emailType": { "type": "string", "enum": [ "OrderConfirmation", "OrderRefunded", "OrderFulfilled", "AdminNewOrder", "OrderShipped", "ContactMessageFromCustomer", "ContactMessageFromShop", "PaymentConfirmation", "AdminPaymentReceived", "ReviewRequest", "ReviewThankYou", "AdminNewReview", "PaymentRecovery", "OrderAccessLink", "OrderMessageToCustomer", "AdminDisputeCreated", "AdminProductRemoved", "OrderDelivered", "PlatformTermsUpdated", "AdminProductRestored", "MerchantSuspended", "MerchantReopened" ] }, "name": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, { "path": "shop/discount-codes.json", "format": "JSON", "description": "The discount codes.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "code": { "type": "string" }, "discountType": { "type": "string", "enum": [ "Percentage", "FixedAmount" ] }, "value": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" }, "isActive": { "type": "boolean" }, "minimumOrderAmount": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maximumDiscountAmount": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "usageLimit": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "usedCount": { "type": [ "string", "integer" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "isOneTimeUse": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" } } } } }, { "path": "shop/sales.json", "format": "JSON", "description": "The sales: price reductions on products and variants.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": [ "string", "number" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" }, "isActive": { "type": "boolean" }, "products": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "variants": { "type": "array", "items": { "$ref": "#/items/properties/products/items" } } }, "required": [ "id", "name", "type", "value", "startDate", "endDate", "isActive", "products", "variants" ] } } }, { "path": "shop/shipping-options.json", "format": "JSON", "description": "The delivery options, with their prices and where they apply.", "schema": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string" }, "shippingProvider": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "serviceCode": { "type": "string" }, "description": { "type": "string" }, "isFlatRate": { "type": "boolean" }, "nationalBasePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "internationalBasePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "pricePerKg": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "volumetricDivisor": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "estimatedDaysMin": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "estimatedDaysMax": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "maxWeight": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maxLength": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maxWidth": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maxHeight": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "requiresSignature": { "type": "boolean" }, "providesTracking": { "type": "boolean" }, "trackingUrlTemplate": { "type": [ "string", "null" ] }, "isActive": { "type": "boolean" }, "isInternational": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" } } }, "nationalBasePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "internationalBasePrice": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "pricePerKg": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "volumetricDivisor": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "estimatedDaysMin": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "estimatedDaysMax": { "type": [ "string", "integer", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)$" }, "maxWeight": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maxLength": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maxWidth": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "maxHeight": { "type": [ "string", "number", "null" ], "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$" }, "isActive": { "type": [ "boolean", "null" ] }, "markets": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "countryCode": { "type": "string" }, "countryName": { "type": "string" }, "regionCode": { "type": [ "string", "null" ] }, "regionName": { "type": [ "string", "null" ] } } } }, "trackingUrlTemplate": { "type": [ "string", "null" ] }, "isLockerDelivery": { "type": "boolean" }, "restrictsProducts": { "type": "boolean" }, "allowedProducts": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } }, "allowedCategories": { "type": "array", "items": { "$ref": "#/items/properties/allowedProducts/items" } } } } } }, { "path": "files/index.csv", "format": "CSV", "description": "Every image and video the shop uses, where it is in the archive, and what it was used as.", "columns": [ "File", "Original address", "Used as", "Status" ] }, { "path": "files/{path}", "format": "As uploaded (images and videos)", "description": "The stored files themselves." } ] }