API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Shipment Inbound
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
      POST
    • Cancel shipment inbound
      PATCH
    • List shipment inbound
      GET
    • Shipment inbound detail
      GET
    • Shipment inbound items
      GET
  • Order Return
    • List return order
    • Return order detail
    • Create return order
    • Cancel Return Order
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Shipment Inbound

Shipment inbound detail

Developing
GET
/api/v1/public/shipments/inbound/detail/{{inbound_code}}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/shipments/inbound/detail/{{inbound_code}}' \
--header 'Authorization;'
Response Response Example
200 - OK - Success
{
  "status_code": 200,
  "data": {
    "id": 1128,
    "country": "VN",
    "currency": "VND",
    "inbound_code": "NHIV19013662",
    "reference_code": "DirectX 12 Ultimate",
    "inbound_type": "purchase_order",
    "return_tracking_code": null,
    "warehouse_provider": "NH_WH_HCM",
    "fulfillment_provider": "nandh",
    "status": 500,
    "status_update_time": 1741690801,
    "note": "Kiểm tra số lượng kiện hàng được giao đến FC",
    "total_parcel": 2,
    "total_sku": 1,
    "total_cost": "5199800000.00",
    "total_inbound_quantity": 200,
    "total_received_quantity": 60,
    "total_lost_quantity": 120,
    "total_damaged_quantity": 20,
    "total_damaged_2_quantity": 0,
    "total_damaged_3_quantity": 0,
    "is_priority_inbound": false,
    "total_weight": 137000,
    "is_confirmed_completion": false,
    "additional_services": "ULG",
    "additional_information": {
      "many_sku_in_carton": 0
    },
    "estimated_delivery_time": 1741885148,
    "inspection_time": 1741684726,
    "completed_time": 1741689601,
    "received_time": 1741683900,
    "created_time": 1741682674,
    "updated_time": 1741682674,
    "user": 190,
    "business": 276,
    "updated_by": 190,
    "created_by": 190,
    "inbound_address": {
      "id": 167,
      "pickup_name": "BTH",
      "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 Logistics",
      "warehouse_provider_name": "FC HCM",
      "is_fulfill_self": false,
      "is_fulfill_3pf": true
    },
    "vendor": {
      "id": 123,
      "name": "FC APD",
      "logo": null,
      "vendor_type_display": "Personal"
    },
    "status_display": "Completed",
    "inbound_type_display": "Purchase Order",
    "status_css": "success",
    "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": [],
    "can_edit_documents": false,
    "can_confirm_completion": false,
    "shipment_inbound_items": [
      11750,
      11749
    ],
    "shipment_inbound_parcel": [
      1489,
      1490
    ],
    "shipment_inbound_images": [
      {
        "id": 2121,
        "image_url": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/DOCUMENT_SCAN_0_20250311_1604241548604043434389224.jpg",
        "video_url": null,
        "priority": 0,
        "created_time": 1741683901,
        "updated_time": 1741683901,
        "shipment_inbound": 1128,
        "shipment_inbound_inspection": null
      },
      {
        "id": 2122,
        "image_url": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/rn_image_picker_lib_temp_0734229c-5fe8-413a-83a9-ac5e9995c9a8.jpg",
        "video_url": null,
        "priority": 0,
        "created_time": 1741683901,
        "updated_time": 1741683901,
        "shipment_inbound": 1128,
        "shipment_inbound_inspection": null
      },
      {
        "id": 2123,
        "image_url": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/rn_image_picker_lib_temp_72990e53-9894-404e-9cba-f1a98e4a9548.jpg",
        "video_url": null,
        "priority": 0,
        "created_time": 1741683901,
        "updated_time": 1741683901,
        "shipment_inbound": 1128,
        "shipment_inbound_inspection": null
      }
    ],
    "shipment_inbound_extend": {
      "id": 998,
      "driver_name": "ThuongBth",
      "driver_phone": "096155",
      "license_plate": "096155",
      "received_by": "thuong.bth@nandhlogistics.vn"
    },
    "email_updated": "appreview01@nandh.vn",
    "email_created": "appreview01@nandh.vn",
    "total_cbm": 0.36,
    "total_fees": 0,
    "total_discounts": 0,
    "total_paid": 0
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Request

Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
data
object 
optional
id
integer 
optional
country
string 
optional
currency
string 
optional
inbound_code
string 
optional
reference_code
string 
optional
inbound_type
string 
optional
return_tracking_code
string 
optional
warehouse_provider
string 
optional
fulfillment_provider
string 
optional
status
integer 
optional
status_update_time
integer 
optional
note
string 
optional
total_parcel
integer 
optional
total_sku
integer 
optional
total_cost
string 
optional
total_inbound_quantity
integer 
optional
total_received_quantity
integer 
optional
total_lost_quantity
integer 
optional
total_damaged_quantity
integer 
optional
total_damaged_2_quantity
integer 
optional
total_damaged_3_quantity
integer 
optional
is_priority_inbound
boolean 
optional
total_weight
integer 
optional
is_confirmed_completion
boolean 
optional
additional_services
string 
optional
additional_information
object 
optional
estimated_delivery_time
integer 
optional
inspection_time
integer 
optional
completed_time
integer 
optional
received_time
integer 
optional
created_time
integer 
optional
updated_time
integer 
optional
user
integer 
optional
business
integer 
optional
updated_by
integer 
optional
created_by
integer 
optional
inbound_address
object 
optional
vendor
object 
optional
status_display
string 
optional
inbound_type_display
string 
optional
status_css
string 
optional
fulfillment_provider_name
string 
optional
warehouse_provider_name
string 
optional
can_edit
boolean 
optional
can_cancel
boolean 
required
can_update_inbound_item
boolean 
required
can_update_received_qty_item
boolean 
required
can_update_completed
boolean 
required
can_confirm_received
boolean 
required
can_confirm
boolean 
required
can_confirm_shipping
boolean 
required
can_confirm_push_3pf
boolean 
required
additional_services_info
array[string]
required
can_edit_documents
boolean 
required
can_confirm_completion
boolean 
required
shipment_inbound_items
array[integer]
required
shipment_inbound_parcel
array[integer]
required
shipment_inbound_images
array [object {8}] 
required
shipment_inbound_extend
object 
required
email_updated
string 
required
email_created
string 
required
total_cbm
number 
required
total_fees
integer 
required
total_discounts
integer 
required
total_paid
integer 
required
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
🟢200OK
Previous
List shipment inbound
Next
Shipment inbound items
Built with