API Docs

Create shipment inbound

Developing

POST

/api/v1/public/shipments/inbound/create

Last modified:2024-11-12 08:30:17

Request

Header Params

Authorization

string

optional

Default:

6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==

Body Params application/json

vendor

integer

required

inbound_address

integer

required

reference_code

string

required

note

string

required

parcels

array [object {5}]

required

reference_code

string

optional

note

string

optional

weight

integer

optional

volume

string

optional

items

array [object {2}]

optional

images

array [object {1}]

required

image_url

string

required

documents

array [object {4}]

required

name

string

optional

quantity

integer

optional

doc_type

string

optional

url

string

optional

additional_services

string

required

config

object

required

auto_approve

integer

required

Example

{
  "vendor": 106,
  "inbound_address": 62,
  "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": "AQUA01",
          "inbound_quantity": 12
        },
        {
          "sku": "230203638",
          "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
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://stg-oms.nandh.vn/api/v1/public/shipments/inbound/create' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
  "vendor": 106,
  "inbound_address": 62,
  "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": "AQUA01",
          "inbound_quantity": 12

        },
        {
          
          "sku": "230203638",
          "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
  }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

🟢200OK

Modified at 2024-11-12 08:30:17

[Retail][Ship by self] Create shipment with item

List shipment inbound