Get a Secondary Charge
get
/shipmentGroups/{shipGroupGid}/secondaryCharges/{shipmentGid}
Request
Path Parameters
-
shipGroupGid(required): string
Resource ID
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : shipmentGroups.secondaryCharges
Type:
Show Source
object
-
actualCo2Emission:
actualCo2Emission
Actual CO2 emissions for the shipment.
-
actualCo2EqEmission:
actualCo2EqEmission
Actual CO2 equivalent emissions for the shipment.
-
aheadLateTime:
aheadLateTime
shipment status
-
aheadOrLate: string
A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user. B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed
-
airRailRouteCode: string
A transportation mode code that is informational for the shipment.
-
appointmentPriorityGid: string
The appointment priority identifier associated with the shipment.
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
-
attributeCurrency1:
attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeCurrency2:
attributeCurrency2
The attribute currency of the shipment.
-
attributeCurrency3:
attributeCurrency3
The attribute currency of the shipment.
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate11:
attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate20:
attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber11: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber20: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
-
bolIssuanceType: string
The bill of lading issuance type identifier.
-
bolType: string
The bill of lading type defined for the shipment, used for report management.
-
bulkCmGid: string
The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.
-
bulkPlanGid: string
If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.
-
cfsCutoffDate:
cfsCutoffDate
The container freight station cutoff date associated with the shipment.
-
cfsLocationGid: string
The location identifier for the container freight station.
-
chargeableVolume:
chargeableVolume
The actual volume used in calculating the cost of the shipment.
-
chargeableWeight:
chargeableWeight
The dimensional weight as determined by the rating process.
-
checkCapacityConstraint: boolean
The indicator to check the capacity constraints associated with the shipment.
-
checkCostConstraint: boolean
The indicator to check cost constraints associated with the shipment
-
checkTimeConstraint: boolean
The indicator to check the time constraints associated with the shipment.
-
cmCost:
cmCost
The shipment cost when the shipment is part of a continuous move tour.
-
cmEmptyDistance:
cmEmptyDistance
The empty leg distance between previous and this shipments.
-
cmName: string
The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.
-
cmNextSourceLocationGid: string
The source location of the next shipment in the continuous move tour.
-
cmPrevDestLocationGid: string
The destination location of the previous shipment in the continuous move tour.
-
cmSequenceNum: number
(int32)
Indicates the shipment's sequence in the continuous move tour.
-
cofcTofc: string
The trailer or flat car or the container on flat car code for rail shipments.
-
combinationEquipGrpGid: string
The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments.
-
consolGid: string
The consol identifier if the shipment has been built from a consol structure.
-
contactGid: string
The contact identifier linking in the contact table information to the shipment.
-
containerDeliveryLocGid: string
The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight.
-
containerPickupLocGid: string
The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
-
currencyGid: string
Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.
-
currentStopNum: number
(int32)
The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
-
customerRateCode: string
The customer rate identifier associated with the shipment if this shipment is planned using a customer.
-
deliveringServprovGid: string
The service provider who is the delivering service provider for this shipment.
-
destArbLevelOfServiceGid: string
The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.
-
destLocationGid: string
The GID of the destination location of the shipment.
-
destLocationOverrideGid: string
The location identifier that will override the destination location that is defined for the shipment.
-
destPierLocationGid: string
The destination operational location.
-
dimVolume:
dimVolume
The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
-
dimWeight:
dimWeight
The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
-
domainName: string
The database domain where this data is stored.
-
driverAssignBulkPlanGid: string
Fleet bulk plan ID for driver assignment.
-
driverGid: string
The driver or primary team driver assigned to the shipment.
-
dropInventoryProcessed: boolean
Indicates fleet equipment inventory processing for dropping an empty equipment after freight.
-
dutyPaid: string
The duty paid of the shipment.
-
earliestStartTime:
earliestStartTime
The earliest start time that will make this shipment feasible.
-
emPhoneNumber: string
The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.
-
endTime:
endTime
The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
-
equipmentAssignBulkPlanGid: string
Fleet bulk plan ID for equipment assignment.
-
equipmentDestination: string
equipment destination
-
equipmentReferenceUnitGid: string
The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.
-
equipRefUnitUtilization: number
(double)
The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.
-
etaDate:
etaDate
Estimated time of arrival
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
externalVoyageCode: string
Specifies the number of the voyage as assigned by the carrier that transports the shipment.
-
feasibilityCodeGid: string
The feasibility code associated with the shipment can identify shipment infeasibilities.
-
firstEquipmentGroupGid: string
A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.
-
firstEquipmentInitial: string
first equipment intial
-
firstEquipmentNumber: string
first equipment number
-
fixedServiceDays: number
(int32)
The fixed number of service days, if returned by the rating engine.
-
flightInstanceId: number
(int64)
The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.
-
freightTerms: string
The freight terms for the shipment, such as prepaid or collect.
-
hasAppointments: boolean
Indicates if any stops on the shipment have appointments.
-
hazmatModeGid: string
The hazmat mode identifier that is associated with the shipment.
-
hazmatRegionGid: string
The hazmat region identifier that is associated with the shipment.
-
incoTermGid: string
The Incoterm identifier associated with the shipment.
-
insuranceAmount:
insuranceAmount
The insurance amount of the shipment.
-
insurancePolicyNumber: string
The insurance policy number that covers this shipment, for informational purposes.
-
insurancePremium:
insurancePremium
The insurance premium of the shipment, for informational purposes.
-
intermediaryCorporationGid: string
The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation.
-
inTrailerBuild: boolean
Indicates that this shipment is in a trailer build shipment group.
-
isAdvancedCharge: boolean
A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.
-
isArRouteCodeFixed: boolean
This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.
-
isAutoMergeConsolidate: boolean
Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)
-
isCostFixed: boolean
A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.
-
isCpctyOverrideApplicable: boolean
A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.
-
isCreditNote: boolean
Y/N based on an associated credit note.
-
isEquipmentFixed: boolean
Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.
-
isFixedDistance: boolean
Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.
-
isFixedTenderContact: boolean
A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.
-
isFixedVoyage: boolean
A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.
-
isHazardous: boolean
A Y/N indicator specifying that the shipment is identified as having hazardous material.
-
isMemoBl: boolean
Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.
-
isPermanent: boolean
Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in "delete shipment" action.
-
isPreferredCarrier: boolean
Indicates if the carrier selected for the shipment is preferred.
-
isPreload: boolean
A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.
-
isPrimary: boolean
Indicates if the shipment is the primary shipment related to an order (bookings) path.
-
isProfitSplit: boolean
Indicates if the NFRC shipment will be profit split.
-
isRateGeoFixed: boolean
A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.
-
isRateOfferingFixed: boolean
A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.
-
isRecalcTotals: boolean
Turns on/off totaling logic.
-
isServiceTimeFixed: boolean
A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.
-
isServprovFixed: boolean
A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.
-
isSpotCosted: boolean
Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.
-
isTemperatureControl: boolean
A Y/N indicator specifying that the shipment is identified as needing temperature control.
-
isTemplate: boolean
Indicates whether a shipment is a template.
-
isToBeHeld: boolean
A Y/N indicator specifying that the shipment is to be held by the carrier.
-
itineraryGid: string
The itinerary identifier that was used to build the shipment if it was built with the planning logic.
-
jobGid: string
The job GID identifier of the shipment, if the shipment is assigned to a job.
-
lastEventGroupGid: string
The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.
-
latestStartTime:
latestStartTime
The latest start time that will make this shipment feasible.
-
links: array
links
Read Only:
true
-
loadConfigEngineTypeGid: string
Null type means no load configuration is performed on the shipment.
-
loadedDistance:
loadedDistance
The total distance that the truck or the transportation mode will travel when the shipment is loaded.
-
loadingHallPenalty: number
(double)
The loading hall penalty used while building loading halls for the shipment.
-
marketCost:
marketCost
Market cost based on the shipment.
-
maxNumRetender: number
(int32)
Maximum number of re-tenders.
-
nfrcRuleGid: string
The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.
-
numEquipmentOrdered: number
(int32)
The number of equipment ordered. This is manually set by the user and can be rated on.
-
numOrderReleases: number
(int32)
The number of order releases that are on this shipment.
-
numStops: number
(int32)
The number of shipment stop records related to this shipment.
-
originalInvoiceCost:
originalInvoiceCost
The original invoice cost at the point when the invoice was initially created or matched to the shipment.
-
originalShipmentGid: string
If the shipment represents a secondary charge, this points back to the "parent" shipment for which the secondary shipment is a "child".
-
originatingServprovGid: string
The service provider who is the originating service provider for this shipment.
-
parcelZone: string
The ship to mail zone. A price key used for parcel rate calculations.
-
parentLegGid: string
The parent leg associated with the itinerary that may have been used to plan the shipment.
-
paymentMethodCodeGid: string
The payment method code identifier.
-
perspective: string
The indicates if the shipment is a buy or sell perspective.
-
pickInventoryProcessed: boolean
Indicates fleet equipment inventory processing for picking an empty equipment before freight.
-
placeDeliverLocationGid: string
The place deliver location identifier specifying the location where ownership of freight ends with delivery.
-
placeReceiptLocationGid: string
The place receipt location identifier specifying the location where ownership of freight starts.
-
plannedCo2Emission:
plannedCo2Emission
CO2 emissions recorded while planning the shipment.
-
plannedCo2EqEmission:
plannedCo2EqEmission
CO2 equivalent emissions recorded while planning the shipment.
-
plannedCost:
plannedCost
The cost when the original shipment was created.
-
plannedRateGeoGid: string
The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.
-
plannedRateOfferingGid: string
The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.
-
plannedServprovGid: string
The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter.
-
plannedTransportModeGid: string
The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.
-
planningParameterSetGid: string
The parameter set GID which is used in building this shipment.
-
portDischargeEta:
portDischargeEta
The estimated port of discharge date associated with ocean-going shipments.
-
portExitLocGid: string
The designated port the freight will be exiting the country for international shipments.
-
portOfDisLocationGid: string
The location ID of the port of discharge for the primary leg carrier.
-
portOfDisOverrideLocGid: string
The location override ID of the port of discharge for the primary leg carrier.
-
portOfExitDate:
portOfExitDate
The estimated port of exit (for international shipments) associated with ocean going shipments.
-
portOfLoadLocationGid: string
The location ID of the port of load for the primary leg carrier.
-
portOfLoadOverrideLocGid: string
The location override ID of the port of load for the primary leg carrier.
-
powerUnitGid: string
The power unit assigned to the shipment.
-
prevDropInventoryProcessed: boolean
Indicates fleet equipment inventory processing for driver's previous shipment's equipment.
-
prevEquipmentDestination: string
previous equipment destination
-
prevReportedBsStatusCode: string
previous reported event for shipment
-
prevReportingScac: string
previous reporting scac
-
prevSightingDate:
prevSightingDate
The date associated with the previous sighting location and in the tracking event.
-
prevSightingLocationGid: string
The location identifier for the previous sighting location used for rail shipment and tracking events.
-
primaryOrderBaseGid: string
A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value.
-
processingCodeGid: string
The processing code GID.
-
projectedTourName: string
Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.
-
projectedTourSequenceNum: number
(int32)
Represents the sequence in which the shipment should appear in the projected tour.
-
railDate:
railDate
The rail date of the shipment that is populated if the shipment utilizes the rail schedules.
-
railInterModalPlanGid: string
The rail intermodal plan identifier of the shipment used for intermodal rail shipments.
-
railReturnLocationGid: string
The rail return location identifier of the rail shipment.
-
railReturnRouteGid: string
The rail return route identifier of the rail shipment.
-
rateGeoGid: string
The detailed rate record (contract) identifier that is used by the service provider moving this shipment.
-
rateOfferingGid: string
The rate offering (contract) identifier that is used by the service provider moving this shipment.
-
repetitionScheduleGid: string
The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.
-
reportedBsStatusCode: string
latest reported event for shipment
-
reportingScac: string
reporting scac
-
reservationNum: string
Saved here to search shipments based on Reservation Number.
-
routeCodeCombinationGid: string
The route code combination identifier of the shipment used for specifying rail shipments.
-
rule11Indicator: string
The rule 11 indicator of the shipment used for managing rail.
-
rule7: boolean
A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.
-
sailCutoffDate:
sailCutoffDate
The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.
-
sailDate:
sailDate
The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.
-
scheduleType: string
When the schedule type is populated, it is a consol.
-
secondaryChargeRuleGid: string
The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.
-
secondaryDriverGid: string
The secondary team driver assigned to the shipment.
-
servprovGid: string
The service provider identifier associated with the shipment.
-
shipmentAsWork: boolean
Indicates the shipment as work.
-
shipmentGid: string
The GID for the shipment.
-
shipmentName: string
A descriptive name of the shipment.
-
shipmentReleased: boolean
A Y/N indicator used for rail shipments that indicate that the shipment is ready.
-
shipmentTypeGid: string
The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.
-
shipmentXid: string
The XID for the shipment.
-
shippingAgentContactGid: string
Indicate if this NFRC is created from the Assign Shipping Agent action on the job.
-
siCutoffDate:
siCutoffDate
The shippers instruction cutoff date associated with the shipment.
-
sightingDate:
sightingDate
The date and time when the shipment was last sighted at the sighting location.
-
sightingLocationGid: string
The location where the shipment was last sighted.
-
solePackagedItemGid: string
only one equipment and with only one item
-
sourceLocationGid: string
The GID of the source location of the shipment.
-
sourceLocationOverrideGid: string
The location identifier that will override the source location that is defined for the shipment.
-
sourcePierLocationGid: string
The source operational location.
-
srcArbLevelOfServiceGid: string
The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.
-
startTime:
startTime
The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
-
tariffDate:
tariffDate
The tariff date, for informational purposes.
-
tariffName: string
The tariff name, for informational purposes.
-
tariffNumber: string
The tariff number, for informational purposes.
-
tariffOrganizationName: string
The tariff organization name, for informational purposes.
-
tariffOrganizationNumber: string
The tariff organization number, for informational purposes.
-
termLocationText: string
The term location text that is informational for the shipment.
-
totalActualCost:
totalActualCost
The total actual cost of the shipment.
-
totalApprovedCost:
totalApprovedCost
The total approved cost associated with the shipment after the approval step in the freight payment process.
-
totalDeclaredValue:
totalDeclaredValue
The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.
-
totalItemPackageCount: number
(int32)
The total item package count of the shipment.
-
totalNetVolume:
totalNetVolume
The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.
-
totalNetWeight:
totalNetWeight
The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.
-
totalNumReferenceUnits: number
(double)
The total number of reference units of the shipment as defined by the equipment reference units.
-
totalPackagingUnitCount: number
(int32)
The total packaging unit count of the shipment.
-
totalShipUnitCount: number
(int64)
The total ship unit count of the shipment.
-
totalTransCost:
totalTransCost
The total cost of the shipment. It represents the total transportation cost after applying the rebate.
-
totalVolume:
totalVolume
The total volume of the shipment.
-
totalWeight:
totalWeight
The total weight of the shipment.
-
totalWeightedCost:
totalWeightedCost
The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.
-
totMatchedInvoiceCost:
totMatchedInvoiceCost
The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.
-
transportModeGid: string
A unique identifier to define the transportation modes.
-
unloadedDistance:
unloadedDistance
The total distance that the truck or the transportation mode will travel when empty.
-
userDefined1IconGid: string
The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined2IconGid: string
The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined3IconGid: string
The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined4IconGid: string
The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
userDefined5IconGid: string
The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
-
vesselGid: string
The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.
-
volumeUtilization: number
(double)
The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.
-
voyageGid: string
The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.
-
waybillDate:
waybillDate
Waybill date represents contractual agreement of the carriage.
-
weighCode: string
The weigh code of the shipment that identifies the weight type.
-
weightUtilization: number
(double)
The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.
-
workAssignmentBulkPlanGid: string
Work assignment bulk plan ID which is generated during work assignment bulk plan process.
Nested Schema : actualCo2EqEmission
Actual CO2 equivalent emissions for the shipment.
Match All
Show Source
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : cfsCutoffDate
The container freight station cutoff date associated with the shipment.
Match All
Show Source
Nested Schema : chargeableVolume
The actual volume used in calculating the cost of the shipment.
Match All
Show Source
Nested Schema : chargeableWeight
The dimensional weight as determined by the rating process.
Match All
Show Source
Nested Schema : cmCost
The shipment cost when the shipment is part of a continuous move tour.
Match All
Show Source
Nested Schema : cmEmptyDistance
The empty leg distance between previous and this shipments.
Match All
Show Source
Nested Schema : dimVolume
The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
Match All
Show Source
Nested Schema : dimWeight
The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
Match All
Show Source
Nested Schema : earliestStartTime
The earliest start time that will make this shipment feasible.
Match All
Show Source
Nested Schema : endTime
The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
Match All
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : insurancePremium
The insurance premium of the shipment, for informational purposes.
Match All
Show Source
Nested Schema : latestStartTime
The latest start time that will make this shipment feasible.
Match All
Show Source
Nested Schema : loadedDistance
The total distance that the truck or the transportation mode will travel when the shipment is loaded.
Match All
Show Source
Nested Schema : originalInvoiceCost
The original invoice cost at the point when the invoice was initially created or matched to the shipment.
Match All
Show Source
Nested Schema : plannedCo2Emission
CO2 emissions recorded while planning the shipment.
Match All
Show Source
Nested Schema : plannedCo2EqEmission
CO2 equivalent emissions recorded while planning the shipment.
Match All
Show Source
Nested Schema : portDischargeEta
The estimated port of discharge date associated with ocean-going shipments.
Match All
Show Source
Nested Schema : portOfExitDate
The estimated port of exit (for international shipments) associated with ocean going shipments.
Match All
Show Source
Nested Schema : prevSightingDate
The date associated with the previous sighting location and in the tracking event.
Match All
Show Source
Nested Schema : railDate
The rail date of the shipment that is populated if the shipment utilizes the rail schedules.
Match All
Show Source
Nested Schema : sailCutoffDate
The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.
Match All
Show Source
Nested Schema : sailDate
The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.
Match All
Show Source
Nested Schema : siCutoffDate
The shippers instruction cutoff date associated with the shipment.
Match All
Show Source
Nested Schema : sightingDate
The date and time when the shipment was last sighted at the sighting location.
Match All
Show Source
Nested Schema : startTime
The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
Match All
Show Source
Nested Schema : totalApprovedCost
The total approved cost associated with the shipment after the approval step in the freight payment process.
Match All
Show Source
Nested Schema : totalDeclaredValue
The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.
Match All
Show Source
Nested Schema : totalNetVolume
The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.
Match All
Show Source
Nested Schema : totalNetWeight
The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.
Match All
Show Source
Nested Schema : totalTransCost
The total cost of the shipment. It represents the total transportation cost after applying the rebate.
Match All
Show Source
Nested Schema : totalWeightedCost
The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.
Match All
Show Source
Nested Schema : totMatchedInvoiceCost
The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.
Match All
Show Source
Nested Schema : unloadedDistance
The total distance that the truck or the transportation mode will travel when empty.
Match All
Show Source
Nested Schema : waybillDate
Waybill date represents contractual agreement of the carriage.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format