Get a Ship Unit

get

/orderBases/{orderBaseGid}/shipUnits/{obShipUnitGid}

Request

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : accessorials
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : 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: object
Show Source
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 : diameter
The unit diameter of 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: object
Show Source
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: object
Show Source
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 : links
Type: array
Read Only: true
Show Source
Nested Schema : loadingSplits
Type: object
Show Source
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: object
Show Source
Nested Schema : releaseInstructions
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : seals
Type: object
Show Source
Nested Schema : specialServices
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
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 : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.accessorials
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.contents
Type: object
Show Source
Nested Schema : attributes
Type: object
Show Source
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: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : volume
The gross volume of the item.
Match All
Show Source
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 : weight
The gross weight of the item.
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 : items
Type: array
Show Source
Nested Schema : orderBases.shipUnits.contents.attributes
Type: object
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.shipUnits.contents.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.shipUnits.contents.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.shipUnits.contents.remarks
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.equipmentRefUnits
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.loadingSplits
Type: object
Show Source
Nested Schema : height
The height for the this part of the ship unit split.
Match All
Show Source
Nested Schema : length
The length for the this part of the ship unit split.
Match All
Show Source
Nested Schema : volume
The volume for the this part of the ship unit split.
Match All
Show Source
Nested Schema : weight
The weight for the this part of the ship unit split.
Match All
Show Source
Nested Schema : width
The width for the this part of the ship unit split.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.releaseInstructions
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Show Source
Nested Schema : 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: object
Show Source
Nested Schema : releaseDate
The date the release instruction should be processed.
Match All
Show Source
Nested Schema : remarks
Type: object
Show Source
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 : volume
The volume for the release instruction.
Match All
Show Source
Nested Schema : weight
The weight for the release instruction.
Match All
Show Source
Nested Schema : width
The width of the ship unit for the release instruction.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.shipUnits.releaseInstructions.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.shipUnits.releaseInstructions.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.specialServices
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : orderBases.shipUnits.statuses
Type: object
Show Source
Back to Top