JobProperties interface
Job Properties
Properties
| all |
Flag to indicate if all devices associated with the job are lost. |
| cancellation |
Reason for cancellation. |
| delayed |
Name of the stage where delay might be present. |
| delivery |
Delivery Info of Job. |
| delivery |
Delivery type of Job. |
| details | Details of a job run. This field will only be sent for expand details filter. |
| error | Top level error for the job. |
| is |
Describes whether the job is cancellable or not. |
| is |
Flag to indicate cancellation of scheduled job. |
| is |
Describes whether the job is deletable or not. |
| is |
Is Prepare To Ship Enabled on this job |
| is |
Describes whether the shipping address is editable or not. |
| reverse |
The Editable status for Reverse Shipping Address and Contact Info |
| reverse |
The Editable status for Reverse Transport preferences |
| start |
Time at which the job was started in UTC ISO 8601 format. |
| status | Name of the stage which is in progress. |
| transfer |
Type of the data transfer. |
Property Details
allDevicesLost
Flag to indicate if all devices associated with the job are lost.
allDevicesLost?: boolean
Property Value
boolean
cancellationReason
Reason for cancellation.
cancellationReason?: string
Property Value
string
delayedStage
Name of the stage where delay might be present.
delayedStage?: string
Property Value
string
deliveryInfo
deliveryType
details
Details of a job run. This field will only be sent for expand details filter.
details?: JobDetailsUnion
Property Value
error
isCancellable
Describes whether the job is cancellable or not.
isCancellable?: boolean
Property Value
boolean
isCancellableWithoutFee
Flag to indicate cancellation of scheduled job.
isCancellableWithoutFee?: boolean
Property Value
boolean
isDeletable
Describes whether the job is deletable or not.
isDeletable?: boolean
Property Value
boolean
isPrepareToShipEnabled
Is Prepare To Ship Enabled on this job
isPrepareToShipEnabled?: boolean
Property Value
boolean
isShippingAddressEditable
Describes whether the shipping address is editable or not.
isShippingAddressEditable?: boolean
Property Value
boolean
reverseShippingDetailsUpdate
The Editable status for Reverse Shipping Address and Contact Info
reverseShippingDetailsUpdate?: ReverseShippingDetailsEditStatus
Property Value
reverseTransportPreferenceUpdate
The Editable status for Reverse Transport preferences
reverseTransportPreferenceUpdate?: ReverseTransportPreferenceEditStatus
Property Value
startTime
Time at which the job was started in UTC ISO 8601 format.
startTime?: Date
Property Value
Date
status
Name of the stage which is in progress.
status?: string
Property Value
string