GET /v1/external/listings
This API can be used to get a JSON representation of all the product listings in your Shiprocket account, i.e., all the products associated with a specific channel.
No parameters are required to access this API. However, the displayed data can be filtered and sorted using further parameters. If no sort parameter is used, the data is displayed in the default format.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
page | NO | integer | The page number you want to display. | 5 |
per_page | NO | integer | The number of listings to get per page. | 2 |
sort | NO | string | The order to sort by. Value: ASC or DESC | ASC |
sort_by | NO | string | Allows you to choose the value field by which the listings will be sorted. Could be sorted by id, by sku, time created etc. | sku |
filter | NO | string | The data to be matched for the filter value. | 11223344 |
filter_by | NO | string | The filter value field . Can be id, sku, etc. | id |
Servers
- https://apiv2.shiprocket.in
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.