요금 조회
이 API는 현재 계정에서 사용 가능한 배송 채널의 운송 요금을 조회합니다.serviceCodes 값을 생략하면, 계정에서 사용할 수 있는 모든 채널의 요금을 반환합니다.
요청 URL
/shipment/rates
요청 방식
POST
요청 본문 파라미터
| 파라미터명 | 예시 | 타입 | 필수 | 설명 |
|---|---|---|---|---|
| sellerOrderNumber | TESTORDER-001 | String | 아니오 | 판매 주문 번호 |
| serviceCodes | [] | Array | 아니오 | 서비스 코드 목록. 생략 시 모든 사용 가능한 채널 조회 |
| shipFrom (발송인 주소) | ||||
| code | – | String | 아니오 | 발송지 주소 코드 |
| name | TEST | String | 예 | 발송자 이름 또는 회사명 |
| attentionName | TEST | String | 아니오 | 담당자 |
| countryCode | US | String | 예 | 국가 코드 (2자리) |
| stateCode | CA | String | 예 | 주 코드 (2자리) |
| city | rowland height | String | 예 | 도시 |
| addressLine1 | test | String | 예 | 주소 1 |
| addressLine2 | – | String | 아니오 | 주소 2 |
| postalCode | 91748 | String | 예 | 우편번호 |
| phone | 0000000000 | String | 예 | 전화번호 |
| phoneExtension | 0000 | String | 아니오 | 내선 |
| isResidential | false | Boolean | 예 | 거주지 주소 여부 |
| shipTo (수취인 주소) | ||||
| name | TEST | String | 예 | 수취인 이름 또는 회사명 |
| attentionName | TEST | String | 아니오 | 담당자 |
| countryCode | US | String | 예 | 국가 코드 |
| stateCode | CA | String | 예 | 주 코드 |
| city | rowland height | String | 예 | 도시 |
| addressLine1 | test | String | 예 | 주소 1 |
| addressLine2 | – | String | 예 | 주소 2 |
| postalCode | 91748 | String | 예 | 우편번호 |
| phone | 0000000000 | String | 예 | 전화번호 |
| phoneExtension | 0000000000 | String | 아니오 | 내선 |
| isResidential | true | Boolean | 예 | 거주지 주소 여부 |
| packages (패키지 정보) | ||||
| length | 10 | Number | 예 | 길이 |
| width | 10 | Number | 예 | 너비 |
| height | 10 | Number | 예 | 높이 |
| weight | 14 | Number | 예 | 무게 |
| quantity | 1 | Number | 예 | 수량 |
| declaredValue | 100 | Number | 아니오 | 보험 가치 (USD) |
| reference1 | REF01 | String | 아니오 | 참조번호 1 |
| reference2 | – | String | 아니오 | 참조번호 2 |
| options (배송 옵션) | ||||
| dimensionUnitCode | IN | String | 예 | 사이즈 단위 (IN = 인치) |
| weightUnitCode | LBS | String | 예 | 무게 단위 (LBS = 파운드) |
| packageType | customPackage | String | 아니오 | 패키지 유형 |
| shipDate | 2022-05-14 | String | 아니오 | 배송 날짜 (YYYY-MM-DD) |
| deliveryConfirmation | signature | String | 아니오 | 서명 서비스: none / signature / adultSignature |
요청 예시
{
"sellerOrderNumber": "TESTORDER-001",
"serviceCodes": [],
"shipFrom": {
"code": "",
"name": "TEST",
"attentionName": "TEST",
"countryCode": "US",
"stateCode": "CA",
"city": "rowland height",
"addressLine1": "test",
"addressLine2": "",
"postalCode": "91748",
"phone": "0000000000",
"phoneExtension": "0000",
"isResidential": false
},
"shipTo": {
"name": "TEST",
"attentionName": "TEST",
"countryCode": "US",
"stateCode": "CA",
"city": "rowland height",
"addressLine1": "test",
"addressLine2": "",
"postalCode": "91748",
"phone": "0000000000",
"phoneExtension": "0000000000",
"isResidential": true
},
"packages": [
{
"length": 10,
"width": 10,
"height": 10,
"weight": 14,
"quantity": 1,
"declaredValue": 100,
"reference1": "REF01",
"reference2": ""
}
],
"options": {
"dimensionUnitCode": "IN",
"weightUnitCode": "LBS",
"packageType": "customPackage",
"shipDate": "2022-05-14",
"deliveryConfirmation": "signature"
}
}응답 예시
{
"code": 200,
"data": {
"rates": [
{
"rateId": "rate_clrt0d0o2hotek12v7u0",
"rate": 13.06,
"chargeItems": null,
"currencyCode": "USD",
"carrierCode": "FedEx",
"carrierName": "FedEx",
"serviceCode": "FedExGround",
"accountCode": "FedEx",
"isCubic": false
}
],
"messages": null
},
"message": "success"
}