Jump to

• Request
• Response

Get a Shipment

get

/quotes/{quoteGid}/costOptions/{costOptionSequence}/shipments/{shipmentSequence}

Request

Path Parameters

• costOptionSequence(required): string
  Resource ID
• quoteGid(required): string
  Resource ID
• shipmentSequence(required): string
  Resource ID

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• actualCost: actualCost
  Actual cost.
• costs: costs
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destLocationGid: string
  The GID for the Destination location.
• destLocationName: string
  Destination location name.
• destViaLocationGid: string
  The GID for the destination via location.
• distance: distance
  Distance.
• domainName: string
  Database domain where this data is stored.
• endTime: endTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• flightGid: string
  The GID for the flight that must be used.
• isPrimary: boolean
  The Primary check box is used to specify if this is the primary leg of the shipment.
• links: array links
  Read Only: true
• nfrcRuleGid: string
  The NFRC rule used to create this shipment if it is an NFRC and was created by the system.
• perspective: string
  Perspective - Buy or Sell.
• rateExpiration: rateExpiration
  Expiration data of the rate.
• rateFromLocationGid: string
  The GID for the rating from location.
• rateGeoGid: string
  The GID for the rate record that should be used. This rates the cost option leg for the given rate record.
• rateOfferingGid: string
  The GID for the rate offering that should be used.
• rateToLocationGid: string
  The GID for the rating to location.
• servprovGid: string
  The GID for the service provider that should be used.
• shipmentSequence: number (int32)
  Internal sequence number for shipment information provide as part of the quote option.
• shipmentTypeGid: string
  Indicates the shipment type for this quote cost option shipment.
• sourceAddressLine1: string
  Source location address line 1 value.
• sourceAddressLine2: string
  Source location address line 2 value.
• sourceAddressLine3: string
  Source location address line 3 value.
• sourceCity: string
  Source location city value.
• sourceCountryCode3Gid: string
  Source Location country code value.
• sourceLocationGid: string
  The GID for the source location.
• sourceLocationName: string
  Source location name.
• sourcePostalCode: string
  Source location postal code value.
• sourceProvince: string
  Source location province value.
• sourceViaLocationGid: string
  The GID for the source via location.
• startTime: startTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• transportModeGid: string
  The GID for the transport mode that should be used.
• voyageGid: string
  The GID for the voyage that must be used.

{
    "properties":{
        "shipmentSequence":{
            "description":"Internal sequence number for shipment information provide as part of the quote option. ",
            "type":"number",
            "format":"int32"
        },
        "isPrimary":{
            "description":"The Primary check box is used to specify if this is the primary leg of the shipment.",
            "type":"boolean"
        },
        "actualCost":{
            "description":"Actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "servprovGid":{
            "description":"The GID for the service provider that should be used.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode that should be used.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"The GID for the rate offering that should be used.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The GID for the rate record that should be used. This rates the cost option leg for the given rate record. ",
            "type":"string"
        },
        "flightGid":{
            "description":"The GID for the flight that must be used.",
            "type":"string"
        },
        "rateFromLocationGid":{
            "description":"The GID for the rating from location.",
            "type":"string"
        },
        "rateToLocationGid":{
            "description":"The GID for the rating to location.",
            "type":"string"
        },
        "sourceViaLocationGid":{
            "description":"The GID for the source via location.",
            "type":"string"
        },
        "destViaLocationGid":{
            "description":"The GID for the destination via location.",
            "type":"string"
        },
        "voyageGid":{
            "description":"The GID for the voyage that must be used.",
            "type":"string"
        },
        "distance":{
            "description":"Distance.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "rateExpiration":{
            "description":"Expiration data of the rate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID for the source location.",
            "type":"string"
        },
        "sourceLocationName":{
            "description":"Source location name.",
            "type":"string"
        },
        "sourceAddressLine1":{
            "description":"Source location address line 1 value.",
            "type":"string"
        },
        "sourceAddressLine2":{
            "description":"Source location address line 2 value.",
            "type":"string"
        },
        "sourceAddressLine3":{
            "description":"Source location address line 3 value.",
            "type":"string"
        },
        "sourceCity":{
            "description":"Source location city value.",
            "type":"string"
        },
        "sourceProvince":{
            "description":"Source location province value.",
            "type":"string"
        },
        "sourceCountryCode3Gid":{
            "description":"Source Location country code value.",
            "type":"string"
        },
        "sourcePostalCode":{
            "description":"Source location postal code value.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID for the Destination location.",
            "type":"string"
        },
        "destLocationName":{
            "description":"Destination location name.",
            "type":"string"
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "shipmentTypeGid":{
            "description":"Indicates the shipment type for this quote cost option shipment.",
            "type":"string"
        },
        "nfrcRuleGid":{
            "description":"The NFRC rule used to create this shipment if it is an NFRC and was created by the system.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCost

Actual cost.

Match All

Actual cost.

Show Source

• object currencyType

{
    "description":"Actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : costs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distance

Distance.

Match All

Distance.

Show Source

• object amountType

{
    "description":"Distance.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : endTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "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
}

Nested Schema : rateExpiration

Expiration data of the rate.

Match All

Expiration data of the rate.

Show Source

• object dateType

{
    "description":"Expiration data of the rate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : startTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.costOptions.shipments.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
    }
}

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 : quotes.costOptions.shipments.costs

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial cost (if any) on the quote cost option.
• cost: cost
  Cost.
• costExplanation: string
  Explanation for cost.
• costSequence: number (int32)
  Cost sequence number for different cost provided for the quote cost option.
• costType: string
  Cost type - e.g., Base Cost, Accessorial etc.
• description: string
  Description.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• paymentMethodCodeGid: string
  Indicates the payment method that applies to this quote shipment cost.

{
    "properties":{
        "costSequence":{
            "description":"Cost sequence number for different cost provided for the quote cost option.",
            "type":"number",
            "format":"int32"
        },
        "costType":{
            "description":"Cost type - e.g., Base Cost, Accessorial etc.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial cost (if any) on the quote cost option.",
            "type":"string"
        },
        "cost":{
            "description":"Cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "description":{
            "description":"Description.",
            "type":"string"
        },
        "costExplanation":{
            "description":"Explanation for cost.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"Indicates the payment method that applies to this quote shipment cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

Cost.

Match All

Cost.

Show Source

• object currencyType

{
    "description":"Cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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 : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

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"
        }
    }
}

Back to Top