Query parameters

• documentReference string

  Announcement document reference.

• voyageAgentReference string

  Voyage agent reference to filter.

• voyageAgentId string

  S)One identifier of the voyage agent to filter.

• customsFlag string

  Type of flow.

  Values are Unknown, Import, Export, Transhipment, or Transit.

• freightAgent string

  Agent code of shipping company.

  Default value is empty.

• desc boolean

  Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.

  Default value is false.

• limit integer(int32)

  Number of results to be returned. Max value is 10.

  Maximum value is 10. Default value is 5.

• offset integer(int32)

  Index of the first returned result.

  Default value is 0.

Responses

• 200 application/json

  Success

  Hide response attributes Show response attributes object

  • total integer(int32)

    Total amount of objects matching given parameters.

  • returned integer(int32)

    Amount of objects returned by the paginated query.

  • first integer(int32)

    Index of the first returned object.

  • items array[object] | null

    Items returned by the query.

    Handling unit information
    An handling unit corresponds to a container or a good.

    Hide items attributes Show items attributes object

    • reference string | null

      Handling unit reference.
      e.g. if the handling unit is an an equipment, this reference should follow the BIC ISO Container Identification Number where possible.

      Minimum length is 0, maximum length is 17.

    • pswId string | null

      S)ONE ID of the handling unit.
      This unique identifier is composed of a prefix(3 characters) and a number(10 digits).

      Minimum length is 0, maximum length is 13.

    • freightFamily string

      The freight family handled by this service is only Container and Breakbulk.
      - Container : Toys, televisions, DVDs, clothing, meat and computers; containers are the best way to transport these and many similar products. By efficiently loading the goods, they can be transported simultaneously in large quantities. The standard sizes mean containers fit on sea-going vessels, lorries, inland barges and train wagons.
      - BreakBulk : Paper, wood, bags of cocoa, rolls of steel, parts of wind turbines; these are all products that can be transported in a container or simply put on a vessel.

      Values are Container, BreakBulk, SolidBulk, LiquidBulk, or MobileUnits.

    • sizeType string | null

      Size type of container.
      Applicable for containers only.

    • packagingCode string | null

      Packaging code of breakbulk.
      Applicable for breakbulk only.

    • measures object

      Handling unit measures.

      Additional properties are NOT allowed.

      Hide measures attributes Show measures attributes object

      • quantity integer(int32) | null

        Number of packages.

      • weight object

        Weight (the default unit is KGM) :
        - GrossWeight
        - Tare : applicable for container only
        - NetWeight

        Additional properties are NOT allowed.

        Hide weight attributes Show weight attributes object

        • tare object

          This object concerns the following fields :
          
          - GrossWeight (the default unit is KGM)
          - Tare (the default unit is KGM)
          - NetWeight (the default unit is KGM)
          - Volume (the default unit is DMQ)

          Additional properties are NOT allowed.

          Hide tare attributes Show tare attributes object

          • value number(double) | null

            Measure value.

          • unit string | null

            Value which comes from the international system of units.

            Minimum length is 0, maximum length is 5.

        • grossWeight object

          This object concerns the following fields :
          
          - GrossWeight (the default unit is KGM)
          - Tare (the default unit is KGM)
          - NetWeight (the default unit is KGM)
          - Volume (the default unit is DMQ)

          Additional properties are NOT allowed.

          Hide grossWeight attributes Show grossWeight attributes object

          • value number(double) | null

            Measure value.

          • unit string | null

            Value which comes from the international system of units.

            Minimum length is 0, maximum length is 5.

        • netWeight object

          This object concerns the following fields :
          
          - GrossWeight (the default unit is KGM)
          - Tare (the default unit is KGM)
          - NetWeight (the default unit is KGM)
          - Volume (the default unit is DMQ)

          Additional properties are NOT allowed.

          Hide netWeight attributes Show netWeight attributes object

          • value number(double) | null

            Measure value.

          • unit string | null

            Value which comes from the international system of units.

            Minimum length is 0, maximum length is 5.

      • volume object

        This object concerns the following fields :
        
        - GrossWeight (the default unit is KGM)
        - Tare (the default unit is KGM)
        - NetWeight (the default unit is KGM)
        - Volume (the default unit is DMQ)

        Additional properties are NOT allowed.

        Hide volume attributes Show volume attributes object

        • value number(double) | null

          Measure value.

        • unit string | null

          Value which comes from the international system of units.

          Minimum length is 0, maximum length is 5.

      • remainingQuantity integer(int32) | null

        Number of packages remaining at current location.
        This field is used in the context of partial reports.
        Applicable for breakbulk only.

      • availableQuantity integer(int32) | null

        Number of packages available at current location.
        This field is used in the context of partial reports.
        Applicable for breakbulk only.

      • reportedQuantity integer(int32) | null

        Number of package reported reported at current location.
        This field is used in the context of partial reports.
        Applicable for breakbulk only.

      • remainingWeight object

        This object concerns the following fields :
        
        - GrossWeight (the default unit is KGM)
        - Tare (the default unit is KGM)
        - NetWeight (the default unit is KGM)
        - Volume (the default unit is DMQ)

        Additional properties are NOT allowed.

        Hide remainingWeight attributes Show remainingWeight attributes object

        • value number(double) | null

          Measure value.

        • unit string | null

          Value which comes from the international system of units.

          Minimum length is 0, maximum length is 5.

    • indicators object

      Handling unit indicators.

      Additional properties are NOT allowed.

      Hide indicators attributes Show indicators attributes object

      • hazardous boolean

        Hazardous indicator.

      • empty boolean

        Indicator to denote whether the equipment is empty or laden.
        Applicable for the container only.

      • reefer boolean

        Reefer indicator.

      • pollutant boolean

        Pollutant indicator.

      • fumigation boolean

        Fumigation indicator.

      • quarantine boolean

        Quarantine indicator.

    • references array[object] | null

      Linked references. This reference should be :
      a sequence number for export process,
      a rank reference for export process.

      References linked to the handling unit
      e.g. for process export, the equipment can be identified by the sequence number.

      Hide references attributes Show references attributes object

      • type string

        Type of references which identified the handling unit. The possible values are :
        - Rank and SequenceNumber for export procedure

        Values are Rank or SequenceNumber.

      • value string | null

        Value of reference.

    • customsFlag string

      List of possible customs flag information :
      - Unknown (undefined flag - default value)
      - Import
      - Export
      - Transhipment
      - Transit

      Values are Unknown, Import, Export, Transhipment, or Transit.

    • huLocation object

      Current location information

      Additional properties are NOT allowed.

      Hide huLocation attributes Show huLocation attributes object

      • place string | null

        Current place of the handling unit.

      • location string | null

        Current location of the handling unit.

    • actors object

      Actors information.

      Additional properties are NOT allowed.

      Hide actors attributes Show actors attributes object

      • freightAgent string | null

        Freight Agent.

      • freightForwarder string | null

        Freight Forwarder.

    • temperatures object

      Temperature information.

      Additional properties are NOT allowed.

      Hide temperatures attributes Show temperatures attributes object

      • setPoint number(double) | null

        Set point temperature.
        The default unit is C.

      • rangeMin number(double) | null

        Min temperature.
        The default unit is C.

      • rangeMax number(double) | null

        Max temperature.
        The default unit is C.

    • shipments array[object] | null

      Shipments information.
      This corresponds to the documentary information related to the handling unit, such as booking or bill of lading information.

      Shipment item.

      Hide shipments attributes Show shipments attributes object

      • documentReference string | null

        Reference of document that links to a shipment.
        e.g. the reference should be a bill of lading number

        Minimum length is 0, maximum length is 32.

      • documentId string | null

        S)ONE ID of document.
        This unique identifier is composed of a prefix (3 characters) and a number (10 digits).>

        Minimum length is 0, maximum length is 13.

      • documentType integer(int32) | null

        Type of document (1001 norm Un/Edifact).

      • documentDate string(date-time) | null

        Date of document.
        ISO 8601 Extended Format

      • originLocation string | null

        Place of origin of the shipment.

        Minimum length is 0, maximum length is 20.

      • destinationLocation string | null

        Place of destination of the shipment.

        Minimum length is 0, maximum length is 20.

      • processingIndicator string

        List of possible processing indicator :
        - Unknown (undefined flag - default value)
        - Import
        - Export
        - Transhipment
        - Transit

        Values are Unknown, Transit, Transhipment, Import, or Export.

      • merchantHaulage boolean

        Indicator specifying that the freight forwarder may modify the shipment.

    • transport object

      Transport information.

      Additional properties are NOT allowed.

      Hide transport attributes Show transport attributes object

      • meansName string | null

        Transport means name.

        Minimum length is 0, maximum length is 384.

      • voyageId string | null

        S)ONE ID of the voyage.
        This unique identifier is composed of a prefix (3 characters) and a number (10 digits).

        Minimum length is 0, maximum length is 13.

      • mode integer(int32)

        Transport mode.
        Unece Recommendation 19

      • meansNationality string | null

        Transport means nationality.
        ISO 3166 alpha 3

      • voyageDates object

        Transport dates

        Additional properties are NOT allowed.

        Hide voyageDates attributes Show voyageDates attributes object

        • eta string(date-time) | null

          Estimated Time of Arrival is the time when a ship, vehicle, aircraft, cargo, emergency service or person is expected to arrive at its destination.
          ISO 8601 Extended Format

        • etd string(date-time) | null

          Estimated Time of Departure is the time when a ship, vehicle, aircraft, cargo, emergency service or person is expected to depart from its point of origin.
          ISO 8601 Extended Format

        • ata string(date-time) | null

          Actual Time of Arrival is the time that a vessel or any other mode of transportation is determined to arrive at its destination.
          ISO 8601 Extended Format

        • atd string(date-time) | null

          Actual Time of Departure is the time that a vessel or any other mode of transportation is determined to depart from its point of origin.
          ISO 8601 Extended Format

      • schedulePlace string | null

        Schedule place.

        Minimum length is 0, maximum length is 5.

      • voyageAgentId string | null

        Voyage agent internal identifier composed of a prefix (3 characters) and a number (10 digits).

        Minimum length is 0, maximum length is 13.

      • voyageAgentReference string | null

        Reference of the voyage agent.

      • meansType string | null

        Transport means type.

      • meansId array[object] | null

        Transport means identifier.

        The mean identifier for the transport,
        e.g. when the mode of transport is a vessel, the transport mean identifier would be the vessel IMO number.

        Hide meansId attributes Show meansId attributes object

        • type string

          Means identifier type. The possible values are :
          - IMONumber for maritime transport
          - CallSign for maritime transport

          Values are IMONumber, CallSign, IATA, or ICAO.

        • name string | null

          Name of means id

          Minimum length is 0, maximum length is 10.

      • arrivalScheduleReference string | null

        Arrival reference.

        Minimum length is 0, maximum length is 384.

      • departureScheduleReference string | null

        Departure reference.

        Minimum length is 0, maximum length is 384.

    • events array[object] | null

      Events information.

      An event corresponds to a movement or an authorization on the handling unit, occured on a location.

      Hide events attributes Show events attributes object

      • eventType string | null

        Type of event.

      • eventDate string(date-time)

        Event date.
        ISO 8601 Extended Format

      • eventPlace string | null

        Place of event

      • eventLocation string | null

        Location of event

      • eventWay string

        Way of the movement on the location

        Values are In, Out, or Undefined.

      • eventTransportMode integer(int32)

        Transport mode of event
        Unece Recommendation 19

    • hazardousItems array[object] | null

      Hazardous information.

      Hazardous item.

      Hide hazardousItems attributes Show hazardousItems attributes object

      • imoClass string | null

        Dangerous class (IMO)

      • limitedQuantity boolean | null

        Limited quantity

    • emptyReturn object

      Empty return information.

      Additional properties are NOT allowed.

      Hide emptyReturn attributes Show emptyReturn attributes object

      • dueDate string(date-time) | null

        Due date
        ISO 8601 Extended Format

      • finishDateEarliest string(date-time) | null

        Finish date earliest
        ISO 8601 Extended Format

      • finishDateLatest string(date-time) | null

        Finish date latest
        ISO 8601 Extended Format

• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • status string | null

    Http error status.

  • timestamp string(date-time)

    Error date.
    ISO 8601 Extended Format

  • code string | null

    Business error code.
    The possible values are :
    - R001 : No handling unit was found
    - R002 : The handling unit is null
    - R003 : The handling unit is not correctly formated

  • message string | null

    Error message.

• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • status string | null

    Http error status.

  • timestamp string(date-time)

    Error date.
    ISO 8601 Extended Format

  • code string | null

    Business error code.
    The possible values are :
    - R001 : No handling unit was found
    - R002 : The handling unit is null
    - R003 : The handling unit is not correctly formated

  • message string | null

    Error message.