Anchor to section titled 'undefined'delivery
delivery
mutation
2024-07
Requires Any of shipping access scopes or manage user permission.
Create a delivery profile.
Anchor to section titled 'Arguments'
Arguments
Specifies the input fields for a delivery profile.
Was this section helpful?
Anchor to section titled 'DeliveryProfileCreatePayload returns'
DeliveryProfileCreatePayload returns
The delivery profile that was created.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: deliveryProfileCreate
Query Reference for MUTATION: deliveryProfileCreate
"mutation deliveryProfileCreate($profile: DeliveryProfileInput!) {\n deliveryProfileCreate(profile: $profile) {\n profile {\n # DeliveryProfile fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: deliveryProfileCreate
"{\n \"profile\": {\n \"conditionsToDelete\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationGroupsToCreate\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"locations\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationsToAdd\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationsToRemove\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"zonesToCreate\": [\n {\n \"countries\": [\n {\n \"code\": \"AC\",\n \"includeAllProvinces\": true,\n \"provinces\": [\n {\n \"code\": \"<your-code>\"\n }\n ],\n \"restOfWorld\": true\n }\n ],\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"methodDefinitionsToCreate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"methodDefinitionsToUpdate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"name\": \"<your-name>\"\n }\n ],\n \"zonesToUpdate\": [\n {\n \"countries\": [\n {\n \"code\": \"AC\",\n \"includeAllProvinces\": true,\n \"provinces\": [\n {\n \"code\": \"<your-code>\"\n }\n ],\n \"restOfWorld\": true\n }\n ],\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"methodDefinitionsToCreate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"methodDefinitionsToUpdate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"name\": \"<your-name>\"\n }\n ]\n }\n ],\n \"locationGroupsToDelete\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationGroupsToUpdate\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"locations\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationsToAdd\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationsToRemove\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"zonesToCreate\": [\n {\n \"countries\": [\n {\n \"code\": \"AC\",\n \"includeAllProvinces\": true,\n \"provinces\": [\n {\n \"code\": \"<your-code>\"\n }\n ],\n \"restOfWorld\": true\n }\n ],\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"methodDefinitionsToCreate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"methodDefinitionsToUpdate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"name\": \"<your-name>\"\n }\n ],\n \"zonesToUpdate\": [\n {\n \"countries\": [\n {\n \"code\": \"AC\",\n \"includeAllProvinces\": true,\n \"provinces\": [\n {\n \"code\": \"<your-code>\"\n }\n ],\n \"restOfWorld\": true\n }\n ],\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"methodDefinitionsToCreate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"methodDefinitionsToUpdate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"name\": \"<your-name>\"\n }\n ]\n }\n ],\n \"methodDefinitionsToDelete\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"name\": \"<your-name>\",\n \"profileLocationGroups\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"locations\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationsToAdd\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"locationsToRemove\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"zonesToCreate\": [\n {\n \"countries\": [\n {\n \"code\": \"AC\",\n \"includeAllProvinces\": true,\n \"provinces\": [\n {\n \"code\": \"<your-code>\"\n }\n ],\n \"restOfWorld\": true\n }\n ],\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"methodDefinitionsToCreate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"methodDefinitionsToUpdate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"name\": \"<your-name>\"\n }\n ],\n \"zonesToUpdate\": [\n {\n \"countries\": [\n {\n \"code\": \"AC\",\n \"includeAllProvinces\": true,\n \"provinces\": [\n {\n \"code\": \"<your-code>\"\n }\n ],\n \"restOfWorld\": true\n }\n ],\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"methodDefinitionsToCreate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"methodDefinitionsToUpdate\": [\n {\n \"active\": true,\n \"conditionsToUpdate\": [\n {\n \"criteria\": 1.1,\n \"criteriaUnit\": \"<your-criteriaUnit>\",\n \"field\": \"TOTAL_PRICE\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"name\": \"<your-name>\",\n \"participant\": {\n \"adaptToNewServices\": true,\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"fixedFee\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"participantServices\": [\n {\n \"active\": true,\n \"name\": \"<your-name>\"\n }\n ],\n \"percentageOfRateFee\": 1.1\n },\n \"priceConditionsToCreate\": [\n {\n \"criteria\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ],\n \"rateDefinition\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"criteria\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n },\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\"\n }\n ]\n }\n ],\n \"name\": \"<your-name>\"\n }\n ]\n }\n ],\n \"sellingPlanGroupsToAssociate\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"sellingPlanGroupsToDissociate\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"variantsToAssociate\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"variantsToDissociate\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"zonesToDelete\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n }\n}"Schema Reference for MUTATION: deliveryProfileCreate
"input DeliveryProfileInput {\n conditionsToDelete: [ID!]\n locationGroupsToCreate: [DeliveryProfileLocationGroupInput!]\n locationGroupsToDelete: [ID!]\n locationGroupsToUpdate: [DeliveryProfileLocationGroupInput!]\n methodDefinitionsToDelete: [ID!]\n name: String\n profileLocationGroups: [DeliveryProfileLocationGroupInput!]\n sellingPlanGroupsToAssociate: [ID!]\n sellingPlanGroupsToDissociate: [ID!]\n variantsToAssociate: [ID!]\n variantsToDissociate: [ID!]\n zonesToDelete: [ID!]\n}\n\ninput DeliveryProfileLocationGroupInput {\n id: ID\n locations: [ID!]\n locationsToAdd: [ID!]\n locationsToRemove: [ID!]\n zonesToCreate: [DeliveryLocationGroupZoneInput!]\n zonesToUpdate: [DeliveryLocationGroupZoneInput!]\n}\n"Display Examples for MUTATION: deliveryProfileCreate
[
{
"example": {
"type_name": "deliveryprofilecreate",
"title": "Create delivery profile",
"description": "Create delivery profile with two location groups, one for shipping from Canada and another one for the United States.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to start with no more than 5 groups. More groups can be added later via the profile update mutation.\n",
"query_string": "mutation createDeliveryProfile($profile: DeliveryProfileInput!) {\n deliveryProfileCreate(profile: $profile) {\n profile {\n id\n name\n profileLocationGroups {\n locationGroup {\n id\n locations(first: 5) {\n nodes {\n name\n address {\n country\n }\n }\n }\n }\n locationGroupZones(first: 2) {\n edges {\n node {\n zone {\n id\n name\n countries {\n code {\n countryCode\n }\n provinces {\n code\n }\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"profile": "$profile"
},
"variables": {
"profile": {
"name": "Sample Delivery Profile",
"locationGroupsToCreate": [
{
"locationsToAdd": [
"gid://shopify/Location/750123840",
"gid://shopify/Location/884687543"
],
"zonesToCreate": [
{
"name": "Canada Zone",
"countries": [
{
"code": "CA",
"provinces": [
{
"code": "ON"
}
]
}
],
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1,
"currencyCode": "USD"
}
},
"weightConditionsToCreate": [
{
"operator": "GREATER_THAN_OR_EQUAL_TO",
"criteria": {
"value": 0,
"unit": "KILOGRAMS"
}
},
{
"operator": "LESS_THAN_OR_EQUAL_TO",
"criteria": {
"value": 15,
"unit": "KILOGRAMS"
}
}
]
}
]
}
]
},
{
"locationsToAdd": [
"gid://shopify/Location/415211365"
],
"zonesToCreate": [
{
"name": "USA Zone",
"countries": {
"code": "US",
"provinces": [
{
"code": "CO"
}
]
},
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1,
"currencyCode": "USD"
}
}
}
]
},
{
"name": "Mexico Zone",
"countries": {
"code": "MX",
"provinces": [
{
"code": "MOR"
}
]
},
"methodDefinitionsToCreate": [
{
"name": "Standard",
"rateDefinition": {
"price": {
"amount": 1,
"currencyCode": "USD"
}
}
}
]
}
]
}
]
}
},
"response": {
"data": {
"deliveryProfileCreate": {
"profile": {
"id": "gid://shopify/DeliveryProfile/933922679",
"name": "Sample Delivery Profile",
"profileLocationGroups": [
{
"locationGroup": {
"id": "gid://shopify/DeliveryLocationGroup/982182448",
"locations": {
"nodes": [
{
"name": "Ottawa Warehouse",
"address": {
"country": "Canada"
}
},
{
"name": "Toronto Store",
"address": {
"country": "Canada"
}
}
]
}
},
"locationGroupZones": {
"edges": [
{
"node": {
"zone": {
"id": "gid://shopify/DeliveryZone/1066475772",
"name": "Canada Zone",
"countries": [
{
"code": {
"countryCode": "CA"
},
"provinces": [
{
"code": "ON"
}
]
}
]
}
}
}
]
}
},
{
"locationGroup": {
"id": "gid://shopify/DeliveryLocationGroup/982182449",
"locations": {
"nodes": [
{
"name": "US Store",
"address": {
"country": "United States"
}
}
]
}
},
"locationGroupZones": {
"edges": [
{
"node": {
"zone": {
"id": "gid://shopify/DeliveryZone/1066475774",
"name": "Mexico Zone",
"countries": [
{
"code": {
"countryCode": "MX"
},
"provinces": [
{
"code": "MOR"
}
]
}
]
}
}
},
{
"node": {
"zone": {
"id": "gid://shopify/DeliveryZone/1066475773",
"name": "USA Zone",
"countries": [
{
"code": {
"countryCode": "US"
},
"provinces": [
{
"code": "CO"
}
]
}
]
}
}
}
]
}
}
]
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/delivery/test/unit/graph_api/admin/delivery/mutations/profile_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createDeliveryProfile($profile: DeliveryProfileInput!) { deliveryProfileCreate(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 } } }\",\n \"variables\": {\n \"profile\": {\n \"name\": \"Sample Delivery Profile\",\n \"locationGroupsToCreate\": [\n {\n \"locationsToAdd\": [\n \"gid://shopify/Location/750123840\",\n \"gid://shopify/Location/884687543\"\n ],\n \"zonesToCreate\": [\n {\n \"name\": \"Canada Zone\",\n \"countries\": [\n {\n \"code\": \"CA\",\n \"provinces\": [\n {\n \"code\": \"ON\"\n }\n ]\n }\n ],\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"criteria\": {\n \"value\": 0,\n \"unit\": \"KILOGRAMS\"\n }\n },\n {\n \"operator\": \"LESS_THAN_OR_EQUAL_TO\",\n \"criteria\": {\n \"value\": 15.0,\n \"unit\": \"KILOGRAMS\"\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"locationsToAdd\": [\n \"gid://shopify/Location/415211365\"\n ],\n \"zonesToCreate\": [\n {\n \"name\": \"USA Zone\",\n \"countries\": {\n \"code\": \"US\",\n \"provinces\": [\n {\n \"code\": \"CO\"\n }\n ]\n },\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n }\n }\n ]\n },\n {\n \"name\": \"Mexico Zone\",\n \"countries\": {\n \"code\": \"MX\",\n \"provinces\": [\n {\n \"code\": \"MOR\"\n }\n ]\n },\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n }\n }\n ]\n }\n ]\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createDeliveryProfile($profile: DeliveryProfileInput!) {\n deliveryProfileCreate(profile: $profile) {\n profile {\n id\n name\n profileLocationGroups {\n locationGroup {\n id\n locations(first: 5) {\n nodes {\n name\n address {\n country\n }\n }\n }\n }\n locationGroupZones(first: 2) {\n edges {\n node {\n zone {\n id\n name\n countries {\n code {\n countryCode\n }\n provinces {\n code\n }\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"profile\": {\n \"name\": \"Sample Delivery Profile\",\n \"locationGroupsToCreate\": [\n {\n \"locationsToAdd\": [\n \"gid://shopify/Location/750123840\",\n \"gid://shopify/Location/884687543\"\n ],\n \"zonesToCreate\": [\n {\n \"name\": \"Canada Zone\",\n \"countries\": [\n {\n \"code\": \"CA\",\n \"provinces\": [\n {\n \"code\": \"ON\"\n }\n ]\n }\n ],\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"criteria\": {\n \"value\": 0,\n \"unit\": \"KILOGRAMS\"\n }\n },\n {\n \"operator\": \"LESS_THAN_OR_EQUAL_TO\",\n \"criteria\": {\n \"value\": 15.0,\n \"unit\": \"KILOGRAMS\"\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"locationsToAdd\": [\n \"gid://shopify/Location/415211365\"\n ],\n \"zonesToCreate\": [\n {\n \"name\": \"USA Zone\",\n \"countries\": {\n \"code\": \"US\",\n \"provinces\": [\n {\n \"code\": \"CO\"\n }\n ]\n },\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n }\n }\n ]\n },\n {\n \"name\": \"Mexico Zone\",\n \"countries\": {\n \"code\": \"MX\",\n \"provinces\": [\n {\n \"code\": \"MOR\"\n }\n ]\n },\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n }\n }\n ]\n }\n ]\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation createDeliveryProfile($profile: DeliveryProfileInput!) {\n deliveryProfileCreate(profile: $profile) {\n profile {\n id\n name\n profileLocationGroups {\n locationGroup {\n id\n locations(first: 5) {\n nodes {\n name\n address {\n country\n }\n }\n }\n }\n locationGroupZones(first: 2) {\n edges {\n node {\n zone {\n id\n name\n countries {\n code {\n countryCode\n }\n provinces {\n code\n }\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"profile\": {\n \"name\": \"Sample Delivery Profile\",\n \"locationGroupsToCreate\": [{\"locationsToAdd\"=>[\"gid://shopify/Location/750123840\", \"gid://shopify/Location/884687543\"], \"zonesToCreate\"=>[{\"name\"=>\"Canada Zone\", \"countries\"=>[{\"code\"=>\"CA\", \"provinces\"=>[{\"code\"=>\"ON\"}]}], \"methodDefinitionsToCreate\"=>[{\"name\"=>\"Standard\", \"rateDefinition\"=>{\"price\"=>{\"amount\"=>1.0, \"currencyCode\"=>\"USD\"}}, \"weightConditionsToCreate\"=>[{\"operator\"=>\"GREATER_THAN_OR_EQUAL_TO\", \"criteria\"=>{\"value\"=>0, \"unit\"=>\"KILOGRAMS\"}}, {\"operator\"=>\"LESS_THAN_OR_EQUAL_TO\", \"criteria\"=>{\"value\"=>15.0, \"unit\"=>\"KILOGRAMS\"}}]}]}]}, {\"locationsToAdd\"=>[\"gid://shopify/Location/415211365\"], \"zonesToCreate\"=>[{\"name\"=>\"USA Zone\", \"countries\"=>{\"code\"=>\"US\", \"provinces\"=>[{\"code\"=>\"CO\"}]}, \"methodDefinitionsToCreate\"=>[{\"name\"=>\"Standard\", \"rateDefinition\"=>{\"price\"=>{\"amount\"=>1.0, \"currencyCode\"=>\"USD\"}}}]}, {\"name\"=>\"Mexico Zone\", \"countries\"=>{\"code\"=>\"MX\", \"provinces\"=>[{\"code\"=>\"MOR\"}]}, \"methodDefinitionsToCreate\"=>[{\"name\"=>\"Standard\", \"rateDefinition\"=>{\"price\"=>{\"amount\"=>1.0, \"currencyCode\"=>\"USD\"}}}]}]}]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createDeliveryProfile($profile: DeliveryProfileInput!) {\n deliveryProfileCreate(profile: $profile) {\n profile {\n id\n name\n profileLocationGroups {\n locationGroup {\n id\n locations(first: 5) {\n nodes {\n name\n address {\n country\n }\n }\n }\n }\n locationGroupZones(first: 2) {\n edges {\n node {\n zone {\n id\n name\n countries {\n code {\n countryCode\n }\n provinces {\n code\n }\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"profile\": {\n \"name\": \"Sample Delivery Profile\",\n \"locationGroupsToCreate\": [\n {\n \"locationsToAdd\": [\n \"gid://shopify/Location/750123840\",\n \"gid://shopify/Location/884687543\"\n ],\n \"zonesToCreate\": [\n {\n \"name\": \"Canada Zone\",\n \"countries\": [\n {\n \"code\": \"CA\",\n \"provinces\": [\n {\n \"code\": \"ON\"\n }\n ]\n }\n ],\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n },\n \"weightConditionsToCreate\": [\n {\n \"operator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"criteria\": {\n \"value\": 0,\n \"unit\": \"KILOGRAMS\"\n }\n },\n {\n \"operator\": \"LESS_THAN_OR_EQUAL_TO\",\n \"criteria\": {\n \"value\": 15.0,\n \"unit\": \"KILOGRAMS\"\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"locationsToAdd\": [\n \"gid://shopify/Location/415211365\"\n ],\n \"zonesToCreate\": [\n {\n \"name\": \"USA Zone\",\n \"countries\": {\n \"code\": \"US\",\n \"provinces\": [\n {\n \"code\": \"CO\"\n }\n ]\n },\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n }\n }\n ]\n },\n {\n \"name\": \"Mexico Zone\",\n \"countries\": {\n \"code\": \"MX\",\n \"provinces\": [\n {\n \"code\": \"MOR\"\n }\n ]\n },\n \"methodDefinitionsToCreate\": [\n {\n \"name\": \"Standard\",\n \"rateDefinition\": {\n \"price\": {\n \"amount\": 1.0,\n \"currencyCode\": \"USD\"\n }\n }\n }\n ]\n }\n ]\n }\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createDeliveryProfile($profile: DeliveryProfileInput!) {\n deliveryProfileCreate(profile: $profile) {\n profile {\n id\n name\n profileLocationGroups {\n locationGroup {\n id\n locations(first: 5) {\n nodes {\n name\n address {\n country\n }\n }\n }\n }\n locationGroupZones(first: 2) {\n edges {\n node {\n zone {\n id\n name\n countries {\n code {\n countryCode\n }\n provinces {\n code\n }\n }\n }\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"profile\" => [\n \"name\" => \"Sample Delivery Profile\",\n \"locationGroupsToCreate\" => [{\"locationsToAdd\"=>[\"gid://shopify/Location/750123840\", \"gid://shopify/Location/884687543\"], \"zonesToCreate\"=>[{\"name\"=>\"Canada Zone\", \"countries\"=>[{\"code\"=>\"CA\", \"provinces\"=>[{\"code\"=>\"ON\"}]}], \"methodDefinitionsToCreate\"=>[{\"name\"=>\"Standard\", \"rateDefinition\"=>{\"price\"=>{\"amount\"=>1.0, \"currencyCode\"=>\"USD\"}}, \"weightConditionsToCreate\"=>[{\"operator\"=>\"GREATER_THAN_OR_EQUAL_TO\", \"criteria\"=>{\"value\"=>0, \"unit\"=>\"KILOGRAMS\"}}, {\"operator\"=>\"LESS_THAN_OR_EQUAL_TO\", \"criteria\"=>{\"value\"=>15.0, \"unit\"=>\"KILOGRAMS\"}}]}]}]}, {\"locationsToAdd\"=>[\"gid://shopify/Location/415211365\"], \"zonesToCreate\"=>[{\"name\"=>\"USA Zone\", \"countries\"=>{\"code\"=>\"US\", \"provinces\"=>[{\"code\"=>\"CO\"}]}, \"methodDefinitionsToCreate\"=>[{\"name\"=>\"Standard\", \"rateDefinition\"=>{\"price\"=>{\"amount\"=>1.0, \"currencyCode\"=>\"USD\"}}}]}, {\"name\"=>\"Mexico Zone\", \"countries\"=>{\"code\"=>\"MX\", \"provinces\"=>[{\"code\"=>\"MOR\"}]}, \"methodDefinitionsToCreate\"=>[{\"name\"=>\"Standard\", \"rateDefinition\"=>{\"price\"=>{\"amount\"=>1.0, \"currencyCode\"=>\"USD\"}}}]}]}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "profile",
"description": "Specifies the input fields for a delivery profile.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DeliveryProfileInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "DeliveryProfileInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "profile",
"argValue": " {\"name\":\"Sample Delivery Profile\",\"locationGroupsToCreate\":[{\"locationsToAdd\":[\"gid://shopify/Location/750123840\",\"gid://shopify/Location/884687543\"],\"zonesToCreate\":[{\"name\":\"Canada Zone\",\"countries\":[{\"code\":\"CA\",\"provinces\":[{\"code\":\"ON\"}]}],\"methodDefinitionsToCreate\":[{\"name\":\"Standard\",\"rateDefinition\":{\"price\":{\"amount\":1,\"currencyCode\":\"USD\"}},\"weightConditionsToCreate\":[{\"operator\":\"GREATER_THAN_OR_EQUAL_TO\",\"criteria\":{\"value\":0,\"unit\":\"KILOGRAMS\"}},{\"operator\":\"LESS_THAN_OR_EQUAL_TO\",\"criteria\":{\"value\":15,\"unit\":\"KILOGRAMS\"}}]}]}]},{\"locationsToAdd\":[\"gid://shopify/Location/415211365\"],\"zonesToCreate\":[{\"name\":\"USA Zone\",\"countries\":{\"code\":\"US\",\"provinces\":[{\"code\":\"CO\"}]},\"methodDefinitionsToCreate\":[{\"name\":\"Standard\",\"rateDefinition\":{\"price\":{\"amount\":1,\"currencyCode\":\"USD\"}}}]},{\"name\":\"Mexico Zone\",\"countries\":{\"code\":\"MX\",\"provinces\":[{\"code\":\"MOR\"}]},\"methodDefinitionsToCreate\":[{\"name\":\"Standard\",\"rateDefinition\":{\"price\":{\"amount\":1,\"currencyCode\":\"USD\"}}}]}]}]}",
"typeKind": "MUTATION"
}
]
}
]