HOhomepick
3. Order

오늘도착 주문 접수

홈픽 서비스 오늘도착 주문정보 접수

post/v1/orderToday

Request

Query parameters

partnerOrderNoDuplicateCheckboolean

제휴사 주문번호 중복 체크 여부

partnerInvoiceNoDuplicateCheckboolean

제휴사 운송장번호 중복 체크 여부

returnDetailMessageOnErrorboolean

에러 발생시 상세 메시지 리턴

Request body

fromZipCode'range[0' | '5]'

보내는 분 우편번호

fromNamestring

보내는 분 이름

fromPhoneNumberstring

보내는 분 연락처(휴대폰)

fromAddr1string

보내는 분 주소1

fromAddr2string

보내는 분 주소2

toZipCode'range[0' | '5]'

받는 분 우편번호

toNamestring

받는 분 이름

toPhoneNumberstring

받는 분 연락처

toAddr1string

받는 분 주소1

toAddr2string

받는 분 주소2

boxType'XXSMALL' | 'XSMALL' | 'SMALL' | 'MEDIUM' | 'MEDIUM_LARGE' | 'LARGE' | 'XLARGE'

박스 종류

boxCountinteger

박스 수량

itemCategorystring

상품 유형

itemNamestring

상품명

itemPriceinteger

상품가격 (최대:200만원)

itemQuantityinteger

상품수량(박스 1개에 담긴 수량)

pickupMessagestring

픽업 기사에게 메시지

deliveryMessagestring

배달 기사에게 메시지

pickupRequestDateTimestring

픽업 요청(희망) 일시 (현재시간 이후)

deliveryRequestDateTimestring

배송 요청(희망) 일시 (최대 요청가능일 +30일)

partnerOrderNostring

제휴사 주문번호

partnerInvoiceNostring

제휴사 운송장번호

partnerMemostring

제휴사 메모

partnerOriginOrderNostring

제휴사 원 주문번호

deliveryType'D_SHIPPING' | 'D_CONVENIENCE' | 'D_PICKUP' | 'D_QUICK' | 'D_CARGO' | 'D_TODAY_P' | 'D_TODAY_D' | 'D_TODAY_PD'

배송 종류(D_TODAY_P 픽업,D_TODAY_D 배송,D_TODAY_PD 픽업&배송)

terminalFirstCodestring

오늘도착(배송) 터미널 코드

terminalFinalCodestring

오늘도착(픽업) 터미널 코드

sendAlimtalkImmediatelyboolean

시간과 관계없이 알림톡 즉시발송 (값을 지정하지 않거나 false인 경우 내부 설정값(발송 마감시간, 예약시간)에 의해 발송)

commonEntrancePasswordstring

공동현관 비밀번호

Example request

[
  {
    "fromZipCode": "07988",
    "fromName": "홍길동",
    "fromPhoneNumber": "01011110000",
    "fromAddr1": "서울 양천구 목동서로 117",
    "fromAddr2": "2층 굿스코아",
    "toZipCode": "06095",
    "toName": "임꺽정",
    "toPhoneNumber": "01011110000",
    "toAddr1": "서울 강남구 봉은사로 479",
    "toAddr2": "47타워 16층 굿스플로",
    "boxType": "MEDIUM",
    "boxCount": 1,
    "itemCategory": "옷",
    "itemName": "폴로셔츠",
    "itemPrice": 50000,
    "itemQuantity": 1,
    "pickupMessage": "현관 앞에 둘게요.",
    "deliveryMessage": "경비실에 맡겨 주세요.",
    "pickupRequestDateTime": "2022-05-27 13:00",
    "deliveryRequestDateTime": "2022-05-27 13:00",
    "partnerMemo": "홍길동 고객님 접수 건",
    "deliveryType": "D_TODAY_D",
    "terminalFirstCode": "T_PANGYO",
    "terminalFinalCode": "T_PANGYO",
    "sendAlimtalkImmediately": true,
    "commonEntrancePassword": "#1234"
  }
]

Response

성공

successboolean

성공여부

messagestring

메시지

responseDateTimestring date-time

응답 서버 시간

Example response

{
  "success": true,
  "message": "오류가 있을 경우 오류 메시지",
  "data": {
    "orderNo": "210518-00077",
    "orderBoxList": [
      {
        "deliveryType": "D_PICKUP",
        "deliveryTypeName": "오늘픽업",
        "invoiceNo": "220527-00077-001",
        "boxType": "SMALL",
        "boxTypeName": "소형",
        "boxCost": 4500,
        "addedCost": 5000,
        "totalCost": 9500,
        "partnerMemo": "홍길동 고객님 접수 건",
        "transporter": "HOMEPICK3",
        "transporterName": "홈픽v3",
        "orderStatus": "RECEIVED",
        "orderStatusName": "접수완료",
        "partnerOriginOrderNo": "OD-54472342001",
        "toCoordinates": {
          "latitude": 37.4979,
          "longitude": 127.0276
        },
        "fromCoordinates": {
          "latitude": 37.4979,
          "longitude": 127.0276
        }
      }
    ]
  },
  "responseDateTime": "2022-05-27T14:45:13.051+09:00"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.