Create a Shipment
post
/shipments
Request
Header Parameters
-
Prefer:
An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Root Schema : schema
Type:
Show Source
object
-
accessorials:
accessorials
-
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.
-
allocations:
allocations
-
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
Read Only:
true
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
Read Only:
true
The actual volume used in calculating the cost of the shipment. -
chargeableWeight:
chargeableWeight
Read Only:
true
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
Read Only:
true
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)
Read Only:
true
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. This attribute is marked as Create-Only.
-
consolGid: string
The consol identifier if the shipment has been built from a consol structure.
-
contactGid: string
Read Only:
true
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.
-
containerGroups:
containerGroups
-
containerPickupLocGid: string
The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
-
costs:
costs
-
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)
Read Only:
true
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
Read Only:
true
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
Read Only:
true
The dimensional volume. Mathematical weight equivalence according to specified dim rate factor. -
dimWeight:
dimWeight
Read Only:
true
The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor. -
documents:
documents
-
domainName: string
The database domain where this data is stored.
-
driverAssignBulkPlanGid: string
Read Only:
true
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
Read Only:
true
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
Read Only:
true
The feasibility code associated with the shipment can identify shipment infeasibilities. -
firstEquipmentGroupGid: string
Read Only:
true
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.
-
informationalCosts:
informationalCosts
-
insertDate:
insertDate
Read Only:
true
insert date -
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
Read Only:
true
Indicates that this shipment is in a trailer build shipment group. -
involvedParties:
involvedParties
-
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
Read Only:
true
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
Read Only:
true
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
Read Only:
true
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. This attribute is marked as Create-Only.
-
isToBeHeld: boolean
A Y/N indicator specifying that the shipment is to be held by the carrier.
-
itineraryGid: string
Read Only:
true
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
Read Only:
true
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.
-
orderReleases:
orderReleases
-
originalInvoiceCost:
originalInvoiceCost
The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.
-
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
Read Only:
true
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
Read Only:
true
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. This attribute is marked as Create-Only.
-
plannedRateGeoGid: string
Read Only:
true
The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
plannedRateOfferingGid: string
Read Only:
true
The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
plannedServprovGid: string
Read Only:
true
The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
plannedTransportModeGid: string
Read Only:
true
The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
planningParameterSetGid: string
Read Only:
true
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
Read Only:
true
The date associated with the previous sighting location and in the tracking event. -
prevSightingLocationGid: string
Read Only:
true
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.
-
refnums:
refnums
-
remarks:
remarks
-
repetitionScheduleGid: string
Read Only:
true
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
-
reqdocs:
reqdocs
-
reservationNum: string
Saved here to search shipments based on Reservation Number.
-
routeCodeCombinationGid: string
Read Only:
true
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
Read Only:
true
When the schedule type is populated, it is a consol. -
secondaryChargeRuleGid: string
Read Only:
true
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.
-
sEquipments:
sEquipments
-
servprovGid: string
The service provider identifier associated with the shipment. This attribute is marked as Create-Only.
-
shipmentAsWork: boolean
Indicates the shipment as work. This attribute is marked as Create-Only.
-
shipmentGid: string
The GID for the shipment.
-
shipmentGroupGid: string
The shipment group identifier if this shipment is placed into a single group.
-
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
Read Only:
true
The date and time when the shipment was last sighted at the sighting location. -
sightingLocationGid: string
Read Only:
true
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.
-
specialServices:
specialServices
-
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.
-
sShipUnits:
sShipUnits
-
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.
-
statuses:
statuses
-
stops:
stops
-
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.
-
tenders:
tenders
-
termLocationText: string
The term location text that is informational for the shipment.
-
texts:
texts
-
totalActualCost:
totalActualCost
The total actual cost of the shipment. This attribute is marked as Create-Only.
-
totalApprovedCost:
totalApprovedCost
The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.
-
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)
Read Only:
true
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)
Read Only:
true
The total number of reference units of the shipment as defined by the equipment reference units. -
totalPackagingUnitCount: number
(int32)
Read Only:
true
The total packaging unit count of the shipment. -
totalShipUnitCount: number
(int64)
The total ship unit count of the shipment.
-
totalTransCost:
totalTransCost
Read Only:
true
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. This attribute is marked as Create-Only.
-
totMatchedInvoiceCost:
totMatchedInvoiceCost
The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.
-
trackingEvents:
trackingEvents
-
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.
-
updateDate:
updateDate
Read Only:
true
update date -
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 : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : actualCo2EqEmission
Actual CO2 equivalent emissions for the shipment.
Match All
Show Source
Nested Schema : allocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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
Read Only:
true
The actual volume used in calculating the cost of the shipment.
Match All
Show Source
Nested Schema : chargeableWeight
Read Only:
true
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 : containerGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : costs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dimVolume
Read Only:
true
The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
Match All
Show Source
Nested Schema : dimWeight
Read Only:
true
The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : informationalCosts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : insurancePremium
The insurance premium of the shipment, for informational purposes.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : orderReleases
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : originalInvoiceCost
The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.
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 : plannedCost
The cost when the original shipment was created. This attribute is marked as Create-Only.
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
Read Only:
true
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 : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reqdocs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : sEquipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : siCutoffDate
The shippers instruction cutoff date associated with the shipment.
Match All
Show Source
Nested Schema : sightingDate
Read Only:
true
The date and time when the shipment was last sighted at the sighting location.
Match All
Show Source
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : sShipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : stops
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : tenders
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : totalActualCost
The total actual cost of the shipment. This attribute is marked as Create-Only.
Match All
Show Source
Nested Schema : totalApprovedCost
The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.
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
Read Only:
true
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. This attribute is marked as Create-Only.
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. This attribute is marked as Create-Only.
Match All
Show Source
Nested Schema : trackingEvents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : shipments.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The XID for the shipment.
-
adjustmentReasonGid: string
The reason why the accessorial was added.
-
costRefs:
costRefs
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
processAsFlowThru: boolean
The override for record to be copied to the sell side during rating.
-
remarks:
remarks
Nested Schema : costRefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.accessorials.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The shipment cost qualifier GID that defines the type of cost.
Nested Schema : shipments.accessorials.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, which identifies the type of remark this is.
-
remarkSequence: number
(int64)
The one-up sequence for the remark, to create a unique identifier.
-
remarkText: string
The remark itself.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : shipments.allocations
Type:
Show Source
object
-
allocatedCost:
allocatedCost
No description.
-
allocSeqNo: number
(int64)
No description.
-
allocTypeQualGid: string
GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
invoiceGid: string
GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
-
links: array
links
Read Only:
true
-
orderAllocations:
orderAllocations
-
orderBaseLineAllocations:
orderBaseLineAllocations
-
orderLineAllocations:
orderLineAllocations
-
parentInvoiceGid: string
If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
-
shipGroupGid: string
Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
group. -
timestamp:
timestamp
No description.
-
voucherGid: string
GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
Nested Schema : orderAllocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : orderBaseLineAllocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : orderLineAllocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : shipments.allocations.orderAllocations
Type:
Show Source
object
-
accessorialCodeGid: string
No description.
-
allocCostSeqno: number
(int64)
No description.
-
attribute1: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute10: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute11: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute12: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute13: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute14: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute15: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute16: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute17: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute18: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute19: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute2: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute20: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute3: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute4: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute5: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute6: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute7: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute8: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute9: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attributeCurrency1:
attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency2:
attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency3:
attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeDate1:
attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate10:
attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate11:
attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate12:
attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate13:
attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate14:
attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate15:
attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate16:
attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate17:
attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate18:
attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate19:
attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate2:
attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate20:
attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate3:
attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate4:
attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate5:
attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate6:
attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate7:
attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate8:
attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate9:
attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeNumber1: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber10: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber11: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber12: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber13: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber14: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber15: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber16: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber17: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber18: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber19: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber2: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber20: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber3: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber4: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber5: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber6: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber7: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber8: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber9: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
cost:
cost
No description.
-
costDescription: string
No description.
-
costTypeGid: string
cost type for this allocation record
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
generalLedgerGid: string
GL code for the allocation order release record.
-
invoiceGid: string
Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill
-
lineitemSeqNo: number
(int32)
Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill
-
links: array
links
Read Only:
true
-
orderReleaseGid: string
No description.
-
shipmentCostSeqno: number
(int64)
Shipment cost seq no would be stored if we perform allocation based on shipment
-
shipmentGid: string
Shipment Gid would be stored in this field if allocation is done based on shipment
-
vatCodeGid: string
The GID for the VAT tax that is being allocated from voucher.
-
voucherGid: string
Voucher Gid would be stored in this field if allocation is done based on voucher
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : shipments.allocations.orderBaseLineAllocations
Type:
Show Source
object
-
accessorialCodeGid: string
No description.
-
allocCostSeqno: number
(int64)
No description.
-
attribute1: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute10: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute11: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute12: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute13: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute14: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute15: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute16: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute17: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute18: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute19: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute2: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute20: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute3: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute4: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute5: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute6: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute7: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute8: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute9: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attributeCurrency1:
attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency2:
attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency3:
attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeDate1:
attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate10:
attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate11:
attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate12:
attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate13:
attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate14:
attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate15:
attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate16:
attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate17:
attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate18:
attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate19:
attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate2:
attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate20:
attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate3:
attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate4:
attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate5:
attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate6:
attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate7:
attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate8:
attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate9:
attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeNumber1: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber10: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber11: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber12: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber13: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber14: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber15: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber16: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber17: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber18: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber19: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber2: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber20: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber3: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber4: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber5: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber6: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber7: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber8: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber9: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
cost:
cost
No description.
-
costDescription: string
No description.
-
costTypeGid: string
No description.
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
generalLedgerGid: string
No description.
-
invoiceGid: string
No description.
-
lineitemSeqNo: number
(int32)
No description.
-
links: array
links
Read Only:
true
-
obLineGid: string
No description.
-
shipmentCostSeqno: number
(int64)
No description.
-
shipmentGid: string
No description.
-
vatCodeGid: string
The GID for the VAT tax that is being allocated from voucher.
-
voucherGid: string
No description.
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : shipments.allocations.orderLineAllocations
Type:
Show Source
object
-
accessorialCodeGid: string
No description.
-
allocCostSeqno: number
(int64)
No description.
-
attribute1: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute10: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute11: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute12: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute13: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute14: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute15: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute16: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute17: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute18: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute19: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute2: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute20: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute3: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute4: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute5: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute6: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute7: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute8: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute9: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attributeCurrency1:
attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency2:
attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency3:
attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeDate1:
attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate10:
attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate11:
attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate12:
attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate13:
attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate14:
attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate15:
attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate16:
attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate17:
attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate18:
attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate19:
attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate2:
attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate20:
attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate3:
attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate4:
attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate5:
attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate6:
attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate7:
attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate8:
attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate9:
attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeNumber1: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber10: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber11: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber12: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber13: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber14: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber15: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber16: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber17: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber18: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber19: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber2: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber20: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber3: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber4: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber5: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber6: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber7: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber8: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber9: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
cost:
cost
No description.
-
costDescription: string
No description.
-
costTypeGid: string
cost type for this allocation record
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
generalLedgerGid: string
GL code for the allocation order release line record.
-
invoiceGid: string
No description.
-
lineitemSeqNo: number
(int32)
No description.
-
links: array
links
Read Only:
true
-
orderReleaseLineGid: string
No description.
-
shipmentCostSeqno: number
(int64)
Shipment cost seq no would be stored if we perform allocation based on shipment
-
shipmentGid: string
Shipment Gid would be stored in this field if allocation is done based Shipment.
-
vatCodeGid: string
The GID for the VAT tax that is being allocated from voucher.
-
voucherGid: string
Voucher Gid would be stored in this field if allocation is done based on voucher or invoice
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : shipments.containerGroups
Type:
Show Source
object
-
containerGroupGid: string
The GID for the container group.
-
containerGroupXid: string
The XID for the container group.
-
containerReleaseNumber: string
The container release number is assigned once a sea carrier receives a new booking line item. They return the container release number (CRN) corresponding to the new booking.
-
destuffLocationGid: string
The location where the contents will be unloaded (destuffed) from the container.
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
referenceCode: string
This field is populated with the reference code that was entered on the unitization rule that was used to create this container.
-
stuffLocationGid: string
The location where the contents will be loaded (stuffed) into the container.
-
unitizationRequestType: string
The unitization request type for this container group that can accept orders with the same unitization request flag and the same stuffing and destuffing location.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.containerGroups.details
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sEquipmentGid: string
The GID for the equipment instance on a shipment for this container group.
Nested Schema : shipments.costs
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code GID associated with the shipment cost.
-
accessorialCostGid: string
The accessorial cost GID associated with the shipment cost.
-
adjustmentReasonGid: string
The reason why this cost was added.
-
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
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency3:
attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
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
-
billableIndicatorGid: string
Indicates the billable status of this shipment cost (sell shipment only).
-
cost:
cost
The cost as it relegates to the cost type for the shipment.
-
costCategoryGid: string
Read Only:
true
The Cost Category Identifier associated with the Shipment Cost -
costIdentifier: string
It will be used to identify or describe a cost.
-
costType: string
C, A, B
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
The date to be used for any currency conversions; if null, the latest conversion is used.
-
exchangeRateGid: string
The set of exchange rates to use for currency conversions; if null, the default set is used.
-
generalLedgerGid: string
The GL code for the shipment cost record.
-
isCostFixed: boolean
Indicates shipment cost is a fixed cost.
-
isWeighted: boolean
Read Only:
true
Whether or not the cost affects the total weighted cost of the shipment only. -
links: array
links
Read Only:
true
-
paymentMethodCodeGid: string
The payment method code for the shipment cost.
-
processAsFlowThru: boolean
The override for a record to be copied to the sell side during rating.
-
rateGeoCostGroupGid: string
The rate detail cost group GID associated with the shipment cost.
-
rateGeoCostSeq: number
(int64)
The rate detail cost sequence identifier associated with the shipment cost.
-
refs:
refs
-
remarks:
remarks
-
shipmentCostSeqno: number
(int64)
A system-generated unique sequence number to define the shipment costs. This attribute is marked as Create-Only.
-
specialServiceGid: string
The special service GID associated with the shipment cost.
-
sShipUnitGid: string
Points to the ship unit (if any) associated with this shipment cost, as a package.
-
sShipUnitLineNo: number
(int64)
Points to the ship unit line (if any) associated with this shipment cost, as a package.
-
trackingNumber: string
Denotes the tracking number associated with a specific charge/cost.
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency3
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 : cost
The cost as it relegates to the cost type for the shipment.
Match All
Show Source
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exchangeRateDate
The date to be used for any currency conversions; if null, the latest conversion is used.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.costs.details
Type:
Show Source
object
-
detail: string
The textual description of the cost detail as calculated and applied by the rating engine.
-
detailSeqno: number
(int64)
A one-up number to make the cost detail record unique.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.costs.refs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID.
-
domainName: string
Database domain where this data is stored.
-
isDropoff: boolean
True or false value to specify if the cost is a dropoff cost.
-
isPickup: boolean
True or false value to specify if the cost is a pickup cost.
-
links: array
links
Read Only:
true
-
seqno: number
(int64)
A system-generated unique sequence number.
-
shipmentCostQualGid: string
A GID for the various cost qualifiers like: item, order base, order release, order release line, etc.
Nested Schema : shipments.costs.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, or remark type.
-
remarkSequence: number
(int64)
The one-up number to make this remark unique.
-
remarkText: string
The remark text.
Nested Schema : shipments.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : shipments.informationalCosts
Type:
Show Source
object
-
cost:
cost
The cost amount.
-
detail: string
Generated text that details the calculation of the cost.
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
infCostType: string
Type of informational cost. O = Original, D = Display
-
links: array
links
Read Only:
true
-
remarks:
remarks
-
shipmentInfCostQualGid: string
The shipment informational cost qualifier GID for this cost.
-
shipmentInfCostSeqno: number
(int64)
The shipment informational cost sequence number.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.informationalCosts.details
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
-
accessorialCostGid: string
The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
-
adjustmentReasonGid: string
An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
-
cost:
cost
The cost value. Examples are base and accessorial.
-
costType: string
The cost type for this shipment cost record.
-
detailSeqno: number
(int64)
The detail sequence number (key).
-
domainName: string
Database domain where this data is stored.
-
generalLedgerGid: string
The general ledger GID associated with the cost element and sent to financial systems.
-
isCostFixed: boolean
A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
-
links: array
links
Read Only:
true
-
processAsFlowThru: boolean
A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
-
rateGeoCostGroupGid: string
The rate detail cost group identifier that was used in calculating this cost value.
-
rateGeoCostSeq: number
(int64)
The rate detail cost sequence that was used in calculating this cost value.
-
specialServiceGid: string
The special service identifier associated to the cost record if it was calculated from a special service.
Nested Schema : shipments.informationalCosts.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSeq: number
(int64)
The remark sequence number (key).
-
remarkText: string
The text associated to the remark code.
Nested Schema : shipments.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication ,method for the involved party listed on the shipment.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The involved party contact for the qualifier listed on the shipment.
-
involvedPartyQualGid: string
The involved party qualifier identifier.
-
links: array
links
Read Only:
true
-
overrideAddresses:
overrideAddresses
-
overrideCity: string
The location city that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
-
overrideCountryCode3Gid: string
The location country code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideLocationName: string
The location name that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
-
overridePostalCode: string
The location postal code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideProvince: string
The location providence that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideProvinceCode: string
The location providence code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
Nested Schema : overrideAddresses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.involvedParties.overrideAddresses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
lineSequence: number
(int64)
The line sequence (key) for the involved party on the shipment.
-
links: array
links
Read Only:
true
-
overrideAddressLine: string
The address line that is to be used for this involved party on a shipment in place (Overridden) of the one on the contact table for the involved party.
Nested Schema : shipments.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentRefnumQualGid: string
The reference qualifier GID defining the reference code.
-
shipmentRefnumValue: string
The value associated to the reference code.
Nested Schema : shipments.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
-
remarkSequence: number
(int64)
The remark sequence (key) associated with the shipment remarks.
-
remarkText: string
A user-entered remark on the shipment.
Nested Schema : shipments.reqdocs
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
The required document type for the shipment.
-
domainName: string
Database domain where this data is stored.
-
instructions: string
The instruction associated with handling of the document.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
The number of document revisions generated.
-
reviewers:
reviewers
-
reviewStatus: string
The status of the review of the document.
-
statuses:
statuses
-
subscribers:
subscribers
-
texts:
texts
Nested Schema : reviewers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : subscribers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.docs
Type:
Show Source
object
-
annotations: string
The document revision annotations.
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
The document GID.
-
documentRevision: number
(int32)
The document revision count.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
review: string
The document review state.
-
reviews:
reviews
Nested Schema : reviews
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.docs.reviews
Type:
Show Source
object
-
comments: string
Comments added by the reviewer.
-
contactGid: string
The reviewer GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
state: string
The review state.
Nested Schema : shipments.reqdocs.reviewers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party qualifier for reviewer, if it is acting as a party on the shipment.
-
contactGid: string
The reviewer.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type.
-
statusValueGid: string
The status value.
Nested Schema : shipments.reqdocs.subscribers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party qualifier for subscriber, if it is acting as a party on the shipment.
-
contactGid: string
The subscriber GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.texts
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sShipUnitGid: string
If the text is associated with a ship unit or ship unit line, this holds the ship unit ID.
-
sShipUnitLineNo: number
(int64)
If the text is associated with a ship unit line, this holds the ship unit line number.
-
textTemplateGid: string
The text template ID.
Nested Schema : shipments.sEquipments
Type:
Show Source
object
-
capacityUsageGid: string
The capacity usage GID that was used for the shipment.
-
domainName: string
Database domain where this data is stored.
-
dropoffStopNum: number
(int32)
The stop number where the equipment is dropped off. It is null if not dropped off in this shipment.
-
links: array
links
Read Only:
true
-
pickupStopNum: number
(int32)
The stop number where the equipment is picked up. It is null if not picked up in this shipment.
-
sEquipmentGid: string
The GID for the equipment associated with the shipment.
-
sEquipmentIndex: number
(int32)
The standing order of the equipment on the shipment.
Nested Schema : shipments.specialServices
Type:
Show Source
object
-
actualDistance:
actualDistance
The actual distance of the special service.
-
actualDuration:
actualDuration
The actual duration of the special service.
-
actualItemPackageCount: number
(int64)
The actual package count applicable to this special service.
-
actualOccurTime:
actualOccurTime
The actual date and time special service occurred.
-
actualShipUnitCount: number
(int64)
The actual ship unit count applicable to this special service.
-
actualVolume:
actualVolume
The actual volume of the goods applicable to this special service.
-
actualWeight:
actualWeight
The actual weight of the goods applicable to this special service.
-
adjustmentReasonGid: string
The reason why charge was added.
-
billableIndicatorGid: string
indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
-
completionState: string
Indicates completion state of this special service.
-
domainName: string
Database domain where this data is stored.
-
isPlannedDurationFixed: boolean
If Y, prevents the system from overwriting the planned duration for the special service.
-
isSystemGenerated: boolean
Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
-
links: array
links
Read Only:
true
-
payableIndicatorGid: string
Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
-
plannedDuration:
plannedDuration
The planned duration of the special service.
-
processAsFlowThru: boolean
The override for record to be copied to the sell side during rating.
-
refs:
refs
-
remarks:
remarks
-
secondaryCharges:
secondaryCharges
-
shipmentSpecialServiceSeq: number
(int64)
The sequence to keep shipment special services unique.
-
specialServiceGid: string
The special service associated with the remark.
-
stopNum: number
(int32)
If the special service is for a particular stop, this indicates the stop number.
Nested Schema : actualOccurTime
The actual date and time special service occurred.
Match All
Show Source
Nested Schema : actualVolume
The actual volume of the goods applicable to this special service.
Match All
Show Source
Nested Schema : actualWeight
The actual weight of the goods applicable to this special service.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : secondaryCharges
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.specialServices.refs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID for the shipment special service.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The shipment cost qualifier associated to the cost reference.
Nested Schema : shipments.specialServices.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, or type.
-
remarkSequence: number
(int64)
The one-up number to make the remark unique.
-
remarkText: string
The remark text itself.
Nested Schema : shipments.specialServices.secondaryCharges
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
secondaryChargeShipmentGid: string
The secondary charge shipment identifier that contains the cost elements and information for the charges.
Nested Schema : shipments.sShipUnits
Type:
Show Source
object
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
domainName: string
Database domain where this data is stored.
-
earlyPickupDate:
earlyPickupDate
The early pickup date defined for the ship unit
-
flexCommodityCode: string
The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
-
flexCommodityQualGid: string
A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
-
isAllowRepack: boolean
If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
-
isCountSplittable: boolean
Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
-
isFixedEruCount: boolean
Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
-
isSplitable: boolean
A true or false value to define whether the ship unit can be split when creating the shipments.
-
links: array
links
Read Only:
true
-
priority: number
(int32)
Defines the priority associated with ship unit.
-
rangeEnd: number
(int32)
The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
rangeStart: number
(int32)
The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
receivedNetVolume:
receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedNetWeight:
receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedShipUnitCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedVolume:
receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
releaseMethodGid: string
The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
-
shipUnitCount: number
(int64)
Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
-
shipUnitGid: string
The GID for the order release ship unit that is associated to this shipment ship unit.
-
sShipUnitGid: string
The GID for the ship unit associated to a shipment.
-
sShipUnitXid: string
The XID for the ship unit associated to a shipment.
-
tag1: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag2: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag3: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag4: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
totalGrossVolume:
totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
-
totalGrossWeight:
totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
-
totalLoadingSplitVolume:
totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
-
totalLoadingSplitWeight:
totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
tShipUnitGid: string
A GID for the order release ship unit.
-
unitDiameter:
unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
-
unitHeight:
unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
unitLength:
unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
unitNetVolume:
unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
-
unitNetWeight:
unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
-
unitVolume:
unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
-
unitWeight:
unitWeight
The weight of the ship unit.
-
unitWidth:
unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : earlyPickupDate
The early pickup date defined for the ship unit
Match All
Show Source
Nested Schema : receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
Match All
Show Source
Nested Schema : unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
Match All
Show Source
Nested Schema : unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Match All
Show Source
Nested Schema : shipments.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type GID for the status value on the shipment.
-
statusValueGid: string
The status value for the shipment status.
Nested Schema : shipments.stops
Type:
Show Source
object
-
accessorialTime:
accessorialTime
The sum of the fixed accessorial time for a particular stop.
-
activityTime:
activityTime
The time spent at the stop for pickup or delivery.
-
actualArrival:
actualArrival
A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
-
actualDeparture:
actualDeparture
The actual departure date and time at the stop.
-
appointmentDelivery:
appointmentDelivery
A Y/N indicator defining if the stop requires a delivery appointment.
-
appointmentDuration:
appointmentDuration
The total appointment duration at the stop.
-
appointmentPickup:
appointmentPickup
A Y/N indicator defining if the stop requires a pickup appointment.
-
appointmentWindowEnd:
appointmentWindowEnd
The appointment window end.
-
appointmentWindowStart:
appointmentWindowStart
The appointment window start.
-
arbitraryType: string
SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.
-
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)
-
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
-
debriefs:
debriefs
-
details:
details
-
distanceType: string
Read Only:
true
L - Loaded, B- Bobtail, D - Deadhead -
distFromPrevStop:
distFromPrevStop
The distance from the last stop.
-
domainName: string
Database domain where this data is stored.
-
driverNonPayable: boolean
Allows the user to specify that stop is payable or not.
-
driveTime:
driveTime
The drive time to the stop from the last stop.
-
estimatedArrival:
estimatedArrival
The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.
-
estimatedDeparture:
estimatedDeparture
The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.
-
externalVoyageCode: string
Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.
-
extSeqNo: number
(int32)
The external sequence number for the stop.
-
flightInstanceId: number
(int64)
Read Only:
true
The flight instance GID. -
fwdLengthOog:
fwdLengthOog
Read Only:
true
The forward length-wise out of gauge. -
involvedParties:
involvedParties
-
isDepot: boolean
A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.
-
isFixedArrival: boolean
A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
-
isFixedDeparture: boolean
A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.
-
isFixedDistance: boolean
When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.
-
isMotherVessel: boolean
Designates a leg as mother vessel to automatically populated header.
-
isPermanent: boolean
A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.
-
leftWidthOog:
leftWidthOog
Read Only:
true
The left width-wise out of gauge. -
links: array
links
Read Only:
true
-
locationGid: string
The location GID for the shipment stop.
-
locationOverrideGid: string
The location GID defining the location to be used to override the actual location on the stop record.
-
locationRoleGid: string
The location role GID for the shipment stop (such as port, cross dock, etc.).
-
parentLocationGid: string
If an operational location, such as terminal at a port, is chosen for this stop, the location GID will be copied to this field and the location GID field will contain the operational location.
-
plannedArrival:
plannedArrival
The planned date and time of arrival at the stop.
-
plannedDeparture:
plannedDeparture
The planned departure date and time at the stop.
-
predictedArrival:
predictedArrival
Read Only:
true
Denotes the predicted arrival time at the stop. -
predictedArrivalHigh:
predictedArrivalHigh
Read Only:
true
Denotes the predicted arrival time high value at the stop. -
predictedArrivalLow:
predictedArrivalLow
Read Only:
true
Denotes the predicted arrival time low value at the stop. -
rateDistanceGid: string
The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case.
-
rateServiceGid: string
The rate service GID set if the stop times were calculated using the rate service engine.
-
rearLengthOog:
rearLengthOog
Read Only:
true
The rear length-wise out of gauge. -
refnums:
refnums
-
remarks:
remarks
-
repetitionSchedStopNumber: number
(int32)
Read Only:
true
The repetition schedule stop GID if the stop times were calculated from a repetition schedule. -
repetitionScheduleGid: string
Read Only:
true
The repetition schedule GID if the stop times were calculated from a repetition schedule. -
restTime:
restTime
The time the truck or the transportation mode should take for rest at the stop.
-
rightWidthOog:
rightWidthOog
Read Only:
true
The right width-wise out of gauge. -
routeCodeGid: string
The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case.
-
runningHeight:
runningHeight
Read Only:
true
The running total height from current stop to next stop. -
runningLength:
runningLength
Read Only:
true
The running total length from current stop to next stop. -
runningWeight:
runningWeight
Read Only:
true
The running total weight from current stop to next stop. -
runningWidth:
runningWidth
Read Only:
true
The running total width from current stop to next stop. -
rushHourTime:
rushHourTime
The amount of time that the drive time defined on the stop in inside the rush hour window.
-
slackVariance: number
(double)
Read Only:
true
The slack variance. -
stopNum: 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. This attribute is marked as Create-Only.
-
stopRequirementType: string
Used only for trips.
-
stopType: string
Define the type of this stop.
-
voyageGid: string
Read Only:
true
The voyage GID. -
waitTime:
waitTime
The time the truck or the transportation mode has to wait at the stop.
Nested Schema : accessorialTime
The sum of the fixed accessorial time for a particular stop.
Match All
Show Source
Nested Schema : activityTime
The time spent at the stop for pickup or delivery.
Match All
Show Source
Nested Schema : actualArrival
A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
Match All
Show Source
Nested Schema : actualDeparture
The actual departure date and time at the stop.
Match All
Show Source
Nested Schema : appointmentDelivery
A Y/N indicator defining if the stop requires a delivery appointment.
Match All
Show Source
Nested Schema : appointmentDuration
The total appointment duration at the stop.
Match All
Show Source
Nested Schema : appointmentPickup
A Y/N indicator defining if the stop requires a pickup appointment.
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 : debriefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : estimatedArrival
The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.
Match All
Show Source
Nested Schema : estimatedDeparture
The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.
Match All
Show Source
Nested Schema : fwdLengthOog
Read Only:
true
The forward length-wise out of gauge.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : leftWidthOog
Read Only:
true
The left width-wise out of gauge.
Match All
Show Source
Nested Schema : plannedArrival
The planned date and time of arrival at the stop.
Match All
Show Source
Nested Schema : plannedDeparture
The planned departure date and time at the stop.
Match All
Show Source
Nested Schema : predictedArrival
Read Only:
true
Denotes the predicted arrival time at the stop.
Match All
Show Source
Nested Schema : predictedArrivalHigh
Read Only:
true
Denotes the predicted arrival time high value at the stop.
Match All
Show Source
Nested Schema : predictedArrivalLow
Read Only:
true
Denotes the predicted arrival time low value at the stop.
Match All
Show Source
Nested Schema : rearLengthOog
Read Only:
true
The rear length-wise out of gauge.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : restTime
The time the truck or the transportation mode should take for rest at the stop.
Match All
Show Source
Nested Schema : rightWidthOog
Read Only:
true
The right width-wise out of gauge.
Match All
Show Source
Nested Schema : runningHeight
Read Only:
true
The running total height from current stop to next stop.
Match All
Show Source
Nested Schema : runningLength
Read Only:
true
The running total length from current stop to next stop.
Match All
Show Source
Nested Schema : runningWeight
Read Only:
true
The running total weight from current stop to next stop.
Match All
Show Source
Nested Schema : runningWidth
Read Only:
true
The running total width from current stop to next stop.
Match All
Show Source
Nested Schema : rushHourTime
The amount of time that the drive time defined on the stop in inside the rush hour window.
Match All
Show Source
Nested Schema : waitTime
The time the truck or the transportation mode has to wait at the stop.
Match All
Show Source
Nested Schema : shipments.stops.debriefs
Type:
Show Source
object
-
activity: string
Specifies the activity (pickup, drop off) for the stop and the debrief values.
-
domainName: string
Database domain where this data is stored.
-
itemGid: string
The item GID for the stop debrief.
-
itemPackageCount: number
(int64)
The count of the package item count.
-
links: array
links
Read Only:
true
-
matchType: string
The match type code for linking the stop debrief data.
-
nonConfReasonCodeGid: string
The non conformance reason code GID associated with the stop debrief recording.
-
orderReleaseLineGid: string
The order release line GID linked to the stop debrief.
-
packagingUnitCount: number
(int64)
The packaging unit count for the packing unit contained in the packaged item.
-
packagingUnitGid: string
The packaging unit GID for the packaging unit count that is contained in the packaged item.
-
sequenceNo: string
The sequence number (key).
-
sEquipmentGid: string
The equipment GID linked to the stop debrief.
-
shipUnitGid: string
The ship unit GID linked to the stop debrief.
-
sShipUnitGid: string
The GID for ship unit for the shipment.
-
sShipUnitLineNo: number
(int64)
The GID for ship unit line number for the shipment.
-
transportHandlingUnitCount: number
(int64)
The transport handling count GID for the stop debrief.
-
transportHandlingUnitGid: string
The transport handling unit GID associated with the transport handling unit.
Nested Schema : shipments.stops.details
Type:
Show Source
object
-
activity: string
The activity performed at the stop. For example: pickup, delivery, etc.
-
activityTime:
activityTime
The time spent performing the activity at the shipment stop.
-
domainName: string
Date and time of the most recent data update.
-
involvedParties:
involvedParties
-
isPermanent: boolean
A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.
-
links: array
links
Read Only:
true
-
shipUnitDwellTime:
shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
-
sShipUnitGid: string
A GID to define the shipment ship unit.
Nested Schema : activityTime
The time spent performing the activity at the shipment stop.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
Match All
Show Source
Nested Schema : shipments.stops.details.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method ID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact ID for the involved party.
-
involvedPartyQualGid: string
The qualifier ID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : shipments.stops.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact ID for the involved party.
-
involvedPartyQualGid: string
The qualifier ID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : shipments.stops.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentStopRefnumQualGid: string
The shipment reference qualifier GID defining the reference type.
-
shipmentStopRefnumValue: string
The shipment stop reference value.
Nested Schema : shipments.stops.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
-
remarkSequence: number
(int64)
The sequence (key) for the remark.
-
remarkText: string
User entered remark.
Nested Schema : shipments.tenders
Type:
Show Source
object
-
deliveryTime:
deliveryTime
No description.
-
destinationLocation: string
A unique identifier to define the locations withing GC3. The gid contains the domain portion.
-
domainName: string
No description.
-
expectedResponse:
expectedResponse
No description.
-
expectedRespUpdated: boolean
Determines whether the expected response for the tender is updated.
-
isStepTender: string
No description.
-
isTenderCount: boolean
No description.
-
iTransactionNo: number
(int64)
No description.
-
links: array
links
Read Only:
true
-
marketCost:
marketCost
Market cost based on the shipment.
-
originalPickupTime:
originalPickupTime
No description.
-
originLocation: string
A unique identifier to define the locations withing GC3. The gid contains the domain portion.
-
plannedCost:
plannedCost
Copied planning cost from shipment.
-
processControlRequestId: number
(int64)
No description.
-
rateGeoGid: string
References the rate record that that is associated with the tender.
-
shipmentTime:
shipmentTime
No description.
-
stepResponseTime:
stepResponseTime
No description.
-
stepResponseTimeBase: number
(int64)
No description.
-
stepResponseTimeUomCode: string
No description.
-
stepTenderPcrId: number
(int64)
No description.
-
tenderType: string
Defines the type of tender. Values are 'Ordinary', 'Broadcast Tender', and 'Spot Bid'
Nested Schema : shipments.texts
Type:
Show Source
object
-
documentDefGid: string
A document that should hold text.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document.
-
textTemplateGid: string
The foreign key to the text template table, in order to include fixed text with this shipment.
Nested Schema : shipments.trackingEvents
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
eventLocationGid: string
The location identifier of an location based event. This will be null for non-location based events.
-
isHidden: boolean
A Y/N indicator to display the status history.
-
iTransactionNo: number
(int64)
The transaction identifier for the shipment data of the tracking event.
-
links: array
links
Read Only:
true
-
partitionKey: number
(double)
The monthly range partition to manage purging status messages.
-
reportingGluser: string
The reporting application user if the tracking event was entered via the system's tracking event UI.
-
reportingMethod: string
The reporting method that links into the communication methods defined for OTM.
-
servprovGid: string
The service provider associated with generating the tracking event.
-
shipmentStopNum: number
(int32)
The shipment stop number for a stop based event.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
accessorials:
accessorials
-
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.
-
allocations:
allocations
-
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
Read Only:
true
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
Read Only:
true
The actual volume used in calculating the cost of the shipment. -
chargeableWeight:
chargeableWeight
Read Only:
true
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
Read Only:
true
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)
Read Only:
true
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. This attribute is marked as Create-Only.
-
consolGid: string
The consol identifier if the shipment has been built from a consol structure.
-
contactGid: string
Read Only:
true
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.
-
containerGroups:
containerGroups
-
containerPickupLocGid: string
The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
-
costs:
costs
-
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)
Read Only:
true
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
Read Only:
true
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
Read Only:
true
The dimensional volume. Mathematical weight equivalence according to specified dim rate factor. -
dimWeight:
dimWeight
Read Only:
true
The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor. -
documents:
documents
-
domainName: string
The database domain where this data is stored.
-
driverAssignBulkPlanGid: string
Read Only:
true
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
Read Only:
true
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
Read Only:
true
The feasibility code associated with the shipment can identify shipment infeasibilities. -
firstEquipmentGroupGid: string
Read Only:
true
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.
-
informationalCosts:
informationalCosts
-
insertDate:
insertDate
Read Only:
true
insert date -
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
Read Only:
true
Indicates that this shipment is in a trailer build shipment group. -
involvedParties:
involvedParties
-
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
Read Only:
true
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
Read Only:
true
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
Read Only:
true
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. This attribute is marked as Create-Only.
-
isToBeHeld: boolean
A Y/N indicator specifying that the shipment is to be held by the carrier.
-
itineraryGid: string
Read Only:
true
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
Read Only:
true
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.
-
orderReleases:
orderReleases
-
originalInvoiceCost:
originalInvoiceCost
The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.
-
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
Read Only:
true
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
Read Only:
true
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. This attribute is marked as Create-Only.
-
plannedRateGeoGid: string
Read Only:
true
The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
plannedRateOfferingGid: string
Read Only:
true
The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
plannedServprovGid: string
Read Only:
true
The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
plannedTransportModeGid: string
Read Only:
true
The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter. -
planningParameterSetGid: string
Read Only:
true
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
Read Only:
true
The date associated with the previous sighting location and in the tracking event. -
prevSightingLocationGid: string
Read Only:
true
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.
-
refnums:
refnums
-
remarks:
remarks
-
repetitionScheduleGid: string
Read Only:
true
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
-
reqdocs:
reqdocs
-
reservationNum: string
Saved here to search shipments based on Reservation Number.
-
routeCodeCombinationGid: string
Read Only:
true
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
Read Only:
true
When the schedule type is populated, it is a consol. -
secondaryChargeRuleGid: string
Read Only:
true
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.
-
sEquipments:
sEquipments
-
servprovGid: string
The service provider identifier associated with the shipment. This attribute is marked as Create-Only.
-
shipmentAsWork: boolean
Indicates the shipment as work. This attribute is marked as Create-Only.
-
shipmentGid: string
The GID for the shipment.
-
shipmentGroupGid: string
The shipment group identifier if this shipment is placed into a single group.
-
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
Read Only:
true
The date and time when the shipment was last sighted at the sighting location. -
sightingLocationGid: string
Read Only:
true
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.
-
specialServices:
specialServices
-
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.
-
sShipUnits:
sShipUnits
-
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.
-
statuses:
statuses
-
stops:
stops
-
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.
-
tenders:
tenders
-
termLocationText: string
The term location text that is informational for the shipment.
-
texts:
texts
-
totalActualCost:
totalActualCost
The total actual cost of the shipment. This attribute is marked as Create-Only.
-
totalApprovedCost:
totalApprovedCost
The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.
-
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)
Read Only:
true
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)
Read Only:
true
The total number of reference units of the shipment as defined by the equipment reference units. -
totalPackagingUnitCount: number
(int32)
Read Only:
true
The total packaging unit count of the shipment. -
totalShipUnitCount: number
(int64)
The total ship unit count of the shipment.
-
totalTransCost:
totalTransCost
Read Only:
true
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. This attribute is marked as Create-Only.
-
totMatchedInvoiceCost:
totMatchedInvoiceCost
The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.
-
trackingEvents:
trackingEvents
-
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.
-
updateDate:
updateDate
Read Only:
true
update date -
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 : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : actualCo2EqEmission
Actual CO2 equivalent emissions for the shipment.
Match All
Show Source
Nested Schema : allocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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
Read Only:
true
The actual volume used in calculating the cost of the shipment.
Match All
Show Source
Nested Schema : chargeableWeight
Read Only:
true
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 : containerGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : costs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dimVolume
Read Only:
true
The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
Match All
Show Source
Nested Schema : dimWeight
Read Only:
true
The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : informationalCosts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : insurancePremium
The insurance premium of the shipment, for informational purposes.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : orderReleases
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : originalInvoiceCost
The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.
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 : plannedCost
The cost when the original shipment was created. This attribute is marked as Create-Only.
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
Read Only:
true
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 : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reqdocs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : sEquipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : siCutoffDate
The shippers instruction cutoff date associated with the shipment.
Match All
Show Source
Nested Schema : sightingDate
Read Only:
true
The date and time when the shipment was last sighted at the sighting location.
Match All
Show Source
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : sShipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : stops
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : tenders
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : totalActualCost
The total actual cost of the shipment. This attribute is marked as Create-Only.
Match All
Show Source
Nested Schema : totalApprovedCost
The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.
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
Read Only:
true
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. This attribute is marked as Create-Only.
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. This attribute is marked as Create-Only.
Match All
Show Source
Nested Schema : trackingEvents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : shipments.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The XID for the shipment.
-
adjustmentReasonGid: string
The reason why the accessorial was added.
-
costRefs:
costRefs
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
processAsFlowThru: boolean
The override for record to be copied to the sell side during rating.
-
remarks:
remarks
Nested Schema : costRefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.accessorials.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The shipment cost qualifier GID that defines the type of cost.
Nested Schema : shipments.accessorials.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, which identifies the type of remark this is.
-
remarkSequence: number
(int64)
The one-up sequence for the remark, to create a unique identifier.
-
remarkText: string
The remark itself.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : shipments.allocations
Type:
Show Source
object
-
allocatedCost:
allocatedCost
No description.
-
allocSeqNo: number
(int64)
No description.
-
allocTypeQualGid: string
GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
invoiceGid: string
GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
-
links: array
links
Read Only:
true
-
orderAllocations:
orderAllocations
-
orderBaseLineAllocations:
orderBaseLineAllocations
-
orderLineAllocations:
orderLineAllocations
-
parentInvoiceGid: string
If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
-
shipGroupGid: string
Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
group. -
timestamp:
timestamp
No description.
-
voucherGid: string
GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
Nested Schema : orderAllocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : orderBaseLineAllocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : orderLineAllocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : shipments.allocations.orderAllocations
Type:
Show Source
object
-
accessorialCodeGid: string
No description.
-
allocCostSeqno: number
(int64)
No description.
-
attribute1: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute10: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute11: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute12: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute13: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute14: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute15: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute16: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute17: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute18: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute19: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute2: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute20: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute3: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute4: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute5: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute6: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute7: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute8: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute9: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attributeCurrency1:
attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency2:
attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency3:
attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeDate1:
attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate10:
attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate11:
attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate12:
attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate13:
attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate14:
attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate15:
attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate16:
attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate17:
attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate18:
attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate19:
attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate2:
attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate20:
attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate3:
attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate4:
attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate5:
attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate6:
attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate7:
attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate8:
attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate9:
attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeNumber1: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber10: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber11: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber12: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber13: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber14: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber15: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber16: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber17: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber18: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber19: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber2: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber20: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber3: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber4: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber5: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber6: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber7: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber8: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber9: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
cost:
cost
No description.
-
costDescription: string
No description.
-
costTypeGid: string
cost type for this allocation record
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
generalLedgerGid: string
GL code for the allocation order release record.
-
invoiceGid: string
Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill
-
lineitemSeqNo: number
(int32)
Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill
-
links: array
links
Read Only:
true
-
orderReleaseGid: string
No description.
-
shipmentCostSeqno: number
(int64)
Shipment cost seq no would be stored if we perform allocation based on shipment
-
shipmentGid: string
Shipment Gid would be stored in this field if allocation is done based on shipment
-
vatCodeGid: string
The GID for the VAT tax that is being allocated from voucher.
-
voucherGid: string
Voucher Gid would be stored in this field if allocation is done based on voucher
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : shipments.allocations.orderBaseLineAllocations
Type:
Show Source
object
-
accessorialCodeGid: string
No description.
-
allocCostSeqno: number
(int64)
No description.
-
attribute1: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute10: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute11: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute12: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute13: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute14: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute15: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute16: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute17: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute18: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute19: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute2: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute20: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute3: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute4: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute5: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute6: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute7: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute8: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute9: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attributeCurrency1:
attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency2:
attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency3:
attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeDate1:
attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate10:
attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate11:
attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate12:
attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate13:
attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate14:
attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate15:
attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate16:
attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate17:
attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate18:
attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate19:
attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate2:
attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate20:
attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate3:
attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate4:
attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate5:
attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate6:
attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate7:
attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate8:
attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate9:
attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeNumber1: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber10: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber11: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber12: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber13: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber14: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber15: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber16: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber17: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber18: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber19: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber2: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber20: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber3: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber4: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber5: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber6: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber7: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber8: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber9: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
cost:
cost
No description.
-
costDescription: string
No description.
-
costTypeGid: string
No description.
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
generalLedgerGid: string
No description.
-
invoiceGid: string
No description.
-
lineitemSeqNo: number
(int32)
No description.
-
links: array
links
Read Only:
true
-
obLineGid: string
No description.
-
shipmentCostSeqno: number
(int64)
No description.
-
shipmentGid: string
No description.
-
vatCodeGid: string
The GID for the VAT tax that is being allocated from voucher.
-
voucherGid: string
No description.
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : shipments.allocations.orderLineAllocations
Type:
Show Source
object
-
accessorialCodeGid: string
No description.
-
allocCostSeqno: number
(int64)
No description.
-
attribute1: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute10: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute11: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute12: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute13: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute14: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute15: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute16: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute17: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute18: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute19: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute2: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute20: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute3: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute4: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute5: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute6: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute7: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute8: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attribute9: string
Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
-
attributeCurrency1:
attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency2:
attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeCurrency3:
attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
-
attributeDate1:
attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate10:
attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate11:
attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate12:
attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate13:
attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate14:
attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate15:
attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate16:
attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate17:
attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate18:
attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate19:
attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate2:
attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate20:
attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate3:
attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate4:
attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate5:
attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate6:
attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate7:
attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate8:
attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeDate9:
attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
-
attributeNumber1: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber10: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber11: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber12: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber13: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber14: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber15: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber16: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber17: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber18: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber19: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber2: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber20: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber3: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber4: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber5: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber6: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber7: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber8: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
attributeNumber9: number
(double)
Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
-
cost:
cost
No description.
-
costDescription: string
No description.
-
costTypeGid: string
cost type for this allocation record
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
generalLedgerGid: string
GL code for the allocation order release line record.
-
invoiceGid: string
No description.
-
lineitemSeqNo: number
(int32)
No description.
-
links: array
links
Read Only:
true
-
orderReleaseLineGid: string
No description.
-
shipmentCostSeqno: number
(int64)
Shipment cost seq no would be stored if we perform allocation based on shipment
-
shipmentGid: string
Shipment Gid would be stored in this field if allocation is done based Shipment.
-
vatCodeGid: string
The GID for the VAT tax that is being allocated from voucher.
-
voucherGid: string
Voucher Gid would be stored in this field if allocation is done based on voucher or invoice
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Show Source
Nested Schema : shipments.containerGroups
Type:
Show Source
object
-
containerGroupGid: string
The GID for the container group.
-
containerGroupXid: string
The XID for the container group.
-
containerReleaseNumber: string
The container release number is assigned once a sea carrier receives a new booking line item. They return the container release number (CRN) corresponding to the new booking.
-
destuffLocationGid: string
The location where the contents will be unloaded (destuffed) from the container.
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
referenceCode: string
This field is populated with the reference code that was entered on the unitization rule that was used to create this container.
-
stuffLocationGid: string
The location where the contents will be loaded (stuffed) into the container.
-
unitizationRequestType: string
The unitization request type for this container group that can accept orders with the same unitization request flag and the same stuffing and destuffing location.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.containerGroups.details
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sEquipmentGid: string
The GID for the equipment instance on a shipment for this container group.
Nested Schema : shipments.costs
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code GID associated with the shipment cost.
-
accessorialCostGid: string
The accessorial cost GID associated with the shipment cost.
-
adjustmentReasonGid: string
The reason why this cost was added.
-
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
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency3:
attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
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
-
billableIndicatorGid: string
Indicates the billable status of this shipment cost (sell shipment only).
-
cost:
cost
The cost as it relegates to the cost type for the shipment.
-
costCategoryGid: string
Read Only:
true
The Cost Category Identifier associated with the Shipment Cost -
costIdentifier: string
It will be used to identify or describe a cost.
-
costType: string
C, A, B
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
The date to be used for any currency conversions; if null, the latest conversion is used.
-
exchangeRateGid: string
The set of exchange rates to use for currency conversions; if null, the default set is used.
-
generalLedgerGid: string
The GL code for the shipment cost record.
-
isCostFixed: boolean
Indicates shipment cost is a fixed cost.
-
isWeighted: boolean
Read Only:
true
Whether or not the cost affects the total weighted cost of the shipment only. -
links: array
links
Read Only:
true
-
paymentMethodCodeGid: string
The payment method code for the shipment cost.
-
processAsFlowThru: boolean
The override for a record to be copied to the sell side during rating.
-
rateGeoCostGroupGid: string
The rate detail cost group GID associated with the shipment cost.
-
rateGeoCostSeq: number
(int64)
The rate detail cost sequence identifier associated with the shipment cost.
-
refs:
refs
-
remarks:
remarks
-
shipmentCostSeqno: number
(int64)
A system-generated unique sequence number to define the shipment costs. This attribute is marked as Create-Only.
-
specialServiceGid: string
The special service GID associated with the shipment cost.
-
sShipUnitGid: string
Points to the ship unit (if any) associated with this shipment cost, as a package.
-
sShipUnitLineNo: number
(int64)
Points to the ship unit line (if any) associated with this shipment cost, as a package.
-
trackingNumber: string
Denotes the tracking number associated with a specific charge/cost.
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency3
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 : cost
The cost as it relegates to the cost type for the shipment.
Match All
Show Source
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exchangeRateDate
The date to be used for any currency conversions; if null, the latest conversion is used.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.costs.details
Type:
Show Source
object
-
detail: string
The textual description of the cost detail as calculated and applied by the rating engine.
-
detailSeqno: number
(int64)
A one-up number to make the cost detail record unique.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.costs.refs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID.
-
domainName: string
Database domain where this data is stored.
-
isDropoff: boolean
True or false value to specify if the cost is a dropoff cost.
-
isPickup: boolean
True or false value to specify if the cost is a pickup cost.
-
links: array
links
Read Only:
true
-
seqno: number
(int64)
A system-generated unique sequence number.
-
shipmentCostQualGid: string
A GID for the various cost qualifiers like: item, order base, order release, order release line, etc.
Nested Schema : shipments.costs.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, or remark type.
-
remarkSequence: number
(int64)
The one-up number to make this remark unique.
-
remarkText: string
The remark text.
Nested Schema : shipments.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : shipments.informationalCosts
Type:
Show Source
object
-
cost:
cost
The cost amount.
-
detail: string
Generated text that details the calculation of the cost.
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
infCostType: string
Type of informational cost. O = Original, D = Display
-
links: array
links
Read Only:
true
-
remarks:
remarks
-
shipmentInfCostQualGid: string
The shipment informational cost qualifier GID for this cost.
-
shipmentInfCostSeqno: number
(int64)
The shipment informational cost sequence number.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.informationalCosts.details
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
-
accessorialCostGid: string
The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
-
adjustmentReasonGid: string
An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
-
cost:
cost
The cost value. Examples are base and accessorial.
-
costType: string
The cost type for this shipment cost record.
-
detailSeqno: number
(int64)
The detail sequence number (key).
-
domainName: string
Database domain where this data is stored.
-
generalLedgerGid: string
The general ledger GID associated with the cost element and sent to financial systems.
-
isCostFixed: boolean
A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
-
links: array
links
Read Only:
true
-
processAsFlowThru: boolean
A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
-
rateGeoCostGroupGid: string
The rate detail cost group identifier that was used in calculating this cost value.
-
rateGeoCostSeq: number
(int64)
The rate detail cost sequence that was used in calculating this cost value.
-
specialServiceGid: string
The special service identifier associated to the cost record if it was calculated from a special service.
Nested Schema : shipments.informationalCosts.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSeq: number
(int64)
The remark sequence number (key).
-
remarkText: string
The text associated to the remark code.
Nested Schema : shipments.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication ,method for the involved party listed on the shipment.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The involved party contact for the qualifier listed on the shipment.
-
involvedPartyQualGid: string
The involved party qualifier identifier.
-
links: array
links
Read Only:
true
-
overrideAddresses:
overrideAddresses
-
overrideCity: string
The location city that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
-
overrideCountryCode3Gid: string
The location country code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideLocationName: string
The location name that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
-
overridePostalCode: string
The location postal code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideProvince: string
The location providence that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
-
overrideProvinceCode: string
The location providence code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
Nested Schema : overrideAddresses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.involvedParties.overrideAddresses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
lineSequence: number
(int64)
The line sequence (key) for the involved party on the shipment.
-
links: array
links
Read Only:
true
-
overrideAddressLine: string
The address line that is to be used for this involved party on a shipment in place (Overridden) of the one on the contact table for the involved party.
Nested Schema : shipments.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentRefnumQualGid: string
The reference qualifier GID defining the reference code.
-
shipmentRefnumValue: string
The value associated to the reference code.
Nested Schema : shipments.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
-
remarkSequence: number
(int64)
The remark sequence (key) associated with the shipment remarks.
-
remarkText: string
A user-entered remark on the shipment.
Nested Schema : shipments.reqdocs
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
The required document type for the shipment.
-
domainName: string
Database domain where this data is stored.
-
instructions: string
The instruction associated with handling of the document.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
The number of document revisions generated.
-
reviewers:
reviewers
-
reviewStatus: string
The status of the review of the document.
-
statuses:
statuses
-
subscribers:
subscribers
-
texts:
texts
Nested Schema : reviewers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : subscribers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.docs
Type:
Show Source
object
-
annotations: string
The document revision annotations.
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
The document GID.
-
documentRevision: number
(int32)
The document revision count.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
review: string
The document review state.
-
reviews:
reviews
Nested Schema : reviews
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.docs.reviews
Type:
Show Source
object
-
comments: string
Comments added by the reviewer.
-
contactGid: string
The reviewer GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
state: string
The review state.
Nested Schema : shipments.reqdocs.reviewers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party qualifier for reviewer, if it is acting as a party on the shipment.
-
contactGid: string
The reviewer.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type.
-
statusValueGid: string
The status value.
Nested Schema : shipments.reqdocs.subscribers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party qualifier for subscriber, if it is acting as a party on the shipment.
-
contactGid: string
The subscriber GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.texts
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sShipUnitGid: string
If the text is associated with a ship unit or ship unit line, this holds the ship unit ID.
-
sShipUnitLineNo: number
(int64)
If the text is associated with a ship unit line, this holds the ship unit line number.
-
textTemplateGid: string
The text template ID.
Nested Schema : shipments.sEquipments
Type:
Show Source
object
-
capacityUsageGid: string
The capacity usage GID that was used for the shipment.
-
domainName: string
Database domain where this data is stored.
-
dropoffStopNum: number
(int32)
The stop number where the equipment is dropped off. It is null if not dropped off in this shipment.
-
links: array
links
Read Only:
true
-
pickupStopNum: number
(int32)
The stop number where the equipment is picked up. It is null if not picked up in this shipment.
-
sEquipmentGid: string
The GID for the equipment associated with the shipment.
-
sEquipmentIndex: number
(int32)
The standing order of the equipment on the shipment.
Nested Schema : shipments.specialServices
Type:
Show Source
object
-
actualDistance:
actualDistance
The actual distance of the special service.
-
actualDuration:
actualDuration
The actual duration of the special service.
-
actualItemPackageCount: number
(int64)
The actual package count applicable to this special service.
-
actualOccurTime:
actualOccurTime
The actual date and time special service occurred.
-
actualShipUnitCount: number
(int64)
The actual ship unit count applicable to this special service.
-
actualVolume:
actualVolume
The actual volume of the goods applicable to this special service.
-
actualWeight:
actualWeight
The actual weight of the goods applicable to this special service.
-
adjustmentReasonGid: string
The reason why charge was added.
-
billableIndicatorGid: string
indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
-
completionState: string
Indicates completion state of this special service.
-
domainName: string
Database domain where this data is stored.
-
isPlannedDurationFixed: boolean
If Y, prevents the system from overwriting the planned duration for the special service.
-
isSystemGenerated: boolean
Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
-
links: array
links
Read Only:
true
-
payableIndicatorGid: string
Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
-
plannedDuration:
plannedDuration
The planned duration of the special service.
-
processAsFlowThru: boolean
The override for record to be copied to the sell side during rating.
-
refs:
refs
-
remarks:
remarks
-
secondaryCharges:
secondaryCharges
-
shipmentSpecialServiceSeq: number
(int64)
The sequence to keep shipment special services unique.
-
specialServiceGid: string
The special service associated with the remark.
-
stopNum: number
(int32)
If the special service is for a particular stop, this indicates the stop number.
Nested Schema : actualOccurTime
The actual date and time special service occurred.
Match All
Show Source
Nested Schema : actualVolume
The actual volume of the goods applicable to this special service.
Match All
Show Source
Nested Schema : actualWeight
The actual weight of the goods applicable to this special service.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : secondaryCharges
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.specialServices.refs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID for the shipment special service.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The shipment cost qualifier associated to the cost reference.
Nested Schema : shipments.specialServices.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, or type.
-
remarkSequence: number
(int64)
The one-up number to make the remark unique.
-
remarkText: string
The remark text itself.
Nested Schema : shipments.specialServices.secondaryCharges
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
secondaryChargeShipmentGid: string
The secondary charge shipment identifier that contains the cost elements and information for the charges.
Nested Schema : shipments.sShipUnits
Type:
Show Source
object
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
domainName: string
Database domain where this data is stored.
-
earlyPickupDate:
earlyPickupDate
The early pickup date defined for the ship unit
-
flexCommodityCode: string
The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
-
flexCommodityQualGid: string
A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
-
isAllowRepack: boolean
If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
-
isCountSplittable: boolean
Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
-
isFixedEruCount: boolean
Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
-
isSplitable: boolean
A true or false value to define whether the ship unit can be split when creating the shipments.
-
links: array
links
Read Only:
true
-
priority: number
(int32)
Defines the priority associated with ship unit.
-
rangeEnd: number
(int32)
The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
rangeStart: number
(int32)
The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
-
receivedNetVolume:
receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedNetWeight:
receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedShipUnitCount: number
(double)
The received item package count. It can be entered as a stop debrief.
-
receivedVolume:
receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
receivedWeight:
receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
-
releaseMethodGid: string
The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
-
shipUnitCount: number
(int64)
Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
-
shipUnitGid: string
The GID for the order release ship unit that is associated to this shipment ship unit.
-
sShipUnitGid: string
The GID for the ship unit associated to a shipment.
-
sShipUnitXid: string
The XID for the ship unit associated to a shipment.
-
tag1: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag2: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag3: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
tag4: string
A flexible field to contain informational data that has been copied from the order to the shipment.
-
totalGrossVolume:
totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
-
totalGrossWeight:
totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
-
totalLoadingSplitVolume:
totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
-
totalLoadingSplitWeight:
totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
tShipUnitGid: string
A GID for the order release ship unit.
-
unitDiameter:
unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
-
unitHeight:
unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
unitLength:
unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
unitNetVolume:
unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
-
unitNetWeight:
unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
-
unitVolume:
unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
-
unitWeight:
unitWeight
The weight of the ship unit.
-
unitWidth:
unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : earlyPickupDate
The early pickup date defined for the ship unit
Match All
Show Source
Nested Schema : receivedNetVolume
The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedNetWeight
The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedVolume
The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : receivedWeight
The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
Match All
Show Source
Nested Schema : totalGrossVolume
The total gross volume of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalGrossWeight
The total gross weight of the shipment ship unit (transport handling unit + lines).
Match All
Show Source
Nested Schema : totalLoadingSplitVolume
Defines the total loading split volume if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : totalLoadingSplitWeight
Defines the total loading split weight if the ship unit can be split to load into the equipment.
Match All
Show Source
Nested Schema : unitDiameter
For cylindrical objects, this defines the diameter of the ship unit.
Match All
Show Source
Nested Schema : unitHeight
The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : unitLength
The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : unitNetVolume
The unit net volume of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitNetWeight
The unit net weight of the goods contained in the shipment ship unit.
Match All
Show Source
Nested Schema : unitVolume
The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
Match All
Show Source
Nested Schema : unitWidth
The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.
Match All
Show Source
Nested Schema : shipments.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type GID for the status value on the shipment.
-
statusValueGid: string
The status value for the shipment status.
Nested Schema : shipments.stops
Type:
Show Source
object
-
accessorialTime:
accessorialTime
The sum of the fixed accessorial time for a particular stop.
-
activityTime:
activityTime
The time spent at the stop for pickup or delivery.
-
actualArrival:
actualArrival
A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
-
actualDeparture:
actualDeparture
The actual departure date and time at the stop.
-
appointmentDelivery:
appointmentDelivery
A Y/N indicator defining if the stop requires a delivery appointment.
-
appointmentDuration:
appointmentDuration
The total appointment duration at the stop.
-
appointmentPickup:
appointmentPickup
A Y/N indicator defining if the stop requires a pickup appointment.
-
appointmentWindowEnd:
appointmentWindowEnd
The appointment window end.
-
appointmentWindowStart:
appointmentWindowStart
The appointment window start.
-
arbitraryType: string
SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.
-
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)
-
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
-
debriefs:
debriefs
-
details:
details
-
distanceType: string
Read Only:
true
L - Loaded, B- Bobtail, D - Deadhead -
distFromPrevStop:
distFromPrevStop
The distance from the last stop.
-
domainName: string
Database domain where this data is stored.
-
driverNonPayable: boolean
Allows the user to specify that stop is payable or not.
-
driveTime:
driveTime
The drive time to the stop from the last stop.
-
estimatedArrival:
estimatedArrival
The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.
-
estimatedDeparture:
estimatedDeparture
The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.
-
externalVoyageCode: string
Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.
-
extSeqNo: number
(int32)
The external sequence number for the stop.
-
flightInstanceId: number
(int64)
Read Only:
true
The flight instance GID. -
fwdLengthOog:
fwdLengthOog
Read Only:
true
The forward length-wise out of gauge. -
involvedParties:
involvedParties
-
isDepot: boolean
A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.
-
isFixedArrival: boolean
A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
-
isFixedDeparture: boolean
A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.
-
isFixedDistance: boolean
When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.
-
isMotherVessel: boolean
Designates a leg as mother vessel to automatically populated header.
-
isPermanent: boolean
A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.
-
leftWidthOog:
leftWidthOog
Read Only:
true
The left width-wise out of gauge. -
links: array
links
Read Only:
true
-
locationGid: string
The location GID for the shipment stop.
-
locationOverrideGid: string
The location GID defining the location to be used to override the actual location on the stop record.
-
locationRoleGid: string
The location role GID for the shipment stop (such as port, cross dock, etc.).
-
parentLocationGid: string
If an operational location, such as terminal at a port, is chosen for this stop, the location GID will be copied to this field and the location GID field will contain the operational location.
-
plannedArrival:
plannedArrival
The planned date and time of arrival at the stop.
-
plannedDeparture:
plannedDeparture
The planned departure date and time at the stop.
-
predictedArrival:
predictedArrival
Read Only:
true
Denotes the predicted arrival time at the stop. -
predictedArrivalHigh:
predictedArrivalHigh
Read Only:
true
Denotes the predicted arrival time high value at the stop. -
predictedArrivalLow:
predictedArrivalLow
Read Only:
true
Denotes the predicted arrival time low value at the stop. -
rateDistanceGid: string
The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case.
-
rateServiceGid: string
The rate service GID set if the stop times were calculated using the rate service engine.
-
rearLengthOog:
rearLengthOog
Read Only:
true
The rear length-wise out of gauge. -
refnums:
refnums
-
remarks:
remarks
-
repetitionSchedStopNumber: number
(int32)
Read Only:
true
The repetition schedule stop GID if the stop times were calculated from a repetition schedule. -
repetitionScheduleGid: string
Read Only:
true
The repetition schedule GID if the stop times were calculated from a repetition schedule. -
restTime:
restTime
The time the truck or the transportation mode should take for rest at the stop.
-
rightWidthOog:
rightWidthOog
Read Only:
true
The right width-wise out of gauge. -
routeCodeGid: string
The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case.
-
runningHeight:
runningHeight
Read Only:
true
The running total height from current stop to next stop. -
runningLength:
runningLength
Read Only:
true
The running total length from current stop to next stop. -
runningWeight:
runningWeight
Read Only:
true
The running total weight from current stop to next stop. -
runningWidth:
runningWidth
Read Only:
true
The running total width from current stop to next stop. -
rushHourTime:
rushHourTime
The amount of time that the drive time defined on the stop in inside the rush hour window.
-
slackVariance: number
(double)
Read Only:
true
The slack variance. -
stopNum: 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. This attribute is marked as Create-Only.
-
stopRequirementType: string
Used only for trips.
-
stopType: string
Define the type of this stop.
-
voyageGid: string
Read Only:
true
The voyage GID. -
waitTime:
waitTime
The time the truck or the transportation mode has to wait at the stop.
Nested Schema : accessorialTime
The sum of the fixed accessorial time for a particular stop.
Match All
Show Source
Nested Schema : activityTime
The time spent at the stop for pickup or delivery.
Match All
Show Source
Nested Schema : actualArrival
A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
Match All
Show Source
Nested Schema : actualDeparture
The actual departure date and time at the stop.
Match All
Show Source
Nested Schema : appointmentDelivery
A Y/N indicator defining if the stop requires a delivery appointment.
Match All
Show Source
Nested Schema : appointmentDuration
The total appointment duration at the stop.
Match All
Show Source
Nested Schema : appointmentPickup
A Y/N indicator defining if the stop requires a pickup appointment.
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 : debriefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : estimatedArrival
The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.
Match All
Show Source
Nested Schema : estimatedDeparture
The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.
Match All
Show Source
Nested Schema : fwdLengthOog
Read Only:
true
The forward length-wise out of gauge.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : leftWidthOog
Read Only:
true
The left width-wise out of gauge.
Match All
Show Source
Nested Schema : plannedArrival
The planned date and time of arrival at the stop.
Match All
Show Source
Nested Schema : plannedDeparture
The planned departure date and time at the stop.
Match All
Show Source
Nested Schema : predictedArrival
Read Only:
true
Denotes the predicted arrival time at the stop.
Match All
Show Source
Nested Schema : predictedArrivalHigh
Read Only:
true
Denotes the predicted arrival time high value at the stop.
Match All
Show Source
Nested Schema : predictedArrivalLow
Read Only:
true
Denotes the predicted arrival time low value at the stop.
Match All
Show Source
Nested Schema : rearLengthOog
Read Only:
true
The rear length-wise out of gauge.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : restTime
The time the truck or the transportation mode should take for rest at the stop.
Match All
Show Source
Nested Schema : rightWidthOog
Read Only:
true
The right width-wise out of gauge.
Match All
Show Source
Nested Schema : runningHeight
Read Only:
true
The running total height from current stop to next stop.
Match All
Show Source
Nested Schema : runningLength
Read Only:
true
The running total length from current stop to next stop.
Match All
Show Source
Nested Schema : runningWeight
Read Only:
true
The running total weight from current stop to next stop.
Match All
Show Source
Nested Schema : runningWidth
Read Only:
true
The running total width from current stop to next stop.
Match All
Show Source
Nested Schema : rushHourTime
The amount of time that the drive time defined on the stop in inside the rush hour window.
Match All
Show Source
Nested Schema : waitTime
The time the truck or the transportation mode has to wait at the stop.
Match All
Show Source
Nested Schema : shipments.stops.debriefs
Type:
Show Source
object
-
activity: string
Specifies the activity (pickup, drop off) for the stop and the debrief values.
-
domainName: string
Database domain where this data is stored.
-
itemGid: string
The item GID for the stop debrief.
-
itemPackageCount: number
(int64)
The count of the package item count.
-
links: array
links
Read Only:
true
-
matchType: string
The match type code for linking the stop debrief data.
-
nonConfReasonCodeGid: string
The non conformance reason code GID associated with the stop debrief recording.
-
orderReleaseLineGid: string
The order release line GID linked to the stop debrief.
-
packagingUnitCount: number
(int64)
The packaging unit count for the packing unit contained in the packaged item.
-
packagingUnitGid: string
The packaging unit GID for the packaging unit count that is contained in the packaged item.
-
sequenceNo: string
The sequence number (key).
-
sEquipmentGid: string
The equipment GID linked to the stop debrief.
-
shipUnitGid: string
The ship unit GID linked to the stop debrief.
-
sShipUnitGid: string
The GID for ship unit for the shipment.
-
sShipUnitLineNo: number
(int64)
The GID for ship unit line number for the shipment.
-
transportHandlingUnitCount: number
(int64)
The transport handling count GID for the stop debrief.
-
transportHandlingUnitGid: string
The transport handling unit GID associated with the transport handling unit.
Nested Schema : shipments.stops.details
Type:
Show Source
object
-
activity: string
The activity performed at the stop. For example: pickup, delivery, etc.
-
activityTime:
activityTime
The time spent performing the activity at the shipment stop.
-
domainName: string
Date and time of the most recent data update.
-
involvedParties:
involvedParties
-
isPermanent: boolean
A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.
-
links: array
links
Read Only:
true
-
shipUnitDwellTime:
shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
-
sShipUnitGid: string
A GID to define the shipment ship unit.
Nested Schema : activityTime
The time spent performing the activity at the shipment stop.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipUnitDwellTime
The ship unit dwell time at the stop location as entered.
Match All
Show Source
Nested Schema : shipments.stops.details.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method ID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact ID for the involved party.
-
involvedPartyQualGid: string
The qualifier ID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : shipments.stops.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact ID for the involved party.
-
involvedPartyQualGid: string
The qualifier ID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : shipments.stops.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentStopRefnumQualGid: string
The shipment reference qualifier GID defining the reference type.
-
shipmentStopRefnumValue: string
The shipment stop reference value.
Nested Schema : shipments.stops.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
-
remarkSequence: number
(int64)
The sequence (key) for the remark.
-
remarkText: string
User entered remark.
Nested Schema : shipments.tenders
Type:
Show Source
object
-
deliveryTime:
deliveryTime
No description.
-
destinationLocation: string
A unique identifier to define the locations withing GC3. The gid contains the domain portion.
-
domainName: string
No description.
-
expectedResponse:
expectedResponse
No description.
-
expectedRespUpdated: boolean
Determines whether the expected response for the tender is updated.
-
isStepTender: string
No description.
-
isTenderCount: boolean
No description.
-
iTransactionNo: number
(int64)
No description.
-
links: array
links
Read Only:
true
-
marketCost:
marketCost
Market cost based on the shipment.
-
originalPickupTime:
originalPickupTime
No description.
-
originLocation: string
A unique identifier to define the locations withing GC3. The gid contains the domain portion.
-
plannedCost:
plannedCost
Copied planning cost from shipment.
-
processControlRequestId: number
(int64)
No description.
-
rateGeoGid: string
References the rate record that that is associated with the tender.
-
shipmentTime:
shipmentTime
No description.
-
stepResponseTime:
stepResponseTime
No description.
-
stepResponseTimeBase: number
(int64)
No description.
-
stepResponseTimeUomCode: string
No description.
-
stepTenderPcrId: number
(int64)
No description.
-
tenderType: string
Defines the type of tender. Values are 'Ordinary', 'Broadcast Tender', and 'Spot Bid'
Nested Schema : shipments.texts
Type:
Show Source
object
-
documentDefGid: string
A document that should hold text.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document.
-
textTemplateGid: string
The foreign key to the text template table, in order to include fixed text with this shipment.
Nested Schema : shipments.trackingEvents
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
eventLocationGid: string
The location identifier of an location based event. This will be null for non-location based events.
-
isHidden: boolean
A Y/N indicator to display the status history.
-
iTransactionNo: number
(int64)
The transaction identifier for the shipment data of the tracking event.
-
links: array
links
Read Only:
true
-
partitionKey: number
(double)
The monthly range partition to manage purging status messages.
-
reportingGluser: string
The reporting application user if the tracking event was entered via the system's tracking event UI.
-
reportingMethod: string
The reporting method that links into the communication methods defined for OTM.
-
servprovGid: string
The service provider associated with generating the tracking event.
-
shipmentStopNum: number
(int32)
The shipment stop number for a stop based event.