List shipment

GET

/api/v1/public/shipments/list

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/v1/public/shipments/list?page=1&page_size=10&created_from={{$date.timestamp|addMonths(-1)}}&created_to={{$date.timestamp}}&status_group=&type_filter&keyword' \
--header 'Authorization: {{your_api_key_here}}'

Response Example

{
    "status_code": 200,
    "data": {
        "shipments": [
            {
                "id": 14143,
                "country": "VN",
                "currency": "VND",
                "platform": "retail",
                "group_platform": "retail",
                "sorting_code": null,
                "tracking_code": "NHSVC1905067383",
                "partner_tracking_code": "LC2609202651",
                "note": "Giao hàng giờ hành chính",
                "packaging_note": "Ghi chú đóng gói",
                "status": 217,
                "status_update_time": 1758884716.0,
                "tax_paid_by": "sender",
                "fee_paid_by": "sender",
                "volume": "0x0x0",
                "protective_packaging": true,
                "inspection": false,
                "use_insurance": false,
                "can_check_content": true,
                "order_shipping_provider": "normal",
                "shipping_provider": "self",
                "fulfillment_provider": "nandh",
                "cod_amount": "123000.00",
                "courier_tracking_code": "LC2609202651",
                "fulfill_type": 2,
                "warehouse_provider": "NH_WH_HCM",
                "is_ship_now": false,
                "priority_fulfillment_3pf": false,
                "partner_created_time": 1758884336.0,
                "partner_information": {},
                "label_code": "68d672a5aa853e24d3385020",
                "estimated_departure_time": 0.0,
                "push_3pl_success": true,
                "push_3pf_success": true,
                "push_rts_success": false,
                "push_fulfill_pack_success": false,
                "additional_services": "",
                "is_seller_own_fleet": true,
                "label_url": null,
                "invoice_code": null,
                "invoice_url": null,
                "confirmed_sla_time": 0.0,
                "sla_time": 0.0,
                "shipped_sla_time": 0.0,
                "fast_fulfill_sla_time": 0.0,
                "fulfilled_time": 0.0,
                "shipped_time": 0.0,
                "delivered_time": 0.0,
                "returned_time": 0.0,
                "completed_time": 0.0,
                "inspection_time": 0.0,
                "received_time": 0.0,
                "created_time": 1758884513.0,
                "updated_time": 1758884513.0,
                "user": 190,
                "business": 276,
                "updated_by": 190,
                "created_by": 190,
                "pickup_address": {
                    "id": 167,
                    "pickup_name": "FC HCM",
                    "contact_name": "SHOP TEST IT",
                    "phone": "0961557476",
                    "address": "Đường An Phú Đông 13, An Phú Đông, Quận 12, Thành phố Hồ Chí Minh",
                    "pickup_code": "PK100167",
                    "fulfillment_provider_name": "N&H Fulfillment",
                    "warehouse_provider_name": "FC APD",
                    "is_fulfill_self": false,
                    "is_fulfill_3pf": true
                },
                "store": {
                    "id": 336,
                    "name": "Hary Trần",
                    "logo": null,
                    "platform": "retail",
                    "is_active": true,
                    "currency": "VND",
                    "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
                },
                "order": {
                    "id": 24011,
                    "currency": "VND",
                    "platform": "retail",
                    "group_platform": "retail",
                    "tracking_code": "NHOV1901943701",
                    "partner_tracking_code": "LC2609202651",
                    "status": 400,
                    "status_update_time": 1758884512.0,
                    "pickup_address_id": 167,
                    "created_time": 1758884336.0,
                    "updated_time": 1758884336.0,
                    "status_display": "Created shipment",
                    "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png",
                    "status_css": "info",
                    "validate_order_type": [
                        "courier_ship",
                        "pickup_address",
                        "receiver"
                    ],
                    "can_view_channel_order_detail": false,
                    "can_approve": false
                },
                "courier_integration": 212,
                "courier": {
                    "id": 16,
                    "prefix": "sof",
                    "name": "Tự Vận Chuyển",
                    "description": "Hình thức người bán tự vận chuyển cho đơn hàng của mình. Tự quản lý quá trình vận chuyển và giao hàng đối với những đơn hàng

Cancel shipment

Shipment detail