Các thuộc tính của Order

billing_address

{ "address1" : "123 Amoebobacterieae St" }

{ "address2" : "" }

{ "city" : "Ottawa" }

{ "company" : "null" }

{ "country" : "US" }

{ "first_name" : "null" }

{ "id" : 207119551 }

{ "last_name" : "null" }

{ "phone" : "(555)555-5555" }

{ "province" : "KY" }

{ "zip" : "40202" }

{ "name" : "null" }

{ "province_code" : "null" }

{ "country_code" : "null" }

{ "default" : true }

Địa chỉ thanh toán. Địa chỉ này là một trường tùy chọn, có thể không có trong Order. Các thuộc tính:

• address1: Địa chỉ thanh toán.
• address2: Địa chỉ thanh toán khác.
• city: Thành phố.
• company: Công ty của người thực hiện thanh toán.
• country: Quốc gia.
• country_code: Mã quốc gia theo chuẩn (ISO 3166-1 alpha-3).
• first_name: Tên của người thanh toán.
• last_name: Họ của người thanh toán.
• name: Họ và tên người thanh toán.
• phone: Điện thoại.
• province: Tỉnh thành.
• province_code: Mã tỉnh thành.
• zip: Mã bưu điện.

browser_ip

{ "browser_ip" : "null" }

Địa chỉ IP thực hiện đặt hàng.

buyer_accepts_marketing

{ "buyer_accepts_marketing" : false }

Xác định người mua hàng có muốn nhận các email marketing từ Shop hay không. Giá trị hợp lệ là "true" hoặc "false."

cancel_reason

{ "cancel_reason" : "null" }

Lý do Order bị hủy. Nếu Order không bị hủy, trường này có giá trị "null". Nếu Order bị hủy, giá trị của trường này có thể là:

• customer: Khách hàng thay đổi hoặc hủy Order.
• fraud: Order này là gian lận.
• inventory: Item của Order không có trong kho.
• other: Order bị hủy không phải do một trong các lí do trên.

cancelled_on

{ "cancelled_on" : "null" }

Thời gian Order bị hủy. Nếu Order bị hủy, API trả về kết quả theo định dạng chuẩn ISO 8601. Nếu Order không bị hủy, giá trị sẽ là "null".

cart_token

{ "cart_token" : "68778783ad298f1c80c3bafcddeea" }

Chuỗi token duy nhất định danh cho một cart ứng với một Order xác định.

client_details

{ "accept_language" : "null" }

{ "browser_height" : "null" }

{ "browser_ip" : "0.0.0.0" }

{ "browser_width" : "null" }

{ "session_hash" : "null" }

{ "user_agent" : "null" }

Một đối tượng chứa thông tin về client:

• accept_language:
• browser_height: Chiều cao màn hình browser (nếu có).
• browser_ip: Địa chỉ IP.
• browser_width: Độ rộng màn hình browser (nếu có).
• session_hash: Một mã băm của phiên đăng nhập.
• user_agent

closed_on

{ "closed_on" : "null" }

Thời gian Order được lưu trữ. API trả về kết quả theo định dạng chuẩn ISO 8601. Nếu Order không được lưu trữ, giá trị của trường này là null.

created_on

{ "created_on" : "2008-01-10T11:00:00Z" }

Thời gian Order được tạo. API trả về kết quả theo định dạng chuẩn ISO 8601. Thuộc tính này được tạo tự động và không thể chỉnh sửa. Nếu bạn import Order từ một hệ thống khác vào Sapo thì hãy sử dụng thuộc tính có thể ghi processed_on để xác định thời gian Order được xử lý.

currency

{ "currency" : "USD" }

Mã tiền tệ được sử dụng trong thanh toán (ISO 4217).

customer

{ "accepts_marketing" : false }

{ "created_on" : "2012-03-13T16:09:55Z" }

{ "email" : "[email protected]" }

