Get All Orders

POST

/open/orders/getAll

Get All Orders

This API will get all orders.

Request Body Parameters:

Name	Type	Description
api_key	string	Your API-key
user_id	number(optional)	Your userid
marketplace_user_id	number(required)	Your marketplace user id
order_status	number	List of statuses : Pending : 9 Ordered : 10 Dispatched : 12 Delivered : 13 Cancelled : 15
sortCol	number	If sort column equals to 1 then it will sort according to order Id , if it is equals to 3 then it will sort according to job delivery datetime
sortDir	any	Sort direction is descending
start	number	Start here (pagination columns)
length	number	Length (pagination columns)
start_date	string	Start date for filtering results
end_date	string	End date for filtering results.

Request

Body Params application/json

Example

{
    "api_key"               : {{apikey}} ,
    "user_id"               : 569866 ,
    "marketplace_user_id"   : 25632 ,
    "order_status"          : 13 ,
    "sortCol"               : 3 ,
    "sortDir"               : "desc" ,
    "start"                 : 2 ,
    "length"                : 100 ,
    "start_date"            : "2021-05-06T15:54:00Z" ,
    "end_date"              : "2021-04-06T15:54:00Z"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.yelo.red/open/orders/getAll' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key"               : {{apikey}} ,
    "user_id"               : 569866 ,
    "marketplace_user_id"   : 25632 ,
    "order_status"          : 13 ,
    "sortCol"               : 3 ,
    "sortDir"               : "desc" ,
    "start"                 : 2 ,
    "length"                : 100 ,
    "start_date"            : "2021-05-06T15:54:00Z" ,
    "end_date"              : "2021-04-06T15:54:00Z"
}'

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2024-04-17 07:11:33

Order review

Get Order Details

Get All Orders

Get All Orders#

This API will get all orders.#

Request

Request Code Samples

Responses

Get All Orders

This API will get all orders.