Skip to main content
GET
List all shipments

Authorizations

Authorization
string
header
required

Access token

Query Parameters

page
integer
default:1

Page number, starting at 1. Non-integer values and values below 1 return 400.

Required range: x >= 1
limit
integer
default:25

Results per page. Values outside 1–100 are clamped to that range. Non-integer input returns 400.

Required range: 1 <= x <= 100
filters
string

JSON object

Example:

"{\"condition\":\"AND\",\"filters\":[{\"type\":\"data\",\"field\":\"status\",\"operator\":\"equals\",\"value\":\"success\"}]}"

sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"} json string in format {'field_name':'asc', 'other_field_name':'desc', ...}

search keyword

awb_no
string

Filter by awb no.

base_shipment_number
string

Filter by base shipment number.

cancellation_reason
string

Filter by cancellation reason.

cancelled_by
string

Filter by cancelled by.

coupon_discount_amount
number

Filter by coupon discount amount.

courier_aggregator_name
string

Filter by courier aggregator name.

courier_aggregator_order_id
string

Filter by courier aggregator order id.

courier_aggregator_reference_no
string

Filter by courier aggregator reference no.

courier_company_id
string

Filter by courier company id.

courier_company_name
string

Filter by courier company name.

created_at
string

Filter by created at.

davai_shipment_id
number

Filter by davai shipment id.

delivered_date
string

Filter by delivered date.

delivery_lead_time
number

Filter by delivery lead time.

delivery_time_gap
number

Filter by delivery time gap.

estimated_delivery_date
string

Filter by estimated delivery date.

eta_delivery
string

Filter by eta delivery.

fulfillment_type
string

Filter by fulfillment type.

grand_total
number

Filter by grand total.

invoice_url
string

Filter by invoice url.

items_weight
number

Filter by items weight.

last_tracking_time
string

Filter by last tracking time.

loyalty_point_redeemed
number

Filter by loyalty point redeemed.

manual_shipping_charges
number

Filter by manual shipping charges.

marketplace_id
string

Filter by marketplace id.

modified_at
string

Filter by modified at.

order
integer

Filter by order.

out_for_delivery_date
string

Filter by out for delivery date.

packing_bin_weight
number

Filter by packing bin weight.

packing_details_data
string

Filter by packing details data.

packing_option
string

Filter by packing option.

promised_delivery_date
string

Filter by promised delivery date.

promotion_discount_amount
number

Filter by promotion discount amount.

reference_number
string

Filter by reference number.

replacement_shipment_number
string

Filter by replacement shipment number.

return_window
string

Filter by return window.

returned_date
string

Filter by returned date.

revised_shipping_date
string

Filter by revised shipping date.

seller_id
string

Filter by seller id.

seller_reference_no
string

Filter by seller reference no.

seller_response_data
string

Filter by seller response data.

shipment_number
string

Filter by shipment number.

shipped_date
string

Filter by shipped date.

shipping_amount
number

Filter by shipping amount.

shipping_amount_including_tax
number

Filter by shipping amount including tax.

shipping_discount_amount
number

Filter by shipping discount amount.

shipping_estimated_cost
number

Filter by shipping estimated cost.

shipping_label_url
string

Filter by shipping label url.

shipping_option
string

Filter by shipping option.

shipping_provider_id
string

Filter by shipping provider id.

shipping_tax_amount
number

Filter by shipping tax amount.

shipping_tax_rate
number

Filter by shipping tax rate.

shipping_tax_type
string

Filter by shipping tax type.

slo_status
string

Filter by slo status.

status
string

Filter by one or more shipment statuses, separated by commas.

store_id
string

Filter by store id.

sub_total
number

Filter by sub total.

sub_total_including_tax
number

Filter by sub total including tax.

total_boxes
number

Filter by total boxes.

total_weight
number

Filter by total weight.

track_status
boolean

Filter by track status.

tracking_url
string

Filter by tracking url.

warehouse_id
string

Filter by warehouse id.

warehouse_name
string

Filter by warehouse name.

Response

OK

message
string
required
success
boolean
required
content
object
required