API ORDER

1. API get đếm số lượng đơn hàng

- API này giúp đếm số lượng đơn hàng có trong shop.

1.1 Request

Method

URL

GET

https://apis.haravan.com/com/orders/count.json

Header: Authorization: Bearer + access_token 

1.2 Response

Status

Response

200

{"count":1594}

401

Unauthorized

403

Forbidden

2. API get danh sách đơn hàng

- API này giúp get tất cả đơn hàng có trong shop

2.1 Request

Method

URL

GET

https://apis.haravan.com/com/orders.json

Header:  Authorization: Bearer + access_token 

2.2 Response

Status

Response

200

{
    "orders": [
        {
            "billing_address": {
                "address1": "0933333123",
                "address2": null,
                "city": null,
                "company": null,
                "country": "Vietnam",
                "first_name": "hang mot",
                "id": 1023998775,
                "last_name": "khach",
                "phone": "0933333123",
                "province": "Hà Nội",
                "zip": null,
                "name": "khach hang mot",
                "province_code": "HI",
                "country_code": "VN",
                "default": true,
                "district": "Huyện Ba Vì",
                "district_code": "HI699",
                "ward": "Xã Ba Vì",
                "ward_code": "09703"
            },
            "browser_ip": null,
            "buyer_accepts_marketing": false,
            "cancel_reason": "other",
            "cancelled_at": "2019-08-29T07:12:43.89Z",
            "cart_token": "ed6a5096b86f4ca1bf49f905e51bc69c",
            "checkout_token": "ed6a5096b86f4ca1bf49f905e51bc69c",
            "client_details": {
                "accept_language": null,
                "browser_ip": null,
                "session_hash": null,
                "user_agent": null,
                "browser_height": null,
                "browser_width": null
            },
            "closed_at": null,
            "created_at": "2019-08-29T04:30:33.17Z",
            "currency": "VND",
            "customer": {
                "accepts_marketing": false,
                "addresses": [
                    {
                        "address1": null,
                        "address2": null,
                        "city": null,
                        "company": null,
                        "country": "Vietnam",
                        "first_name": "hang mot",
                        "id": 1034504743,
                        "last_name": "khach",
                        "phone": null,
                        "province": null,
                        "zip": null,
                        "name": "khach hang mot",
                        "province_code": null,
                        "country_code": "vn",
                        "default": true,
                        "district": null,
                        "district_code": null,
                        "ward": null,
                        "ward_code": null
                    }
                ],
                "created_at": "2019-08-29T04:29:48.22Z",
                "default_address": {
                    "address1": null,
                    "address2": null,
                    "city": null,
                    "company": null,
                    "country": "Vietnam",
                    "first_name": "hang mot",
                    "id": 1034504743,
                    "last_name": "khach",
                    "phone": null,
                    "province": null,
                    "zip": null,
                    "name": "khach hang mot",
                    "province_code": null,
                    "country_code": "vn",
                    "default": true,
                    "district": null,
                    "district_code": null,
                    "ward": null,
                    "ward_code": null
                },
                "email": "quochuy.dev1112@gmail.com",
                "phone": null,
                "first_name": "hang mot",
                "id": 1023998775,
                "multipass_identifier": null,
                "last_name": "khach",
                "last_order_id": 1078550261,
                "last_order_name": "#100000",
                "note": null,
                "orders_count": 1,
                "state": "Disabled",
                "tags": null,
                "total_spent": 0,
                "total_paid": 0,
                "updated_at": "2019-08-29T07:12:53Z",
                "verified_email": false,
                "send_email_invite": false,
                "send_email_welcome": false,
                "password": null,
                "password_confirmation": null,
                "group_name": null,
                "birthday": null,
                "gender": null,
                "last_order_date": null
            },
            "discount_codes": [],
            "email": "quochuy.dev1112@gmail.com",
            "financial_status": "pending",
            "fulfillments": [],
            "fulfillment_status": "notfulfilled",
            "tags": null,
            "gateway": "Thanh toán khi giao hàng (COD)",
            "gateway_code": "COD",
            "id": 1078550261,
            "landing_site": null,
            "landing_site_ref": null,
            "source": "haravan_draft_order",
            "line_items": [
                {
                    "fulfillable_quantity": 1,
                    "fulfillment_service": null,
                    "fulfillment_status": "notfulfilled",
                    "grams": 0,
                    "id": 1089785696,
                    "price": 100000,
                    "price_original": 100000,
                    "price_promotion": 0,
                    "product_id": 1021299998,
                    "quantity": 1,
                    "requires_shipping": true,
                    "sku": null,
                    "title": "test 1",
                    "variant_id": 1043013707,
                    "variant_title": "Default Title",
                    "vendor": "testnsx",
                    "type": "testloai",
                    "name": "test 1 - Default Title",
                    "gift_card": false,
                    "taxable": true,
                    "tax_lines": null,
                    "product_exists": true,
                    "barcode": null,
                    "properties": null,
                    "total_discount": 0,
                    "applied_discounts": [],
                    "image": null,
                    "not_allow_promotion": false,
                    "ma_cost_amount": 0
                }
            ],
            "name": "#100000",
            "note": null,
            "number": 1078550261,
            "order_number": "#100000",
            "processing_method": null,
            "referring_site": "haravan_draft_order",
            "refunds": [
                {
                    "created_at": "2019-08-29T07:12:43.895Z",
                    "id": 1003551890,
                    "note": "",
                    "refund_line_items": null,
                    "restock": null,
                    "user_id": 200000126886,
                    "order_id": 1078550261,
                    "transactions": []
                }
            ],
            "shipping_address": {
                "address1": "0933333123",
                "address2": null,
                "city": null,
                "company": null,
                "country": "Vietnam",
                "first_name": "hang mot",
                "last_name": "khach",
                "latitude": 0,
                "longitude": 0,
                "phone": "0933333123",
                "province": "Hà Nội",
                "zip": null,
                "name": "khach hang mot",
                "province_code": "HI",
                "country_code": "VN",
                "district_code": "HI699",
                "district": "Huyện Ba Vì",
                "ward_code": "09703",
                "ward": "Xã Ba Vì"
            },
            "shipping_lines": [
                {
                    "code": null,
                    "price": 0,
                    "source": null,
                    "title": null
                }
            ],
            "source_name": "haravan_draft_order",
            "subtotal_price": 500000,
            "tax_lines": null,
            "taxes_included": false,
            "token": "ed6a5096b86f4ca1bf49f905e51bc69c",
            "total_discounts": 0,
            "total_line_items_price": 500000,
            "total_price": 500000,
            "total_tax": 0,
            "total_weight": 0,
            "updated_at": "2019-08-29T07:12:43.895Z",
            "transactions": [
                {
                    "amount": 500000,
                    "authorization": null,
                    "created_at": "2019-08-29T04:30:33.256Z",
                    "device_id": null,
                    "gateway": "Thanh toán khi giao hàng (COD)",
                    "id": 1030338166,
                    "kind": "pending",
                    "order_id": 1078550261,
                    "receipt": null,
                    "status": null,
                    "test": false,
                    "user_id": 1000554361,
                    "location_id": 686975,
                    "payment_details": null,
                    "parent_id": null,
                    "currency": "VND",
                    "haravan_transaction_id": null,
                    "external_transaction_id": null,
                    "send_email": false
                }
            ],
            "note_attributes": [],
            "confirmed_at": "2019-08-29T04:30:33.906Z",
            "closed_status": "unclosed",
            "cancelled_status": "cancelled",
            "confirmed_status": "confirmed",
            "user_id": 1000554361,
            "device_id": null,
            "location_id": 686975,
            "ref_order_id": 0,
            "ref_order_number": null,
            "confirm_user": null,
            "utm_source": null,
            "utm_medium": null,
            "utm_campaign": null,
            "utm_term": null,
            "utm_content": null,
            "redeem_model": null
        }
    ]
}

