Điểm cuối
Yêu cầu chi tiết đơn hàng hoàn thành
POST | https://api.iglobalstores.com/2.0/order-completed - Tạo một yêu cầu mới cho thông tin liên quan đến một đơn hàng đã hoàn thành.
Yêu cầu HTTPS
| Trường | Ghi chú |
|---|---|
| Phương thức HTTP | POST |
| URL điểm cuối | https://api.iglobalstores.com/2.0/order-completed |
| Giao thức | HTTPS |
| Định dạng tin nhắn | JSON |
| Tiêu đề HTTP chấp nhận | Accept: application/json |
| Tiêu đề HTTP mã thông báo bảo mật | serviceToken: your-test-token-valueThêm một tiêu đề vào yêu cầu HTTPS của bạn có tên serviceToken với giá trị là mã thông báo API bảo mật thử nghiệm của bạn. (Liên hệ với Quản lý Tài khoản của bạn để biết mã này.) |
| Tiêu đề HTTP Content-Type | Content-Type: application/jsonVì bạn sẽ gửi dữ liệu JSON đến dịch vụ, hãy thêm một tiêu đề vào yêu cầu HTTPS của bạn có tên Content-Type với giá trị là application/json |
Các cặp khóa/giá trị JSON trong thân yêu cầu
Định dạng Tin nhắn: JSON
Ví dụ yêu cầu
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Định nghĩa JSON yêu cầu
| Trường | Ghi chú |
|---|---|
billingAddress BẮT BUỘC | Đây là địa chỉ thanh toán của đơn hàng. Đây là một bản đồ chứa các trường địa chỉ sau: address1, address2, address3, city, state, stateCode, postalCode, và countryCode. Các trường chứa này có thể bắt buộc hoặc không bắt buộc tùy thuộc vào quốc gia. Điểm cuối địa phương trả về các trường địa chỉ cụ thể nào bắt buộc hoặc không bắt buộc cho mỗi quốc gia. Lưu ý: stateCode luôn không bắt buộc và không được khai báo trong điểm cuối địa phương. Bạn có thể truyền stateCode, nếu có sẵn. |
billingCompany TÙY CHỌN | Đây là tên công ty thanh toán của đơn hàng. |
billingEmail BẮT BUỘC | Đây là địa chỉ email thanh toán của đơn hàng. |
billingName BẮT BUỘC | Đây là tên đầy đủ của người thanh toán của đơn hàng. |
billingPhone BẮT BUỘC | Đây là số điện thoại thanh toán của đơn hàng. |
items[index].orderGrandTotal BẮT BUỘC | Đây là tổng số tiền mà người mua thanh toán cho đơn hàng của họ bằng USD (Đô la Mỹ). Vui lòng cung cấp mà không có dấu phẩy, không có ký hiệu đô la "$", và với hai chữ số thập phân. Giá trị ví dụ: 2102.99 |
items[index].orderNumber BẮT BUỘC | Đây là số đơn hàng của bạn cho đơn hàng mới hoàn tất. Giá trị ví dụ: 854725421 |
paymentTypeCode BẮT BUỘC | Phương thức thanh toán được người mua sử dụng để thanh toán cho đơn hàng của họ. Giá trị ví dụ: PayPal hoặc Visa hoặc MC hoặc AMEX hoặc DISC |
prepaidDutyTax BẮT BUỘC | Người mua có chọn prepay thuế và phí nhập khẩu của họ hay họ bị buộc phải prepay chúng? Nếu có, đặt thành true; nếu không, đặt thành false. Giá trị ví dụ: true hoặc false |
shippingQuoteId BẮT BUỘC | Đây là ID của báo giá vận chuyển mà người mua đã chọn. Chi tiết giỏ hàng cần giống như khi báo giá vận chuyển được lấy. Nếu chi tiết giỏ hàng đã thay đổi, thì bạn nên đã gọi báo giá vận chuyển mới trước khi hoàn tất đơn hàng của người mua. |
shipToCompany TÙY CHỌN | Đây là tên công ty của người sẽ nhận đơn hàng được vận chuyển. |
shipToEmail BẮT BUỘC | Đây là địa chỉ email của người sẽ nhận đơn hàng được vận chuyển. |
shipToName BẮT BUỘC | Đây là tên đầy đủ của người sẽ nhận đơn hàng được vận chuyển. |
shipToPhone BẮT BUỘC | Đây là số điện thoại của người sẽ nhận đơn hàng được vận chuyển. |
Phản hồi HTTPS
Định dạng tin nhắn: JSON
Phản hồi ví dụ chỉ cho Canada & Australia
Lưu ý: Các phản hồi thực sự sẽ chứa tất cả các quốc gia được hỗ trợ.
Phản hồi ví dụ
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Định nghĩa JSON phản hồi
| Trường | Ghi chú |
|---|---|
deniedParty | Đây là một bản đồ của kết quả sàng lọc bên bị từ chối. Nếu được đặt thành null, thì việc sàng lọc bên bị từ chối không được thực hiện. Liên hệ với đại diện Zonos của bạn nếu bạn gặp phải điều này. |
deniedParty.flagged | Liệu đơn hàng này có khớp với một bản ghi trong danh sách bên bị từ chối hợp nhất của Zonos hay không. Nếu đúng, hãy xem xét đơn hàng này trước khi xử lý. Khi không chắc chắn, đừng xử lý một đơn hàng được đánh dấu là đúng. Giá trị ví dụ: true hoặc false |
deniedParty.source | Nếu trường bị đánh dấu được đặt thành true, trường này sẽ chứa các tham chiếu nguồn hữu ích trong việc xem xét lý do tại sao đơn hàng bị đánh dấu là khớp với bên bị từ chối. |
igOrderId | Zonos định danh cho đơn hàng mới hoàn thành. Giá trị ví dụ: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API Hoàn Thành Đơn Hàng Legacy
Tìm hiểu cách hoạt động của API Hoàn Thành Đơn Hàng Legacy.Điểm cuối Hoàn Thành Đơn Hàng chấp nhận các chi tiết cuối cùng của đơn hàng của người mua, kiểm tra các chi tiết đơn hàng cho các bên bị từ chối và trả về kết quả cùng với một ID đơn hàng cụ thể của Zonos.