Yêu cầu HTTPS là gì cho API Checkout?

Yêu cầu HTTPS cho API Checkout bao gồm phương thức HTTP (POST), điểm cuối ('https://api.iglobalstores.com/v2/orderDetail'), giao thức (HTTPS), định dạng thông báo (JSON) và tiêu đề HTTP (Accept: application/json, Content-Type: application/json).

Các cặp khóa/giá trị JSON trong phần thân yêu cầu là gì?

Các cặp khóa/giá trị JSON trong phần thân yêu cầu bao gồm 'orderId', 'referenceId', 'secret' và 'storeId'. 'orderId' và 'referenceId' là tùy chọn, nhưng phải chuyển một trong số chúng. 'secret' và 'storeId' là bắt buộc.

Các phản hồi lỗi HTTP có thể xảy ra là gì?

Các phản hồi lỗi HTTP có thể xảy ra bao gồm 415 (Loại phương tiện không được hỗ trợ), 406 (Không thể chấp nhận), 400 (Yêu cầu không hợp lệ) và 500 (Lỗi máy chủ nội bộ). Mỗi mã lỗi tương ứng với một loại lỗi cụ thể.

Các định nghĩa JSON phản hồi là gì?

Các định nghĩa JSON phản hồi bao gồm các tham số khác nhau liên quan đến chi tiết đơn hàng, chẳng hạn như 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' và nhiều tham số khác. Mỗi tham số cung cấp thông tin cụ thể về đơn hàng.

Checkout•

Trang chủTài liệu tham khảo API Checkout REST API Chi tiết đơn hàng

Chi tiết đơn hàng

Q: Điểm cuối API Checkout là gì?

Điểm cuối API Checkout là 'orderDetail'. Điểm cuối API này được sử dụng để truy xuất an toàn chi tiết đơn hàng và trạng thái của một đơn hàng được hoàn thành thông qua Zonos Checkout.

Tìm hiểu cách điểm cuối Chi tiết đơn hàng hoạt động.

Điểm cuối orderDetail được sử dụng để truy xuất an toàn chi tiết đơn hàng và trạng thái của một đơn hàng được hoàn thành thông qua Zonos Checkout.

Điểm cuối

Lưu ý: Các khóa phản hồi có thể được sửa đổi và/hoặc có thể thêm các khóa bổ sung. Nếu bạn sử dụng điểm cuối, vui lòng đặt mã của bạn để phù hợp với các khả năng này.

POST | `https://api.iglobalstores.com/v2/orderDetail`

Yêu cầu HTTPS

trường↕	ghi chú↕
Phương thức HTTP	POST
Điểm cuối	`https://api.iglobalstores.com/v2/orderDetail`
Giao thức	HTTPS
Định dạng thông báo	JSON
Tiêu đề HTTP Chấp nhận	Accept: application/json
Tiêu đề HTTP Content-Type	Content-Type: application/json

Cặp khóa/giá trị JSON trong phần thân yêu cầu

trường↕	ghi chú↕
`orderId` TÙY CHỌN, nếu chuyển tham số `referenceId`	ID đơn hàng Zonos có thể được chuyển cùng hoặc không có ID cửa hàng và dấu gạch ngang của bạn (Ví dụ: 123-45678 hoặc 45678). Lưu ý: Sau khi hoàn thành đơn hàng và thanh toán, khách hàng sẽ được chuyển hướng đến trang Hoàn thành Đơn hàng / Cảm ơn Đơn hàng được lưu trữ trên miền của bạn. URL sẽ chứa tham số chuỗi truy vấn "orderId" chứa giá trị này.`integer / string`
`referenceId` TÙY CHỌN, nếu chuyển tham số "orderId"	Tham số này được sử dụng để tra cứu dữ liệu của một đơn hàng theo `referenceId` duy nhất được chuyển trong điểm cuối dịch vụ API `createTempCart`. Tham số này nên bị bỏ qua hoặc null khi dự định tra cứu chi tiết đơn hàng dựa trên tham số `orderId`.`string`
`secret` BẮT BUỘC	GUID bí mật API được cung cấp bởi Zonos`string`
`storeId` BẮT BUỘC	ID Cửa hàng được cung cấp bởi Zonos.`integer`

