Data Integration

Data Models

11min
category any kind of category defined by the app this represents the following structure { "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 { "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 { "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) { "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 { "id" "foo 123456", "name" "avengers endgame", "category" { "id" "2342", "name" "movies" }, "ispaid" true, "hastrial" false } address an address object represents the following format { "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 { "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) { "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