subscriptionContractFetchDeliveryOptions

mutation

Requires the write_own_subscription_contracts scope.

Fetches the available delivery options for a Subscription Contract.

Anchor to Arguments

Arguments

Anchor to addressaddress

•CustomerAddressInput

The address to deliver the subscription contract to.

Show input fields

Anchor to subscriptionContractIdsubscriptionContractId

•ID!

required

The ID of the subscription contract.

Was this section helpful?

Anchor to SubscriptionContractFetchDeliveryOptionsPayload returnsSubscriptionContractFetchDeliveryOptionsPayload returns

Anchor to deliveryOptionsResultdeliveryOptionsResult

•SubscriptionDeliveryOptionsResult

The available delivery options for a given delivery address. Returns null for pending requests.

Show union types

Anchor to userErrorsuserErrors

•[SubscriptionContractUserError!]!

non-null

The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

subscriptionContractFetchDeliveryOptions reference

Mutation Reference

mutation subscriptionContractFetchDeliveryOptions($address: CustomerAddressInput, $subscriptionContractId: ID!) {

subscriptionContractFetchDeliveryOptions(address: $address, subscriptionContractId: $subscriptionContractId) {

deliveryOptionsResult {

# SubscriptionDeliveryOptionsResult fields

}

userErrors {

field

message

}

Input

{

"address": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"company": "<your-company>",

"countryCode": "AC",

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

"phoneNumber": "<your-phoneNumber>",

"zip": "<your-zip>",

"zoneCode": "<your-zoneCode>"

"subscriptionContractId": "gid://shopify/SubscriptionContract/10079785100"

}

Variables

{
  "address": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "countryCode": "AC",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phoneNumber": "<your-phoneNumber>",
    "zip": "<your-zip>",
    "zoneCode": "<your-zoneCode>"
  },
  "subscriptionContractId": "gid://shopify/SubscriptionContract/10079785100"
}

Schema

input CustomerAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  countryCode: CountryCode
  firstName: String
  lastName: String
  phoneNumber: String
  zip: String
  zoneCode: String
}