eBay Bulk Data Exchange APIVersion 1.5.0

RecurringJobDetail

Type defining the recurringJobDetail container that is returned for each recurring job defined for the seller. The recurringJobDetail container consists of a unique identifier for the recurring job, the current status of the recurring job ('Active' or 'Suspended), the frequency of the recurring job (daily, weekly, monthly), and the download job type.

Type that uses RecurringJobDetail:

Call that uses RecurringJobDetail:

Fields



creationTime ( dateTime ) [1]
This timestamp indicates the date and time that the Bulk Data Exchange job was created.
See the Field Index to learn which calls use creationTime.

dailyRecurrence ( DailyRecurrence ) [0..1]
This container is only returned if a daily recurrence was set up for the recurring job. If a recurring job is set up to run on a daily basis, the time of day is returned under the dailyRecurrence container.
See the Field Index to learn which calls use dailyRecurrence.

downloadJobType ( token ) [1]
Specifies the report you want to download. Each Bulk Data Exchange job can only have one job type per job. For instance, if you are downloading a SoldReport, it will only have predefined SoldReport data within the file.

Applicable values:
ActiveInventoryReport
A report that contains all of the active listings for a specific seller ID. The eBay servers read the credential information passed in by the seller's application to determine which seller's data to retrieve.
FeeSettlementReport
A report that contains all of the fees that you have incurred as invoices are generated by the eBay servers. This report gives large merchants the ability to look at their fees for many listings in one file.
SoldReport
Lists all items that have been sold by this seller (sold items that were submitted to the Large Merchant Service by the seller's application).

When an item is sold, the eBay application creates an 'order' for the seller. If only one item is sold, there is one order ID and one line item ID associated with the sale. However, if multiple items are sold as part of the same transaction, there is one order ID for the sale, and multiple line item IDs - one line item ID for each item sold.

Therefore, SoldReport returns the order IDs and line item IDs for every order associated with the seller who is making the request. Sellers use this information to make inventory updates and start order fulfillment.

When orders have been fulfilled, the seller will probably want to remove them from the list of all orders that comes back every time they receive a SoldReport. To do this, they can acknowledge each order that has been fulfilled (using order ID or line item ID) by uploading a list of the fulfilled order information using an OrderAck request.

After you upload a data file with an OrderAck request, the orders (or line items within an order) will no longer appear in SoldReport. After you send the first OrderAck call, future SoldReport responses will only contain unacknowledged orders and line items.
See the Field Index to learn which calls use downloadJobType.

frequencyInMinutes ( int ) [0..1]
This field is only returned if an intraday frequency was set up for the recurring job. If an intraday frequency is set up for a recurring job, job instances will be executed according to the frequency (in minutes) set in the frequencyInMinutes field.
See the Field Index to learn which calls use frequencyInMinutes.

jobStatus ( RecurringJobStatus ) [1]
The current state of a recurring Bulk Data Exchange job.
See the Field Index to learn which calls use jobStatus.

monthlyRecurrence ( MonthlyRecurrence ) [0..1]
This container is only returned if a monthly recurrence was set up for the recurring job. If a recurring job is set up to run on a monthly basis, the day of month and the time of day is returned under the monthlyRecurrence container.
See the Field Index to learn which calls use monthlyRecurrence.

recurringJobId ( string ) [1]
The unique identifier of a recurring job that is assigned by the Bulk Data Exchange API after a successful createRecurringJob call. This value is passed into the request of other recurring job calls of the File Transfer API.
See the Field Index to learn which calls use recurringJobId.

weeklyRecurrence ( WeeklyRecurrence ) [0..1]
This container is only returned if a weekly recurrence was set up for the recurring job. If a recurring job is set up to run on a weekly basis, the day of week and the time of day is returned under the weeklyRecurrence container.
See the Field Index to learn which calls use weeklyRecurrence.