Create return order

Developing

POST

/api/v1/public/return-orders/create

Last modified:2025-04-05 03:03:15

Request

Header Params

Authorization

string

optional

Default:

6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==

Body Params application/json

order_tracking_code

string

required

return_address

integer

required

reason_type

string

required

item_missing : Missing item (Thiếu sản phẩm)
item_damaged : Item is damaged (Mặt hàng bị hư hỏng)
wrong_item : Wrong item delivered (Sai mặt hàng)
not_receipt : Item not received (Không nhận được)
warranty : Under warranty/insurance claim (Bảo hiểm)
different_description : Not as described (Mô tả khác)
mutual_agree : Return by mutual agreement (Thỏa thuận)
change_mind : Customer changed mind (Change mind)
expectation_failed : Did not meet expectations (Expectation failed)
item_fake : Counterfeit item (Hàng giả)
physical_dmg : Physical damage (Physical DMG)
functional_dmg : Functional damage (Functional DMG)
other : Other reason (Khác)

reason

string

optional

pickup

object

optional

To implement the logic where the customer_id field determines whether the other fields are mandatory or not, you can structure it as follows:
API Request Logic:
If customer_id is provided: Other fields such as fullname, phone, address, zipcode, province_name, district_name, and ward_name are optional.
If customer_id is null: Other fields (fullname, phone, address, zipcode, province_name, district_name, ward_name) are mandatory.

customer_id

integer

optional

If customer_id is null, the following fields are required

fullname

string

optional

This must be filled if customer_id is null

phone

string

optional

This must be filled if customer_id is null

country

string

optional

This must be filled if customer_id is null

email

string

optional

This must be filled if customer_id is null

address

string

optional

This must be filled if customer_id is null

zipcode

null

optional

This must be filled if customer_id is null

province_id

integer

required

This must be filled if customer_id is null

district_id

integer

optional

This must be filled if customer_id is null

ward_id

integer

optional

This must be filled if customer_id is null

return_items

array [object {4}]

optional

sku

string

required

sale_price

string

required

return_quantity

integer

required

order_item_id

integer

required

config

object

optional

delivery_service

string

required

shipping_info

object

optional

courier_integration_id

integer

required

ID referring to the courier's integration setup.

courier_id

integer

required

ID of the courier used (likely "Tự Vận Chuyển" or Self-shipping).

shipping_fee

integer

required

courier_tracking_code

string

required

"SPXVN045379876785" — The tracking number provided by the courier.

Example

{
  "order_tracking_code": "NHOV1908761573",
  "return_address": 167,
  "reason_type": "wrong_item",
  "reason": "",
  "pickup": {
    "customer_id": null,
    "fullname": "Bùi Thị Hoài Thương",
    "phone": "+84961557476",
    "country": "VN",
    "email": "buithihoaithuong301@gmail.com",
    "address": "Số 9 Trà khúc",
    "zipcode": null,
    "province_id": 79,
    "district_id": 766,
    "ward_id": 26965
  },
  "return_items": [
    {
      "sku": "MUOIXATAC",
      "sale_price": "200000.00",
      "return_quantity": 2,
      "order_item_id": 26703
    },
    {
      "sku": "250204067",
      "sale_price": "30700000.00",
      "return_quantity": 1,
      "order_item_id": 26702
    }
  ],
  "config": {
    "delivery_service": "SOF_STD"
  },
  "shipping_info": {
    "courier_integration_id": 172,
    "courier_id": 16,
    "shipping_fee": 0,
    "courier_tracking_code": "SPXVN045379876785"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://stg-oms.nandh.vn/api/v1/public/return-orders/create' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_tracking_code": "NHOV1908761573",
    "return_address": 167,
    "reason_type": "wrong_item",
    "reason": "",
    "pickup": {
         "customer_id": null,
        "fullname": "Bùi Thị Hoài Thương",
        "phone": "+84961557476",
        "country": "VN",
        "email": "buithihoaithuong301@gmail.com",
        "address": "Số 9 Trà khúc",
        "zipcode": null,
        "province_id": 79,
        "district_id": 766,
        "ward_id": 26965
    },
    "return_items": [
        {
            "sku": "MUOIXATAC",
            "sale_price": "200000.00",
            "return_quantity": 2,
            "order_item_id": 26703
        },
        {
            "sku": "250204067",
            "sale_price": "30700000.00",
            "return_quantity": 1,
            "order_item_id": 26702
        }
    ],
    "config": {
        "delivery_service": "SOF_STD"
    },
    "shipping_info": {
        "courier_integration_id": 172,
        "courier_id": 16,
        "shipping_fee": 0,
        "courier_tracking_code": "SPXVN045379876785"
    }
}'

Responses

🟢200OK

application/json

Body

status_code

integer

optional

data

object

optional

order_return_id

integer

optional

return_tracking_code

string

optional

error

boolean

optional

error_code

null

optional

log_id

null

optional

messages

string

optional

total

integer

optional

Example

{
  "status_code": 200,
  "data": {
    "order_return_id": 350,
    "return_tracking_code": "NHRV1908266927"
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Modified at 2025-04-05 03:03:15

Return order detail

SHIPMENT INBOUND