엔드포인트
주문 완료 세부정보 요청
POST | https://api.iglobalstores.com/2.0/order-completed
- 완료된 주문과 관련된 정보에 대한 새 요청을 생성합니다.
HTTPS 요청
필드 | 비고 |
---|---|
HTTP 메서드 | POST |
엔드포인트 URL | https://api.iglobalstores.com/2.0/order-completed |
프로토콜 | HTTPS |
메시지 형식 | JSON |
수락 HTTP 헤더 | Accept: application/json |
보안 토큰 HTTP 헤더 | serviceToken: your-test-token-valueHTTPS 요청에 serviceToken이라는 이름의 헤더를 추가하고, 값으로 테스트 보안 API 토큰을 입력하세요. (이 토큰은 계정 관리자에게 문의하세요.) |
Content-Type HTTP 헤더 | Content-Type: application/json서비스에 JSON 데이터를 게시할 것이므로, HTTPS 요청에 Content-Type이라는 이름의 헤더를 추가하고, 값으로 application/json을 입력하세요. |
요청 본문의 JSON 키/값 쌍
메시지 형식: JSON
예제 요청
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"
}
요청 JSON 정의
필드 | 비고 |
---|---|
billingAddress 필수 | 주문의 청구 주소입니다. 이는 다음 주소 필드를 포함하는 맵입니다: address1 , address2 , address3 , city , state , stateCode , postalCode , 및 countryCode . 이 포함된 필드는 국가에 따라 필수 또는 비필수입니다. 로컬라이제이션 엔드포인트는 각 국가에 대해 어떤 특정 주소 필드가 필수인지 아닌지를 반환합니다. 주의: stateCode 는 항상 비필수이며 로컬라이제이션 엔드포인트에 선언되지 않습니다. 가능하다면 stateCode 를 전달할 수 있습니다. |
billingCompany 선택 사항 | 주문의 청구 회사 이름입니다. |
billingEmail 필수 | 주문의 청구 이메일 주소입니다. |
billingName 필수 | 주문의 전체 청구 이름입니다. |
billingPhone 필수 | 주문의 청구 전화번호입니다. |
items[index].orderGrandTotal 필수 | 쇼핑객이 주문에 대해 지불한 총액(USD, 미국 달러)입니다. 쉼표 없이, 달러 기호 “$” 없이, 소수점 두 자리로 제공해 주십시오. 예시 값: 2102.99 |
items[index].orderNumber 필수 | 새로 완료된 주문에 대한 주문 번호입니다. 예시 값: 854725421 |
paymentTypeCode 필수 | 쇼핑객이 주문에 대해 지불하는 데 사용한 결제 방법입니다. 예시 값: PayPal 또는 Visa 또는 MC 또는 AMEX 또는 DISC |
prepaidDutyTax 필수 | 쇼핑객이 수입 세금 및 세금을 prepay 하기로 선택했습니까, 아니면 강제로 prepay 해야 했습니까? 그렇다면 true로 설정하고, 그렇지 않다면 false로 설정하십시오. 예시 값: true 또는 false |
shippingQuoteId 필수 | 쇼핑객이 선택한 배송 견적의 ID입니다. 장바구니 세부정보는 배송 견적을 검색할 때와 동일해야 합니다. 장바구니 세부정보가 변경되었다면, 쇼핑객의 주문을 완료하기 전에 새로운 배송 견적을 요청해야 합니다. |
shipToCompany 선택 사항 | 배송된 주문을 받을 개인의 회사 이름입니다. |
shipToEmail 필수 | 배송된 주문을 받을 개인의 이메일 주소입니다. |
shipToName 필수 | 배송된 주문을 받을 개인의 전체 이름입니다. |
shipToPhone 필수 | 배송된 주문을 받을 개인의 전화번호입니다. |
HTTPS 응답
메시지 형식: JSON
캐나다 및 호주에 대한 예시 응답
참고: 실제 응답은 모든 지원되는 국가를 포함합니다.
예시 응답
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
응답 JSON 정의
필드 | 비고 |
---|---|
deniedParty | 이는 거부된 당사자 심사 결과의 맵입니다. null로 설정된 경우, 거부된 당사자 심사가 수행되지 않았음을 의미합니다. 이 경우 귀하의 Zonos 담당자에게 문의하십시오. |
deniedParty.flagged | 이 주문이 Zonos의 거부된 당사자 통합 목록에서 기록과 일치하는지 여부입니다. true인 경우, 처리하기 전에 이 주문을 검토하십시오. 의심스러운 경우, true로 플래그가 설정된 주문은 처리하지 마십시오. 예시 값: true 또는 false |
deniedParty.source | 플래그가 true로 설정된 경우, 이 필드는 주문이 거부된 당사자와 일치하는 이유를 검토하는 데 유용한 출처 참조를 포함합니다. |
igOrderId | 새로 완료된 주문에 대한 Zonos 식별자입니다. 예시 값: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
주문 완료 API 레거시
레거시 주문 완료 API가 작동하는 방식에 대해 알아보세요.주문 완료 엔드포인트는 쇼핑객의 주문에 대한 최종 세부정보를 수락하고, 주문 세부정보에서 거부된 당사자를 검사하며, 결과와 함께 Zonos-특정 주문 ID를 반환합니다.