Get Products Count
This REST API is used to get the count of the published or unpublished products listings on marketplace. This request generally runs after each authentication request to check if the markteplace has some live (PUBLISHED) listings. In case their are no published listings, no further api requests are sent.
Tip
It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Mandatory |
| Endpoint: | /productsCount |
| Request Type: | GET |
| Scheme: | HTTPS |
| Content-Type: | application/json |
| Header (apiKey): | accessToken (got from Get Authentication) |
Sample URL
https://{MarketplaceBaseUrl}/productsCount?publishedStatus=PUBLISHED
Query Parameters
| PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| publishedStatus | string | Posting Status | Yes | Allowable: PUBLISHED, UNPUBLISHED |
Response Payload
{
"count": 20
}Response Payload (Error)
{
"message":"String"
}Response Payload Details
| PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| count | Number | this is the total of unique count of PUBLISHED listings | - | - |
| message | string | Error message Eg: Invalid User/Token | - | - |
Error Codes
Refer Response Codes section to know about specific errors codes.
FAQs/Notes
Q1. We(MP) don’t have the concept of PUBLISHED or UNPUBLISHED products, rather, we have LIVE and NON-LIVE for our products. How will it work in UC?
Ans. Even if you have different statuses defined, it can still work in UC as you can do the mapping at your end.
Q2. This API is used to get the count of the published and unpublished products on MP but its base URL has one of the parameters passed as “published”. Is it a discrepancy??
Ans. No. The status in params will used only UNPUBLISHED listings and results can be seen accordingly.