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

Create shipment inbound

Developing
POST
/api/v1/public/shipments/inbound/create
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/public/shipments/inbound/create' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "vendor": 106,
  "inbound_address": {{pickup_id}},
  "reference_code": "PA0001",
  "note": "Noi dung ghi chu shipment inbound",
  "parcels": [
    {
      "reference_code": "PA0001",
      "note": "Noi dung ghi chu",
      "weight": 1000,
      "volume": "10x20x11",
      "items": [
        {
          
          "sku": "VinamilkHappyStar220ml",
          "inbound_quantity": 12

        },
        {
          
          "sku": "250204067",
          "inbound_quantity": 12
        }
      ]
    }
  ],
  "images": [
    {
      "image_url": "https://cf.shopee.vn/file/b0e52a4fbd93984a86d0a13c3b84144f"
    },
    {
      "image_url": "https://cf.shopee.vn/file/72ad6b5915844a189a163ca319494aad"
    },
    {
      "image_url": "https://cf.shopee.vn/file/adc7248ada379446553ace30f9899fdc"
    }
  ],
  "documents": [
    {
      "name": "file test",
      "quantity": 2,
      "doc_type": "3",
      "url": "google.com"
    }
  ],
  "additional_services": "CIG,ULG,RGO",
  "config": {
    "auto_approve": 1
  }
}'
Response Response Example
200 - Success
{
  "status_code": 200,
  "data": {
    "shipment_inbound_id": 1411,
    "inbound_code": "NHIV1901916370",
    "total_parcel": 1
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Request

Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}
Body Params application/json
vendor
integer 
required
inbound_address
integer 
required
reference_code
string 
optional
note
string 
optional
parcels
array [object {5}] 
required
reference_code
string 
required
note
string 
optional
weight
integer 
required
volume
string 
required
items
array [object {2}] 
required
images
array [object {1}] 
optional
image_url
string 
optional
documents
array [object {4}] 
optional
name
string 
optional
quantity
integer 
optional
doc_type
string 
optional
url
string 
optional
additional_services
string 
optional
config
object 
required
auto_approve
integer 
required
Examples

Responses

🟢200Success
application/json
Body
status_code
integer 
optional
data
object 
optional
shipment_inbound_id
integer 
optional
inbound_code
string 
optional
total_parcel
integer 
optional
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
🟠400Bad Request
Previous
List shipment of order
Next
Cancel shipment inbound
Built with