Skip to main content
Anchor to JobResult

JobResult

interface

A job corresponds to some long running task that the client should poll for status.

Anchor to FieldsFields

Anchor to donedone
•Boolean!
non-null

This indicates if the job is still queued or has been run.

Anchor to idid
•ID!
non-null

A globally-unique ID that's returned when running an asynchronous mutation.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CustomerSegmentMembersQueryCustomerSegmentMembersQuery
•OBJECT

A job to determine a list of members, such as customers, that are associated with an individual segment.

Anchor to currentCountcurrentCount
•Int!
non-null

The current total number of members in a given segment.

Anchor to donedone
•Boolean!
non-null

This indicates if the job is still queued or has been run.

Anchor to idid
•ID!
non-null

A globally-unique ID that's returned when running an asynchronous mutation.

Anchor to statusstatus
•CustomerSegmentMembersQueryStatus!
non-null

The status of the customer segment members query.

Anchor to OrderCancelJobResultOrderCancelJobResult
•OBJECT

A job to determine the result of an order cancellation request.

Anchor to donedone
•Boolean!
non-null

This indicates if the job is still queued or has been run.

Anchor to errorserrors
•[OrderCancelUserError!]!
non-null

Returns any error that occurred during order cancellation.

Anchor to idid
•ID!
non-null

A globally-unique ID that's returned when running an asynchronous mutation.

Anchor to orderorder
•Order

The order associated with the cancellation request.

Anchor to statusstatus
•OrderCancelStatus!
non-null

The current status of the order cancellation request.

Anchor to OrderCreateMandatePaymentJobResultOrderCreateMandatePaymentJobResult
•OBJECT

A job result for tracking the status of a mandate payment request on an order.

Anchor to donedone
•Boolean!
non-null

This indicates if the job is still queued or has been run.

Anchor to errorserrors
•[UserError!]!
non-null

Returns any errors that occurred during the mandate payment.

Anchor to idid
•ID!
non-null

A globally-unique ID that's returned when running an asynchronous mutation.

Anchor to orderorder
•Order

The order associated with the mandate payment request.

Anchor to statusstatus
•OrderCreateMandatePaymentStatus!
non-null

The current status of the mandate payment request.

Anchor to ShippingLabelPurchaseResultShippingLabelPurchaseResult
•OBJECT

A result object that tracks the progress of a shipping label purchase request.

Anchor to donedone
•Boolean!
non-null

This indicates if the job is still queued or has been run.

Anchor to errorserrors
•[ShippingLabelPurchaseError!]!
non-null

Returns any error that occurred during shipping label purchase.

Anchor to idid
•ID!
non-null

A globally-unique ID that's returned when running an asynchronous mutation.

Anchor to shippingLabelsshippingLabels
•[ShippingLabel!]!
non-null

The shipping labels associated with the purchase request.

Anchor to statusstatus
•ShippingLabelPurchaseResultStatus!
non-null

The current status of the shipping label purchase result.

Was this section helpful?