discountAutomaticBxgyCreate
mutation

Choose a version:

Requires Apps must have write_discounts access scope.

Creates a BXGY automatic discount.

Anchor to section titled 'Arguments'

Arguments

Anchor to automaticBxgyDiscount automaticBxgyDiscount DiscountAutomaticBxgyInput! required: The input data used to create the automatic discount.

Was this section helpful?

Anchor to section titled 'DiscountAutomaticBxgyCreatePayload returns'

DiscountAutomaticBxgyCreatePayload returns

Anchor to DiscountAutomaticBxgyCreatePayload.automaticDiscountNode automaticDiscountNode DiscountAutomaticNode: The created automatic discount.
Anchor to DiscountAutomaticBxgyCreatePayload.userErrors userErrors [DiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: discountAutomaticBxgyCreate

Query Reference for MUTATION: discountAutomaticBxgyCreate

"mutation discountAutomaticBxgyCreate($automaticBxgyDiscount: DiscountAutomaticBxgyInput!) {\n  discountAutomaticBxgyCreate(automaticBxgyDiscount: $automaticBxgyDiscount) {\n    automaticDiscountNode {\n      # DiscountAutomaticNode fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: discountAutomaticBxgyCreate

"{\n  \"automaticBxgyDiscount\": {\n    \"combinesWith\": {\n      \"orderDiscounts\": true,\n      \"productDiscounts\": true,\n      \"shippingDiscounts\": true\n    },\n    \"customerBuys\": {\n      \"items\": {\n        \"all\": true,\n        \"collections\": {\n          \"add\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"remove\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ]\n        },\n        \"products\": {\n          \"productVariantsToAdd\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"productVariantsToRemove\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"productsToAdd\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"productsToRemove\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ]\n        }\n      },\n      \"value\": {\n        \"amount\": \"29.99\",\n        \"quantity\": \"50\"\n      }\n    },\n    \"customerGets\": {\n      \"appliesOnOneTimePurchase\": true,\n      \"appliesOnSubscription\": true,\n      \"items\": {\n        \"all\": true,\n        \"collections\": {\n          \"add\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"remove\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ]\n        },\n        \"products\": {\n          \"productVariantsToAdd\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"productVariantsToRemove\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"productsToAdd\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ],\n          \"productsToRemove\": [\n            \"gid://shopify/<objectName>/10079785100\"\n          ]\n        }\n      },\n      \"value\": {\n        \"discountAmount\": {\n          \"amount\": \"29.99\",\n          \"appliesOnEachItem\": true\n        },\n        \"discountOnQuantity\": {\n          \"effect\": {\n            \"amount\": \"29.99\",\n            \"percentage\": 1.1\n          },\n          \"quantity\": \"50\"\n        },\n        \"percentage\": 1.1\n      }\n    },\n    \"endsAt\": \"2019-09-07T15:50:00Z\",\n    \"startsAt\": \"2019-09-07T15:50:00Z\",\n    \"title\": \"<your-title>\",\n    \"usesPerOrderLimit\": \"50\"\n  }\n}"

Schema Reference for MUTATION: discountAutomaticBxgyCreate

"input DiscountAutomaticBxgyInput {\n  combinesWith: DiscountCombinesWithInput\n  customerBuys: DiscountCustomerBuysInput\n  customerGets: DiscountCustomerGetsInput\n  endsAt: DateTime\n  startsAt: DateTime\n  title: String\n  usesPerOrderLimit: UnsignedInt64\n}\n\ninput DiscountCombinesWithInput {\n  orderDiscounts: Boolean\n  productDiscounts: Boolean\n  shippingDiscounts: Boolean\n}\n\ninput DiscountCustomerBuysInput {\n  items: DiscountItemsInput\n  value: DiscountCustomerBuysValueInput\n}\n\ninput DiscountCustomerGetsInput {\n  appliesOnOneTimePurchase: Boolean\n  appliesOnSubscription: Boolean\n  items: DiscountItemsInput\n  value: DiscountCustomerGetsValueInput\n}\n"

Display Examples for MUTATION: discountAutomaticBxgyCreate

[]

discountAutomaticBxgyCreatemutation

Arguments

DiscountAutomaticBxgyCreatePayload returns

discountAutomaticBxgyCreate
mutation