Jump to

• Request
• Response

Get a Shipment

get

/shipments/{shipmentGid}

Request

Path Parameters

• shipmentGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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.

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

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCo2Emission

Actual CO2 emissions for the shipment.

Match All

Show Source

• object amountType

{
    "description":"Actual CO2 emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualCo2EqEmission

Actual CO2 equivalent emissions for the shipment.

Match All

Show Source

• object amountType

{
    "description":"Actual CO2 equivalent emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : aheadLateTime

shipment status

Match All

Show Source

• object amountType

{
    "description":"shipment status",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsCutoffDate

The container freight station cutoff date associated with the shipment.

Match All

Show Source

• object dateTimeType

{
    "description":"The container freight station cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : chargeableVolume

Read Only: true

The actual volume used in calculating the cost of the shipment.

Match All

Show Source

• object amountType

{
    "description":"The actual volume used in calculating the cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : chargeableWeight

Read Only: true

The dimensional weight as determined by the rating process.

Match All

Show Source

• object amountType

{
    "description":"The dimensional weight as determined by the rating process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : cmCost

The shipment cost when the shipment is part of a continuous move tour.

Match All

Show Source

• object currencyType

{
    "description":"The shipment cost when the shipment is part of a continuous move tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : cmEmptyDistance

The empty leg distance between previous and this shipments.

Match All

Show Source

• object amountType

{
    "description":"The empty leg distance between previous and this shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : containerGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.containerGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dimVolume

Read Only: true

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Match All

Show Source

• object amountType

{
    "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

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

• object amountType

{
    "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : earliestStartTime

The earliest start time that will make this shipment feasible.

Match All

Show Source

• object dateTimeType

{
    "description":"The earliest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

• object dateTimeType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : etaDate

Estimated time of arrival

Match All

Show Source

• object dateTimeType

{
    "description":"Estimated time of arrival",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : informationalCosts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.informationalCosts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : insuranceAmount

The insurance amount of the shipment.

Match All

Show Source

• object currencyType

{
    "description":"The insurance amount of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : insurancePremium

The insurance premium of the shipment, for informational purposes.

Match All

Show Source

• object currencyType

{
    "description":"The insurance premium of the shipment, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : latestStartTime

The latest start time that will make this shipment feasible.

Match All

Show Source

• object dateTimeType

{
    "description":"The latest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : loadedDistance

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Match All

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : orderReleases

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.orderReleases"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object currencyType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : plannedCo2Emission

CO2 emissions recorded while planning the shipment.

Match All

Show Source

• object amountType

{
    "description":"CO2 emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2EqEmission

CO2 equivalent emissions recorded while planning the shipment.

Match All

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCost

The cost when the original shipment was created. This attribute is marked as Create-Only.

Match All

Show Source

• object currencyType

{
    "description":"The cost when the original shipment was created. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : portDischargeEta

The estimated port of discharge date associated with ocean-going shipments.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated port of discharge date associated with ocean-going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portOfExitDate

The estimated port of exit (for international shipments) associated with ocean going shipments.

Match All

Show Source

• object dateTimeType

{
    "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : prevSightingDate

Read Only: true

The date associated with the previous sighting location and in the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The date associated with the previous sighting location and in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : railDate

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Match All

Show Source

• object dateTimeType

{
    "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateTimeType

{
    "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Match All

Show Source

• object dateTimeType

{
    "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sEquipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.sEquipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : siCutoffDate

The shippers instruction cutoff date associated with the shipment.

Match All

Show Source

• object dateTimeType

{
    "description":"The shippers instruction cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingDate

Read Only: true

The date and time when the shipment was last sighted at the sighting location.

Match All

Show Source

• object dateTimeType

{
    "description":"The date and time when the shipment was last sighted at the sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sShipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.sShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateTimeType

{
    "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stops

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tariffDate

The tariff date, for informational purposes.

Match All

Show Source

• object dateType

{
    "description":"The tariff date, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : tenders

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.tenders"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalActualCost

The total actual cost of the shipment. This attribute is marked as Create-Only.

Match All

Show Source

• object currencyType

{
    "description":"The total actual cost of the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object currencyType

{
    "description":"The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object currencyType

{
    "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object amountType

{
    "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object currencyType

{
    "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalVolume

The total volume of the shipment.

Match All

Show Source

• object amountType

{
    "description":"The total volume of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

The total weight of the shipment.

Match All

Show Source

• object amountType

{
    "description":"The total weight of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object currencyType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object currencyType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : unloadedDistance

The total distance that the truck or the transportation mode will travel when empty.

Match All

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : waybillDate

Waybill date represents contractual agreement of the carriage.

Match All

Show Source

• object dateTimeType

{
    "description":"Waybill date represents contractual agreement of the carriage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.accessorials

Type: object

Show Source

• 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

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why the accessorial was added.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.accessorials.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.accessorials.costRefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.accessorials.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.accessorials.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.accessorials.costRefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.accessorials.costRefs

Type: object

Show Source

• 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.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier GID that defines the type of cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.accessorials.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.accessorials.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.accessorials.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up sequence for the remark, to create a unique identifier.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, which identifies the type of remark this is.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark itself.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.allocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.allocations

Type: object

Show Source

• 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.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"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.",
            "type":"string"
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group.",
            "type":"string"
        },
        "orderAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.allocations.orderAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.allocations.orderLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderBaseLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.allocations.orderBaseLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

No description.

Match All

Show Source

• object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : orderAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.allocations.orderAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderBaseLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.allocations.orderBaseLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.allocations.orderLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : timestamp

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.allocations.orderAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.allocations.orderAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.allocations.orderAllocations

Type: object

Show Source

• 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

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseGid":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release record.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "lineitemSeqNo":{
            "description":"Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill",
            "type":"number",
            "format":"int32"
        },
        "invoiceGid":{
            "description":"Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill",
            "type":"string"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based on  shipment ",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

No description.

Match All

Show Source

• object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.allocations.orderBaseLineAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.allocations.orderBaseLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.allocations.orderBaseLineAllocations

Type: object

Show Source

• 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.

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "obLineGid":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "voucherGid":{
            "description":"No description.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

No description.

Match All

Show Source

• object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.allocations.orderLineAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.allocations.orderLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.allocations.orderLineAllocations

Type: object

Show Source

• 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

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release line record.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based Shipment.",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher or invoice",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

No description.

Match All

Show Source

• object dateType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.containerGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.containerGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.containerGroups

Type: object

Show Source

• 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.

{
    "properties":{
        "containerGroupGid":{
            "description":"The GID for the container group.",
            "type":"string"
        },
        "containerGroupXid":{
            "description":"The XID for the container group.",
            "type":"string"
        },
        "unitizationRequestType":{
            "description":"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.",
            "type":"string"
        },
        "containerReleaseNumber":{
            "description":"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.",
            "type":"string"
        },
        "stuffLocationGid":{
            "description":"The location where the contents will be loaded (stuffed) into the container.",
            "type":"string"
        },
        "destuffLocationGid":{
            "description":"The location where the contents will be unloaded (destuffed) from the container.",
            "type":"string"
        },
        "referenceCode":{
            "description":"This field is populated with the reference code that was entered on the unitization rule that was used to create this container.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.containerGroups.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.containerGroups.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.containerGroups.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.containerGroups.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.containerGroups.details

Type: object

Show Source

• 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.

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the equipment instance on a shipment for this container group.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.costs

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.costs

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentCostSeqno":{
            "description":"A system-generated unique sequence number to define the shipment costs. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"C, A, B",
            "type":"string"
        },
        "cost":{
            "description":"The cost as it relegates to the cost type for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code GID associated with the shipment cost.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost GID associated with the shipment cost.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"Indicates the billable status of this shipment cost (sell shipment only).",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group GID associated with the shipment cost.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence identifier associated with the shipment cost.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service GID associated with the shipment cost.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"Indicates shipment cost is a fixed cost.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"The override for a record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why this cost was added.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The GL code for the shipment cost record.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code for the shipment cost.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"The date to be used for any currency conversions; if null, the latest conversion is used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"The set of exchange rates to use for currency conversions; if null, the default set is used.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"Points to the ship unit (if any) associated with this shipment cost, as a package.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"Points to the ship unit line (if any) associated with this shipment cost, as a package.",
            "type":"number",
            "format":"int64"
        },
        "isWeighted":{
            "description":"Whether or not the cost affects the total weighted cost of the shipment only.",
            "type":"boolean",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costCategoryGid":{
            "description":"The Cost Category Identifier associated with the Shipment Cost",
            "type":"string",
            "readOnly":true
        },
        "trackingNumber":{
            "description":"Denotes the tracking number associated with a specific charge/cost.",
            "type":"string"
        },
        "costIdentifier":{
            "description":"It will be used to identify or describe a cost.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150) ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.costs.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.costs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.costs.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

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

Match All

Show Source

• object currencyType

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

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.costs.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

The date to be used for any currency conversions; if null, the latest conversion is used.

Match All

Show Source

• object dateType

{
    "description":"The date to be used for any currency conversions; if null, the latest conversion is used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : refs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.costs.refs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.costs.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.costs.details

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.costs.details

Type: object

Show Source

• 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

{
    "properties":{
        "detailSeqno":{
            "description":"A one-up number to make the cost detail record unique.",
            "type":"number",
            "format":"int64"
        },
        "detail":{
            "description":"The textual description of the cost detail as calculated and applied by the rating engine.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.costs.refs

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.costs.refs

Type: object

Show Source

• 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.

{
    "properties":{
        "seqno":{
            "description":"A system-generated unique sequence number.",
            "type":"number",
            "format":"int64"
        },
        "costReferenceGid":{
            "description":"The cost reference GID.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"A GID for the various cost qualifiers like: item, order base, order release, order release line, etc.",
            "type":"string"
        },
        "isPickup":{
            "description":"True or false value to specify if the cost is a pickup cost.",
            "type":"boolean"
        },
        "isDropoff":{
            "description":"True or false value to specify if the cost is a dropoff cost.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.costs.remarks

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.costs.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make this remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.documents

Type: object

Show Source

• 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
  Represents the related document for consolidated/linked documents.
• 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.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.informationalCosts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.informationalCosts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.informationalCosts

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentInfCostSeqno":{
            "description":"The shipment informational cost sequence number.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "detail":{
            "description":"Generated text that details the calculation of the cost.",
            "type":"string"
        },
        "infCostType":{
            "description":"Type of informational cost.  O = Original, D = Display",
            "type":"string"
        },
        "shipmentInfCostQualGid":{
            "description":"The shipment informational cost qualifier GID for this cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.informationalCosts.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.informationalCosts.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost amount.

Match All

Show Source

• object currencyType

{
    "description":"The cost amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.informationalCosts.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.informationalCosts.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.informationalCosts.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.informationalCosts.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.informationalCosts.details

Type: object

Show Source

• 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.

{
    "properties":{
        "detailSeqno":{
            "description":"The detail sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"The cost type for this shipment cost record.",
            "type":"string"
        },
        "cost":{
            "description":"The cost value. Examples are base and accessorial.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group identifier that was used in calculating this cost value.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence that was used in calculating this cost value.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier associated to the cost record if it was calculated from a special service.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"An adjustment reason code GID  that categorizes the cost element as an adjustment and the type.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The general ledger GID associated with the cost element and sent to financial systems.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost value. Examples are base and accessorial.

Match All

Show Source

• object currencyType

{
    "description":"The cost value. Examples are base and accessorial.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.informationalCosts.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.informationalCosts.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.informationalCosts.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSeq":{
            "description":"The remark sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.involvedParties

Type: object

Show Source

• 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

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The involved party qualifier identifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact for the qualifier listed on the shipment.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication ,method for the involved party listed on the shipment.",
            "type":"string"
        },
        "overrideLocationName":{
            "description":"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.",
            "type":"string"
        },
        "overrideCity":{
            "description":"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.",
            "type":"string"
        },
        "overrideProvince":{
            "description":"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",
            "type":"string"
        },
        "overrideProvinceCode":{
            "description":"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",
            "type":"string"
        },
        "overrideCountryCode3Gid":{
            "description":"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",
            "type":"string"
        },
        "overridePostalCode":{
            "description":"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",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "overrideAddresses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.involvedParties.overrideAddresses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : overrideAddresses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.involvedParties.overrideAddresses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.involvedParties.overrideAddresses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.involvedParties.overrideAddresses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.involvedParties.overrideAddresses

Type: object

Show Source

• 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.

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence (key) for the involved party on the shipment.",
            "type":"number",
            "format":"int64"
        },
        "overrideAddressLine":{
            "description":"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.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.orderReleases

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.orderReleases"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.orderReleases

Type: object

Show Source

• links: array links
  Read Only: true

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.refnums

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentRefnumQualGid":{
            "description":"The reference qualifier GID defining the reference  code.",
            "type":"string"
        },
        "shipmentRefnumValue":{
            "description":"The value associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence (key) associated with the shipment remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark on the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs

Type: object

Show Source

• 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

{
    "properties":{
        "documentDefGid":{
            "description":"The required document type for the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"The number of document revisions generated.",
            "type":"number",
            "format":"int32"
        },
        "reviewStatus":{
            "description":"The status of the review of the document.",
            "type":"string"
        },
        "instructions":{
            "description":"The instruction associated with handling of the document.",
            "type":"string"
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.reqdocs.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.reqdocs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "subscribers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.reqdocs.subscribers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.reqdocs.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "docs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.reqdocs.docs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : docs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs.docs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : reviewers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs.reviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : subscribers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs.subscribers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs.docs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs.docs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs.docs

Type: object

Show Source

• 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

{
    "properties":{
        "documentGid":{
            "description":"The document GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"The document revision count.",
            "type":"number",
            "format":"int32"
        },
        "review":{
            "description":"The document review state.",
            "type":"string"
        },
        "annotations":{
            "description":"The document revision annotations.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "reviews":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.reqdocs.docs.reviews"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : reviews

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.reqdocs.docs.reviews"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs.docs.reviews

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs.docs.reviews"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs.docs.reviews

Type: object

Show Source

• 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.

{
    "properties":{
        "contactGid":{
            "description":"The reviewer GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"The review state.",
            "type":"string"
        },
        "comments":{
            "description":"Comments added by the reviewer.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs.reviewers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs.reviewers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs.reviewers

Type: object

Show Source

• 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

{
    "properties":{
        "contactGid":{
            "description":"The reviewer.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The involved party qualifier for reviewer, if it is acting as a party on the shipment.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs.statuses

Type: object

Show Source

• 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.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs.subscribers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs.subscribers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs.subscribers

Type: object

Show Source

• 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

{
    "properties":{
        "contactGid":{
            "description":"The subscriber GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The involved party qualifier for subscriber, if it is acting as a party on the shipment.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.reqdocs.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.reqdocs.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.reqdocs.texts

Type: object

Show Source

• 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.

{
    "properties":{
        "textTemplateGid":{
            "description":"The text template ID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"If the text is associated with a ship unit or ship unit line, this holds the ship unit ID.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"If the text is associated with a ship unit line, this holds the ship unit line number.",
            "type":"number",
            "format":"int64"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.sEquipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.sEquipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.sEquipments

Type: object

Show Source

• 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.

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the equipment associated with the shipment.",
            "type":"string"
        },
        "capacityUsageGid":{
            "description":"The capacity usage GID that was used for the shipment.",
            "type":"string"
        },
        "pickupStopNum":{
            "description":"The stop number where the equipment is picked up.  It is null if not picked up in this shipment.",
            "type":"number",
            "format":"int32"
        },
        "dropoffStopNum":{
            "description":"The stop number where the equipment is dropped off. It is null if not dropped off in this shipment.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sEquipmentIndex":{
            "description":"The standing order of the equipment on the shipment.",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.specialServices

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentSpecialServiceSeq":{
            "description":"The sequence to keep shipment special services unique.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service associated with the remark.",
            "type":"string"
        },
        "stopNum":{
            "description":"If the special service is for a particular stop, this indicates the stop number.",
            "type":"number",
            "format":"int32"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why charge was added.",
            "type":"string"
        },
        "completionState":{
            "description":"Indicates completion state of this special service.",
            "type":"string"
        },
        "payableIndicatorGid":{
            "description":"Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"indicates the billable status of this special service; if values, overrides the billable status on the special service itself.",
            "type":"string"
        },
        "actualOccurTime":{
            "description":"The actual date and time special service occurred.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDuration":{
            "description":"The planned duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPlannedDurationFixed":{
            "description":"If Y, prevents the system from overwriting the planned duration for the special service.",
            "type":"boolean"
        },
        "actualDuration":{
            "description":"The actual duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualDistance":{
            "description":"The actual distance of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWeight":{
            "description":"The actual weight of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualVolume":{
            "description":"The actual volume of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualShipUnitCount":{
            "description":"The actual ship unit count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "actualItemPackageCount":{
            "description":"The actual package count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "isSystemGenerated":{
            "description":"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.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.specialServices.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "secondaryCharges":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.specialServices.secondaryCharges"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDistance

The actual distance of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual distance of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualDuration

The actual duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualOccurTime

The actual date and time special service occurred.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual date and time special service occurred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualVolume

The actual volume of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual volume of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWeight

The actual weight of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual weight of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : plannedDuration

The planned duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The planned duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.specialServices.refs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryCharges

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.specialServices.secondaryCharges"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.specialServices.refs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.specialServices.refs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.specialServices.refs

Type: object

Show Source

• 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.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID for the shipment special service.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier associated to the cost reference.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.specialServices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.specialServices.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.specialServices.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text itself.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.specialServices.secondaryCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.specialServices.secondaryCharges"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.specialServices.secondaryCharges

Type: object

Show Source

• 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.

{
    "properties":{
        "secondaryChargeShipmentGid":{
            "description":"The secondary charge shipment identifier that contains the cost elements and information for the charges.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.sShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.sShipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.sShipUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitGid":{
            "description":"The GID for the ship unit associated to a shipment.",
            "type":"string"
        },
        "sShipUnitXid":{
            "description":"The XID for the ship unit associated to a shipment.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.",
            "type":"string"
        },
        "unitLength":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWidth":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitHeight":{
            "description":"The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitVolume":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "isSplitable":{
            "description":"A true or false value to define whether the ship unit can be split when creating the shipments.",
            "type":"boolean"
        },
        "shipUnitCount":{
            "description":"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.",
            "type":"number",
            "format":"int64"
        },
        "earlyPickupDate":{
            "description":"The early pickup date defined for the ship unit",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "receivedWeight":{
            "description":"The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedShipUnitCount":{
            "description":"The received item package count. It can be entered as a stop debrief.",
            "type":"number",
            "format":"double"
        },
        "shipUnitGid":{
            "description":"The GID for the order release ship unit that is associated to this shipment ship unit.",
            "type":"string"
        },
        "unitNetWeight":{
            "description":"The unit net weight of the goods contained in the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitNetVolume":{
            "description":"The unit net volume of the goods contained in the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedNetWeight":{
            "description":"The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedNetVolume":{
            "description":"The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tag1":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag2":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag3":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag4":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tShipUnitGid":{
            "description":"A GID for the order release ship unit.",
            "type":"string"
        },
        "isCountSplittable":{
            "description":"Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.",
            "type":"boolean"
        },
        "totalGrossWeight":{
            "description":"The total gross weight of the shipment ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalGrossVolume":{
            "description":"The total gross volume of the shipment ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "rangeStart":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "rangeEnd":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "releaseMethodGid":{
            "description":"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.",
            "type":"string"
        },
        "isAllowRepack":{
            "description":"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. ",
            "type":"boolean"
        },
        "totalLoadingSplitWeight":{
            "description":"Defines the total loading split weight if the ship unit can be split to load into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalLoadingSplitVolume":{
            "description":"Defines the total loading split volume if the ship unit can be split to load into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "priority":{
            "description":"Defines the priority associated with ship unit.",
            "type":"number",
            "format":"int32"
        },
        "isFixedEruCount":{
            "description":"Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : earlyPickupDate

The early pickup date defined for the ship unit

Match All

Show Source

• object dateTimeType

{
    "description":"The early pickup date defined for the ship unit",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : 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

• object amountType

{
    "description":"The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalGrossVolume

The total gross volume of the shipment ship unit (transport handling unit + lines).

Match All

Show Source

• object amountType

{
    "description":"The total gross volume of the shipment ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalGrossWeight

The total gross weight of the shipment ship unit (transport handling unit + lines).

Match All

Show Source

• object amountType

{
    "description":"The total gross weight of the shipment ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"Defines the total loading split volume if the ship unit can be split to load into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"Defines the total loading split weight if the ship unit can be split to load into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitDiameter

For cylindrical objects, this defines the diameter of the ship unit.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetVolume

The unit net volume of the goods contained in the shipment ship unit.

Match All

Show Source

• object amountType

{
    "description":"The unit net volume of the goods contained in the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetWeight

The unit net weight of the goods contained in the shipment ship unit.

Match All

Show Source

• object amountType

{
    "description":"The unit net weight of the goods contained in the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitWeight

The weight of the ship unit.

Match All

Show Source

• object amountType

{
    "description":"The weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object amountType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.statuses

Type: object

Show Source

• 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.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the shipment.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the shipment status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops

Type: object

Show Source

• 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.

{
    "properties":{
        "stopNum":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The location GID for the shipment stop.",
            "type":"string"
        },
        "locationRoleGid":{
            "description":"The location role GID for the shipment stop (such as port, cross dock, etc.).",
            "type":"string"
        },
        "plannedArrival":{
            "description":"The planned date and time of arrival at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedArrival":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedArrival":{
            "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
            "type":"boolean"
        },
        "actualArrival":{
            "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDeparture":{
            "description":"The planned departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedDeparture":{
            "description":"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.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedDeparture":{
            "description":"A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.",
            "type":"boolean"
        },
        "actualDeparture":{
            "description":"The actual departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "waitTime":{
            "description":"The time the truck or the transportation mode has to wait at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "restTime":{
            "description":"The time the truck or the transportation mode should take for rest at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "driveTime":{
            "description":"The drive time to the stop from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "distFromPrevStop":{
            "description":"The distance from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "activityTime":{
            "description":"The time spent at the stop for pickup or delivery.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.",
            "type":"boolean"
        },
        "isDepot":{
            "description":"A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "appointmentPickup":{
            "description":"A Y/N indicator defining if the stop requires a pickup appointment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentDelivery":{
            "description":"A Y/N indicator defining if the stop requires a delivery appointment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "accessorialTime":{
            "description":"The sum of the fixed accessorial time for a particular stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "parentLocationGid":{
            "description":"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.",
            "type":"string"
        },
        "locationOverrideGid":{
            "description":"The location GID defining the location to be used to override the actual location on the stop record.",
            "type":"string"
        },
        "stopRequirementType":{
            "description":"Used only for trips.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"The rate service GID set if the stop times were calculated using the rate service engine.",
            "type":"string"
        },
        "arbitraryType":{
            "description":"SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.",
            "type":"boolean"
        },
        "extSeqNo":{
            "description":"The external sequence number for the stop.",
            "type":"number",
            "format":"int32"
        },
        "rushHourTime":{
            "description":"The amount of time that the drive time defined on the stop in inside the rush hour window.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "voyageGid":{
            "description":"The voyage GID.",
            "type":"string",
            "readOnly":true
        },
        "isMotherVessel":{
            "description":"Designates a leg as mother vessel to automatically populated header.",
            "type":"boolean"
        },
        "flightInstanceId":{
            "description":"The flight instance GID.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule GID if the stop times were calculated from a repetition schedule.",
            "type":"string",
            "readOnly":true
        },
        "stopType":{
            "description":"Define the type of this stop.",
            "type":"string"
        },
        "slackVariance":{
            "description":"The slack variance.",
            "type":"number",
            "format":"double",
            "readOnly":true
        },
        "driverNonPayable":{
            "description":"Allows the user to specify that stop is payable or not.",
            "type":"boolean"
        },
        "repetitionSchedStopNumber":{
            "description":"The repetition schedule stop GID if the stop times were calculated from a repetition schedule.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "distanceType":{
            "description":"L - Loaded, B- Bobtail, D - Deadhead",
            "type":"string",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentWindowStart":{
            "description":"The appointment window start.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentWindowEnd":{
            "description":"The appointment window end.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "rateDistanceGid":{
            "description":"The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case. ",
            "type":"string"
        },
        "routeCodeGid":{
            "description":"The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case. ",
            "type":"string"
        },
        "runningWeight":{
            "description":"The running total weight from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningLength":{
            "description":"The running total length from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningWidth":{
            "description":"The running total width from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningHeight":{
            "description":"The running total height from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "leftWidthOog":{
            "description":"The left width-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "rightWidthOog":{
            "description":"The right width-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "fwdLengthOog":{
            "description":"The forward length-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "rearLengthOog":{
            "description":"The rear length-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "predictedArrival":{
            "description":"Denotes the predicted arrival time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "predictedArrivalLow":{
            "description":"Denotes the predicted arrival time low value at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "predictedArrivalHigh":{
            "description":"Denotes the predicted arrival time high value at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.",
            "type":"string"
        },
        "appointmentDuration":{
            "description":"The total appointment duration at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "debriefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.debriefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorialTime

The sum of the fixed accessorial time for a particular stop.

Match All

Show Source

• object amountType

{
    "description":"The sum of the fixed accessorial time for a particular stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTime

The time spent at the stop for pickup or delivery.

Match All

Show Source

• object amountType

{
    "description":"The time spent at the stop for pickup or delivery.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object dateTimeType

{
    "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualDeparture

The actual departure date and time at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentDelivery

A Y/N indicator defining if the stop requires a delivery appointment.

Match All

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining if the stop requires a delivery appointment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentDuration

The total appointment duration at the stop.

Match All

Show Source

• object amountType

{
    "description":"The total appointment duration at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : appointmentPickup

A Y/N indicator defining if the stop requires a pickup appointment.

Match All

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining if the stop requires a pickup appointment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentWindowEnd

The appointment window end.

Match All

Show Source

• object dateTimeType

{
    "description":"The appointment window end.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentWindowStart

The appointment window start.

Match All

Show Source

• object dateTimeType

{
    "description":"The appointment window start.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : debriefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.debriefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distFromPrevStop

The distance from the last stop.

Match All

Show Source

• object amountType

{
    "description":"The distance from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : driveTime

The drive time to the stop from the last stop.

Match All

Show Source

• object amountType

{
    "description":"The drive time to the stop from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

• object dateTimeType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

• object dateTimeType

{
    "description":"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.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : fwdLengthOog

Read Only: true

The forward length-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The forward length-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : leftWidthOog

Read Only: true

The left width-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The left width-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : plannedArrival

The planned date and time of arrival at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The planned date and time of arrival at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : plannedDeparture

The planned departure date and time at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The planned departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : predictedArrival

Read Only: true

Denotes the predicted arrival time at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : predictedArrivalHigh

Read Only: true

Denotes the predicted arrival time high value at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time high value at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : predictedArrivalLow

Read Only: true

Denotes the predicted arrival time low value at the stop.

Match All

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time low value at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : rearLengthOog

Read Only: true

The rear length-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The rear length-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : restTime

The time the truck or the transportation mode should take for rest at the stop.

Match All

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode should take for rest at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : rightWidthOog

Read Only: true

The right width-wise out of gauge.

Match All

Show Source

• object amountType

{
    "description":"The right width-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningHeight

Read Only: true

The running total height from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total height from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningLength

Read Only: true

The running total length from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total length from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningWeight

Read Only: true

The running total weight from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total weight from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningWidth

Read Only: true

The running total width from current stop to next stop.

Match All

Show Source

• object amountType

{
    "description":"The running total width from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

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

• object amountType

{
    "description":"The amount of time that the drive time defined on the stop in inside the rush hour window.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : waitTime

The time the truck or the transportation mode has to wait at the stop.

Match All

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode has to wait at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.debriefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.debriefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops.debriefs

Type: object

Show Source

• 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.

{
    "properties":{
        "activity":{
            "description":"Specifies the activity (pickup, drop off) for the stop and the debrief values.",
            "type":"string"
        },
        "sequenceNo":{
            "description":"The sequence number (key).",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"The GID for ship unit for the shipment.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"The GID for ship unit line number for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "itemPackageCount":{
            "description":"The count of the package item count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The packaging unit GID for the packaging unit count that is contained in the packaged item.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the packing unit contained in the packaged item.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit GID associated with the transport handling unit.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"The transport handling count GID for the stop debrief.",
            "type":"number",
            "format":"int64"
        },
        "itemGid":{
            "description":"The item GID for the stop debrief.",
            "type":"string"
        },
        "nonConfReasonCodeGid":{
            "description":"The non conformance reason code GID associated with the stop debrief recording.",
            "type":"string"
        },
        "shipUnitGid":{
            "description":"The ship unit GID linked to the stop debrief.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The equipment GID linked to the stop debrief.",
            "type":"string"
        },
        "matchType":{
            "description":"The match type code for linking the stop debrief data.",
            "type":"string"
        },
        "orderReleaseLineGid":{
            "description":"The order release line GID linked to the stop debrief.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops.details

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitGid":{
            "description":"A GID to define the shipment ship unit.",
            "type":"string"
        },
        "activity":{
            "description":"The activity performed at the stop. For example: pickup, delivery, etc.",
            "type":"string"
        },
        "activityTime":{
            "description":"The time spent performing the activity at the shipment stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Date and time of the most recent data update.",
            "type":"string"
        },
        "shipUnitDwellTime":{
            "description":"The ship unit dwell time at the stop location as entered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The time spent performing the activity at the shipment stop.

Match All

Show Source

• object amountType

{
    "description":"The time spent performing the activity at the shipment stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipUnitDwellTime

The ship unit dwell time at the stop location as entered.

Match All

Show Source

• object amountType

{
    "description":"The ship unit dwell time at the stop location as entered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.details.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops.details.involvedParties

Type: object

Show Source

• 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

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops.involvedParties

Type: object

Show Source

• 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

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops.refnums

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentStopRefnumQualGid":{
            "description":"The shipment reference qualifier GID defining the reference type.",
            "type":"string"
        },
        "shipmentStopRefnumValue":{
            "description":"The shipment stop reference value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.stops.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.stops.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number,  service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.tenders

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.tenders"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.tenders

Type: object

Show Source

• 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'

{
    "properties":{
        "iTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "tenderType":{
            "description":"Defines the type of tender. Values are 'Ordinary', 'Broadcast Tender', and 'Spot Bid'",
            "type":"string"
        },
        "shipmentTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expectedResponse":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originLocation":{
            "description":"A unique identifier to define the locations withing GC3. The gid contains the domain portion.",
            "type":"string"
        },
        "destinationLocation":{
            "description":"A unique identifier to define the locations withing GC3. The gid contains the domain portion.",
            "type":"string"
        },
        "deliveryTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originalPickupTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isTenderCount":{
            "description":"No description.",
            "type":"boolean"
        },
        "rateGeoGid":{
            "description":"References the rate record that that is associated with the tender.",
            "type":"string"
        },
        "plannedCost":{
            "description":"Copied planning cost from shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "processControlRequestId":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "isStepTender":{
            "description":"No description.",
            "type":"string"
        },
        "stepResponseTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "stepResponseTimeUomCode":{
            "description":"No description.",
            "type":"string"
        },
        "stepResponseTimeBase":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "stepTenderPcrId":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "expectedRespUpdated":{
            "description":"Determines whether the expected response for the tender is updated.",
            "type":"boolean"
        },
        "marketCost":{
            "description":"Market cost based on the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : deliveryTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : expectedResponse

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originalPickupTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : plannedCost

Copied planning cost from shipment.

Match All

Show Source

• object currencyType

{
    "description":"Copied planning cost from shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipmentTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : stepResponseTime

No description.

Match All

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.texts

Type: object

Show Source

• 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.

{
    "properties":{
        "textTemplateGid":{
            "description":"The foreign key to the text template table, in order to include fixed text with this shipment.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"A document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.trackingEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : shipments.trackingEvents

Type: object

Show Source

• 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.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier for the shipment data of the tracking event.",
            "type":"number",
            "format":"int64"
        },
        "servprovGid":{
            "description":"The service provider associated with generating the tracking event.",
            "type":"string"
        },
        "reportingGluser":{
            "description":"The reporting application user if the tracking event was entered via the system's tracking event UI.",
            "type":"string"
        },
        "reportingMethod":{
            "description":"The reporting method that links into the communication methods defined for OTM.",
            "type":"string"
        },
        "shipmentStopNum":{
            "description":"The shipment stop number for a stop based event.",
            "type":"number",
            "format":"int32"
        },
        "eventLocationGid":{
            "description":"The location identifier of an location based event. This will be null for non-location based events.",
            "type":"string"
        },
        "isHidden":{
            "description":"A Y/N indicator to display the status history.",
            "type":"boolean"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Back to Top