complexType "ns:DisputeType" | eBay Trading API

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:DisputeType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 21 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 21 elements, elem. wildcard
Used:	at 2 locations

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (2):

ns:Dispute (in ns:DisputeArray),

ns:Dispute (in ns:GetDisputeResponse)

Known Usage Locations

As direct type of elements (2):

ns:Dispute (in ns:DisputeArray),

ns:Dispute (in ns:GetDisputeResponse)

Annotation

Contains all information describing a dispute.

Note: 'Item Not Received' or 'Significantly Not As Described' cases, initiated by buyers through the eBay Money Back Guarantee program, are not returned with GetDispute or GetUserDisputes. The getCase method of the Post-Order API is used to retrieve Money Back Guarantee cases programmatically.

XML Source (w/o annotations (22); see within schema source)

<xs:complexType name="DisputeType">

<xs:sequence>

<xs:element minOccurs="0" name="DisputeID" type="ns:DisputeIDType"/>

<xs:element minOccurs="0" name="DisputeRecordType" type="ns:DisputeRecordTypeCodeType"/>

<xs:element minOccurs="0" name="DisputeState" type="ns:DisputeStateCodeType"/>

<xs:element minOccurs="0" name="DisputeStatus" type="ns:DisputeStatusCodeType"/>

<xs:element minOccurs="0" name="OtherPartyRole" type="ns:TradingRoleCodeType"/>

<xs:element minOccurs="0" name="OtherPartyName" type="xs:string"/>

<xs:element minOccurs="0" name="UserRole" type="ns:TradingRoleCodeType"/>

<xs:element minOccurs="0" name="BuyerUserID" type="ns:UserIDType"/>

<xs:element minOccurs="0" name="SellerUserID" type="ns:UserIDType"/>

<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>

<xs:element minOccurs="0" name="Item" type="ns:ItemType"/>

<xs:element minOccurs="0" name="DisputeReason" type="ns:DisputeReasonCodeType"/>

<xs:element minOccurs="0" name="DisputeExplanation" type="ns:DisputeExplanationCodeType"/>

<xs:element minOccurs="0" name="DisputeCreditEligibility" type="ns:DisputeCreditEligibilityCodeType"/>

<xs:element minOccurs="0" name="DisputeCreatedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="DisputeModifiedTime" type="xs:dateTime"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="DisputeResolution" type="ns:DisputeResolutionType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="DisputeMessage" type="ns:DisputeMessageType"/>

<xs:element minOccurs="0" name="Escalation" type="xs:boolean"/>

<xs:element minOccurs="0" name="PurchaseProtection" type="xs:boolean"/>

<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 22/22)

ns:BuyerUserID

Type:

ns:UserIDType, simple content

The eBay user ID of the buyer involved in the dispute.

XML Representation Summary

<ns:BuyerUserID>

Content:

{ xs:string }

</ns:BuyerUserID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="BuyerUserID" type="ns:UserIDType"/>

ns:DisputeCreatedTime

Type:

xs:dateTime, predefined, simple content

The date and time the dispute was created, in GMT.

XML Representation Summary

<ns:DisputeCreatedTime>

Content:

{ xs:dateTime }

</ns:DisputeCreatedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeCreatedTime" type="xs:dateTime"/>

ns:DisputeCreditEligibility

Type:

ns:DisputeCreditEligibilityCodeType, simple content

A value to indicate whether or not the seller is currently eligible for a Final Value Fee credit. The seller becomes eligible for a Final Value Fee credit after filing and winning an Unpaid Item case. This tag only indicates credit eligibility and does not mean that the case can be closed. The seller can open an Unpaid Item case as soon as two days after the listing ends.

XML Representation Summary

<ns:DisputeCreditEligibility>

Content:

{ enumeration of xs:token }

</ns:DisputeCreditEligibility>

Simple Content

Enumeration:

