International Shipping Delivery Data Creation

You can upload delivery data for shipment departures using the Willog platform. Data with success as true is created, and data with false indicates a failure.

Request

---

POST ext/v1/ocean/reference-numbers

Request Body

• data: REQUIRED ARRAY - 배송 데이터 리스트
  • referenceNumber: REQUIRED STRING - Reference number
  • serialNumber: REQUIRED STRING - Device serial number
  • destinationName: REQUIRED STRING - Customer name
  • productName: REQUIRED STRING - Product name
  • departureTime: OPTIONAL NUMBER - Departure time timestamp(ms)
  • carrierNumber: OPTIONAL STRING - Carrier code number
  • containerCode: OPTIONAL STRING - Container number
  • memo: OPTIONAL STRING - Remarks
  • useDoorOpenAlarm: OPTIONAL BOOLEAN - Door open alarm usage
  • autoDepartureDelayMinutes: OPTIONAL NUMBER - Auto departure delay time
  • alarmRange: OBJECT - Alarm range
    • abnormal: OBJECT - Abnormal alarm
      • temperature: OBJECT - Temperature
        • min: OPTIONAL NUMBER - Minimum temperature
        • max: OPTIONAL NUMBER - Maximum temperature
      • humidity: OBJECT - Humidity
        • min: OPTIONAL NUMBER - Minimum humidity
        • max: OPTIONAL NUMBER - Maximum humidity
      • acceleration: OBJECT - Shock
        • acc: OPTIONAL NUMBER - Shock value

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 - Success status
• message: STRING - Remarks
• errors: ARRAY - Errors
• referenceNumber: STRING - Reference number
  • index: NUMBER - Order
  • rowErrors: ARRAY - Row errors
  • message: STRING - English error message
  • messageKo: STRING - Korean error message
  • sub: STRING - Code type
  • errorCodeName: STRING - Error code name
  • serials: ARRAY - Related device serial numbers

Error Code Types

Name	Description
MandatoryFieldNotEmpty	Mandatory field
InvalidFieldValue	Invalid value
NotRegisteredValue	Non-existent item or value
InvalidDateFormat	Invalid date format
InvalidFormat	Invalid format
InvalidMaxLength	Exceeded maximum character limit
InvalidTextCharacter	Contains invalid character
InvalidCodeIncludedSpaceValue	Contains space in the middle
CodeDuplicatedInCompany	Reference number already duplicated in company
CodeDuplicatedInRequests	Reference number duplicated in request
TooLongProductNameLength	Product name exceeds 20 characters
CannotBeLessMaximumThanMinimum	Minimum and maximum values are reversed
InvalidHumidityValueType	Invalid humidity value
InvalidTemperatureValueType	Invalid temperature value
InvalidAlarmRange	Invalid alarm range
NotRegisteredDevice	Unregistered device
CannotCreateDeviceDuplicatedSerial	Duplicate device in request
BannedDevice	Banned device
AlreadyUsingDevice	Device already in use
UnavailableCarrierCode	Unregistered carrier code

Example Response

Success case

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

Error case

{
  "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": []
        }
      ]
    }
  ]
}