Tạo đơn hàng

Tạo thông tin đơn hàng trên hệ thống AG Fulfillment

HTTP Request

POST https://api.agbiz.vn/v2/ffm-order/orders/external

Attribute	Value	Description
URL	https://api.agbiz.vn/v2/ffm-order/orders/external	Đường dẫn URL
Method	POST	Phương thức HTTP Request
Headers	content-type: application/json	HTTP Headers
	ag-signature	Chữ ký để kiểm tra tính đúng đắn của dữ liệu khi truyền tải trên mạng. Lấy chữ ký ở đây.
Payload	json	Tham khảo Request Dto bên dưới

Request Dto

Attribute	Type	Required	Description
clientId	string	có	Mã client được config tại đây.
seller	string	không	Tên của seller bán hàng.
countryId	number	có	Thị trường trên AG Fulfillment: Thái Lan: 66, Phillies: 63, Malaysia: 60, Ấn Độ: 91, Myanmar: 95, Indonesia: 62, Lào: 856, Mỹ: 1
discount	number	có	Số tiền giảm giá
surcharge	number	có	Phụ phí
shippingFee	number	có	Phí vận chuyển
paid	number	có	Trả trước
subTotal	number	có	Tổng tiền (Giá trị đơn hàng chưa trừ giảm giá, trả trước và tính phụ phí)
externalId	string	có	Mã đơn hàng nội bộ của bạn
products	ProductDto[]	có	Danh sách sản phẩm trong đơn hàng. (Cần đồng bộ sản phẩm qua hệ thống AG Fulfillment trước)
internalNote	string	không	Ghi chú đơn hàng
customer	CustomerDto	không	Thông tin người nhận đơn hàng
carrierCode	string	không	Mã code của đơn vị vận chuyển trên hệ thồng AG Fulfillment. Nếu vận đơn tạo trực tiếp với ĐVVC thì truyền carrierCode đúng với ĐVVC đó. VD: jtexpress, ninjavan... Nếu vận đơn từ sàn TMĐT thì truyền carrierCode là tên sàn. VD: shopee, tiktokshop → Xem danh sách ĐVVC đang được hỗ trợ trên hệ thống
waybillNumber	string	không	Mã vận đơn
orderSource	string	không	Nguồn đơn, tên sàn tạo đơn. VD: lazada, shopee...
waybillNote	string	không	Ghi chú vận đơn
waybillURL	string	không	Đường dẫn URL chứa waybill để in đơn
tags	TagDto[]	không	Danh sách thẻ TagDto

Product Dto

Attribute	Type	Required	Description
sku	number	có	Mã SKU sản phẩm trên hệ thống AG Fulfillment
quantity	number	có	Số lượng sản phẩm
price	number	có	Giá trị của sản phẩm (Không nhân số lượng)
weight	number	có	Tổng cân nặng của từng sản phẩm trong đơn (Đã nhân với số lượng)

Customer Dto

Attribute	Type	Required	Description
name	string	không	Tên người nhận hàng
phone	string	không	Số điện thoại người nhận
address	string	không	Địa chỉ người nhận
province	string	không	Tên Thành phố / Tỉnh. VD: Hà Nội Xem thêm
district	string	không	Tên Quận / Huyện. VD: Đống Đa Xem thêm
ward	string	không	Tên Phường / Xã. VD: Thịnh Quang Xem thêm
postCode	string	không	Post Code Chi tiết

Tag Dto

Attribute	Type	Required	Description
name	string	không	Tên tag

Dữ liệu mẫu

{
   "products":[
      {
         "sku":"BB_HVL",
         "quantity":1,
         "price":299,
         "weight":100
      },
      {
         "sku":"BBX3_HVL",
         "quantity":9,
         "price":233,
         "weight":100
      }
   ],
   "customer":{
      "name":"มี นา",
      "phone":"01234968",
      "address":"1/11 ม.3 ตำบลบางแก้วฟ้า 120",
      "ward":"Thịnh Quang",
      "district":"Đống Đa",
      "province":"Hà Nội",
      "postCode":"10000"
   },
   "internalNote": "Ghi chú",
   "externalId":"BB-HVL-20210312",
   "clientId":244,
   "countryId": 66,
   "discount":1097,
   "surcharge":0,
   "shippingFee":0,
   "paid":0,
   "subTotal":2396,
   "seller":"AGPTH - CP - Noy",
   "carrierCode": "shopeetiktokshop",
   "waybillNumber": "PH7891OLK22",
   "orderSource": "shopee",
   "waybillURL": "https://cf.shopee.sg/file/4e801822251141f7fc177ff284f50d8e",
}

HTTP Response

Attribute	Type	Description
statusCode	integer	Kết quả của request
message	string	Mô tả chi tiết request
error	string	Mã lỗi dạng văn bản
data	json	Json chứa thông tin đơn hàng
data.externalId	string	Mã đơn hàng cần đồng bộ sang hệ thống AG Fulfillment
data.so	string	Mã đơn hàng vừa tạo trên hệ thống AG Fulfillment

Response mẫu

{
    "statusCode": 403,
    "message": "Signature invalid",
    "error": "Forbidden"
}

{
    "data": {
        "externalId": "F99MKP-20240328-2",
        "so": "VNDY5PZK"
    }
}