cartBillingAddressUpdate

Updates the billing address on the cart.

Use it in a workflow

Add a step and choose the Shopify Storefront connector.
Pick the cartBillingAddressUpdate action (under Cart).
Fill in the fields below, then reference the result from later steps as {{cartbillingaddressupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CartBillingAddressUpdate($cartId: ID!, $billingAddress: MailingAddressInput) {
  cartBillingAddressUpdate(cartId: $cartId, billingAddress: $billingAddress) {
    cart {
      appliedGiftCards {
        amountUsed
        amountUsedV2
        balance
        balanceV2
        id
        lastCharacters
        presentmentAmountUsed
      }
      attributes {
        key
        value
      }
      buyerIdentity {
        countryCode
        customer
        deliveryAddressPreferences
        email
        phone
        preferences
        purchasingCompany
      }
      checkoutUrl
      cost {
        checkoutChargeAmount
        subtotalAmount
        subtotalAmountEstimated
        totalAmount
        totalAmountEstimated
        totalDutyAmount
        totalDutyAmountEstimated
        totalTaxAmount
        totalTaxAmountEstimated
      }
      createdAt
      delivery
      discountAllocations {
        discountApplication
        discountedAmount
        sourceDiscountApplication
        targetType
      }
      discountApplications {
        allocationMethod
        targetSelection
        targetType
        totalAllocatedAmount
        value
      }
      discountCodes {
        applicable
        code
      }
      estimatedCost {
        checkoutChargeAmount
        subtotalAmount
        totalAmount
        totalDutyAmount
        totalTaxAmount
      }
      id
      note
      totalQuantity
      updatedAt
    }
    userErrors {
      code
      field
      message
    }
    warnings {
      code
      message
      target
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

cartIdstringrequired

The ID of the cart.

billingAddressobject

The customer's billing address.

address1string

address2string

citystring

companystring

countrystring

firstNamestring

lastNamestring

phonestring

provincestring

zipstring

json

{
  "cartId": "string",
  "billingAddress": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "company": "string",
    "country": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "province": "string",
    "zip": "string"
  }
}

Response

Read the result with {{cartbillingaddressupdate.response.data.data.cartBillingAddressUpdate}}. If the API returns errors, the step fails and they are at {{cartbillingaddressupdate.response.data.errors}}.

cartobject

appliedGiftCardsarray<object>

attributesarray<object>

buyerIdentityobject7 fields

checkoutUrlstring

costobject9 fields

createdAtstring

deliveryobject

discountAllocationsarray<object>

discountApplicationsarray<object>

discountCodesarray<object>

estimatedCostobject5 fields

idstring

notestring

totalQuantitynumber

updatedAtstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

warningsarray<object>

codeobject

messageobject

targetobject

Need more? See the Shopify Storefront guide for connection setup and behaviour shared by every action.

Was this page helpful?