eBay Business Policies Management APIVersion 1.0.0
 

getConsolidationJobStatus

This call can be used to retrieve the status of a shipping policies consolidation job.



Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

<?xml version="1.0" encoding="utf-8"?>
<getConsolidationJobStatusRequest xmlns="http://www.ebay.com/marketplace/selling">
  <!-- Call-specific Input Fields -->
  <JobId> long </JobId>
  <!-- Standard Input Fields -->
  <extension> ExtensionType </extension>
  <!-- ... more extension nodes allowed here ... -->
</getConsolidationJobStatusRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
JobId long Optional Unique ID assigned to a shipping policies consolidation job. The JobId value passed into this field will retrieve the shipping policies consolidation job identified by this value. If no JobId is passed in, the status of the most recent consolidation job is returned.
Standard Input Fields  
extension ExtensionType Optional,
repeatable: [0..*]
Reserved for future use.



Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<getConsolidationJobStatusResponse xmlns="http://www.ebay.com/marketplace/selling">
  <!-- Call-specific Output Fields -->
  <Job> ConsolidationJob
    <JobId> long </JobId>
    <JobStatus> ConsolidationJobStatus </JobStatus>
    <JobType> ConsolidationJobType </JobType>
    <SiteId> int </SiteId>
  </Job>
  <!-- ... more Job nodes allowed here ... -->
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter values allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</getConsolidationJobStatusResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
Job ConsolidationJob Always,
repeatable: [1..*]
Container consisting of details related to the shipping policies consolidation job, including the status of the job and the eBay site ID.
Job.JobId long Always Unique identifier for a shipping policies consolidation job. This field will not be returned in the consolidateShippingProfiles response if the call fails to create the job. A JobId value is needed in the GetConsolidationJobStatus request to retrieve a job.
Job.JobStatus ConsolidationJobStatus Always This field indicates the status of the shipping policies consolidation job.

Applicable values:

Complete
This value indicates that the shipping policies consolidation job has successfully completed.
Failed
This value indicates that the shipping policies consolidation job has failed. If this value is returned, it is possible that the user can find the reason for job failure by looking at the errorMessage container (if any) in the same response.
Running
This value indicates that the shipping policies consolidation job is currently in progress.

Code so that your app gracefully handles any future changes to this list.
Job.JobType ConsolidationJobType Always The type of shipping policies consolidation job. Currently, only one value is applicable.

Applicable values:

ShippingProfilesConsolidation
This value indicates that the job type is a shipping policies consolidation job.

Code so that your app gracefully handles any future changes to this list.
Job.SiteId int Always Unique identifier of the eBay listing site.
Standard Output Fields  
ack AckValue Always A token representing the application-level acknowledgment code that indicates the response status, such as success. The AckValue list specifies the possible values for ack.

Applicable values:

Failure
eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
PartialFailure
eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request.
Success
eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
Warning
The request that triggered the error was processed successfully but with one or more warnings.

Code so that your app gracefully handles any future changes to this list.
errorMessage ErrorMessage Conditionally Information for an error or warning that occurred when eBay processed the request.
errorMessage.error ErrorData Conditionally,
repeatable: [0..*]
Details about a single error.
errorMessage.error.category ErrorCategory Conditionally There are three categories of errors: request errors, application errors, and system errors.

Applicable values:

Application
An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
Request
An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
System
Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request 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.

Code so that your app gracefully handles any future changes to this list.
errorMessage.error.domain string Conditionally Name of the domain in which the error occurred.
errorMessage.error.errorId long Conditionally 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.
errorMessage.error.exceptionId token Conditionally Unique identifier for an exception associated with an error.
errorMessage.error.message string Conditionally A detailed description of the condition that caused the error.
errorMessage.error.parameter ErrorParameter (string) Conditionally,
repeatable: [0..*]
Various 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.
errorMessage.error.parameter
  [ attribute name ]
string Conditionally Various 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.
errorMessage.error.severity ErrorSeverity Conditionally Indicates whether the reported problem is fatal (an error) or is less severe (a warning). Review the error message details for information on the cause.

If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, 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, resend the request to eBay.

If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.

If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.

Applicable values:

Error
eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
Warning
The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this response, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.

Code so that your app gracefully handles any future changes to this list.
errorMessage.error.subdomain string Conditionally Name of the subdomain in which the error occurred.
timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ).
version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.



Samples

Code samples not yet added for this call's documentation.



Change History

Change Date Description
1.0.0
2012-02-15
  • (added) New call.