Jump to

• Request
• Response

Get Voyages

get

/voyages

Request

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/voyages"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object voyages

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/voyages"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : voyages

Type: object

Show Source

• arrRegionName: string
  The voyage's Departure Region name and Arrival Region name are for information only. The Departure and Arrival information is intended to hold the trade lane level description of the voyage e.g., Asia to North America, Middle East to Europe.
• dataSourcePartitionKey: number (double)
  Partition key used to parse the data based on the data source.
• depDate: depDate
  The departure date for the voyage.
• depRegionName: string
  The name of the departure region for the voyage.
• domainName: string
  Database domain where this data is stored.
• insertDate: insertDate
  Read Only: true

  insert date
• isComposite: boolean
  Check box used to identify voyages that are composite voyages i.e., the voyage has a transload point.
  Composite Voyages - A composite voyage is a voyage that takes place using two or more vessels. The main vessel is the 'mother' vessel and can be identified as such when creating a voyage. This enables you to identify which feeder was from the source port and what is the mother vessel discharging at the destination port on the shipment.
  A shipment's last departure stop must be before voyage's first transload stop.
  A shipment's first arrival stop must be after voyage's last transload stop.
  If a transload shipment has a composite voyage, then it will find all transload stops on its voyage and insert them as transload stops on the shipment. The times from the voyage are copied to shipment stops.
  If there are multiple transload stops in a voyage, then all the transload stops should be together in the middle of voyage stops.
• links: array links
  Read Only: true
• locations: locations
• servprovGid: string
  The GID for the service provider for the voyage.
• servprovProfileGid: string
  The GID for the service provider profile. The service provider profile is on the voyage to support scenarios where multiple ocean carriers have a vessel sharing agreement.
• timeStamp: timeStamp
  Time the record was added.
• updateDate: updateDate
  Read Only: true

  update date
• vesselGid: string
  The GID for the vessel assigned to the voyage. The vessel record contains important information about the vessel like: Owner, Operator, Registry Port, Flag Country, Official Number.
• voyageGid: string
  The GID for the voyage.
• voyageName: string
  The name of the voyage.
• voyageServiceTypeGid: string
  The GID for the voyage service type. The Voyage Service Type links the voyage with a rate service and rate. The Voyage Service Type ID identifies the voyage service type which must be assigned to at least one rate service. Each voyage schedule must have a voyage service type that is associated with at least one rate service for it to be considered for a shipment.
• voyageXid: string
  The unique external identifier for the voyage.

