Anchor to section titled 'undefined'

discountAutomaticFreeShippingCreate
mutation

Requires Apps must have write_discounts access scope.

Creates a free shipping automatic discount.

Anchor to section titled 'Arguments'

Arguments

Anchor to freeShippingAutomaticDiscount
freeShippingAutomaticDiscount
DiscountAutomaticFreeShippingInput!
required

The input data used to create the automatic discount.

Was this section helpful?
Anchor to section titled 'DiscountAutomaticFreeShippingCreatePayload returns'

DiscountAutomaticFreeShippingCreatePayload returns

Anchor to DiscountAutomaticFreeShippingCreatePayload.automaticDiscountNode
automaticDiscountNode
DiscountAutomaticNode

The created automatic discount.

Anchor to DiscountAutomaticFreeShippingCreatePayload.userErrors
userErrors
[DiscountUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
  discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
    automaticDiscountNode {
      id
    }
    userErrors {
      field
      message
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) { discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) { automaticDiscountNode { id } userErrors { field message } } }",
 "variables": {
    "freeShippingAutomaticDiscount": {
      "title": "New Auto Free Shipping Discount",
      "startsAt": "2022-05-11T22:30:47Z",
      "destination": {
        "all": true
      },
      "minimumRequirement": {
        "subtotal": {
          "greaterThanOrEqualToSubtotal": "1"
        }
      },
      "combinesWith": {
        "orderDiscounts": true,
        "productDiscounts": true
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
      automaticDiscountNode {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "freeShippingAutomaticDiscount": {
        "title": "New Auto Free Shipping Discount",
        "startsAt": "2022-05-11T22:30:47Z",
        "destination": {
          "all": true
        },
        "minimumRequirement": {
          "subtotal": {
            "greaterThanOrEqualToSubtotal": "1"
          }
        },
        "combinesWith": {
          "orderDiscounts": true,
          "productDiscounts": true
        }
      }
    },
  },
);

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 M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
      automaticDiscountNode {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "freeShippingAutomaticDiscount": {
    "title": "New Auto Free Shipping Discount",
    "startsAt": "2022-05-11T22:30:47Z",
    "destination": {
      "all": true
    },
    "minimumRequirement": {
      "subtotal": {
        "greaterThanOrEqualToSubtotal": "1"
      }
    },
    "combinesWith": {
      "orderDiscounts": true,
      "productDiscounts": true
    }
  }
}

response = client.query(query: query, variables: variables)

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
      discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
        automaticDiscountNode {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "freeShippingAutomaticDiscount": {
        "title": "New Auto Free Shipping Discount",
        "startsAt": "2022-05-11T22:30:47Z",
        "destination": {
          "all": true
        },
        "minimumRequirement": {
          "subtotal": {
            "greaterThanOrEqualToSubtotal": "1"
          }
        },
        "combinesWith": {
          "orderDiscounts": true,
          "productDiscounts": true
        }
      }
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
      automaticDiscountNode {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY;

$variables = [
  "freeShippingAutomaticDiscount" => [
    "title" => "New Auto Free Shipping Discount",
    "startsAt" => "2022-05-11T22:30:47Z",
    "destination" => [
      "all" => true,
    ],
    "minimumRequirement" => [
      "subtotal" => [
        "greaterThanOrEqualToSubtotal" => "1",
      ],
    ],
    "combinesWith" => [
      "orderDiscounts" => true,
      "productDiscounts" => true,
    ],
  ],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "freeShippingAutomaticDiscount": {
    "title": "New Auto Free Shipping Discount",
    "startsAt": "2022-05-11T22:30:47Z",
    "destination": {
      "all": true
    },
    "minimumRequirement": {
      "subtotal": {
        "greaterThanOrEqualToSubtotal": "1"
      }
    },
    "combinesWith": {
      "orderDiscounts": true,
      "productDiscounts": true
    }
  }
}
Hide code
Response
JSON
{
  "discountAutomaticFreeShippingCreate": {
    "automaticDiscountNode": {
      "id": "gid://shopify/DiscountAutomaticNode/1057371196"
    },
    "userErrors": []
  }
}