Abra API: Discount types

discountValue sets what a discount gives. Its type picks one of the shapes below, and each shape has its own fields. The first eight run on Abra's discount functions and can be created and edited through the API. The last five are native Shopify discounts, which you can only attach with discountId. For how each one works in the Abra app, see Discount and Reward Types.

The type values, in the order they appear on this page:

• Gift: Gift with purchase

• BxgyDiscount: Buy X get Y

• DiscountMultiValueProduct: Different discount per product

• DiscountMultiValueCollection: Different discount per collection

• TieredDiscount: Tiered discount

• CollectionOrderDiscount: Order discount by collection

• MultiEffectTiers: Tiers with several rewards

• VolumeDiscount: Volume discount

• DiscountPercentage: Shopify percentage off

• DiscountAmount: Shopify amount off

• DiscountOnQuantity: Shopify discount on quantity

• DiscountCodeFreeShipping: Shopify free shipping

• BXGY: Shopify buy X get Y

Gift with purchase

type: Gift. Adds free gift products to the cart once it reaches prerequisite.minimumRequirement, which must be a subtotal or quantity above 0. Items covered by entitled count toward that minimum. products lists 1 to 10 gift products, and quantity is how many gifts the shopper earns (1 by default); with compound, they earn that many again each time the minimum is met again. Use discountClass PRODUCT and typeName DiscountAutomaticApp or DiscountCodeApp.

Example request body

A request body for Create a discount:

{
  "title": "Free gift with purchase",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "Gift",
    "quantity": 1,
    "products": [
      {
        "id": "gid://shopify/Product/123",
        "handle": "free-gift-product",
        "title": "Free Gift Product",
        "variants": [
          {
            "id": "gid://shopify/ProductVariant/456",
            "displayName": "Default Title"
          }
        ]
      }
    ],
    "compound": false,
    "countsTowardEligibility": false
  },
  "prerequisite": {
    "minimumRequirement": {
      "greaterThanOrEqualToSubtotal": {
        "amount": "50.00",
        "currencyCode": "USD"
      }
    }
  }
}

Buy X get Y

type: BxgyDiscount. Abra's buy X get Y. productCards lists up to 5 things the shopper must buy, each with items, a purchase type and a quantity or subtotal (requirementType). customerGets says what they get: a percentage off, an amount off, a fixed price or a free gift on the chosen items. Use discountClass PRODUCT and typeName DiscountAutomaticApp or DiscountCodeApp.

productCards[]

productCards[].minimumSubtotal

productCards[].items

productCards[].items.products[]

productCards[].items.products[].variants[]

productCards[].items.collections[]

customerGets

customerGets.productCards[]

customerGets.value

Example request body

A request body for Create a discount:

{
  "title": "Buy 2 get 1 free",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "BxgyDiscount",
    "requirementType": "QUANTITY",
    "productCards": [
      {
        "quantity": 2,
        "requirementType": "QUANTITY",
        "items": {
          "type": "AllProducts"
        },
        "purchaseType": "ONE_TIME"
      }
    ],
    "customerGets": {
      "applyToProductCardItems": true,
      "productCards": [
        {
          "quantity": 1,
          "items": {
            "type": "AllProducts"
          }
        }
      ],
      "value": {
        "type": "DiscountPercentage",
        "percentage": "100"
      }
    }
  }
}

Different discount per product

type: DiscountMultiValueProduct. Gives different products different discounts. Each entry in discounts picks products or collections (type), or variants by metafield when selectionMethod is metafield, and sets a percentage or amount off in value. Use discountClass PRODUCT and typeName DiscountAutomaticApp or DiscountCodeApp.

discounts[]

discounts[].collections[]

discounts[].products[]

discounts[].products[].variants[]

Example request body

A request body for Create a discount:

{
  "title": "Per-product discounts",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "DiscountMultiValueProduct",
    "selectionMethod": "product",
    "discounts": [
      {
        "type": "DiscountProducts",
        "products": [
          {
            "id": "gid://shopify/Product/123",
            "handle": "example-product",
            "variants": [
              {
                "id": "gid://shopify/ProductVariant/456",
                "displayName": "Default Title"
              }
            ]
          }
        ],
        "value": {
          "type": "DiscountPercentage",
          "percentage": "20"
        }
      }
    ]
  }
}

Different discount per collection

