Choose a version:

cartDeliveryAddressesAdd

mutation

Adds delivery addresses to a Cart. A cart can have up to 20 delivery addresses. One address can be marked as selected for checkout, and addresses can optionally be marked as one-time use so they aren't saved to the customer's account.

Anchor to Arguments

Arguments

Anchor to addressesaddresses

•[CartSelectableAddressInput!]!

required

A list of delivery addresses to add to the cart.

The input must not contain more than 250 values.

Show input fields

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Was this section helpful?

Anchor to CartDeliveryAddressesAddPayload returnsCartDeliveryAddressesAddPayload returns

Anchor to cartcart •Cart: The updated cart.

Show fields
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Show fields

Was this section helpful?

Examples

Adds a delivery address to a cart

Description

Add a delivery address to a cart

Query

mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {
  cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {
    userErrors {
      message
      code
      field
    }
    warnings {
      message
      code
      target
    }
    cart {
      id
      delivery {
        addresses {
          id
          selected
          oneTimeUse
          address {
            ... on CartDeliveryAddress {
              firstName
              lastName
              company
              address1
              address2
              city
              provinceCode
              zip
              countryCode
            }
          }
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
  "addresses": [
    {
      "selected": true,
      "address": {
        "deliveryAddress": {
          "address1": "131 Greene Street",
          "city": "New York",
          "provinceCode": "NY",
          "countryCode": "US",
          "zip": "10012"
        }
      }
    }
  ]
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) { cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) { userErrors { message code field } warnings { message code target } cart { id delivery { addresses { id selected oneTimeUse address { ... on CartDeliveryAddress { firstName lastName company address1 address2 city provinceCode zip countryCode } } } } } } }",
 "variables": {
    "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
    "addresses": [
      {
        "selected": true,
        "address": {
          "deliveryAddress": {
            "address1": "131 Greene Street",
            "city": "New York",
            "provinceCode": "NY",
            "countryCode": "US",
            "zip": "10012"
          }
        }
      }
    ]
  }
}'

React Router

import { unauthenticated } from "../shopify.server";

export const loader = async () => {
  const { storefront } = await unauthenticated.storefront(
    'your-development-store.myshopify.com'
  );
  const response = await storefront.graphql(
    `#graphql
  mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {
    cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {
      userErrors {
        message
        code
        field
      }
      warnings {
        message
        code
        target
      }
      cart {
        id
        delivery {
          addresses {
            id
            selected
            oneTimeUse
            address {
              ... on CartDeliveryAddress {
                firstName
                lastName
                company
                address1
                address2
                city
                provinceCode
                zip
                countryCode
              }
            }
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
        "addresses": [
            {
                "selected": true,
                "address": {
                    "deliveryAddress": {
                        "address1": "131 Greene Street",
                        "city": "New York",
                        "provinceCode": "NY",
                        "countryCode": "US",
                        "zip": "10012"
                    }
                }
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {
      cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {
        userErrors {
          message
          code
          field
        }
        warnings {
          message
          code
          target
        }
        cart {
          id
          delivery {
            addresses {
              id
              selected
              oneTimeUse
              address {
                ... on CartDeliveryAddress {
                  firstName
                  lastName
                  company
                  address1
                  address2
                  city
                  provinceCode
                  zip
                  countryCode
                }
              }
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
        "addresses": [
            {
                "selected": true,
                "address": {
                    "deliveryAddress": {
                        "address1": "131 Greene Street",
                        "city": "New York",
                        "provinceCode": "NY",
                        "countryCode": "US",
                        "zip": "10012"
                    }
                }
            }
        ]
    },
  },
});

Response

{
  "cartDeliveryAddressesAdd": {
    "userErrors": [],
    "warnings": [],
    "cart": {
      "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
      "delivery": {
        "addresses": [
          {
            "id": "gid://shopify/CartSelectableAddress/59168936-5627-4056-b460-9c2ca1dff094",
            "selected": true,
            "oneTimeUse": false,
            "address": {
              "firstName": null,
              "lastName": "",
              "company": null,
              "address1": "131 Greene Street",
              "address2": null,
              "city": "New York",
              "provinceCode": "NY",
              "zip": "10012",
              "countryCode": "US"
            }
          }
        ]
      }
    }
  }
}

cartDeliveryAddressesAdd reference

Examples

import { unauthenticated } from "../shopify.server";

export const loader = async () => {

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {

cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {

userErrors {

message

code

field

}

warnings {

message

code

target

}

cart {

delivery {

addresses {

selected

oneTimeUse

address {

... on CartDeliveryAddress {

firstName

lastName

company

address1

address2

city

provinceCode

zip

countryCode

}

}`,

{

variables: {

"id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",

"addresses": [

{

"selected": true,

"address": {

"deliveryAddress": {

"address1": "131 Greene Street",

"city": "New York",

"provinceCode": "NY",

"countryCode": "US",

"zip": "10012"

}

]

);

const json = await response.json();

return json.data;

}

GQL

mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {
  cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {
    userErrors {
      message
      code
      field
    }
    warnings {
      message
      code
      target
    }
    cart {
      id
      delivery {
        addresses {
          id
          selected
          oneTimeUse
          address {
            ... on CartDeliveryAddress {
              firstName
              lastName
              company
              address1
              address2
              city
              provinceCode
              zip
              countryCode
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) { cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) { userErrors { message code field } warnings { message code target } cart { id delivery { addresses { id selected oneTimeUse address { ... on CartDeliveryAddress { firstName lastName company address1 address2 city provinceCode zip countryCode } } } } } } }",
 "variables": {
    "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
    "addresses": [
      {
        "selected": true,
        "address": {
          "deliveryAddress": {
            "address1": "131 Greene Street",
            "city": "New York",
            "provinceCode": "NY",
            "countryCode": "US",
            "zip": "10012"
          }
        }
      }
    ]
  }
}'

React Router

import { unauthenticated } from "../shopify.server";

export const loader = async () => {
  const { storefront } = await unauthenticated.storefront(
    'your-development-store.myshopify.com'
  );
  const response = await storefront.graphql(
    `#graphql
  mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {
    cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {
      userErrors {
        message
        code
        field
      }
      warnings {
        message
        code
        target
      }
      cart {
        id
        delivery {
          addresses {
            id
            selected
            oneTimeUse
            address {
              ... on CartDeliveryAddress {
                firstName
                lastName
                company
                address1
                address2
                city
                provinceCode
                zip
                countryCode
              }
            }
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
        "addresses": [
            {
                "selected": true,
                "address": {
                    "deliveryAddress": {
                        "address1": "131 Greene Street",
                        "city": "New York",
                        "provinceCode": "NY",
                        "countryCode": "US",
                        "zip": "10012"
                    }
                }
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation CartDeliveryAddressesAdd($id: ID!, $addresses: [CartSelectableAddressInput!]!) {
      cartDeliveryAddressesAdd(cartId: $id, addresses: $addresses) {
        userErrors {
          message
          code
          field
        }
        warnings {
          message
          code
          target
        }
        cart {
          id
          delivery {
            addresses {
              id
              selected
              oneTimeUse
              address {
                ... on CartDeliveryAddress {
                  firstName
                  lastName
                  company
                  address1
                  address2
                  city
                  provinceCode
                  zip
                  countryCode
                }
              }
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",
        "addresses": [
            {
                "selected": true,
                "address": {
                    "deliveryAddress": {
                        "address1": "131 Greene Street",
                        "city": "New York",
                        "provinceCode": "NY",
                        "countryCode": "US",
                        "zip": "10012"
                    }
                }
            }
        ]
    },
  },
});

Input variables

JSON

{

"id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",

"addresses": [

{

"selected": true,

"address": {

"deliveryAddress": {

"address1": "131 Greene Street",

"city": "New York",

"provinceCode": "NY",

"countryCode": "US",

"zip": "10012"

}

]

}

Response

JSON

{

"cartDeliveryAddressesAdd": {

"userErrors": [],

"warnings": [],

"cart": {

"id": "gid://shopify/Cart/c1-145e58da76bbee55b288ea50b81810d3?key=0068c4788cbb29555c10c3acc3b2ffc2",

"delivery": {

"addresses": [

{

"id": "gid://shopify/CartSelectableAddress/59168936-5627-4056-b460-9c2ca1dff094",

"selected": true,

"oneTimeUse": false,

"address": {

"firstName": null,

"lastName": "",

"company": null,

"address1": "131 Greene Street",

"address2": null,

"city": "New York",

"provinceCode": "NY",

"zip": "10012",

"countryCode": "US"

}

]

}