본문으로 건너뛰기

국제 운송 컨테이너 코드 및 선사 코드 생성

윌로그 플랫폼에서 제공하는 국제 운송 컨테이너 코드 및 선사 코드를 생성하는 API입니다. 이 API를 사용하여 새로운 컨테이너 코드와 선사 코드를 생성할 수 있습니다.

Request


POST ext/v1/ocean/reference-numbers/:referenceNumber/carrier

Path Variable

NameDescription
referenceNumber관리번호

Request Body

  • carrierCode: REQUIRED STRING - 선사 코드
  • containerCode: REQUIRED STRING - 컨테이너 코드
  • blNumber: OPTIONAL STRING - B/L 번호

carrierCode값은 서비스 지원 선사 코드의 선사 코드 내용을 참고해 주시기 바랍니다.

Example Request

POST /ext/v1/ocean/reference-numbers/:referenceNumber/carrier
Authorization: Bearer token
{
"carrierCode": "HDMU",
"containerCode": "VPLU0000460",
"blNumber": "HASLS21299999999"
}

Response


Response Body

  • success: boolean - 성공 여부
  • message: string - 비고

Example Success Response

HTTP/1.1 200 OK

{
"success": true,
"message": "Carrier code and Container Code are linked to given reference number successfully"
}

Example Error Response

- 선사 코드 또는 컨테이너 코드가 이미 다른 관리번호에 연결된 경우

HTTP/1.1 200 OK

{
"success": false,
"message": "Carrier code or Container Code is already linked to another reference number"
}

- 관리번호에 디바이스가 설정되지 않은 경우

HTTP/1.1 200 OK

{
"success": false,
"message": "No device was set for the reference number"
}

- 선사 코드를 찾을 수 없는 경우

HTTP/1.1 200 OK

{
"success": false,
"message": "Carrier not found for given carrierCode: HDMU"
}

- 컨테이너 번호 형식이 올바르지 않은 경우

HTTP/1.1 200 OK

{
"success": false,
"message": "Invalid container code format."
}

- 선사가 컨테이너 번호 조회를 지원하지 않는 경우 (컨테이너 코드 + 선사 코드만 입력되고 B/L 번호가 없는 경우)

HTTP/1.1 200 OK

{
"success": false,
"message": "Carrier HDMU does not support container linking"
}