API Docs

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

Developing

POST

/api/v1/public/shipments/create

Last modified:2025-02-24 09:35:00

Request

Header Params

Authorization

string

optional

Default:

6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==

Body Params application/json

order_tracking_code

string

required

Order code (Example: nhov1903942018)

pickup_address

integer

required

config

object

optional

preview

integer

optional

use_insurance

integer

optional

fulfill_now

integer

optional

Operating order (packaging 45p)

protective_packaging

integer

optional

additional_services

string

optional

EXG: Exchange goods
PRS: Pricing service
IGD: Co-inspection of goods upon delivery

box_dimension

integer

required

courier_integration

integer

required

courier_service

integer

required

service_id

shipping_info

object

optional

This parameter when the order is shipped and used the bill of lading and the separate AWB file

shipping_fee

integer

required

If free shipping, the default value 0

courier_tracking_code

string

required

AWB Code

courier_ship

integer

required

Shipping codes, data taken from https://developers.nandh.vn/api-11878854

label_url

string

required

File AWB or Label Transportation

Example

{
  "order_tracking_code": "NHOV1901344269",
  "pickup_address": 167,
  "config": {
    "preview": 1,
    "use_insurance": 0,
    "fulfill_now": 0,
    "protective_packaging": 0,
    "additional_services": "",
    "box_dimension": 120,
    "courier_integration": 172,
    "courier_service": 15
  },
  "shipping_info": {
    "shipping_fee": 0,
    "courier_tracking_code": "104577519879",
    "courier_ship": 12,
    "label_url": "https://stg-oms.nandh.vn/api/v1/shipments/awb-label/677e04eeb4c14d85fb32645c"
  }
}

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/create' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_tracking_code": "NHOV1901344269",
    "pickup_address": 167,
    "config": {
        "preview": 1,
        "use_insurance": 0,
        "fulfill_now": 0,
        "protective_packaging": 0,
        "additional_services": "",
        "box_dimension": 120,
        "courier_integration": 172,
        "courier_service": 15
    },
    "shipping_info": {
        "shipping_fee": 0,
        "courier_tracking_code": "104577519879",
        "courier_ship": 12,
        "label_url": "https://stg-oms.nandh.vn/api/v1/shipments/awb-label/677e04eeb4c14d85fb32645c"
    }
}'

Responses

🟢200OK

application/json

Body

status_code

integer

required

data

object

required

shipment_id

integer

required

tracking_code

string

required

error

boolean

required

error_code

null

optional

log_id

null

optional

messages

string

required

total

integer

required

Example

{
  "status_code": 200,
  "data": {
    "shipment_id": 5875,
    "tracking_code": "NHSV1901810304"
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Modified at 2025-02-24 09:35:00

Cancel shipment

Create shipment inbound