API Docs
Home
References
  • Product API
  • Product Inventory API
Home
References
  • Product API
  • Product Inventory API
  1. API
  2. Shipment Inbound
  • Overview
  • Getting Started
  • Common Errors
  • API
    • Config
      • List Pickup Address
      • List Box Dimension
      • List vendor
      • List store
    • Product
      • Options
        • List category
        • List brand
      • Create Single Product
      • List product
      • Product detail
      • Create Product From Product Inventory
    • Product Inventory
      • Options
        • List Outbound Strategy
        • List Product Type
        • List Material
        • List Storage Method
      • List product inventory
      • Product inventory detail
      • Create single inventory product
    • Order
      • Shipping Service
        • Preview shipping prices
          • List available courier
          • List shipping service
        • List available courier from order
        • List shipping service of courier
      • Create order B2C
      • List order
      • Order detail
      • Cancel order
    • Shipment
      • Create shipment auto
      • Cancel shipment
      • [Retail][Ship by self] Create shipment with item
    • Shipment Inbound
      • Create shipment inbound
        POST
      • List shipment inbound
        GET
      • Shipment inbound detail
        GET
      • Shipment inbound items
        GET
    • Courier
      • List courier service integrated
      • List courier operate
      • List courier integrated
    • Address Directory
      • Province
      • District
      • Ward
  • Status
    • SHIPMENT INBOUND
    • ORDER
    • SHIPMENT
    • RETURN
  • Webhooks
    • WebHook connection required
    • HOOK EVENT ORDER CREATED
    • HOOK EVENT ORDER UPDATE STATUS
    • HOOK EVENT SHIPMENT CREATED
    • HOOK EVENT SHIPMENT UPDATE STATUS
    • HOOK EVENT INBOUND UPDATE STATUS
    • HOOK EVENT INBOUND CREATED
    • HOOK EVENT STOCK UPDATE
  1. API
  2. Shipment Inbound

Shipment inbound detail

Developing
GET
/api/v1/public/shipments/inbound/detail/{{inbound_code}}
Last modified:2024-08-02 03:32:07

Request

Header Params
Authorization
string 
optional
Default:
6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://stg-oms.nandh.vn/api/v1/public/shipments/inbound/detail/{{inbound_code}}' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ=='

Responses

🟢200OK
application/json
Body
status_code
integer 
required
data
object 
required
id
integer 
required
country
string 
required
currency
string 
required
inbound_code
string 
required
reference_code
string 
required
inbound_type
string 
required
return_tracking_code
null 
required
warehouse_provider
string 
required
fulfillment_provider
string 
required
status
integer 
required
status_update_time
integer 
required
note
null 
required
total_parcel
integer 
required
total_sku
integer 
required
total_cost
string 
required
total_inbound_quantity
integer 
required
total_received_quantity
integer 
required
total_lost_quantity
integer 
required
total_damaged_quantity
integer 
required
is_priority_inbound
boolean 
required
total_weight
integer 
required
additional_services
string 
required
additional_information
object 
required
estimated_delivery_time
integer 
required
inspection_time
integer 
required
completed_time
integer 
required
received_time
integer 
required
created_time
integer 
required
updated_time
integer 
required
user
integer 
required
business
integer 
required
updated_by
integer 
required
created_by
integer 
required
inbound_address
object 
required
vendor
object 
required
status_display
string 
required
inbound_type_display
string 
required
status_css
string 
required
fulfillment_provider_name
string 
required
warehouse_provider_name
null 
required
can_edit
boolean 
required
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
required
shipment_inbound_items
array[integer]
required
shipment_inbound_parcel
array[integer]
required
shipment_inbound_images
array [object {5}] 
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 
required
error_code
null 
required
log_id
null 
required
messages
string 
required
total
integer 
required
Example
{
  "status_code": 200,
  "data": {
    "id": 507,
    "country": "VN",
    "currency": "VND",
    "inbound_code": "NHIV8584049",
    "reference_code": "NHIV8584049",
    "inbound_type": "purchase_order",
    "return_tracking_code": null,
    "warehouse_provider": "NH_WH_BD",
    "fulfillment_provider": "nandh",
    "status": 500,
    "status_update_time": 1721106001,
    "note": null,
    "total_parcel": 2,
    "total_sku": 2,
    "total_cost": "200000.00",
    "total_inbound_quantity": 200,
    "total_received_quantity": 200,
    "total_lost_quantity": 0,
    "total_damaged_quantity": 0,
    "is_priority_inbound": false,
    "total_weight": 29900,
    "additional_services": "",
    "additional_information": {
      "many_sku_in_carton": 0
    },
    "estimated_delivery_time": 1721321998,
    "inspection_time": 1721104173,
    "completed_time": 1721104801,
    "received_time": 1721104067,
    "created_time": 1721103033,
    "updated_time": 1721103033,
    "user": 85,
    "business": 143,
    "updated_by": 85,
    "created_by": 85,
    "inbound_address": {
      "id": 65,
      "pickup_name": "KHO BD",
      "contact_name": "QL Kho BD",
      "phone": "0348948651",
      "address": "số 1",
      "pickup_code": "PK100065",
      "fulfillment_provider_name": "N&H Logistics",
      "warehouse_provider_name": "FC BD",
      "is_fulfill_self": false,
      "is_fulfill_3pf": true
    },
    "vendor": {
      "id": 53,
      "name": "Xưởng gỗ gia dung Hoàng Hà",
      "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 BD",
    "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": [],
    "shipment_inbound_items": [
      10221,
      10220
    ],
    "shipment_inbound_parcel": [
      791,
      792
    ],
    "shipment_inbound_images": [
      {
        "id": 788,
        "image_url": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/images/rn_image_picker_lib_temp_8688dcc0-09ee-4816-bc40-1ebece7e3ec0.jpg",
        "priority": 0,
        "created_time": 1721104068,
        "updated_time": 1721104068
      },
      {
        "id": 789,
        "image_url": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/images/rn_image_picker_lib_temp_096e31a4-a1ab-4dd5-b4a8-c814b932d38a.jpg",
        "priority": 0,
        "created_time": 1721104068,
        "updated_time": 1721104068
      },
      {
        "id": 790,
        "image_url": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/images/rn_image_picker_lib_temp_b9a5cd6b-4462-4c20-9fef-e4f6796bf853.jpg",
        "priority": 0,
        "created_time": 1721104068,
        "updated_time": 1721104068
      }
    ],
    "shipment_inbound_extend": {
      "id": 414,
      "driver_name": "ghJ",
      "driver_phone": "64979",
      "license_plate": "gahsh",
      "received_by": "nvln@nandh.vn"
    },
    "email_updated": "adv@nandh.vn",
    "email_created": "adv@nandh.vn",
    "total_cbm": 0.42,
    "total_fees": 0,
    "total_discounts": 0,
    "total_paid": 0
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}
Modified at 2024-08-02 03:32:07
Previous
List shipment inbound
Next
Shipment inbound items
Built with