Creates a Bulk Data Exchange Job and assigns it a job id and a file reference id. You need to add
these ids to all Bulk Data Exchange calls that are related to your job, such as getJobStatusRequest.
You will also need to add this information to File Transfer Service requests
for this job.
Creates a Bulk Data Exchange Job and assigns it a job id and a file reference id.
samples
Specifies the Merchant Data API request used in a Bulk Data
Exchange upload job. Each Bulk Data Exchange job can only have one jobType
(Merchant Data API request) per job. For instance,
if you are uploading a data file, it can not have AddFixedPriceItem
requests and ReviseFixedPriceItem requests within the same upload file.
<br><br>
For each of the request job types, Merchant Data requests with the same name
are included within a data file and uploaded. For instance, if you create
an AddFixedPriceItem job, then the file you are going to upload must contain
AddFixedPriceItem requests - one request for each item, listing, or acknowledgement
in your data file.
<br><br>
The following value definitions describe the request or response associated with
each job type.
<br><br>
For more information about creating and uploading Merchant Data files, see the
Large Merchant Services User Guide.
<br><br>
<dl>
<lh>Applicable values:<br></lh>
<dt>AddFixedPriceItem</dt>
<dd>Defines a single new fixed price item and lists it on a
specified eBay site.
</dd>
<dt>EndFixedPriceItem</dt>
<dd>Ends the specified item listing before the date and time at which
it would normally end (per the listing duration).
</dd>
<dt>OrderAck</dt>
<dd>Request that acknowledges that an order has been received. Use the OrderAck
request to acknowledge each line item in a SoldReport by order ID or line item ID.
<br><br>
After you send the first OrderAck call, future SoldReports will only contain unacknowledged
orders or line items.
</dd>
<dt>RelistFixedPriceItem</dt>
<dd>Enables a seller to take a single item (or a single multi-item
listing) that ended without bidders or buyers and re-list it on a
specified eBay site.
<br><br>
A listing may be re-listed with the same item
properties as the original or the seller may change a number of the
item's defining properties at re-listing time. The new listing will
have a different item ID than the original one.
</dd>
<dt>ReviseFixedPriceItem</dt>
<dd>Enables a seller to change the properties of a currently
active listing.
<br><br>
If the listing contains multiple items, you can revise most of the fields in
the listing (except Title, currency, product ID, photo display type, variation
details, duration, format, or eBay Giving Works charity), even
after one of the items in the listing has been purchased. To revise multiple
listings, include a ReviseFixedPriceItemRequest once for each item or listing
in your data file, with new information for each item or listing.
</dd>
<dt>ReviseInventoryStatus</dt>
<dd>Enables a seller to change the price and quantity of a currently
active fixed-price listing.
Inputs are the item IDs and SKUs of the listings being revised, and price and
quantity that are being changed for each revision.
<br><br>
Only applicable to fixed-price listings that include a SKU.
</dd>
<dt>SetShipmentTrackingInfo</dt>
<dd>Includes information about a specific item and the shipping information
associated with it.
</dd>
<dt>UploadSiteHostedPictures</dt>
<dd>Uploads a picture to EPS (eBay Picture Services) when you supply a URL
in the ExternalPictureURL field (the location of the picture on an external web
server). Unlike what the call name implies, you can only upload one picture per
request.
</dd>
<dt>VerifyAddFixedPriceItem</dt>
<dd>Acknowledges that the data for a single new fixed price item
matches the schema and can be added without data errors.
</dd>
specified eBay site.
it would normally end (per the listing duration).
request to acknowledge each line item in a SoldReport by order ID or line item ID.
<br><br>
After you send the first OrderAck call, future SoldReports will only contain unacknowledged
<dt>RelistFixedPriceItem</dt>
<dd>Enables a seller to take a single item (or a single multi-item
listing) that ended without bidders or buyers and re-list it on a
specified eBay site.
<br><br>
A listing may be re-listed with the same item
properties as the original or the seller may change a number of the
item's defining properties at re-listing time. The new listing will
have a different item ID than the original.
</dd>
<dt>ReviseFixedPriceItem</dt>
<dd>Enables a seller to change the properties of a currently
active listing. Include the item ID of the ended item being revised and any
properties that are being changed for the revision within a data file.
<br><br>
If the listing contains multiple items, you can revise most of the fields in
the listing (except Title, currency, product ID, photo display type, variation
details, duration, format, or eBay Giving Works charity), even
after one of the items in the listing has been purchased. To revise multiple
listings, include a ReviseFixedPriceItemRequest once for each item or listing
in your data file, with new information for each item or listing.
</dd>
<dd>Enables a seller to change the price and quantity of a currently
active fixed-price listing.
quantity that are being changed for each revision.
<br><br>
Only applicable to fixed-price listings that include a SKU.
</dd>
<dt>SetShipmentTrackingInfo</dt>
<dd>Includes information about a specific item and the shipping information
associated with it.
</dd>
<dt>UploadSiteHostedPictures</dt>
<dd>Uploads a picture to EPS (eBay Picture Services) when you supply a URL
in the ExternalPictureURL field (the location of the picture on an external web
server). Unlike what the call name implies, you can only upload one picture per
request.
</dd>
<dt>VerifyAddFixedPriceItem</dt>
<dd>Acknowledges that the data for a single new fixed price item
matches the schema and can be added without data errors.
</dd>
</dl>
createUploadJob
Yes
A Universally Unique Identifier (UUID) provided by the seller's application.
createUploadJob
Yes
Specifies the upload job type. Only XML is currently allowed.
createUploadJob
No
Begins processing the data in the uploaded file. For example, if the data
file contains data for the AddFixedPriceItem request, the Bulk Data Exchange web service
reads and sends this item data from the uploaded file to the eBay Trading platform.
(Adds the Fixed Price Items to the eBay web site.)
Begins processing the data in the uploaded file.
samples
Job Id assigned by the Bulk Data Exchange service
when createUploadJobRequest is called. Use this jobId
with any Bulk Data Exchange call, or pass this
jobId into a File Transfer service uploadJobRequest.
startUploadJob
Yes
Stops (aborts) processing the uploaded file or processing the report file
(to be downloaded). When your application makes this call, the
processing will stop, but it may not stop immediately. (Much like when you
abort a job from your printer queue.)
<br>
<br>
To determine which data was processed (added to the eBay web site or report)
and which data still needs to be added, see the AbortJobResponse that is
returned by this call.
Stops (aborts) processing the uploaded file.
samples
Job Id assigned by the Bulk Data Exchange service
when createUploadJobRequest or startDownloadJob is
called. Use this jobId with any Bulk Data Exchange call,
or pass this jobId into a File Transfer service
uploadJobRequest or downloadJobRequest call.
abortJob
Yes
Lists all jobs that have been submitted with this Seller ID that have the job type
specified in the request. You can enter a request with no job type field to see the
status of all of your jobs, you can put a few job type fields in your request to
see the status for specific job types, or you can put a single job type field in
your request.
Lists Bulk Data Exchange jobs for this Seller ID.
samples
Use this field to designate the start of a date/time range. By default, 30
days worth of data is returned.
getJobs
No
Use this field to designate the end of a date/time range. Defaults to
current time.
getJobs
No
Job filter criteria. Default is return all job types.
<br><br>
Each of the Bulk Data Exchange job types corresponds to a Merchant Data request
or response with the same name. The requests or responses included within a
data file are uploaded or downloaded after the job is created. For instance,
if you create an AddFixedPriceItem job, then the file you are going to upload
must contain AddFixedPriceItem requests - one request for each item in your
data file.
<br><br>
Each Bulk Data Exchange job can only have one job type per job. For instance,
if you are uploading a data file, it can not have both AddFixedPriceItem
requests and ReviseFixedPriceItem requests within the same data file.
<br><br>
The following value definitions describe the request or response associated
with each job type.
<br><br>
For more information about creating and uploading Merchant Data files, see the
Large Merchant Services User Guide.
<br><br>
<dl>
<lh>Applicable values:<br></lh>
<dt>ActiveInventoryReport</dt>
<dd>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.
</dd>
<dt>AddFixedPriceItem</dt>
<dd>A request that defines a single new fixed price item and lists it on a
specified eBay site.
</dd>
<dt>EndFixedPriceItem</dt>
<dd>A request that ends the specified item listing before the date and time at which
it would normally end (per the listing duration).
</dd>
<dt>OrderAck</dt>
<dd>A request that request that acknowledges that an order has been received. Use the OrderAck
request to acknowledge each line item in a SoldReport by order ID or line item ID.
<br><br>
After you send the first OrderAck call, future SoldReports will only contain unacknowledged
orders or line items.
</dd>
<dt>RelistFixedPriceItem</dt>
<dd>A request that enables a seller to take a single item (or a single multi-item
listing) that ended without bidders or buyers and re-list it on a
specified eBay site.
<br><br>
A listing may be re-listed with the same item
properties as the original or the seller may change a number of the
item's defining properties at re-listing time. The new listing will
have a different item ID than the original.
</dd>
<dt>ReviseFixedPriceItem</dt>
<dd>A request that enables a seller to change the properties of a currently
active listing.
<br><br>
If the listing contains multiple items, you can revise most of the fields in
the listing (except Title, currency, product ID, photo display type, variation
details, duration, format, or eBay Giving Works charity), even
after one of the items in the listing has been purchased. To revise multiple
listings, include a ReviseFixedPriceItemRequest once for each item or listing
in your data file, with new information for each item or listing.
</dd>
<dt>ReviseInventoryStatus</dt>
<dd>A request that enables a seller to change the price and quantity of a currently
active fixed-price listing.
Inputs are the item IDs and SKUs of the listings being revised, and price and
quantity that are being changed for each revision.
<br><br>
</dd>
<dt>SetShipmentTrackingInfo</dt>
<dd>A request that includes information about a specific item and the shipping information
associated with it.
</dd>
<dt>SoldReport</dt>
<dd>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).
<br><br>
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.
<br><br>
Therefore, the Sold Report 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.
<br><br>
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) y uploading a list of the
fulfilled order information using an OrderAck request.
<br><br>
After you upload a data file with an OrderAck request, the orders (or line
items within an order) will no longer appear in the SoldReport. (After you
send the first OrderAck call, future SoldReports that you request will only
contain unacknowledged orders and line items.)
</dd>
<dt>UploadSiteHostedPictures</dt>
<dd>A request that uploads a picture to EPS (eBay Picture Services) when you supply a URL
in the ExternalPictureURL field (the location of the picture on an external web
server). Unlike what the call name implies, you can only upload one picture per
request.
</dd>
<dt>VerifyAddFixedPriceItem</dt>
<dd>A request that acknowledges that the data for a single new fixed price item
matches the schema and can be added without data errors.
</dd>
<dt>UploadSiteHostedPictures</dt>
<dd>A request that uploads a picture to EPS (eBay Picture Services) when you supply a URL
in the ExternalPictureURL field (the location of the picture on an external web
server). Unlike what the call name implies, you can only upload one picture per
request.
</dd>
<dt>VerifyAddFixedPriceItem</dt>
<dd>A request that acknowledges that the data for a single new fixed price item
matches the schema and can be added without data errors.
</dd>
<dl>
getJobs
No
Returns the current state of a Bulk Data Exchange Job. Use getJobStatus to
find out where your job is in the processing cycle. Default is to return
status for all jobs.
getJobs
No
Get job status for the provided job ID.
Get job status for the provided job ID..
samples
Job Id assigned by the Bulk Data Exchange service
when createUploadJobRequest or startDownloadJob is
called. Use this jobId with any Bulk Data Exchange call,
or pass this jobId into a File Transfer service
uploadJobRequest or downloadJobRequest call.
getJobStatus
Yes
Begins processing the data for a report file to download. You must use the getJobStatus or
getRecurringJobExecutionStatus calls to determine when the report data is available for download.
Begins processing the data for a report file the you will download.
samples
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
pre-defined SoldReport data within the file.
<br><br>
<dl>
<lh>Applicable values:<br></lh>
<dt>ActiveInventoryReport</dt>
<dd>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.
</dd>
<dt>FeeSettlementReport</dt>
<dd>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.
</dd>
<dt>SoldReport</dt>
<dd>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).
<br><br>
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.
<br><br>
Therefore, the Sold Report 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.
<br><br>
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
fulfulled (using order ID or line item ID) by uploading a list of the
fulfulled order information using an OrderAck request.
<br><br>
After you upload a data file with an OrderAck request, the orders (or line
items within an order) will no longer appear in the SoldReport. (After you
send the first OrderAck call, future SoldReports that you request will only
contain unacknowledged orders and line items.)
</dd>
<dl>
startDownloadJob
Yes
A Universally Unique Identifier (UUID) provided by the seller's
application.
startDownloadJob
Yes
Request filter.
startDownloadJob
No
It is an internal tag used to specify whether the download job
is started as part of the recurring job request or not.
startDownloadJob
No
Lets you request only the data within specific parameters, such as a date range.
Lets you request only the data within specific parameters, such as a date
range.
startDownloadJob
No
Reserved for future use.
Reserved for future use.
startDownloadJob
No
Specify what needs to be included as part of active inventory report.
startDownloadJob
No
Reserved for future use.
Reserved for future use.
startDownloadJob
Yes
Reserved for future use. Lets you request only the eBay fees you have incurred
since the specified start time.
The start time of the invoice period.
<br><br>
An 'invoice' is the eBay term for the bill that is sent to the seller by the
eBay application.
<br><br>
The FeeSettlementReport is based on fees from a given billing cycle for which
there is an invoice. The FeeSettlementReport will be generated based on the
last available invoice since the specified start time.
startDownloadJob
Yes
Specify in this filter what exactly needs to be included in the active inventory report.
Specify the type of listing(s) you would like the report to include - Chinese, FixedPriceItem or both.
startDownloadJob
No
Specify filters specific to fixed price items.
startDownloadJob
No
Specify filters specific to auction items.
startDownloadJob
No
Specify filters specific to fixed price items.
Specify if variation details are needed to be included as part of the report.
startDownloadJob
No
Specify filters specific to auction items.
Specify if bid count on the auction needs to be included as part of the report.
startDownloadJob
No
Specify if report needs to included if reserve price has been met.
startDownloadJob
No
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Subset of ListingType's allowed in Active inventory report.
Chinese Acution type.
Listing type is fixed price.
Listing type is chinese Auction or fixed price.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Creates a recurring Bulk Data Exchange Job and assigns it a recurringJobId.
When you create a recurring job, you must include a recurrence interval, such
as Daily, Weekly, Monthly, or Frequency In Minutes.
Once a recurring job has been created, a separate job ID is created for each
job that is created/executed. For example, if a job runs every hour, it will
have a recurring job ID and each hourly job will have a jobId and file
reference ID.
Creates a recurring Bulk Data Exchange Job.
samples
A Universally Unique Identifier (UUID) provided by the seller's
application.
createRecurringJob
Yes
Use this element to specify job recurrence interval in minutes.
createRecurringJob
No
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 pre-defined SoldReport
data within the file.
<br><br>
<dl>
<lh>Applicable values:<br></lh>
<dt>ActiveInventoryReport</dt>
<dd>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.
</dd>
<dt>FeeSettlementReport</dt>
<dd>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.
</dd>
<dt>SoldReport</dt>
<dd>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).
<br><br>
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.
<br><br>
Therefore, the Sold Report 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.
<br><br>
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
fulfulled (using order ID or line item ID) by uploading a list of the
fulfulled order information using an OrderAck request.
<br><br>
After you upload a data file with an OrderAck request, the orders (or line
items within an order) will no longer appear in the SoldReport. (After you
send the first OrderAck call, future SoldReports that you request will only
contain unacknowledged orders and line items.)
</dd>
<dl>
createRecurringJob
Yes
Optional element to specify a monthly schedule for a recurring job.
createRecurringJob
No
Optional element to specify a weekly schedule for a recurring job.
createRecurringJob
No
Optional element to specify a daily schedule for a recurring job.
createRecurringJob
No
Deletes the recurring job. If you only want to delete a single instance of the
recurring job, use abortRecurringJob. If you only want to stop the recurring job
but plan to start it again later, use suspendRecurringJob.
Deletes recurring job.
samples
Recurring job Id, returned by call to createRecurrringJob operation
deleteRecurringJob
Yes
Get all recurring jobs submitted by this seller. There should only be one
recurring job per job type.
Get all recurring jobs submitted by this seller.
samples
Returns the status information for the latest instance of a Recurring Job.
To see all instances of a Recurring Job, use getRecurringJobExecutionHistory.
Check recurring job execution status.
samples
Recurring job ID, returned by call to createRecurrringJob operation.
getRecurringJobExecutionStatus
Yes
Returns all instances of a recurring job that have occurred so far. To see only
the status information for the latest instance of a recurring job, use
getRecurringJobExecutionStatus.
Returns all instances of a recurring job that have occurred so far.
samples
Filter on job start time. Default is 30 days.
getRecurringJobExecutionHistory
No
Filter on job start time. Default is current time.
getRecurringJobExecutionHistory
No
Recurring job ID, returned by call to createRecurrringJob operation.
getRecurringJobExecutionHistory
Yes
Returns the current state of a Bulk Data Exchange job. Use getJobStatus to
find out where your job is in the processing cycle. Default is to return
status for all jobs.
getRecurringJobExecutionHistory
No
Re-starts recurring job that has been suspended.
Re-activates a recurring job that has been suspended.
samples
Recurring job ID, returned by call to CreateRecurrringJob operation
activateRecurringJob
Yes
Stops processing of recurring job. When your application makes this call, the
processing will stop, but it may not stop immediately. To determine which data
was processed and which data still needs to be processed, see the
SuspendRecurringJobResponse that is returned by this call.
Stops the processing for a recurring job.
samples
Recurring job Id, returned by call to CreateRecurrringJob operation
suspendRecurringJob
Yes
Deletes the next instance of a Recurring Job. When your application makes this
call, the job execution will stop, but it may not stop immediately. To determine
which data was processed and which data still needs to be processed, see the
AbortRecurringJobExecutionResponse that is returned by this call.
Deletes the next instance of a recurring job.
samples
Recurring job ID, returned by call to createRecurrringJob operation
abortRecurringJobExecution
Yes
This is the base class for request container for all service operations.
Base response container for all service operations. Contains error information
associated with the request.
Returns the acknowledgement of the call success or failure.
Always
Information for an error or warning that occurred when eBay processed the
request.
Conditionally
The version of the schema that your WSDL is based on.
Always
The data and time of the response.
Always
Returns job id and a file reference id, as well as the maximum upload file size for
your data file. You need to add these ids to all Bulk Data Exchange calls that
are related to your job, such as getJobStatusRequest.
<br>
<br>
You will also need to add this information to File Transfer service requests
for this job.
Job Id assigned by the Bulk Data Exchange service
when createUploadJobRequest is called. Use this
jobId with any Bulk Data Exchange call, or pass
this jobId into a File Transfer service
uploadJobRequest call.
createUploadJob
Always
A unique ID assigned to a file by the Bulk Data Exchange service
when createUploadJobRequest is called. Pass this fileReferenceId into a
File Transfer service uploadFileRequest call.
createUploadJob
Always
Maximum size of a file that may be uploaded or downloaded. Currently, the
default maximum size is 15MB. The number of calls allowed in a data file
that you want to upload varies with the size of the Item description, the
type of data in the description, and the complexity of each call in your
file.
createUploadJob
Always
Reports successful or unsuccessful attempt to process the data in the uploaded
file.
Reports job aborted. To determine which data was processed and which data still
needs to be processed, see the AbortJobResponse that is returned by this call.
Returns the list of jobs requested by this seller.
The job profile is a collection of data about a job that includes:
jobId, jobType, jobStatus, job creation time, job completion time,
errorCount, percentComplete, and inputFileReferenceId (for upload jobs).
<br><br>
If upload job processing has finished, a new fileReferenceId is also returned.
<br><br>
The job profile returns data about the state of the Bulk Data Exchange job,
but does not return information about the status of the processing for any
data file that is sent with the job request or returned with the job
response.
getJobs
Always
Returns the status of jobs submitted by this seller.
The job profile is a collection of data about a job that includes:
jobId, jobType, jobStatus, job creation time, job completion time,
errorCount, percentComplete, and inputFileReferenceId (for upload jobs).
<br><br>
If upload job processing has finished, a new fileReferenceId is also returned.
<br><br>
The job profile returns data about the state of the Bulk Data Exchange job,
but does not return information about the status of the processing for any
data file that is sent with the job request or returned with the job
response.
getJobStatus
Always
Indicates that a report or response is being processed by the eBay servers.
Job ID assigned by the Bulk Data Exchange service
when startDownloadJobRequest is called. Pass this
jobId into a File Transfer service downloadJobRequest.
startDownloadJob
Always
Returns the job ID for a successfully created recurring job, or returns
failure along with the reason the recurring job could not be created.
Recurring Job ID obtained by calling createRecurringJobRequest.
createRecurringJob
Always
Returns a 'Success' or 'Failure' response to indicate whether a specified
recurring job was deleted.
Returns the recurring job ID, creation time, frequency, job type, and job status
for each recurring job created by the seller making this call.
Recurring job ID, creation time, frequency, job type, and job status for a
recurring job.
getRecurringJobs
Always
Returns the job profile for a specified recurring job ID. This job profile
includes the job ID, job type, job status, creation time, completion time, error
count, percent complete, and file reference ID.
The job profile is a collection of data about a job that includes:
jobId, jobType, jobStatus, job creation time, job completion time,
errorCount, percentComplete, and inputFileReferenceId (for upload jobs).
<br><br>
If upload job processing has finished, a new fileReferenceId is also returned.
<br><br>
The job profile returns data about the state of the Bulk Data Exchange job,
but does not return information about the status of the processing for any
data file that is sent with the job request or returned with the job
response.
getRecurringJobExecutionStatus
Always
Returns the job profile for each job instance for a specified recurring job ID.
This job profile includes the job ID, job type, job status, creation time,
completion time, error count, percent complete, and file reference ID.
The job profile is a collection of data about a job that includes:
jobId, jobType, jobStatus, job creation time, job completion time,
errorCount, percentComplete, and inputFileReferenceId (for upload jobs).
<br><br>
If upload job processing has finished, a new fileReferenceId is also returned.
<br><br>
The job profile returns data about the state of the Bulk Data Exchange job,
but does not return information about the status of the processing for any
data file that is sent with the job request or returned with the job
response.
getRecurringJobExecutionHistory
Always
Returns Success or Failure to indicate whether a Recurring Job (that was
suspended) has been re-activated correctly.
Returns Success or Failure to indicate whether the scheduled processing for a
recurring job has been stopped. To resume processing schedule, use
activateRecurringJob.
Returns Success or Failure to indicate whether the next instance of a Recurring
Job has been deleted. f so, the Recurring Job schedule remains active. If you want
to remove the recurringJob completely, use DeleteRecurringJob. Use
getRecurringJobExecutionStatus to see the last completed instance of a
recurring job.
Recurring Job Detail for response. Job detail includes recurring job ID, creation
time, frequency of recurrence, job type, and job status.
Recurring job ID, returned by call to createRecurrringJobRequest.
getRecurringJobs
Always
The date and time a Bulk Data Exchange job was created.
getRecurringJobs
Always
Use this element to specify job recurrence interval in minutes.
getRecurringJobs
Conditionally
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 pre-defined
SoldReport data within the file.
<br><br>
<dl>
<lh>Applicable values:<br></lh>
<dt>ActiveInventoryReport</dt>
<dd>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.
</dd>
<dt>FeeSettlementReport</dt>
<dd>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.
</dd>
<dt>SoldReport</dt>
<dd>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).
<br><br>
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.
<br><br>
Therefore, the Sold Report 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.
<br><br>
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
fulfulled (using order ID or line item ID) by uploading a list of the
fulfulled order information using an OrderAck request.
<br><br>
After you upload a data file with an OrderAck request, the orders (or line
items within an order) will no longer appear in the SoldReport. (After you
send the first OrderAck call, future SoldReports that you request will only
contain unacknowledged orders and line items.)
</dd>
<dl>
getRecurringJobs
Always
Returns the current state of a recurring Bulk Data Exchange Job. Use
getJobStatus to find out where your job is in the processing cycle.
Default is to return status for all jobs.
getRecurringJobs
Always
Optional element to define the recurrence interval for monthly jobs.
getRecurringJobs
Conditionally
Optional element to define the recurrence interval for weekly jobs.
getRecurringJobs
Conditionally
Optional element to define the recurrence interval for daily jobs.
getRecurringJobs
Conditionally
Type of file to be uploaded or downloaded.
XML file.
The job profile is a collection of data about a job that includes:
jobId, jobType, jobStatus, job creation time, job completion time,
errorCount, percentComplete, and inputFileReferenceId (for upload jobs).
<br><br>
If upload job processing has finished, a new fileReferenceId is also returned.
<br><br>
The job profile returns data about the state of the Bulk Data Exchange job,
but does not return information about the status of the processing for any
data file that is sent with the job request or returned with the job
response.
Job Id obtained by calling createUploadJob.
getJobs
Always
getJobStatus
Always
getRecurringJobExecutionStatus
Always
getRecurringJobExecutionHistory
Always
Each of the Bulk Data Exchange job types corresponds to a Merchant Data request
or response with the same name. The requests or responses are included within a
data file that will be uploaded or downloaded after the job is created. For instance,
if you create an AddFixedPriceItem job, then the file you are going to upload must contain
AddFixedPriceItem requests - one request for each item in your data file.
<br><br>
Each Bulk Data Exchange job can only have one job type per job. For example,
if you are uploading a data file it can not have both AddFixedPriceItem requests
and ReviseFixedPriceItem requests within the same data file.
<br><br>
The following value definitions describe the request or response associated with
each job type.
<br><br>
For more information about creating and uploading Merchant Data files, see the
Large Merchant Services User Guide.
<br><br>
<dl>
<lh>Applicable values:<br></lh>
<dt>ActiveInventoryReport</dt>
<dd>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.
</dd>
<dt>AddFixedPriceItem</dt>
<dd>A request that defines a single new fixed price item and lists it on a
specified eBay site.
</dd>
<dt>EndFixedPriceItem</dt>
<dd>A request that ends the specified item listing before the date and time at which
it would normally end (per the listing duration).
</dd>
<dt>OrderAck</dt>
<dd>A request that request that acknowledges that an order has been received. Use the OrderAck
request to acknowledge each line item in a SoldReport by order ID or line item ID.
<br><br>
After you send the first OrderAck call, future SoldReports will only contain unacknowledged
orders or line items.
</dd>
<dt>RelistFixedPriceItem</dt>
<dd>A request that enables a seller to take a single item (or a single multi-item
listing) that ended without bidders or buyers and re-list it on a
specified eBay site.
<br><br>
A listing may be re-listed with the same item
properties as the original or the seller may change a number of the
item's defining properties at re-listing time. The new listing will
have a different item ID than the original.
</dd>
<dt>ReviseFixedPriceItem</dt>
<dd>A request that enables a seller to change the properties of a currently
active listing.
<br><br>
If the listing contains multiple items, you can revise most of the fields in
the listing (except Title, currency, product ID, photo display type, variation
details, duration, format, or eBay Giving Works charity), even
after one of the items in the listing has been purchased. To revise multiple
listings, include a ReviseFixedPriceItemRequest once for each item or listing
in your data file, with new information for each item or listing.
</dd>
<dt>ReviseInventoryStatus</dt>
<dd>A request that enables a seller to change the price and quantity of a currently
active fixed-price listing.
Inputs are the item IDs and SKUs of the listings being revised, and price and
quantity that are being changed for each revision.
<br><br>
</dd>
<dt>SetShipmentTrackingInfo</dt>
<dd>A request that includes information about a specific item and the shipping information
associated with it.
</dd>
<dt>SoldReport</dt>
<dd>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).
<br><br>
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.
<br><br>
Therefore, the Sold Report 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.
<br><br>
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) y uploading a list of the
fulfilled order information using an OrderAck request.
<br><br>
After you upload a data file with an OrderAck request, the orders (or line
items within an order) will no longer appear in the SoldReport. (After you
send the first OrderAck call, future SoldReports that you request will only
contain unacknowledged orders and line items.)
</dd>
<dt>UploadSiteHostedPictures</dt>
<dd>A request that uploads a picture to EPS (eBay Picture Services) when you supply a URL
in the ExternalPictureURL field (the location of the picture on an external web
server). Unlike what the call name implies, you can only upload one picture per
request.
</dd>
<dt>VerifyAddFixedPriceItem</dt>
<dd>A request that acknowledges that the data for a single new fixed price item
matches the schema and can be added without data errors.
</dd>
<dl>
getJobs
Always
getJobStatus
Always
getRecurringJobExecutionStatus
Always
getRecurringJobExecutionHistory
Always
Returns the current state of a Bulk Data Exchange Job. Use getJobStatus to find
out where your job is in the processing cycle. Default is to return status for
all jobs.
getJobs
Always
getJobStatus
Always
getRecurringJobExecutionStatus
Always
getRecurringJobExecutionHistory
Always
The date and time a Bulk Data Exchange job was created.
getJobs
Always
getJobStatus
Always
getRecurringJobExecutionStatus
Always
getRecurringJobExecutionHistory
Always
The date and time that job processing was completed. Use this with creationTime
to determine the average processing time for your jobs. If job processing has
not completed, this field will not be returned.
getJobs
Conditionally
getJobStatus
Conditionally
getRecurringJobExecutionStatus
Conditionally
getRecurringJobExecutionHistory
Conditionally
The number of non-fatal (informational) errors that occurred during file
processing (uploads or reports) after you sent the Bulk Data Exchange
startUploadJobRequest call or the startDownloadJobRequest call.
getJobs
Conditionally
getJobStatus
Conditionally
getRecurringJobExecutionStatus
Conditionally
getRecurringJobExecutionHistory
Conditionally
The percentage of your file that has been processed after sending the
Bulk Data Exchange startUploadJobRequest call or the startDownloadJobRequest
call.
getJobs
Always
getJobStatus
Always
getRecurringJobExecutionStatus
Always
getRecurringJobExecutionHistory
Always
A unique ID assigned to a file by the Bulk Data Exchange service
when createUploadJobRequest is called. Pass this fileReferenceId into a
File Transfer service uploadFileRequest call.
<br><br>
If a job has not completed processing, only the inputFileReferenceId
(original fileReferenceId from the createUploadJobResponse) will be
returned. Once the upload job has finished processing, a new fileReferenceId
is assigned by the Bulk Data Exchange service and returned by the job
status calls.
getJobs
Conditionally
getJobStatus
Conditionally
getRecurringJobExecutionStatus
Conditionally
getRecurringJobExecutionHistory
Conditionally
The fileReferenceId is a unique ID assigned to a file by the Bulk Data Exchange
service when createUploadJobRequest is called. It is also returned by the getJobs,
getJobStatus, getRecurringJobExecutionStatus, and getRecurringJobExecutionHistory
calls as the 'inputFileReferenceId', so you can retrieve the ID if you no longer
have your results from the createUploadJob call.
<br><br>
Pass this inputFileReferenceId into a File Transfer service uploadFileRequest.
<br><br>
Once the job processing is finished, a new fileReferenceId
is assigned by the Bulk Data Exchange service and returned by the job
status calls.
getJobs
Conditionally
getJobStatus
Conditionally
getRecurringJobExecutionStatus
Conditionally
getRecurringJobExecutionHistory
Conditionally
Indicates whether the error is a severe error (causing the request to fail)
or an informational error (a warning) that should be communicated to the
user.
The request was processed successfully, but something occurred that may
affect your application or the user.
The request that triggered the error was not processed successfully.
When a serious application-level error occurs, the error is returned
instead of the business data.
The request that triggered the error was processed successfully but with some
warnings.
Reserved for future use.
ErrorMessage to indicate any Error/Warning occurred as part of service call.
Any run time error will not be reported here, but will be reported aspart of
soap fault.
Details about a single error.
Conditionally
This represents error details.
A unique code that identifies the particular error condition that occurred.
Your application can use error codes as identifiers in your customized
error-handling algorithms.
Conditionally
Name of the domain upon which the error occurred.
<dl>
<lh>Domains include:</lh>
<dt>
Marketplace
</dt>
<dd>
A business or validation error occurred for the Bulk Data Exchange service.
</dd>
<dt>
SOA
</dt>
<dd>
An exception occurred in the Service Oriented Architecture (SOA) framework.
</dd>
</dl>
Conditionally
Indicates whether the error caused the request to fail (Error) or not
(Warning).
<br><br>
If the request fails and the source of the problem is within the application
(such as a missing required element), please change the application before you
retry the request. If the problem is due to end-user input data, please alert
the end-user to the problem and provide the means for them to correct the data.
Once the problem in the application or data is resolved, you can attempt to re-
send the request to eBay.
<br><br>
If the source of the problem is on eBay's side, you can retry the request as-is
a reasonable number of times (eBay recommends twice). If the error persists,
contact Developer Technical Support. Once the problem has been resolved, the
request may be resent in its original form.
<br><br>
When a warning occurs, the error is returned in addition to the business data.
In this case, you do not need to retry the request (as the original request was
successful). However, depending on the cause or nature of the warning, you
might need to contact either the end user or eBay to effect a long term
solution to the problem to prevent it from reoccurring in the future.
Conditionally
There are three categories of errors: request errors, application errors, and
system errors.
Conditionally
A detailed description of the condition that resulted in the error.
Conditionally
Name of the subdomain upon which the error occurred.
<dl>
<lh>Subdomains include:</lh>
<dt>
BulkDataExchangeService
</dt>
<dd>
The error is specific to the BulkDataExchangeService service.
</dd>
<dt>
MarketplaceCommon
</dt>
<dd>
The error is common to all Marketplace services.
</dd>
</dl>
Conditionally
Unique identifier for an exception associated with an error.
Conditionally
Some warning and error messages return one or more variables that contain
contextual information about the error. This is often the field or value that
triggered the error.
Conditionally
Contextual information associated with an error.
The name of the parameter in the get of parameter types returned
within the error type.
Conditionally
Indicates whether the error is a severe error (causing the request to fail)
or an informational error (a warning) that should be communicated to the
user.
The request that triggered the error was not processed successfully.
When a serious application-level error occurs, the error is returned
instead of the business data.
The request was processed successfully, but something occurred that may
affect your application or the user. For example, eBay may have changed a
value the user sent in. In this case, eBay returns a normal, successful
response and also returns the warning.
There are three categories of error: request errors, application errors,
and system errors. Request and application errors are caused primarily by
invalid data passed in the request. System errors are caused primarily by
application failures and cannot be corrected by changing request values.
Indicates that an error has occurred on the eBay system side, such as a
database or server down. An application can retry the request as-is a
reasonable number of times (eBay recommends twice). If the error
persists, contact Developer Technical Support. Once the problem has been
resolved, the request may be resent in its original form.
An error occurred due to a problem with the request, such as missing or
invalid fields. The problem must be corrected before the request can be
made again. If the problem is due to something in the application (such
as a missing required field), the application must be changed. Once the
problem in the application or data is resolved, resend the corrected
request to eBay.
An error occurred due to a problem with the request, such as invalid or
missing data. The problem must be corrected before the request can be
made again. If the problem is a result of end-user data, the application
must alert the end-user to the problem and provide the means for the
end-user to correct the data. Once the problem in the data is resolved,
resend the request to eBay with the corrected data.
Returns the current state of a Bulk Data Exchange Job. Use getJobStatus to find
out where your job is in the processing cycle. A request without a specific Job ID
will return status for all jobs.
The job ID and file reference ID have been created as a result of the
createUploadJobRequest or the startDownloadJobRequest.
The job has been internally scheduled for processing by the Bulk Data
Exchange service.
Processing on the data file or the report has begun.
Processing on the data file or the report has finished.
The Bulk Data Exchange has been aborted due to the abortJobRequset
call.
The Bulk Data Exchange job has not completed successfully, due to
incorrect data format, request errors, or Bulk Data Exchange
service errors.
Returns the current state of a recurring Bulk Data Exchange Job.
Job is active.
Job is suspended.
Include this element when creating a recurring job that runs monthly.
Allowed Values: Day_1, Day_2, Day_3, ...Day_28, Day_Last
createRecurringJob
Yes
getRecurringJobs
Always
Recurring Time for the job to run ex:08:00:00.000Z
createRecurringJob
Yes
getRecurringJobs
Always
Include this element when creating a recurring job that runs weekly.
Allowed Values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
createRecurringJob
Yes
getRecurringJobs
Always
Recurring Time for the job to run ex:08:00:00.000Z
createRecurringJob
Yes
getRecurringJobs
Always
Include this element when creating a recurring job that runs daily.
Recurring Time for the job to run ex:08:00:00.000Z
createRecurringJob
Yes
getRecurringJobs
Always
1.4.1