{
    "properties":{
        "voyageGid":{
            "description":"The GID for the voyage.",
            "type":"string"
        },
        "voyageXid":{
            "description":"The unique external identifier for the voyage.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider for the voyage.",
            "type":"string"
        },
        "voyageServiceTypeGid":{
            "description":"The GID for the voyage service type. The Voyage Service Type links the voyage with a rate service and rate. The Voyage Service Type ID identifies the voyage service type which must be assigned to at least one rate service. Each voyage schedule must have a voyage service type that is associated with at least one rate service for it to be considered for a shipment.",
            "type":"string"
        },
        "vesselGid":{
            "description":"The GID for the vessel assigned to the voyage. The vessel record contains important information about the vessel like: Owner, Operator, Registry Port, Flag Country, Official Number.",
            "type":"string"
        },
        "voyageName":{
            "description":"The name of the voyage.",
            "type":"string"
        },
        "depRegionName":{
            "description":"The name of the departure region for the voyage.",
            "type":"string"
        },
        "arrRegionName":{
            "description":"The voyage's Departure Region name and Arrival Region name are for information only. The Departure and Arrival information is intended to hold the  trade lane level description of the voyage e.g., Asia to North America,  Middle East to Europe.",
            "type":"string"
        },
        "depDate":{
            "description":"The departure date for the voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "timeStamp":{
            "description":"Time the record was added.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataSourcePartitionKey":{
            "description":"Partition key used to parse the data based on the data source.",
            "type":"number",
            "format":"double"
        },
        "servprovProfileGid":{
            "description":"The GID for the service provider profile. The service provider profile is on the voyage to support scenarios where multiple ocean carriers have a vessel sharing agreement.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isComposite":{
            "description":"Check box used to identify voyages that are composite voyages i.e., the voyage has a transload point. <br>Composite Voyages -  A composite voyage is a voyage that takes place using two or more vessels. The main vessel is the 'mother' vessel  and can be identified as such when creating a voyage. This enables you to identify which feeder was from the source port and what is the mother vessel discharging at the destination port on the shipment.<br>A shipment's last departure stop must be before voyage's first transload stop.<br>A shipment's first arrival stop must be after voyage's last transload stop.<br>If a transload shipment has a composite voyage, then it will find all transload stops on its voyage and insert them as transload stops on the shipment. The times from the voyage are copied to shipment stops.<br>If there are multiple transload stops in a voyage, then all the transload stops should be together in the middle of voyage stops.",
            "type":"boolean"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "locations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/voyages.locations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : depDate

The departure date for the voyage.

Match All

Show Source

• object dateTimeType

{
    "description":"The departure date for the voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/voyages.locations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : timeStamp

Time the record was added.

Match All

Show Source

• object dateTimeType

{
    "description":"Time the record was added.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object voyages.locations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/voyages.locations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : voyages.locations

Type: object

Show Source

• actualDOrADate: actualDOrADate
  The actual date at port sometimes sent by carrier.
• dataSourcePartitionKey: number (double)
  Partition key used to parse the data based on the data source.
• domainName: string
  Database domain where this data is stored.
• dOrA: string
  Defines whether the location is a pickup (D) or delivery (A) point for the voyage.
• dOrADate: dOrADate
  The date for the pickup (D) or delivery (A) for the voyage.
• estimatedDOrADate: estimatedDOrADate
  The estimated date at port sometimes sent by a carrier.
• isMotherVessel: boolean
  You can select the Mother check box to indicate that this is the mother vessel or "vessel of record" for the leg for customs.
• isTransload: boolean
  For composite voyages. The transload point check box identifies the transload port in the rotation. The Transload check box is used by OTM to indicate a transload stop (the stop type will be "T" for transload.)
• links: array links
  Read Only: true
• locationGid: string
  The GID for the location of the voyage.
• seqNo: number (int32)
  The sequence number for the location of the voyage.
• vesselDescription: string
  The Vessel Description field is for further information about the vessel for the leg. It is for information only.
• voyageDescription: string
  The Voyage Description field is the voyage of the operator of the leg. This is for information only and is not a validated field.
• voyageServiceTypeGid: string
  The GID for the voyage service type. The Voyage Service Type ID field is the voyage service type of the operator of the leg. It is a validated field but is only used for information and documentation. The Voyage Service Type ID on the header is operational and used to link the voyage to the rate service. The voyage service type of the mother vessel should be the voyage service type on the header.

{
    "properties":{
        "seqNo":{
            "description":"The sequence number for the location of the voyage.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The GID for the location of the voyage.",
            "type":"string"
        },
        "dOrA":{
            "description":"Defines whether the location is a pickup (D) or delivery (A) point for the voyage.",
            "type":"string"
        },
        "dOrADate":{
            "description":"The date for the pickup (D) or delivery (A) for the voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedDOrADate":{
            "description":"The estimated date at port sometimes sent by a carrier.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "actualDOrADate":{
            "description":"The actual date at port sometimes sent by carrier.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataSourcePartitionKey":{
            "description":"Partition key used to parse the data based on the data source.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isTransload":{
            "description":"For composite voyages. The transload point check box identifies the transload port in the rotation. The Transload check box is used by OTM to indicate a transload stop (the stop type will be \"T\" for transload.)",
            "type":"boolean"
        },
        "voyageServiceTypeGid":{
            "description":"The GID for the voyage service type. The Voyage Service Type ID field is the voyage service type of the operator of the leg. It is a validated field but is only used for information and documentation. The Voyage Service Type ID on the header is operational and used to link the voyage to the rate service. The voyage service type of the mother vessel should be the voyage service type on the header.",
            "type":"string"
        },
        "voyageDescription":{
            "description":"The Voyage Description field is the voyage of the operator of the leg. This is for information only and is not a validated field.",
            "type":"string"
        },
        "vesselDescription":{
            "description":"The Vessel Description field is for further information about the vessel for the leg. It is for information only.",
            "type":"string"
        },
        "isMotherVessel":{
            "description":"You can select the Mother check box to indicate that this is the mother vessel or \"vessel of record\" for the leg for customs.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDOrADate

The actual date at port sometimes sent by carrier.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual date at port sometimes sent by carrier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dOrADate

The date for the pickup (D) or delivery (A) for the voyage.

Match All

Show Source

• object dateTimeType

{
    "description":"The date for the pickup (D) or delivery (A) for the voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : estimatedDOrADate

The estimated date at port sometimes sent by a carrier.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated date at port sometimes sent by a carrier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top