Điểm cuối
Lưu ý: Các khóa phản hồi có thể được sửa đổi và/hoặc các khóa bổ sung có thể được thêm vào. Nếu bạn sẽ sử dụng điểm cuối này, vui lòng thiết lập mã của bạn để phù hợp với những 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 tin nhắn | JSON |
Tiêu đề HTTP Accept | Accept: application/json |
Tiêu đề HTTP Content-Type | Content-Type: application/json |
Các cặp khóa/giá trị JSON trong thân yêu cầu
trường | ghi chú |
---|---|
orderId TÙY CHỌN, nếu truyền tham số referenceId | Id đơn hàng Zonos có thể được truyền với hoặc không có Id cửa hàng và dấu gạch nối (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” sẽ chứa giá trị này.integer / string |
referenceId TÙY CHỌN, nếu truyề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 bằng referenceId duy nhất được truyền trong điểm cuối dịch vụ API createTempCart . Tham số này nên được để trống hoặc null khi có ý định tra cứu thông tin đơn hàng dựa trên tham số orderId .string |
secret BẮT BUỘC | API secret GUID được cung cấp bởi Zonosstring |
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 điệp | nghĩa |
---|---|---|
415 | Loại phương tiện không được hỗ trợ | Thực thể HTML. Tiêu đề “Content-Type” HTTP không hợp lệ. |
406 | Không chấp nhận | Thực thể HTML. Tiêu đề “Accept” HTTP không hợp lệ. |
400 | Yêu cầu không hợp lệ | “error”:”orderId: 999-99999 không phải là một orderId hợp lệ”“error”:”Không thể tìm thấy đơn hàng với orderId: 999-99999”“error”:”Thông tin xác thực bảo mật không hợp lệ”“error”:”Nội dung post không hợp lệ”“error”:”Tham số orderId hoặc referenceId là bắt buộc”“error”:”Không thể chỉ định cả hai tham số orderId và referenceId”“error”:”Không tìm thấy đơn hàng với orderId: 999-99999”“error”:”Tham số store là 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ể lấy đơn hàng với referenceId: 999999” |
500 | Lỗi máy chủ nội bộ | “error”:”Không thể xử lý thông tin đơn hàng” |
Định nghĩa JSON phản hồi
trường | ghi chú |
---|---|
error | Tham số này chỉ có mặt 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ả số hộp sẽ được sử dụng để vận chuyển đơn hàng, được truyền vào yêu cầu createTempCart .string |
order.carrierAccountNumber | Số tài khoản của nhà vận chuyển mà khách truy cập sở hữu; được sử dụng khi tài khoản nhà vận chuyển của khách truy cập được kích hoạtstring |
order.carrierAccountShippingMethod | Phương thức vận chuyển đã chọn trên tài khoản nhà vận chuyển của khách truy cập; được sử dụng khi tài khoản nhà vận chuyển của khách truy cập được kích hoạtstring |
order.cslListMatch | Trùng khớp Danh sách Sàng lọc Tập hợp (CSL). Một boolean cho biết khi thông tin khách hàng đã tạo ra một sự trùng khớp trong Danh sách Sàng lọc Tập hợp của Hoa Kỳ và cần được xem xét để có thể liên quan đến 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 Checkoutstring |
order.dutyTaxesBreakdown | Một bản đồ phân tích chi tiết thuế/thuế phíLưu ý - Nếu có, IPF (Phí xử lý quốc tế) không được bao gồm.JSON string |
order.dutyTaxesBreakdown.brokerageFee | Số tiền phí môi giới bằng USD; số thực dương, hai chữ số thập phâninteger |
order.dutyTaxesBreakdown.dispursementFee | Số tiền phí chi trả bằng USD; số thực dương, hai chữ số thập phâninteger |
order.dutyTaxesBreakdown.duty | Số tiền thuế nhập khẩu bằng USD; số thực dương, hai chữ số thập phâninteger |
order.dutyTaxesBreakdown.prepaymentFee | Số tiền phí trả trước bằng USD; số thực dương, hai chữ số thập phâninteger |
order.dutyTaxesBreakdown.vatOnDispursementFee | Số tiền VAT/thuế trên phí chi trả bằng USD; số thực dương, hai chữ số thập phâninteger |
order.dutyTaxesBreakdown.vatTax | Số tiền VAT/thuế bằng USD, không bao gồm VAT/thuế trên phí chi trả; số thực dương, hai chữ số thập phâninteger |
order.dutyTaxesTotal | Tổng thuế và phí bằng USD; số thực dương, hai chữ số thập phâninteger |
order.foreignCurrencyCode | Mã tiền tệ mà thanh toán đơn hàng đã được thực hiện.string |
remittance_amount | Số tiền cần được chuyển đến một quốc gia cụ thể (ví dụ: VAT Vương quốc Anh).decimal |
order.grandTotal | Tổng cộng bằng USD; số thực dương, hai chữ số thập phâninteger |
order.grandTotalForeign | Tổng cộng bằng tiền tệ đã thanh toán; số thực dương, hai chữ số thập phâninteger |
order.items | Danh sách các bản đồ mặt hàngBản đồ mặt hàng chứa chi tiết về mặt hàng đã được truyền vào 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ặt hàng, vui lòng xem tài liệu API createTempCart JSON string |
order.itemsCount | Số lượng mặt hàng trong đơn hànginteger |
order.itemsTotal | Tổng số mặt hàng/sản phẩm bằng USD; số thực dương, hai chữ số thập phâninteger |
order.itemsTotalForeign | Tổng số mặt hàng/sản phẩm bằng tiền tệ đã thanh toán; số thực dương, hai chữ số thập phâninteger |
order.items[index].height | Số thực dương, hai chữ số thập phâninteger |
order.items[index].itemNonShippable | boolean |
order.items[index].length | Số thực dương, hai chữ số thập phâninteger |
order.items[index].quantity | integer |
order.items[index].weight | Số thực dương, hai chữ số thập phâninteger |
order.items[index].width | Số thực dương, hai chữ số thập phâninteger |
order.items[index].unitPrice | Số thực dương, hai chữ số thập phâninteger |
order.merchantOrderId | MerchantOrderId liên kết với đơn hàng thông qua updateMerchantOrderId API service endpoint.string |
order.misc1 | Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string |
order.misc2 | Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string |
order.misc3 | Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string |
order.misc4 | Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string |
order.misc5 | Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string |
order.misc6 | Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string |
order.nationalIdentifier | Thông tin địa chỉ thanh toán quốc tế bổ sung cho đơn hàng khi cần thiết. Các giá trị đã được nhập vào Zonos Checkout.string |
order.notes | 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 liệu ghi chú này có được đánh dấu là quan trọng hay không |
order.notes[index].note | Nội dung ghi chústring |
order.optInEmail | Chỉ ra rằng khách hàng đã chọn hộp kiểm cho “đăng ký nhận bản tin của chúng tôi” trong Zonos CheckoutChỉ áp dụng nếu bạn đã chọn hiển thị hộp kiểm này trên trang checkoutboolean |
order.orderId | Số nhận dạng của đơn hàng trong hệ thống Zonosstring |
order.orderDate | Dấu thời gian tạo đơn hàng millis theo UTC/GMT.millis |
order.orderDateString | Dấu thời gian tạo đơn hàng dưới dạng chuỗi theo 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 Lấy tài liệu đơn hàng tại đây.Thông tin bổ sung về các trạng thái đơn hàng có thể được tìm thấy trong Cập nhật tài liệu đơn hàng tại đây.string |
order.orderStatusDate | Dấu thời gian millis theo UTC/GMT của sự thay đổi orderStatus gần nhất trong hệ thống Zonos.millis |
order.orderStatusDateString | Dấu thời gian dưới dạng chuỗi theo UTC/GMT của sự thay đổi orderStatus gần nhất trong hệ thống Zonos.string |
order.paymentProcessing | Một bản đồ chi tiết về 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 nhận thanh toán trong millis, nếu có. Nếu Zonos đang xử lý thanh toán, nút này sẽ bị loại trừ khỏi phản hồi.millis |
order.paymentProcessing.captureDateString | Ngày ghi nhận 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 sẽ bị loại trừ khỏi phản hồi.string |
order.paymentProcessing.cardType | Thương hiệu thẻ tín dụngNếu Zonos đang xử lý thanh toán, nút này sẽ bị loại trừ khỏi phản hồi.string |
order.paymentProcessing.lastFour | Bốn số cuối của số thẻ tín dụng thanh toán. Nếu Zonos đang xử lý thanh toán, nút này sẽ 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ẽ chỉ ra “iGlobal_CC” hoặc “iGlobal_PayPal”.string |
order.paymentProcessing.transactionType | Chỉ ra loại giao dịch “AUTH_CAPTURE” hoặc “AUTH_ONLY”. Nếu Zonos đang xử lý thanh toán, nút này sẽ bị loại trừ khỏi phản hồi.string |
order.poNumber | Số đơn đặt hàng cho đơn hàng được chỉ định bên trong Zonos Checkout; được sử dụng khi đơn đặt hàng được kích hoạtstring |
order.quotedDutyTaxes | Thuế và phí được báo giá trong Zonos Checkout, hiển thị bằng USD; số dương, số thập phân với hai chữ số sau dấu phẩyinteger |
order.quotedDutyTaxesForeign | Thuế và phí được báo giá trong Zonos Checkout. Hiển thị bằng tiền tệ đã thanh toán; số dương, số thập phân với hai chữ số sau dấu phẩyinteger |
order.referenceId | referenceId duy nhất liên kết với đơn hàng thông qua điểm cuối dịch vụ API createTempCart.string |
order.shipComplete | Chỉ ra liệu đơn hàng có nên được giao thành nhiều phần hay khôngboolean |
order.shippingCarrierServiceLevel | Nhận diện nhà vận chuyển và cấp độ dịch vụ cho tùy chọn vận chuyển đã chọnstring |
order.shippingInstructions | Hướng dẫn tùy chỉnh cho cấp độ dịch vụ vận chuyểnstring |
order.shippingTotal | Tổng chi phí vận chuyển bằng USD; số dương, số thập phân với hai chữ số sau dấu phẩy integer |
order.shippingTotalForeign | Tổng chi phí vận chuyển bằng tiền tệ đã thanh toán; số dương, số thập phân với hai chữ số sau dấu phẩyinteger |
order.testOrder | Chỉ ra liệu đơn hàng có phải là đơn hàng thử nghiệm hay không.boolean |
order.trackingNumber | Số theo dõi được tạo cho lô hàng, nếu có.string |
order.zip | Địa chỉ giao hàng / đích đế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 việc 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
Thông tin đơn hàng
Tìm hiểu cách hoạt động của điểm cuối thông tin đơn hàng.Điểm cuối
orderDetail
được sử dụng để lấy thông tin và trạng thái đơn hàng một cách an toàn cho một đơn hàng đã hoàn thành qua Zonos Checkout.