GET /v1/external/orders
This API call will display a list of all created and available orders in your Shiprocket account. The product and shipment details are displayed as sub-arrays within each order detail.
You can also sort and filter the data according to your needs by passing the optional parameters. Not passing anything will display the data in the default format.
You can also fetch the data based on the order update date. PFB the validations:
1. if updated_to => passed and updated_from not passed =>, error will come => Please send update_from date along with update_to date
2. if updated_from => passed and updated_to => paased => and from-to > 30 then error => Difference between updated_from and update_to date should not be greater than 30 days.
3. if updated_From < 30 then error => Updated_from date should not be less than 30 days from current date
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
page | NO | integer | The page number to display. | 5 |
per_page | NO | integer | The number of entries per page. | 5 |
sort | NO | string | Sort conditions: ASC or DESC | ASC |
sort_by | NO | string | The Field to sort by: id or status | id |
to | NO | string | The end date. | 2018-07-24 |
from | NO | string | The start date. | 2019-07-24 |
filter_by | NO | string | Field to filter by. | status, payment_method, delivery_country, channel_order_id |
filter | NO | string | Value of the field | |
search | NO | string | Search for AWB or by Channel order_id (order id specified by you). | 224477 |
pickup_location | NO | string | Search Orders on the basis of pickup location. | xyz |
channel_id | NO | integer | Channel ID Returned in Get Integrated Channels API | 123 |
fbs | NO | integer | Use this filter if you want to view and filter the SRF orders | 0 or 1 |
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.