Advertisement
Guest User

Untitled

a guest
Apr 1st, 2023
57
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
JSON 4.56 KB | None | 0 0
  1. "/categories/{categoryId}/products": {
  2.       "get": {
  3.         "tags": [
  4.           "Categories"
  5.         ],
  6.         "summary": "Retrieve all products in a category",
  7.         "description": "Retrieve all active products associated with the provided category ID. It can be the ID of leaf category, sub-category, or root category. In case of leaf category, the API returns all products associated with that leaf category. However, if the ID of the root or sub-category is provided, the API returns the products in each child category in the hierarchy that is associated with the provided category ID.",
  8.         "parameters": [
  9.           {
  10.             "name": "pricelistid",
  11.             "in": "header",
  12.             "description": "Enter the ID of the price list associated with the products to narrow down the search.",
  13.             "schema": {
  14.               "type": "string"
  15.             }
  16.           },
  17.           {
  18.             "name": "categoryId",
  19.             "in": "path",
  20.             "description": "Enter the category ID, typically the classification hierarchy ID.",
  21.             "required": true,
  22.             "schema": {
  23.               "type": "string"
  24.             }
  25.           },
  26.           {
  27.             "name": "filter",
  28.             "in": "query",
  29.             "description": "Add conditional filters in standard URI format to narrow down the search result.",
  30.             "schema": {
  31.               "type": "array",
  32.               "items": {
  33.                 "type": "string"
  34.               }
  35.             }
  36.           },
  37.           {
  38.             "name": "query",
  39.             "in": "query",
  40.             "description": "Enter the name of the product to narrow down the search result. The API can only match a maximum of 20 characters. If the input string is longer than 20 characters, the API retrieves products where the product name matches the first 20 characters of the search string.",
  41.             "schema": {
  42.               "type": "string"
  43.             }
  44.           },
  45.           {
  46.             "name": "includes",
  47.             "in": "query",
  48.             "description": "Add the list of related objects that are associated with the product to include them in the search result.",
  49.             "schema": {
  50.               "type": "array",
  51.               "items": {
  52.                 "type": "string"
  53.               }
  54.             }
  55.           },
  56.           {
  57.             "name": "sort",
  58.             "in": "query",
  59.             "description": "Enter the fields and sort order for the result. Add multiple fields to sort the result further. By default, sort order is ascending based on relevance.",
  60.             "schema": {
  61.               "type": "string"
  62.             }
  63.           },
  64.           {
  65.             "name": "page",
  66.             "in": "query",
  67.             "description": "Enter the page number of the search result from where to view the result.",
  68.             "schema": {
  69.               "type": "integer",
  70.               "format": "int32",
  71.               "default": 1
  72.             }
  73.           },
  74.           {
  75.             "name": "limit",
  76.             "in": "query",
  77.             "description": "Enter the number of records to display on each page. By default, the API displays 50 records on each page. A maximum of 500 records are displayed on each page.",
  78.             "schema": {
  79.               "type": "integer",
  80.               "format": "int32",
  81.               "default": 50
  82.             }
  83.           },
  84.           {
  85.             "name": "cartId",
  86.             "in": "header",
  87.             "description": "Enter the cart Id",
  88.             "schema": {
  89.               "type": "string",
  90.               "default": ""
  91.             }
  92.           }
  93.         ],
  94.         "responses": {
  95.           "200": {
  96.             "description": "Success",
  97.             "content": {
  98.               "text/plain": {
  99.                 "schema": {
  100.                   "type": "array",
  101.                   "items": {
  102.                     "$ref": "#/components/schemas/Conga.Revenue.Entities.Product"
  103.                   }
  104.                 }
  105.               },
  106.               "application/json": {
  107.                 "schema": {
  108.                   "type": "array",
  109.                   "items": {
  110.                     "$ref": "#/components/schemas/Conga.Revenue.Entities.Product"
  111.                   }
  112.                 }
  113.               },
  114.               "text/json": {
  115.                 "schema": {
  116.                   "type": "array",
  117.                   "items": {
  118.                     "$ref": "#/components/schemas/Conga.Revenue.Entities.Product"
  119.                   }
  120.                 }
  121.               }
  122.             }
  123.           }
  124.         }
  125.       }
  126.     }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement