provideShippingInfo

This call is used by the seller to provide the buyer with the name of the shipping carrier and the date that the item was shipped. It is typically used when an original item, a replacement item, or a missing/replacement part is en route to the buyer.

Request Details

In the provideShippingInfo request, the seller must provide the case ID and the case type (EBP_INR or EBP_SNAD only) for the case upon which shipping information will be provided. If the caseId.id and caseId.type values don't match, the request is processed (if caseId.id is valid) but a warning message is returned. The carrierUsed and shippedDate fields are also required.

If not already known, the case ID for an eBay Buyer Protection case can be retrieved with a call to getUserCases. If you make this call, use EBP_INR and/or EBP_SNAD case type filters to restrict results to Item Not Received and/or Significantly Not As Described cases. To get more detailed information on an eBay Buyer Protection case, you will want to call getEBPCaseDetail, using the same case ID in the request.

There is an optional comments field that allows the seller to provide any relevant comments to the buyer.

If a German seller has any supporting documents that will act as proof that an item was shipped to the buyer, the seller can upload one to five documents using the uploadDocuments call.

Working with the Response

The response for provideShippingInfo includes the standard fields for a successful call, which are timestamp and version. If they occur, errors and/or warnings will be returned in an errorMessage container.

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"?>
<provideShippingInfoRequest xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Input Fields -->
  <carrierUsed> string </carrierUsed>
  <caseId> CaseIdType
    <id> string </id>
    <type> CaseType </type>
  </caseId>
  <comments> string </comments>
  <shippedDate> dateTime </shippedDate>
</provideShippingInfoRequest>

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"?>
<provideShippingInfoResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- (No call-specific Output fields) -->

  <!-- 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>
</provideShippingInfoResponse>

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

This call is used by the seller to provide the buyer with the name of the shipping carrier and the date that the item was shipped.

Description

This provideShippingInfo call sample is used by a seller to provide the buyer with the name of the shipping carrier and the date of shipment. an alternative shipping address to the buyer who is returning an item. The case ID, case type, carrierUsed field, and shippedDate field are required. The comments field is optional.

This call will fail if an invalid case ID is passed in. If the case ID does not match the case type that is passed in, a warning message will be returned in the request, but the call will succeed (if case ID is valid). The caller must be authenticated to make this call.

This call only returns the standard output fields to indicate a successful call.

Input

A seller provides the buyer with the name of the shipping carrier and the date of shipment.

The case ID is 5********7. 'EBP_INR' is passed in as the caseId.type value. 'USPS' is passed in as the carrierUsed value, and a timestamp of '2011-03-18T19:14:46.173Z' is passed into the shippedDate field. The string, 'Your item was shipped with USPS on March 18.' is passed into the comments field.

SOAP format. Also available is the XML equivalent.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header>
      <RequesterCredentials>
        <eBayAuthToken>A********3</eBayAuthToken>
      </RequesterCredentials>
   </soap:Header>
   <soap:Body>
      <provideShippingInfoRequest>
         <caseId>
            <id>5********7</id>
            <type>EBP_INR</type>
         </caseId>
         <carrierUsed>USPS</carrierUsed>
         <shippedDate>2011-03-18T19:14:46.173Z</shippedDate>
         <!--Optional:-->
         <comments>Your item was shipped with USPS on March 18.</comments>
      </provideShippingInfoRequest>
   </soap:Body>
</soap:Envelope>

Output

The seller's call is successful as indicated by the Success value in the ack field.

SOAP format. Also available is the XML equivalent.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header/>
   <soap:Body>
      <provideShippingInfoResponse>
         <ack>Success</ack>
         <version>1.3.0</version>
         <timestamp>2011-04-11T02:25:41.001Z</timestamp>
      </provideShippingInfoResponse>
   </soap:Body>
</soap:Envelope>

   Here is the same output in XML format. Note that this does not include standard values.

XML format. Also available is the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<provideShippingInfoResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <ack>Success</ack>
   <version>1.3.0</version>
   <timestamp>2011-04-11T02:25:41.001Z</timestamp>
</provideShippingInfoResponse>

Change History