Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
- POST
  Get Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

Discounts

Get Discounts

Gets applicable discounts for a transaction. The discounts are categorized as
1) Transaction-level discounts: Applied on the whole transaction. For example, if the transaction is for $100, the discount is applied by percentage or amount to the whole transaction amount. This category includes tier-specific discounts.
2) Item-level discounts: Applied on specific SKU so that discount percentage or amount is applied to specific product (regardless of the quantity).
3) Miscellaneous discounts - This category captures all other types of discounts.

POST

discounts

curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/discounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
  "entityReference": "Company_Club",
  "transactionTimestamp": "2020-02-08 09:30:26",
  "taxAmount": 1,
  "grossAmount": 6,
  "netAmount": 5,
  "transactionItems": [
    {
      "grossAmount": 6,
      "taxAmount": 1,
      "netAmount": 5,
      "categories": [
        "Proteins",
        "Adults"
      ],
      "itemName": "Whey",
      "itemPrice": 5,
      "itemQuantity": 1,
      "SKU": "123456"
    }
  ]
}'

{
  "status": 200,
  "message": "Created",
  "errors": {},
  "data": [
    {
      "grossAmount": 6,
      "taxAmount": 1,
      "netAmount": 4,
      "discounts": [
        {
          "type": "tier",
          "description": "20.0% discount from tier rule.",
          "value": 1,
          "id": 23,
          "ruleName": "tier-discount-rule",
          "discountPercentage": 20,
          "discountAmount": 1
        }
      ],
      "transactionItems": [
        {
          "SKU": "123456",
          "discounts": []
        }
      ],
      "miscellaneous": []
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

profileId

string

required

Profile ID of member

Example:

"67460e74-02e3-11e8-b443-00163e990bdb"

entityReference

string

required

External reference of the store where the transaction occurred

Minimum length: 1

Example:

"Company_Club"

transactionTimestamp

string

required

Transaction timestamp (UTC format)

Example:

"2020-02-08 09:30:26"

taxAmount

number

required

Tax amount

Example:

1

grossAmount

number

required

Gross amount of the transaction (before discount)

Example:

6

netAmount

number

required

Net amount of the transaction (after discount).

Example:

5

transactionItems

object[]

Item details

transactionItems.grossAmount

number

required

Transaction gross amount

Example:

6

transactionItems.netAmount

number

required

Net amount of transaction

Example:

5

transactionItems.categories

string[]

required

List of item categories

Example:

["Proteins", "Adults"]

transactionItems.itemPrice

integer

required

Item price

Example:

5

transactionItems.itemQuantity

integer

required

Item quantity

Example:

1

transactionItems.SKU

string

required

Stock Keeping Unit (SKU) of item

Required string length: 1 - 100

Example:

"123456"

transactionItems.taxAmount

number

Tax amount

Example:

1

transactionItems.itemName

string

Item name

Minimum length: 1

Example:

"Whey"

Response

200

application/json

Response of the Discounts API

status

integer

Status of the call

Example:

200

message

string

default:Exception message

Message corresponding to the call

Example:

"Created"

errors

object

Error details, if applicable

Example:

{}

data

object[]

data.grossAmount

number

Gross amount of transaction (before discount)

Example:

6

data.taxAmount

number

Tax amount on transaction

Example:

1

data.netAmount

number

Net amount of transaction (after discount).

Example:

4

data.discounts

object[]

data.transactionItems

object[]

data.transactionItems.SKU

string

Stock Keeping Unit (SKU) of item

Minimum length: 1

Example:

"123456"

data.transactionItems.discounts

object[]

Example:

[]

data.miscellaneous

object[]

Example:

[]

Was this page helpful?

Get Points to be Expired Rewards History

curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/discounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
  "entityReference": "Company_Club",
  "transactionTimestamp": "2020-02-08 09:30:26",
  "taxAmount": 1,
  "grossAmount": 6,
  "netAmount": 5,
  "transactionItems": [
    {
      "grossAmount": 6,
      "taxAmount": 1,
      "netAmount": 5,
      "categories": [
        "Proteins",
        "Adults"
      ],
      "itemName": "Whey",
      "itemPrice": 5,
      "itemQuantity": 1,
      "SKU": "123456"
    }
  ]
}'

{
  "status": 200,
  "message": "Created",
  "errors": {},
  "data": [
    {
      "grossAmount": 6,
      "taxAmount": 1,
      "netAmount": 4,
      "discounts": [
        {
          "type": "tier",
          "description": "20.0% discount from tier rule.",
          "value": 1,
          "id": 23,
          "ruleName": "tier-discount-rule",
          "discountPercentage": 20,
          "discountAmount": 1
        }
      ],
      "transactionItems": [
        {
          "SKU": "123456",
          "discounts": []
        }
      ],
      "miscellaneous": []
    }
  ]
}