Jump to

• Request
• Response

Get a Stop Rate

get

/rateOfferings/{rateOfferingGid}/stopRates/{lowStopxhighStop}

Request

Path Parameters

• lowStopxhighStop(required): string
  Resource ID
• rateOfferingGid(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 : rateOfferings.stopRates

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• highStop: number (int32)
  Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.
  The high stop field defines the high end of the range for stop off charges.
  
• links: array links
  Read Only: true
• lowStop: number (int32)
  Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.
  The low stop fields defines the low end of the range for stop off charges.
  
• perStopCost: perStopCost
  The per stop charge for the low high range being defined.

{
    "properties":{
        "lowStop":{
            "description":"Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.<br>The low stop fields defines the low end of the range for stop off charges.<br>",
            "type":"number",
            "format":"int32"
        },
        "highStop":{
            "description":"Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.<br>The high stop field defines the high end of the range for stop off charges.<br>",
            "type":"number",
            "format":"int32"
        },
        "perStopCost":{
            "description":"The per stop charge for the low high range being defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "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 : perStopCost

The per stop charge for the low high range being defined.

Match All

Show Source

• object currencyType

{
    "description":"The per stop charge for the low high range being defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

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

Back to Top