deliveryProfileUpdate

Updates a DeliveryProfile's configuration, including its shipping zones, rates, and associated products.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the deliveryProfileUpdate action (under Delivery).
Fill in the fields below, then reference the result from later steps as {{deliveryprofileupdate.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 DeliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
  deliveryProfileUpdate(id: $id, profile: $profile) {
    profile {
      activeMethodDefinitionsCount
      coversAllItems
      default
      id
      locationsWithoutRatesCount
      name
      originLocationCount
      productVariantsCount {
        count
        precision
      }
      productVariantsCountV2 {
        capped
        count
      }
      unassignedLocations {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      version
      zoneCountryCount
    }
    userErrors {
      field
      message
    }
  }
}

Variables

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

idstringrequired

The ID of the delivery profile to update.

profileobjectrequired

Specifies the input fields for a delivery profile.

namestring

profileLocationGroupsarray<object>6 fields

locationGroupsToCreatearray<object>6 fields

locationGroupsToUpdatearray<object>6 fields

locationGroupsToDeletearray<string>

variantsToAssociatearray<string>

variantsToDissociatearray<string>

zonesToDeletearray<string>

methodDefinitionsToDeletearray<string>

conditionsToDeletearray<string>

sellingPlanGroupsToAssociatearray<string>

sellingPlanGroupsToDissociatearray<string>

coversAllItemsboolean

json

{
  "id": "string",
  "profile": {
    "name": "string",
    "profileLocationGroups": [
      {
        "id": "string",
        "locations": "string",
        "locationsToAdd": "string",
        "locationsToRemove": "string",
        "zonesToCreate": "string",
        "zonesToUpdate": "string"
      }
    ],
    "locationGroupsToCreate": [
      {
        "id": "string",
        "locations": "string",
        "locationsToAdd": "string",
        "locationsToRemove": "string",
        "zonesToCreate": "string",
        "zonesToUpdate": "string"
      }
    ],
    "locationGroupsToUpdate": [
      {
        "id": "string",
        "locations": "string",
        "locationsToAdd": "string",
        "locationsToRemove": "string",
        "zonesToCreate": "string",
        "zonesToUpdate": "string"
      }
    ],
    "locationGroupsToDelete": [
      "string"
    ],
    "variantsToAssociate": [
      "string"
    ],
    "variantsToDissociate": [
      "string"
    ],
    "zonesToDelete": [
      "string"
    ],
    "methodDefinitionsToDelete": [
      "string"
    ],
    "conditionsToDelete": [
      "string"
    ],
    "sellingPlanGroupsToAssociate": [
      "string"
    ],
    "sellingPlanGroupsToDissociate": [
      "string"
    ]
  }
}

Response

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

profileobject

activeMethodDefinitionsCountnumber

coversAllItemsboolean

defaultboolean

idstring

locationsWithoutRatesCountnumber

namestring

originLocationCountnumber

productVariantsCountobject2 fields

productVariantsCountV2object2 fields

unassignedLocationsarray<object>

versionnumber

zoneCountryCountnumber

userErrorsarray<object>

fieldobject

messageobject

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

Was this page helpful?