"InEligible"	-	The seller is not currently eligible for a Final Value Fee credit.
"Eligible"	-	The seller is eligible for a Final Value Fee credit.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeCreditEligibility" type="ns:DisputeCreditEligibilityCodeType"/>

ns:DisputeExplanation

Type:

ns:DisputeExplanationCodeType, simple content

The detailed explanation for the dispute. Valid values depend on the value of DisputeReason. See DisputeExplanationCodeList for details.

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:DisputeID

Type:

ns:DisputeIDType, simple content

The unique identifier of an eBay dispute.

XML Representation Summary

<ns:DisputeID>

Content:

{ xs:string }

</ns:DisputeID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeID" type="ns:DisputeIDType"/>

ns:DisputeMessage

Type:

ns:DisputeMessageType, complex content

A response or message posted to a dispute, either by an application or by a user on the eBay site.

Component Diagram

XML Representation Summary

<ns:DisputeMessage>

Content:

ns:MessageID?, ns:MessageSource?, ns:MessageCreationTime?, ns:MessageText?, {any}*

</ns:DisputeMessage>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="DisputeMessage" type="ns:DisputeMessageType"/>

ns:DisputeModifiedTime

Type:

xs:dateTime, predefined, simple content

The date and time the dispute was modified, in GMT.

XML Representation Summary

<ns:DisputeModifiedTime>

Content:

{ xs:dateTime }

</ns:DisputeModifiedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeModifiedTime" type="xs:dateTime"/>

ns:DisputeReason

Type:

ns:DisputeReasonCodeType, simple content

The top-level reason for the dispute. The value of DisputeReason determines which values of DisputeExplanation are valid. See DisputeExplanationCodeList for details.

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:DisputeRecordType

Type:

ns:DisputeRecordTypeCodeType, simple content

A value to indicate the type of dispute.

XML Representation Summary

<ns:DisputeRecordType>

Content:

{ enumeration of xs:token }

</ns:DisputeRecordType>

Simple Content

Enumeration:

"UnpaidItem"	-	This enumeration value indicates that the dispute is an Unpaid Item case created by the seller against the buyer. A seller should always try to resolve an Unpaid Item issue with the buyer before opening up a case with eBay. Sometimes, just sending payment reminders to the buyer or messaging the buyer through the Messaging platform can be helpful. The Resolving unpaid items with buyers help topic provides more details and tips on trying to work Unpaid Item issues out with the buyer.
"ItemNotReceived"	-	This enumeration value indicates that the dispute is an Item Not Received case created by the buyer against the seller through PayPal's platform. Note: As noted above, the GetDispute or GetUserDisputes calls will not return any eBay Money Back Guarantee cases.
"HalfDispute"	-	This enumeration value is no longer applicable as the Half.com marketplace is shut down.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeRecordType" type="ns:DisputeRecordTypeCodeType"/>

ns:DisputeResolution

Type:

ns:DisputeResolutionType, complex content

The action resulting from the dispute resolution. The action might include a Final Value Fee credit to the seller, a strike to the buyer, a reversal, or an appeal.

Component Diagram

XML Representation Summary

<ns:DisputeResolution>

Content:

ns:DisputeResolutionRecordType?, ns:DisputeResolutionReason?, ns:ResolutionTime?, {any}*

</ns:DisputeResolution>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="DisputeResolution" type="ns:DisputeResolutionType"/>

ns:DisputeState

Type:

ns:DisputeStateCodeType, simple content

The internal state of the dispute. The value determines which values of DisputeActivity are valid when responding to a dispute.

XML Representation Summary

<ns:DisputeState>

Content:

{ enumeration of xs:token }

</ns:DisputeState>

Simple Content

Enumeration:

see details at ns:DisputeStateCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeState" type="ns:DisputeStateCodeType"/>

ns:DisputeStatus

Type:

ns:DisputeStatusCodeType, simple content

The status of the dispute, which provides additional information about the dispute state.

