Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- "/categories/{categoryId}/products": {
- "get": {
- "tags": [
- "Categories"
- ],
- "summary": "Retrieve all products in a category",
- "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.",
- "parameters": [
- {
- "name": "pricelistid",
- "in": "header",
- "description": "Enter the ID of the price list associated with the products to narrow down the search.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "categoryId",
- "in": "path",
- "description": "Enter the category ID, typically the classification hierarchy ID.",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "filter",
- "in": "query",
- "description": "Add conditional filters in standard URI format to narrow down the search result.",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- {
- "name": "query",
- "in": "query",
- "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.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "includes",
- "in": "query",
- "description": "Add the list of related objects that are associated with the product to include them in the search result.",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- {
- "name": "sort",
- "in": "query",
- "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.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "page",
- "in": "query",
- "description": "Enter the page number of the search result from where to view the result.",
- "schema": {
- "type": "integer",
- "format": "int32",
- "default": 1
- }
- },
- {
- "name": "limit",
- "in": "query",
- "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.",
- "schema": {
- "type": "integer",
- "format": "int32",
- "default": 50
- }
- },
- {
- "name": "cartId",
- "in": "header",
- "description": "Enter the cart Id",
- "schema": {
- "type": "string",
- "default": ""
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "text/plain": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Conga.Revenue.Entities.Product"
- }
- }
- },
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Conga.Revenue.Entities.Product"
- }
- }
- },
- "text/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Conga.Revenue.Entities.Product"
- }
- }
- }
- }
- }
- }
- }
- }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement