API Documentation

API URL

https://api3.freshlime.com

 

ENDPOINT

POST /data

 

PARAMETERS

Parameter

Description

Example

app_id

The App ID identifying apps that integrate with Freshlime. Format is UUID

app_id=76e97686-29d6-46dd-a4a1-341f9c9b0443

merchant_id

The Merchant UUID of the Freshlime merchant that the data is coming from. Format is UUID

merchant_id=4f74b4a8-f489-4c61-ac2d-cdd63250c0eb

data_type

The type of data included in the upload. Valid values are: contacts, transactions, subscriptions, employees, locations, invoices

data_type=contacts

user_key

The User Key issued to approved developers and acts as the API Token.  Format is UUID

user_key=c3d5beb4-5e5e-4a25-9502-187bb3aa4f6b

 

EXAMPLE API CALL

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 POST https://api3.freshlime.com/data?user_key=c3d5beb4-5e5e-4a25-9502-187bb3aa4f6b&app_id=76e97686-29d6-46dd-a4a1-341f9c9b0443&merchant_id=4f74b4a8-f489-4c61-ac2d-cdd63250c0eb&data_type=contacts Request Headers Content-Type: "application/x-www-form-urlencoded" Host: "api3.freshlime.com" Accept-Encoding: "gzip, deflate" Content-Length: 1331 Connection: "keep-alive" Request Body file: {…} autoClose: true bytesRead: 1112 closed: true domain: null fd: null flags: "r" mode: 438 path: "1573054498-contacts.json" readable: false

Code Samples:

Contacts Example

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 "contacts": [ { "id": "", "location_id": "", "status": "", "created": "", "clients": [ { "client_id": "" } ], "contact_methods": [ { "type": "phone", "number": "", "extension": "", "sms_optin": [ { "terms": "", "active_timestamp": "", "inactive_timestamp": "" } ] }, { "type": "email", "email": "", "email_optin": [ { "terms": "", "active_timestamp": "", "inactive_timestamp": "" } ] }, { "type": "shipping address", "street": "", "suite": "", "city": "", "state": "", "postal_code": "", "inactive_timestamp": "" } ] } ]

 

Transactions Example

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 "transactions": [ { "id": "", "meta": { "rep_id": "", "location_id": "", "contact_id": "", "client_id": "", "subscription_id": "" }, "details": { "status": "", "amount": "", "summary": "", "fulfillment_date": "", "open_date": "", "close_date": "" }, "invoices": [ { "number": "", "total_amount": "", "terms": "", "issue_date": "", "due_date": "", "line_items": [ { "id": "", "name": "", "quantity": "", "amount": "", "discount": "", "discount_code": "", "notes": "" } ] } ], "contacts": [ { "type": "buyer", "contact_id": "" }, { "type": "ship_address", "street": "", "suite": "", "city": "", "state": "", "postal_code": "" }, { "type": "billing_address", "street": "", "suite": "", "city": "", "state": "", "postal_code": "" } ] } ]