**Order Fulfillment Enabled will be released 1/10/13**
Data Structure holding publisher information.
Fields:
| Field |
Data Type |
Nulls |
Description |
emailNotificationCallbackSharedKey
|
string
|
Y
|
The shared secret key posted on the email notification callback. Should be used to verify the identity for the calling code.
|
| emailServiceProvider |
string |
|
The third party email service provider for the publisher. One of {Sailthru, EDialog, Triton, StormPost, Unknown}. |
logoUrl
|
string
|
Y
|
The absolute URL for this publisher's logo (null if not applicable).
|
| name |
string
|
|
The name of the publisher.
|
| orderFulfillmentEnabled |
bool
|
|
Determines if the publisher is configured to select and sell product sales / order fulfillment offers and contracts.
|
| promotionalDiscountPercent |
decimal
|
Y
|
Some publishers choose to run offers with a discount for certain users. This field is the "percent off" value used for that discount. [0,100]
|
referAFriendEnabled
|
bool
|
Y
|
Determines whether the refer a friend feature is enabled for this publisher.
|
referAnOfferEnabled
|
bool
|
|
Determines whether the refer a offer feature is enabled for this publisher.
|
| referAnOfferPurchasesRequired |
int
|
Y
|
Determines the number of purchases that must come from referring an offer to get the item free. Will be null if the feature isn't enabled. |
| storedCreditCardsEnabled |
bool
|
|
Determines whether the publisher and the publisher's default payment processor support the storing of credit cards. |
| storedCreditCardsLimit |
int |
Y |
The number of credit cards that one consumer can store based on the publisher's payment processor. Null if stored credit cards are not enabled and/or supported. |
| subscriptionManagementEnabled |
bool
|
|
Determines if the publisher supports the api extension subscription management features. |
supportedCurrencies
|
list
|
|
A list currencies the publisher supports.
|
| supportedLanguages |
list
|
|
A list of supported languages.
|
Currency:
| Field |
Data Type |
Nulls |
Description |
| isoCode |
string
|
|
Three letter code denoting the currency. USD, CAD, etc
|
| symbol |
string
|
|
The currency symbol to be used, eg $, €, ¥.
|
| referAFriendAmount |
decimal |
Y |
The current value in that currency for the RAF credits. Null implies RAF not set up.
|
SupportedLanguages
| Field |
Data Type |
Nulls |
Description |
cultureCode
|
string
|
|
The culture code of the language such as "en" or "en-us"
|
englishDisplayName
|
string
|
|
The name of the language in english.
|
| displayName |
string
|
|
The name of the language in the defined language.
|
| isDefault |
bool
|
|
Whether or not this language is defined as the publisher's default language.
|
Sample JSON Response:
{
"emailNotificationCallbackSharedKey": "LKjedk$#FO*#KJFk43IDfyh 3v42"
"emailServiceProvider": "Unknown",
"logoUrl": "http://gcs-dev.s3.amazonaws.com/publishers/dailyvoice/images/logos/penguins.jpg",
"name": "Daily Voice",
"productSalesEnabled": true,
"promotionalDiscountPercent": 32,
"promotionalPercentDiscount": 0.32,
"referAFriendEnabled": true,
"referAnOfferEnabled": true,
"referAnOfferPurchasesRequired": 3,
"storedCreditCardsEnabled": true,
"storedCreditCardsLimit": 10,
"subscriptionManagementEnabled": true,
"supportedCurrencies": [
{
"isoCode": "GBP",
"referAFriendAmount": 8,
"symbol": "£"
},
{
"isoCode": "USD",
"referAFriendAmount": 16,
"symbol": "$"
}
],
"supportedLanguages": [
{
"cultureCode": "en",
"displayName": "English",
"englishDisplayName": "English",
"isDefault": true
}
]
}
Sample
XML Response:
<publisher>
<emailNotificationCallbackSharedKey>LKjedk$#FO*#KJFk43IDfyh 3v42</emailNotificationCallbackSharedKey>
<emailServiceProvider>Unknown</emailServiceProvider>
<logoUrl>http://gcs-dev.s3.amazonaws.com/publishers/dailyvoice/images/logos/penguins.jpg</logoUrl>
<name>Daily Voice</name>
<productSalesEnabled>false</productSalesEnabled>
<promotionalDiscountPercent>32.00</promotionalDiscountPercent>
<promotionalPercentDiscount>0.32</promotionalPercentDiscount>
<referAFriendEnabled>true</referAFriendEnabled>
<referAnOfferEnabled>true</referAnOfferEnabled>
<referAnOfferPurchasesRequired>3</referAnOfferPurchasesRequired>
<storedCreditCardsEnabled>true</storedCreditCardsEnabled>
<storedCreditCardsLimit>10</storedCreditCardsLimit>
<subscriptionManagementEnabled>true</subscriptionManagementEnabled>
<supportedCurrencies>
<currency>
<isoCode>GBP</isoCode>
<referAFriendAmount>8.0000</referAFriendAmount>
<symbol>£</symbol>
</currency>
<currency>
<isoCode>USD</isoCode>
<referAFriendAmount>16.0000</referAFriendAmount>
<symbol>$</symbol>
</currency>
</supportedCurrencies>
<supportedLanguages>
<language>
<cultureCode>en</cultureCode>
<displayName>English</displayName>
<englishDisplayName>English</englishDisplayName>
<isDefault>true</isDefault>
</language>
</supportedLanguages>
</publisher>
|
|
