EXPORT Schedules API V2

Updated on 2015-09-23

Current Version: 2

Deprecated Version: 1

Requests Allowed: POST/GET/SOAP


Summary:

This API allows you to export details for the delivery schedule.


Resource/WSDL Page:

http://<your_domain_here>/api/2/export.asmx?op=Schedules


Parameters

Example Values: 

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and Not expired)

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

start_date

Required

Type: DATETIME

Max Length: N/A

Sets the beginning day for the timeframe you want to look at.

Use format MM-DD-YYYY

end_date

Required

Type: DATETIME

Max Length: N/A

Sets the ending day for the timeframe you want to look at.

Use format MM-DD-YYYY

buyer_id

Required

Type: INTEGER

Max Length: N/A

Buyer‘s CAKE Entity ID

Pass 0 to skip

status_id

Required

Type: INTEGER

Max Length: N/A

Filter by the Buyer Contract’s status.

See: GETAccountStatuses API

 

vertical_id

Required

Type: INTEGER

Max Length: N/A

Vertical‘s CAKE Entity ID

Pass 0 to skip

priority_only

Required

Type: BOOL

Max Length: N/A

View only schedules where priority is turned on.

Pass TRUE for priority only.

Pass FALSE for all schedules.

active_only

Required

Type: BOOL

Max Length: N/A

View only active schedules.

Pass TRUE for active only.

Pass FALSE for all schedules.

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 


Example Request:

GET

http://demo.cakemarketing.com/api/2/export.asmx/Schedules?api_key=dNJFmId9rI&start_date=12-10-2014&end_date=12-10-2014&buyer_id=0&status_id=0&vertical_id=607&priority_only=FALSE&active_only=FALSE


Sample XML Response:

 

