discountCodeFreeShippingCreate

Creates an free shipping discount that's applied on a cart and at checkout when a customer enters a code.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the discountCodeFreeShippingCreate action (under Discount).
Fill in the fields below, then reference the result from later steps as {{discountcodefreeshippingcreate.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 DiscountCodeFreeShippingCreate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!) {
  discountCodeFreeShippingCreate(
    freeShippingCodeDiscount: $freeShippingCodeDiscount
  ) {
    codeDiscountNode {
      codeDiscount
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}

Variables

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

freeShippingCodeDiscountobjectrequired

The input data used to create the discount code.

combinesWithobject4 fields

titlestring

startsAtstring

endsAtstring

appliesOncePerCustomerboolean

codestring

customerSelectionobject3 fields

usageLimitnumber

contextobject4 fields

tagsarray<string>

minimumRequirementobject2 fields

destinationobject2 fields

maximumShippingPricestring

recurringCycleLimitnumber

appliesOnOneTimePurchaseboolean

appliesOnSubscriptionboolean

json

{
  "freeShippingCodeDiscount": {
    "combinesWith": {
      "productDiscounts": false,
      "orderDiscounts": false,
      "shippingDiscounts": false,
      "productDiscountsWithTagsOnSameCartLine": {
        "add": "string",
        "remove": "string"
      }
    },
    "title": "string",
    "startsAt": "string",
    "endsAt": "string",
    "appliesOncePerCustomer": false,
    "code": "string",
    "customerSelection": {
      "all": false,
      "customers": {
        "add": "string",
        "remove": "string"
      },
      "customerSegments": {
        "add": "string",
        "remove": "string"
      }
    },
    "usageLimit": 0,
    "context": {
      "all": "ALL",
      "customers": {
        "add": "string",
        "remove": "string"
      },
      "customerSegments": {
        "add": "string",
        "remove": "string"
      },
      "markets": {
        "add": "string",
        "remove": "string"
      }
    },
    "tags": [
      "string"
    ],
    "minimumRequirement": {
      "quantity": {
        "greaterThanOrEqualToQuantity": "string"
      },
      "subtotal": {
        "greaterThanOrEqualToSubtotal": "string"
      }
    },
    "destination": {
      "all": false,
      "countries": {
        "add": "string",
        "remove": "string",
        "includeRestOfWorld": "string"
      }
    }
  }
}

Response

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

codeDiscountNodeobject

codeDiscountobject33 fields

This field can return one of several different object shapes — properties from every possible shape are shown together.

idstring

userErrorsarray<object>

codeobject

extraInfoobject

fieldobject

messageobject

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

Was this page helpful?