Data Integration
Data Models

11min
Category
Any kind of category defined by the app. This represents the following structure-
JSON
{
    "id": "1234",
    "name": "CATEGORY_NAME"
}
{
    "id": "1234",
    "name": "CATEGORY_NAME"
}
﻿
id- Id of the Category in string format.
name- Name of the category in string format.
Tag
Any kind of tags defined by the app. This represents the following structure-
JSON
{
    "id": "1234",
    "name": "TAG_NAME"
}
{
    "id": "1234",
    "name": "TAG_NAME"
}
﻿
id- Id of the Tag in string format.
name- Name of the Tag in string format.
Item
The item object represents a product/content as described in Terminologies. The Item represents the following structure
JSON
{
   "id": "FOO-123456",
   "name": "Avengers: Endgame",
   "category": {
       "id": "2342",
       "name": "Movies"
   }
}
{
   "id": "FOO-123456",
   "name": "Avengers: Endgame",
   "category": {
       "id": "2342",
       "name": "Movies"
   }
}
﻿
Cart Item
The CartItem object represents an Item along with quantity. This represents the following structure (showing as JSON)-
JSON
{
   "id": "FOO-123456",
   "name": "Avengers: Endgame",
   "category": {
       "id": "2342",
       "name": "Movies"
   },
   "quantity": 2
}
{
   "id": "FOO-123456",
   "name": "Avengers: Endgame",
   "category": {
       "id": "2342",
       "name": "Movies"
   },
   "quantity": 2
}
﻿
Premium Item
This type of Item represents a consumable/premium item which does not have access to all the users or may be locked. This extends the Item.
JSON
{
   "id": "FOO-123456",
   "name": "Avengers: Endgame",
   "category": {
       "id": "2342",
       "name": "Movies"
   },
   "isPaid": true,
   "hasTrial": false
}
{
   "id": "FOO-123456",
   "name": "Avengers: Endgame",
   "category": {
       "id": "2342",
       "name": "Movies"
   },
   "isPaid": true,
   "hasTrial": false
}
﻿
Address
An address object represents the following format-
JSON
{
    "l1": 'Kenner Group Inc',
    "l2": '85 Bradford Lane',
    "city": 'Vincentown',
    "country": "United States of America",
    "countryCode": "US",
    "state": 'New Jersey',
    "stateCode": "NJ",
    "zip": "08120"
}
{
    "l1": 'Kenner Group Inc',
    "l2": '85 Bradford Lane',
    "city": 'Vincentown',
    "country": "United States of America",
    "countryCode": "US",
    "state": 'New Jersey',
    "stateCode": "NJ",
    "zip": "08120"
}
﻿
l1- Line 1 of the address.
l2- Line 2 of the address.
city- City of the address.
country- Full country name.
countryCode- Abbr. country code.
state- Full state name.
stateCode- Abbr. state code.
zip- Zipcode of the address.
Amount
An amount object represents the following format-
JSON
{
   "value": 1134.50,
   "currency": "USD"
}
{
   "value": 1134.50,
   "currency": "USD"
}
﻿
value- The amount in number format.
currency- Any 3-character ISO currency code. For example- INR, USD, BRL, GBP. You can find more on Wikipedia.
Coupon
Any applied coupon (for events) or any coupon to apply (for CTAs).
JSON
{
   "id": "FOO-12345",
   "code": "FREE20",
   "amount": 20.0,
   "discountType": "percent",
}
{
   "id": "FOO-12345",
   "code": "FREE20",
   "amount": 20.0,
   "discountType": "percent",
}
﻿
code- The actual coupon code that the user will use.
amount- The amount of discount to offer.
discountType- Applicable values- percent, fixed_cart, fixed_product.
﻿
Updated 25 Mar 2024
Did this page help you?
Push Notification
Mandatory Events