{ "first_name" : "Bob" }

{ "id" : 207119551 }

{ "last_name" : "Norman" }

{ "note" : "null" }

{ "last_name" : "null" }

{ "orders_count" : "0" }

{ "state" : "null" }

{ "total_spent" : "0.00" }

{ "modified_on" : "2012-03-13T16:09:55Z" }

{ "tags" : "tagcity" }

Một đối tượng chứa thông tin của Customer. Lưu ý rằng Order có thể không có Customer và người mua không nên phụ thuộc vào một đối tượng Customer có sẵn. Đối tượng này có thể null

• accepts_marketing: Xác định Customer có muốn nhận email marketing từ Shop hay không. Giá trị hợp lệ là "true" hoặc "false".
• created_on: Thời gian Customer được tạo.
• email: Địa chỉ email của Customer.
• first_name: Tên của Customer.
• order_id: Số duy nhất định danh cho Customer.
• last_name: Họ của Customer.
• note: Thông tin thêm về Customer
• orders_count: Số lượng Order được đặt bởi Customer
• state:
• total_spent:
• modified_on: Thời gian Customer được cập nhật lần cuối.
• tags: Các thẻ mô tả ngắn, thường được dùng cho mục đích lọc và tìm kiếm, được định dạng như một chuỗi ký tự cách nhau bởi dấu phẩy. Ví dụ: tag1, tag2, tag3.

discount_codes

{ "discount_codes" : "[]" }

Mã Discount được áp dụng cho Order. Nếu không có mã Discount thì trường này giá trị rỗng.

• amount: Số lượng giảm giá ứng với Discount.
• code: Mã Discount.
• type: Loại Discount. Có thể một trong các giá trị: "percentage", "shipping", "fixed_amount" (mặc định).

email

{ "email" : "[email protected]" }

Địa chỉ Email của Customer. Trường này phải có khi Order có địa chỉ thanh toán.

financial_status

{ "financial_status" : "authorized" }

• pending: Việc thanh toán đang tạm hoãn.
• authorized: Việc thanh toán đã được xác thực.
• partially_paid: Đã thanh toán được một phần.
• paid: Order đã được thanh toán (đây là giá trị mặc định).
• partially_refunded: Order đã được hoàn trả một phần.
• refunded: Order đã được hoàn trả toàn bộ.
• voided: Việc thanh toán đã bị vô hiệu.

status

{ "status" : "open" }

• open: Đơn hàng mở.
• closed: Đơn hàng được lưu trữ.
• cancelled: Đơn hàng bị hủy.

fulfillments

{ "created_on" : "2012-03-13T16:09:54Z" }

{ "id" : 255858046 }

{ "order_id" : 450789469 }

{ "status" : "failure" }

{ "tracking_company" : "null" }

{ "tracking_number" : "1Z2345" }

{ "modified_on" : "2012-05-01T14:22:25Z" }

• created_on: Thời gian Fulfilment được tạo. API trả về kết quả theo định dạng chuẩn ISO 8601.
• id: Số duy nhất định danh cho Fulfillment.
• line_items: Bản ghi thông tin các item trong Fulfillment.
• order_id: Số duy nhất định danh Order.
• receipt: Thông tin hóa đơn.
• status: Trạng thái của Fulfillment.
• tracking_company: Tên công ty vận chuyển.
• tracking_number: Mã vận chuyển, được cung cấp bởi công ty vận chuyển.
• modified_on: Thời gian Fulfillment được cập nhật lần cuối. API trả về kết quả theo định dạng chuẩn ISO 8601.

fulfillment_status

{ "fulfillment_status" : "null" }

• fulfilled: Mọi line item trong Order đã được giao toàn bộ.
• null: Chưa một line item nào của Order được giao.
• partial: Order được giao một phần.

tags

{ "tags" : "tagsational" }

