Checkout API 엔드포인트란 무엇인가요?

Checkout API 엔드포인트는 'orderDetail'입니다. 이 API 엔드포인트는 Zonos Checkout을 통해 완료된 주문의 세부정보와 상태를 안전하게 조회하는 데 사용됩니다.

Checkout API의 HTTPS 요청은 무엇인가요?

Checkout API의 HTTPS 요청에는 HTTP 메서드(POST), 엔드포인트('https://api.iglobalstores.com/v2/orderDetail'), 프로토콜(HTTPS), 메시지 형식(JSON), HTTP 헤더(Accept: application/json, Content-Type: application/json)가 포함됩니다.

요청 본문의 JSON key/value 쌍은 무엇인가요?

요청 본문의 JSON key/value 쌍에는 'orderId', 'referenceId', 'secret', 'storeId'가 포함됩니다. 'orderId'와 'referenceId'는 선택 사항이지만 둘 중 하나는 반드시 전달해야 합니다. 'secret'과 'storeId'는 필수입니다.

가능한 오류 HTTP 응답에는 어떤 것이 있나요?

가능한 오류 HTTP 응답에는 415(Unsupported media type), 406(Not Acceptable), 400(Bad Request), 500(Internal Server Error)이 있습니다. 각 오류 코드는 특정 유형의 오류에 해당합니다.

응답 JSON 정의는 무엇인가요?

응답 JSON 정의에는 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' 등 주문 세부정보와 관련된 다양한 매개변수가 포함됩니다. 각 매개변수는 주문에 대한 특정 정보를 제공합니다.

Checkout•

홈API 참조 Checkout REST API 주문 세부정보

주문 세부정보

주문 세부정보 엔드포인트의 작동 방식을 알아보세요.

orderDetail 엔드포인트는 Zonos Checkout을 통해 완료된 주문의 세부정보와 상태를 안전하게 검색하는 데 사용됩니다.

엔드포인트

참고: 응답 키는 변경될 수 있으며 추가 키가 생성될 수도 있습니다. 이 엔드포인트를 사용할 경우, 이러한 가능성에 대응할 수 있도록 코드를 구성하시기 바랍니다.

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

HTTPS 요청

필드↕	참고↕
HTTP 메서드	POST
엔드포인트	`https://api.iglobalstores.com/v2/orderDetail`
프로토콜	HTTPS
메시지 형식	JSON
Accept HTTP 헤더	Accept: application/json
Content-Type HTTP 헤더	Content-Type: application/json

요청 본문의 JSON key/value 쌍

필드↕	참고↕
`orderId` 선택 사항, `referenceId` 매개변수를 전달하는 경우	Zonos 주문 Id는 매장 Id와 하이픈을 포함하거나 제외하고 전달할 수 있습니다(예: 123-45678 또는 45678). 참고: 주문 완료 및 결제 후, 고객은 귀사 도메인에서 호스팅되는 주문 완료/주문 감사 페이지로 리디렉션됩니다. 이때 URL에는 이 값을 담은 쿼리스트링 매개변수 "orderId"가 포함됩니다.`integer / string`
`referenceId` 선택 사항, "orderId" 매개변수를 전달하는 경우	이 매개변수는 `createTempCart` API 서비스 엔드포인트에 전달된 고유 `referenceId`로 주문 데이터를 조회하는 데 사용됩니다. `orderId` 매개변수를 기준으로 주문 세부정보를 조회하려는 경우, 이 매개변수는 생략하거나 null로 두어야 합니다.`string`
`secret` 필수	Zonos에서 제공한 API secret GUID`string`
`storeId` 필수	Zonos에서 제공한 Store ID.`integer`

오류 HTTP 응답

오류 코드↕	메시지↕	의미↕
415	Unsupported media type	HTML 엔티티. HTTP “Content-Type” 헤더가 유효하지 않습니다.
406	Not Acceptable	HTML 엔티티. HTTP “Accept” 헤더가 유효하지 않습니다.
400	Bad Request	“error”:”orderId: 999-99999 is not a valid orderId”“error”:”Could not find an order with orderId: 999-99999”“error”:”Invalid security credentials”“error”:”Invalid post body”“error”:”Parameter orderId or referenceId is required”“error”:”Cannot specify both Parameters orderId and referenceId”“error”:”No order found with orderId: 999-99999”“error”:”Parameter store required”“error”:”No order found with referenceId: 999999 for storeId: 999”“error”:”referenceId: 999999 for storeId: 999 has been duplicated”“error”:”Couldn’t retrieve order with referenceId: 999999”
500	Internal Server Error	“error”:”Couldn’t process order details”

