Skip to main content

List Delivery Order​

List Delivery Order with pagination and filter

Available Filter​

Value TypeExample
stringDO-0001
date2010-02-02T20:23:05+07:00
float90.345
Operator TypeDescription
gteGreater Than or Equal
gtGreater Than
lteLower Than or Equal
ltLower Than
eqEqual
Field TypeValue Type
numberstring
shipped_customer.idstring
shipped_customer.namestring
billed_customer.idstring
billed_customer.namestring
customer.idstring
customer.namestring
marketing_user.idnumber
marketing_user.namestring
fleet_task.idstring
fleet_task.numberstring
fleet_task.vehicle.license_platestring
origin_address.idnumber
origin_address.namestring
destination_address.idnumber
destination_address.namestring
expected_pickup_ondate
expected_delivered_ondate
load_countfloat
load_weightfloat
load_volumefloat
status.namestring
vendor.idstring
vendor.namestring
created_ondate
created_bystring
updated_ondate

Example Filter​

Field TypeOperatorValue
numbereqDO-0090
shipped_customer.ideqdbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df
shipped_customer.nameeqRobert
billed_customer.ideqdbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df
billed_customer.nameeqRobert
customer.ideqdbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df
customer.nameeqJNE
marketing_user.ideq12
marketing_user.nameeqRobert
fleet_task.ideqdbffb68c-f5ab-4ec4-83fd-91ca6bc1d1df
fleet_task.numbereqFO-1234
origin_address.nameeqSumatra
destination_address.nameeqSulawesi
expected_pickup_onlt2023-02-02T20:13:05+07:00
expected_delivered_onlt2023-02-02T20:13:05+07:00
load_countlt1324.670
load_weightgte2000
load_volumelte200000
statuseqDraft
created_onlt2023-02-02T20:13:05+07:00
created_byeqAdmin
updated_ongt2022-02-02T20:23:05+07:00

Available Sort​

Operator TypeDescription
ascSmallest to Largest
descLargest to Smallest
FieldDescriptionExample
numberNumber of Delivery Ordernumber asc
shipped_customer.nameName of Shipped Customershipped_customer.name asc
customer.nameName of Customercustomer.name asc
billed_customer.nameName of Billed Customerbilled_customer.name asc
marketing_user.nameName of Marketing Usermarketing_user.name desc
fleet_task.numberNumber of Fleet Taskfleet_task.number desc
fleet_task.vehicle.license_plateLicense Plate of Fleet Task Vehiclefleet_task.number desc
origin_address.nameName of Origin Addressorigin_address.name desc
origin_address.cityName of Origin Cityorigin_address.city desc
destination_address.nameName of Destination Addressdestination_address.name desc
destination_address.cityName of Destination Citydestination_address.city desc
expected_pickup_onExpected Pickup Dateexpected_pickup_on asc
expected_delivered_onExpected Delivery Dateexpected_delivered_on desc
load_countTotal Count of Loadsload_count desc
load_weightTotal Weight of Loadsload_weight desc
load_volumeTotal Volume of Loadsload_volume desc
status.nameName of Statusstatus.name desc
created_onDelivery Order Created Atcreated_on desc
created_byDelivery Order Created Bycreated_by desc
updated_onDelivery Order Updated Onupdated_on desc
Field
number
customer.name
marketing_user.name
fleet_task.number
origin_address.name
origin_address.city
destination_address.name
destination_address.city
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

desc

Schema
    metadata object
    count integer
    page integer
    total_count integer
    total_page integer
    data object
    paginated_result object[]
  • Array [
    • base_uuid string
    parent_uuid string
    reference_number string
    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
    city string
    id integer
    name string
    full_name string
    geolocation string
    geolocation_type string
    destination_address object
    city string
    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[]
  • Array [
    • 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[]
GET /delivery-order

Authorization

name: Authorizationtype: apiKeyin: header

Request

Base URL
https://api-dev.mceasy.com/order/api/web/v1
BearerAuth
filters — query
format — query
limit — query
page — query
search — query
sorts — query
Accept
curl / cURL
curl -L -X GET 'https://api-dev.mceasy.com/order/api/web/v1/delivery-order' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'