Anchor to section titled 'undefined'delivery
delivery
mutation
2025-01release candidate
Requires Any of
shipping access scopes or manage_delivery_settings user permission.
Update a delivery profile.
Anchor to section titled 'Arguments'
Arguments
The ID of the delivery profile to update.
- Anchor to leaveLegacyModeProfilesleaveLegacyModeProfiles
Whether this delivery profile should leave legacy mode.
Specifies the input fields for a delivery profile.
Was this section helpful?
Anchor to section titled 'DeliveryProfileUpdatePayload returns'
DeliveryProfileUpdatePayload returns
The delivery profile that was updated.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Examples
Hide code
DescriptionCopy
mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
deliveryProfileUpdate(id: $id, profile: $profile) {
profile {
id
name
profileLocationGroups {
locationGroup {
id
locations(first: 5) {
nodes {
name
address {
country
}
}
}
}
locationGroupZones(first: 2) {
edges {
node {
zone {
id
name
countries {
code {
countryCode
}
provinces {
code
}
}
}
}
}
}
}
}
userErrors {
field
message
}
}
}curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) { deliveryProfileUpdate(id: $id, profile: $profile) { profile { id name profileLocationGroups { locationGroup { id locations(first: 5) { nodes { name address { country } } } } locationGroupZones(first: 2) { edges { node { zone { id name countries { code { countryCode } provinces { code } } } } } } } } userErrors { field message } } }",
"variables": {
"id": "gid://shopify/DeliveryProfile/593363170",
"profile": {
"name": "Sample Updated Delivery Profile",
"locationGroupsToUpdate": [
{
"id": "gid://shopify/DeliveryLocationGroup/955592432",
"locationsToAdd": [
"gid://shopify/Location/884687543"
],
"zonesToCreate": [
{
"name": "USA Zone",
"countries": {
"code": "US",
"provinces": [
{
"code": "CO"
}
]
},
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1.0,
"currencyCode": "USD"
}
}
}
]
}
]
}
]
}
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
deliveryProfileUpdate(id: $id, profile: $profile) {
profile {
id
name
profileLocationGroups {
locationGroup {
id
locations(first: 5) {
nodes {
name
address {
country
}
}
}
}
locationGroupZones(first: 2) {
edges {
node {
zone {
id
name
countries {
code {
countryCode
}
provinces {
code
}
}
}
}
}
}
}
}
userErrors {
field
message
}
}
}`,
{
variables: {
"id": "gid://shopify/DeliveryProfile/593363170",
"profile": {
"name": "Sample Updated Delivery Profile",
"locationGroupsToUpdate": [
{
"id": "gid://shopify/DeliveryLocationGroup/955592432",
"locationsToAdd": [
"gid://shopify/Location/884687543"
],
"zonesToCreate": [
{
"name": "USA Zone",
"countries": {
"code": "US",
"provinces": [
{
"code": "CO"
}
]
},
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1.0,
"currencyCode": "USD"
}
}
}
]
}
]
}
]
}
},
},
);
const data = await response.json();
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
deliveryProfileUpdate(id: $id, profile: $profile) {
profile {
id
name
profileLocationGroups {
locationGroup {
id
locations(first: 5) {
nodes {
name
address {
country
}
}
}
}
locationGroupZones(first: 2) {
edges {
node {
zone {
id
name
countries {
code {
countryCode
}
provinces {
code
}
}
}
}
}
}
}
}
userErrors {
field
message
}
}
}
QUERY
variables = {
"id": "gid://shopify/DeliveryProfile/593363170",
"profile": {
"name": "Sample Updated Delivery Profile",
"locationGroupsToUpdate": [{"id"=>"gid://shopify/DeliveryLocationGroup/955592432", "locationsToAdd"=>["gid://shopify/Location/884687543"], "zonesToCreate"=>[{"name"=>"USA Zone", "countries"=>{"code"=>"US", "provinces"=>[{"code"=>"CO"}]}, "methodDefinitionsToCreate"=>[{"name"=>"Standard", "rateDefinition"=>{"price"=>{"amount"=>1.0, "currencyCode"=>"USD"}}}]}]}]
}
}
response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
deliveryProfileUpdate(id: $id, profile: $profile) {
profile {
id
name
profileLocationGroups {
locationGroup {
id
locations(first: 5) {
nodes {
name
address {
country
}
}
}
}
locationGroupZones(first: 2) {
edges {
node {
zone {
id
name
countries {
code {
countryCode
}
provinces {
code
}
}
}
}
}
}
}
}
userErrors {
field
message
}
}
}`,
"variables": {
"id": "gid://shopify/DeliveryProfile/593363170",
"profile": {
"name": "Sample Updated Delivery Profile",
"locationGroupsToUpdate": [
{
"id": "gid://shopify/DeliveryLocationGroup/955592432",
"locationsToAdd": [
"gid://shopify/Location/884687543"
],
"zonesToCreate": [
{
"name": "USA Zone",
"countries": {
"code": "US",
"provinces": [
{
"code": "CO"
}
]
},
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1.0,
"currencyCode": "USD"
}
}
}
]
}
]
}
]
}
},
},
});
use Shopify\Clients\Graphql;
$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
deliveryProfileUpdate(id: $id, profile: $profile) {
profile {
id
name
profileLocationGroups {
locationGroup {
id
locations(first: 5) {
nodes {
name
address {
country
}
}
}
}
locationGroupZones(first: 2) {
edges {
node {
zone {
id
name
countries {
code {
countryCode
}
provinces {
code
}
}
}
}
}
}
}
}
userErrors {
field
message
}
}
}
QUERY;
$variables = [
"id" => "gid://shopify/DeliveryProfile/593363170",
"profile" => [
"name" => "Sample Updated Delivery Profile",
"locationGroupsToUpdate" => [{"id"=>"gid://shopify/DeliveryLocationGroup/955592432", "locationsToAdd"=>["gid://shopify/Location/884687543"], "zonesToCreate"=>[{"name"=>"USA Zone", "countries"=>{"code"=>"US", "provinces"=>[{"code"=>"CO"}]}, "methodDefinitionsToCreate"=>[{"name"=>"Standard", "rateDefinition"=>{"price"=>{"amount"=>1.0, "currencyCode"=>"USD"}}}]}]}],
],
];
$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
"id": "gid://shopify/DeliveryProfile/593363170",
"profile": {
"name": "Sample Updated Delivery Profile",
"locationGroupsToUpdate": [
{
"id": "gid://shopify/DeliveryLocationGroup/955592432",
"locationsToAdd": [
"gid://shopify/Location/884687543"
],
"zonesToCreate": [
{
"name": "USA Zone",
"countries": {
"code": "US",
"provinces": [
{
"code": "CO"
}
]
},
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1,
"currencyCode": "USD"
}
}
}
]
}
]
}
]
}
}
Hide code
Response
JSON
{
"deliveryProfileUpdate": {
"profile": {
"id": "gid://shopify/DeliveryProfile/593363170",
"name": "Sample Updated Delivery Profile",
"profileLocationGroups": [
{
"locationGroup": {
"id": "gid://shopify/DeliveryLocationGroup/955592432",
"locations": {
"nodes": [
{
"name": "Ottawa Store",
"address": {
"country": "Canada"
}
},
{
"name": "Ottawa Warehouse",
"address": {
"country": "Canada"
}
},
{
"name": "Shipping Origin",
"address": {
"country": "Canada"
}
}
]
}
},
"locationGroupZones": {
"edges": [
{
"node": {
"zone": {
"id": "gid://shopify/DeliveryZone/161697132",
"name": "Canada",
"countries": [
{
"code": {
"countryCode": "CA"
},
"provinces": [
{
"code": "ON"
}
]
}
]
}
}
},
{
"node": {
"zone": {
"id": "gid://shopify/DeliveryZone/1066475777",
"name": "USA Zone",
"countries": [
{
"code": {
"countryCode": "US"
},
"provinces": [
{
"code": "CO"
}
]
}
]
}
}
}
]
}
}
]
},
"userErrors": []
}
}