type: DiscountMultiValueCollection. Gives different collections different discounts. Each entry in discounts lists collections and the percentage or amount off in value. Use discountClass PRODUCT and typeName DiscountAutomaticApp or DiscountCodeApp.

discounts[]

discounts[].collections[]

Example request body

A request body for Create a discount:

{
  "title": "Per-collection discounts",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "DiscountMultiValueCollection",
    "discounts": [
      {
        "type": "DiscountCollection",
        "collections": [
          {
            "id": "gid://shopify/Collection/123",
            "handle": "summer-sale",
            "productsCount": 10
          }
        ],
        "value": {
          "type": "DiscountPercentage",
          "percentage": "15"
        }
      }
    ]
  }
}

Tiered discount

type: TieredDiscount. The reward grows as the cart grows. Each tier in discounts has a threshold in prerequisite.minimumRequirement (a subtotal or quantity) and gives a percentage or amount off (PERCENTAGE_OFF) or free gifts (FREE_GIFT). tiersType lists the reward kinds used and globalPrerequisite the threshold kinds. Thresholds and rewards must increase from tier to tier. entitled sets the products it covers. Use discountClass PRODUCT and typeName DiscountAutomaticApp or DiscountCodeApp.

discounts[]

discounts[].prerequisite

discounts[].value

Example request body

A request body for Create a discount:

{
  "title": "Spend more save more",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "TieredDiscount",
    "globalPrerequisite": [
      "SUBTOTAL"
    ],
    "tiersType": [
      "PERCENTAGE_OFF"
    ],
    "entitled": {
      "type": "AllDiscountItems",
      "all": true
    },
    "discounts": [
      {
        "type": "PERCENTAGE_OFF",
        "prerequisite": {
          "minimumRequirement": {
            "greaterThanOrEqualToSubtotal": {
              "amount": "50.00",
              "currencyCode": "USD"
            }
          }
        },
        "value": {
          "type": "DiscountPercentage",
          "percentage": "10"
        }
      }
    ]
  }
}

Order discount by collection

type: CollectionOrderDiscount. An order discount set up per collection. Each entry in discounts lists collections and the percentage or amount off in value. It's always saved with discountClass ORDER; use typeName DiscountAutomaticApp or DiscountCodeApp.

discounts[]

discounts[].collections[]

Example request body

A request body for Create a discount:

{
  "title": "10% off accessories collection",
  "discountClass": "ORDER",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "CollectionOrderDiscount",
    "discounts": [
      {
        "type": "DiscountCollections",
        "collections": [
          {
            "id": "gid://shopify/Collection/123",
            "handle": "accessories"
          }
        ],
        "value": {
          "type": "DiscountPercentage",
          "percentage": "10"
        }
      }
    ]
  }
}

Tiers with several rewards

type: MultiEffectTiers. Like a tiered discount, but each tier in tiers can combine several rewards: product discounts, an order discount, free shipping and gifts. Thresholds use globalPrerequisite (SUBTOTAL or QUANTITY) and must increase, and purchaseType is ONE_TIME_PURCHASE or SUBSCRIPTION. Send discountClass PRODUCT; the Shopify discount classes are set from the rewards you use. Use typeName DiscountAutomaticApp or DiscountCodeApp.

tiers[]

tiers[].prerequisite

tiers[].discounts[]

tiers[].discounts[].value[] when type is ProductDiscount

tiers[].discounts[].value[].value

tiers[].discounts[].value when type is GWPDiscount

tiers[].discounts[].value when type is OrderDiscount

tiers[].discounts[].value when type is FreeShippingDiscount

Example request body

A request body for Create a discount:

{
  "title": "Tiered discount with multiple effects",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "MultiEffectTiers",
    "globalPrerequisite": "SUBTOTAL",
    "purchaseType": "ONE_TIME_PURCHASE",
    "entitled": {
      "type": "AllDiscountItems",
      "all": true
    },
    "tiers": [
      {
        "prerequisite": {
          "minimumRequirement": {
            "greaterThanOrEqualToSubtotal": {
              "amount": "50.00",
              "currencyCode": "USD"
            }
          }
        },
        "discounts": [
          {
            "type": "ProductDiscount",
            "value": [
              {
                "entitled": {
                  "type": "AllDiscountItems",
                  "all": true
                },
                "value": {
                  "type": "DiscountPercentage",
                  "percentage": "10"
                },
                "quantity": 1
              }
            ]
          }
        ]
      }
    ]
  }
}