XML Representation Summary

<ns:DisputeStatus>

Content:

{ enumeration of xs:token }

</ns:DisputeStatus>

Simple Content

Enumeration:

see details at ns:DisputeStatusCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DisputeStatus" type="ns:DisputeStatusCodeType"/>

ns:Escalation

Type:

xs:boolean, predefined, simple content

This field is returned as true if the buyer is eligible to appeal a closed Item Not Received dispute.

XML Representation Summary

<ns:Escalation>

Content:

{ xs:boolean }

</ns:Escalation>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Escalation" type="xs:boolean"/>

ns:Item

Type:

ns:ItemType, complex content

Container consisting of high-level details about the item involved in the dispute.

Component Diagram

XML Representation Summary

<ns:Item>

Content:

ns:ApplicationData?, ns:AttributeSetArray?, ns:AttributeArray?, ns:LookupAttributeArray?, ns:AutoPay?, ns:BiddingDetails?, ns:BuyerProtection?, ns:BuyItNowPrice?, ns:CategoryMappingAllowed?, ns:Charity?, ns:Country?, ns:CrossPromotion?, ns:Currency?, ns:Description?, ns:DescriptionReviseMode?, ns:Distance?, ns:HitCounter?, ns:ItemID?, ns:ListingDetails?, ns:ListingDuration?, ns:ListingEnhancement*, ns:ListingType?, ns:Location?, ns:LotSize?, ns:PartnerCode?, ns:PartnerName?, ns:PaymentDetails?, ns:PaymentMethods*, ns:PayPalEmailAddress?, ns:PrimaryCategory?, ns:PrivateListing?, ns:ProductListingDetails?, ns:Quantity?, ns:PrivateNotes?, ns:RegionID?, ns:RelistLink?, ns:ReservePrice?, ns:ReviseStatus?, ns:ScheduleTime?, ns:SecondaryCategory?, ns:FreeAddedCategory?, ns:Seller?, ns:SellingStatus?, ns:ShippingDetails?, ns:ShipToLocations*, ns:Site?, ns:StartPrice?, ns:Storefront?, ns:SubTitle?, ns:TimeLeft?, ns:Title?, ns:UUID?, ns:VATDetails?, ns:SellerVacationNote?, ns:WatchCount?, ns:HitCount?, ns:DisableBuyerRequirements?, ns:BestOfferDetails?, ns:LocationDefaulted?, ns:UseTaxTable?, ns:GetItFast?, ns:BuyerResponsibleForShipping?, ns:LimitedWarrantyEligible?, ns:eBayNotes?, ns:QuestionCount?, ns:Relisted?, ns:QuantityAvailable?, ns:SKU?, ns:SearchDetails?, ns:PostalCode?, ns:PictureDetails?, ns:VideoDetails?, ns:DispatchTimeMax?, ns:BestOfferEnabled?, ns:LocalListing?, ns:SellerContactDetails?, ns:TotalQuestionCount?, ns:ProxyItem?, ns:ExtendedSellerContactDetails?, ns:LeadCount?, ns:NewLeadCount?, ns:ItemSpecifics?, ns:GroupCategoryID?, ns:ClassifiedAdPayPerLeadFee?, ns:BidGroupItem?, ns:ApplyBuyerProtection?, ns:ListingSubtype2?, ns:MechanicalCheckAccepted?, ns:UpdateSellerInfo?, ns:UpdateReturnPolicy?, ns:ItemPolicyViolation?, ns:CrossBorderTrade*, ns:BusinessSellerDetails?, ns:BuyerGuaranteePrice?, ns:BuyerRequirementDetails?, ns:ReturnPolicy?, ns:PaymentAllowedSite*, ns:InventoryTrackingMethod?, ns:IntegratedMerchantCreditCardEnabled?, ns:Variations?, ns:ItemCompatibilityList?, ns:ItemCompatibilityCount?, ns:ConditionID?, ns:ConditionDescription?, ns:ConditionDisplayName?, ns:TaxCategory?, ns:QuantityAvailableHint?, ns:QuantityThreshold?, ns:DiscountPriceInfo?, ns:SellerProvidedTitle?, ns:VIN?, ns:VINLink?, ns:VRM?, ns:VRMLink?, ns:QuantityInfo?, ns:SellerProfiles?, ns:ShippingServiceCostOverrideList?, ns:ShippingOverride?, ns:ShippingPackageDetails?, ns:TopRatedListing?, ns:QuantityRestrictionPerBuyer?, ns:FloorPrice?, ns:CeilingPrice?, ns:IsIntermediatedShippingEligible?, ns:UnitInfo?, ns:RelistParentID?, ns:ConditionDefinition?, ns:HideFromSearch?, ns:ReasonHideFromSearch?, ns:PickupInStoreDetails?, ns:SiteId?, ns:IgnoreQuantity?, ns:AvailableForPickupDropOff?, ns:EligibleForPickupDropOff?, ns:LiveAuction?, ns:DigitalGoodInfo?, ns:eBayPlus?, ns:eBayPlusEligible?, ns:eMailDeliveryAvailable?, ns:IsSecureDescription?, {any}*

