From 18321d3639c1a6fdbd592fe4d49b5c9d6b486b8b Mon Sep 17 00:00:00 2001 From: Bo Su Date: Thu, 7 Sep 2023 17:53:41 +1000 Subject: [PATCH] UNITY-8531 REST: extend PATCH/GET operations on Product API - Review changes --- .../examples/patch_product_productid_request.json | 6 +++--- .../examples/patch_product_productid_response.json | 2 +- _raml/apps/products/products.raml | 1 + apps/data-types.md | 14 +++++++------- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/_raml/apps/products/examples/patch_product_productid_request.json b/_raml/apps/products/examples/patch_product_productid_request.json index 4578f4202..518c25593 100644 --- a/_raml/apps/products/examples/patch_product_productid_request.json +++ b/_raml/apps/products/examples/patch_product_productid_request.json @@ -69,12 +69,12 @@ { "op": "add", "path": "/customisationInfo", - "value": {"isCustomizable":1, "customizableTextLength":50, "customizableHeadlineText":"headline text"} + "value": {"isCustomizable":true, "customizableTextLength":50, "customizableHeadlineText":"Customize your product"} }, { "op": "add", "path": "/title", - "value": "My title" + "value": "BRAND NEW: Dr.Boom - Star Wars Edition - Technic365" }, { "op": "add", @@ -94,5 +94,5 @@ { "op": "add", "path": "/productCode", - "value": "examplecode" + "value": "Z-1080-BT-02" }] \ No newline at end of file diff --git a/_raml/apps/products/examples/patch_product_productid_response.json b/_raml/apps/products/examples/patch_product_productid_response.json index 87d487dc1..ab231fe18 100644 --- a/_raml/apps/products/examples/patch_product_productid_response.json +++ b/_raml/apps/products/examples/patch_product_productid_response.json @@ -199,7 +199,7 @@ "refAmount": 1, "refUnit": "piece", "refContentAmount": 2, - "productCode": null, + "productCode": "Z-108-002", "manufacturer": "Bass by Dr.Boom", "upc": null, "ean": null, diff --git a/_raml/apps/products/products.raml b/_raml/apps/products/products.raml index 65e18783b..ed3547b6a 100644 --- a/_raml/apps/products/products.raml +++ b/_raml/apps/products/products.raml @@ -111,6 +111,7 @@ post: - /isNew
- /newnessDate
- /video
+ - /isVATInfoVisible
- /isManufacturerPriceRRP
- /referencePriceInfo
- /isShippingLinkVisible
diff --git a/apps/data-types.md b/apps/data-types.md index 2d2c70cb5..17e3e6540 100644 --- a/apps/data-types.md +++ b/apps/data-types.md @@ -629,9 +629,9 @@ This object is used for the attributes of basePrice, depositPrice, ecoParticipat | customizableHeadlineText | string | The headline for the customization text field in the storefront. | | newnessDate | string | The date when the 'New' marker is set to expire. Expressed according to ISO 8601. | | refAmount | string | The product reference amount with respect to the product price (e.g. every 1 'piece' costs 10,00 €) | -| refUnit | string | The product reference unit. Can be *byte*, *kilobyte*, *megabyte*, *gigabyte*, *terrabyte*, *gram*, *kilogram*, *milligram*, *ounce*, *pound*, *tone*, *litre*, *cubicfoot*, *cubicinch*, *cubicmetre*, *cubicyard*, *fluidounce*, *gallon*, *millilitre*, *quart*, *metre*, *centimetre*, *foot*, *inch*, *kilometre*, *millimetre*, *yard*, *piece*, *bottle*, *box*, *can*, *capsule*, *carton*, *glass*, *kit*, *pack*, *packet*, *pair*, *roll*, *set*, *sheet*, *ticket*, *unit*, *second*, *day*, *hour*, *minute*, *month*, *night*, *week*, *year*, *squaremetre*, *squarecentimetre*, *squarefoot*, *squareinch*, *squaremillimetre*, *squareyard* | -| refContentAmount | string | The number of reference units that is packaged within the product itself (e.g. the product contains 2 'piece(s)') | -| productCode | string | The product code (e.g. EAN, UPC, ASIN und ISBN) | +| refUnit | string | The product reference unit. Can be *byte*, *kilobyte*, *megabyte*, *gigabyte*, *terrabyte*, *gram*, *kilogram*, *milligram*, *ounce*, *pound*, *tone*, *litre*, *cubicfoot*, *cubicinch*, *cubicmetre*, *cubicyard*, *fluidounce*, *gallon*, *millilitre*, *quart*, *metre*, *centimetre*, *foot*, *inch*, *kilometre*, *millimetre*, *yard*, *piece*, *bottle*, *box*, *can*, *capsule*, *carton*, *glass*, *kit*, *pack*, *packet*, *pair*, *roll*, *set*, *sheet*, *ticket*, *unit*, *second*, *day*, *hour*, *minute*, *month*, *night*, *week*, *year*, *squaremetre*, *squarecentimetre*, *squarefoot*, *squareinch*, *squaremillimetre*, *squareyard*. | +| refContentAmount | string | The number of reference units that is packaged within the product itself (e.g. the product contains 2 'piece(s)'). | +| productCode | string | The product code (e.g. EAN, UPC, ASIN and ISBN). | ## product (create request) @@ -758,10 +758,10 @@ This object is used for the attributes of basePrice, depositPrice, ecoParticipat | customizableTextLength | number | The maximum length of the custom text the customer can enter for a product in the storefront. | | customizableHeadlineText | string | The headline for the customization text field in the storefront. | | newnessDate | string | The date when the 'New' marker is set to expire. Expressed according to ISO 8601. | -| refAmount | string | The product reference amount with respect to the product price (e.g. every 1 'piece' costs 10,00 €) | -| refUnit | string | The product reference unit. Can be *byte*, *kilobyte*, *megabyte*, *gigabyte*, *terrabyte*, *gram*, *kilogram*, *milligram*, *ounce*, *pound*, *tone*, *litre*, *cubicfoot*, *cubicinch*, *cubicmetre*, *cubicyard*, *fluidounce*, *gallon*, *millilitre*, *quart*, *metre*, *centimetre*, *foot*, *inch*, *kilometre*, *millimetre*, *yard*, *piece*, *bottle*, *box*, *can*, *capsule*, *carton*, *glass*, *kit*, *pack*, *packet*, *pair*, *roll*, *set*, *sheet*, *ticket*, *unit*, *second*, *day*, *hour*, *minute*, *month*, *night*, *week*, *year*, *squaremetre*, *squarecentimetre*, *squarefoot*, *squareinch*, *squaremillimetre*, *squareyard* | -| refContentAmount | string | The number of reference units that is packaged within the product itself (e.g. the product contains 2 'piece(s)') | -| productCode | string | The product code (e.g. EAN, UPC, ASIN und ISBN) | +| refAmount | string | The product reference amount with respect to the product price (e.g. every 1 'piece' costs 10,00 €). | +| refUnit | string | The product reference unit. Can be *byte*, *kilobyte*, *megabyte*, *gigabyte*, *terrabyte*, *gram*, *kilogram*, *milligram*, *ounce*, *pound*, *tone*, *litre*, *cubicfoot*, *cubicinch*, *cubicmetre*, *cubicyard*, *fluidounce*, *gallon*, *millilitre*, *quart*, *metre*, *centimetre*, *foot*, *inch*, *kilometre*, *millimetre*, *yard*, *piece*, *bottle*, *box*, *can*, *capsule*, *carton*, *glass*, *kit*, *pack*, *packet*, *pair*, *roll*, *set*, *sheet*, *ticket*, *unit*, *second*, *day*, *hour*, *minute*, *month*, *night*, *week*, *year*, *squaremetre*, *squarecentimetre*, *squarefoot*, *squareinch*, *squaremillimetre*, *squareyard*. | +| refContentAmount | string | The number of reference units that is packaged within the product itself (e.g. the product contains 2 'piece(s)'). | +| productCode | string | The product code (e.g. EAN, UPC, ASIN and ISBN). | | query | string | The search query. | | fallbackQuery | string | The fallback used if the original query did not produce any results. | | facets | array of [facet](page:apps-data-types#facet) | The refined search filter options. |