<?xml version=”1.0”encoding=”utf-8”?>
<schedule_export_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/2/">
<success>true</success>
<row_count>4</row_count>
<schedules>
<schedule>
<schedule_id>235547</schedule_id>
<buyer>
<buyer_id>1326</buyer_id>
<buyer_name>Matt Test Buyer</buyer_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<credit_limit>10000.0000</credit_limit>
<credit_used>0.0000</credit_used>
<prepaid_amount>300500.0000</prepaid_amount>
</buyer>
<buyer_contract>
<buyer_contract_id>1231</buyer_contract_id>
<buyer_contract_name>Matt Test Buyer Contract</buyer_contract_name>
<account_status>
<account_status_id xmlns="API:id_name_store">2</account_status_id>
<account_status_name xmlns="API:id_name_store">Inactive</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<prepaid_amount xsi:nil="true"/>
<rank>0</rank>
</buyer_contract>
<vertical>
<vertical_id xmlns="API:id_name_store">607</vertical_id>
<vertical_name xmlns="API:id_name_store">Matt Test Vert</vertical_name>
</vertical>
<schedule_type>
<schedule_type_id xmlns="API:id_name_store">1</schedule_type_id>
<schedule_type_name xmlns="API:id_name_store">Exclusive</schedule_type_name>
</schedule_type>
<default_price>0.0000</default_price>
<date_open>2014-12-10T00:00:00</date_open>
<date_closed>2014-12-10T23:59:00</date_closed>
<sold>0</sold>
<cap>1000</cap>
<cap_remaining>1000</cap_remaining>
<errors>0</errors>
<ping>false</ping>
<active>false</active>
<priority>true</priority>
<sweeper>false</sweeper>
<cherry_picked>false</cherry_picked>
</schedule>
<schedule>
<schedule_id>235568</schedule_id>
<buyer>
<buyer_id>1345</buyer_id>
<buyer_name>Matt Test Buyer 2</buyer_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<credit_limit>0.0000</credit_limit>
<credit_used>0.0000</credit_used>
<prepaid_amount>0.0000</prepaid_amount>
</buyer>
<buyer_contract>
<buyer_contract_id>1261</buyer_contract_id>
<buyer_contract_name>Matt Test Contract</buyer_contract_name>
<account_status>
<account_status_id xmlns="API:id_name_store">2</account_status_id>
<account_status_name xmlns="API:id_name_store">Inactive</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<prepaid_amount xsi:nil="true"/>
<rank xsi:nil="true"/>
</buyer_contract>
<vertical>
<vertical_id xmlns="API:id_name_store">607</vertical_id>
<vertical_name xmlns="API:id_name_store">Matt Test Vert</vertical_name>
</vertical>
<schedule_type>
<schedule_type_id xmlns="API:id_name_store">1</schedule_type_id>
<schedule_type_name xmlns="API:id_name_store">Exclusive</schedule_type_name>
</schedule_type>
<default_price>10.0000</default_price>
<date_open>2014-12-10T00:00:00</date_open>
<date_closed>2014-12-10T23:59:00</date_closed>
<sold>0</sold>
<cap>50</cap>
<cap_remaining>50</cap_remaining>
<errors>0</errors>
<ping>false</ping>
<active>false</active>
<priority>false</priority>
<sweeper>false</sweeper>
<cherry_picked>false</cherry_picked>
</schedule>
<schedule>
<schedule_id>235670</schedule_id>
<buyer>
<buyer_id>1326</buyer_id>
<buyer_name>Matt Test Buyer</buyer_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<credit_limit>10000.0000</credit_limit>
<credit_used>0.0000</credit_used>
<prepaid_amount>300500.0000</prepaid_amount>
</buyer>
<buyer_contract>
<buyer_contract_id>1418</buyer_contract_id>
<buyer_contract_name>Matt's Buyer Test Contract</buyer_contract_name>
<account_status>
<account_status_id xmlns="API:id_name_store">2</account_status_id>
<account_status_name xmlns="API:id_name_store">Inactive</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<prepaid_amount xsi:nil="true"/>
<rank xsi:nil="true"/>
</buyer_contract>
<vertical>
<vertical_id xmlns="API:id_name_store">607</vertical_id>
<vertical_name xmlns="API:id_name_store">Matt Test Vert</vertical_name>
</vertical>
<schedule_type>
<schedule_type_id xmlns="API:id_name_store">2</schedule_type_id>
<schedule_type_name xmlns="API:id_name_store">Multisell</schedule_type_name>
</schedule_type>
<default_price>30.0000</default_price>
<date_open>2014-12-10T00:00:00</date_open>
<date_closed>2014-12-10T23:59:00</date_closed>
<sold>0</sold>
<cap>100</cap>
<cap_remaining>100</cap_remaining>
<errors>0</errors>
<ping>true</ping>
<active>false</active>
<priority>false</priority>
<sweeper>false</sweeper>
<cherry_picked>false</cherry_picked>
</schedule>
<schedule>
<schedule_id>235726</schedule_id>
<buyer>
<buyer_id>1326</buyer_id>
<buyer_name>Matt Test Buyer</buyer_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<credit_limit>10000.0000</credit_limit>
<credit_used>0.0000</credit_used>
<prepaid_amount>300500.0000</prepaid_amount>
</buyer>
<buyer_contract>
<buyer_contract_id>1498</buyer_contract_id>
<buyer_contract_name>Test Buyer Contract 2</buyer_contract_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<prepaid_amount>23000.0000</prepaid_amount>
<rank>0</rank>
</buyer_contract>
<vertical>
<vertical_id xmlns="API:id_name_store">607</vertical_id>
<vertical_name xmlns="API:id_name_store">Matt Test Vert</vertical_name>
</vertical>
<schedule_type>
<schedule_type_id xmlns="API:id_name_store">1</schedule_type_id>
<schedule_type_name xmlns="API:id_name_store">Exclusive</schedule_type_name>
</schedule_type>
<default_price>100.0000</default_price>
<date_open>2014-12-10T00:00:00</date_open>
<date_closed>2014-12-10T23:59:00</date_closed>
<sold>0</sold>
<cap>10</cap>
<cap_remaining>10</cap_remaining>
<errors>0</errors>
<ping>true</ping>
<active>false</active>
<priority>true</priority>
<sweeper>false</sweeper>
<cherry_picked>false</cherry_picked>
</schedule>
</schedules>
</schedule_export_response>

 

Example Error Messages:

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Invalid Buyer ID

buyer_id is less than or equal to 0 or is greater than 0, but doesn’t match an existing Buyer ID in CAKE.

Invalid Status ID

account_status_id is less than or equal to 0 or is greater than 0, but doesn’t match an existing status ID in CAKE.

Invalid Vertical ID

vertical_id is less than or equal to 0 or is greater than 0, but doesn’t match an existing Vertical ID in CAKE.