Jump to

• Request
• Response

Get Costs

get

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

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.
• 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/quotes.costOptions.shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

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

Show Source

• Array of: object links

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

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

Type: object

Show Source

• href: string
• rel: string

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

Back to Top