Phản hồi lỗi HTTP

mã lỗi↕	thông báo↕	ý nghĩa↕
415	Loại phương tiện không được hỗ trợ	Thực thể HTML. Tiêu đề HTTP "Content-Type" không hợp lệ.
406	Không thể chấp nhận	Thực thể HTML. Tiêu đề HTTP "Accept" không hợp lệ.
400	Yêu cầu không hợp lệ	"error":"orderId: 999-99999 không phải là orderId hợp lệ""error":"Không tìm thấy đơn hàng có orderId: 999-99999""error":"Thông tin xác thực không hợp lệ""error":"Phần thân bài đăng không hợp lệ""error":"Tham số orderId hoặc referenceId bắt buộc""error":"Không thể chỉ định cả Tham số orderId và referenceId""error":"Không tìm thấy đơn hàng với orderId: 999-99999""error":"Tham số cửa hàng bắt buộc""error":"Không tìm thấy đơn hàng với referenceId: 999999 cho storeId: 999""error":"referenceId: 999999 cho storeId: 999 đã bị trùng lặp""error":"Không thể truy xuất đơn hàng với referenceId: 999999"
500	Lỗi máy chủ nội bộ	"error":"Không thể xử lý chi tiết đơn hàng"

Định nghĩa JSON phản hồi