Tags là các thẻ mô tả ngắn, thường được sử dụng cho mục đích lọc và tìm kiếm, được định dạng như một xâu ký tự cách nhau bởi dấu phẩy. Ví dụ: tag1, tag2, tag3. Mỗi một tag giới hạn 40 ký tự.

id

{ "id" : 450789469 }

Số duy nhất định danh Order. Id này được dùng cho API. Giá trị này khác với thuộc tính order_number (xem bên dưới), cũng là một số duy nhất để định danh Order nhưng mục đích sử dụng là dành cho chủ Shop và Customer.

landing_site

{ "landing_site" : "http://www.example.com?source=abc" }

Địa chỉ URL của trang từ đó người mua truy cập vào Shop.

line_items

{ "fulfillable_quantity" : 1 }

{ "fulfillment_service" : "amazon" }

{ "fulfillment_status" : "fulfilled" }

{ "grams" : 500 }

{ "id" : 669751112 }

{ "price" : "199.99" }

{ "product_id" : 7513594 }

{ "quantity" : 1 }

{ "requires_shipping" : true }

{ "sku" : "IPOD-342-N" }

{ "title" : "IPod Nano" }

{ "variant_id" : 4264112 }

{ "variant_title" : "Pink" }

{ "vendor" : "Apple" }

{ "name" : "IPod Nano - Pink" }

{ "gift_card" : false }

{ "taxable" : true }

{ "tax_lines" : "[]" }

{ "total_discount" : "5.00" }

Danh sách các đối tượng line item, mỗi đối tượng chứa thông tin về một item trong Order. Mỗi line_item có các thuộc tính sau:

• fulfillable_quantity: Số lượng còn phải giao hàng.
• fulfillment_service: Nhà cung cấp dịch vụ giao vận. Các giá trị hợp lệ là: "manual" hoặc tên của nhà cung cấp dịch vụ, ví dụ: "amazon", "shipwire"...
• fulfillment_status: Trạng thái giao vận. Các giá trị hợp lệ là: fulfilled, null hoặc partial.
• grams: Khối lượng của item theo đơn vị gram.
• id: Id của line item.
• price: Giá của item trước khi mã Discount được áp dụng.
• product_id: Số duy nhất định danh Product trong Fulfillment. Giá trị này có thể null nếu như Product gốc tương ứng đã bị xóa
• quantity: Số lượng Product đã được mua.
• requires_shipping: Xác định việc Fulfillment có cần giao hàng hay không. Các giá trị hợp lệ: true hoặc false.
• sku: Một mã duy nhất định danh cho item của Fulfillment.
• title: Tiêu đề của Product.
• variant_id: Id của Product Variant.
• variant_title: Tiêu đề của Product Variant.
• vendor: Tên nhà phân phối item.
• name: Tên của Product Variant.
• total_discount: Tổng số tiền giảm giá cho line item.

name

{ "name" : "#1001" }

Tên của Order của khách hàng được biểu diễn bởi một số.

note

{ "note" : "null" }

Đoạn ghi chú được chủ Shop gắn kèm vào Order.

note_attributes

{ "note_attributes" : [{ "name" : "custom name" ,  "value" : "custom value" }] }

Các thông tin thêm được đưa vào Order.

number

{ "number" : "1" }

Số duy nhất định danh Order đối với Shop. Số này là số tự tăng và bắt đầu từ 1000.

order_number

{ "order_number" : 1001 }

Số duy nhất định danh Order. Số này được sử dụng bởi chủ Shop và khách hàng.

payment_gateway_names

{ "payment_gateway_names" : ["authorize_net", "Cash on Delivery (COD)"] }

Danh sách tất cả cổng thanh toán sử dụng cho Order.

processed_on

{ "processed_on" : "2008-01-10T11:00:00Z" }

Thời gian Order được nhập, theo định dạng chuẩn ISO 8601. Giá trị này có thể được đặt bằng một ngày trong quá khứ khi import Order từ một hệ thống khác. Nếu không có giá trị nào được cấp, nó sẽ tự sinh

