что описывает этот json { "endpoints": { "storefront": [ { "path":…
- User
что описывает этот json
{ "endpoints": { "storefront": [ { "path": "/storefront/orders/my-orders", "method": "GET", "description": "get My Orders", "params": { "productName": { "type": "", "required": true, "description": "(Required) " }, "orderStatus": { "type": "PENDING_PAYMENT" } } }, { "path": "/storefront/orders/completed", "method": "GET", "description": "check Order Exists By Product Id And User Id With Status", "params": { "productId": { "type": "", "required": true, "description": "(Required) " } } }, { "path": "/storefront/orders", "method": "POST", "description": "create Order", "params": {} }, { "path": "/storefront/checkouts/:id", "method": "GET", "description": "get Order With Items By Id", "params": {} }, { "path": "/storefront/checkouts", "method": "POST", "description": "create Checkout", "params": {} } ], "backoffice": [ { "path": "/backoffice/orders/:id", "method": "GET", "description": "get Order With Items By Id 1", "params": {} }, { "path": "/backoffice/orders", "method": "GET", "description": "get Orders", "params": { "createdFrom": { "type": "1970-01-01T00:00:01.968Z" }, "createdTo": { "type": "2023-07-22T04:04:58.535Z" }, "warehouse": { "type": "" }, "productName": { "type": "" }, "billingPhoneNumber": { "type": "" }, "email": { "type": "" }, "billingCountry": { "type": "" }, "pageNo": { "type": "0" }, "pageSize": { "type": "10" } } } ], "/api/webhook/backoffice/webhooks": [ { "path": "/api/webhook/backoffice/webhooks", "method": "GET", "description": "getWebhooks" }, { "path": "/api/webhook/backoffice/webhooks", "method": "POST", "description": "createWebhook" }, { "path": "/api/webhook/backoffice/webhooks", "method": "GET", "description": "getWebhook" }, { "path": "/api/webhook/backoffice/webhooks", "method": "GET", "description": "deleteWebhook" }, { "path": "/api/webhook/backoffice/webhooks", "method": "GET", "description": "updateWebhook" } ], "/api/webhook/backoffice/events": [ { "path": "/api/webhook/backoffice/events", "method": "GET", "description": "getEvents" } ], "/api/tax/backoffice/tax-rates": [ { "path": "/api/tax/backoffice/tax-rates", "method": "GET", "description": "getTaxRates" }, { "path": "/api/tax/backoffice/tax-rates", "method": "GET", "description": "getPageableTaxRates" }, { "path": "/api/tax/backoffice/tax-rates", "method": "POST", "description": "createTaxRate" }, { "path": "/api/tax/backoffice/tax-rates", "method": "GET", "description": "getTaxRate" }, { "path": "/api/tax/backoffice/tax-rates", "method": "GET", "description": "deleteTaxRate" }, { "path": "/api/tax/backoffice/tax-rates", "method": "GET", "description": "editTaxRate" } ], "/api/tax/backoffice/tax-classes": [ { "path": "/api/tax/backoffice/tax-classes", "method": "GET", "description": "getTaxClasses" }, { "path": "/api/tax/backoffice/tax-classes", "method": "GET", "description": "getPageableTaxClasses" }, { "path": "/api/tax/backoffice/tax-classes", "method": "POST", "description": "createTaxClass" }, { "path": "/api/tax/backoffice/tax-classes", "method": "GET", "description": "getTaxClass" }, { "path": "/api/tax/backoffice/tax-classes", "method": "GET", "description": "deleteTaxClass" }, { "path": "/api/tax/backoffice/tax-classes", "method": "GET", "description": "editTaxClass" } ], "/api/rating/backoffice/ratings": [ { "path": "/api/rating/backoffice/ratings", "method": "GET", "description": "getRatings" }, { "path": "/api/rating/backoffice/ratings", "method": "GET", "description": "getLatestRatings" }, { "path": "/api/rating/backoffice/ratings", "method": "GET", "description": "deleteRatingById" } ], "/api/promotion/backoffice/promotions": [ { "path": "/api/promotion/backoffice/promotions", "method": "GET", "description": "getPromotions" }, { "path": "/api/promotion/backoffice/promotions", "method": "POST", "description": "createPromotion" }, { "path": "/api/promotion/backoffice/promotions", "method": "PUT", "description": "updatePromotion" }, { "path": "/api/promotion/backoffice/promotions", "method": "GET", "description": "getPromotion" }, { "path": "/api/promotion/backoffice/promotions", "method": "GET", "description": "deletePromotion" } ], "/api/order/backoffice/orders": [ { "path": "/api/order/backoffice/orders", "method": "GET", "description": "getOrders" }, { "path": "/api/order/backoffice/orders", "method": "GET", "description": "getLatestOrders" }, { "path": "/api/order/backoffice/orders", "method": "GET", "description": "getOrderById" } ], "/api/location/backoffice/state-or-provinces": [ { "path": "/api/location/backoffice/state-or-provinces", "method": "GET", "description": "getStateOrProvincesByCountry" }, { "path": "/api/location/backoffice/state-or-provinces", "method": "GET", "description": "getPageableStateOrProvinces" }, { "path": "/api/location/backoffice/state-or-provinces", "method": "POST", "description": "createStateOrProvince" }, { "path": "/api/location/backoffice/state-or-provinces", "method": "GET", "description": "getStateOrProvince" }, { "path": "/api/location/backoffice/state-or-provinces", "method": "GET", "description": "deleteStateOrProvince" }, { "path": "/api/location/backoffice/state-or-provinces", "method": "GET", "description": "editStateOrProvince" }, { "path": "/api/location/backoffice/state-or-provinces", "method": "GET", "description": "getStatesOrProvinces" } ], "/api/location/backoffice/countries": [ { "path": "/api/location/backoffice/countries", "method": "GET", "description": "getCountries" }, { "path": "/api/location/backoffice/countries", "method": "GET", "description": "getPageableCountries" }, { "path": "/api/location/backoffice/countries", "method": "POST", "description": "createCountry" }, { "path": "/api/location/backoffice/countries", "method": "GET", "description": "getCountry" }, { "path": "/api/location/backoffice/countries", "method": "GET", "description": "deleteCountry" }, { "path": "/api/location/backoffice/countries", "method": "GET", "description": "editCountry" } ], "/api/inventory/backoffice/warehouses": [ { "path": "/api/inventory/backoffice/warehouses", "method": "GET", "description": "getProductInWarehouse" }, { "path": "/api/inventory/backoffice/warehouses", "method": "GET", "description": "getWarehouses" }, { "path": "/api/inventory/backoffice/warehouses", "method": "GET", "description": "getPageableWarehouses" }, { "path": "/api/inventory/backoffice/warehouses", "method": "POST", "description": "createWarehouse" }, { "path": "/api/inventory/backoffice/warehouses", "method": "GET", "description": "getWarehouse" }, { "path": "/api/inventory/backoffice/warehouses", "method": "GET", "description": "deleteWarehouse" }, { "path": "/api/inventory/backoffice/warehouses", "method": "GET", "description": "editWarehouse" } ], "/api/inventory/backoffice/stocks": [ { "path": "/api/inventory/backoffice/stocks", "method": "POST", "description": "addProductIntoWarehouse" }, { "path": "/api/inventory/backoffice/stocks", "method": "GET", "description": "fetchStocksInWarehouseByProductNameAndProductSku" }, { "path": "/api/inventory/backoffice/stocks", "method": "PUT", "description": "updateProductQuantityInStock" } ], "/api/inventory/backoffice/stocks/histories": [ { "path": "/api/inventory/backoffice/stocks/histories", "method": "GET", "description": "getStockHistories" } ], "/api/customer": [ { "path": "/api/customer", "method": "GET", "description": "getCustomers" }, { "path": "/api/customer", "method": "GET", "description": "getCustomer" }, { "path": "/api/customer", "method": "GET", "description": "createCustomer" }, { "path": "/api/customer", "method": "GET", "description": "updateCustomer" }, { "path": "/api/customer", "method": "GET", "description": "deleteCustomer" }, { "path": "/api/customer", "method": "GET", "description": "getMyProfile" } ], "/api/product/backoffice/product-template": [ { "path": "/api/product/backoffice/product-template", "method": "GET", "description": "getProductTemplates" }, { "path": "/api/product/backoffice/product-template", "method": "GET", "description": "getPageableProductTemplates" }, { "path": "/api/product/backoffice/product-template", "method": "POST", "description": "createProductTemplate" }, { "path": "/api/product/backoffice/product-template", "method": "GET", "description": "getProductTemplate" }, { "path": "/api/product/backoffice/product-template", "method": "GET", "description": "updateProductTemplate" } ], "/api/product/backoffice": [ { "path": "/api/product/backoffice", "method": "GET", "description": "getProducts" }, { "path": "/api/product/backoffice", "method": "GET", "description": "getLatestProducts" }, { "path": "/api/product/backoffice", "method": "GET", "description": "exportProducts" }, { "path": "/api/product/backoffice", "method": "GET", "description": "getProduct" }, { "path": "/api/product/backoffice", "method": "GET", "description": "createProduct" }, { "path": "/api/product/backoffice", "method": "GET", "description": "updateProduct" }, { "path": "/api/product/backoffice", "method": "GET", "description": "deleteProduct" }, { "path": "/api/product/backoffice", "method": "GET", "description": "getVariationsByProductId" }, { "path": "/api/product/backoffice", "method": "GET", "description": "getRelatedProductByProductId" }, { "path": "/api/product/backoffice", "method": "GET", "description": "getProductOptionValueByProductId" } ], "/api/product/backoffice/product-options": [ { "path": "/api/product/backoffice/product-options", "method": "GET", "description": "getProductOptions" }, { "path": "/api/product/backoffice/product-options", "method": "GET", "description": "getPageableProductOptions" }, { "path": "/api/product/backoffice/product-options", "method": "GET", "description": "getProductOption" }, { "path": "/api/product/backoffice/product-options", "method": "POST", "description": "createProductOption" }, { "path": "/api/product/backoffice/product-options", "method": "GET", "description": "updateProductOption" }, { "path": "/api/product/backoffice/product-options", "method": "GET", "description": "deleteProductOption" } ], "/api/product/backoffice/product-attribute-value": [ { "path": "/api/product/backoffice/product-attribute-value", "method": "GET", "description": "getAttributeValueOfProduct" }, { "path": "/api/product/backoffice/product-attribute-value", "method": "POST", "description": "createProductAttributeValueOfProduct" }, { "path": "/api/product/backoffice/product-attribute-value", "method": "GET", "description": "updateProductAttributeValueOfProduct" }, { "path": "/api/product/backoffice/product-attribute-value", "method": "GET", "description": "deleteProductAttributeValueOfProductById" } ], "/api/product/backoffice/product-attribute": [ { "path": "/api/product/backoffice/product-attribute", "method": "GET", "description": "getProductAttributes" }, { "path": "/api/product/backoffice/product-attribute", "method": "GET", "description": "getPageableProductAttributes" }, { "path": "/api/product/backoffice/product-attribute", "method": "POST", "description": "createProductAttribute" }, { "path": "/api/product/backoffice/product-attribute", "method": "GET", "description": "updateProductAttribute" }, { "path": "/api/product/backoffice/product-attribute", "method": "GET", "description": "getProductAttribute" }, { "path": "/api/product/backoffice/product-attribute", "method": "GET", "description": "deleteProductAttribute" } ], "/api/product/backoffice/product-attribute-groups": [ { "path": "/api/product/backoffice/product-attribute-groups", "method": "GET", "description": "getProductAttributeGroups" }, { "path": "/api/product/backoffice/product-attribute-groups", "method": "GET", "description": "getPageableProductAttributeGroups" }, { "path": "/api/product/backoffice/product-attribute-groups", "method": "GET", "description": "getProductAttributeGroup" }, { "path": "/api/product/backoffice/product-attribute-groups", "method": "POST", "description": "createProductAttributeGroup" }, { "path": "/api/product/backoffice/product-attribute-groups", "method": "GET", "description": "updateProductAttributeGroup" }, { "path": "/api/product/backoffice/product-attribute-groups", "method": "GET", "description": "deleteProductAttributeGroup" } ], "/api/media/medias": [ { "path": "/api/media/medias", "method": "POST", "description": "uploadMedia" } ], "/api/product/backoffice/categories": [ { "path": "/api/product/backoffice/categories", "method": "GET", "description": "getCategories" }, { "path": "/api/product/backoffice/categories", "method": "GET", "description": "getCategory" }, { "path": "/api/product/backoffice/categories", "method": "POST", "description": "createCategory" }, { "path": "/api/product/backoffice/categories", "method": "GET", "description": "updateCategory" }, { "path": "/api/product/backoffice/categories", "method": "GET", "description": "deleteCategory" }, { "path": "/api/product/backoffice/categories", "method": "GET", "description": "getProductsByCategory" } ], "/api/product/backoffice/brands": [ { "path": "/api/product/backoffice/brands", "method": "GET", "description": "getBrands" }, { "path": "/api/product/backoffice/brands", "method": "GET", "description": "getPageableBrands" }, { "path": "/api/product/backoffice/brands", "method": "POST", "description": "createBrand" }, { "path": "/api/product/backoffice/brands", "method": "GET", "description": "getBrand" }, { "path": "/api/product/backoffice/brands", "method": "GET", "description": "deleteBrand" }, { "path": "/api/product/backoffice/brands", "method": "GET", "description": "editBrand" } ] }, "types": { "Webhook": { "name": "Webhook", "properties": { "id": "number", "payloadUrl": "string", "secret": "string", "contentType": "string", "isActive": "boolean", "events": "WebhookEvent[]" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/webhook/models/Webhook.ts" }, "WebhookEvent": { "name": "WebhookEvent", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/webhook/models/Event.ts" }, "TaxRate": { "name": "TaxRate", "properties": { "id": "number", "rate": "number", "zipCode": "string", "taxClassName": "string", "taxClassId": "number", "countryId": "number", "countryName": "string", "stateOrProvinceId": "number", "stateOrProvinceName": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/tax/models/TaxRate.ts" }, "TaxClass": { "name": "TaxClass", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/tax/models/TaxClass.ts" }, "RatingSearchForm": { "name": "RatingSearchForm", "properties": { "createdFrom": "Date", "createdTo": "Date", "brandName": "string", "productName": "string", "customerName": "string", "message": "string", "pageNo": "number", "pageSize": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/rating/models/RatingSearchForm.ts" }, "Rating": { "name": "Rating", "properties": { "id": "number", "content": "string", "createdBy": "string", "star": "number", "productId": "number", "createdOn": "Date", "lastName": "string", "firstName": "string", "productName": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/rating/models/Rating.ts" }, "PromotionDetail": { "name": "PromotionDetail", "properties": { "id": "number", "name": "string", "slug": "string", "description": "string", "couponCode": "string", "usageLimit": "number", "usageCount": "number", "discountType": "string", "applyTo": "string", "usageType": "string", "discountPercentage": "number", "discountAmount": "number", "minimumOrderPurchaseAmount": "number", "isActive": "boolean", "startDate": "string", "endDate": "string", "brands": "BrandVm[]", "categories": "CategoryGetVm[]", "products": "ProductVm[]" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Promotion.ts" }, "PromotionPage": { "name": "PromotionPage", "properties": { "promotionDetailVmList": "PromotionDetail[]", "pageNo": "number", "pageSize": "number", "totalPage": "number", "totalElements": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Promotion.ts" }, "PromotionListRequest": { "name": "PromotionListRequest", "properties": { "promotionName": "string", "couponCode": "string", "pageNo": "number", "pageSize": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Promotion.ts" }, "PromotionDto": { "name": "PromotionDto", "properties": { "id": "number", "name": "string", "slug": "string", "description": "string", "couponCode": "string", "usageLimit": "number", "discountType": "string", "applyTo": "string", "usageType": "string", "discountPercentage": "number", "discountAmount": "number", "minimumOrderPurchaseAmount": "number", "isActive": "boolean", "startDate": "string", "endDate": "string", "brandIds": "number[]", "categoryIds": "number[]", "productIds": "number[]" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Promotion.ts" }, "ProductVm": { "name": "ProductVm", "properties": { "id": "number", "name": "string", "slug": "string", "isAllowedToOrder": "boolean", "isPublished": "boolean", "isFeatured": "boolean", "isVisibleIndividually": "boolean", "createdOn": "Date", "taxClassId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Product.ts" }, "CategoryGetVm": { "name": "CategoryGetVm", "properties": { "id": "number", "name": "string", "slug": "string", "parentId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Category.ts" }, "BrandVm": { "name": "BrandVm", "properties": { "id": "number", "name": "string", "slug": "string", "isPublish": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/promotion/models/Brand.ts" }, "ProfileRequest": { "name": "ProfileRequest", "properties": { "email": "string", "firstName": "string", "lastName": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/profile/models/ProfileRequest.ts" }, "Payment": { "name": "Payment", "properties": { "id": "number", "name": "string", "isEnabled": "boolean", "configureUrl": "string", "landingViewComponentName": "string", "additionalSettings": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/payment/models/Payment.ts" }, "OrderSearchForm": { "name": "OrderSearchForm", "properties": { "createdFrom": "Date", "createdTo": "Date", "orderStatus": "string[]", "productName": "string", "countryName": "string", "email": "string", "billingPhoneNumber": "string", "pageNo": "number", "pageSize": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/order/models/OrderSearchForm.ts" }, "OrderItem": { "name": "OrderItem", "properties": { "id": "number", "productId": "number", "productName": "string", "quantity": "number", "productPrice": "number", "note": "string", "discountAmount": "number", "taxAmount": "number", "taxPercent": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/order/models/OrderItem.ts" }, "OrderAddress": { "name": "OrderAddress", "properties": { "id": "number", "contactName": "string", "phone": "string", "addressLine1": "string", "addressLine2": "string", "city": "string", "zipCode": "string", "districtId": "number", "districtName": "string", "stateOrProvinceId": "number", "stateOrProvinceName": "string", "countryId": "number", "countryName": "string", "isActive": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/order/models/OrderAddress.ts" }, "Order": { "name": "Order", "properties": { "id": "number", "email": "string", "note": "string", "tax": "number", "discount": "number", "numberItem": "number", "totalPrice": "number", "deliveryFee": "number | 0", "couponCode": "string", "deliveryMethod": "string", "deliveryStatus": "string", "paymentMethod": "string", "paymentStatus": "string", "createdOn": "Date", "orderStatus": "string", "orderItemVms": "OrderItem[]", "shippingAddressVm": "OrderAddress", "billingAddressVm": "OrderAddress", "checkoutId": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/order/models/Order.ts" }, "StateOrProvince": { "name": "StateOrProvince", "properties": { "id": "number", "name": "string", "code": "string", "type": "string", "countryId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/location/models/StateOrProvince.ts" }, "District": { "name": "District", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/location/models/District.ts" }, "Country": { "name": "Country", "properties": { "id": "number", "code2": "string", "name": "string", "code3": "string", "isBillingEnabled": "boolean", "isShippingEnabled": "boolean", "isCityEnabled": "boolean", "isZipCodeEnabled": "boolean", "isDistrictEnabled": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/location/models/Country.ts" }, "WarehouseDetail": { "name": "WarehouseDetail", "properties": { "id": "number", "name": "string", "contactName": "string", "phone": "string", "addressLine1": "string", "addressLine2": "string", "city": "string", "zipCode": "string", "districtId": "number", "stateOrProvinceId": "number", "countryId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/WarehouseDetail.ts" }, "Warehouse": { "name": "Warehouse", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/Warehouse.ts" }, "StockInfo": { "name": "StockInfo", "properties": { "id": "number", "productId": "number", "productName": "string", "productSku": "string", "quantity": "number", "reservedQuantity": "number", "warehouseId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/StockInfo.ts" }, "StockHistoryList": { "name": "StockHistoryList", "properties": { "data": "StockHistory[]" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/StockHistoryList.ts" }, "StockHistory": { "name": "StockHistory", "properties": { "id": "number", "productName": "string", "adjustedQuantity": "number", "createdBy": "string", "createdOn": "string", "note": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/StockHistory.ts" }, "StockPostVM": { "name": "StockPostVM", "properties": { "productId": "number", "warehouseId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/Stock.ts" }, "ProductQuantityInStock": { "name": "ProductQuantityInStock", "properties": { "stockId": "number", "quantity": "number", "note": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/ProductQuantityInStock.ts" }, "ProductInfoVm": { "name": "ProductInfoVm", "properties": { "id": "number", "name": "string", "sku": "string", "existInWh": "boolean", "isSelected": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/inventory/models/ProductInfoVm.ts" }, "Customers": { "name": "Customers", "properties": { "customers": "Customer[]", "totalPage": "number", "totalUser": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/customer/models/Customers.ts" }, "Customer": { "name": "Customer", "properties": { "id": "string", "email": "string", "username": "string", "firstName": "string", "lastName": "string", "createdTimestamp": "Date" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/customer/models/Customer.ts" }, "CustomerCreateVM": { "name": "CustomerCreateVM", "properties": { "username": "string", "email": "string", "firstName": "string", "lastName": "string", "password": "string", "confirmPassword": "string", "role": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/customer/models/Customer.ts" }, "CustomerUpdateVM": { "name": "CustomerUpdateVM", "properties": { "email": "string", "firstName": "string", "lastName": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/customer/models/Customer.ts" }, "Products": { "name": "Products", "properties": { "productContent": "Product[]", "pageNo": "number", "pageSize": "number", "totalElements": "number", "totalPages": "number", "isLast": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/Products.ts" }, "ProductVariationPut": { "name": "ProductVariationPut", "properties": {}, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductVariationPut.ts" }, "ProductVariationPost": { "name": "ProductVariationPost", "properties": { "name": "string", "slug": "string", "sku": "string", "gtin": "string", "price": "number", "thumbnailMediaId": "number", "productImageIds": "number[]", "optionValuesByOptionId": "Object" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductVariationPost.ts" }, "ProductVariation": { "name": "ProductVariation", "properties": { "id": "number", "optionName": "string", "optionSku": "string", "optionGTin": "string", "optionPrice": "number", "optionThumbnail": "Media", "optionImages": "Media[]", "optionValuesByOptionId": "Record<number, string>" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductVariation.ts" }, "Variantion": { "name": "Variantion", "properties": { "id": "number", "name": "string", "slug": "string", "sku": "string", "gtin": "string", "price": "number", "thumbnail": "Media", "productImages": "Media[]", "options": "{\n [key: string]: string;\n }" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductVariation.ts" }, "ProductThumbnails": { "name": "ProductThumbnails", "properties": { "productContent": "ProductThumbnail[]", "pageNo": "number", "pageSize": "number", "totalElements": "number", "totalPages": "number", "isLast": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductThumbnails.ts" }, "ProductThumbnail": { "name": "ProductThumbnail", "properties": { "id": "number", "name": "string", "slug": "string", "thumbnailUrl": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductThumbnail.ts" }, "ProductTemplate": { "name": "ProductTemplate", "properties": { "id": "number", "name": "string", "productAttributeTemplates": "ProductAttributeTemplate[]" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/FormProductTemplate.ts" }, "ProductPayload": { "name": "ProductPayload", "properties": { "name": "string", "slug": "string", "brandId": "number", "categoryIds": "number[]", "shortDescription": "string", "description": "string", "specification": "string", "sku": "string", "gtin": "string", "weight": "number", "dimensionUnit": "string", "length": "number", "width": "number", "height": "number", "price": "number", "isAllowedToOrder": "boolean", "isPublished": "boolean", "isFeatured": "boolean", "isVisibleIndividually": "boolean", "stockTrackingEnabled": "boolean", "taxIncluded": "boolean", "metaTitle": "string", "metaKeyword": "string", "metaDescription": "string", "thumbnailMediaId": "number", "productImageIds": "number[]", "variations": "ProductVariationPost[] | ProductVariationPut[]", "productOptionValues": "ProductOptionsValuePost[]", "productOptionValueDisplays": "ProductOptionValueDisplay[]", "relatedProductIds": "number[]", "taxClassId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductPayload.ts" }, "ProductOptionsValuePost": { "name": "ProductOptionsValuePost", "properties": { "productOptionId": "number", "value": "string[]", "displayType": "string", "displayOrder": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductOptionValuePost.ts" }, "ProductOptionValuePost": { "name": "ProductOptionValuePost", "properties": { "productOptionId": "number", "value": "{\n [key: string]: string;\n }", "displayType": "string", "displayOrder": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductOptionValuePost.ts" }, "ProductOptionValueDisplay": { "name": "ProductOptionValueDisplay", "properties": { "productOptionId": "number", "value": "string", "displayType": "string", "displayOrder": "number", "productOptionName": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductOptionValuePost.ts" }, "ProductOptionValueDisplayGet": { "name": "ProductOptionValueDisplayGet", "properties": { "productOptionId": "number", "productOptionValue": "string", "displayType": "string", "displayOrder": "number", "productOptionName": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductOptionValuePost.ts" }, "ProductOption": { "name": "ProductOption", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductOption.ts" }, "ProductImage": { "name": "ProductImage", "properties": { "thumbnail": "File", "productImages": "FileList" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductImage.ts" }, "ProductAttributeValuePost": { "name": "ProductAttributeValuePost", "properties": { "productId": "number", "productAttributeId": "number", "value": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductAttributeValuePost.ts" }, "ProductAttributeValue": { "name": "ProductAttributeValue", "properties": { "id": "number", "nameProductAttribute": "string", "value": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductAttributeValue.ts" }, "ProductAttributeGroup": { "name": "ProductAttributeGroup", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductAttributeGroup.ts" }, "ProductAttribute": { "name": "ProductAttribute", "properties": { "id": "number", "name": "string", "productAttributeGroup": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/ProductAttribute.ts" }, "Product": { "name": "Product", "properties": { "id": "number", "name": "string", "shortDescription": "string", "description": "string", "specification": "string", "sku": "string", "gtin": "string", "slug": "string", "weight": "number", "dimensionUnit": "string", "length": "number", "width": "number", "height": "number", "price": "number", "metaTitle": "string", "metaKeyword": "string", "metaDescription": "string", "isAllowedToOrder": "boolean", "isPublished": "boolean", "isFeatured": "boolean", "isVisible": "boolean", "stockTrackingEnabled": "boolean", "taxIncluded": "boolean", "brandId": "number", "categories": "Category[]", "thumbnailMedia": "Media", "productImageMedias": "Media[]", "createdOn": "Date", "taxClassId": "number", "parentId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/Product.ts" }, "Media": { "name": "Media", "properties": { "id": "number", "url": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/Media.ts" }, "ProductAttributeOfTemplate": { "name": "ProductAttributeOfTemplate", "properties": { "productAttributeId": "number", "displayOrder": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/FormProductTemplate.ts" }, "productAttribute": { "name": "productAttribute", "properties": { "id": "number", "name": "string" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/FormProductTemplate.ts" }, "ProductAttributeTemplate": { "name": "ProductAttributeTemplate", "properties": { "displayOrder": "number", "productAttribute": "productAttribute" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/FormProductTemplate.ts" }, "FromProductTemplate": { "name": "FromProductTemplate", "properties": { "name": "string", "productAttributeTemplates": "ProductAttributeOfTemplate[]" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/FormProductTemplate.ts" }, "FormProduct": { "name": "FormProduct", "properties": { "name": "string", "slug": "string", "brandId": "number", "categoryIds": "number[]", "description": "string", "shortDescription": "string", "specification": "string", "sku": "string", "gtin": "string", "weight": "number", "dimensionUnit": "string", "length": "number", "width": "number", "height": "number", "price": "number", "isAllowedToOrder": "boolean", "isPublished": "boolean", "isFeatured": "boolean", "isVisibleIndividually": "boolean", "stockTrackingEnabled": "boolean", "taxIncluded": "boolean", "thumbnailMedia": "Media", "productImageMedias": "Media[]", "metaTitle": "string", "metaKeyword": "string", "metaDescription": "string", "relateProduct": "number[]", "crossSell": "number[]", "productAttributes": "ProductAttributeValue[]", "productVariations": "ProductVariation[]", "productOptionValuePost": "ProductOptionValuePost[]", "taxClassId": "number" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/FormProduct.ts" }, "Filter": { "name": "Filter", "properties": { "name": "string", "icon": "any" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/Filter.ts" }, "Category": { "name": "Category", "properties": { "id": "number", "name": "string", "description": "string", "slug": "string", "parentId": "number | null", "metaKeywords": "string", "metaDescription": "string", "displayOrder": "number", "isPublish": "boolean", "imageId": "number", "categoryImage": "{\n id: number;\n url: string;\n }" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/Category.ts" }, "Brand": { "name": "Brand", "properties": { "id": "number", "name": "string", "slug": "string", "isPublish": "boolean" }, "sourceFile": "/Users/twondma/Documents/Projects/yas/backoffice/modules/catalog/models/Brand.ts" } }, "auth": { "type": "oauth2", "config": {} } }
- Assistant
Этот JSON представляет собой описание API, который предоставляет различные конечные точки для функционала интернет-магазина и бэк-офиса. Данные структурированы в несколько ключевых разделов, каждый из которых содержит информацию о различных ресурсах и их параметрах.
Основные Sections:
-
endpoints:
- Этот раздел описывает различные конечные точки API, сгруппированные по категориям (
storefront,backoffice, и др.). - Каждая конечная точка включает путь (
path), метод (например,GET,POST), описание функции конечной точки (description) и параметры (params), которые требует конечная точка.
Примеры из раздела endpoints:
/storefront/orders/my-orders: Получение заказов текущего пользователя./backoffice/orders: Получение списка заказов с возможностью фильтрации по различным параметрам.
- Этот раздел описывает различные конечные точки API, сгруппированные по категориям (
-
types:
- Этот раздел описывает различные типы данных, которые используются в API, включая структуру их свойств.
- Каждый тип данных имеет имя и свойства, а также путь к исходному файлу, где этот тип определяется.
Примеры из раздела types:
Webhook: Описание вебхука включает идентификатор, URL полезной нагрузки, секрет и другие параметры.Order: Описание заказа включает информацию о клиенте, элементах заказа, ценах и статусах.
-
auth:
- Этот раздел описывает метод аутентификации, используемый для доступа к API.
- В данном случае используется
oauth2, что означает, что для доступа к конечным точкам API может потребоваться токен доступа.
Общая структура:
- JSON организован в виде "ключ-значение", где каждое значение может быть объектом, массивом объектов или примитивным типом (число, строка и т. д.).
- Эта структура позволяет разработчикам быстро понять, какие действия можно выполнить через API, какие параметры необходимы и какие типы данных они могут ожидать.
В общем, этот JSON служит документацией для API, предоставляя разработчикам полное представление о доступных ресурсах и взаимодействиях с ними.
-
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.