subscriptionContractSelectDeliveryMethod

mutation

Requires the write_own_subscription_contracts scope.

Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.

Anchor to Arguments

Arguments

Anchor to deliveryMethodInputdeliveryMethodInput

•SubscriptionDeliveryMethodInput!

required

The delivery method selected for the subscription contract.

Anchor to subscriptionContractIdsubscriptionContractId

•ID!

required

The ID of the subscription contract.

Anchor to subscriptionDeliveryOptionsResultTokensubscriptionDeliveryOptionsResultToken

•String!

required

The token associated with the successfully fetched delivery options result for the subscription contract.

Was this section helpful?

Anchor to SubscriptionContractSelectDeliveryMethodPayload returnsSubscriptionContractSelectDeliveryMethodPayload returns

Anchor to contractcontract •SubscriptionContract: The updated subscription contract object.
Anchor to userErrorsuserErrors •[SubscriptionContractUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionContractSelectDeliveryMethod reference

Mutation Reference

mutation subscriptionContractSelectDeliveryMethod($deliveryMethodInput: SubscriptionDeliveryMethodInput!, $subscriptionContractId: ID!, $subscriptionDeliveryOptionsResultToken: String!) {

subscriptionContractSelectDeliveryMethod(deliveryMethodInput: $deliveryMethodInput, subscriptionContractId: $subscriptionContractId, subscriptionDeliveryOptionsResultToken: $subscriptionDeliveryOptionsResultToken) {

contract {

# SubscriptionContract fields

}

userErrors {

field

message

}

Input

{

"deliveryMethodInput": {

"localDelivery": {

"deliveryAddress": {},

"instructions": "<your-instructions>",

"phone": "<your-phone>"

"pickup": {

"locationId": "gid://shopify/<objectName>/10079785100"

"shipping": {

"shippingAddress": {}

}

"subscriptionContractId": "gid://shopify/<objectName>/10079785100",

"subscriptionDeliveryOptionsResultToken": "<your-subscriptionDeliveryOptionsResultToken>"

}

Variables

{
  "deliveryMethodInput": {
    "localDelivery": {
      "deliveryAddress": {},
      "instructions": "<your-instructions>",
      "phone": "<your-phone>"
    },
    "pickup": {
      "locationId": "gid://shopify/<objectName>/10079785100"
    },
    "shipping": {
      "shippingAddress": {}
    }
  },
  "subscriptionContractId": "gid://shopify/<objectName>/10079785100",
  "subscriptionDeliveryOptionsResultToken": "<your-subscriptionDeliveryOptionsResultToken>"
}

Schema

input SubscriptionDeliveryMethodInput {
  localDelivery: SubscriptionDeliveryMethodLocalDeliveryInput
  pickup: SubscriptionDeliveryMethodPickupInput
  shipping: SubscriptionDeliveryMethodShippingInput
}

input SubscriptionDeliveryMethodLocalDeliveryInput {
  deliveryAddress: CustomerAddressInput
  instructions: String
  phone: String!
}

input SubscriptionDeliveryMethodPickupInput {
  locationId: ID!
}

input SubscriptionDeliveryMethodShippingInput {
  shippingAddress: CustomerAddressInput
}