Volume discount

type: VolumeDiscount. Price breaks for buying more of the products in customerGets. Each tier in tiers has a threshold and a reward: a percentage off, an amount off each item, a fixed price or free gifts. With minimumPurchaseAmountPerProductVariant, the threshold is counted per product or per variant (minimumPurchaseScope) instead of across the cart. Use discountClass PRODUCT and typeName DiscountAutomaticApp or DiscountCodeApp.

customerGets

customerGets.products[]

customerGets.products[].variants[]

customerGets.collections[]

tiers[]

tiers[].prerequisite

tiers[].value

Example request body

A request body for Create a discount:

{
  "title": "Volume pricing",
  "discountClass": "PRODUCT",
  "typeName": "DiscountAutomaticApp",
  "discountValue": {
    "type": "VolumeDiscount",
    "globalPrerequisite": [
      "QUANTITY"
    ],
    "tiersType": [
      "PERCENTAGE_OFF"
    ],
    "compound": false,
    "customerGets": {
      "appliesTo": "ALL_PRODUCTS",
      "all": true
    },
    "minimumPurchaseAmountPerProductVariant": false,
    "tiers": [
      {
        "prerequisite": {
          "minimumRequirement": {
            "greaterThanOrEqualToQuantity": 5
          }
        },
        "value": {
          "type": "DiscountPercentage",
          "percentage": "10"
        }
      }
    ]
  }
}

Shopify percentage off

type: DiscountPercentage. A native Shopify amount-off discount that takes a percentage off, set in percentage as a string such as 10. Its typeName is DiscountCodeBasic or DiscountAutomaticBasic. Native discounts can't be created or edited through the API: attach an existing Shopify discount with discountId.

Shopify amount off

type: DiscountAmount. A native Shopify amount-off discount that takes a fixed amount off, set in discountAmount, or off each item when appliesOnEachItem is true. Its typeName is DiscountCodeBasic or DiscountAutomaticBasic. Native discounts can't be created or edited through the API: attach an existing Shopify discount with discountId.

Shopify discount on quantity

type: DiscountOnQuantity. A native Shopify discount on a number of items: quantity items get the effect, a percentage or an amount off. Its typeName is DiscountCodeBasic or DiscountAutomaticBasic. Native discounts can't be created or edited through the API: attach an existing Shopify discount with discountId.

Shopify free shipping

type: DiscountCodeFreeShipping. A native Shopify free shipping discount. It has no other fields. Its typeName is DiscountCodeFreeShipping or DiscountAutomaticFreeShipping. Native discounts can't be created or edited through the API: attach an existing Shopify discount with discountId.

Shopify buy X get Y

type: BXGY. Shopify's own buy X get Y. customerBuys sets the items and the quantity or purchase amount the shopper must buy, and customerGets the items they get and the discount on them. Its typeName is DiscountCodeBxgy or DiscountAutomaticBxgy. Native discounts can't be created or edited through the API: attach an existing Shopify discount with discountId.

customerBuys

customerBuys.items

customerBuys.items.collections[]

customerBuys.value when type is DiscountPurchaseAmount

customerBuys.value when type is DiscountQuantity

customerGets

Shared objects

These objects appear in more than one discount type. Each is described once here.

Entitled items

Used by the Tiered discount and Tiers with several rewards types.

collections[]

Entry value

Used by the Different discount per product, Different discount per collection and Order discount by collection types.

Free gift settings

Used by the Gift with purchase, Buy X get Y, Tiered discount, Tiers with several rewards and Volume discount types.

Gift product

Used by the Gift with purchase, Tiered discount, Tiers with several rewards and Volume discount types.

variants[]

Metafield selection

Used by the Buy X get Y, Different discount per product, Tiered discount, Tiers with several rewards and Volume discount types.

Money

Used by the Buy X get Y, Different discount per product, Different discount per collection, Tiered discount, Order discount by collection, Tiers with several rewards, Volume discount and Shopify amount off types.

Tier threshold

Used by the Tiered discount, Tiers with several rewards and Volume discount types.

greaterThanOrEqualToSubtotal

This page is generated from the Abra API specification (build bc96ccc) · ref 51d894041a08. Edits made in Pylon are overwritten.