Thuộc tính
Các cặp khóa/giá trị JSON trong thân yêu cầu
POST https://api.iglobalstores.com/v1/createTempCart
trường | ghi chú |
---|---|
boxCount | Giá trị ví dụ: 22x15x15(1),8x8x4(2),32x22x14(1) Định dạng: Danh sách kích thước hộp và số lượng cách nhau bằng dấu phẩy. Trong ví dụ trên, có tổng cộng 4 hộp. Hộp đầu tiên trong danh sách sẽ dài 22 inch, rộng 15 inch và cao 15 inch. Chỉ có một hộp được sử dụng cho kích thước đó. Sẽ có hai hộp kích thước: 8x8x4 inch. Có thể truyền cùng một kích thước hộp nhiều lần nếu điều đó dễ dàng cho bạn, như thế này: “22x15x15(1),22x15x15(1)”, có nghĩa là 2 hộp kích thước: 22x15x15 inch. Trường này mô tả các hộp sẽ được sử dụng để vận chuyển đơn hàng. Không mong đợi rằng một thương nhân biết điều này vào thời điểm đặt hàng; tuy nhiên, nếu đã biết, nó có thể được truyền theo định dạng string . |
contShoppingURL | Trường này được sử dụng để truyền một URL để ghi đè HREF của nút “Tiếp tục mua sắm” bên trong Zonos Checkout. string |
domesticShippingCharge | Trường này được sử dụng để truyền một khoản phí vận chuyển nội địa đến Zonos Checkout, và số tiền sẽ được thêm vào phí vận chuyển. Điều này có thể được cấu hình để thêm tổng phí vận chuyển hoặc được tách ra như một mục riêng biệt. số dương dấu phẩy động, hai chữ số thập phân |
externalConfirmationPageURL | Trường này được sử dụng để truyền một URL của trang xác nhận đơn hàng / cảm ơn bạn. Sau khi khách hàng hoàn tất thanh toán bên trong Zonos Checkout, họ sẽ được chuyển hướng đến URL này để xác nhận đơn hàng. URL này thường được sử dụng để kích hoạt một cuộc gọi đến điểm cuối dịch vụ API “orderDetail” của Zonos để lấy chi tiết đơn hàng và nhập đơn hàng vào hệ thống. string |
footerHTML | Trường này được sử dụng để truyền một chuỗi HTML được mã hóa URL. Chuỗi HTML này sẽ được giải mã và đặt trước thẻ đóng body trên trang checkout. Thường được sử dụng để truyền mã cho tiếp thị lại, phân tích, v.v. chuỗi mã hóa URL |
items BẮT BUỘC | Trường này là một danh sách các bản đồ mặt hàng. chuỗi JSON |
items[index].countryOfOrigin | Trường này được sử dụng để truyền quốc gia xuất xứ của mặt hàng. Tham số phải là mã quốc gia mã ISO hai chữ cái. string |
items[index].description BẮT BUỘC | Trường này được sử dụng để truyền một mô tả đầy đủ về mặt hàng trong dòng giỏ hàng, bao gồm bất kỳ tùy chọn, màu sắc, v.v. của mặt hàng. string |
items[index].height | Trường này được sử dụng để truyền chiều cao của mặt hàng và được khuyến nghị cao để có báo giá vận chuyển chính xác. Đơn vị chiều cao là BẮT BUỘC string - số dương dấu phẩy động, hai chữ số thập phân / số nguyên (inch) |
items[index].imageURL BẮT BUỘC | Trường này được sử dụng để truyền URL đến hình ảnh sản phẩm của mặt hàng. URL phải là HTTPS để hiển thị bên trong Zonos Checkout. string / URL HTTPS |
items[index]itemBrand | Trường này được sử dụng để truyền thương hiệu của mặt hàng string |
items[index]itemCategory | Trường này được sử dụng để truyền loại mặt hàng và có thể được truyền theo định dạng phân cách bằng ống nếu mặt hàng có nhiều loại. Giá trị ví dụ: “giày” hoặc “giày|giày thể thao|giày giảm giá” string |
items[index]itemCustomization | Trường này được sử dụng để truyền thêm chi tiết về mặt hàng mà không hiển thị trong Zonos Checkout; tuy nhiên, điều này có thể được truy xuất thông qua điểm cuối dịch vụ API “orderDetail”. |
items[index]itemHSCode | Trường này được sử dụng để truyền mã HS của mặt hàng và có thể có hoặc không có dấu chấm. Giá trị ví dụ: “3926901000” hoặc “3926.90.1000” string |
items[index].itemURL | Trường này được sử dụng để truyền URL đến trang sản phẩm của mặt hàng. string / URL |
items[index].length | Trường này được sử dụng để truyền chiều dài của mặt hàng và được khuyến nghị cao để có báo giá vận chuyển chính xác. Đơn vị chiều dài là BẮT BUỘC string - số thực dương, hai chữ số thập phân / số nguyên (inch) |
items[index].nonShippable | Trường này được sử dụng để chỉ định xem mặt hàng có nên được bao gồm trong các tính toán vận chuyển, thuế và phí hay không. Tải xuống kỹ thuật số, mã giảm giá, phí xử lý, v.v. nên được truyền với giá trị “true”. boolean: true or false |
items[index].productId | Trường này được sử dụng để truyền số lượng mặt hàng. string |
items[index].quantity BẮT BUỘC | Trường này được sử dụng để truyền số lượng mặt hàng. string |
items[index].sku | Trường này được sử dụng để truyền SKU / UPC / v.v. của mặt hàng. string |
items[index].unitPrice BẮT BUỘC | Trường này được sử dụng để truyền giá đơn vị của mặt hàng. số thực dương, hai chữ số thập phân / số nguyên |
items[index].weight | Trường này được sử dụng để truyền trọng lượng của mặt hàng và được khuyến nghị cao để có báo giá vận chuyển chính xác. Đơn vị trọng lượng mặc định là “LBS” trừ khi một đơn vị trọng lượng khác được truyền trong items[index].itemWeightUnits``string - số thực dương, hai chữ số thập phân / số nguyên |
items[index].weightUnits | Trường này được sử dụng để ghi đè các đơn vị trọng lượng mặc định của mặt hàng. Đơn vị trọng lượng của mặt hàng mặc định là “LBS” trừ khi một đơn vị trọng lượng khác được truyền trong trường này. string - "LB", "OZ", "KG", hoặc "G” |
items[index].width | Trường này được sử dụng để truyền chiều rộng của mặt hàng và được khuyến nghị cao để có báo giá vận chuyển chính xác. Đơn vị chiều rộng là BẮT BUỘC string - số thực dương, hai chữ số thập phân / số nguyên (inch) |
misc1 - misc6 | Trường này được sử dụng để truyền dữ liệu khác liên quan đến đơn hàng thông qua API Zonos để được truy xuất cùng với dữ liệu đơn hàng trả về từ điểm cuối dịch vụ API “orderDetail” của Zonos. string |
referenceId | Trường này được sử dụng để truyền một giá trị nhận dạng tham chiếu duy nhất cho giỏ hàng/session/v.v. trong hệ thống của bạn. Điều này có thể được sử dụng để tra cứu ID đơn hàng Zonos thông qua điểm cuối dịch vụ API “orderDetail” của Zonos. string |
storeId BẮT BUỘC | ID cửa hàng được cung cấp bởi Zonos. số nguyên |
Các loại dữ liệu chuỗi bổ sung
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Giảm giá, phiếu giảm giá và mã khuyến mãi
Để gửi giảm giá, phiếu giảm giá và mã khuyến mãi đến Zonos thông qua bài đăng máy chủ, chúng phải được truyền dưới dạng một mặt hàng riêng biệt với giá trị âm cho các tham số: “unitPrice”
và “nonShippable”:true
.
VÍ DỤ BẢN ĐỒ GIẢM GIÁ
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
Phản hồi HTTPS
Phản hồi HTTP thành công
Định dạng tin nhắn: JSON
VÍ DỤ PHẢN HỒI THÀNH CÔNG
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Định nghĩa JSON phản hồi
trường | ghi chú |
---|---|
tempCartUUID | Tham số này sẽ chứa một GUID được gán cho giỏ hàng quốc tế của khách hàng của bạn và được tạo trong hệ thống Zonos. Trường này sẽ được truyền qua tham số chuỗi string trong URL khi chuyển hướng trình duyệt của người dùng đến Zonos Checkout. |
Phản hồi HTTP lỗi
Mã lỗi | nghĩa |
---|---|
400 | Ký tự không mong đợi trong thân yêu cầu. |
406 | Không chấp nhận. Tiêu đề HTTP cho “Accept” không hợp lệ. |
415 | Loại phương tiện không được hỗ trợ. Tiêu đề HTTP cho “Content-Type” không hợp lệ. |
422 | Thực thể không thể xử lý. |
500 | “storeId” không chính xác hoặc thân JSON không thể được phân tích. |
VÍ DỤ PHẢN HỒI LỖI
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Error 422 Unprocessable Entity</title>
</head>
<body>
<h2>HTTP ERROR 422</h2>
<p>
Problem accessing /v2/createTempCart. Reason:
<pre>Unprocessable Entity</pre>
</p>
<h2>The request entity had the following errors:</h2>
<ul>
<li>items may not be empty (was null)</li>
<li>items may not be null (was null)</li>
</ul>
</body>
</html>
Chuyển hướng đến Zonos Checkout
Sau khi nhận được phản hồi thành công chứa tempCartUUID
, máy chủ của bạn sẽ gửi một yêu cầu chuyển hướng từ trình duyệt của khách hàng đến Zonos Checkout với các tham số chuỗi truy vấn URL phù hợp được đề cập dưới đây.
Ví dụ URL chuyển hướng: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Lưu ý: [yourassignedsubdomain] - Liên hệ với thành viên nhóm triển khai Zonos của bạn để nhận subdomain Zonos.com của bạn.
Tham số yêu cầu URL
trường | ghi chú |
---|---|
tempCartUUID BẮT BUỘC | Giá trị này được lấy bằng cách gọi điểm cuối dịch vụ API createTempCart của Zonos. string / GUID |
country | Mã ISO hai chữ cái của quốc gia đích. Chúng tôi rất khuyến nghị truyền tham số này để cải thiện trải nghiệm người dùng. Tham số country sẽ tự động chọn quốc gia đích bên trong Zonos Checkout. Khi sử dụng Zonos Hello JS (JavaScript) trên trang, bạn có thể lấy giá trị này bằng cách gọi phương thức JavaScript: zonos.country() . string (Độ dài: 2) |
Các kiểu dữ liệu chuỗi bổ sung
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Tạo một checkout
Khám phá các cặp khóa/giá trị liên quan đến việc tạo một checkout.
Điểm cuối API này được sử dụng để gửi thông tin giỏ hàng và mặt hàng từ giỏ hàng của khách hàng đến API Zonos.
Bạn sẽ nhận được một phản hồi JSON chứa
tempCartUUID
, một định danh giỏ hàng duy nhất trong Hệ thống Zonos. Điều này sẽ được sử dụng để chuyển hướng khách hàng đến Zonos Checkout để hoàn tất đơn hàng.