What is the Checkout API endpoint?

The Checkout API endpoint is 'orderDetail'. This API endpoint is used to securely retrieve the order details and status of an order completed via the Zonos Checkout.

What is the HTTPS request for the Checkout API?

The HTTPS request for the Checkout API includes the HTTP method (POST), the endpoint ('https://api.iglobalstores.com/v2/orderDetail'), the protocol (HTTPS), the message format (JSON), and the HTTP headers (Accept: application/json, Content-Type: application/json).

What are the JSON key/value pairs in the request body?

The JSON key/value pairs in the request body include 'orderId', 'referenceId', 'secret', and 'storeId'. 'orderId' and 'referenceId' are optional, but one of them must be passed. 'secret' and 'storeId' are required.

What are the possible error HTTP responses?

The possible error HTTP responses include 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request), and 500 (Internal Server Error). Each error code corresponds to a specific type of error.

What are the response JSON definitions?

The response JSON definitions include various parameters related to the order details, such as 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber', and many others. Each parameter provides specific information about the order.

Checkout•

홈API-Referenz Checkout REST API Order details

주문내역

Order Details 엔드포인트의 작동 방식을 알아보세요. 그만큼orderDetail-엔드포인트는 주문 세부정보 및 초과 상태를 표시하는 데 사용됩니다.Zonos Checkout완료된 주문을 안전하게 검색합니다.

종료 지점

참고: 답안은 변경되거나 추가될 수 있습니다. 엔드포인트를 사용하는 경우 이러한 가능성을 고려하도록 코드를 설정하십시오.

포스트 |`https://api.iglobalstores.com/v2/orderDetail`### HTTPS 요청

필드↕	참고↕
HTTP 메소드	포스트
엔드포인트	`https://api.iglobalstores.com/v2/orderDetail`
프로토콜	HTTPS
메시지 형식	JSON
HTTP 헤더 허용	수락: 애플리케이션/json
콘텐츠 유형 HTTP 헤더	콘텐츠 유형: 애플리케이션/json

요청 본문의 JSON 키/값 쌍

필드↕	참고↕
`orderId`고르다IONAL, 만약에`referenceId`매개변수	주문 ID가 전달되었습니다.Zonos상점 ID와 하이픈을 포함하거나 포함하지 않고 전달될 수 있습니다(예: 123-45678 또는 45678). 참고: 주문을 완료하고 결제한 후 고객은 도메인에 호스팅된 주문 완료/주문 감사 페이지로 리디렉션됩니다. URL에는 이 값을 포함하는 쿼리 문자열 매개 변수 "orderId"가 포함되어 있습니다.`integer / string`
`referenceId`고르다ION매개변수가 "orderId"인 경우 AL	이 매개변수는 고유한 코드를 사용하여 주문 데이터를 전달하는 데 사용됩니다.`referenceId`그걸 찾아보려고API-서비스 엔드포인트`createTempCart`양도됩니다. 매개변수를 기반으로 주문 세부정보를 지정하려면 이 매개변수를 생략하거나 null이어야 합니다.`orderId`찾아보기 위해.`string`
`secret`필수	비밀API-GUID 제공자:Zonos`string`
`storeId`필수	제공한 매장 IDZonos.`integer`

HTTP 응답 오류

오류 코드↕	메시지↕	의미↕
415	지원되지 않는 미디어 유형	HTML 엔터티. HTTP 헤더 'Content-Type'이 잘못되었습니다.
406	허용되지 않음	HTML 엔터티. HTTP 헤더 'Accept'가 잘못되었습니다.
400	잘못된 요청	"error": "orderId: 999-99999는 유효한 orderId가 아닙니다." "error": "orderId: 999-99999로 주문을 찾을 수 없습니다." "error": "잘못된 보안 자격 증명" "error": "잘못된 게시물 텍스트" "error": "매개변수 orderId 또는 referenceId가 필요합니다." "error": "orderId와 매개변수를 모두 지정할 수 없습니다." referenceId""error":"orderId: 999-99999인 주문이 없습니다.""error":"매개변수 저장이 필요합니다""error":"storeId: 999에 대한 referenceId: 999999인 주문이 없습니다.""error":"storeId: 999에 대한 referenceId: 999999가 중복되었습니다.""error":"referenceId가 있는 주문을 검색할 수 없습니다. 999999“
500	내부 서버 오류	“오류”: “주문 세부정보를 처리할 수 없습니다.”