processing_method

{ "processing_method" : "direct" }

Xác định loại của phương thức xử lý thanh toán. Các giá trị hợp lệ: checkout, direct, manual, offsite hoặc express.

referring_site

{ "referring_site" : "http://www.anexample.com" }

Website mà người dùng từ đó truy cập vào Shop.

refunds

Danh sách tất cả các Refund thực hiện trên Order.

shipping_address

{ "address1" : "123 Amoebobacterieae St" }

{ "address2" : "" }

{ "city" : "Ottawa" }

{ "company" : "null" }

{ "country" : "Canada" }

{ "first_name" : "Bob" }

{ "last_name" : "Bobsen" }

{ "latitude" : "45.41634" }

{ "longitude" : "-75.6868" }

{ "phone" : "555-625-1199" }

{ "province" : "Ontario" }

{ "zip" : "K2P0V6" }

{ "name" : "Bob Bobsen" }

{ "country_code" : "CA" }

{ "province_code" : "ON" }

Địa chỉ giao hàng của Order. Địa chỉ này là tùy chọn, có thể không có. Nó có các thuộc tính sau:

• address1: Địa chỉ giao hàng chính.
• address2: Địa chỉ giao hàng thêm.
• city: The city of the shipping address.
• company: Tên công ty của người nhận hàng.
• country: Tên quốc qua.
• country_code: Mã quốc gia gồm 3 ký tựThe two-letter code for the country of the shipping address.
• first_name: Tên của người nhận hàng.
• last_name: Họ của người nhận hàng.
• name: Họ tên đầy đủ của người nhận hàng.
• phone: Số điện thoại của người nhận hàng.
• province: Tên tỉnh thành của địa chỉ giao hàng.
• province_code: Mã tỉnh thành.
• zip: Mã bưu điện.

shipping_lines

{ "code" : "Free Shipping" }

{ "price" : 0.0 }

{ "source" : "bizweb" }

{ "title" : "Free Shipping" }

{ "tax_lines" : "[]" }

Một mảng các shipping_line, mỗi một Shipping line mô tả chi tiết về phương thức vận chuyển đã sử dụng, có các thuộc tính sau:

• code: Mã tham chiếu tới phương thức vận chuyển.
• price: Phí vận chuyển.
• source: Nguồn vận chuyển.
• title: Tên phương thức vận chuyển.

source_name

{ "source_name" : "web" }

Nơi Order được tạo. Chỉ có thể được thiết lập giá trị lúc tạo Order. Order được tạo thông qua các kênh chính thống của Sapo có các giá trị được bảo tồn mà không thể gán khi sử dụng API. Các giá trị đó là: "web", "pos", "iphone", and "android" Order được tạo qua API có thể gán bất cứ xâu nào khác mà bạn muốn. Nếu source_name không xác định thì Order được tạo ra sẽ có giá trị source_name là "api".

subtotal_price

{ "subtotal_price" : 398.0 }

Tổng giá của Order trước khi tính phí vận chuyển và thuế

token

{ "token" : "b1946ac92492d2347c6235b4d2611184" }

Chuỗi token duy nhất định danh cho Order.

total_discounts

{ "total_discounts" : "0.00" }

Tổng số tiền được giảm giá khi của Order.

total_line_items_price

{ "total_line_items_price" : "398.00" }

Tổng giá của tất cả các item trong Order.

total_price

{ "total_price" : "409.94" }

Tổng số tiền mà người dùng phải thanh toán cho Order.

total_weight

{ "total_weight" : 300 }

Tổng khối lượng của các line item trong Order, tính theo đơn vị gram.

modified_on

{ "modified_on" : "2012-08-24T14:02:15Z" }

Thời gian Order được cập nhật lần cuối. API trả về kết quả theo định dạng chuẩn ISO 8601.