Skip to main content
Anchor to DeliveryPromiseParticipant

DeliveryPromiseParticipant

object

Requires read_delivery_promises access scope.

Returns enabled delivery promise participants.

Anchor to FieldsFields

Anchor to brandedPromiseHandlebrandedPromiseHandle
•String!
non-null

The branded promise handle of the promise participant.

Anchor to idid
•ID!
non-null

The ID of the promise participant.

Anchor to ownerowner
•DeliveryPromiseParticipantOwner

The resource that the participant is attached to.

Anchor to ownerTypeownerType
•DeliveryPromiseParticipantOwnerType!
non-null

The owner type of the participant.

Was this section helpful?

Anchor to QueriesQueries

Anchor to deliveryPromiseParticipantsdeliveryPromiseParticipants
•query

Returns delivery promise participants.

Arguments

Anchor to ownerIdsownerIds
•[ID!]

The product variant ID to filter by.

Anchor to brandedPromiseHandlebrandedPromiseHandle
•String!
required

The branded promise handle to filter by.

Anchor to ownerTypeownerType
•DeliveryPromiseParticipantOwnerType

The owner type to filter by.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Was this section helpful?

Anchor to MutationsMutations

Anchor to deliveryPromiseParticipantsUpdatedeliveryPromiseParticipantsUpdate
•mutation

Updates the delivery promise participants by adding or removing owners based on a branded promise handle.

Arguments

Anchor to brandedPromiseHandlebrandedPromiseHandle
•String!
required

The branded promise handle to update the delivery promise participants for.

Anchor to ownersToAddownersToAdd
•[ID!]
Default:[]

The owners to add to the delivery promise participants.

Anchor to ownersToRemoveownersToRemove
•[ID!]
Default:[]

The owners to remove from the delivery promise participants.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?