</ns:Item>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Item" type="ns:ItemType"/>

ns:OrderLineItemID

Type:

xs:string, predefined, simple content

OrderLineItemID is a unique identifier for an eBay order line item. In the case of GetDispute and GetUserDisputes responses, this value identifies the order line item involved in the dispute.

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:OtherPartyName

Type:

xs:string, predefined, simple content

The user name of the person involved in the dispute who is not taking action or requesting information.

XML Representation Summary

<ns:OtherPartyName>

Content:

{ xs:string }

</ns:OtherPartyName>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="OtherPartyName" type="xs:string"/>

ns:OtherPartyRole

Type:

ns:TradingRoleCodeType, simple content

The role of the person involved in the dispute who is not taking action or requesting information. The role is either Buyer or Seller.

XML Representation Summary

<ns:OtherPartyRole>

Content:

{ enumeration of xs:token }

</ns:OtherPartyRole>

Simple Content

Enumeration:

"Buyer"	-	The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.
"Seller"	-	The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.
"CustomCode"	-	This value is reserved for future or internal use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="OtherPartyRole" type="ns:TradingRoleCodeType"/>

ns:PurchaseProtection

Type:

xs:boolean, predefined, simple content

This field is returned as true if the buyer used PayPal to pay for the item, and is eligible for PayPal's Standard Purchase Protection.

XML Representation Summary

<ns:PurchaseProtection>

Content:

{ xs:boolean }

</ns:PurchaseProtection>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PurchaseProtection" type="xs:boolean"/>

ns:SellerUserID

Type:

ns:UserIDType, simple content

The eBay user ID of the seller involved in the dispute.

XML Representation Summary

<ns:SellerUserID>

Content:

{ xs:string }

</ns:SellerUserID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SellerUserID" type="ns:UserIDType"/>

ns:TransactionID

Type:

xs:string, predefined, simple content

The unique identifier of the order line item (transaction) under dispute. An order line item is created once there is a commitment from a buyer to purchase an item. In the case of GetDispute and GetUserDisputes responses, this value identifies the order line item involved in the dispute.

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"/>

ns:UserRole

Type:

ns:TradingRoleCodeType, simple content

The role of the person involved in the dispute who is taking action or requesting information. The role is either Buyer or Seller.

XML Representation Summary

<ns:UserRole>

Content:

{ enumeration of xs:token }

</ns:UserRole>

Simple Content

Enumeration:

"Buyer"	-	The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.
"Seller"	-	The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.
"CustomCode"	-	This value is reserved for future or internal use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="UserRole" type="ns:TradingRoleCodeType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

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.