Skip to content

carter-j-h/iterable-python-wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IterableWrapper

Python Wrapper for the Iterable API. Current version is 1.1

Installation

pip3 install iterablepythonwrapper

Setup

pip3 install -r requirements.txt

Usage:

from iterablepythonwrapper.client import IterableApi

APIKEY="ENTER YOUR API CREDENTIALS HERE"

ic = IterableApi(api_key=APIKEY)

Campaigns

Create Campaign: (https://api.iterable.com/api/docs#!/campaigns/create_campaign)

ic.create_campaign(name="Weekly Newsletter", list_ids=[80665], template_id=300987)

Commerce

Track Purchase (https://api.iterable.com/api/docs#!/commerce/trackPurchase)

cart_purchases = [
	{
		"id": "100",
		"sku": "1000",
		"name": "iPhone X",
		"description": "The latest iPhone with the biggest screen ever!",
		"categories":["mobile", "iPhone X", "Apple", ],
		"price": 999.99,
		"quantity": 1
	}
]

ic.track_purchase(user={"email":"[email protected]"}, items=cart_purchases, total=999.99)

Update Cart: (https://api.iterable.com/api/docs#!/commerce/updateCart)

cart_items = [
	{
		"id": "100",
		"sku": "1000",
		"name": "iPhone X",
		"description": "The latest iPhone with the biggest screen ever!",
		"categories":["mobile", "iPhone X", "Apple", ],
		"price": 999.99,
		"quantity": 1
	}
]
ic.update_cart(user={"email": "[email protected]"}, items=cart_items)

Events

Track Event: (https://api.iterable.com/api/docs#!/events/track)

event_details= {
	"User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X; rv:42.0) Gecko/20100101 Firefox/42.0",
	"referrer": "https://www.google.com"
}

ic.track_event(email="[email protected]",
				event_name="app_login",
				dataFields=event_details,
				campaign_id=215,
				template_id= 1000)

Templates

Upsert Email Template (https://api.iterable.com/api/docs#!/templates/upsertEmailTemplate)

ic.upsert_email_template(client_template_id=100000,
						name="New Email Template",
						from_name="Abe Lincoln",
						reply_to_email="[email protected]",
						subject="A word from Abe Lincoln!", 
						preheader_text="Abe wants You!",
						html=HTML_CONTENT_HERE)

Users

Update User (https://api.iterable.com/api/docs#!/users/updateUser)

ic.update_user(email="[email protected]",
				data_fields={"firstName":"Abe",
							"lastName":"Lincoln",
							"jobTitle": "16th President of the United States"})

Bulk Update (https://api.iterable.com/api/docs#!/users/bulkUpdateUser)

presidents = [
	{
		"email": "[email protected]",
		"dataFields": {
			"firstName":"Abe",
			"lastName":"Lincoln",
			"jobTitle": "16th President of the United States"
		}
	},
	{
		"email": "[email protected]",
		"dataFields": {
			"firstName":"Teddy",
			"lastName":"Roosevelt",
			"jobTitle": "26th President of the United States"
		}
	}
]

ic.bulk_update_user(users=presidents)