subscriptionContractFetchDeliveryOptions

mutation

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.
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.
Anchor to userErrorsuserErrors •[SubscriptionContractUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionContractFetchDeliveryOptions reference

Mutation Reference

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

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

deliveryOptionsResult {

# SubscriptionDeliveryOptionsResult fields

}

userErrors {

field

message

}

Input

{

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

"address": {

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

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

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

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

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

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

"territoryCode": "<your-territoryCode>",

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

"zoneCode": "<your-zoneCode>",

"zip": "<your-zip>"

}

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

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