본문으로 건너뛰기

국제운송 배송 데이터 생성

윌로그 플랫폼에서 출고를 위한 배송 데이터 업로드를 할 수 있습니다. success 가 true 인 데이터는 생성, false 인 데이터는 실패한 데이터입니다.

Request​

POST ext/v1/ocean/reference-numbers​

Request Body​

  • data: REQUIRED ARRAY - 배송 데이터 리스트
    • referenceNumber: REQUIRED STRING - 관리번호
    • serialNumber: REQUIRED STRING - 디바이스 시리얼 번호
    • destinationName: REQUIRED STRING - 거래처 이름
    • productName: REQUIRED STRING - 상품 이름
    • departureTime: OPTIONAL NUMBER - 출고시간 timestamp(ms)
    • carrierNumber: OPTIONAL STRING - 선주코드 번호
    • containerCode: OPTIONAL STRING - 컨테이너 번호
    • memo: OPTIONAL STRING - 비고
    • useDoorOpenAlarm: OPTIONAL BOOLEAN - 문열림 알람 여부
    • autoDepartureDelayMinutes: OPTIONAL NUMBER - 자동 출고 시작 지연 시간
    • alarmRange: OBJECT - 일탈 알람 범위
      • abnormal: OBJECT - 일탈 알람
        • temperature: OBJECT - 온도
          • min: OPTIONAL NUMBER - 최소 온도
          • max: OPTIONAL NUMBER - 최대 온도
        • humidity: OBJECT - 습도
          • min: OPTIONAL NUMBER - 최소 습도
          • max: OPTIONAL NUMBER - 최대 습도
        • acceleration: OBJECT - 충격
          • acc: OPTIONAL NUMBER - 충격 값

Request Example​

Example 1​

POST /ext/v1/ocean/reference-numbers
Authorization: Bearer token
{
  "data": [
    {
      "referenceNumber": "A-01-SHQ",
      "serialNumber": "T000A104",
      "destinationName": "타이타닉_A",
      "productName": "타이타닉 모형",
      "departureTime": 1757495851000,
      "carrierNumber": "HMM",
      "containerCode": "VPLU0000460",
      "useDoorOpenAlarm": false,
      "autoDepartureDelayMinutes": null,
      "memo": "memo added",
      "alarmRange": {
        "abnormal": {
          "temperature": {
            "max": 100,
            "min": 10
          },
          "humidity": {
            "max": 50,
            "min": 20
          },
          "acc": {
            "max": 16,
            "min": 0
          }
        }
      }
    }
  ]
}

Example 2​

POST /ext/v1/ocean/reference-numbers
Authorization: Bearer token
{
  "data": [
    {
      "referenceNumber": "A-01-SHQ",
      "serialNumber": "T000A104",
      "destinationName": "타이타닉_A",
      "productName": "타이타닉 모형",
    }
  ]
}

Response​

Response Body​

  • success: BOOLEAN - 성공 여부
  • message: STRING - 비고
  • errors: ARRAY - 에러들
  • referenceNumber: STRING - 관리번호
    • index: NUMBER - 순서
    • rowErrors: ARRAY - 각행별 에러들
    • message: STRING - 영문 에러 메시지
    • messageKo: STRING - 한글 에러 메시지
    • sub: STRING - 구분 코드
    • errorCodeName: STRING - 에러 코드 명
    • serials: ARRAY - 관련된 기기 시리얼 번호

Error Code Types​

NameDescription
MandatoryFieldNotEmpty필수 항목
InvalidFieldValue허용되지 않는 값
NotRegisteredValue존재하지 않는 항목 또는 값
InvalidDateFormat유효하지 않은 날짜 형식
InvalidFormat유효하지 않은 포맷
InvalidMaxLength글자 길이 최대 한도 초과
InvalidTextCharacter유효하지 않은 글자 포함
InvalidCodeIncludedSpaceValue중간에 공백이 들어간 경우
CodeDuplicatedInCompany관리번호가 이미 중복된 이름이 등록된 경우
CodeDuplicatedInRequests관리번호가 request 중에 중복된 경우
TooLongProductNameLength상품 이름이 너무 20자 이상인 경우
CannotBeLessMaximumThanMinimum일탈 알람이 최소최대 값이 역전 된 경우
InvalidHumidityValueType유효하지 않은 습도 값인 경우
InvalidTemperatureValueType유효하지 않은 온도 값인 경우
InvalidAlarmRange유효하지 않은 일탈 알람의 범위인 경우
NotRegisteredDevice등록되지 않은 기기의 경우
CannotCreateDeviceDuplicatedSerial리퀘스트에 중복된 기기가 있는 경우
BannedDevice사용불가한 디바이스의 경우
AlreadyUsingDevice이미 사용중인 중복된 디바이스가 있는 경우
UnavailableCarrierCode등록되지 않은 선박 코드인 경우

Example Response​

성공한 경우​

{
  "success": true,
  "message": "Transport group creation successful",
  "errors": []
}

에러가 있는 경우​

{
  "success": false,
  "message": "Has Errors",
  "errors": [
    {
      "referenceNumber": "T1",
      "index": 0,
      "rowErrors": [
        {
          "message": "Invalid Range. Valid range of Temperature : -300 - 2000",
          "messageKo": "Temperature의 유효한 범위: -300 - 2000 에서 벗어났습니다.",
          "sub": "code",
          "errorCodeName": "InvalidRangeValue",
          "serials": []
        },
        {
          "message": "Invalid acc format: 12.0111",
          "messageKo": "acc에 유효하지 않은 형식: 12.0111",
          "sub": "code",
          "errorCodeName": "InvalidFormat",
          "serials": []
        },
        {
          "message": "not registered device.[deviceSerial]",
          "messageKo": "등록되지 않은 기기입니다.[deviceSerial]",
          "sub": "serials",
          "errorCodeName": "NotRegisteredDevice",
          "serials": []
        },
        {
          "message": "Not Registered value for destinationName field: receiverName}",
          "messageKo": "destinationName의 항목에 존재하지 않은 값: receiverName",
          "sub": "code",
          "errorCodeName": "NotRegisteredValue",
          "serials": []
        },
        {
          "message": "Unavailable carrier code: [HEUNG-AP]",
          "messageKo": "운송 해운사 코드가 유효하지 않습니다.[HEUNG-AP]",
          "sub": "code",
          "errorCodeName": "UnavailableCarrierCode",
          "serials": []
        }
      ]
    }
  ]
}