Authentication

The current version of the API is 1.0. You may obtain an API key as an administrative user in Settings. The API key should be used in the header for all requests per the usage provided.

Authorization: Token token="41a08de1c61033008bb1998ae0c66ed3"

Campaigns

brand A name for the campaign
url URL at which the brand is hosted, typically brand name itself with '.com' or another TLD appended
facebook_url URL for the brand's Facebook page
twitter_url URL for the brand's Twitter handle
youtube_url URL for the brand's YouTube channel
instagram_url URL for the brand's Instagram account
pinterest_url URL for the brand's Pinterest account
trademark Trademark registration number(s) issued by the USPTO for any trademarks issued to protect the brand in trade
patent Patent number(s) issued by the USPTO for any patents issued to protect the products in trade
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"campaign": [
     {
     "brand": "POWERDECAL",
     "url": "https://powerdecal.com",
     "facebook_url": "https://facebook.com/powerdecal",
     "twitter_url": "https://twitter.com/powerdecal",
     "youtube_url": "https://youtube.com/powerdecal",
     "instagram_url": "https://instagram.com/powerdecal",
     "pinterest_url": "https://pinterest.com/powerdecal",
     "trademark": "4178049",
     "patent": "D681,739",
     }]
}

Sources

name A name for the location
country_code Country code for the country in which the source is located
street_address First and possibly only part of street address
street_address2 Optional second part of street address
city City in which the source is located
state State or province in which the city is located
zip Zip code in which the source is located
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"location": [
     {
     "name": "ACME Industries, Inc.",
     "country_code": "US",
     "street_address": "20 W Kinzie St",
     "street_address2": None,
     "city": "Chicago",
     "state": "IL",
     "zip": "60654",
     }]
}

Products

brand Brand under which the products are sold, related to brand in Campaigns
sku Unique identifier for the product variant
form Form factor (physical or digital)
name Name of the product
image_url URL at which the product image is hosted
file_url URL at which the product is hosted, if product is digital
category Optional product cateogory
option Option for the corresponding product variant
upc Universal Product Code for the product variant
source Location from which the product is sourced, related to name in Sources
case_pack Master carton case pack quantity
carton_length Master carton length
carton_width Master carton width
carton_height Master carton height
gross_weight Master carton gross weight
net_weight Master carton net weight
pricing Product wholesale pricing
msrp Manufacturer suggested retail price
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"submission": [
     {
     "brand": "POWERDECAL",
     "sku": "PWR7701",
     "form": "PHYSICAL",
     "name": "Pittsburgh Steelers",
     "image_url": "https://cartpilot.com/static/images/PWR7701.png",
     "file_url": None,
     "category": "NFL",
     "option": "POWERDECAL® + Lens",
     "upc": 094746527563,
     "source": "ACME Industries, Inc.",
     "case_pack": 60,
     "carton_length": 18.7,
     "carton_width": 11,
     "carton_height": 10.4,
     "gross_weight": 12,
     "net_weight": 11,
     "pricing": None,
     "msrp": 19.95,
     }]
}

Distributions

name Name of the distributor
sku Specific product to be distributed, related to SKU in Products
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"distributions": [
     {
     "sku": "PWR7701",
     "distributor": "Amazon.com",
     }]
}

Licensings

name Name of the license
sku Specific product to be licensed, related to SKU in Products
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"licensings": [
     {
     "sku": "PWR7701",
     "license": "Pittsburgh Steelers",
     }]
}

Sites

sku SKU to be posted to site, related to Product
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"sites": [
     {
     "product": "PWR7701",
     }]
}

Posts

brand Brand for which you are posting, related to Brand in Campaign
account Social media account
message Message to be posted to account
date Scheduled date for message to post
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"sites": [
     {
     "brand": "POWERDECAL",
     "account": "Facebook",
     "message": "Save 20% this weekend!",
     "date": "2018-11-01 11:00:00",
     }]
}