Request
- URL:
/orders
- Method: POST
- Header:
- Content-type: application/json
Request Body
Đối tượng JSON request (Content-Type: application/json) | |||
---|---|---|---|
Tên | Mô tả | Kiểu dữ liệu | Mặc định |
invoice_id | Invoice ID của đơn hàng (Bắt buộc) | String | |
payments | Danh sách các phiếu thu sẽ tạo | Payment[] | |
coupons | Danh sách coupon sử dụng. Chỉ hỗ trợ 1 phần tử | Coupon[] | |
details | Danh sách các sản phẩm sẽ bán trong đơn hàng | Detail[] | |
promotion | Thông tin về chương trình khuyến mãi áp dụng trên đơn hàng | Promotion | |
company_id | Company ID | Integer | |
creator_id | User ID của người tạo | Integer | |
employee_id | User ID của nhân viên bán hàng | Integer | |
store_id | ID của cửa hàng | Integer | |
warehouse_id | ID của kho xuất | Integer | |
status | Trạng thái đơn hàng | Integer | |
date_created | Ngày tạo đơn | Integer - Unix timestamp | |
price_sell | Tổng thành tiền | Float | |
quantity | Tổng số lượng item có trong đơn hàng | Integer | |
price_discount_value | Giá trị khuyến mãi trên đơn hàng | Float | |
price_shipping | Phí vận chuyển | Float | |
price_tax | Thuế | Float | |
price_final | Tổng tiền khách hàng phải trả | Float | |
cod_amount | Giá trị COD | Float | |
shipping_address | Địa chỉ người nhận | String | |
shipping_phone | Số điện thoại người nhận | String | |
shipping_full_name | Họ tên người nhận | String | |
shipping_region_id | ID tỉnh, thành phố của địa chỉ người nhận | String | |
shipping_sub_region_id | ID quận, huyện của địa chỉ người nhận | String | |
customer_id | ID khách hàng | Integer | |
contact_email | Email liên hệ | String | |
billing_address | Địa chỉ người mua | String | |
billing_phone | Điện thoại người mua | String | |
billing_full_name | Họ tên người mua | String | |
billing_gender | Giới tính của người mua (0: nữ, 1: nam) | Integer | |
billing_region_id | ID tỉnh, thành phố của địa chỉ người mua | Integer | |
billing_sub_region_id | ID quận, huyện của địa chỉ người mua | Integer | |
customer_birthday | Ngày tháng năm sinh của Kh (tạo mới KH) | Integer - Unix timestamp | |
shipping_service | ID nhà vận chuyển | Integer | |
promotion_id | ID chương trình khuyến mãi | Integer | |
tax_ratio | Thuế suất (từ 0 đến 100) | Integer | |
tag | Thẻ (tag) đơn hàng. Cách nhau dấu phẩy | String | |
origin | ID nguồn đơn hàng | Integer | |
customer_origin_id | ID nguồn khách hàng | Integer | |
note | Ghi chú cho đơn hàng | String | |
pos | Đánh dấu tạo đơn hàng. (Bắt buộc gửi lên true) | Boolean | true |
Cấu trúc JSON của đối tượng ‹Payment› | ||
---|---|---|
Tên | Mô tả | Kiểu dữ liệu |
method | Phương thức thanh toán của phiếu thu/chi | Integer |
value | Giá trị thanh toán | Float |
Cấu trúc JSON của đối tượng ‹Coupon› | ||
---|---|---|
Tên | Mô tả | Kiểu dữ liệu |
code | Mã Coupon | String |
discount_type | Loại áp dụng | Integer |
discount_value | Giá trị áp dụng |
Cấu trúc JSON của đối tượng ‹Detail› | ||
---|---|---|
Tên | Mô tả | Kiểu dữ liệu |
quantity | Số lượng sản phẩm | Integer |
price_before_promotion | Giá bán (trước khuyến mãi) | Float |
variant_id | ID của kiểu sản phẩm | Integer |
sku | SKU sản phẩm | String |
product_id | ID sản phẩm | Integer |
item_code | Mã sản phẩm | String |
item_name | Tên sản phẩm | String |
item_inventory_type | Phương pháp tồn kho của sản phẩm. Xem thêm phần sản phẩm | Integer |
item_serial_number | Serial Number của dòng chi tiết | String |
item_title | Thuộc tính tiêu đề của sản phẩm | String |
item_size | Thuộc tính kích thước của sản phẩm | String |
item_color | Thuộc tính màu sắc của sản phẩm | String |
item_material | Thuộc tính chất liệu của sản phẩm | String |
item_style | Thuộc tính kiểu dáng của sản phẩm | String |
price | Giá bán | Float |
promotion_manual | Thông tin khuyến mãi theo sản phẩm này | ProductPromotion |
Cấu trúc JSON của đối tượng ‹ProductPromotion› | ||
---|---|---|
Tên | Mô tả | Kiểu dữ liệu |
value_type | Loại áp dụng | Integer |
value | Giá trị áp dụng | Float |
Ví dụ một request object:
{ "invoice_id": "SPR-180314-1154-97AC", "company_id": "1", "creator_id": "1", "employee_id": "1", "store_id": 1195, "warehouse_id": "16", "status": 13, "payment_method": 42, "date_created": 1521003282, "payments": [ { "method": 11, "value": 920000 } ], "coupons": [ { "code": "valentine", "discount_type": 1, "discount_value": 10 } ], "details": [ { "quantity": 2, "price_before_promotion": 675000, "variant_id": 7311, "sku": "4572735364433", "product_id": 1565, "item_code": "4572", "item_name": "Giày Sandal 4572", "item_inventory_type": 0, "item_serial_number": "", "item_title": "Giày dép", "item_size": "38", "item_color": "Đỏ bóng", "item_material": "Si bóng", "item_style": "đi chơi", "price": 500000, "promotion_manual": { "value_type": "3", "value": "175000" } } ], "price_sell": 1000000, "quantity": 2, "price_discount_value": 200000, "price_discount": 200000, "price_tax": 80000, "price_shipping": 40000, "price_final": 920000, "cod_amount": 920000, "shipping_address": "33/36 Nguyễn Thái Học, P. Phạm Ngữ Lão", "shipping_phone": "0938916902", "shipping_full_name": "Huỳnh Sự", "shipping_region_id": 3, "shipping_sub_region_id": 822, "customer_id": 44690, "contact_email": "huynhquocsu@gmail.com", "billing_address": "33/36 Nguyễn Thái Học, P. Phạm Ngữ Lão", "billing_phone": "0938916902", "billing_full_name": "Huỳnh Sự", "billing_gender": 1, "billing_region_id": 3, "billing_sub_region_id": 822, "customer_birthday": 0, "shipping_service": 92, "promotion_id": 70, "promotion": { "id": 70, "code": "KMVLENTINE", "name": "Khuyến mãi 14/3 giảm 100k", "description": "", "value_type": 3, "value": 100000, "has_gift": 0, "gifts": [] }, "price_discount_unit": "VND", "price_tax_value": "10", "price_tax_unit": "%", "tax_ratio": 10, "tag": "valentine", "origin": "28", "customer_origin_id": 0, "note": "Giao hang gio hanh chinh", "pos": true }
Response
Success response
Status Code: 201
Content-Type: application/json
Cấu trúc theo cấu trúc của một đơn hàng trong phần danh sách đơn hàng. Nhấn vào đây để xem cấu trúc response. Nếu khách hàng chưa tồn tại thì sẽ tạo một khách hàng với thông tin từ request như email, điện thoại người mua, tên người mua, ngày sinh..
Error response
Nếu response có lỗi thì có thể tham khảo bảng bên dưới để biết các lỗi có thể xuất hiện khi gửi request này:
HTTP Status | Mã lỗi | Mô tả |
---|---|---|
422 | error_shipping_region_id_not_exist | ID tỉnh, thành phố (địa chỉ người nhận) không hợp lệ |
422 | error_shipping_sub_region_id_not_exist | ID quận huyện (địa chỉ người nhận) không hợp lệ |
422 | error_shipping_sub_sub_region_id_not_exist | ID xã phường (địa chỉ người nhận) không hợp lệ |
422 | error_billing_region_id_not_exist | ID tỉnh, thành phố (địa chỉ người mua) không hợp lệ |
422 | error_billing_sub_region_id_not_exist | ID quận huyện (địa chỉ người mua) không hợp lệ |
422 | error_billing_sub_sub_region_id_not_exist | ID xã phường (địa chỉ người mua) không hợp lệ |
422 | error_store_require | ID cửa hàng là bắt buộc. |
422 | error_store_not_exist | ID cửa hàng không tồn tại |
422 | error_not_role_permission | Không có quyền truy cập cửa hàng đã chọn |
422 | error_shipping_service_validate | ID nhà vận chuyển không đúng |
422 | error_delivery_status_error | Trạng thái giao hàng không hợp lệ |
422 | error_current_date_more_than_current_date_30_day | Ngày tạo không được trước 30 ngày so với hiện tại |
422 | error_status_not_validate | Trạng thái đơn hàng không hợp lệ |
422 | error_origin_not_validate | ID nguồn đơn hàng không hợp lệ |
422 | error_employee_not_exist | Nhân viên không tồn tại |
422 | error_invoice_require | Invoice ID là bắt buộc |
422 | error_invoice_id_is_exist | Invoice ID đã tồn tại |