UPS(미리 보기)
UPS(United Parcel Service)는 전 세계 고객과 비즈니스에 광범위한 운송, 전자 상거래 및 비즈니스 서비스 포트폴리오를 제공합니다. UPS API에 연결하여 주소 유효성 검사, 위치 검색, 배송 만들기, 배송 추적 등을 수행합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | 지역 |
|---|---|---|
| 논리 앱 | 표준 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | 마이크로소프트 다이내믹스 |
| URL | https://aka.ms/iomsupport |
| 전자 메일 | iomdri@microsoft.com |
| 커넥터 메타데이터 | |
|---|---|
| Publisher | 마이크로소프트 |
| 웹 사이트 | https://www.ups.com/us/en/services/technology-integration.page |
| 개인 정보 보호 정책 | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| 카테고리 | Productivity |
UPS(United Parcel Service) 커넥터는 Dynamics 365 Intelligent Order Management의 공급자 통합에 사용하도록 특별히 개발되었습니다.
사전 요구 사항
- 에서 UPS.com 프로필에 https://www.ups.com/upsdeveloperkit?loc=en_US등록합니다.
자격 증명을 가져오는 방법
- 액세스 .https://www.ups.com/upsdeveloperkit?loc=en_US
- 로그인하여 계정에 연결합니다.
- "액세스 키 요청"을 사용하여 액세스 키를 생성합니다.
- UPS.Com 프로필 로그인 사용자 이름, 암호 및 생성된 액세스 키는 필수 자격 증명입니다.
커넥터 시작
UPS 공급자를 사용하도록 설정하려면 다음을 수행 https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider 합니다.
알려진 문제 및 제한 사항
이 커넥터는 Dynamics 365 Intelligent Order Management의 UPS 공급자 통합에 사용하도록 특별히 개발되었습니다. Dynamics 365 Intelligent Order Management 이외의 사용 사례에 대한 지원은 제한됩니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | 설명 | 필수 |
|---|---|---|---|
| 환경: 샌드박스 또는 프로덕션 | 문자열 | UPS 샌드박스 환경 또는 프로덕션 환경 | 진실 |
| 액세스 키 | 시큐어스트링 (보안 문자열) | UPS 온보딩 프로세스를 통해 얻은 액세스 키 | 진실 |
| 사용자 이름 | 문자열 | MyUPS 계정의 사용자 이름 | 진실 |
| 암호 | 시큐어스트링 (보안 문자열) | MyUPS 계정의 암호 | 진실 |
| 트랜잭션 원본 | 문자열 | 호출하는 클라이언트/원본 애플리케이션을 식별합니다. | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| 로케이터 |
로케이터 API는 UPS 전체 서비스 및 셀프 서비스 위치, 작업 시간 및 픽업 시간을 제공합니다. |
| 배송 만들기 |
배송 API를 만들면 애플리케이션에서 대상에 대한 패키지 배송을 관리하는 여러 가지 방법이 제공됩니다. |
| 배송 취소 |
배송 취소 API는 이전에 예약된 배송을 취소하는 데 사용됩니다. |
| 주소 유효성 검사 거리 수준 |
주소 유효성 검사 거리 수준 API를 사용하여 미국 및 푸에르토리코에서 유효한 주소의 미국 우편 서비스 데이터베이스에 대한 주소를 확인할 수 있습니다. |
| 추적 |
추적 API는 패키지, 지상 화물 및 항공 화물 운송을 지원합니다. |
로케이터
로케이터 API는 UPS 전체 서비스 및 셀프 서비스 위치, 작업 시간 및 픽업 시간을 제공합니다.
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
고객이 제공한 데이터입니다. XML일 수 있습니다. 이 데이터가 요청에 있으면 고객에게 다시 에코됩니다. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
메시지의 버전을 식별합니다. |
|
ResponseStatusCode (응답 상태 코드)
|
LocatorResponse.Response.ResponseStatusCode | string |
교환의 성공 또는 실패를 식별합니다. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
응답 상태 코드를 설명합니다. |
|
오류 심각도
|
LocatorResponse.Response.Error.ErrorSeverity | string |
오류의 심각도를 설명합니다. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
오류를 설명하는 숫자 값입니다. |
|
오류 설명
|
LocatorResponse.Response.Error.ErrorDescription | string |
오류 코드를 설명합니다. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
다시 시도할 때까지 대기할 시간(초)입니다. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
오류에 있는 요소의 Xpath 이름입니다. 요청 문서의 요소를 가리키는 유효한 Xpath입니다. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
오류에 있는 특성의 이름입니다. 오류 위치 요소에 포함된 특성의 이름입니다. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
오류 요소의 내용입니다. |
|
위도
|
LocatorResponse.Geocode.Latitude | string |
원본 주소의 위도, 교환의 중심점, 우편 번호의 중심점 또는 도시의 중심점입니다. |
|
경도
|
LocatorResponse.Geocode.Longitude | string |
원본 주소의 경도, 교환의 중심점, 우편 번호의 중심점 또는 도시의 중심점입니다. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
고지 사항
|
LocatorResponse.SearchResults.Disclaimer | string |
면책 조항. 사용자가 그라운드 및 항공 서비스 유형을 요청했고 최대 UPS 위치 목록 크기가 충족되지 않은 경우 위치 목록은 검색 반경 내에서 지상 또는 공기를 제공하는 위치로 계속됩니다. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Number
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
UPS 저장소인 경우 드롭 위치의 가운데 번호입니다. |
|
높이
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
요청에 제공된 값이 반환되고, 그렇지 않으면 이미지의 기본 너비가 200픽셀로 설정됩니다. 다른 유효한 값은 100에서 400 사이입니다. |
|
너비
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
요청에 제공된 값이 반환되고, 그렇지 않으면 이미지의 기본 너비가 200픽셀로 설정됩니다. 다른 유효한 값은 100에서 400 사이입니다. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
모든 UPS 위치를 표시하기 위해 그림이 있어야 하는 요소입니다. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
사용자가 X축에서 이동하려는 수준입니다. 반환되지 않습니다. 초기 응답에 따라 사용자는 이미지를 왼쪽 또는 오른쪽으로 더 볼 수 있습니다. 이렇게 하려면 값이 1, 0 또는 1인 다른 요청이 필요합니다. |
|
Pany
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
사용자가 Y축에서 이동하려는 수준입니다. 초기 요청의 기본값은 0입니다. 초기 응답에 따라 사용자는 y축의 위 또는 아래로 이미지를 더 자세히 보려고 할 수 있습니다. 이렇게 하려면 값이 1, 0 또는 1인 다른 요청이 필요합니다. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
5개의 위치 ID 목록은 지도 생성을 위해 MapID 내에서 암호화됩니다. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
5개의 UPS 위치와 MapID에 지정된 원본 위치가 있는 지도에 대한 링크입니다. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
특정 UPS 위치의 위치 ID입니다. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
UPS 위치의 X 좌표입니다. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
UPS 위치의 Y 좌표입니다. |
|
세그먼트
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
원본에서 지정된 위치로의 단계별 방향입니다. |
|
가치
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
원본에서 UPS 위치까지의 계산된 거리입니다. |
|
코드
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
측정 코드의 거리 단위입니다. 검색 요청에 사용되는 측정 단위가 반환됩니다. 반환되는 값은 MI-마일입니다. |
|
설명
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
요청에 지정된 측정 단위에 대한 설명을 반환할 수 있습니다. 유효한 값은 마일 및 킬로미터입니다. |
|
시간
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
출발지에서 위치로 운전하는 데 걸리는 총 예상 기간입니다. |
|
가치
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
원점에서 UPS 위치까지의 직선 거리입니다. |
|
코드
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
측정 코드의 거리 단위입니다. 검색 요청에 사용되는 측정 단위가 반환됩니다. 반환되는 값은 MI-마일입니다. |
|
설명
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
요청에 지정된 측정 단위에 대한 설명을 반환할 수 있습니다. 유효한 값은 마일 및 킬로미터입니다. |
|
Totaltime입니다
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
출발지에서 위치로 운전하는 데 걸리는 총 예상 기간입니다. 형식: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
국가 또는 지역에 AccessPoints가 있는지 여부를 나타냅니다. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
검색에서 신뢰도 수준을 허용하는 표시기입니다. |
배송 만들기
배송 API를 만들면 애플리케이션에서 대상에 대한 패키지 배송을 관리하는 여러 가지 방법이 제공됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
트랜잭션 ID
|
transid | True | string |
요청에 고유한 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
코드
|
ShipmentResponse.Response.ResponseStatus.Code | string |
트랜잭션의 성공 또는 실패를 식별합니다. |
|
설명
|
ShipmentResponse.Response.ResponseStatus.Description | string |
응답 상태 코드를 설명합니다. 성공 텍스트를 반환합니다. |
|
Alert
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
고객이 제공한 데이터입니다. XML일 수 있습니다. 이 데이터가 요청에 있으면 고객에게 다시 에코됩니다. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
요청에 고유한 식별자입니다. |
|
고지 사항
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
통화 코드
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge 통화 코드 형식입니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
기본 서비스 요금 값 금액입니다. |
|
통화 코드
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
교통 요금은 통화 코드 유형입니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
운송 및 추가 요금 값 금액입니다. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
통화 코드
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
액세서리 요금 통화 코드 형식입니다. 배송 요청에 사용된 통화 코드가 반환됩니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
액세서리 요금 값 금액입니다. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
통화 코드
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
총 요금 통화 코드 유형입니다. 배송 요청에 사용된 통화 코드가 반환됩니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
총 요금 값 금액입니다. |
|
통화 코드
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes 통화 코드 형식입니다. 배송 요청에 사용된 통화 코드가 반환됩니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes 금액입니다. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
통화 코드
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
총 요금 통화 코드입니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
총 청구 금액입니다. |
|
통화 코드
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes 통화 코드 형식입니다. 배송 요청에 사용된 통화 코드가 반환됩니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes 금액입니다. |
|
통화 코드
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
총 요금 통화 코드입니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
총 청구 금액입니다. |
|
통화 코드
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
할인 금액 통화 코드입니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
할인 금액 금액 금액입니다. |
|
통화 코드
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Net Charge 통화 코드입니다. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
순 청구 금액입니다. |
|
밀도
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
Shipper가 밀도 기반 속도에 적합한 경우 밀도가 반환됩니다. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
운송업체가 밀도 기반 속도에 적합한 경우 총 입방 피트가 반환됩니다. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod는 배송이 배송 수준 또는 패키지 수준으로 평가되었는지 여부를 나타냅니다. 이 정보는 RatingMethodRequestedIndicator가 요청에 있는 경우에만 반환됩니다. 유효한 값: 01 = 배송 수준 02 = 패키지 수준입니다. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod는 사용된 청구 가능 가중치 계산 방법(패키지 수준 또는 배송 수준)인지 여부를 나타냅니다. 이 정보는 RatingMethodRequestedIndicator가 요청에 있는 경우에만 반환됩니다. |
|
코드
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
청구 가중치 측정 단위의 코드입니다. 값은 KGS 또는 LBS입니다. |
|
설명
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
청구 가중치 측정 단위에 대한 설명입니다. |
|
무게
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
청구 가중치입니다. 실제 배송 중량과 배송 차원 가중치가 더 높습니다. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
배송에서 첫 번째 패키지의 UPS 배송 ID 번호.1Z 번호를 반환했습니다. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey는 Mail Innovations 이중 반송 배송을 처리하는 데 필요한 고유한 키입니다. |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
수락 단계에서 전달되어야 하는 인코딩된 배송 매개 변수입니다. ShipConfirmResponse에만 적용됩니다. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
코드
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
높은 값 보고서의 그래픽 이미지 형식에 대한 코드입니다. |
|
설명
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
형식 코드에 대한 설명입니다. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Base 64로 인코딩된 html, EPL2, ZPL 또는 SPL 이미지 ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
코드
|
ShipmentResponse.ShipmentResults.Form.Code | string |
형식을 나타내는 코드입니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. 유효한 값: 01 - 요청된 모든 국제 양식입니다. |
|
설명
|
ShipmentResponse.ShipmentResults.Form.Description | string |
양식의 형식을 나타내는 설명입니다. 가능한 값입니다. 요청된 모든 국제 양식입니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
코드
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
양식이 생성되는 형식을 나타내는 코드입니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. 유효한 값: PDF = pdf 전용입니다. |
|
설명
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
양식 이미지 형식 코드에 대한 설명입니다. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Base 64로 인코딩된 International Forms 이미지입니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
완성된 국제 양식의 저장된 버전을 나중에 검색하기 위한 고유 ID입니다. 코드 = 01일 때 항상 반환됩니다. 01은 국제 형식을 나타냅니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
국제 양식 그룹을 식별하는 설명 텍스트를 포함합니다. 이 요소는 요청 및 응답의 일부입니다. 이 요소는 양식에 표시되지 않습니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
코드
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
생성된 COD 턴 인 페이지의 서식 코드입니다. 유효한 값: HTML = HTML 형식입니다. COD 턴 인 페이지에는 HTML 형식만 지원됩니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
설명
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
생성된 COD 턴 인 페이지의 형식 코드에 대한 설명입니다. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Base 64로 인코딩된 html 브라우저 이미지 렌더링 소프트웨어. ShipmentResponse 및 ShipAcceptResponse에만 적용됩니다. |
|
코드
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
높은 값 보고서가 생성되는 형식을 나타내는 코드입니다. 유효한 값: PDF = pdf. |
|
설명
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
이미지 형식에 대한 설명입니다. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Base 64로 인코딩된 PDF 이미지입니다. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
URL은 레이블, 영수증 및 기타 문서(해당하는 경우 HighValueReport, CustomsInvoice 및 ImportControl 지침)를 요청할 수 있는 페이지를 가리킵니다. LabelURL은 Mail Innovations Forward를 제외한 인쇄/전자 ImportControl 배송, 인쇄/전자, 반송 배송, 전달 배송에 대해 LabelLinksIndicator가 요청된 경우에만 반환됩니다. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
URL은 레이블, 영수증 및 기타 문서(해당하는 경우 HighValueReport, CustomsInvoice 및 ImportControl 지침)를 요청할 수 있는 페이지를 가리킵니다. LocalLanguageLabelURL은 LabelLinksIndicator가 인쇄/전자 ImportControl 배송, 인쇄/전자 반품 배송, Mail Innovations Forward를 제외한 전달 배송, LabelLinksIndicator가 로캘 요소와 함께 요청된 경우 반환되지 않는 배송에 대해 요청된 경우에만 반환됩니다. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
URL은 레이블, 영수증 및 기타 문서(해당하는 경우 HighValueReport, CustomsInvoice 및 ImportControl 지침)를 요청할 수 있는 페이지를 가리킵니다. ReceiptURL은 LabelLinksIndicator가 인쇄/전자 ImportControl 배송, 인쇄/전자 반품 배송에 대해 요청된 경우에만 반환됩니다. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
URL은 레이블, 영수증 및 기타 문서(해당하는 경우 HighValueReport, CustomsInvoice 및 ImportControl 지침)를 요청할 수 있는 페이지를 가리킵니다. LocalLanguageReceiptURL은 LabelLinksIndicator가 인쇄/전자 ImportControl 배송, 인쇄/전자 반품 배송, Mail Innovations Forward를 제외한 전달 배송, LabelLinksIndicator가 로캘 요소와 함께 요청된 경우 반환되지 않는 배송에 대해 요청된 경우에만 반환됩니다. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Image(Pdf 형식) 모든 위험 상품 패키지에 필요한 모든 Dangrous 제품 배송 용지 사본이 포함된 여러 페이지 PDF 문서가 반환됩니다. DGSignatoryInfo가 있는 경우에만 반환됩니다. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
마스터 판지 ID입니다. MasterCartonIndicator가 요청에 있으면 MasterCartonID가 반환됩니다. |
배송 취소
배송 취소 API는 이전에 예약된 배송을 취소하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
배송 ID 번호
|
shipmentidentificationnumber | True | string |
배송의 ID 번호입니다. |
|
추적 번호
|
trackingnumber | string |
패키지의 추적 번호입니다. |
|
|
트랜잭션 ID
|
transid | True | string |
요청에 고유한 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
코드
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
트랜잭션의 성공 또는 실패를 식별합니다. |
|
설명
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
응답 상태 코드를 설명합니다. 성공 텍스트를 반환합니다. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
고객이 제공한 데이터입니다. XML일 수 있습니다. 이 데이터가 요청에 있으면 고객에게 다시 에코됩니다. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
요청에 고유한 식별자입니다. |
|
코드
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
요약 결과의 상태에 대한 코드입니다. |
|
설명
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
요약 결과의 상태에 대한 설명입니다. |
|
코드
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
요약 결과의 상태에 대한 코드입니다. |
|
설명
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
요약 결과의 상태에 대한 설명입니다. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
패키지의 ID 번호입니다. |
주소 유효성 검사 거리 수준
주소 유효성 검사 거리 수준 API를 사용하여 미국 및 푸에르토리코에서 유효한 주소의 미국 우편 서비스 데이터베이스에 대한 주소를 확인할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
요청 옵션
|
requestoption | True | integer |
주소 유효성 검사 요청의 요청 옵션입니다. |
|
지역별 요청 표시기
|
regionalrequestIndicator | string |
주소 유효성 검사 요청의 지역별 요청 표시기입니다. |
|
|
최대 후보 목록 크기
|
maximumcandidatelistsize | integer |
주소 유효성 검사 요청의 최대 후보 목록 크기입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
코드
|
XAVResponse.Response.ResponseStatus.Code | string |
시스템에서 반환된 경고 코드입니다. |
|
설명
|
XAVResponse.Response.ResponseStatus.Description | string |
시스템에서 반환된 메시지입니다. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
쿼리에서 올바른 일치 항목을 찾았습니다. |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
쿼리가 제공된 정보에 따라 일치 항목을 찾을 수 없음을 나타냅니다. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
후보를 찾을 수 없습니다. |
|
코드
|
XAVResponse.AddressClassification.Code | string |
입력 주소의 분류 코드를 포함합니다. |
|
설명
|
XAVResponse.AddressClassification.Description | string |
주소 분류 코드의 텍스트 설명을 포함합니다. |
|
후보
|
XAVResponse.Candidate |
추적
추적 API는 패키지, 지상 화물 및 항공 화물 운송을 지원합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
문의 번호
|
inquiryNumber | True | string |
UPS 추적 정보에 액세스하는 데 사용되는 조회 번호입니다. |
|
트랜잭션 ID
|
transid | True | string |
요청에 고유한 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
선적
|
trackResponse.shipment | array of object |
문의 번호와 관련된 배송 세부 정보를 포함하는 요소입니다. |
|
패키지
|
trackResponse.shipment.package | array of object |
패키지 세부 정보를 포함하는 요소입니다. |
|
추적 번호
|
trackResponse.shipment.package.trackingNumber | string |
작은 패키지, 메일 혁신, 화물 또는 야간 추적 번호입니다. |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
유형
|
trackResponse.shipment.package.deliveryTime.type | string |
배달 유형을 나타냅니다. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
시작 시간, 커밋된 시간 또는 배달된 시간입니다. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
창의 종료 시간입니다. |
|
활동
|
trackResponse.shipment.package.activity | array of object |
inquiryNumber와 연결된 검사 작업을 포함하는 컨테이너 요소입니다. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
유형
|
trackResponse.shipment.package.activity.status.type | string |
활동 유형입니다. |
|
묘사
|
trackResponse.shipment.package.activity.status.description | string |
상태 설명입니다. |
|
코드
|
trackResponse.shipment.package.activity.status.code | string |
상태 코드입니다. |
|
날짜
|
trackResponse.shipment.package.activity.date | string |
활동의 날짜입니다. |
|
시간
|
trackResponse.shipment.package.activity.time | string |
활동의 시간입니다. |