Description

This API is used to retrieve the category product list. Category ID details must be available for calling this API.

Product List API must be called periodically i.e. once a month. If there are changes in the product attributes, then QC will
inform integrator about the impact of change. Post confirmation from QC, call Product List API and then refresh the
database.

Method: GET

URL/Path: baseurl/rest/v3/orders

E.g.: extapi12.budgetree .in/rest/v3/orders

Request URL Parameters:

Field Name	Data Type	Mandatory/Optional	Description	Example
id	int	Optional	Category ID	5
offset	int	Optional	Offset is the position from where the product list will be retrieved.	If the limit is 10 and offset is 0, then the first 10 products will be retrieved [0-9]. Similarly, if the limit is 10 and offset is 5, 10 products will be retrieved starting from position 5 [5-14]
limit	int	Optional	Limit is the number of products that will be shown on each page. Max value is 500.	100

Request Header:

Content-Type	application/json
Accept	*/*

Sample Request – For GET calls, request body is not required.

Request Parameters – For GET calls, request parameters are not required.

Sample Response

NOTE: The sample contains information on the length of the parameters

Sample Response    200

            {
                "id": "7", (10)
                "name": "Budgetree Root", (255)
                "url": "/budgetree -root",(255)
                "description": null,(65535)
                "images": {
                    "image": null, (255)
                    "thumbnail": null (255)
                },
                "productsCount": 40,(10)
                "products": [
                    {
                        "sku": "EGCGBPAN001", (64)
                        "name": "Pantaloons E-Gift Card", (255)
                        "currency": {
                            "code": "INR",(3)
                            "symbol": "₹",(3)
                            "numericCode": "356" (3)
                        },
                        "url": "pantaloons-e-gift-card",(255)
                        "minPrice": "100", (255)
                        "maxPrice": "2000", (255)
                        "images": {
                            "thumbnail": "https://gbdev.s3.amazonaws.com/uat/product/EGCGBPAN001/d/thumbnail/233_budgetree .png",(255)
                            "mobile": "https://gbdev.s3.amazonaws.com/uat/product/EGCGBPAN001/d/mobile/233_budgetree .png",(255)
                            "base": "https://gbdev.s3.amazonaws.com/uat/product/EGCGBPAN001/d/image/233_budgetree .png",(255)
                            "small": "https://gbdev.s3.amazonaws.com/uat/product/EGCGBPAN001/d/small_image/233_budgetree .png" (255)
                        },
            "createdAt" : "", (iso-format)
            "updatedAt" : "" (iso-format)
                    },
                    { //second node
                        "sku": "GCGBAMZN001",
                        "name": "Amazon.in Gift Card",
                        "currency": {
                            "code": "INR",
                            "symbol": "₹",
                            "numericCode": "356"
                        },
                        "url": "amazon-in-gift-card",
                        "minPrice": "1",
                        "maxPrice": "10000",
                        "images": {
                            "thumbnail": "https://gbdev.s3.amazonaws.com/uat/product/GCGBAMZN001/d/thumbnail/137_budgetree .png",
                            "mobile": "https://gbdev.s3.amazonaws.com/uat/product/GCGBAMZN001/d/mobile/137_budgetree .jpg",
                            "base": "https://gbdev.s3.amazonaws.com/uat/product/GCGBAMZN001/d/image/137_budgetree .jpg",
                            "small": "https://gbdev.s3.amazonaws.com/uat/product/GCGBAMZN001/d/small_image/137_budgetree .png"
                        }
                    }
                ]
            }
            

Sample Response    400

                {
                    "code": 6652,
                    "message": "Invalid Category",
                    "messages": []
                  }
                

Response Parameters

Success

Field Name	Data Type	Mandatory	Description	Example
id	string	Yes	Catalog ID	2
name	string	Yes	Catalog Name	Digital
url	string	Yes	Catalog URL	digital
description	string	No	Catalog Description	About Catalog
images	object
image	string	No	Catalog image	Image URL
thumbnail	string	No	Catalog Thumbnail Image	Image URL
productsCount	number	No	Product Count	1
products	array
object
sku	string	No	Product SKU	ACTVPRD
name	string	No	Product Name	Active Products
currency	object
code	string	No	Currency code	INR
numericCode	string	No	Currency numeric code	356
symbol	string	No	Currency symbol	₹
url	string	No	Product URL	digital
minPrice	string	No	Product Minimum Price	100
maxPrice	string	No	Product Maximum Price	10000
images	object
images	string	No	Product Image	Image URL
thumbnail	string	No	Product Thumbnail Image	Image URL
base	string	No	Product Base Image	Image URL
small	string	No	Product Small Image	Image URL
createdAt	DateTime	yes	Product creation date-time details in UTC. The format will standard iso-8601
updatedAt	DateTime	yes	Product’s last update date-time details in UTC. The format will standard iso-8601

Failure

Field Name	Data Type	Mandatory	Description	Example
code	number	Yes	Error Code	6652
message	string	Yes	Error Message	Invalid Category
messages	array

HTTP Codes

Status Code	Message	Description
200	Ok	This indicates category product details are returned.
400	Bad Request	This indicates request validations are failed
401	Unauthorized	This indicates OAuth authorization failed to validate
403	Forbidden	This indicates API access is revoked or insufficient permissions
500	Internal Server Error	This indicates an error has occurred on budgetree

Error Response Codes

Status Code	Description
6652	Invalid category

---

---