응답 JSON 정의

필드↕	참고↕
`error`	오류가 발생한 경우에만 존재하며 오류에 대한 설명을 포함합니다.`string`
`order`	주문 세부정보의 맵입니다.`JSON string`
`order.billingZip`	주문의 청구 주소입니다 - 값은 Zonos Checkout에 입력된 내용입니다.`string`
`orderboxCount`	이 필드는 주문 배송에 사용될 상자를 설명하며, createTempCart 요청에 전달됩니다.`string`
`order.carrierAccountNumber`	방문자 자신의 배송업체 계정 번호입니다. 방문자 배송업체 계정이 활성화된 경우 사용됩니다.`string`
`order.carrierAccountShippingMethod`	방문자 자신의 배송업체 계정에서 선택한 배송 방법입니다. 방문자 배송업체 계정이 활성화된 경우 사용됩니다.`string`
`order.cslListMatch`	Consolidated Screening List(CSL) 일치 여부입니다. 고객 정보가 미국 Consolidated Screening List에서 일치 항목을 생성하여 거부 대상자 연관 가능성을 검토해야 함을 나타내는 boolean 값입니다.`boolean`
`order.customerSelectedShippingName`	Zonos Checkout 내 배송 옵션 표시 이름입니다.`string`
`order.dutyTaxesBreakdown`	관세/세금 세부 내역의 맵입니다참고 - 해당되는 경우 IPF(International Processing Fee)는 포함되지 않습니다.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	중개 수수료 금액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.dispursementFee`	지급 수수료 금액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.duty`	관세 금액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	선결제 수수료 금액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	지급 수수료에 대한 VAT/세금 금액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.vatTax`	USD 단위의 VAT/세금 금액이며, 지급 수수료에 대한 VAT/세금은 포함하지 않습니다; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesTotal`	관세 및 세금 총액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.foreignCurrencyCode`	주문 결제가 정산된 통화 코드입니다.`string`
`remittance_amount`	특정 국가로 송금해야 하는 금액입니다. 예: 영국 VAT.`decimal`
`order.grandTotal`	총액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.grandTotalForeign`	정산 통화 기준 총액; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.items`	항목 맵의 목록입니다항목 맵에는 임시 장바구니 생성 시 Zonos Checkout에 전달된 항목에 대한 세부정보가 포함됩니다항목 속성에 대한 자세한 내용은 createTempCart API 문서를 참조하세요`JSON string`
`order.itemsCount`	주문 라인 항목 수입니다.`integer`
`order.itemsTotal`	상품/제품 총액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.itemsTotalForeign`	정산 통화 기준 상품/제품 총액; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.items[index].height`	양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.items[index].width`	양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.items[index].unitPrice`	양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.merchantOrderId`	updateMerchantOrderId API 서비스 엔드포인트를 통해 주문과 연결된 `MerchantOrderId`입니다.`string`
`order.misc1`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 추가 값입니다.`string`
`order.misc2`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 추가 값입니다.`string`
`order.misc3`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 추가 값입니다.`string`
`order.misc4`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 추가 값입니다.`string`
`order.misc5`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 추가 값입니다.`string`
`order.misc6`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 추가 값입니다.`string`
`order.nationalIdentifier`	필요한 경우 주문에 대한 추가 국제 청구 주소 정보입니다. 값은 Zonos Checkout에 입력된 내용입니다.`string`
`order.notes`	노트 맵의 목록입니다. 노트 맵에는 주문 노트에 대한 세부정보가 포함됩니다.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	주문, 배송 등에 대해 고객이 작성한 노트인지를 나타내는 boolean 값입니다.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	이 노트가 중요로 표시되었는지를 나타내는 `boolean` 값입니다
`order.notes[index].note`	노트 내용입니다`string`
`order.optInEmail`	고객이 Zonos Checkout 내에서 "뉴스레터 가입" 체크박스를 선택했음을 나타냅니다체크아웃 페이지에 이 체크박스를 표시하도록 설정한 경우에만 적용됩니다.`boolean`
`order.orderId`	Zonos 시스템 내 주문의 식별 번호입니다.`string`
`order.orderDate`	UTC/GMT 기준 주문 생성 타임스탬프(밀리초)입니다.`millis`
`order.orderDateString`	UTC/GMT 기준 주문 생성 타임스탬프 문자열입니다.`string`
`order.orderStatus`	Zonos 시스템 내 주문의 상태입니다. `orderStatus` 사용에 대한 자세한 내용은 여기의 주문 검색 문서를 참조하세요. 주문 상태에 대한 추가 정보는 여기의 주문 업데이트 문서에서 확인할 수 있습니다.`string`
`order.orderStatusDate`	Zonos 시스템에서 가장 최근에 `orderStatus`가 변경된 시점의 UTC/GMT 타임스탬프(밀리초)입니다.`millis`
`order.orderStatusDateString`	Zonos 시스템에서 가장 최근에 `orderStatus`가 변경된 시점의 UTC/GMT 타임스탬프 문자열입니다.`string`
`order.paymentProcessing`	`paymentProcessing` 세부정보의 맵입니다. 일부 매개변수는 계정에 적용되지 않을 수 있으며, 이 경우 응답에서 제외됩니다.`JSON string`
`order.paymentProcessing.captureDate`	결제 캡처 날짜(밀리초), 가능한 경우Zonos가 결제를 처리하는 경우, 이 노드는 응답에서 제외됩니다.`millis`
`order.paymentProcessing.captureDateString`	결제 캡처 날짜(문자열), 가능한 경우Zonos가 결제를 처리하는 경우, 이 노드는 응답에서 제외됩니다.`string`
`order.paymentProcessing.cardType`	신용카드 브랜드Zonos가 결제를 처리하는 경우, 이 노드는 응답에서 제외됩니다.`string`
`order.paymentProcessing.lastFour`	청구 신용카드 번호의 마지막 4자리입니다.Zonos가 결제를 처리하는 경우, 이 노드는 응답에서 제외됩니다.`string`
`order.paymentProcessing.paymentGateway`	결제 게이트웨이 이름Zonos가 결제를 처리하는 경우 "iGlobal_CC" 또는 "iGlobal_PayPal"로 표시됩니다.`string`
`order.paymentProcessing.transactionType`	트랜잭션 유형을 나타냅니다“AUTH_CAPTURE” 또는 “AUTH_ONLY”.Zonos가 결제를 처리하는 경우, 이 노드는 응답에서 제외됩니다.`string`
`order.poNumber`	Zonos Checkout 내에서 지정된 주문의 구매 주문 번호입니다; 구매 주문 기능이 활성화된 경우 사용됩니다.`string`
`order.quotedDutyTaxes`	Zonos Checkout에서 견적된 관세 및 세금이며, USD로 표시됩니다; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.quotedDutyTaxesForeign`	Zonos Checkout에서 견적된 관세 및 세금입니다. 정산 통화로 표시됩니다; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.referenceId`	createTempCart API 서비스 엔드포인트를 통해 주문과 연결된 고유 `referenceId`입니다.`string`
`order.shipComplete`	주문을 여러 부분으로 배송해야 하는지를 나타냅니다.`boolean`
`order.shippingCarrierServiceLevel`	선택한 배송 옵션의 배송업체 및 서비스 등급 식별자입니다.`string`
`order.shippingInstructions`	배송 서비스 등급에 대한 맞춤 지침입니다.`string`
`order.shippingTotal`	배송비 총액(USD); 양의 부동 소수점, 소수점 이하 두 자리 `integer`
`order.shippingTotalForeign`	정산 통화 기준 배송비 총액; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.testOrder`	테스트 주문 여부를 나타냅니다.`boolean`
`order.trackingNumber`	해당하는 경우 배송을 위해 생성된 추적 번호입니다.`string`
`order.zip`	주문의 목적지/배송 주소입니다 - 값은 Zonos Checkout에 입력되었거나, Zonos Checkout으로의 리디렉션을 통해 주문에 전달된 내용입니다.`string`

추가 데이터 유형:

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

데모 예약하기