DOCS

Order details

/

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.

Đ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ườngghi chú
Phương thức HTTPPOST
Điểm cuốihttps://api.iglobalstores.com/v2/orderDetail
Giao thứcHTTPS
Định dạng tin nhắnJSON
Tiêu đề HTTP AcceptAccept: application/json
Tiêu đề HTTP Content-TypeContent-Type: application/json

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

trườngghi chú
orderId TÙY CHỌN, nếu truyền tham số referenceIdId đơ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ỘCAPI secret GUID được cung cấp bởi Zonosstring
storeId BẮT BUỘCId cửa hàng được cung cấp bởi Zonos.integer

Phản hồi lỗi HTTP

Mã lỗithông điệpnghĩa
415Loại phương tiện không được hỗ trợThực thể HTML. Tiêu đề “Content-Type” HTTP không hợp lệ.
406Không chấp nhậnThực thể HTML. Tiêu đề “Accept” HTTP không hợp lệ.
400Yê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”
500Lỗ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ườngghi chú
errorTham 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
orderboxCountTrườ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.carrierAccountNumberSố 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.carrierAccountShippingMethodPhươ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.cslListMatchTrù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.customerSelectedShippingNameTên hiển thị tùy chọn vận chuyển bên trong Zonos Checkoutstring
order.dutyTaxesBreakdownMộ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.brokerageFeeSố tiền phí môi giới bằng USD; số thực dương, hai chữ số thập phâninteger
order.dutyTaxesBreakdown.dispursementFeeSố tiền phí chi trả bằng USD; số thực dương, hai chữ số thập phâninteger
order.dutyTaxesBreakdown.dutySố tiền thuế nhập khẩu bằng USD; số thực dương, hai chữ số thập phâninteger
order.dutyTaxesBreakdown.prepaymentFeeSố tiền phí trả trước bằng USD; số thực dương, hai chữ số thập phâninteger
order.dutyTaxesBreakdown.vatOnDispursementFeeSố 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.vatTaxSố 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.dutyTaxesTotalTổng thuế và phí bằng USD; số thực dương, hai chữ số thập phâninteger
order.foreignCurrencyCodeMã tiền tệ mà thanh toán đơn hàng đã được thực hiện.string
remittance_amountSố 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.grandTotalTổng cộng bằng USD; số thực dương, hai chữ số thập phâninteger
order.grandTotalForeignTổng cộng bằng tiền tệ đã thanh toán; số thực dương, hai chữ số thập phâninteger
order.itemsDanh 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.itemsCountSố lượng mặt hàng trong đơn hànginteger
order.itemsTotalTổ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.itemsTotalForeignTổ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].heightSố thực dương, hai chữ số thập phâninteger
order.items[index].itemNonShippableboolean
order.items[index].lengthSố thực dương, hai chữ số thập phâninteger
order.items[index].quantityinteger
order.items[index].weightSố thực dương, hai chữ số thập phâninteger
order.items[index].widthSố thực dương, hai chữ số thập phâninteger
order.items[index].unitPriceSố thực dương, hai chữ số thập phâninteger
order.merchantOrderIdMerchantOrderId liên kết với đơn hàng thông qua updateMerchantOrderId API service endpoint.string
order.misc1Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string
order.misc2Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string
order.misc3Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string
order.misc4Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string
order.misc5Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string
order.misc6Giá trị bổ sung liên kết với đơn hàng thông qua createTempCart API service endpoint.string
order.nationalIdentifierThô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.notesDanh 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].createdByUserstring
order.notes[index].customerNoteMộ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].dateCreatedmillis
order.notes[index].dateCreatedStringstring
order.notes[index].flaggedMộ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].noteNội dung ghi chústring
order.optInEmailChỉ 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.orderIdSố nhận dạng của đơn hàng trong hệ thống Zonosstring
order.orderDateDấu thời gian tạo đơn hàng millis theo UTC/GMT.millis
order.orderDateStringDấu thời gian tạo đơn hàng dưới dạng chuỗi theo UTC/GMT.string
order.orderStatusTrạ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.orderStatusDateDấ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.orderStatusDateStringDấ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.paymentProcessingMộ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.captureDateNgà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.captureDateStringNgà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.cardTypeThươ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.lastFourBố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.paymentGatewayTê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.transactionTypeChỉ 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.poNumberSố đơ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.quotedDutyTaxesThuế 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.quotedDutyTaxesForeignThuế 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.referenceIdreferenceId 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.shipCompleteChỉ ra liệu đơn hàng có nên được giao thành nhiều phần hay khôngboolean
order.shippingCarrierServiceLevelNhậ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.shippingInstructionsHướng dẫn tùy chỉnh cho cấp độ dịch vụ vận chuyểnstring
order.shippingTotalTổ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.shippingTotalForeignTổ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.testOrderChỉ ra liệu đơn hàng có phải là đơn hàng thử nghiệm hay không.boolean
order.trackingNumberSố 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

Trang này có hữu ích không?