본문으로 건너뛰기

Box 배송 도착 API

배송 중인 Box 배송의 도착 처리를 진행합니다.

온도 데이터가 있어야만 도착 처리가 가능합니다.

  • 보내주신 fetchedManualArrivalTime 의 시간 값으로 도착 처리됩니다.
  • 만약 fetchedManualArrivalTime 가 없으면 현재 시간으로 도착 처리됩니다.
  • 도착 시간은 현재 시간보다 이전이어야 하며, 배송의 출발 시간보다 이후여야 합니다.

Request


POST https://openapi.willog.io/ext/v1/box/transports/{transportCode}/arrive

Path Variable

NameDescription
transportCode배송 코드

Request Body

NameTypeRequiredDescription
customerCodeStringfalse고객사 코드
fetchedManualArrivalTimeUnix timestamp(ms)false수동으로 설정할 도착 시간

Example Request

POST /ext/v1/box/transports/{transportCode}/arrive
Authorization: Bearer token
{
"customerCode": "customer1",
"fetchedManualArrivalTime": 1738665219000
}

Response


Response Body

NameTypeNot-nullDescription
transportCodeStringtrue배송 코드
serialStringtrue디바이스 시리얼
departureTimeUnix timestamp(ms)true출발 시간
arrivalTimeUnix timestamp(ms)true도착 시간
fetchedManualArrivalTimeUnix timestamp(ms)false설정한 도착 시간

Example Response

HTTP/1.1 200 OK

{
"transportCode": "5089229ca9f1",
"serial": "AB000343",
"departureTime": 1738655274000,
"arrivalTime": 1738665219000,
"fetchedManualArrivalTime": 1738665219000
}

Error Responses

- 배송이 존재하지 않는 경우

HTTP/1.1 400 Bad Request

{
"code": "T0088"
}

- 배송에 사용된 디바이스가 존재하지 않는 경우

HTTP/1.1 400 Bad Request

{
"code": "T0025"
}

- 도착 처리할 수 없는 배송 상태인 경우

HTTP/1.1 400 Bad Request

{
"code": "T0082"
}

- 도착 시간이 현재 시간 이후인 경우

HTTP/1.1 400 Bad Request

{
"code": "T0101"
}

- 도착 시간이 출발 시간 이전인 경우

HTTP/1.1 400 Bad Request

{
"code": "T0061"
}

- 측정 데이터가 존재하지 않는 경우

HTTP/1.1 400 Bad Request

{
"code": "T0048"
}