List shipment inbound
Developing
GET
/api/v1/public/shipments/inbound/list
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/shipments/inbound/list?page=1&page_size=5&created_from={{$date.timestamp|addMonths(-1)}}&created_to={{$date.timestamp}}' \
--header 'Authorization;'Response Response Example
{
"status_code": 200,
"data": [
{
"id": 1370,
"country": "VN",
"currency": "VND",
"inbound_code": "NHIV1902934756",
"reference_code": "NHIV1902934756",
"inbound_type": "purchase_order",
"return_tracking_code": null,
"warehouse_provider": "NH_WH_HCM",
"fulfillment_provider": "nandh",
"status": 700,
"status_update_time": 1746602164,
"note": null,
"total_parcel": 1,
"total_sku": 1,
"total_cost": "25999000.00",
"total_inbound_quantity": 1000,
"total_received_quantity": 0,
"total_lost_quantity": 0,
"total_damaged_quantity": 0,
"total_damaged_2_quantity": 0,
"total_damaged_3_quantity": 0,
"is_priority_inbound": false,
"total_weight": 685000,
"is_confirmed_completion": false,
"additional_services": "ULR",
"additional_information": {
"many_sku_in_carton": 0
},
"estimated_delivery_time": 1746809995,
"inspection_time": 0,
"completed_time": 0,
"received_time": 0,
"created_time": 1746600439,
"updated_time": 1746600439,
"user": 190,
"business": 276,
"updated_by": 190,
"created_by": 190,
"inbound_address": 167,
"vendor": {
"id": 123,
"name": "FC APD",
"logo": null,
"vendor_type_display": "Personal"
},
"status_display": "Cancelled",
"inbound_type_display": "Purchase Order",
"status_css": "danger",
"fulfillment_provider_name": "N&H Logistics",
"warehouse_provider_name": "FC HCM",
"can_edit": false,
"can_cancel": false,
"can_update_inbound_item": false,
"can_update_received_qty_item": false,
"can_update_completed": false,
"can_confirm_received": false,
"can_confirm": false,
"can_confirm_shipping": false,
"can_confirm_push_3pf": false,
"additional_services_info": [
{
"value": "ULR",
"label": "Unloading goods - loose cargo",
"description": "",
"is_active": true,
"is_default": true
}
],
"can_edit_documents": false,
"can_confirm_completion": false,
"shipment_inbound_items": [
12182
],
"shipment_inbound_parcel": [
1819
],
"email_updated": "appreview01@nandh.vn",
"email_created": "appreview01@nandh.vn"
},
{
"id": 1363,
"country": "VN",
"currency": "VND",
"inbound_code": "NHIV1902067630",
"reference_code": "PO-89977",
"inbound_type": "purchase_order",
"return_tracking_code": null,
"warehouse_provider": "NH_WH_HCM",
"fulfillment_provider": "nandh",
"status": 700,
"status_update_time": 1746428153,
"note": "Kiểm kỹ ngoại quan",
"total_parcel": 2,
"total_sku": 2,
"total_cost": "26368000.00",
"total_inbound_quantity": 220,
"total_received_quantity": 0,
"total_lost_quantity": 0,
"total_damaged_quantity": 0,
"total_damaged_2_quantity": 0,
"total_damaged_3_quantity": 0,
"is_priority_inbound": false,
"total_weight": 270100,
"is_confirmed_completion": false,
"additional_services": "ULR",
"additional_information": {
"many_sku_in_carton": 0
},
"estimated_delivery_time": 1746637146,
"inspection_time": 0,
"completed_time": 0,
"received_time": 0,
"created_time": 1746428094,
"updated_time": 1746428094,
"user": 190,
"business": 276,
"updated_by": 190,
"created_by": 190,
"inbound_address": 167,
"vendor": {
"id": 123,
"name": "FC APD",
"logo": null,
"vendor_type_display": "Personal"
},
"status_display": "Cancelled",
"inbound_type_display": "Purchase Order",
"status_css": "danger",
"fulfillment_provider_name": "N&H Logistics",
"warehouse_provider_name": "FC HCM",
"can_edit": false,
"can_cancel": false,
"can_update_inbound_item": false,
"can_update_received_qty_item": false,
"can_update_completed": false,
"can_confirm_received": false,
"can_confirm": false,
"can_confirm_shipping": false,
"can_confirm_push_3pf": false,
"additional_services_info": [
{
"value": "ULR",
"label": "Unloading goods - loose cargo",
"description": "",
"is_active": true,
"is_default": true
}
],
"can_edit_documents": false,
"can_confirm_completion": false,
"shipment_inbound_items": [
12173,
12172
],
"shipment_inbound_parcel": [
1811,
1812
],
"email_updated": "appreview01@nandh.vn",
"email_created": "appreview01@nandh.vn"
}
],
"error": false,
"error_code": null,
"log_id": null,
"messages": "",
"total": 2
}Request
Query Params
page
integer
required
Example:
1
page_size
integer
required
Example:
5
created_from
array[string]
required
Example:
["{{$date.timestamp|addMonths(-1)}}"]
created_to
array[string]
required
Example:
["{{$date.timestamp}}"]
Header Params
Authorization
string
required
Default:
{{your_api_key_here}}