API 포털

WMS 포털

운송장 생성

요청 URL

/shipment/createLabel

요청 방식

POST

요청 본문 파라미터

파라미터명	예시	타입	필수	설명
sellerOrderNumber	TESTORDER-001	String	예	판매 주문 번호
serviceCode	–	String	예	배송 서비스 코드
poZipCode	–	String	예	발송 창고 우편번호 (5자리, 일부 USPS 전용)
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	예	2자리 국가 코드
stateCode	CA	String	예	2자리 주 코드
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	아니오	패키지 유형 (기본값: customPackage)
shipDate	2022-05-14	String	아니오	발송일 (YYYY-MM-DD)
deliveryConfirmation	signature	String	아니오	서명 서비스: none / signature / adultSignature
isReturnLabel	false	Boolean	아니오	반품 운송장 여부
isDG	false	Boolean	아니오	위험물 여부
isUniqueSellerOrderNumber	false	String	아니오	주문번호의 고유성 강제 여부

요청 예시

{
  "sellerOrderNumber": "TESTORDER-001",
  "shipFrom": {
    "name": "TEST",
    "attentionName": "TEST",
    "countryCode": "US",
    "stateCode": "CA",
    "city": "rowland height",
    "addressLine1": "test",
    "addressLine2": "",
    "postalCode": "91748",
    "phone": "0000000000",
    "phoneExtension": "0000"
  },
  "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,
      "reference1": "REF01"
    }
  ],
  "options": {
    "dimensionUnitCode": "IN",
    "weightUnitCode": "LBS"
  }
}

응답 예시

{
  "code": 200,
  "data": {
    "masterTrackingNumber": "1Z005780000000000",
    "ShipmentNo": "shipment_c26h06ron0mddh2186p0",
    "carrierCode": "UPS",
    "serviceCode": "UPSGround",
    "totalCharge": 10.02,
    "currencyCode": "USD",
    "chargeItems": null,
    "labelUrl": "https://pdf_url",
    "labelFileType": "pdf",
    "trackingNumbers": [
      "1Z005780000000000"
    ],
    "sellerOrderNumber": "TESTORDER-001",
    "fileDatas": null
  },
  "message": "success"
}