trường↕	ghi chú↕
`error`	Tham số này chỉ xuất hiện khi có lỗi xảy ra và sẽ chứa mô tả lỗi.`string`
`order`	Đây là một bản đồ chi tiết đơn hàng.`JSON string`
`order.billingZip`	Địa chỉ thanh toán cho đơn hàng - các giá trị được nhập vào Zonos Checkout.`string`
`orderboxCount`	Trường này mô tả các hộp sẽ được sử dụng để vận chuyển đơn hàng, được chuyển vào yêu cầu createTempCart .`string`
`order.carrierAccountNumber`	Số tài khoản vận chuyển của khách truy cập; được sử dụng khi các tài khoản vận chuyển của khách truy cập được kích hoạt`string`
`order.carrierAccountShippingMethod`	Phương thức vận chuyển được chọn trên tài khoản vận chuyển của khách truy cập; được sử dụng khi các tài khoản vận chuyển của khách truy cập được kích hoạt`string`
`order.cslListMatch`	Kết hợp Danh sách Sàng lọc Hợp nhất (CSL). Một boolean cho biết khi thông tin khách hàng đã tạo ra một kết quả phù hợp trong Danh sách Sàng lọc Hợp nhất của Hoa Kỳ và nên được xem xét để có thể liên kết với bên bị từ chối.`boolean`
`order.customerSelectedShippingName`	Tên hiển thị tùy chọn vận chuyển bên trong Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Một bản đồ của bảng phân tích nghĩa vụ/thuế Lưu ý - Nếu áp dụng, Phí Xử lý Quốc tế (IPF) không được bao gồm.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Số tiền phí môi giới tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Số tiền phí phân phối tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.dutyTaxesBreakdown.duty`	Số tiền nghĩa vụ tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Số tiền phí thanh toán trước tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Số tiền VAT/thuế trên phí phân phối tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.dutyTaxesBreakdown.vatTax`	Số tiền VAT/thuế tính bằng USD, không bao gồm VAT/thuế trên phí phân phối; số thập phân dương, hai chữ số thập phân`integer`
`order.dutyTaxesTotal`	Tổng cộng nghĩa vụ và thuế tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.foreignCurrencyCode`	Mã tiền tệ mà thanh toán đơn hàng được giải quyết.`string`
`remittance_amount`	Số tiền cần được chuyển đến một quốc gia cụ thể, ví dụ: _ UK VAT_.`decimal`
`order.grandTotal`	Tổng cộng tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.grandTotalForeign`	Tổng cộng tính bằng tiền tệ được giải quyết; số thập phân dương, hai chữ số thập phân`integer`
`order.items`	Một danh sách các bản đồ mục Bản đồ mục chứa chi tiết về mục được chuyển đến Zonos Checkout khi tạo giỏ hàng tạm thời Để biết thêm chi tiết về các thuộc tính mục, vui lòng xem tài liệu API createTempCart `JSON string`
`order.itemsCount`	Số lượng hàng dòng đơn hàng`integer`
`order.itemsTotal`	Tổng cộng hàng/sản phẩm tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.itemsTotalForeign`	Tổng cộng hàng/sản phẩm tính bằng tiền tệ được giải quyết; số thập phân dương, hai chữ số thập phân`integer`
`order.items[index].height`	Số thập phân dương, hai chữ số thập phân`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Số thập phân dương, hai chữ số thập phân`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Số thập phân dương, hai chữ số thập phân`integer`
`order.items[index].width`	Số thập phân dương, hai chữ số thập phân`integer`
`order.items[index].unitPrice`	Số thập phân dương, hai chữ số thập phân`integer`
`order.merchantOrderId`	`MerchantOrderId` được liên kết với đơn hàng thông qua điểm cuối dịch vụ API updateMerchantOrderId .`string`
`order.misc1`	Giá trị bổ sung được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart .`string`
`order.misc2`	Giá trị bổ sung được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart .`string`
`order.misc3`	Giá trị bổ sung được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart .`string`
`order.misc4`	Giá trị bổ sung được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart .`string`
`order.misc5`	Giá trị bổ sung được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart .`string`
`order.misc6`	Giá trị bổ sung được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart .`string`
`order.nationalIdentifier`	Thông tin địa chỉ thanh toán quốc tế bổ sung cho đơn hàng khi cần. Các giá trị được nhập vào Zonos Checkout.`string`
`order.notes`	Một danh sách các bản đồ ghi chú; bản đồ ghi chú chứa chi tiết về ghi chú đơn hàng.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Một boolean cho biết đây có phải là ghi chú do khách hàng tạo về đơn hàng, vận chuyển, v.v.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Một `boolean` cho biết nếu ghi chú này được đánh dấu là quan trọng
`order.notes[index].note`	Nội dung ghi chú`string`
`order.optInEmail`	Cho biết rằng khách hàng đã chọn hộp kiểm "đăng ký bản tin của chúng tôi" bên trong Zonos Checkout Chỉ áp dụng nếu bạn đã chọn để hiển thị hộp này trên trang thanh toán`boolean`
`order.orderId`	Số nhận dạng đơn hàng trong hệ thống Zonos`string`
`order.orderDate`	Dấu thời gian tạo đơn hàng millis ở UTC/GMT.`millis`
`order.orderDateString`	Chuỗi dấu thời gian tạo đơn hàng ở UTC/GMT.`string`
`order.orderStatus`	Trạng thái/trạng thái của đơn hàng trong hệ thống Zonos. Để biết thêm chi tiết về việc sử dụng `orderStatus`, vui lòng xem Tài liệu Truy xuất một đơn hàng tại đây. Thông tin bổ sung về trạng thái đơn hàng có thể được tìm thấy trong Tài liệu Cập nhật tại đây.`string`
`order.orderStatusDate`	Dấu thời gian millis ở UTC/GMT của thay đổi `orderStatus` gần đây nhất trong hệ thống Zonos.`millis`
`order.orderStatusDateString`	Chuỗi dấu thời gian ở UTC/GMT của thay đổi `orderStatus` gần đây nhất trong hệ thống Zonos.`string`
`order.paymentProcessing`	Một bản đồ của chi tiết `paymentProcessing`. Một số tham số có thể không áp dụng cho tài khoản của bạn và sẽ bị loại trừ khỏi phản hồi.`JSON string`
`order.paymentProcessing.captureDate`	Ngày ghi lại thanh toán tính bằng millis, nếu có. Nếu Zonos đang xử lý thanh toán, nút này bị loại trừ khỏi phản hồi.`millis`
`order.paymentProcessing.captureDateString`	Ngày ghi lại thanh toán dưới dạng chuỗi, nếu có. Nếu Zonos đang xử lý thanh toán, nút này bị loại trừ khỏi phản hồi.`string`
`order.paymentProcessing.cardType`	Hãng thẻ tín dụngNếu Zonos đang xử lý thanh toán, nút này bị loại trừ khỏi phản hồi.`string`
`order.paymentProcessing.lastFour`	Bốn số cuối cùng của số thẻ tín dụng thanh toán. Nếu Zonos đang xử lý thanh toán, nút này bị loại trừ khỏi phản hồi.`string`
`order.paymentProcessing.paymentGateway`	Tên cổng thanh toán Nếu Zonos đang xử lý thanh toán, sẽ cho biết "iGlobal_CC" hoặc "iGlobal_PayPal".`string`
`order.paymentProcessing.transactionType`	Cho biết loại giao dịch "AUTH_CAPTURE" hoặc "AUTH_ONLY". Nếu Zonos đang xử lý thanh toán, nút này bị loại trừ khỏi phản hồi.`string`
`order.poNumber`	Số đơn hàng mua cho đơn hàng được chỉ định bên trong Zonos Checkout; được sử dụng khi các đơn hàng mua được kích hoạt`string`
`order.quotedDutyTaxes`	Nghĩa vụ và thuế được trích dẫn trong Zonos Checkout, được hiển thị tính bằng USD; số thập phân dương, hai chữ số thập phân`integer`
`order.quotedDutyTaxesForeign`	Nghĩa vụ và thuế được trích dẫn trong Zonos Checkout. Hiển thị tính bằng tiền tệ được giải quyết; số thập phân dương, hai chữ số thập phân`integer`
`order.referenceId`	`referenceId` duy nhất được liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart.`string`
`order.shipComplete`	Cho biết liệu đơn hàng có nên được vận chuyển theo nhiều phần hay không`boolean`
`order.shippingCarrierServiceLevel`	Nhận dạng nhà vận chuyển và mức dịch vụ cho tùy chọn vận chuyển đã chọn`string`
`order.shippingInstructions`	Hướng dẫn có thể tùy chỉnh cho mức dịch vụ vận chuyển`string`
`order.shippingTotal`	Tổng vận chuyển tính bằng USD; số thập phân dương, hai chữ số thập phân `integer`
`order.shippingTotalForeign`	Tổng vận chuyển tính bằng tiền tệ được giải quyết; số thập phân dương, hai chữ số thập phân`integer`
`order.testOrder`	Cho biết rằng đơn hàng có phải là đơn hàng thử nghiệm không.`boolean`
`order.trackingNumber`	Số theo dõi được tạo cho lô hàng, nếu áp dụng.`string`
`order.zip`	Địa chỉ đích / vận chuyển cho đơn hàng - các giá trị được nhập vào Zonos Checkout hoặc được chuyển đến đơn hàng thông qua chuyển hướng đến Zonos Checkout.`string`

Các loại dữ liệu bổ sung:

order.address1
order.address2
order.address3
order.altPhone
order.billingAddress1
order.billingAddress2
order.billingAddress3
order.billingAltPhone
order.billingCity
order.birthDate
order.billingCompany
order.billingCountryCode
order.billingCountryName
order.billingEmail
order.billingName
order.billingPhone
order.billingState
order.city
order.company
order.countryCode
order.countryName
order.email
order.items[index].countryOfOrigin
order.items[index].description
order.items[index].imageURL
order.items[index].itemBrand
order.items[index].itemCategory
order.items[index].itemColor
order.items[index].itemCustomization
order.items[index].itemDescriptionDetailed
order.items[index].itemDescriptionLong
order.items[index].itemFabricContent
order.items[index].itemHSCode
order.items[index].itemLtlClass
order.items[index].itemMaterial
order.items[index].itemURL
order.items[index].productId
order.items[index].sku
order.items[index].productId
order.items[index].weightUnits
order.name
order.phone
order.state

Đặt lịch demo