Create a Ship Unit
post
/orderBases/{orderBaseGid}/shipUnits
Request
Path Parameters
-
orderBaseGid(required): string
Resource ID
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Nested Schema : schema
Type:
Show Source
object
-
accessorials:
accessorials
-
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
-
attributeDate2:
attributeDate2
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
-
attributeNumber2: 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
-
bufferLocationGid: string
The buffer location to identify if this order base ship unit is being modeled with a buffer location to hold inventory prior to final delivery.
-
contents:
contents
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
declaredValue:
declaredValue
The declared value of the total of the goods, ship unit content lines on the ship unit.
-
deliveryIsAppt: boolean
Indicates if the early/late delivery times are appointment times
-
destLocationGid: string
The destination location GID for the delivery location associated with this order base ship unit.
-
diameter:
diameter
The unit diameter of the ship unit.
-
domainName: string
Database domain where this data is stored.
-
earlyDeliveryDate:
earlyDeliveryDate
The earliest date when the item can be delivered.
-
earlyPickupDate:
earlyPickupDate
The earliest date when the item can be picked up.
-
equipmentRefUnits:
equipmentRefUnits
-
flexCommodityCode: string
The user defined commodity code for the item. E.g.. HTS, SITC, STCC, NMFC
-
flexCommodityQualGid: string
The user defined commodity qualifier identify the type of commodity classification being used, such as NMFC.
-
height:
height
The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
involvedParties:
involvedParties
-
isShippable: boolean
A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.
-
lateDeliveryDate:
lateDeliveryDate
The latest date when the item can be picked delivered.
-
latePickupDate:
latePickupDate
The latest date when the item can be picked up.
-
length:
length
The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
links: array
links
Read Only:
true
-
loadConfigSetupGid: string
A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.
-
loadingSplits:
loadingSplits
-
loadPoint: string
The specific loading location for the source location on the ship unit.
-
netVolume:
netVolume
The total net volume of the ship unit content lines on the ship unit.
-
netWeight:
netWeight
The total net weight of the ship unit content lines on the ship unit.
-
obShipUnitGid: string
The GID for the ship unit associated to an order base.
-
obShipUnitXid: string
The XID for the ship unit associated to a order base.
-
pickupIsAppt: boolean
Indicates if the early/late pickup times are appointment times
-
planFromLoadPoint: string
The specific loading location for the plan from location on the ship unit.
-
planFromLocationGid: string
The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
-
planToLocationGid: string
The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
-
planToUnloadPoint: string
The specific unloading location for the plan to location on the ship unit.
-
refnums:
refnums
-
releasedCount: number
(int64)
Read Only:
true
The number of ship units that have been processed onto order release through the releasing logic. -
releaseInstructions:
releaseInstructions
-
remarks:
remarks
-
seals:
seals
-
shipUnitCount: number
(int64)
The number of ship units this entry represents. Ship unit count of 1 to model discrete ship units and bulk orders. Greater than 1 to model multiple uniform ship units.
-
sourceLocationGid: string
The source location GID for the pickup location associated with this order base ship unit.
-
specialServices:
specialServices
-
splittableBy: string
Indicates how the resulting order release ship unit may be split across equipment.
-
statuses:
statuses
-
tag1: string
Additional information about the item. Like the color or size code, etc.
-
tag2: string
Additional information about the item. Like the color or size code, etc.
-
tag3: string
Additional information about the item. Like the color or size code, etc.
-
tag4: string
Additional information about the item. Like the color or size code, etc.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
unloadPoint: string
The specific unloading location for the delivery location on the ship unit.
-
volume:
volume
The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
-
weight:
weight
The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
-
width:
width
The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : contents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : declaredValue
The declared value of the total of the goods, ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be delivered.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be picked up.
Match All
Show Source
Nested Schema : equipmentRefUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : height
The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : lateDeliveryDate
The latest date when the item can be picked delivered.
Match All
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked up.
Match All
Show Source
Nested Schema : length
The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : loadingSplits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : netVolume
The total net volume of the ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : netWeight
The total net weight of the ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseInstructions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : volume
The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
Match All
Show Source
Nested Schema : weight
The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
Match All
Show Source
Nested Schema : width
The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.
Match All
Show Source
Nested Schema : orderBases.shipUnits.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code used to specify that this accessorial needs to be copied to the order release and covered when planning the shipment.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : orderBases.shipUnits.contents
Type:
Show Source
object
-
attributes:
attributes
-
countPerShipUnit: number
(int64)
The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.
-
declaredValue:
declaredValue
The declared value, commercial value of the ship unit line contents for sale of goods.
-
domainName: string
Database domain where this data is stored.
-
initialItemGid: string
The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field.
-
involvedParties:
involvedParties
-
links: array
links
Read Only:
true
-
packagedCount: number
(int64)
The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
-
packagedItemGid: string
The packaged item GID defining the content line for the ship unit.
-
packagingUnitCount: number
(int64)
The packaging unit count for the inner pack.
-
packagingUnitGid: string
The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.
-
refnums:
refnums
-
remarks:
remarks
-
sequenceNo: number
(int64)
The unique sequence within the ship unit to define the individual line items.
-
tag1: string
Additional information about the item. Like the color, size, code.
-
tag2: string
Additional information about the item. Like the color, size, code.
-
tag3: string
Additional information about the item. Like the color, size, code.
-
tag4: string
Additional information about the item. Like the color, size, code.
-
volume:
volume
The gross volume of the item.
-
volumePerShipUnit:
volumePerShipUnit
The volume per order base content line to handle shipping a multiple count number of ship units.
-
weight:
weight
The gross weight of the item.
-
weightPerShipUnit:
weightPerShipUnit
The weight per ship unit order base content line to handle shipping a multiple count number of ship units.
Nested Schema : attributes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : declaredValue
The declared value, commercial value of the ship unit line contents for sale of goods.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : volumePerShipUnit
The volume per order base content line to handle shipping a multiple count number of ship units.
Match All
Show Source
Nested Schema : weightPerShipUnit
The weight per ship unit order base content line to handle shipping a multiple count number of ship units.
Match All
Show Source
Nested Schema : orderBases.shipUnits.contents.attributes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
itemFeatureQualGid: string
The item feature qualifier GID defining what type of feature this value is associated with.
-
itemFeatureValue: string
The item feature value for the order base line. This allows for future structural definition of an item such as size and color.
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : orderBases.shipUnits.contents.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method ID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact GID for the involved party.
-
involvedPartyQualGid: string
The qualifier GID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : orderBases.shipUnits.contents.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obSuContentRefnumQualGid: string
The reference number qualifier GID defining the reference code.
-
obSuContentRefnumValue: string
The text associated to the reference code.
Nested Schema : orderBases.shipUnits.contents.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier GID defining the remark code.
-
remarkSequence: number
(int64)
The remark sequence identifier used for sequential ordering.
-
remarkText: string
The text associated to the remark code.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : orderBases.shipUnits.equipmentRefUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentReferenceUnitGid: string
The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.
-
links: array
links
Read Only:
true
-
numReferenceUnits: number
(double)
The number of equipment reference units this ship unit will consume when loading onto the equipment.
-
totalNumReferenceUnits: number
(double)
The total equipment reference units max consumption demand for this ship unit.
Nested Schema : orderBases.shipUnits.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method GID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact GID for the involved party.
-
involvedPartyQualGid: string
The qualifier GID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : orderBases.shipUnits.loadingSplits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
height:
height
The height for the this part of the ship unit split.
-
length:
length
The length for the this part of the ship unit split.
-
links: array
links
Read Only:
true
-
splitNo: number
(int32)
The split number for the ship unit.
-
volume:
volume
The volume for the this part of the ship unit split.
-
weight:
weight
The weight for the this part of the ship unit split.
-
width:
width
The width for the this part of the ship unit split.
Nested Schema : orderBases.shipUnits.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obShipUnitRefnumQualGid: string
The reference number qualifier identifier defining the reference code.
-
obShipUnitRefnumValue: string
The text associated to the reference number code.
Nested Schema : orderBases.shipUnits.releaseInstructions
Type:
Show Source
object
-
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
-
attributeDate2:
attributeDate2
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
-
attributeNumber2: 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
-
destLocationGid: string
The destination location GID for the delivery of the order base ship unit.
-
domainName: string
Database domain where this data is stored.
-
earlyDeliveryDate:
earlyDeliveryDate
The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
-
earlyPickupDate:
earlyPickupDate
The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
-
flaggedForDelete: boolean
A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.
-
height:
height
The height of the ship unit for the release instruction.
-
isAutoRelease: boolean
A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.
-
isProcessed: boolean
Read Only:
true
A Y/N indicator specifying that the release instruction was processed to create an order release ship unit. -
itemPackageCount: number
(int64)
The number of packaged items on this ship unit release instruction.
-
lateDeliveryDate:
lateDeliveryDate
The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
-
latePickupDate:
latePickupDate
The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
-
length:
length
The length of the ship unit for the release instruction.
-
links: array
links
Read Only:
true
-
masterOrderBaseGid: string
The master order base GID to be set on the order release created from the line. An order release can be created from multiple order bases and one of them is nominated as the master to get master level information for such as bill to party.
-
obSuReleaseInstrGid: string
The GID for the Release Instruction associated to the order base ship unit.
-
obSuReleaseInstrXid: string
The XID for the release instruction.
-
orderBaseGid: string
The order base GID for the release instruction.
-
refnums:
refnums
-
releaseDate:
releaseDate
The date the release instruction should be processed.
-
remarks:
remarks
-
sequenceNo: number
(int64)
The sequence number (key) associated with the release instruction.
-
shipUnitReleaseCount: number
(int64)
The ship unit release count specifying the amount to be processed with this release instruction.
-
shipWithGroup: string
The ship with group value that will be used when creating the order release from this release instruction.
-
sourceLocationGid: string
The source location GID for the pickup of the order base ship unit.
-
tag1: string
Additional information about the item. Like the color or code number.
-
tag2: string
Additional information about the item. Like the color or code number.
-
tag3: string
Additional information about the item. Like the color or code number.
-
tag4: string
Additional information about the item. Like the color or code number.
-
totalVolume:
totalVolume
The total volume of the ship units for this release instruction.
-
totalWeight:
totalWeight
The total weight of the ship units for this release instruction.
-
transportHandlingUnitGid: string
The transport handling unit GID to be applied to the order release ship unit created with this release instruction.
-
volume:
volume
The volume for the release instruction.
-
weight:
weight
The weight for the release instruction.
-
width:
width
The width of the ship unit for the release instruction.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : height
The height of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : lateDeliveryDate
The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : length
The length of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseDate
The date the release instruction should be processed.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : totalVolume
The total volume of the ship units for this release instruction.
Match All
Show Source
Nested Schema : totalWeight
The total weight of the ship units for this release instruction.
Match All
Show Source
Nested Schema : orderBases.shipUnits.releaseInstructions.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
orderReleaseRefnumQualGid: string
The reference number qualifier GID defining the reference code.
-
orderReleaseRefnumValue: string
The text associated to the reference code.
Nested Schema : orderBases.shipUnits.releaseInstructions.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier GID defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the order base ship unit release instruction.
-
remarkText: string
The text associated to the remark code.
Nested Schema : orderBases.shipUnits.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the order base ship unit.
-
remarkText: string
The text associated to the remark code.
Nested Schema : orderBases.shipUnits.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipUnitSeal: string
The transport handling unit seal number for the order base ship unit.
Nested Schema : orderBases.shipUnits.specialServices
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
specialServiceGid: string
The special service identifier defining the special service that needs to be performed for the ship unit.
Nested Schema : orderBases.shipUnits.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type GID for the status value on the order base.
-
statusValueGid: string
The status value for the order release base.
Root Schema : schema
Type:
Show Source
object
-
accessorials:
accessorials
-
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
-
attributeDate2:
attributeDate2
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
-
attributeNumber2: 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
-
bufferLocationGid: string
The buffer location to identify if this order base ship unit is being modeled with a buffer location to hold inventory prior to final delivery.
-
contents:
contents
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
declaredValue:
declaredValue
The declared value of the total of the goods, ship unit content lines on the ship unit.
-
deliveryIsAppt: boolean
Indicates if the early/late delivery times are appointment times
-
destLocationGid: string
The destination location GID for the delivery location associated with this order base ship unit.
-
diameter:
diameter
The unit diameter of the ship unit.
-
domainName: string
Database domain where this data is stored.
-
earlyDeliveryDate:
earlyDeliveryDate
The earliest date when the item can be delivered.
-
earlyPickupDate:
earlyPickupDate
The earliest date when the item can be picked up.
-
equipmentRefUnits:
equipmentRefUnits
-
flexCommodityCode: string
The user defined commodity code for the item. E.g.. HTS, SITC, STCC, NMFC
-
flexCommodityQualGid: string
The user defined commodity qualifier identify the type of commodity classification being used, such as NMFC.
-
height:
height
The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
involvedParties:
involvedParties
-
isShippable: boolean
A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.
-
lateDeliveryDate:
lateDeliveryDate
The latest date when the item can be picked delivered.
-
latePickupDate:
latePickupDate
The latest date when the item can be picked up.
-
length:
length
The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
links: array
links
Read Only:
true
-
loadConfigSetupGid: string
A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.
-
loadingSplits:
loadingSplits
-
loadPoint: string
The specific loading location for the source location on the ship unit.
-
netVolume:
netVolume
The total net volume of the ship unit content lines on the ship unit.
-
netWeight:
netWeight
The total net weight of the ship unit content lines on the ship unit.
-
obShipUnitGid: string
The GID for the ship unit associated to an order base.
-
obShipUnitXid: string
The XID for the ship unit associated to a order base.
-
pickupIsAppt: boolean
Indicates if the early/late pickup times are appointment times
-
planFromLoadPoint: string
The specific loading location for the plan from location on the ship unit.
-
planFromLocationGid: string
The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
-
planToLocationGid: string
The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
-
planToUnloadPoint: string
The specific unloading location for the plan to location on the ship unit.
-
refnums:
refnums
-
releasedCount: number
(int64)
Read Only:
true
The number of ship units that have been processed onto order release through the releasing logic. -
releaseInstructions:
releaseInstructions
-
remarks:
remarks
-
seals:
seals
-
shipUnitCount: number
(int64)
The number of ship units this entry represents. Ship unit count of 1 to model discrete ship units and bulk orders. Greater than 1 to model multiple uniform ship units.
-
sourceLocationGid: string
The source location GID for the pickup location associated with this order base ship unit.
-
specialServices:
specialServices
-
splittableBy: string
Indicates how the resulting order release ship unit may be split across equipment.
-
statuses:
statuses
-
tag1: string
Additional information about the item. Like the color or size code, etc.
-
tag2: string
Additional information about the item. Like the color or size code, etc.
-
tag3: string
Additional information about the item. Like the color or size code, etc.
-
tag4: string
Additional information about the item. Like the color or size code, etc.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
unloadPoint: string
The specific unloading location for the delivery location on the ship unit.
-
volume:
volume
The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
-
weight:
weight
The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
-
width:
width
The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : contents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : declaredValue
The declared value of the total of the goods, ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be delivered.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be picked up.
Match All
Show Source
Nested Schema : equipmentRefUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : height
The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : lateDeliveryDate
The latest date when the item can be picked delivered.
Match All
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked up.
Match All
Show Source
Nested Schema : length
The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : loadingSplits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : netVolume
The total net volume of the ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : netWeight
The total net weight of the ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseInstructions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : volume
The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
Match All
Show Source
Nested Schema : weight
The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
Match All
Show Source
Nested Schema : width
The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.
Match All
Show Source
Nested Schema : orderBases.shipUnits.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code used to specify that this accessorial needs to be copied to the order release and covered when planning the shipment.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : orderBases.shipUnits.contents
Type:
Show Source
object
-
attributes:
attributes
-
countPerShipUnit: number
(int64)
The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.
-
declaredValue:
declaredValue
The declared value, commercial value of the ship unit line contents for sale of goods.
-
domainName: string
Database domain where this data is stored.
-
initialItemGid: string
The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field.
-
involvedParties:
involvedParties
-
links: array
links
Read Only:
true
-
packagedCount: number
(int64)
The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
-
packagedItemGid: string
The packaged item GID defining the content line for the ship unit.
-
packagingUnitCount: number
(int64)
The packaging unit count for the inner pack.
-
packagingUnitGid: string
The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.
-
refnums:
refnums
-
remarks:
remarks
-
sequenceNo: number
(int64)
The unique sequence within the ship unit to define the individual line items.
-
tag1: string
Additional information about the item. Like the color, size, code.
-
tag2: string
Additional information about the item. Like the color, size, code.
-
tag3: string
Additional information about the item. Like the color, size, code.
-
tag4: string
Additional information about the item. Like the color, size, code.
-
volume:
volume
The gross volume of the item.
-
volumePerShipUnit:
volumePerShipUnit
The volume per order base content line to handle shipping a multiple count number of ship units.
-
weight:
weight
The gross weight of the item.
-
weightPerShipUnit:
weightPerShipUnit
The weight per ship unit order base content line to handle shipping a multiple count number of ship units.
Nested Schema : attributes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : declaredValue
The declared value, commercial value of the ship unit line contents for sale of goods.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : volumePerShipUnit
The volume per order base content line to handle shipping a multiple count number of ship units.
Match All
Show Source
Nested Schema : weightPerShipUnit
The weight per ship unit order base content line to handle shipping a multiple count number of ship units.
Match All
Show Source
Nested Schema : orderBases.shipUnits.contents.attributes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
itemFeatureQualGid: string
The item feature qualifier GID defining what type of feature this value is associated with.
-
itemFeatureValue: string
The item feature value for the order base line. This allows for future structural definition of an item such as size and color.
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : orderBases.shipUnits.contents.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method ID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact GID for the involved party.
-
involvedPartyQualGid: string
The qualifier GID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : orderBases.shipUnits.contents.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obSuContentRefnumQualGid: string
The reference number qualifier GID defining the reference code.
-
obSuContentRefnumValue: string
The text associated to the reference code.
Nested Schema : orderBases.shipUnits.contents.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier GID defining the remark code.
-
remarkSequence: number
(int64)
The remark sequence identifier used for sequential ordering.
-
remarkText: string
The text associated to the remark code.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : orderBases.shipUnits.equipmentRefUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentReferenceUnitGid: string
The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.
-
links: array
links
Read Only:
true
-
numReferenceUnits: number
(double)
The number of equipment reference units this ship unit will consume when loading onto the equipment.
-
totalNumReferenceUnits: number
(double)
The total equipment reference units max consumption demand for this ship unit.
Nested Schema : orderBases.shipUnits.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method GID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact GID for the involved party.
-
involvedPartyQualGid: string
The qualifier GID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : orderBases.shipUnits.loadingSplits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
height:
height
The height for the this part of the ship unit split.
-
length:
length
The length for the this part of the ship unit split.
-
links: array
links
Read Only:
true
-
splitNo: number
(int32)
The split number for the ship unit.
-
volume:
volume
The volume for the this part of the ship unit split.
-
weight:
weight
The weight for the this part of the ship unit split.
-
width:
width
The width for the this part of the ship unit split.
Nested Schema : orderBases.shipUnits.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obShipUnitRefnumQualGid: string
The reference number qualifier identifier defining the reference code.
-
obShipUnitRefnumValue: string
The text associated to the reference number code.
Nested Schema : orderBases.shipUnits.releaseInstructions
Type:
Show Source
object
-
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
-
attributeDate2:
attributeDate2
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
-
attributeNumber2: 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
-
destLocationGid: string
The destination location GID for the delivery of the order base ship unit.
-
domainName: string
Database domain where this data is stored.
-
earlyDeliveryDate:
earlyDeliveryDate
The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
-
earlyPickupDate:
earlyPickupDate
The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
-
flaggedForDelete: boolean
A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.
-
height:
height
The height of the ship unit for the release instruction.
-
isAutoRelease: boolean
A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.
-
isProcessed: boolean
Read Only:
true
A Y/N indicator specifying that the release instruction was processed to create an order release ship unit. -
itemPackageCount: number
(int64)
The number of packaged items on this ship unit release instruction.
-
lateDeliveryDate:
lateDeliveryDate
The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
-
latePickupDate:
latePickupDate
The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
-
length:
length
The length of the ship unit for the release instruction.
-
links: array
links
Read Only:
true
-
masterOrderBaseGid: string
The master order base GID to be set on the order release created from the line. An order release can be created from multiple order bases and one of them is nominated as the master to get master level information for such as bill to party.
-
obSuReleaseInstrGid: string
The GID for the Release Instruction associated to the order base ship unit.
-
obSuReleaseInstrXid: string
The XID for the release instruction.
-
orderBaseGid: string
The order base GID for the release instruction.
-
refnums:
refnums
-
releaseDate:
releaseDate
The date the release instruction should be processed.
-
remarks:
remarks
-
sequenceNo: number
(int64)
The sequence number (key) associated with the release instruction.
-
shipUnitReleaseCount: number
(int64)
The ship unit release count specifying the amount to be processed with this release instruction.
-
shipWithGroup: string
The ship with group value that will be used when creating the order release from this release instruction.
-
sourceLocationGid: string
The source location GID for the pickup of the order base ship unit.
-
tag1: string
Additional information about the item. Like the color or code number.
-
tag2: string
Additional information about the item. Like the color or code number.
-
tag3: string
Additional information about the item. Like the color or code number.
-
tag4: string
Additional information about the item. Like the color or code number.
-
totalVolume:
totalVolume
The total volume of the ship units for this release instruction.
-
totalWeight:
totalWeight
The total weight of the ship units for this release instruction.
-
transportHandlingUnitGid: string
The transport handling unit GID to be applied to the order release ship unit created with this release instruction.
-
volume:
volume
The volume for the release instruction.
-
weight:
weight
The weight for the release instruction.
-
width:
width
The width of the ship unit for the release instruction.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : height
The height of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : lateDeliveryDate
The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : length
The length of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseDate
The date the release instruction should be processed.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : totalVolume
The total volume of the ship units for this release instruction.
Match All
Show Source
Nested Schema : totalWeight
The total weight of the ship units for this release instruction.
Match All
Show Source
Nested Schema : orderBases.shipUnits.releaseInstructions.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
orderReleaseRefnumQualGid: string
The reference number qualifier GID defining the reference code.
-
orderReleaseRefnumValue: string
The text associated to the reference code.
Nested Schema : orderBases.shipUnits.releaseInstructions.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier GID defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the order base ship unit release instruction.
-
remarkText: string
The text associated to the remark code.
Nested Schema : orderBases.shipUnits.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the order base ship unit.
-
remarkText: string
The text associated to the remark code.
Nested Schema : orderBases.shipUnits.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipUnitSeal: string
The transport handling unit seal number for the order base ship unit.
Nested Schema : orderBases.shipUnits.specialServices
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
specialServiceGid: string
The special service identifier defining the special service that needs to be performed for the ship unit.
Nested Schema : orderBases.shipUnits.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type GID for the status value on the order base.
-
statusValueGid: string
The status value for the order release base.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
accessorials:
accessorials
-
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
-
attributeDate2:
attributeDate2
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
-
attributeNumber2: 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
-
bufferLocationGid: string
The buffer location to identify if this order base ship unit is being modeled with a buffer location to hold inventory prior to final delivery.
-
contents:
contents
-
coreDiameter:
coreDiameter
For cylindrical objects, this defines the diameter of the core.
-
declaredValue:
declaredValue
The declared value of the total of the goods, ship unit content lines on the ship unit.
-
deliveryIsAppt: boolean
Indicates if the early/late delivery times are appointment times
-
destLocationGid: string
The destination location GID for the delivery location associated with this order base ship unit.
-
diameter:
diameter
The unit diameter of the ship unit.
-
domainName: string
Database domain where this data is stored.
-
earlyDeliveryDate:
earlyDeliveryDate
The earliest date when the item can be delivered.
-
earlyPickupDate:
earlyPickupDate
The earliest date when the item can be picked up.
-
equipmentRefUnits:
equipmentRefUnits
-
flexCommodityCode: string
The user defined commodity code for the item. E.g.. HTS, SITC, STCC, NMFC
-
flexCommodityQualGid: string
The user defined commodity qualifier identify the type of commodity classification being used, such as NMFC.
-
height:
height
The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
-
involvedParties:
involvedParties
-
isShippable: boolean
A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.
-
lateDeliveryDate:
lateDeliveryDate
The latest date when the item can be picked delivered.
-
latePickupDate:
latePickupDate
The latest date when the item can be picked up.
-
length:
length
The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
-
links: array
links
Read Only:
true
-
loadConfigSetupGid: string
A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.
-
loadingSplits:
loadingSplits
-
loadPoint: string
The specific loading location for the source location on the ship unit.
-
netVolume:
netVolume
The total net volume of the ship unit content lines on the ship unit.
-
netWeight:
netWeight
The total net weight of the ship unit content lines on the ship unit.
-
obShipUnitGid: string
The GID for the ship unit associated to an order base.
-
obShipUnitXid: string
The XID for the ship unit associated to a order base.
-
pickupIsAppt: boolean
Indicates if the early/late pickup times are appointment times
-
planFromLoadPoint: string
The specific loading location for the plan from location on the ship unit.
-
planFromLocationGid: string
The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
-
planToLocationGid: string
The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
-
planToUnloadPoint: string
The specific unloading location for the plan to location on the ship unit.
-
refnums:
refnums
-
releasedCount: number
(int64)
Read Only:
true
The number of ship units that have been processed onto order release through the releasing logic. -
releaseInstructions:
releaseInstructions
-
remarks:
remarks
-
seals:
seals
-
shipUnitCount: number
(int64)
The number of ship units this entry represents. Ship unit count of 1 to model discrete ship units and bulk orders. Greater than 1 to model multiple uniform ship units.
-
sourceLocationGid: string
The source location GID for the pickup location associated with this order base ship unit.
-
specialServices:
specialServices
-
splittableBy: string
Indicates how the resulting order release ship unit may be split across equipment.
-
statuses:
statuses
-
tag1: string
Additional information about the item. Like the color or size code, etc.
-
tag2: string
Additional information about the item. Like the color or size code, etc.
-
tag3: string
Additional information about the item. Like the color or size code, etc.
-
tag4: string
Additional information about the item. Like the color or size code, etc.
-
transportHandlingUnitGid: string
The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
-
unloadPoint: string
The specific unloading location for the delivery location on the ship unit.
-
volume:
volume
The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
-
weight:
weight
The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
-
width:
width
The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : contents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : coreDiameter
For cylindrical objects, this defines the diameter of the core.
Match All
Show Source
Nested Schema : declaredValue
The declared value of the total of the goods, ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be delivered.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be picked up.
Match All
Show Source
Nested Schema : equipmentRefUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : height
The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : lateDeliveryDate
The latest date when the item can be picked delivered.
Match All
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked up.
Match All
Show Source
Nested Schema : length
The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
Match All
Show Source
Nested Schema : loadingSplits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : netVolume
The total net volume of the ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : netWeight
The total net weight of the ship unit content lines on the ship unit.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseInstructions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : volume
The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
Match All
Show Source
Nested Schema : weight
The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
Match All
Show Source
Nested Schema : width
The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.
Match All
Show Source
Nested Schema : orderBases.shipUnits.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The accessorial code used to specify that this accessorial needs to be copied to the order release and covered when planning the shipment.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : orderBases.shipUnits.contents
Type:
Show Source
object
-
attributes:
attributes
-
countPerShipUnit: number
(int64)
The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.
-
declaredValue:
declaredValue
The declared value, commercial value of the ship unit line contents for sale of goods.
-
domainName: string
Database domain where this data is stored.
-
initialItemGid: string
The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field.
-
involvedParties:
involvedParties
-
links: array
links
Read Only:
true
-
packagedCount: number
(int64)
The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
-
packagedItemGid: string
The packaged item GID defining the content line for the ship unit.
-
packagingUnitCount: number
(int64)
The packaging unit count for the inner pack.
-
packagingUnitGid: string
The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.
-
refnums:
refnums
-
remarks:
remarks
-
sequenceNo: number
(int64)
The unique sequence within the ship unit to define the individual line items.
-
tag1: string
Additional information about the item. Like the color, size, code.
-
tag2: string
Additional information about the item. Like the color, size, code.
-
tag3: string
Additional information about the item. Like the color, size, code.
-
tag4: string
Additional information about the item. Like the color, size, code.
-
volume:
volume
The gross volume of the item.
-
volumePerShipUnit:
volumePerShipUnit
The volume per order base content line to handle shipping a multiple count number of ship units.
-
weight:
weight
The gross weight of the item.
-
weightPerShipUnit:
weightPerShipUnit
The weight per ship unit order base content line to handle shipping a multiple count number of ship units.
Nested Schema : attributes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : declaredValue
The declared value, commercial value of the ship unit line contents for sale of goods.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : volumePerShipUnit
The volume per order base content line to handle shipping a multiple count number of ship units.
Match All
Show Source
Nested Schema : weightPerShipUnit
The weight per ship unit order base content line to handle shipping a multiple count number of ship units.
Match All
Show Source
Nested Schema : orderBases.shipUnits.contents.attributes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
itemFeatureQualGid: string
The item feature qualifier GID defining what type of feature this value is associated with.
-
itemFeatureValue: string
The item feature value for the order base line. This allows for future structural definition of an item such as size and color.
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : orderBases.shipUnits.contents.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method ID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact GID for the involved party.
-
involvedPartyQualGid: string
The qualifier GID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : orderBases.shipUnits.contents.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obSuContentRefnumQualGid: string
The reference number qualifier GID defining the reference code.
-
obSuContentRefnumValue: string
The text associated to the reference code.
Nested Schema : orderBases.shipUnits.contents.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier GID defining the remark code.
-
remarkSequence: number
(int64)
The remark sequence identifier used for sequential ordering.
-
remarkText: string
The text associated to the remark code.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : orderBases.shipUnits.equipmentRefUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentReferenceUnitGid: string
The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.
-
links: array
links
Read Only:
true
-
numReferenceUnits: number
(double)
The number of equipment reference units this ship unit will consume when loading onto the equipment.
-
totalNumReferenceUnits: number
(double)
The total equipment reference units max consumption demand for this ship unit.
Nested Schema : orderBases.shipUnits.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method GID for the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The contact GID for the involved party.
-
involvedPartyQualGid: string
The qualifier GID for the involved party.
-
links: array
links
Read Only:
true
Nested Schema : orderBases.shipUnits.loadingSplits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
height:
height
The height for the this part of the ship unit split.
-
length:
length
The length for the this part of the ship unit split.
-
links: array
links
Read Only:
true
-
splitNo: number
(int32)
The split number for the ship unit.
-
volume:
volume
The volume for the this part of the ship unit split.
-
weight:
weight
The weight for the this part of the ship unit split.
-
width:
width
The width for the this part of the ship unit split.
Nested Schema : orderBases.shipUnits.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obShipUnitRefnumQualGid: string
The reference number qualifier identifier defining the reference code.
-
obShipUnitRefnumValue: string
The text associated to the reference number code.
Nested Schema : orderBases.shipUnits.releaseInstructions
Type:
Show Source
object
-
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
-
attributeDate2:
attributeDate2
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
-
attributeNumber2: 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
-
destLocationGid: string
The destination location GID for the delivery of the order base ship unit.
-
domainName: string
Database domain where this data is stored.
-
earlyDeliveryDate:
earlyDeliveryDate
The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
-
earlyPickupDate:
earlyPickupDate
The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
-
flaggedForDelete: boolean
A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.
-
height:
height
The height of the ship unit for the release instruction.
-
isAutoRelease: boolean
A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.
-
isProcessed: boolean
Read Only:
true
A Y/N indicator specifying that the release instruction was processed to create an order release ship unit. -
itemPackageCount: number
(int64)
The number of packaged items on this ship unit release instruction.
-
lateDeliveryDate:
lateDeliveryDate
The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
-
latePickupDate:
latePickupDate
The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
-
length:
length
The length of the ship unit for the release instruction.
-
links: array
links
Read Only:
true
-
masterOrderBaseGid: string
The master order base GID to be set on the order release created from the line. An order release can be created from multiple order bases and one of them is nominated as the master to get master level information for such as bill to party.
-
obSuReleaseInstrGid: string
The GID for the Release Instruction associated to the order base ship unit.
-
obSuReleaseInstrXid: string
The XID for the release instruction.
-
orderBaseGid: string
The order base GID for the release instruction.
-
refnums:
refnums
-
releaseDate:
releaseDate
The date the release instruction should be processed.
-
remarks:
remarks
-
sequenceNo: number
(int64)
The sequence number (key) associated with the release instruction.
-
shipUnitReleaseCount: number
(int64)
The ship unit release count specifying the amount to be processed with this release instruction.
-
shipWithGroup: string
The ship with group value that will be used when creating the order release from this release instruction.
-
sourceLocationGid: string
The source location GID for the pickup of the order base ship unit.
-
tag1: string
Additional information about the item. Like the color or code number.
-
tag2: string
Additional information about the item. Like the color or code number.
-
tag3: string
Additional information about the item. Like the color or code number.
-
tag4: string
Additional information about the item. Like the color or code number.
-
totalVolume:
totalVolume
The total volume of the ship units for this release instruction.
-
totalWeight:
totalWeight
The total weight of the ship units for this release instruction.
-
transportHandlingUnitGid: string
The transport handling unit GID to be applied to the order release ship unit created with this release instruction.
-
volume:
volume
The volume for the release instruction.
-
weight:
weight
The weight for the release instruction.
-
width:
width
The width of the ship unit for the release instruction.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : height
The height of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : lateDeliveryDate
The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
Match All
Show Source
Nested Schema : length
The length of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : releaseDate
The date the release instruction should be processed.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : totalVolume
The total volume of the ship units for this release instruction.
Match All
Show Source
Nested Schema : totalWeight
The total weight of the ship units for this release instruction.
Match All
Show Source
Nested Schema : orderBases.shipUnits.releaseInstructions.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
orderReleaseRefnumQualGid: string
The reference number qualifier GID defining the reference code.
-
orderReleaseRefnumValue: string
The text associated to the reference code.
Nested Schema : orderBases.shipUnits.releaseInstructions.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier GID defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the order base ship unit release instruction.
-
remarkText: string
The text associated to the remark code.
Nested Schema : orderBases.shipUnits.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier defining the remark code.
-
remarkSequence: number
(int64)
The sequence identifier for the remark associated with the order base ship unit.
-
remarkText: string
The text associated to the remark code.
Nested Schema : orderBases.shipUnits.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipUnitSeal: string
The transport handling unit seal number for the order base ship unit.
Nested Schema : orderBases.shipUnits.specialServices
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
specialServiceGid: string
The special service identifier defining the special service that needs to be performed for the ship unit.
Nested Schema : orderBases.shipUnits.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type GID for the status value on the order base.
-
statusValueGid: string
The status value for the order release base.