Get Special Services
get
/sellShipments/{shipmentGid}/specialServices
Request
Path Parameters
-
shipmentGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
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.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : sellShipments.specialServices
Type:
Show Source
object
-
actualDistance:
actualDistance
The actual distance of the special service.
-
actualDuration:
actualDuration
The actual duration of the special service.
-
actualItemPackageCount: number
(int64)
The actual package count applicable to this special service.
-
actualOccurTime:
actualOccurTime
The actual date and time special service occurred.
-
actualShipUnitCount: number
(int64)
The actual ship unit count applicable to this special service.
-
actualVolume:
actualVolume
The actual volume of the goods applicable to this special service.
-
actualWeight:
actualWeight
The actual weight of the goods applicable to this special service.
-
adjustmentReasonGid: string
The reason why charge was added.
-
billableIndicatorGid: string
indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
-
completionState: string
Indicates completion state of this special service.
-
domainName: string
Database domain where this data is stored.
-
isPlannedDurationFixed: boolean
If Y, prevents the system from overwriting the planned duration for the special service.
-
isSystemGenerated: boolean
Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
-
links: array
links
Read Only:
true
-
payableIndicatorGid: string
Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
-
plannedDuration:
plannedDuration
The planned duration of the special service.
-
processAsFlowThru: boolean
The override for record to be copied to the sell side during rating.
-
refs:
refs
-
remarks:
remarks
-
shipmentSpecialServiceSeq: number
(int64)
The sequence to keep shipment special services unique.
-
specialServiceGid: string
The special service associated with the remark.
-
stopNum: number
(int32)
If the special service is for a particular stop, this indicates the stop number.
Nested Schema : actualOccurTime
The actual date and time special service occurred.
Match All
Show Source
Nested Schema : actualVolume
The actual volume of the goods applicable to this special service.
Match All
Show Source
Nested Schema : actualWeight
The actual weight of the goods applicable to this special service.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
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 : sellShipments.specialServices.refs
Type:
Show Source
object
-
costReferenceGid: string
The cost reference GID for the shipment special service.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The shipment cost qualifier associated to the cost reference.
Nested Schema : sellShipments.specialServices.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier, or type.
-
remarkSequence: number
(int64)
The one-up number to make the remark unique.
-
remarkText: string
The remark text itself.