응답 JSON 정의

필드↕	참고↕
`error`	이 매개변수는 오류가 발생한 경우에만 존재하며 오류 설명을 포함합니다.`string`
`order`	주문내역 지도입니다.`JSON string`
`order.billingZip`	주문에 대한 청구서 수신 주소 - 필드에 값이 입력되었습니다.Zonos Checkout입력했습니다.`string`
`orderboxCount`	이 필드는 주문 배송에 사용되는 상자를 설명하며 createTempCart 요청으로 전달됩니다.`string`
`order.carrierAccountNumber`	방문자 자신의 운송업체 계정 번호 방문자 운송업체 계정이 활성화된 경우 사용됩니다.`string`
`order.carrierAccountShippingMethod`	방문자 자신의 운송업체 계정에서 선택한 배송 방법 방문자 운송업체 계정이 활성화된 경우 사용됩니다.`string`
`order.cslListMatch`	통합 준수Screen목록(CSL)입니다. US Consolidated에서 고객 정보가 일치하는 경우를 나타내는 부울 값Screen목록을 작성하고 거부된 당사자와의 제휴 가능성을 확인해야 합니다.`boolean`
`order.customerSelectedShippingName`	배송 옵션 표시 이름:Zonos Checkout`string`
`order.dutyTaxesBreakdown`	관세/세금 내역 지도입니다. 참고: 해당되는 경우 IPF(국제 처리 수수료)는 포함되지 않습니다.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	중개 수수료 금액(USD) 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.dispursementFee`	폐기 수수료 금액(USD) 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.duty`	관세 금액(USD) 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	PrepayUSD로 표시된 수수료 금액; 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	인출 수수료에 대한 VAT/세액(USD); 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesBreakdown.vatTax`	USD 단위의 VAT/세금 금액에는 인출 수수료에 대한 VAT/세금이 포함되지 않습니다. 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.dutyTaxesTotal`	관세 및 세금 총액(USD) 양의 부동 소수점, 소수점 이하 두 자리`integer`
`order.foreignCurrencyCode`	주문 결제가 처리된 통화 코드입니다.`string`
`remittance_amount`	특정 국가로 송금해야 하는 금액입니다. B. 영국 부가가치세.`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`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	에이`boolean` 이 메모가 중요로 표시되었는지 여부를 나타냅니다
`order.notes[index].note`	메모 내용`string`
`order.optInEmail`	고객이 "뉴스레터 가입" 확인란을 선택했음을 나타냅니다.Zonos Checkout선택했습니다. 이 확인란을 선택 취소한 경우에만 적용됩니다.Checkout페이지`boolean`
`order.orderId`	주문의 식별 번호Zonos체계`string`
`order.orderDate`	주문 생성 타임스탬프는 UTC/GMT 기준 밀리초입니다.`millis`
`order.orderDateString`	UTC/GMT로 주문 생성을 위한 타임스탬프 문자열입니다.`string`
`order.orderStatus`	Zonos 시스템의 주문 상태/상태입니다. `orderStatus` 사용에 대한 자세한 내용은 주문 검색 문서를 참조하세요. 주문 상태에 대한 추가 정보는 주문 업데이트 문서를 참조하세요.`string`
`order.orderStatusDate`	마지막 UTC/GMT 타임스탬프`orderStatus`변경Zonos체계.`millis`
`order.orderStatusDateString`	마지막 UTC/GMT의 타임스탬프 문자열`orderStatus`변경Zonos체계.`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`	결제 게이트웨이 이름IfZonos결제가 처리됩니다. "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`	선택한 배송 옵션에 대한 운송업체 및 서비스 수준 ID`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

데모 예약하기