Get Lines

get

/orderBases/{orderBaseGid}/lines

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.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

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 : items
Type: array
Show Source
Nested Schema : orderBases.lines
Type: object
Show Source
Nested Schema : allocations
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : declaredValue
The declared value contains the stated value for the order base line item.
Match All
The declared value contains the stated value for the order base line item.
Show Source
Nested Schema : earlyDeliveryDate
The earliest date when the item can be delivered.
Match All
The earliest date when the item can be delivered.
Show Source
Nested Schema : earlyPickupDate
The earliest date when the item can be picked up.
Match All
The earliest date when the item can be picked up.
Show Source
Nested Schema : equipmentRefUnits
Type: object
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : lateDeliveryDate
The latest date when the item can be picked delivered.
Match All
The latest date when the item can be picked delivered.
Show Source
Nested Schema : latePickupDate
The latest date when the item can be picked up.
Match All
The latest date when the item can be picked up.
Show Source
Nested Schema : packageRefUnits
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : releasedVolume
Read Only: true
The total volume that has already been released against this order base line.
Match All
The total volume that has already been released against this order base line.
Show Source
Nested Schema : releasedWeight
Read Only: true
The total released weight that has already been released against this order base line.
Match All
The total released weight that has already been released against this order base line.
Show Source
Nested Schema : releaseInstructions
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : volume
The volume of the packaged items for this line.
Match All
The volume of the packaged items for this line.
Show Source
Nested Schema : weight
The weight of the packaged items for this line.
Match All
The weight of the packaged items for this line.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.allocations
Type: object
Show Source
Nested Schema : allocationBase
Type: object
Show Source
Nested Schema : baseCost
No description.
Match All
No description.
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : exchangeRateDate
No description.
Match All
No description.
Show Source
Nested Schema : privateCost
No description.
Match All
No description.
Show Source
Nested Schema : totalAllocLineCost
No description.
Match All
No description.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.allocations.allocationBase
Type: object
Show Source
Nested Schema : allocatedCost
No description.
Match All
No description.
Show Source
Nested Schema : exchangeRateDate
No description.
Match All
No description.
Show Source
Nested Schema : timestamp
No description.
Match All
No description.
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.allocations.details
Type: object
Show Source
Nested Schema : attributeCurrency1
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Show Source
Nested Schema : attributeCurrency2
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Show Source
Nested Schema : attributeCurrency3
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
Show Source
Nested Schema : attributeDate1
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate10
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate11
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate12
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate13
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate14
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate15
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate16
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate17
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate18
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate19
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate2
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate20
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate3
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate4
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate5
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate6
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate7
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate8
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : attributeDate9
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Match All
Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
Show Source
Nested Schema : cost
No description.
Match All
No description.
Show Source
Nested Schema : exchangeRateDate
No description.
Match All
No description.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.attributes
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.equipmentRefUnits
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.packageRefUnits
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.refnums
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.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
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
Match All
Attribute fields (flexfields) allow you to add additional information about an object. Data type date
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
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.
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
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.
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
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.
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
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.
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : releaseDate
The date the release instruction is to be processed.
Match All
The date the release instruction is to be processed.
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
The total volume of the ship units for this release instruction.
Show Source
Nested Schema : totalWeight
The total weight of the ship units for this release instruction.
Match All
The total weight of the ship units for this release instruction.
Show Source
Nested Schema : volumeValue
The volume for the release instruction.
Match All
The volume for the release instruction.
Show Source
Nested Schema : weightValue
The weight for the release instruction.
Match All
The weight for the release instruction.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.releaseInstructions.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.releaseInstructions.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : orderBases.lines.statuses
Type: object
Show Source
Back to Top