엔드포인트
참고: 응답 키는 수정될 수 있으며/또는 추가 키가 추가될 수 있습니다. 엔드포인트를 사용할 경우 이러한 가능성에 맞게 코드를 설정하세요.
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 키/값 쌍
필드 | 비고 |
---|---|
orderId 선택 사항, referenceId 매개변수를 전달하는 경우 | Zonos 주문 ID는 상점 ID와 하이픈 없이 또는 함께 전달할 수 있습니다 (예: 123-45678 또는 45678). 참고: 주문 완료 및 결제 후 고객은 귀하의 도메인에 호스팅된 주문 완료/주문 감사 페이지로 리디렉션됩니다. URL에는 이 값을 포함하는 쿼리 문자열 매개변수 “orderId”가 포함됩니다.정수 / 문자열 |
referenceId 선택 사항, “orderId” 매개변수를 전달하는 경우 | 이 매개변수는 createTempCart API 서비스 엔드포인트에서 전달된 고유한 referenceId 로 주문 데이터를 조회하는 데 사용됩니다. 이 매개변수는 orderId 매개변수를 기반으로 주문 세부정보를 조회할 때 생략하거나 null로 두어야 합니다.문자열 |
secret 필수 | Zonos에서 제공한 API 비밀 GUID문자열 |
storeId 필수 | Zonos에서 제공한 상점 ID.정수 |
오류 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”:”store 매개변수가 필요합니다”“error”:”storeId: 999에 대한 referenceId: 999999로 주문을 찾을 수 없습니다”“error”:”storeId: 999에 대한 referenceId: 999999가 중복되었습니다”“error”:”referenceId: 999999로 주문을 검색할 수 없습니다” |
500 | 내부 서버 오류 | “error”:”주문 세부정보를 처리할 수 없습니다” |
응답 JSON 정의
필드 | 노트 |
---|---|
error | 이 매개변수는 오류가 발생했을 때만 존재하며 오류 설명을 포함합니다.string |
order | 주문 세부정보의 맵입니다.JSON string |
order.billingZip | 주문의 청구 주소 - 값은 Zonos Checkout에 입력되었습니다.string |
orderboxCount | 이 필드는 주문을 배송하는 데 사용될 상자의 수를 설명하며, createTempCart 요청에 전달됩니다.string |
order.carrierAccountNumber | 방문자의 자체 배송 운송업체 계좌 번호; 방문자 운송업체 계좌가 활성화된 경우 사용됩니다.string |
order.carrierAccountShippingMethod | 방문자의 자체 배송 운송업체 계좌에서 선택된 배송 방법; 방문자 운송업체 계좌가 활성화된 경우 사용됩니다.string |
order.cslListMatch | 통합 심사 목록(CSL) 일치. 고객 정보가 미국 통합 심사 목록에서 일치를 생성했는지 여부를 나타내는 부울 값으로, 거부된 당사자 연관 가능성을 검토해야 합니다.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 | 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 | 주문과 관련된 MerchantOrderId updateMerchantOrderId API 서비스 엔드포인트를 통해.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 | 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 | 청구 신용 카드 번호의 마지막 네 자리 숫자. 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
주문 세부정보
주문 세부정보 엔드포인트가 작동하는 방식을 알아보세요.orderDetail
엔드포인트는 Zonos Checkout를 통해 완료된 주문의 세부정보와 상태를 안전하게 검색하는 데 사용됩니다.