Jump to

• Request
• Response

Get Costs

get

/lnmShipments/{shipmentGid}/costs

Request

Path Parameters

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

Nested Schema : items

Type: array

Show Source

• Array of: object lnmShipments.costs

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : lnmShipments.costs

Type: object

Show Source

• accessorialCodeDesc: string
  No description.
• accessorialCodeGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• bulkplanGid: string
  No description.
• bulkplanSpecGid: string
  No description.
• cost: cost
  The cost as it releates to the cost type for the shipment.
• costType: string
  C, A, B
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
• isCostFixed: boolean
  Indicates shipment cost is a fixed cost.
• isWeighted: boolean
  Whether or not the cost affects the total weighted cost of the shipment only
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  Override for record to be copied to the sell side during rating.
• scenarioGid: string
  No description.
• shipmentCostSeqNo: number (int64)
  A system generated unique sequence number to define the shipment costs.

{
    "properties":{
        "shipmentCostSeqNo":{
            "description":"A system generated unique sequence number to define the  shipment costs.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "scenarioGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"The cost as it releates to the cost type for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "accessorialCodeDesc":{
            "description":"No description.",
            "type":"string"
        },
        "costType":{
            "description":"C, A, B",
            "type":"string"
        },
        "isCostFixed":{
            "description":"Indicates shipment cost is a fixed cost.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"Override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "isWeighted":{
            "description":"Whether or not the cost affects the total weighted cost of the shipment only",
            "type":"boolean"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "bulkplanSpecGid":{
            "description":"No description.",
            "type":"string"
        },
        "bulkplanGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost as it releates to the cost type for the shipment.

Match All

The cost as it releates to the cost type for the shipment.

Show Source

• object currencyType

{
    "description":"The cost as it releates to the cost type for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

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

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

Back to Top