Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:AddDisputeRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 15 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 5 elements
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:DisputeExplanation?, ns:DisputeReason?, ns:ItemID?, ns:TransactionID?, ns:OrderLineItemID?
</...>
All Direct / Indirect Based Elements (1):
ns:AddDisputeRequest
Known Usage Locations
Annotation
Enables a seller to create an Unpaid Item case against a buyer.

Although the seller is eligible to open up an Unpaid Item case two days after the buyer purchases the item or wins the item through an auction, it is recommended that the seller contact the buyer first to try and make it right before opening a case. The Unpaid Items help page talks more about how a seller should handle an unpaid item.

Note: To create a cancellation request programmatically, the seller would have to use the POST /post-order/v2/cancellation method of the Post-Order API.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:AddDisputeRequestType
XML Source (w/o annotations (6); see within schema source)
<xs:complexType name="AddDisputeRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="DisputeExplanation" type="ns:DisputeExplanationCodeType"/>
<xs:element minOccurs="0" name="DisputeReason" type="ns:DisputeReasonCodeType"/>
<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>
<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>
<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 5/16)
ns:DisputeExplanation
Type:
ns:DisputeExplanationCodeType, simple content
This enumerated value gives the explanation of why the seller opened a case. Not all values contained in DisputeExplanationCodeType are allowed in the AddDispute call, and the values that are allowed must match the DisputeReason value.
XML Representation Summary
<ns:DisputeExplanation>
   
Content: 
{ enumeration of xs:token }
</ns:DisputeExplanation>
Simple Content
Enumeration:
see details at ns:DisputeExplanationCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DisputeExplanation" type="ns:DisputeExplanationCodeType"/>
ns:DisputeReason
Type:
ns:DisputeReasonCodeType, simple content
The enumeration value passed into this required field will depend on the action being taken. The seller will pass in BuyerHasNotPaid if the seller is creating an Unpaid Item case against the buyer, or if the seller has ran out of stock on the item, or otherwise cannot fulfill the order.
XML Representation Summary
<ns:DisputeReason>
   
Content: 
{ enumeration of xs:token }
</ns:DisputeReason>
Simple Content
Enumeration:
see details at ns:DisputeReasonCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DisputeReason" type="ns:DisputeReasonCodeType"/>
ns:ItemID
Type:
ns:ItemIDType, simple content
Unique identifier of an eBay listing. To identify a specific order line item, either an ItemID/TransactionID pair or an OrderLineItemID value must be passed in the request. So, unless OrderLineItemID is used, this field is required.
XML Representation Summary
<ns:ItemID>
   
Content: 
{ xs:string }
</ns:ItemID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>
ns:OrderLineItemID
Type:
xs:string, predefined, simple content
OrderLineItemID is a unique identifier of an order line item. To identify a specific order line item, either an ItemID/TransactionID pair or an OrderLineItemID value must be passed in the request. So, unless ItemID/TransactionID pair is used, this field is required.
XML Representation Summary
<ns:OrderLineItemID>
   
Content: 
{ xs:string }
</ns:OrderLineItemID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>
ns:TransactionID
Type:
xs:string, predefined, simple content
The unique identifier of a buyer's purchase. A TransactionID is created by eBay once a buyer purchases the item through a fixed-priced listing or by using the Buy It Now feature in an auction listing, or when an auction listing ends with a winning bidder. To identify a specific order line item, either an ItemID/TransactionID pair or an OrderLineItemID value must be passed in the request. So, unless OrderLineItemID is used, this field is required.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.
XML Representation Summary
<ns:TransactionID>
   
Content: 
{ xs:string }
</ns:TransactionID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.