택배 차량 등록(연동)

차량 번호를 기준으로 요청한 택배 차량을 새로 등록하거나 수정하는 API입니다.

• 차량 번호가 있을 경우:
  • 차량 번호에 해당하는 데이터가 보내주신 데이터로 업데이트 처리됩니다.
• 차량 번호가 없을 경우:
  • 해당 차량 번호로 새로운 택배 차량이 등록됩니다.

기존 차량의 특정 데이터를 제거하고 싶을 경우, 제거하려는 데이터 필드에 null 값을 보내주시면 됩니다. 반대로 특정 데이터를 유지하고 싶을 경우, 해당 데이터를 온전히 보내주셔야 합니다.

같은 차량 번호가 하나 이상 요청에 포함될 경우, 해당 차량 번호는 모두 실패 처리됩니다.

Request

---

PUT https://openapi.willog.io/hub/v1/delivery-trucks

Request Body

Name	Type	Required	Description
vehicles	Array	true	차량 데이터 목록 (max: 200)
vehicles[].identifier	String	true	차량번호
vehicles[].assetCode	String	false	관리 번호
vehicles[].driverName	String	false	운전자 이름
vehicles[].groupName	String	false	그룹명(센터명)
vehicles[].weightKg	Number	false	무게(kg) (min: 0)
vehicles[].memo	String	false	메모 (비고)

Example Request

PUT /hub/v1/delivery-trucks
Authorization: Bearer apiKey

{
    "vehicles": [
        {
            "identifier": "12가3456",
            "assetCode": "ABCD-1234",
            "weightKg": 1000,
            "memo": null,
            "driverName": null,
            "groupName": null
        },
        {
            "identifier": "09가8765",
            "assetCode": "EFGH-5678",
            "weightKg": 3000,
            "memo": "주말 배송 차량",
            "driverName": null,
            "groupName": null
        }
    ]
}

Response

---

Response Body

Name	Type	Not-null	Description
items	Array	true	반환되는 배열 데이터
items[].resultCode	String	true	택배 차량 등록 결과
items[].identifier	String	true	차량 번호
items[].identifierType	String	true	운송수단 식별자 타입
items[].assetCode	String	false	관리 번호

ResultCode

Name	Description
SUCCESS	성공
DUPLICATE_REQUEST_IDENTIFIER	실패(같은 차량 번호가 하나 이상 요청에 포함될 경우)

Identifier Types

Name	Description
CAR_LICENSE_NUMBER	차량 번호

Example Response

HTTP/1.1 200 OK

{
  "items": [
    {
      "resultCode": "SUCCESS",
      "identifier": "12가3456",
      "assetCode": "ABCD-1234",
      "identifierType": "CAR_LICENSE_NUMBER"
    },
    {
      "resultCode": "DUPLICATE_REQUEST_IDENTIFIER",
      "identifier": "34가5678",
      "assetCode": "ABCD-5678",
      "identifierType": "CAR_LICENSE_NUMBER"
    },
    {
      "resultCode": "DUPLICATE_REQUEST_IDENTIFIER",
      "identifier": "34가5678",
      "assetCode": "EFGH-1234",
      "identifierType": "CAR_LICENSE_NUMBER"
    }
  ]
}

Error Responses

- 유효하지 않은 토큰 및 인증키

HTTP/1.1 400 Bad Request

{
    "code": "A0010"
}

- 잘못된 파라미터로 요청

HTTP/1.1 400 Bad Request

{
    "code": "E0021"
}

- 서버 에러

HTTP/1.1 500 Internal Server Error

{
    "code": "OA-9999"
}