Danh sách trả hàng hoàn tiền

• API này dùng để lấy danh sách yêu cầu trả hàng hoàn tiền trên sàn: Shopee, Tiktok, Lazada.

Request

• Xem common request params.

curl --location --globoff 'https://pos.open.nhanh.vn/v3.0/ecom/return?appId={{appId}}&businessId={{businessId}}' \
--header 'Authorization: {{accessToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "filters": {
        "ecomAppId": 8195
    },
    "paginator": {
        "icpp": 50  
    }
}'

Filters

Key	Type	Description
ecomAppId	int $^{{\color{red}*}}$	ID các sàn trên Nhanh.vn. Lưu ý: chỉ hỗ trợ 3 sàn: Shopee / TikTok / Lazada
shopIds	array	List ID shop của gian hàng trên sàn
returnIdOrReturnTrackingNumber	string	ID yêu cầu hoàn tiền / Mã vận đơn trả
originalEcomOrderId	string	ID đơn hàng gốc trên sàn
createdFromAt	int	Thời gian tạo từ (timestamp)
createdToAt	int	Thời gian tạo đến (timestamp)
updatedFromAt	int	Thời gian cập nhật từ (timestamp)
updatedToAt	int	Thời gian cập nhật đến (timestamp)
nhanhStatuses	array	List ID trạng thái trả hàng hoàn tiền 1: Đã hoàn tiền 2: Đang xử lý 3: Đã hủy yêu cầu 4: Đang khiếu nại 5: Đang hoàn tiền

Response

• Xem cấu trúc chung tại đây.

Failed response

• Xem các mã lỗi chung tại đây.

Successful response

{
  "code": 1,
  "paginator": {
    "next": {
      "id": "(string) next ID"
    }
  },
  "data": [
    {
      "shopId": "(string) ID Shop",
      "returnId": "(string) ID trả hàng hoàn tiền",
      "businessId": "(int) ID doanh nghiệp",
      "returnType": "(int) ID returnType (1: Hoàn tiền ngay, 2: Trả hàng và hoàn tiền, 3: Đổi mới",
      "originalEcomOrderId": "(string) ID đơn hàng gốc",
      "reasonInfor": {
        "reasonId": "(string) ID lý do trên sàn",
        "reasonName": "(string) Tên trạng thái trên sàn"
      },
      "productsInfor": [
        {
          "image": "(string) Đường dẫn ảnh sản phẩm trên sàn",
          "name": "(string) Tên sản phẩm trên sàn",
          "quantity": "(double) Số lượng sản phẩm",
          "price":"(double) Giá sản phẩm",
          "sku": "(string) Mã SKU trên sàn"
        }
      ],
      "amount": "(double) Tổng tiền hoàn",
      "ecomStatus": {
        "id": "(string) Mã trạng thái yêu cầu trả hàng trên sàn",
        "name": "(string) Tên trạng thái yêu cầu trả hàng trên sàn"
      },
      "nhanhStatus": {
        "id": "(int) ID trạng thái yêu cầu trả hàng trên Nhanh ",
        "name": "(string) Tên trạng thái yêu cầu trả hàng trên Nhanh"
      },
      "createdAt": "(int) Thời gian tạo (timestamp)",
      "updateAt": "(int) Thời gian cập nhật (timestamp)"
    }
  ]
}