checkoutShippingAddressUpdateV2 mutation
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping address of an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingAddress
(
MailingAddressInput!
)
required
|
The shipping address to where the line items will be shipped. |
MailingAddressInput fields
-
address1 (
String
)The first line of the address. Typically the street address or PO Box number.
-
address2 (
String
)The second line of the address. Typically the number of the apartment, suite, or unit.
-
city (
String
)The name of the city, district, village, or town.
-
company (
String
)The name of the customer's company or organization.
-
country (
String
)The name of the country.
-
firstName (
String
)The first name of the customer.
-
lastName (
String
)The last name of the customer.
-
phone (
String
)A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
-
province (
String
)The region of the address, such as the province, state, or district.
-
zip (
String
)The zip or postal code of the address.
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead