List Delivery Order
List DeliveryOrder with pagination and filter
Available Filter
Value Type | Example |
---|---|
string | DO-0001 |
date | 2010-02-02T20:23:05+07:00 |
float | 90.345 |
Operator Type | Description |
---|---|
gte | Greater Than or Equal |
gt | Greater Than |
lte | Lower Than or Equal |
lt | Lower Than |
eq | Equal |
Field Type | Value Type |
---|---|
number | string |
shipped_customer.id | string |
shipped_customer.name | string |
billed_customer.id | string |
billed_customer.name | string |
customer.id | string |
customer.name | string |
marketing_user.id | number |
marketing_user.name | string |
fleet_task.id | string |
fleet_task.number | string |
fleet_task.vehicle.license_plate | string |
origin_address.id | number |
origin_address.name | string |
destination_address.id | number |
destination_address.name | string |
expected_pickup_on | date |
expected_delivered_on | date |
load_count | float |
load_weight | float |
load_volume | float |
status.name | string |
vendor.id | string |
vendor.name | string |
created_on | date |
created_by | string |
updated_on | date |
Example Filter
Field Type | Operator | Value |
---|---|---|
number | eq | DO-0090 |
shipped_customer.id | eq | dbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df |
shipped_customer.name | eq | Robert |
billed_customer.id | eq | dbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df |
billed_customer.name | eq | Robert |
customer.id | eq | dbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df |
customer.name | eq | JNE |
marketing_user.id | eq | 12 |
marketing_user.name | eq | Robert |
fleet_task.id | eq | dbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df |
fleet_task.number | eq | FO-1234 |
origin_address.name | eq | Sumatra |
destination_address.name | eq | Sulawesi |
expected_pickup_on | lt | 2023-02-02T20:13:05+07:00 |
expected_delivered_on | lt | 2023-02-02T20:13:05+07:00 |
load_count | lt | 1324.670 |
load_weight | gte | 2000 |
load_volume | lte | 200000 |
status | eq | Draft |
created_on | lt | 2023-02-02T20:13:05+07:00 |
created_by | eq | Admin |
updated_on | gt | 2022-02-02T20:23:05+07:00 |
Available Sort
Operator Type | Description |
---|---|
asc | Smallest to Largest |
desc | Largest to Smallest |
Field | Description | Example |
---|---|---|
number | Number of Delivery Order | number asc |
shipped_customer.name | Name of Shipped Customer | shipped_customer.name asc |
customer.name | Name of Customer | customer.name asc |
billed_customer.name | Name of Billed Customer | billed_customer.name asc |
marketing_user.name | Name of Marketing User | marketing_user.name desc |
fleet_task.number | Number of Fleet Task | fleet_task.number desc |
fleet_task.vehicle.license_plate | License Plate of Fleet Task Vehicle | fleet_task.number desc |
origin_address.name | Name of Origin Address | origin_address.name desc |
destination_address.name | Name of Destination Address | destination_address.name desc |
expected_pickup_on | Expected Pickup Date | expected_pickup_on asc |
expected_delivered_on | Expected Delivery Date | expected_delivered_on desc |
load_count | Total Count of Loads | load_count desc |
load_weight | Total Weight of Loads | load_weight desc |
load_volume | Total Volume of Loads | load_volume desc |
status.name | Name of Status | status.name desc |
created_on | Delivery Order Created At | created_on desc |
created_by | Delivery Order Created By | created_by desc |
updated_on | Delivery Order Updated On | updated_on desc |
Available Search
Field |
---|
number |
customer.name |
marketing_user.name |
fleet_task.number |
origin_address.name |
destination_address.name |
status |
created_by |
shipped_customer.name |
billed_customer.name |
fleet_task.vehicle.license_plate |
Query Parameters
filters string[]
format string
Possible values: [excel
, json
]
limit integer
page integer
search string
sorts string[]
Responses
- 200
- 400
desc
application/json
application/pdf
Schema
Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
metadata object
count integer
page integer
total_count integer
total_page integer
data object
paginated_result object[]
id string
number string
is_late boolean
customer object
! Attention: Remove this field soon as the breaking shipped&billed_customer go to production
id string
name string
shipped_customer object
id string
name string
billed_customer object
id string
name string
marketing_user object
id integer
name string
fleet_task object
id string
number string
driver_user object
id integer
name string
vehicle object
id integer
license_plate string
origin_address object
id integer
name string
full_name string
geolocation string
geolocation_type string
destination_address object
id integer
name string
full_name string
geolocation string
geolocation_type string
expected_pickup_on string
expected_delivered_on string
vendor object
id string
name string
status
load_count integer
load_weight number
load_volume number
created_on string
created_by string
canceled_reason string
rescheduled_reason string
shipment_number string
external_reference_number string
user_definition_fields object[]
key string
Possible values: [udf1
, udf2
, udf3
, udf4
, udf5
, udf6
, udf7
, udf8
, udf9
, udf10
, udf11
, udf12
, udf13
, udf14
, udf15
, udf16
, udf17
, udf18
, udf19
, udf20
]
name string
type string
Possible values: [NUMBER
, TEXT
, BOOL
, DATE
]
value
timestamp object
picked_on string
delivered_on string
ids string[]
{
"metadata": {
"count": 0,
"page": 0,
"total_count": 0,
"total_page": 0
},
"data": {
"paginated_result": [
{
"id": "string",
"number": "string",
"is_late": true,
"customer": {
"id": "string",
"name": "string"
},
"shipped_customer": {
"id": "string",
"name": "string"
},
"billed_customer": {
"id": "string",
"name": "string"
},
"marketing_user": {
"id": 0,
"name": "string"
},
"fleet_task": {
"id": "string",
"number": "string",
"driver_user": {
"id": 0,
"name": "string"
},
"vehicle": {
"id": 0,
"license_plate": "string"
}
},
"origin_address": {
"id": 0,
"name": "string",
"full_name": "string",
"geolocation": "string",
"geolocation_type": "string"
},
"destination_address": {
"id": 0,
"name": "string",
"full_name": "string",
"geolocation": "string",
"geolocation_type": "string"
},
"expected_pickup_on": "string",
"expected_delivered_on": "string",
"vendor": {
"id": "string",
"name": "string"
},
"load_count": 0,
"load_weight": 0,
"load_volume": 0,
"created_on": "string",
"created_by": "string",
"canceled_reason": "string",
"rescheduled_reason": "string",
"shipment_number": "string",
"external_reference_number": "string",
"user_definition_fields": [
{
"key": "udf1",
"name": "string",
"type": "NUMBER",
"value": {}
}
],
"timestamp": {
"picked_on": "string",
"delivered_on": "string"
}
}
],
"ids": [
"string"
]
}
}
Schema
Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
metadata object
count integer
page integer
total_count integer
total_page integer
data object
paginated_result object[]
id string
number string
is_late boolean
customer object
! Attention: Remove this field soon as the breaking shipped&billed_customer go to production
id string
name string
shipped_customer object
id string
name string
billed_customer object
id string
name string
marketing_user object
id integer
name string
fleet_task object
id string
number string
driver_user object
id integer
name string
vehicle object
id integer
license_plate string
origin_address object
id integer
name string
full_name string
geolocation string
geolocation_type string
destination_address object
id integer
name string
full_name string
geolocation string
geolocation_type string
expected_pickup_on string
expected_delivered_on string
vendor object
id string
name string
status
load_count integer
load_weight number
load_volume number
created_on string
created_by string
canceled_reason string
rescheduled_reason string
shipment_number string
external_reference_number string
user_definition_fields object[]
key string
Possible values: [udf1
, udf2
, udf3
, udf4
, udf5
, udf6
, udf7
, udf8
, udf9
, udf10
, udf11
, udf12
, udf13
, udf14
, udf15
, udf16
, udf17
, udf18
, udf19
, udf20
]
name string
type string
Possible values: [NUMBER
, TEXT
, BOOL
, DATE
]
value
timestamp object
picked_on string
delivered_on string
ids string[]
{
"metadata": {
"count": 0,
"page": 0,
"total_count": 0,
"total_page": 0
},
"data": {
"paginated_result": [
{
"id": "string",
"number": "string",
"is_late": true,
"customer": {
"id": "string",
"name": "string"
},
"shipped_customer": {
"id": "string",
"name": "string"
},
"billed_customer": {
"id": "string",
"name": "string"
},
"marketing_user": {
"id": 0,
"name": "string"
},
"fleet_task": {
"id": "string",
"number": "string",
"driver_user": {
"id": 0,
"name": "string"
},
"vehicle": {
"id": 0,
"license_plate": "string"
}
},
"origin_address": {
"id": 0,
"name": "string",
"full_name": "string",
"geolocation": "string",
"geolocation_type": "string"
},
"destination_address": {
"id": 0,
"name": "string",
"full_name": "string",
"geolocation": "string",
"geolocation_type": "string"
},
"expected_pickup_on": "string",
"expected_delivered_on": "string",
"vendor": {
"id": "string",
"name": "string"
},
"load_count": 0,
"load_weight": 0,
"load_volume": 0,
"created_on": "string",
"created_by": "string",
"canceled_reason": "string",
"rescheduled_reason": "string",
"shipment_number": "string",
"external_reference_number": "string",
"user_definition_fields": [
{
"key": "udf1",
"name": "string",
"type": "NUMBER",
"value": {}
}
],
"timestamp": {
"picked_on": "string",
"delivered_on": "string"
}
}
],
"ids": [
"string"
]
}
}
Bad Request
application/json
application/pdf
Schema
Example (from schema)
Schema
errors
message string
{
"errors": {},
"message": "string"
}
Schema
Example (from schema)
Schema
errors
message string
{
"errors": {},
"message": "string"
}
Loading...