API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

deliveryProfileUpdate mutation

Version unstable

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • sellingPlanGroupsToAssociate ([ID!])

    The selling plan groups to be associated with this profile.

  • sellingPlanGroupsToDissociate ([ID!])

    The selling plan groups to be dissociated with this profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • sellingPlanGroupsToAssociate ([ID!])

    The selling plan groups to be associated with this profile.

  • sellingPlanGroupsToDissociate ([ID!])

    The selling plan groups to be dissociated with this profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • sellingPlanGroupsToAssociate ([ID!])

    The selling plan groups to be associated with this profile.

  • sellingPlanGroupsToDissociate ([ID!])

    The selling plan groups to be dissociated with this profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Updates a delivery profile.

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
id ( ID! ) required

The ID of the profile to update.

leaveLegacyModeProfiles ( Boolean )

Whether or not this profile should leave legacy mode.

profile ( DeliveryProfileInput! ) required

Specifies the input fields for a delivery profile.

DeliveryProfileInput fields

  • conditionsToDelete ([ID!])

    Conditions to delete.

  • locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])

    The location groups to be created in the profile.

  • locationGroupsToDelete ([ID!])

    The location groups to be deleted in the profile.

  • locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])

    The location groups to be updated in the profile.

  • methodDefinitionsToDelete ([ID!])

    Method definitions to delete.

  • name (String)

    The name of the profile.

  • profileLocationGroups ([DeliveryProfileLocationGroupInput!])

    The location groups associated with the profile.

  • variantsToAssociate ([ID!])

    The product variant ids to be associated with this profile.

  • variantsToDissociate ([ID!])

    The product variant ids to be dissociated from this profile and returned to the default profile.

  • zonesToDelete ([ID!])

    Zones to delete.

Return fields

  • profile (DeliveryProfile)

    The delivery profile that was updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.