The TellaFriend API provides a rich solution for clients who wish to integrate a referral program into an online store. \nIntegrating the TellaFriend API with your own backend system enables a seamless integration of a powerful referral program with your store.
\n| Authorization | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| OAuth2 | \nAccess Token | \nencrypted string that provides permissions | \n
| Parámetro | \nDescripción | \n
|---|---|
| errorCode | \nString Code that identify the error | \n
| errorMessage | \nString International error message depends on the header on the request of the regional se | \n
| errorDetail | \nString Detail of the error | \n
| httpStatus | \nString List of codes for answer request status of the HyperText Transference Protocol (HTTP).\n200 - Success Response\n201 - Created\n400 - Bad Request\n404 - Not Found\n500 - Internal Server Error\n | \n
| errorOrigin | \nString Service where error was originated | \n
String (Required)\ntype of provider
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en/es"}],"body":{"mode":"raw","raw":"{\n\t\"fullName\": \"Documentation Proof3\",\n\t\"firstName\": \"Proof3\",\n\t\"lastName\": \"Proof3\",\n\t\"mobileNumber\": \"1256213789\",\n\t\"email\": \"proof3@proof3.com\",\n\t\"password\": \"proof3\",\n\t\"storeUrl\": \"http://proof3.com\",\n\t\"storeName\": \"Proofs3\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tellafriend.club/tellafriend/api/merchant","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| ecommerceProvider | \nDEFAULT | \nString (Required) It is defined if it is the default store | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| VALUE | \nDESCRIPTION | \n
|---|---|
| fullName | \nString Full name of the user | \n
| firstName | \nString First name of the user | \n
| lastName | \nString Last name of the user | \n
| mobileNumber | \nString Mobile number of the user | \n
| String Email address of the user | \n|
| password | \nString Account password | \n
| storeUrl | \nString Store URL | \n
| storeName | \nString Store Name | \n
| VALUE | \nDESCRIPTION | \n
|---|---|
| apiKey | \n String The API Key of the username of the account. It’s a randomly generated STRING of 32 characters | \n
| apiSecret | \nString The API password of the account (Secret). It’s a numeric random STRING of 16 characters | \n
| merchantId | \n String ID Store | \n
String (Required) \nThe API Key of the username of the account. It’s a randomly generated STRING of 32 characters
\n","key":"apikey","type":"text","value":"{{Api Key}}"},{"description":"String (Required)\nThe API password of the account (Secret). It’s a numeric random STRING of 16 characters.
\n","key":"apiSecret","type":"text","value":"{{Api Secret}}"},{"description":"String (Required)\nSecurity value
\n","key":"grant_type","type":"text","value":"api"}]},"url":"https://api.tellafriend.club/api/security/oauth/token","description":"| Username | \nTAF | \n
| Password | \nTAF | \n
| VALUES | \nDESCRIPTION | \n
|---|---|
| apikey | \nString The API Key of the username of the account. It’s a randomly generated STRING of 32 characters | \n
| apiSecret | \nString The API password of the account (Secret). It’s a numeric random STRING of 16 characters | \n
| grant_type | \nString The ID store of the users | \n
| VALUE | \nDESCRIPTION | \n
|---|---|
| access_token | \nString Token to make request | \n
| token_type | \nString Token Type | \n
| refresh_token | \nString Token to generate additional access tokens | \n
| expired_in | \nint Time in seconds for the token to expire | \n
| scope | \nString Permissions that the token has | \n
| jti | \nString Identification token for the JWT library | \n
String (Required)\ntype of provider
\n","type":"text"},{"key":"language","value":"en / es","description":"String (Opcional)\nLanguage of the answer
\n","type":"text"}],"url":"https://api.tellafriend.club/tellafriend/api/merchant/status","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| ecommerceProvider | \nDEFAULT | \nString (Required) It is defined if it is the store by default | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| VALUE | \nDESCRIPTION | \n|
|---|---|---|
| createdOn | \n String Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ' Account creation date | \n|
| advocates | \nboolean Indicates if the advocates are configured | \n|
| friends | \nboolean Indicates if friends are configured | \n|
| referralProgramStyle | \nboolean Indicates if styles are configured | \n\n |
| activeReferralProgram | \n boolean Indicates if the referral program is active | \n
String (Required)\ntype of provider
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates","urlObject":{"protocol":"https","path":["api","merchant","advocates"],"host":["api","tellafriend","club"],"query":[],"variable":[]}},"response":[{"id":"36e09e4e-710b-4a02-aacd-9b90b3c57751","name":"Advocate","originalRequest":{"method":"GET","header":[{"description":"String (Required)\ntype of provider","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"advocateId\": \"5e7509aa8a2fc54a54d45c3c\",\n \"merchantName\": null,\n \"merchantUrl\": \"https://imranmomin.com\",\n \"shareUrl\": \"https://json.com/a=5e7509aa8a2fc54a54d45c3c\",\n \"shortShareUrl\": \"pre.go4clients.com/DAVIDSANTANARINCO7@56.am\",\n \"discountShopUrl\": \"https://imranmomin.com\",\n \"shortUrlCode\": null,\n \"discountCode\": \"NO_CODE\",\n \"advocate\": {\n \"createdOn\": \"2020-03-20T18:21:30.825+0000\",\n \"lastUpdate\": \"2020-03-20T18:21:30.825+0000\",\n \"firstName\": \"david Advocate\",\n \"lastName\": \"Rincon\",\n \"fullName\": \"david Advocate\",\n \"mobileNumber\": \"57301224877\",\n \"email\": \"DAVIDSANTANARINCO7@56.am\"\n }\n },\n {\n \"advocateId\": \"5e7509aa8a2fc54a54d45c3c\",\n \"merchantName\": null,\n \"merchantUrl\": \"https://imranmomin.com\",\n \"shareUrl\": \"https://json.com/a=5e7509aa8a2fc54a54d45c3c\",\n \"shortShareUrl\": \"pre.go4clients.com/DAVIDSANTANARINCO7@56.am\",\n \"discountShopUrl\": \"https://imranmomin.com\",\n \"shortUrlCode\": null,\n \"discountCode\": \"NO_CODE\",\n \"advocate\": {\n \"createdOn\": \"2020-03-20T18:21:30.825+0000\",\n \"lastUpdate\": \"2020-03-20T18:21:30.825+0000\",\n \"firstName\": \"david Advocate\",\n \"lastName\": \"Rincon\",\n \"fullName\": \"david Advocate\",\n \"mobileNumber\": \"57301224877\",\n \"email\": \"DAVIDSANTANARINCO7@56.am\"\n }\n }\n]"}],"_postman_id":"d8cf83b7-720f-49c0-8bac-5633313eaf1d"},{"name":"Get advocate by Id","id":"96f62e0e-0b41-456b-aeea-e55758cf6713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"description":"String (Required)\ntype of provider
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates/{id}","urlObject":{"protocol":"https","path":["api","merchant","advocates","{id}"],"host":["api","tellafriend","club"],"query":[],"variable":[]}},"response":[{"id":"841457ac-e491-40ce-8baf-8f7756dc8098","name":"Advocate by Id","originalRequest":{"method":"GET","header":[{"description":"String (Required)\ntype of provider","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates/{id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"advocateId\": \"5e7509aa8a2fc54a54d45c3c\",\n\t\"merchantName\": null,\n\t\"merchantUrl\": \"https://imranmomin.com\",\n\t\"shareUrl\": \"https://json.com/a=5e7509aa8a2fc54a54d45c3c\",\n\t\"shortShareUrl\": \"pre.go4clients.com/DAVIDSANTANARINCO7@56.am\",\n\t\"discountShopUrl\": \"https://imranmomin.com\",\n\t\"shortUrlCode\": null,\n\t\"discountCode\": \"NO_CODE\",\n\t\"advocate\": {\n\t\t\"createdOn\": \"2020-03-20T18:21:30.825+0000\",\n\t\t\"lastUpdate\": \"2020-03-20T18:21:30.825+0000\",\n\t\t\"firstName\": \"david Advocate\",\n\t\t\"lastName\": \"Rincon\",\n\t\t\"fullName\": \"david Advocate\",\n\t\t\"mobileNumber\": \"57301224877\",\n\t\t\"email\": \"DAVIDSANTANARINCO7@56.am\"\n\t}\n}"}],"_postman_id":"96f62e0e-0b41-456b-aeea-e55758cf6713"},{"name":"Create advocate","id":"09490280-ac94-47a6-af05-d8e538fa9049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"String (Required)\ntype of provider
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}","description":"Token (Reuqeried)
\n"}],"url":"https://api.tellafriend.club/api/merchant/advocates","urlObject":{"protocol":"https","path":["api","merchant","advocates"],"host":["api","tellafriend","club"],"query":[],"variable":[]}},"response":[{"id":"baf50c3e-9dc2-4bdc-8954-e88da3b08dc9","name":"Advocate POST/PUT","originalRequest":{"method":"POST","header":[{"description":"String (Required)\ntype of provider","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"body":{"mode":"raw","raw":"{\n\t\"advocate\": {\n\t\t\"firstName\": \"david Advocate\",\n\t\t\"lastName\": \"Rincon\",\n\t\t\"fullName\": \"david Advocate\",\n\t\t\"mobileNumber\": \"57301224877\",\n\t\t\"email\": \"DAVIDSANTANARINCO7@56.am\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tellafriend.club/api/merchant/advocates"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"advocateId\": \"5e7509aa8a2fc54a54d45c3c\",\n \"merchantName\": null,\n \"merchantUrl\": \"https://imranmomin.com\",\n \"shareUrl\": \"https://json.com/a=5e7509aa8a2fc54a54d45c3c\",\n \"shortShareUrl\": \"pre.go4clients.com/DAVIDSANTANARINCO7@56.am\",\n \"discountShopUrl\": \"https://imranmomin.com\",\n \"shortUrlCode\": null,\n \"discountCode\": \"NO_CODE\",\n \"advocate\": {\n \"createdOn\": \"2020-03-20T18:21:30.825+0000\",\n \"lastUpdate\": \"2020-03-20T18:21:30.825+0000\",\n \"firstName\": \"david Advocate\",\n \"lastName\": \"Rincon\",\n \"fullName\": \"david Advocate\",\n \"mobileNumber\": \"57301224877\",\n \"email\": \"DAVIDSANTANARINCO7@56.am\"\n }\n}"}],"_postman_id":"09490280-ac94-47a6-af05-d8e538fa9049"},{"name":"Edit advocate","id":"47e85324-340c-4a9f-b81c-b864deb48d46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"description":"String (Required)\ntype of provider
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates","urlObject":{"protocol":"https","path":["api","merchant","advocates"],"host":["api","tellafriend","club"],"query":[],"variable":[]}},"response":[{"id":"54158aaa-ff18-4534-89fe-074d56b8107f","name":"Advocate POST/PUT","originalRequest":{"method":"POST","header":[{"description":"String (Required)\ntype of provider","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"body":{"mode":"raw","raw":"{\n\t\"advocate\": {\n\t\t\"firstName\": \"david Advocate\",\n\t\t\"lastName\": \"Rincon\",\n\t\t\"fullName\": \"david Advocate\",\n\t\t\"mobileNumber\": \"57301224877\",\n\t\t\"email\": \"DAVIDSANTANARINCO7@56.am\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tellafriend.club/api/merchant/advocates"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"advocateId\": \"5e7509aa8a2fc54a54d45c3c\",\n \"merchantName\": null,\n \"merchantUrl\": \"https://imranmomin.com\",\n \"shareUrl\": \"https://json.com/a=5e7509aa8a2fc54a54d45c3c\",\n \"shortShareUrl\": \"pre.go4clients.com/DAVIDSANTANARINCO7@56.am\",\n \"discountShopUrl\": \"https://imranmomin.com\",\n \"shortUrlCode\": null,\n \"discountCode\": \"NO_CODE\",\n \"advocate\": {\n \"createdOn\": \"2020-03-20T18:21:30.825+0000\",\n \"lastUpdate\": \"2020-03-20T18:21:30.825+0000\",\n \"firstName\": \"david Advocate\",\n \"lastName\": \"Rincon\",\n \"fullName\": \"david Advocate\",\n \"mobileNumber\": \"57301224877\",\n \"email\": \"DAVIDSANTANARINCO7@56.am\"\n }\n}"}],"_postman_id":"47e85324-340c-4a9f-b81c-b864deb48d46"},{"name":"Delete advocate","id":"abb83a18-52eb-4868-82d6-f5e37bd0d83b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"description":"String (Required)\ntype of provider
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates","urlObject":{"protocol":"https","path":["api","merchant","advocates"],"host":["api","tellafriend","club"],"query":[],"variable":[]}},"response":[{"id":"bb1fecee-6020-4295-a4a8-64232a794cbf","name":"Advocate","originalRequest":{"method":"DELETE","header":[{"description":"String (Required)\ntype of provider","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Opcional)\nLanguage of the answer","key":"language","type":"text","value":"en/es"},{"key":"Authorization","type":"text","value":"Bearer {$token}"}],"url":"https://api.tellafriend.club/api/merchant/advocates/{id}"},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"abb83a18-52eb-4868-82d6-f5e37bd0d83b"}],"id":"4cfb1228-dc39-4de3-b557-915e19a68463","description":"for this advocates API, just send the basic data of the advocate as email, name, phone number. The response you will receive will contain data such as the generated discount code, shortlink, store url, among others.
\n","event":[{"listen":"prerequest","script":{"id":"62f4b211-5ddb-4966-a19e-ae68c21fe9ad","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c651a3a-8c14-406c-84e3-9b735c85b286","type":"text/javascript","exec":[""]}}],"_postman_id":"4cfb1228-dc39-4de3-b557-915e19a68463"},{"name":"Discounts","item":[{"name":"Get Discounts","id":"956e9c42-61c3-4d3e-a91a-ff1ddfb49e1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"language","value":"en / es","description":"String (Optional)\nLanguage of the answer
\n","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTgzOTQwMTgsInVzZXJfbmFtZSI6ImpvcmdlLnBlcmV6QHRlbGludGVsLm5ldCIsImF1dGhvcml0aWVzIjpbIlRBRl9BRE1JTiJdLCJqdGkiOiIzYzliZmIxNC0wMTcxLTQ1M2YtODY1ZS0zMWI1OTE0NmU0OWEiLCJjbGllbnRfaWQiOiJUQUYiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXX0.tCaBwvUAdNW9cZ0Fu0FU_VW5NQQYeusyO2giDDeqKM8","description":"Token (Reuqeried)
\n","type":"text"}],"url":"http://10.170.3.226:9020/api/merchant/discounts/newdiscounts?fromDate=2019-09-25T00:00:00.000-0000&toDate=2020-09-25T00:00:00.000-0000&ecommerceProvider=DEFAULT","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| Authorization | \nBearer {$token} | \nToke (Required) | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| KEY | \nDESCRIPTION | \n
|---|---|
| ecommerceProvider | \nDEFAULT String (Optional) It is defined if it is the store by default\n |
| fromDate | \nTimestamp (Required) Format :yyyy-MM-dd'T'HH:mm:ss.SSSZ Discount start date\n |
| fromDate | \nTimestamp (Required) Format :yyyy-MM-dd'T'HH:mm:ss.SSSZ Discount end date | \n
| VALUE | \nDESCRIPTION | \n||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| createdOn | \nString Date when the discount was created | \n||||||||||||||||||||||||||||||||
| discountCode | \nString Discount code value | \n||||||||||||||||||||||||||||||||
| merchantUrl | \nStore URL | \n||||||||||||||||||||||||||||||||
| discountType | \nReferralProgramRewardType *It only applies for advocates \n
| \n||||||||||||||||||||||||||||||||
| value | \ndouble Purchase value | \n||||||||||||||||||||||||||||||||
| maximumOrderAmount | \ndouble Maximum order amount applied for the discoun | \n||||||||||||||||||||||||||||||||
| minimumOrderAmount | \ndouble Minimum order amount applied for the discount | \n||||||||||||||||||||||||||||||||
| maxRedemptions | \nint Maximum times that a reward can be reddem by an advocate | \nredemptionCounter | \nint \nNumber of times the code was redeemed | \n
Toke (Required)
\n","type":"text"}],"url":"https://api.tellafriend.club/tellafriend/api/api/merchant/discounts/v2.0?discountCode=mycodetest","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| Authorization | \nBearer {$token} | \nToke (Required) | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| KEY | \nDESCRIPTION | \n
|---|---|
| discountCode | \nString(Required) \ndiscount code you want to evaluate\n |
| KEY | \nDESCRIPTION | \n
|---|---|
| discountCode | \nString \nDiscount code you want to evaluate\n |
| merchantId | \nString \nId of the associated store\n |
| purchaseAmount | \nDouble \nPurchase amount of this discount code\n |
| valid | \nBoolean \nAnswer true or false if the code is valid\n |
String (Required)\nIt should be set to DEFAULT
\n","key":"ecommerceProvider","type":"text","value":"DEFAULT"},{"description":"String (Optional)\nLanguage of the answer
\n","key":"language","type":"text","value":"en / es"},{"description":"String (Required)
\n","key":"Authorization","type":"text","value":"Bearer {$token}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100.1,\n \"totalProductsAmount\": 2,\n \"shippingValue\": 9.1,\n \"taxValue\": 0,\n \"code\" : {{Discount Code}},\n \"buyer\": {\n \"firstName\": \"advocate\",\n \"lastName\": \"advocate\",\n \"fullName\": \"advocate\",\n \"mobileNumber\": \"573155014556\",\n \"email\": \"advocate@prueba.com\",\n \"address\": \"calle 1234\",\n \"gender\": \"M\",\n \"age\": \"23\",\n \"country\": \"Colombia\",\n \"ipAddress\": \"10.170.2.2\",\n \"city\": \"Bogota\",\n \"operativeSystem\": \"Windows\",\n \"browser\": \"google\",\n \"device\": \"phone\"\n },\n \"products\": [{\n \"name\": \"camisa\",\n \"category\": \"ropa\"\n }],\n \"discountApplication\":[ {\n \"value\": 10,\n \"code\": {{Discount Code}},\n \"type\": \"STORE_DISCOUNT\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tellafriend.club/tellafriend/api/merchant/conversions/processconversion","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| ecommerceProvider | \nDEFAULT | \nString (Optional) It is defined if it is the store by default | \n
| Authorization | \nBearer {$token} | \nToke (Required) | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| VALUE | \nDESCRIPTION | \n||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| discountApplication | \nConversionDiscountApplicationVO (Required) It is a list of discounts applied\n
| ||||||||||||||||||||||||||||||
| totalAmount | \ndouble (Optional) Total amount billed\n | \n||||||||||||||||||||||||||||||
| totalProductsAmout | \ndouble (Optional) the sum of the total cost of the purchased product | \n||||||||||||||||||||||||||||||
| shippingValue | \ndouble (Optional) Shipping value | \n||||||||||||||||||||||||||||||
| taxValue | \ndouble (Optional) Tax value | \n||||||||||||||||||||||||||||||
| code | \ndouble (Required) Advocate’s code | \n||||||||||||||||||||||||||||||
| buyer | \nConversionBuyerV0 (Required) Buyer information \n
| \n||||||||||||||||||||||||||||||
| products | \nConversionProductVO\n
| \n||||||||||||||||||||||||||||||
| orderId | \nint (Opcional) Transaction ID | \n
200 OK
\n\nString (Required)\nIt should be set to DEFAULT
\n","type":"text"},{"key":"language","value":"en / es","description":"String (Optional)\nLanguage of the answer
\n","type":"text"}],"url":"https://api.tellafriend.club/tellafriend/api/merchant/conversions/processconversion/url?totalAmount=10.0&totalProductsAmount=2&shippingValue=9.1&taxValue=9.1&code={{Discount Code}}&firstName=advocate&lastName=advocate&fullName=advocate&mobileNumber=573155014556&email=advocate@prueba.com&address=prueba&gender=M&age=19&country=prueba&ipAddress=prueba&city=prueba&operativeSystem=prueba&browser=prueba&device=prueba&discountCode={{Discount code}}&orderId=prueba","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| ecommerceProvider | \nDEFAULT | \nString (RequIRED) It is defined if it is the store by default | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| KEY | \nDESCRIPTION | \n
|---|---|
| totalAmount | \ndouble (Optional) Total amount of the purchase. | \n
| totalProductsAmount | \ndouble (Optional) Total products | \n
| shippingValue | \ndouble (Optional) Shipping value | \n
| taxValue | \ndouble (Optional) Tax value | \n
| code | \nString(Optional) Advocate discount code | \n
| firstName | \nString(Optional) Buyer's first name | \n
| lastName | \nString(Optional) Buyer's last name | \n
| fullName | \nString(Optional) Buyer's full name | \n
| mobileNumber | \nString(Required) Buyer's mobile number | \n
| String(Required) Buyer's email | \n|
| address | \nString(Optional) Buyer's physical address | \n
| gender | \nString(Optional) Buyer's gender | \n
| age | \nString(Optional) Buyer's age | \n
| country | \nString(Optional) Country where buyer is based | \n
| ipAddress | \nString(Optional) Buyer's IP address | \n
| city | \nString(Optional) City where buyer is based | \n
| operativeSystem | \nString(Optional) Buyer's Operative system | \n
| browser | \nString(Optional) Buyer's browser | \n
| device | \nString(Optional) Buyer's device | \n
| discountCode | \nString(Required) Advocate discount code | \n
| orderId | \nString(Required) Transaction ID | \n
| VALUE | \nDESCRIPTION | \n||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| discountCode | \nString Advocate discount code\n | ||||||||||||||||||||||||||||||
| totalAmount | \ndouble Total amount billed\n | \n||||||||||||||||||||||||||||||
| totalProductsAmout | \ndouble the sum of the total cost of the purchased product | \n||||||||||||||||||||||||||||||
| shippingValue | \ndouble Shipping value | \n||||||||||||||||||||||||||||||
| taxValue | \ndouble Tax value | \n||||||||||||||||||||||||||||||
| discountAmount | \ndouble Discount Amount | \n||||||||||||||||||||||||||||||
| buyer | \nBuyer information \n
| \n||||||||||||||||||||||||||||||
| successfulOperation | \nboolean Indicates if the process was successful | \n
double (Optional)\nTotal Amount of the purchase
\n","type":"text/plain"},"key":"totalAmount","value":"10.0"},{"description":{"content":"double(Optional)\nTotal Products
\n","type":"text/plain"},"key":"totalProductsAmount","value":"2"},{"description":{"content":"double(Optional)\nShipping value
\n","type":"text/plain"},"key":"shippingValue","value":"9.1"},{"description":{"content":"double (Optional)\nTax Value
\n","type":"text/plain"},"key":"taxValue","value":"9.1"},{"description":{"content":"String (Optional)\nAdvocate's discount code
\n","type":"text/plain"},"key":"code","value":"{{Discount Code}}"},{"description":{"content":"String (Optional)\nBuyer's first name
\n","type":"text/plain"},"key":"firstName","value":"advocate"},{"description":{"content":"String (Optional)\nBuyer's last name
\n","type":"text/plain"},"key":"lastName","value":"advocate"},{"description":{"content":"String (Optional)\nBuyer's full name
\n","type":"text/plain"},"key":"fullName","value":"advocate"},{"description":{"content":"String (Required)\nBuyer's mobile number
\n","type":"text/plain"},"key":"mobileNumber","value":"573155014556"},{"description":{"content":"String (Required)\nBuyer's email
\n","type":"text/plain"},"key":"email","value":"advocate@prueba.com"},{"description":{"content":"String (Optional)\nBuyer's physical address
\n","type":"text/plain"},"key":"address","value":"prueba"},{"description":{"content":"String (Optional)\nGender of the buyer
\n","type":"text/plain"},"key":"gender","value":"M"},{"description":{"content":"String (Optional)\nAge of the buyer
\n","type":"text/plain"},"key":"age","value":"19"},{"description":{"content":"String (Optional)\nCountry where buyer is based
\n","type":"text/plain"},"key":"country","value":"prueba"},{"description":{"content":"String (Optional)\nIP address of the buyer
\n","type":"text/plain"},"key":"ipAddress","value":"prueba"},{"description":{"content":"String (Optional)\nCity where buyer is based
\n","type":"text/plain"},"key":"city","value":"prueba"},{"description":{"content":"String (Optional)\nBuyer's operative system
\n","type":"text/plain"},"key":"operativeSystem","value":"prueba"},{"description":{"content":"String (Optional)\nBuyer's browser
\n","type":"text/plain"},"key":"browser","value":"prueba"},{"description":{"content":"String (Optional)\nBuyer's device
\n","type":"text/plain"},"key":"device","value":"prueba"},{"description":{"content":"String (Required)\nAdvocate's discount code
\n","type":"text/plain"},"key":"discountCode","value":"{{Discount code}}"},{"description":{"content":"int (Optional)\nTransaction ID
\n","type":"text/plain"},"key":"orderId","value":"prueba"}],"variable":[]}},"response":[{"id":"3fb153d2-40b1-4932-a701-62df6114475d","name":"Send Conversion URL","originalRequest":{"method":"POST","header":[{"key":"ecommerceProvider","value":"DEFAULT","description":"String (Optional)\nIt should be set to DEFAULT","type":"text"},{"key":"language","value":"en / es","description":"String (Optional)\nLanguage of the answer","type":"text"}],"url":{"raw":"https://api.tellafriend.club/tellafriend/api/merchant/conversions/processconversion/url?totalAmount=10.0&totalProductsAmount=2&shippingValue=9.1&taxValue=9.1&code={{Discount Code}}&firstName=advocate&lastName=advocate&fullName=advocate&mobileNumber=573155014556&email=advocate@prueba.com&address=prueba&gender=M&age=19&country=prueba&ipAddress=prueba&city=prueba&operativeSystem=prueba&browser=prueba&device=prueba&discountCode={{Discount Code}}&orderId=123","protocol":"https","host":["api","tellafriend","club"],"path":["tellafriend","api","merchant","conversions","processconversion","url"],"query":[{"key":"totalAmount","value":"10.0","description":"double (Optional)\nTotal Amount of the purchase"},{"key":"totalProductsAmount","value":"2","description":"double(Optional)\nTotal Products"},{"key":"shippingValue","value":"9.1","description":"double(Optional)\nShipping value"},{"key":"taxValue","value":"9.1","description":"double (Optional)\nTax Value"},{"key":"code","value":"{{Discount Code}}","description":"String (Required)\nAdvocate's discount code"},{"key":"firstName","value":"advocate","description":"String (Optional)\nBuyer's first name"},{"key":"lastName","value":"advocate","description":"String (Optional)\nBuyer's last name"},{"key":"fullName","value":"advocate","description":"String (Optional)\nBuyer's full name"},{"key":"mobileNumber","value":"573155014556","description":"String (Required)\nBuyer's mobile number"},{"key":"email","value":"advocate@prueba.com","description":"String (Required)\nBuyer's email"},{"key":"address","value":"prueba","description":"String (Optional)\nBuyer's physical address"},{"key":"gender","value":"M","description":"String (Optional)\nGender of the buyer"},{"key":"age","value":"19","description":"String (Optional)\nAge of the buyer"},{"key":"country","value":"prueba","description":"String (Optional)\nCountry where buyer is based\n"},{"key":"ipAddress","value":"prueba","description":"String (Optional)\nIP address of the buyer"},{"key":"city","value":"prueba","description":"String (Optional)\nCity where buyer is based"},{"key":"operativeSystem","value":"prueba","description":"String (Optional)\nBuyer's operative system"},{"key":"browser","value":"prueba","description":"String (Optional)\nBuyer's browser"},{"key":"device","value":"prueba","description":"String (Optional)\nBuyer's device"},{"key":"discountCode","value":"{{Discount Code}}","description":"String (Required)\nAdvocate's discount code"},{"key":"orderId","value":"123","description":"int (Optional)\nTransaction ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 10 Mar 2020 22:25:22 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"discoundCode\": {{Discount Code}},\n \"totalAmount\": 10,\n \"totalProductsAmount\": 2,\n \"shippingValue\": 9.1,\n \"taxValue\": 9.1,\n \"discountAmount\": 1,\n \"buyer\": {\n \"firstName\": \"advocate\",\n \"lastName\": \"advocate\",\n \"fullName\": \"advocate\",\n \"mobileNumber\": \"573155014556\",\n \"email\": \"advocate@prueba.com\",\n \"address\": \"prueba\",\n \"gender\": \"M\",\n \"age\": \"19\",\n \"country\": \"prueba\",\n \"ipAddress\": \"prueba\",\n \"city\": \"prueba\",\n \"operativeSystem\": \"prueba\",\n \"browser\": \"prueba\",\n \"device\": \"prueba\"\n },\n \"successfulOperation\": false\n}"}],"_postman_id":"cd2c622f-b6fd-4327-b63e-511d19d43533"},{"name":"Postback URL v2","id":"bb6c6372-59f9-466d-a39f-d3f2943a1953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"String (Required)\nIt should be set to DEFAULT
\n"},{"key":"language","value":"en / es","type":"text","description":"String (Optional)\nLanguage of the answer
\n"}],"url":"https://api.tellafriend.club/tellafriend/api/merchant/conversions/conversion/url?orderId=123&discountCode=123Abc","description":"| KEY | \nVALUE | \nDESCRIPTION | \n
|---|---|---|
| ecommerceProvider | \nDEFAULT | \nString (RequIRED) It is defined if it is the store by default | \n
| language | \nen / es | \nString (Optional) Defines the language in which the answer will arrive | \n
| orderId | \nString(Required) Transaction ID | \n
| discountCode | \nString(Required) Advocate discount code | \n
int (Optional)\nTransaction ID
\n","type":"text/plain"},"key":"orderId","value":"123"},{"description":{"content":"String (Required)\nAdvocate's discount code
\n","type":"text/plain"},"key":"discountCode","value":"123Abc"}],"variable":[]}},"response":[],"_postman_id":"bb6c6372-59f9-466d-a39f-d3f2943a1953"}],"id":"aee992fe-f9de-4da2-a82d-b8953d6d3f32","_postman_id":"aee992fe-f9de-4da2-a82d-b8953d6d3f32","description":""}]}