401

Unauthorized

403

Forbidden

3. API get chi tiết đơn hàng

- API này giúp lấy thông tin chi tiết 1 đơn hàng

3.1 Request

Method

URL

GET

https://apis.haravan.com/com/orders/#{order_id}.json

Header:  Authorization: Bearer + access_token 

3.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024004330,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": null,
        "cancelled_at": null,
        "cart_token": "af3a28a3ef4b44e2aba1c1d84d459cd1",
        "checkout_token": "af3a28a3ef4b44e2aba1c1d84d459cd1",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": null,
        "created_at": "2019-08-29T07:51:36.603Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T07:15:26.44Z",
            "default_address": null,
            "email": "guest@haravan.com",
            "phone": null,
            "first_name": null,
            "id": 1024004330,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": 1078583099,
            "last_order_name": "#100002",
            "note": null,
            "orders_count": 2,
            "state": "Disabled",
            "tags": null,
            "total_spent": 100000,
            "total_paid": 0,
            "updated_at": "2019-08-29T07:51:38Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "guest@haravan.com",
        "financial_status": "paid",
        "fulfillments": [
            {
                "created_at": "2019-08-29T07:51:36.824Z",
                "id": 1013640600,
                "order_id": 1078583099,
                "receipt": null,
                "status": "success",
                "tracking_company": "Khác",
                "tracking_company_code": "other",
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": "http://www.google.com/search?q=",
                "tracking_urls": [
                    "http://www.google.com/search?q="
                ],
                "updated_at": "2019-08-29T07:51:36.892Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Đã hoàn thành",
                        "grams": 0,
                        "id": 1089824075,
                        "price": 100000,
                        "product_id": 1021299998,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": null,
                        "title": "test 1",
                        "variant_id": 1043013707,
                        "variant_title": "Default Title",
                        "vendor": "testnsx",
                        "name": "test 1",
                        "variant_inventory_management": null,
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Đã giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "delivered",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": "",
                "ready_to_pick_date": "2019-08-29T07:51:37Z",
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": "2019-08-29T07:51:37Z",
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": null,
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": "",
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": null,
        "gateway": "Tiền mặt",
        "gateway_code": null,
        "id": 1078583099,
        "landing_site": null,
        "landing_site_ref": null,
        "source": "pos",
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "fulfilled",
                "grams": 0,
                "id": 1089824075,
                "price": 100000,
                "price_original": 100000,
                "price_promotion": 0,
                "product_id": 1021299998,
                "quantity": 1,
                "requires_shipping": true,
                "sku": null,
                "title": "test 1",
                "variant_id": 1043013707,
                "variant_title": "Default Title",
                "vendor": "testnsx",
                "type": "testloai",
                "name": "test 1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100002",
        "note": "",
        "number": 1078583099,
        "order_number": "#100002",
        "processing_method": null,
        "referring_site": null,
        "refunds": [],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": "pos",
        "subtotal_price": 100000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "af3a28a3ef4b44e2aba1c1d84d459cd1",
        "total_discounts": 0,
        "total_line_items_price": 100000,
        "total_price": 100000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T07:51:36.868Z",
        "transactions": [
            {
                "amount": 100000,
                "authorization": null,
                "created_at": "2019-08-29T07:51:36.933Z",
                "device_id": null,
                "gateway": "Tiền mặt",
                "id": 1030349010,
                "kind": "capture",
                "order_id": 1078583099,
                "receipt": null,
                "status": null,
                "test": false,
                "user_id": 1000554361,
                "location_id": 686975,
                "payment_details": null,
                "parent_id": 1030349008,
                "currency": "VND",
                "haravan_transaction_id": null,
                "external_transaction_id": null,
                "send_email": false
            }
        ],
        "note_attributes": [],
        "confirmed_at": "2019-08-29T07:51:36.668Z",
        "closed_status": "unclosed",
        "cancelled_status": "uncancelled",
        "confirmed_status": "confirmed",
        "user_id": 1000554361,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

422

{"errors": "Đơn hàng không tồn tại"}

1

billing_address (object)

Địa chỉ đặt hàng

1.1

address1 (string)

Địa chỉ 1

1.2

address2  (string)

Địa chỉ 2

1.3

city  (string)

Thành phố

1.4

company (string)

Công ty

1.5

country  (string)

Quốc gia

1.6

first_name  (string)

Tên

1.7

id (string)

ID khách hàng

1.8

last_name (string)

Họ và tên đệm

1.9

phone  (string)

Điện thoại

1.10

province (string)

Tỉnh/ Thành

1.11

zip (string)

Mã code quốc gia

1.12

name (string)

Họ và Tên

1.13

province_code (string)

Mã tỉnh thành

1.14

country_code (string)

Mã quốc gia

1.15

default (boolean)

Là địa chỉ mặc định:

true: có

false: không

1.16

district (string)

Quận/ huyện

1.17

district_code (string)

Mã quận huyện

1.18

ward (string)

Phường/Xã

1.19

ward_code (string)

Mã phường/ xã

2

browser_ip (string)

Địa chỉ IP trình duyệt

3

buyer_accepts_marketing (boolean)

Chấp nhận nhận quảng cáo:

true: có

false: không

4

cancel_reason (string)

Lý do hủy

5

cancelled_at (datetime)

Thời điểm hủy đơn hàng

6

cart_token (string)

Mã thông báo giỏ hàng

7

checkout_token (string)

Mã thông báo checkout

8

client_details (object)

Thông tin chi tiết máy khách hàng

8.1

accept_language (string)

Ngôn ngữ chấp nhận

8.2

browser_ip (string)

Địa chỉ IP trình duyệt

8.3

session_hash (string)

Phiên giao dịch

8.4

user_agent (string)

Thông tin trình duyệt

8.5

browser_height (string)

Chiều cao trình duyệt

8.6

browser_width (string)

Chiều rộng trình duyệt

9

closed_at (datetime)

Ngày đóng đơn hàng

10

created_at (datetime)

Ngày tạo đơn hàng

11

currency (string)

Loại tiền

12

customer (object)

Khách hàng

12.1

accepts_marketing (boolean)

Nhận quảng cáo:

true: Có

false: Không

12.2

addresses (array)

- Danh sách các object địa chỉ của khách hàng, tối đa 11 object, bao gồm 1 object địa chỉ mặc định và 10 địa chỉ khác.

- Ý nghĩa của các field bên trong tương tự như mục 1. billing_address

12.3

created_at (datetime)

Thời điểm khách hàng được tạo

12.4

default_address (object)

- Địa chỉ mặc định của khách hàng.

- Ý nghĩa của các field bên trong tương tự như mục 1. billing_address.

12.5

email (string)

Email khách hàng

12.6

first_name (string)

Tên

12.7

id (number)

ID khách hàng

12.8

multipass_identifier (string)

CMND

12.9

last_name (string)

Họ và tên đệm

12.10

last_order_id (number)

Mã đơn hàng cuối cùng mà khách hàng mua

12.11

last_order_name (string)

Tên đơn hàng cuối cùng mà khách hàng mua

12.12

note (string)

Ghi chú

12.13

order_count (number)

Số lượng đơn hàng mà khách hàng đã đặt

12.14

state (string)

Trạng thái tài khoản của Khách Hàng:

“Disabled”: KH chưa tạo tài khoản

“Invited”: KH đã nhận lời mời tạo tài khoản
“Enabled”: KH đã tạo tài khoản

“Declined”: KH từ chối lời mời email tạo tài khoản

12.15

tags (string)

Nhãn đính kèm với khách hàng

12.16

total_spent (number)

Tổng tiền khách hàng đã mua hàng

12.17

total_paid (number)

Tổng tiền khách hàng đã thanh toán

12.18

updated_at (datetime)

Ngày cập nhật

13

discount_codes (array)

Giá trị khuyến mãi

13.1

amount (number)

Số tiền khuyến mãi

13.2

code (string)

Mã khuyến mãi

13.3

type (string)

Loại khuyến mãi:

"fixed_amount": Số tiền.

"percentage": % Giảm.

"shipping": Miễn phí vận chuyển.

13.4

is_coupon_code (boolean)

Loại khuyến mãi:

false: Là chương trình khuyến mãi

true: Là khuyến mãi coupon

14

email (string)

Email đặt hàng của khách hàng

15

financial_status

Trạng thái thanh toán:

“pending”: Chưa thanh toán

“partially_paid”: Đã thanh toán một phần

“paid”: Đã thanh toán

“partiallyrefunded”: Đã thanh toán một phần

“refunded”: Đã hoàn tiền

“voided”: Đã huỷ

16

fulfillments (array)

Mảng giá trị thực hiện vận chuyển giao hàng

16.1

created_at (datetime)

Thời điểm tạo giao hàng

16.2

id (number)

Id giao hàng>

16.3

order_id (number)

Id đơn hàng được giao

16.4

tracking_company (string)

Tên nhà vận chuyển

"Giao Hàng Nhanh"

"VNPost"

"Khác"

"Viettel Post"

"ShipChung.vn"

"ProShip.vn"

"FlexShip"

"Giao hàng nhanh"

"DHL"

"Ninja Van"

"GrabExpress"

"AhaMove"

"ViettelPost2018"

"HCMPost2019"

16.5

tracking_company_code (string)

Mã nhà vận chuyển:

"ghn": Giao Hàng Nhanh

"vnpost": VNPost

"other": Khác

"viettelpost": Viettel Post

"shipchung": ShipChung.vn

"proship": ProShip.vn

"flexship": FlexShip

"ghn2018": Giao hàng nhanh

"dhl": DHL

"ninjavan": Ninja Van

"grabexpress": GrabExpress

"ahamove": AhaMove

"viettelpost2018": ViettelPost2018

"hcmpost2019": HCMPost2019

16.6

tracking_numbers (array)

List mã vận chuyển từ nhà vận chuyển

16.7

tracking_number (string)

Mã vận chuyển

16.8

tracking_url (string)

Link tìm kiếm bản đồ vận chuyển

16.9

tracking_urls (string)

List link tìm kiếm bản đồ vận chuyển

16.10

updated_at (datetime)

Thời điểm cập nhật vận chuyển

16.11

line_items (array)

List sản phẩm được vận chuyển, các field của object bên trong tương tự như mục 25.line_items

16.12

notify_customer (boolean)

Thông báo cho khách hàng:

true: Có

false: Không

16.13

province (string)

Tỉnh thành

16.14

province_code (string)

Mã tỉnh thành

16.15

district (string)

Quận huyện

16.16

district_code (string)

Mã quận huyện

16.17

ward (string)

Phường xã

16.18

ward_code (string)

Mã phường xã

16.19

cod_amount (number)

Tiền thu hộ

16.20

carrier_status_name (string)

Tên trạng thái giao hàng

16.21

carrier_cod_status_name (string)

Tên trạng thái thu tiền COD:

"Không"

"Chưa Nhận"

"Đã nhận"

16.22

carrier_status_code (string)

Mã trạng thái giao hàng:

"readytopick": chờ lấy hàng

"picking": đang đi lấy

"delivering": đang giao hàng

"delivered": đã giao hàng

"cancel": hủy giao hàng

"return": chuyển hoàn

"pending": chờ xử lý

"notmeetcustomer": không gặp khách

"waitingforreturn": chờ chuyển hoàn

16.23

carrier_cod_status_code (string)

Mã trạng thái thu tiền COD:

"none": Không

"codpending": Chưa nhận

"codpaid" Chưa nhận

"codreceipt" Đã nhận

16.24

location_id (number)

Mã chi nhánh lấy hàng

16.25

shipping_package (number)

Gói giao hàng

16.26

note (string)

Ghi chú

16.27

carrier_service_package (number)

Gói vận chuyển

16.28

carrier_service_package_name (string)

Tên gói vận chuyển

16.29

is_new_service_package (boolean)

Sử dụng gói mặc định:

true: không

false: có

16.30

coupon_code (string)

Mã khuyến mãi

16.31

ready_to_pick_date (datetime)

Thời điểm chuyển qua trạng thái “sẵn sàng giao”

16.32

picking_date (datetime)

Thời điểm chuyển qua trạng thái “chọn giao hàng”

16.33

delivering_date (datetime)

Thời điểm chuyển qua trạng thái “Đang giao hàng”

16.34

delivered_date (datetime)

Thời điểm chuyển qua trạng thái “Đã giao hàng”

16.35

return_date (datetime)

Thời điểm chuyển qua trạng thái “Trả hàng”

16.36

not_meet_customer_date (datetime)

Thời điểm chuyển qua trạng thái “Không gặp khách hàng”

16.37

waiting_for_return_date (datetime)

Thời điểm chuyển qua trạng thái “Chờ chuyển hoàn”

16.38

cod_paid_date (datetime)

Thời điểm chuyển qua trạng thái “Đã nhận tiền thu hộ COD”

16.39

cod_receipt_date (datetime)

Thời điểm chuyển qua trạng thái “Đối soát tiền thu hộ COD”

16.40

cod_pending_date (datetime)

Thời điểm chuyển qua trạng thái “đợi thu hộ COD”

16.41

cod_not_receipt_date (datetime)

Thời điểm chuyển qua trạng thái “không đối soát tiền thu hộ COD”

16.42

is_view_before (boolean)

Được xem hàng trước:

true: Có

false: Không

16.43

country (string)

Quốc gia

16.44

country_code (string)

Mã quốc gia

16.45

zip_code (string)

Mã code quốc gia

16.46

city (string)

Thành phố

16.47

real_shipping_fee

Phí vận chuyển thực

16.48

shipping_notes (string)

Ghi chú

16.49

total_weight (number)

Tổng khối lượng

16.50

package_width (number)

Chiều rộng gói hàng

16.51

package_height (number)

Chiều cao gói hàng

17

fulfillment_status (string)

Trạng thái giao hàng (trạng thái tạo vận đơn):

null: Không giao hàng

"not_fulfilled": Chưa hoàn thành

"partial": Hoàn thành một phần

"fulfilled": Đã hoàn thành

18

tags (string)

Gắn nhãn của đơn hàng

19

gateway (string)

Phương thức thanh toán

20

gateway_code (string)

Mã phương thức thanh toán

21

id (number)

Mã đơn hàng

22

landing_site (string)

URL nơi người mua đặt hàng

23

landing_site_ref (string)

URL tham chiếu

24

source (string)

Nguồn đơn hàng

25

line_items (array)

Chi tiết đơn hàng

25.1

fulfillable_quantity (number)

Số lượng sản phẩm giao hàng

25.2

fulfillment_service (number)

Giao hàng dịch vụ

25.3

fulfillment_status (string)

Trạng thái giao hàng (trạng thái tạo vận đơn):

null: Không giao hàng

"not_fulfilled": Chưa hoàn thành

"partial": Hoàn thành một phần

"fulfilled": Đã hoàn thành

25.4

grams (number)

Khối lượng của sản phẩm

25.5

id (string)

Id line item

25.6

price (number)

Giá sản phẩm trong line item

25.7

price_original (number)

Giá gốc của sản phẩm trong line item

25.8

price_promotion (number)

Giá khuyến mãi của sản phẩm trong line item

25.9

product_id (string)

id sản phẩm

25.10

quantity (number)

Số lượng sản phẩm

25.11

requires_shipping (boolean)

Có giao hàng:

true: Có
false: Không

25.12

sku (string)

Mã sku của sản phẩm

25.13

title (string)

Tên của sản phẩm

25.14

variant_id (string)

ID biến thể của sản phẩm

25.15

variant_title (string)

Tên biến thể của sản phẩm

25.16

vendor (string)

Nhà sản xuất của sản phẩm

25.17

type (string)

Loại sản phẩm

25.18

name (string)

Tên sản phẩm và tên biến thể của sản phẩm

25.19

gift_card (Boolean)

Có thẻ quà tặng:

true: Có

false: Không

25.20

taxable (Boolean)

Sản phẩm không chịu thuế:

true: Có

false: Không

25.21

tax_lines (array)

Chi tiết thuế sản phẩm: price, rate, title

25.22

product_exists (Boolean)

Còn sản phẩm:

true: Còn
false: Hết

25.22

barcode (string)

Mã barcode định danh sản phẩm

25.23

total_discount (number)

Tổng tiền chiết khấu của sản phẩm

25.24

applied_discounts (array)

Thôn tin khuyến mãi

25.24.1

Description (string)

Miêu tả

25.24.2

Amount (number)

Số tiền được giảm

25.25

image (array)

Chi tiết hình ảnh sản phẩm

25.25.1

src (string)

Link ảnh sản phẩm

25.25.2

attactment (string)

File đính kèm

25.25.3

filename (string)

Tên file

25.25.4

not_allow_promotion (boolean)

Sản phẩm không được áp dụng chương trình khuyến mãi:

false: Không

true: Có

25.25.5

ma_cost_amount (number)

Giá vốn của sản phẩm

26

name (string)

Tên đơn hàng hiện tại

27

note (string)

Ghi chú của đơn hàng

28

number (number)

Số nhận dạng duy nhất cho cửa hàng

29

order_number (string)

Số đơn hàng

30

processing_method (string)

Phương thức xử lý

31

referring_site (string)

Trang web mà khách hàng đã nhấn vào để vào cửa hàng

32

refunds (array)

Danh sách hoàn trả được áp dụng cho đơn hàng

32.1

created_at (datetime)

Thời điểm tạo hoàn trả cho đơn hàng

32.2

id (number)

ID object refund

32.3

note (string)

Ghi chú hoàn trả

32.4

refund_line_items (array)

Danh sách sản phẩm được hoàn trả

32.4.1

id (number)

ID object refund_line_item

32.4.2

line_item (object)

Chi tiết sản phẩm hoàn trả.

32.4.3

line_item_id (number)

Id của line item trên đơn hàng

32.4.3

Quantity (number)

Sô lượng sản phẩm trả

32.5

restock (boolean)

Có hoàn trả sản phẩm:

true: Có

false: Không

32.6

user_id (number)

Id nhân viên hoàn trả

32.7

order_id (number)

Id đơn hàng hoàn trả

32.8

transactions (array)

Chi tiết tiền thanh toán hoàn trả

32.8.1

amount (number)

Số tiền hoàn trả

32.8.2

created_at (datetime)

Thời điểm hoàn tiền

32.8.3

gateway (string)

Phương thức thanh toán

32.8.4

id (number)

Id của object chi tiết hoàn tiền

32.8.5

kind (string)

Loại giao dịch:

"pending": chờ xử lý.

"capture": Đã chuyển tiền.

"void": Đang chờ xử lý.

"refund": Hoàn trả

32.8.5

order_id (number)

Id đơn hàng

32.8.6

user_id (number)

Người thanh toán, 0: hệ thống tự thanh toán

32.8.7

location_id (number)

Id chi nhánh thanh toán

32.8.8

currency (string)

Loại tiền tệ

33

shipping_address (array)

Địa chỉ để giao hàng, các field của object bên trong có ý nghĩa tương tự như mục 1. billing_address

34

shipping_lines (array)

Chứa các phương thức giao hàng được sử dụng

34.1

code (string)

Mã vận chuyển

34.2

price (number)

Phí vận chuyển

34.3

source (string)

Nguồn vận chuyển

34.4

title (string)

Tên vận chuyển

35

source_name (string)

Tên nguồn mua hàng

36

subtotal_price (number)

Tổng giá đơn hàng

37

tax_lines (string)

Thuế đi kèm

38

taxes_included (string)

Tính thuế số phụ đặt hàng

false: Không
true: Có

39

token (string)

Số nhận dạng duy nhất cho đơn hàng cụ thể

40

total_discounts (number)

Tổng giá trị khuyến mãi của đơn hàng

41

total_line_items_price (number)

Tổng tất cả giá của tất cả mặt hàng

42

total_price (number)

Tổng giá của đơn hàng trước khi vận chuyển và thuế

43

total_tax (number)

Tổng tiền thuế áp dụng cho đơn hàng

44

total_weight (number)

Tổng khối lượng đơn hàng tính bằng gram

45

updated_at (datetime)

Thời điểm cập nhật đơn hàng

46

inventory_behaviour (string)

Xác đinh có được quảng cáo sản phẩm

47

transactions (array)

Giao dịch trong đơn hàng, các field của object bên trong có ý nghĩa tương tự như mục 32.8 transactions

48

note_attributes (string)

Thông tin được bổ sung khi đặt hàng

49.1

name (string)

Tên thông tin

49.2

value (string)

Giá trị

50

confirmed_at (datatime)

Thời điểm xác nhận đơn hàng

51

closed_status (string)

Trạng thái lưu trữ đơn hàng:

"unclosed": không lưu trữ đơn hàng

"closed": có lưu trữ đơn hàng

52

cancelled_status (string)

Trạng thái hủy đơn hàng:

"uncancelled": không hủy

"cancelled": Có hủy

53

confirmed_status (string)

Trạng thái xác nhận đơn hàng:

"unconfirmed": không xác nhận

"confirmed": có xác nhận

4. API tạo đơn hàng

- API này giúp tạo 1 đơn hàng (Ví dụ bên dưới, đơn hàng được tạo ra lưu lại email khách hàng, trạng thái đã giao hàng, các sản phẩm và số lượng được đặt).

4.1 Request

Method

URL

POST

https://apis.haravan.com/com/orders.json

Header:  
Authorization: Bearer + access_token 
Content-Type: application/json
 

- Có 2 cách tạo đơn hàng :

+ Tạo đơn hàng có variant_id, có thể quản lý tồn kho.

Header:  Authorization: Bearer + access_token 
Content-Type: application/json

Request raw json:
{
  "order": {
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ]

 

+ Tạo đơn hàng không có variant_id, không thể quản lý tồn kho

Request raw json:
{
  "order": {
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "line_items": [
      {
        "price": 10000,
        "quantity": 1,
        "title": 1,
      }
    ]
  }
}
 

STT

Thuộc tính

Mô tả

1

email (String)

Địa chỉ email khách hàng

2

fulfillment_status (String)

Trạng thái vận chuyển

3

line_items (Arrays)

Danh sách sản phẩm mua

3.1

variant_id (Number)

Id variant sản phẩm

3.2

quantity (Number)

Số lượng

4.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024021320,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": null,
        "cancelled_at": null,
        "cart_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "checkout_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": null,
        "created_at": "2019-08-29T09:14:52.98Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T09:12:54.258Z",
            "default_address": null,
            "email": "foo@example.com",
            "phone": null,
            "first_name": null,
            "id": 1024021320,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": null,
            "last_order_name": null,
            "note": null,
            "orders_count": 0,
            "state": "Disabled",
            "tags": null,
            "total_spent": 0,
            "total_paid": 0,
            "updated_at": "2019-08-29T09:12:54.258Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "foo@example.com",
        "financial_status": "pending",
        "fulfillments": [
            {
                "created_at": "2019-08-29T09:14:53.191Z",
                "id": 1013643280,
                "order_id": 1078596404,
                "receipt": null,
                "status": "success",
                "tracking_company": null,
                "tracking_company_code": null,
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": null,
                "tracking_urls": [],
                "updated_at": "2019-08-29T09:14:53.191Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Chưa hoàn thành",
                        "grams": 0,
                        "id": 1089840050,
                        "price": 200000,
                        "product_id": 1021300008,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": "tét",
                        "title": "test 2.1",
                        "variant_id": 1043013721,
                        "variant_title": "Default Title",
                        "vendor": "testnxs",
                        "name": "test 2.1",
                        "variant_inventory_management": "haravan",
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Đã giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "delivered",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": null,
                "ready_to_pick_date": null,
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": null,
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": null,
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": null,
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": null,
        "gateway": null,
        "gateway_code": null,
        "id": 1078596404,
        "landing_site": null,
        "landing_site_ref": null,
        "source": null,
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "notfulfilled",
                "grams": 0,
                "id": 1089840050,
                "price": 200000,
                "price_original": 200000,
                "price_promotion": 0,
                "product_id": 1021300008,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "tét",
                "title": "test 2.1",
                "variant_id": 1043013721,
                "variant_title": "Default Title",
                "vendor": "testnxs",
                "type": "testloai",
                "name": "test 2.1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100003",
        "note": null,
        "number": 1078596404,
        "order_number": "#100003",
        "processing_method": null,
        "referring_site": null,
        "refunds": [],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": null,
        "subtotal_price": 200000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "total_discounts": 0,
        "total_line_items_price": 200000,
        "total_price": 200000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T09:14:53.19Z",
        "transactions": [],
        "note_attributes": [],
        "confirmed_at": null,
        "closed_status": "unclosed",
        "cancelled_status": "uncancelled",
        "confirmed_status": "unconfirmed",
        "user_id": 200000126886,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

5. API cập nhật trạng thái lưu trữ

- API giúp lưu trữ 1 đơn hàng

5.1 Request

Method

URL

POST

https://apis.haravan.com/com/orders/#{order_id}/open.json

Header:  Authorization: Bearer + access_token 

5.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024021320,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": null,
        "cancelled_at": null,
        "cart_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "checkout_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": null,
        "created_at": "2019-08-29T09:14:52.98Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T09:12:54.258Z",
            "default_address": null,
            "email": "foo@example.com",
            "phone": null,
            "first_name": null,
            "id": 1024021320,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": 1078596404,
            "last_order_name": "#100003",
            "note": null,
            "orders_count": 1,
            "state": "Disabled",
            "tags": null,
            "total_spent": 0,
            "total_paid": 0,
            "updated_at": "2019-08-29T09:14:54Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "foo@example.com",
        "financial_status": "pending",
        "fulfillments": [
            {
                "created_at": "2019-08-29T09:14:53.191Z",
                "id": 1013643280,
                "order_id": 1078596404,
                "receipt": null,
                "status": "success",
                "tracking_company": null,
                "tracking_company_code": null,
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": null,
                "tracking_urls": [],
                "updated_at": "2019-08-29T09:14:53.191Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Chưa hoàn thành",
                        "grams": 0,
                        "id": 1089840050,
                        "price": 200000,
                        "product_id": 1021300008,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": "tét",
                        "title": "test 2.1",
                        "variant_id": 1043013721,
                        "variant_title": "Default Title",
                        "vendor": "testnxs",
                        "name": "test 2.1",
                        "variant_inventory_management": "haravan",
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Đã giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "delivered",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": null,
                "ready_to_pick_date": null,
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": null,
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": null,
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": null,
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": null,
        "gateway": null,
        "gateway_code": null,
        "id": 1078596404,
        "landing_site": null,
        "landing_site_ref": null,
        "source": null,
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "notfulfilled",
                "grams": 0,
                "id": 1089840050,
                "price": 200000,
                "price_original": 200000,
                "price_promotion": 0,
                "product_id": 1021300008,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "tét",
                "title": "test 2.1",
                "variant_id": 1043013721,
                "variant_title": "Default Title",
                "vendor": "testnxs",
                "type": "testloai",
                "name": "test 2.1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100003",
        "note": null,
        "number": 1078596404,
        "order_number": "#100003",
        "processing_method": null,
        "referring_site": null,
        "refunds": [],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": null,
        "subtotal_price": 200000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "total_discounts": 0,
        "total_line_items_price": 200000,
        "total_price": 200000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T09:14:53.19Z",
        "transactions": [
            {
                "amount": 200000,
                "authorization": null,
                "created_at": "2019-08-29T09:14:53.361Z",
                "device_id": null,
                "gateway": "",
                "id": 1030353776,
                "kind": "pending",
                "order_id": 1078596404,
                "receipt": null,
                "status": null,
                "test": false,
                "user_id": 200000126886,
                "location_id": 686975,
                "payment_details": null,
                "parent_id": null,
                "currency": "VND",
                "haravan_transaction_id": null,
                "external_transaction_id": null,
                "send_email": false
            }
        ],
        "note_attributes": [],
        "confirmed_at": null,
        "closed_status": "unclosed",
        "cancelled_status": "uncancelled",
        "confirmed_status": "unconfirmed",
        "user_id": 200000126886,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

422

{"errors": "Đơn hàng không tồn tại"}

6. API cập nhật trạng thái hủy lưu trữ

- API giúp hủy lưu trữ 1 đơn hàng

6.1 Request

Method

URL

POST

https://apis.haravan.com/com/orders/#{order_id}/close.json

Header:  Authorization: Bearer + access_token 

6.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024021320,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": null,
        "cancelled_at": null,
        "cart_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "checkout_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": "2019-08-29T09:30:20.087Z",
        "created_at": "2019-08-29T09:14:52.98Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T09:12:54.258Z",
            "default_address": null,
            "email": "foo@example.com",
            "phone": null,
            "first_name": null,
            "id": 1024021320,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": 1078596404,
            "last_order_name": "#100003",
            "note": null,
            "orders_count": 1,
            "state": "Disabled",
            "tags": null,
            "total_spent": 0,
            "total_paid": 0,
            "updated_at": "2019-08-29T09:14:54Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "foo@example.com",
        "financial_status": "pending",
        "fulfillments": [
            {
                "created_at": "2019-08-29T09:14:53.191Z",
                "id": 1013643280,
                "order_id": 1078596404,
                "receipt": null,
                "status": "success",
                "tracking_company": null,
                "tracking_company_code": null,
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": null,
                "tracking_urls": [],
                "updated_at": "2019-08-29T09:14:53.191Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Chưa hoàn thành",
                        "grams": 0,
                        "id": 1089840050,
                        "price": 200000,
                        "product_id": 1021300008,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": "tét",
                        "title": "test 2.1",
                        "variant_id": 1043013721,
                        "variant_title": "Default Title",
                        "vendor": "testnxs",
                        "name": "test 2.1",
                        "variant_inventory_management": "haravan",
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Đã giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "delivered",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": null,
                "ready_to_pick_date": null,
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": null,
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": null,
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": null,
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": null,
        "gateway": null,
        "gateway_code": null,
        "id": 1078596404,
        "landing_site": null,
        "landing_site_ref": null,
        "source": null,
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "notfulfilled",
                "grams": 0,
                "id": 1089840050,
                "price": 200000,
                "price_original": 200000,
                "price_promotion": 0,
                "product_id": 1021300008,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "tét",
                "title": "test 2.1",
                "variant_id": 1043013721,
                "variant_title": "Default Title",
                "vendor": "testnxs",
                "type": "testloai",
                "name": "test 2.1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100003",
        "note": null,
        "number": 1078596404,
        "order_number": "#100003",
        "processing_method": null,
        "referring_site": null,
        "refunds": [],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": null,
        "subtotal_price": 200000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "total_discounts": 0,
        "total_line_items_price": 200000,
        "total_price": 200000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T09:30:20.092Z",
        "transactions": [
            {
                "amount": 200000,
                "authorization": null,
                "created_at": "2019-08-29T09:14:53.361Z",
                "device_id": null,
                "gateway": "",
                "id": 1030353776,
                "kind": "pending",
                "order_id": 1078596404,
                "receipt": null,
                "status": null,
                "test": false,
                "user_id": 200000126886,
                "location_id": 686975,
                "payment_details": null,
                "parent_id": null,
                "currency": "VND",
                "haravan_transaction_id": null,
                "external_transaction_id": null,
                "send_email": false
            }
        ],
        "note_attributes": [],
        "confirmed_at": null,
        "closed_status": "closed",
        "cancelled_status": "uncancelled",
        "confirmed_status": "unconfirmed",
        "user_id": 200000126886,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

422

{"errors": "Đơn hàng không tồn tại"}

7. API cập nhật trạng thái hủy đơn hàng

- API giúp hủy 1 đơn hàng

7.1 Request

Method

URL

POST

https://apis.haravan.com/com/orders/#{order_id}/cancel.json

Header:  Authorization: Bearer + access_token 

7.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024021320,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": "other",
        "cancelled_at": "2019-08-29T09:33:24.074Z",
        "cart_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "checkout_token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": "2019-08-29T09:30:20.087Z",
        "created_at": "2019-08-29T09:14:52.98Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T09:12:54.258Z",
            "default_address": null,
            "email": "foo@example.com",
            "phone": null,
            "first_name": null,
            "id": 1024021320,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": 1078596404,
            "last_order_name": "#100003",
            "note": null,
            "orders_count": 1,
            "state": "Disabled",
            "tags": null,
            "total_spent": 0,
            "total_paid": 0,
            "updated_at": "2019-08-29T09:33:25Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "foo@example.com",
        "financial_status": "pending",
        "fulfillments": [
            {
                "created_at": "2019-08-29T09:14:53.191Z",
                "id": 1013643280,
                "order_id": 1078596404,
                "receipt": null,
                "status": "success",
                "tracking_company": null,
                "tracking_company_code": null,
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": null,
                "tracking_urls": [],
                "updated_at": "2019-08-29T09:33:24.25Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Chưa hoàn thành",
                        "grams": 0,
                        "id": 1089840050,
                        "price": 200000,
                        "product_id": 1021300008,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": "tét",
                        "title": "test 2.1",
                        "variant_id": 1043013721,
                        "variant_title": "Default Title",
                        "vendor": "testnxs",
                        "name": "test 2.1",
                        "variant_inventory_management": "haravan",
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Hủy giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "cancel",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": null,
                "ready_to_pick_date": null,
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": null,
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": "2019-08-29T09:33:24.178Z",
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": null,
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": null,
        "gateway": null,
        "gateway_code": null,
        "id": 1078596404,
        "landing_site": null,
        "landing_site_ref": null,
        "source": null,
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "notfulfilled",
                "grams": 0,
                "id": 1089840050,
                "price": 200000,
                "price_original": 200000,
                "price_promotion": 0,
                "product_id": 1021300008,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "tét",
                "title": "test 2.1",
                "variant_id": 1043013721,
                "variant_title": "Default Title",
                "vendor": "testnxs",
                "type": "testloai",
                "name": "test 2.1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100003",
        "note": null,
        "number": 1078596404,
        "order_number": "#100003",
        "processing_method": null,
        "referring_site": null,
        "refunds": [
            {
                "created_at": "2019-08-29T09:33:24.087Z",
                "id": 1003553931,
                "note": "",
                "refund_line_items": null,
                "restock": null,
                "user_id": 200000126886,
                "order_id": 1078596404,
                "transactions": []
            }
        ],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": null,
        "subtotal_price": 200000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "7a1d0edb8e6f42878291c2d1b724d6d3",
        "total_discounts": 0,
        "total_line_items_price": 200000,
        "total_price": 200000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T09:33:24.086Z",
        "transactions": [
            {
                "amount": 200000,
                "authorization": null,
                "created_at": "2019-08-29T09:14:53.361Z",
                "device_id": null,
                "gateway": "",
                "id": 1030353776,
                "kind": "pending",
                "order_id": 1078596404,
                "receipt": null,
                "status": null,
                "test": false,
                "user_id": 200000126886,
                "location_id": 686975,
                "payment_details": null,
                "parent_id": null,
                "currency": "VND",
                "haravan_transaction_id": null,
                "external_transaction_id": null,
                "send_email": false
            }
        ],
        "note_attributes": [],
        "confirmed_at": null,
        "closed_status": "closed",
        "cancelled_status": "cancelled",
        "confirmed_status": "unconfirmed",
        "user_id": 200000126886,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

422

{"errors": "Đơn hàng không tồn tại"}

8. API cập nhật trạng thái xác thực đơn hàng

- API giúp xác thực 1 đơn hàng

8.1 Request

Method

URL

POST

https://apis.haravan.com/com/orders/#{order_id}/confirm.json

Header:  Authorization: Bearer + access_token 

8.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024021320,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": null,
        "cancelled_at": null,
        "cart_token": "c61143e43ee846ba9104418ec493c64e",
        "checkout_token": "c61143e43ee846ba9104418ec493c64e",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": null,
        "created_at": "2019-08-29T09:37:08.268Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T09:12:54.258Z",
            "default_address": null,
            "email": "foo@example.com",
            "phone": null,
            "first_name": null,
            "id": 1024021320,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": 1078600208,
            "last_order_name": "#100007",
            "note": null,
            "orders_count": 2,
            "state": "Disabled",
            "tags": null,
            "total_spent": 0,
            "total_paid": 0,
            "updated_at": "2019-08-29T09:37:09Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "foo@example.com",
        "financial_status": "pending",
        "fulfillments": [
            {
                "created_at": "2019-08-29T09:37:08.369Z",
                "id": 1013643961,
                "order_id": 1078600208,
                "receipt": null,
                "status": "success",
                "tracking_company": null,
                "tracking_company_code": null,
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": null,
                "tracking_urls": [],
                "updated_at": "2019-08-29T09:37:08.369Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Chưa hoàn thành",
                        "grams": 0,
                        "id": 1089846532,
                        "price": 200000,
                        "product_id": 1021300008,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": "tét",
                        "title": "test 2.1",
                        "variant_id": 1043013721,
                        "variant_title": "Default Title",
                        "vendor": "testnxs",
                        "name": "test 2.1",
                        "variant_inventory_management": "haravan",
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Đã giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "delivered",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": null,
                "ready_to_pick_date": null,
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": null,
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": null,
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": null,
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": null,
        "gateway": null,
        "gateway_code": null,
        "id": 1078600208,
        "landing_site": null,
        "landing_site_ref": null,
        "source": null,
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "notfulfilled",
                "grams": 0,
                "id": 1089846532,
                "price": 200000,
                "price_original": 200000,
                "price_promotion": 0,
                "product_id": 1021300008,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "tét",
                "title": "test 2.1",
                "variant_id": 1043013721,
                "variant_title": "Default Title",
                "vendor": "testnxs",
                "type": "testloai",
                "name": "test 2.1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100007",
        "note": null,
        "number": 1078600208,
        "order_number": "#100007",
        "processing_method": null,
        "referring_site": null,
        "refunds": [],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": null,
        "subtotal_price": 200000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "c61143e43ee846ba9104418ec493c64e",
        "total_discounts": 0,
        "total_line_items_price": 200000,
        "total_price": 200000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T09:37:23.852Z",
        "transactions": [
            {
                "amount": 200000,
                "authorization": null,
                "created_at": "2019-08-29T09:37:08.454Z",
                "device_id": null,
                "gateway": "",
                "id": 1030355390,
                "kind": "pending",
                "order_id": 1078600208,
                "receipt": null,
                "status": null,
                "test": false,
                "user_id": 200000126886,
                "location_id": 686975,
                "payment_details": null,
                "parent_id": null,
                "currency": "VND",
                "haravan_transaction_id": null,
                "external_transaction_id": null,
                "send_email": false
            }
        ],
        "note_attributes": [],
        "confirmed_at": "2019-08-29T09:37:23.848Z",
        "closed_status": "unclosed",
        "cancelled_status": "uncancelled",
        "confirmed_status": "confirmed",
        "user_id": 200000126886,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

422

{"errors": "Đơn hàng không tồn tại"}

9. API cập nhật tags

- API giúp xác thực 1 đơn hàng

9.1 Request

Method

URL

POST

https://apis.haravan.com/admin/orders/#{order_id}.json

Header:  Authorization: Bearer + access_token 

9.2 Response

Status

Response

200

{
    "order": {
        "billing_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "id": 1024021320,
            "last_name": null,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "default": true,
            "district": null,
            "district_code": null,
            "ward": null,
            "ward_code": null
        },
        "browser_ip": null,
        "buyer_accepts_marketing": false,
        "cancel_reason": null,
        "cancelled_at": null,
        "cart_token": "c61143e43ee846ba9104418ec493c64e",
        "checkout_token": "c61143e43ee846ba9104418ec493c64e",
        "client_details": {
            "accept_language": null,
            "browser_ip": null,
            "session_hash": null,
            "user_agent": null,
            "browser_height": null,
            "browser_width": null
        },
        "closed_at": null,
        "created_at": "2019-08-29T09:37:08.268Z",
        "currency": "VND",
        "customer": {
            "accepts_marketing": false,
            "addresses": [],
            "created_at": "2019-08-29T09:12:54.258Z",
            "default_address": null,
            "email": "foo@example.com",
            "phone": null,
            "first_name": null,
            "id": 1024021320,
            "multipass_identifier": null,
            "last_name": null,
            "last_order_id": 1078600208,
            "last_order_name": "#100007",
            "note": null,
            "orders_count": 2,
            "state": "Disabled",
            "tags": null,
            "total_spent": 0,
            "total_paid": 0,
            "updated_at": "2019-08-29T09:37:09Z",
            "verified_email": false,
            "send_email_invite": false,
            "send_email_welcome": false,
            "password": null,
            "password_confirmation": null,
            "group_name": null,
            "birthday": null,
            "gender": null,
            "last_order_date": null
        },
        "discount_codes": [],
        "email": "foo@example.com",
        "financial_status": "pending",
        "fulfillments": [
            {
                "created_at": "2019-08-29T09:37:08.369Z",
                "id": 1013643961,
                "order_id": 1078600208,
                "receipt": null,
                "status": "success",
                "tracking_company": null,
                "tracking_company_code": null,
                "tracking_numbers": [],
                "tracking_number": null,
                "tracking_url": null,
                "tracking_urls": [],
                "updated_at": "2019-08-29T09:37:08.369Z",
                "line_items": [
                    {
                        "fulfillable_quantity": 0,
                        "fulfillment_service": "Thủ công",
                        "fulfillment_status": "Chưa hoàn thành",
                        "grams": 0,
                        "id": 1089846532,
                        "price": 200000,
                        "product_id": 1021300008,
                        "quantity": 1,
                        "requires_shipping": true,
                        "sku": "tét",
                        "title": "test 2.1",
                        "variant_id": 1043013721,
                        "variant_title": "Default Title",
                        "vendor": "testnxs",
                        "name": "test 2.1",
                        "variant_inventory_management": "haravan",
                        "properties": null,
                        "product_exists": false
                    }
                ],
                "notify_customer": false,
                "province": null,
                "province_code": null,
                "district": null,
                "district_code": null,
                "ward": null,
                "ward_code": null,
                "cod_amount": 0,
                "carrier_status_name": "Đã giao hàng",
                "carrier_cod_status_name": "Không",
                "carrier_status_code": "delivered",
                "carrier_cod_status_code": "none",
                "location_id": 686975,
                "shipping_package": 0,
                "note": null,
                "carrier_service_package": 0,
                "carrier_service_package_name": null,
                "is_new_service_package": false,
                "coupon_code": null,
                "ready_to_pick_date": null,
                "picking_date": null,
                "delivering_date": null,
                "delivered_date": null,
                "return_date": null,
                "not_meet_customer_date": null,
                "waiting_for_return_date": null,
                "cod_paid_date": null,
                "cod_receipt_date": null,
                "cod_pending_date": null,
                "cod_not_receipt_date": null,
                "cancel_date": null,
                "is_view_before": null,
                "country": null,
                "country_code": null,
                "zip_code": null,
                "city": null,
                "real_shipping_fee": 0,
                "shipping_notes": null,
                "total_weight": 0,
                "package_length": 0,
                "package_width": 0,
                "package_height": 0,
                "boxme_servicecode": null,
                "transport_type": 0,
                "address": null,
                "sender_phone": null,
                "sender_name": null,
                "carrier_service_code": null,
                "from_longtitude": 0,
                "from_latitude": 0,
                "to_longtitude": 0,
                "to_latitude": 0,
                "sort_code": null
            }
        ],
        "fulfillment_status": "fulfilled",
        "tags": “Còn hàng,Đã giao”,
        "gateway": null,
        "gateway_code": null,
        "id": 1078600208,
        "landing_site": null,
        "landing_site_ref": null,
        "source": null,
        "line_items": [
            {
                "fulfillable_quantity": 0,
                "fulfillment_service": null,
                "fulfillment_status": "notfulfilled",
                "grams": 0,
                "id": 1089846532,
                "price": 200000,
                "price_original": 200000,
                "price_promotion": 0,
                "product_id": 1021300008,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "tét",
                "title": "test 2.1",
                "variant_id": 1043013721,
                "variant_title": "Default Title",
                "vendor": "testnxs",
                "type": "testloai",
                "name": "test 2.1 - Default Title",
                "gift_card": false,
                "taxable": true,
                "tax_lines": null,
                "product_exists": true,
                "barcode": null,
                "properties": null,
                "total_discount": 0,
                "applied_discounts": [],
                "image": null,
                "not_allow_promotion": false,
                "ma_cost_amount": 0
            }
        ],
        "name": "#100007",
        "note": null,
        "number": 1078600208,
        "order_number": "#100007",
        "processing_method": null,
        "referring_site": null,
        "refunds": [],
        "shipping_address": {
            "address1": null,
            "address2": null,
            "city": null,
            "company": null,
            "country": "Vietnam",
            "first_name": null,
            "last_name": null,
            "latitude": 0,
            "longitude": 0,
            "phone": null,
            "province": null,
            "zip": null,
            "name": " ",
            "province_code": null,
            "country_code": "VN",
            "district_code": null,
            "district": null,
            "ward_code": null,
            "ward": null
        },
        "shipping_lines": [
            {
                "code": null,
                "price": 0,
                "source": null,
                "title": null
            }
        ],
        "source_name": null,
        "subtotal_price": 200000,
        "tax_lines": null,
        "taxes_included": false,
        "token": "c61143e43ee846ba9104418ec493c64e",
        "total_discounts": 0,
        "total_line_items_price": 200000,
        "total_price": 200000,
        "total_tax": 0,
        "total_weight": 0,
        "updated_at": "2019-08-29T09:37:23.852Z",
        "transactions": [
            {
                "amount": 200000,
                "authorization": null,
                "created_at": "2019-08-29T09:37:08.454Z",
                "device_id": null,
                "gateway": "",
                "id": 1030355390,
                "kind": "pending",
                "order_id": 1078600208,
                "receipt": null,
                "status": null,
                "test": false,
                "user_id": 200000126886,
                "location_id": 686975,
                "payment_details": null,
                "parent_id": null,
                "currency": "VND",
                "haravan_transaction_id": null,
                "external_transaction_id": null,
                "send_email": false
            }
        ],
        "note_attributes": [],
        "confirmed_at": "2019-08-29T09:37:23.848Z",
        "closed_status": "unclosed",
        "cancelled_status": "uncancelled",
        "confirmed_status": "confirmed",
        "user_id": 200000126886,
        "device_id": null,
        "location_id": 686975,
        "ref_order_id": 0,
        "ref_order_number": null,
        "confirm_user": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "redeem_model": null
    }
}

401

Unauthorized

403

Forbidden

422

{"errors": "Đơn hàng không tồn tại"}

10. Những lưu ý khi đồng bộ đơn hàng

10.1 Đơn hàng có mã khuyến mãi

- Khi đồng bộ đơn hàng khuyến mãi từ hệ thống khác về Haravan, cần bổ sung thêm những thông tin sau để Haravan ghi nhận và giảm giá tương ứng.

- VD : ta có một một object dùng để post tạo đơn hàng

{
  "order": {
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ],
    "total_discounts": 10000             
    "discount_codes": [
        {
            "amount": 10000,                      
            "code": "test",                            
            "is_coupon_code": false
        }
     ]
  }
}

STT

Thuộc tính

Mô tả

1

total_discounts (number)

Tổng giá trị khuyến mãi trên đơn hàng

2

discount_codes (array)

Có được hiển thị hay không

3

amount (number)

Tiền khuyến mãi

4

code (string)

Mã khuyến mãi

5

is_coupon_code (boolean)

Loại khuyến mãi:
false: Là chương trình khuyến mãi thì sẽ ghi nhận code luôn không check
true: Là khuyến mãi coupon hệ thống sẽ check code phải có tồn tại trong danh sách khuyến mãi

10.2 Map địa chỉ khi đồng bộ đơn hàng

- Khi đồng bộ đơn hàng từ hệ thống khác về Haravan, cần map thông tin địa chỉ đúng theo các field tương ứng.

- VD : ta có một một object dùng để post tạo đơn hàng

{
    "order": {
        "billing_address": {
             ….
            "ward": "Phường 15",
            "ward_code": "27208",
            "district": "Quận 11",
            "district_code": "HC476",
            "province": "Hồ Chí Minh",
            "province_code": "HC",
            "address1": "123 abc",
     },
        "shipping_address": {
             ….
            "ward": "Phường 15",
            "ward_code": "27208",
            "district": "Quận 11",
            "district_code": "HC476",
            "province": "Hồ Chí Minh",
            "province_code": "HC",
            "address1": "123 abc",
     },
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ]
}

STT

Thuộc tính

Mô tả

1

Ward (string)

Phường/xã

2

ward_code (string)

Mã phường/xã

3

district (string)

Quận/huyện

4

district_code (string)

Mã quận/huyện

5

province (string)

Tỉnh/thành

6

province_code (string)

Mã tỉnh/thành

7

address1 (string)

Địa chỉ

10.3 Đơn hàng có sử dụng cod

- Khi đồng bộ đơn hàng sử dụng cod từ hệ thống khác về Haravan, cần truyền thêm thông tin tương ứng để Haravan ghi nhận

- VD : ta có một một object dùng để post tạo đơn hàng

{
  "order": {
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ],
    is_cod_gateway = true
  }
}

STT

Thuộc tính

Mô tả

1

is_cod_gateway (boolean)

Có sử dụng cod hay không