Sign in
3. Order

주문 접수

홈픽 서비스 주문정보 접수

post/v1/order

Query parameters

partnerOrderNoDuplicateCheckboolean

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

partnerInvoiceNoDuplicateCheckboolean

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

Request body

fromZipCode'range[0' | '5]'

보내는 분 우편번호

fromNamestring

보내는 분 이름

fromPhoneNumberstring

보내는 분 연락처

fromAddr1string

보내는 분 주소1

fromAddr2string

보내는 분 주소2

toZipCode'range[0' | '5]'

받는 분 우편번호

toNamestring

받는 분 이름

toPhoneNumberstring

받는 분 연락처

toAddr1string

받는 분 주소1

toAddr2string

받는 분 주소2

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

배송 종류

transporter'HOMEPICK' | 'HOMEPICK3' | 'TODAY' | 'EPOST' | 'HANJIN' | 'CJGLS' | 'LOTTE' | 'LOGEN' | 'CUHOME' | 'SEVENELEVEN' | 'RETURNALL' | 'DVER' | 'GOGOX' | 'INSUNG'

택배사 코드

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

박스 종류

boxCountinteger

박스 수량

itemCategorystring

상품 유형

itemNamestring

상품명

itemPriceinteger

상품가격

itemQuantityinteger

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

pickupMessagestring

픽업 기사에게 메시지

deliveryMessagestring

배달 기사에게 메시지

pickupRequestDateTimestring

픽업 요청(희망) 일시

deliveryRequestDateTimestring

배송 요청(희망) 일시

partnerOrderNostring

제휴사 주문번호

partnerInvoiceNostring

제휴사 운송장번호

partnerMemostring

제휴사 메모

Example request

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

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 endpoint across all 1 revision of this API.