# Table of Contents - [Develop | eBay Developers Program](#develop-ebay-developers-program) - [eBay Developers Program](#ebay-developers-program) - [Forgot Your Password | eBay Developers Program](#forgot-your-password-ebay-developers-program) - [Categorized Call Index - Trading API](#categorized-call-index-trading-api) - [](#-cdata-api-deprecation-rss-) - [](#-cdata-api-status-rss-) - [Tutorials - Trading API](#tutorials-trading-api) - [Release Notes - Trading API](#release-notes-trading-api) - [Making a Trading API call guide | eBay Developers Program](#making-a-trading-api-call-guide-ebay-developers-program) - [Welcome to the Trading API User Guide | eBay Developers Program](#welcome-to-the-trading-api-user-guide-ebay-developers-program) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Identity API indexes | eBay Developers Program](#identity-api-indexes-ebay-developers-program) - [eBay Developers Program](#ebay-developers-program) - [CheckoutBuyerRequestsTotal | eBay Developers Program](#checkoutbuyerrequeststotal-ebay-developers-program) - [BidReceived | eBay Developers Program](#bidreceived-ebay-developers-program) - [Unknown](#unknown) - [geteBayDetails (ShippingServiceDetails)](#getebaydetails-shippingservicedetails-) - [GetCategoryFeatures](#getcategoryfeatures) - [Unknown](#unknown) - [Unknown](#unknown) - [FindItemsAdvanced documentation](#finditemsadvanced-documentation) - [GetCategoryFeatures](#getcategoryfeatures) - [Unknown](#unknown) - [Unknown](#unknown) - [Global ID Values - API Reference ](#global-id-values-api-reference-) - [Unknown](#unknown) - [geteBayDetails (ShippingServiceDetails)](#getebaydetails-shippingservicedetails-) - [Finding API: Simple Schema Types](#finding-api-simple-schema-types) - [Enumeration Index - API Reference - Return Management API](#enumeration-index-api-reference-return-management-api) - [eBay Site ID to Global ID Mapping - Product API](#ebay-site-id-to-global-id-mapping-product-api) - [CaseTypeEnum - API Reference - Post-Order API](#casetypeenum-api-reference-post-order-api) - [RlspTypeEnum - API Reference - Post-Order API](#rlsptypeenum-api-reference-post-order-api) - [CategoryGroup - API Reference - Business Policies Management API](#categorygroup-api-reference-business-policies-management-api) - [ShippingMethodEnum - API Reference - Post-Order API](#shippingmethodenum-api-reference-post-order-api) - [FundingMethodTypeEnum - API Reference - Post-Order API](#fundingmethodtypeenum-api-reference-post-order-api) - [URIValue - API Reference - Product API](#urivalue-api-reference-product-api) - [ReturnPayoutRecoupInfoType - API Reference - Post-Order API](#returnpayoutrecoupinfotype-api-reference-post-order-api) - [FileFormatEnum - API Reference - Post-Order API](#fileformatenum-api-reference-post-order-api) - [ProductResponse - API Reference - Product API](#productresponse-api-reference-product-api) - [CaseTypeEnum - API Reference - Post-Order API](#casetypeenum-api-reference-post-order-api) - [RefundType - API Reference - Post-Order API](#refundtype-api-reference-post-order-api) - [ReturnHoldStatusEnum - API Reference - Post-Order API](#returnholdstatusenum-api-reference-post-order-api) - [ReturnPolicyInfo - API Reference - Business Policies Management API](#returnpolicyinfo-api-reference-business-policies-management-api) - [ReturnShippingCostType - API Reference - Post-Order API](#returnshippingcosttype-api-reference-post-order-api) - [ErrorMessage - API Reference - Product API](#errormessage-api-reference-product-api) - [ReturnStatusEnum - API Reference - Post-Order API](#returnstatusenum-api-reference-post-order-api) - [FileFormatEnum - API Reference - Post-Order API](#fileformatenum-api-reference-post-order-api) - [DesiredOutcomeTypeEnum - API Reference - Post-Order API](#desiredoutcometypeenum-api-reference-post-order-api) - [ErrorData - API Reference - Product API](#errordata-api-reference-product-api) - [InquirySummaryType - API Reference - Post-Order API](#inquirysummarytype-api-reference-post-order-api) - [PropertyNameValue - API Reference - Product Metadata API](#propertynamevalue-api-reference-product-metadata-api) - [FreightShipping - API Reference - Business Policies Management API](#freightshipping-api-reference-business-policies-management-api) - [FileStatusEnum - API Reference - Post-Order API](#filestatusenum-api-reference-post-order-api) - [UserPartyEnum - API Reference - Post-Order API](#userpartyenum-api-reference-post-order-api) - [PaginationOutput - API Reference - Product API](#paginationoutput-api-reference-product-api) - [ShippingPolicyInfo - API Reference - Business Policies Management API](#shippingpolicyinfo-api-reference-business-policies-management-api) - [ErrorCategory - API Reference - Product API](#errorcategory-api-reference-product-api) - [FundingMethodTypeEnum - API Reference - Post-Order API](#fundingmethodtypeenum-api-reference-post-order-api) - [Applicable values for addSellerProfileRequest.shippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency](#applicable-values-for-addsellerprofilerequest-shippingpolicyprofile-shippingpolicyinfo-shippingpolicycurrency) - [ErrorParameter - API Reference - Product API](#errorparameter-api-reference-product-api) - [ErrorSeverity - API Reference - Product API](#errorseverity-api-reference-product-api) - [Insurance - API Reference - Business Policies Management API](#insurance-api-reference-business-policies-management-api) - [ShippingPolicyProfileList - API Reference - Business Policies Management API](#shippingpolicyprofilelist-api-reference-business-policies-management-api) - [ShippingPolicyInfoService - API Reference - Business Policies Management API](#shippingpolicyinfoservice-api-reference-business-policies-management-api) - [BuyerCloseReturnReasonEnum - API Reference - Post-Order API](#buyerclosereturnreasonenum-api-reference-post-order-api) - [Applicable values for getSellerProfilesResponse.shippingPolicyProfile.ShippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency](#applicable-values-for-getsellerprofilesresponse-shippingpolicyprofile-shippingpolicyprofile-shippingpolicyinfo-shippingpolicycurrency) - [ShippingProfileDiscountInfo - API Reference - Business Policies Management API](#shippingprofilediscountinfo-api-reference-business-policies-management-api) - [Applicable values for addSellerProfileResponse.shippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency](#applicable-values-for-addsellerprofileresponse-shippingpolicyprofile-shippingpolicyinfo-shippingpolicycurrency) - [MarketplaceIdEnum - API Reference - Post-Order API](#marketplaceidenum-api-reference-post-order-api) - [ReturnResponseDueType - API Reference - Post-Order API](#returnresponseduetype-api-reference-post-order-api) - [ReturnReasonTypeEnum - API Reference - Post-Order API](#returnreasontypeenum-api-reference-post-order-api) - [ReturnShippingCostType - API Reference - Post-Order API](#returnshippingcosttype-api-reference-post-order-api) - [AppealGrantStatusEnum - API Reference - Post-Order API](#appealgrantstatusenum-api-reference-post-order-api) - [RefundFundingType - API Reference - Post-Order API](#refundfundingtype-api-reference-post-order-api) - [FileStatusEnum - API Reference - Post-Order API](#filestatusenum-api-reference-post-order-api) - [IsoCurrencyCode - API Reference - Business Policies Management API](#isocurrencycode-api-reference-business-policies-management-api) - [MoneyMovementEntry - API Reference - Post-Order API](#moneymovemententry-api-reference-post-order-api) - [PaymentProviderEnum - API Reference - Post-Order API](#paymentproviderenum-api-reference-post-order-api) - [StatusType - API Reference - Post-Order API](#statustype-api-reference-post-order-api) - [ReturnStatusEnum - API Reference - Post-Order API](#returnstatusenum-api-reference-post-order-api) - [NoSellerUploadLabelReasonEnum - API Reference - Post-Order API](#noselleruploadlabelreasonenum-api-reference-post-order-api) - [ScanDetailType - API Reference - Post-Order API](#scandetailtype-api-reference-post-order-api) - [ShippingPolicyProfile - API Reference - Business Policies Management API](#shippingpolicyprofile-api-reference-business-policies-management-api) - [InternationalReturnPolicyInfo - API Reference - Business Policies Management API](#internationalreturnpolicyinfo-api-reference-business-policies-management-api) - [PaymentProviderEnum - API Reference - Post-Order API](#paymentproviderenum-api-reference-post-order-api) - [RelistStatusEnum - API Reference - Post-Order API](#reliststatusenum-api-reference-post-order-api) - [ReturnPolicyProfileList - API Reference - Business Policies Management API](#returnpolicyprofilelist-api-reference-business-policies-management-api) - [FundingStatusEnum - API Reference - Post-Order API](#fundingstatusenum-api-reference-post-order-api) - [StockPhotoURL - API Reference - Product API](#stockphotourl-api-reference-product-api) - [TotalRefundAmountType - API Reference - Post-Order API](#totalrefundamounttype-api-reference-post-order-api) - [AckValue - API Reference - Product API](#ackvalue-api-reference-product-api) - [ShipmentTrackingDetailType - API Reference - Post-Order API](#shipmenttrackingdetailtype-api-reference-post-order-api) - [OrderType - API Reference - Product API](#ordertype-api-reference-product-api) - [PaymentInfo - API Reference - Business Policies Management API](#paymentinfo-api-reference-business-policies-management-api) - [ReturnStateEnum - API Reference - Post-Order API](#returnstateenum-api-reference-post-order-api) - [CloseReturnReasonEnum - API Reference - Post-Order API](#closereturnreasonenum-api-reference-post-order-api) - [Amount - API Reference - Business Policies Management API](#amount-api-reference-business-policies-management-api) - [FilePurposeEnum - API Reference - Post-Order API](#filepurposeenum-api-reference-post-order-api) - [ReturnPayoutRecoupInfoType - API Reference - Post-Order API](#returnpayoutrecoupinfotype-api-reference-post-order-api) - [StringValue - API Reference - Product API](#stringvalue-api-reference-product-api) - [ReturnPolicyProfile - API Reference - Business Policies Management API](#returnpolicyprofile-api-reference-business-policies-management-api) - [URIValue - API Reference - Product Metadata API](#urivalue-api-reference-product-metadata-api) - [OrderType - API Reference - Product Metadata API](#ordertype-api-reference-product-metadata-api) - [InquiryDetails - API Reference - Post-Order API](#inquirydetails-api-reference-post-order-api) - [SortOrder - API Reference - Product Metadata API](#sortorder-api-reference-product-metadata-api) - [InquiryDetailsResponse - API Reference - Post-Order API](#inquirydetailsresponse-api-reference-post-order-api) - [NumericValue - API Reference - Product API](#numericvalue-api-reference-product-api) - [Notes - API Reference - Product API](#notes-api-reference-product-api) - [RefundInfoType - API Reference - Post-Order API](#refundinfotype-api-reference-post-order-api) - [DepositDetails - API Reference - Business Policies Management API](#depositdetails-api-reference-business-policies-management-api) - [RlspTypeEnum - API Reference - Post-Order API](#rlsptypeenum-api-reference-post-order-api) - [Refund_MoneyMovementStatusEnum - API Reference - Post-Order API](#refund-moneymovementstatusenum-api-reference-post-order-api) - [PaymentProfileList - API Reference - Business Policies Management API](#paymentprofilelist-api-reference-business-policies-management-api) - [ProvideLabelRequest - API Reference - Post-Order API](#providelabelrequest-api-reference-post-order-api) - [EscalationEligibilityInfo - API Reference - Post-Order API](#escalationeligibilityinfo-api-reference-post-order-api) - [SortOrder - API Reference - Product API](#sortorder-api-reference-product-api) - [ret:MoneyMovementDetailType - API Reference - Post-Order API](#ret-moneymovementdetailtype-api-reference-post-order-api) - [StringValue - API Reference - Product Metadata API](#stringvalue-api-reference-product-metadata-api) - [CategoryGroups - API Reference - Business Policies Management API](#categorygroups-api-reference-business-policies-management-api) - [MarkAsReceivedRequest - API Reference - Post-Order API](#markasreceivedrequest-api-reference-post-order-api) - [ItemizedReturnShippingCostType - API Reference - Post-Order API](#itemizedreturnshippingcosttype-api-reference-post-order-api) - [NumericValue - API Reference - Product Metadata API](#numericvalue-api-reference-product-metadata-api) - [ReturnRefundInitiatorEnum - API Reference - Post-Order API](#returnrefundinitiatorenum-api-reference-post-order-api) - [ActivityOptionEnum - API Reference - Post-Order API](#activityoptionenum-api-reference-post-order-api) - [Appeal Case Decision - eBay Post-Order API Reference](#appeal-case-decision-ebay-post-order-api-reference) - [ReturnCreationInfoType - API Reference - Post-Order API](#returncreationinfotype-api-reference-post-order-api) - [Value - API Reference - Product API](#value-api-reference-product-api) - [ErrorSeverity - API Reference - Product Metadata API](#errorseverity-api-reference-product-metadata-api) - [ItemDetailType - API Reference - Post-Order API](#itemdetailtype-api-reference-post-order-api) - [ClaimHistoryEventModel - API Reference - Post-Order API](#claimhistoryeventmodel-api-reference-post-order-api) - [EscalateRequest - API Reference - Post-Order API](#escalaterequest-api-reference-post-order-api) - [Close Case - eBay Post-Order API Reference](#close-case-ebay-post-order-api-reference) - [Product Services APIs](#product-services-apis) - [ReturnHoldInfoType - API Reference - Post-Order API](#returnholdinfotype-api-reference-post-order-api) - [ShippingMethodEnum - API Reference - Post-Order API](#shippingmethodenum-api-reference-post-order-api) - [NoSellerUploadLabelReasonEnum - API Reference - Post-Order API](#noselleruploadlabelreasonenum-api-reference-post-order-api) - [EligibilityResultType - API Reference - Post-Order API](#eligibilityresulttype-api-reference-post-order-api) - [LabelActionEnum - API Reference - Post-Order API](#labelactionenum-api-reference-post-order-api) - [ErrorParameter - API Reference - Product Metadata API](#errorparameter-api-reference-product-metadata-api) - [RefundType - API Reference - Post-Order API](#refundtype-api-reference-post-order-api) - [PartyEnum - API Reference - Post-Order API](#partyenum-api-reference-post-order-api) - [SellerProfile - API Reference - Business Policies Management API](#sellerprofile-api-reference-business-policies-management-api) - [FundingSource - API Reference - Post-Order API](#fundingsource-api-reference-post-order-api) - [Price | eBay Developers Program](#price-ebay-developers-program) - [ErrorCategory - API Reference - Product Metadata API](#errorcategory-api-reference-product-metadata-api) - [BaseResponse - API Reference - Return Management API](#baseresponse-api-reference-return-management-api) - [Unknown](#unknown) - [PropertyValue - API Reference - Product API](#propertyvalue-api-reference-product-api) - [EscalateInquiryRequest - API Reference - Post-Order API](#escalateinquiryrequest-api-reference-post-order-api) - [ConsolidationJobType - API Reference - Business Policies Management API](#consolidationjobtype-api-reference-business-policies-management-api) - [TrackingStatusEnum - API Reference - Post-Order API](#trackingstatusenum-api-reference-post-order-api) - [PaginationInput - API Reference - Product API](#paginationinput-api-reference-product-api) - [IssueRefundRequest - API Reference - Post-Order API](#issuerefundrequest-api-reference-post-order-api) - [Product - API Reference - Product API](#product-api-reference-product-api) - [RequestTypeEnum - API Reference - Post-Order API](#requesttypeenum-api-reference-post-order-api) - [RefundInfo - API Reference - Post-Order API](#refundinfo-api-reference-post-order-api) - [ReturnSortOrderType - API Reference - Return Management API](#returnsortordertype-api-reference-return-management-api) - [ProductStatus - API Reference - Product API](#productstatus-api-reference-product-api) - [ReturnEligibilityErrorDetailType - API Reference - Post-Order API](#returneligibilityerrordetailtype-api-reference-post-order-api) - [ReturnResponseHistoryType - API Reference - Post-Order API](#returnresponsehistorytype-api-reference-post-order-api) - [ProductIdentifier - API Reference - Product API](#productidentifier-api-reference-product-api) - [ReturnStatusType - API Reference - Return Management API](#returnstatustype-api-reference-return-management-api) - [GetConsolidationJobStatusResponse - API Reference - Business Policies Management API](#getconsolidationjobstatusresponse-api-reference-business-policies-management-api) - [ReturnAddressRequest - API Reference - Post-Order API](#returnaddressrequest-api-reference-post-order-api) - [ConsolidationJobStatus - API Reference - Business Policies Management API](#consolidationjobstatus-api-reference-business-policies-management-api) - [Provide Case Shipment Info - eBay Post-Order API Reference](#provide-case-shipment-info-ebay-post-order-api-reference) - [BaseServiceRequest - API Reference - Product API](#baseservicerequest-api-reference-product-api) - [ReturnTypeEnum - API Reference - Post-Order API](#returntypeenum-api-reference-post-order-api) - [PaymentProfile - API Reference - Business Policies Management API](#paymentprofile-api-reference-business-policies-management-api) - [PartialOrderTypeEnum - API Reference - Post-Order API](#partialordertypeenum-api-reference-post-order-api) - [PropertyValue - API Reference - Product Metadata API](#propertyvalue-api-reference-product-metadata-api) - [PayoutRecoupInfo - API Reference - Post-Order API](#payoutrecoupinfo-api-reference-post-order-api) - [PaymentStatusEnum - API Reference - Post-Order API](#paymentstatusenum-api-reference-post-order-api) - [GetProductDetailsRequest - API Reference - Product API](#getproductdetailsrequest-api-reference-product-api) - [RequestTypeEnum - API Reference - Post-Order API](#requesttypeenum-api-reference-post-order-api) - [ItemDetails - API Reference - Post-Order API](#itemdetails-api-reference-post-order-api) - [ReturnRefundInitiatorEnum - API Reference - Post-Order API](#returnrefundinitiatorenum-api-reference-post-order-api) - [FundingSourceType - API Reference - Post-Order API](#fundingsourcetype-api-reference-post-order-api) - [Value - API Reference - Product Metadata API](#value-api-reference-product-metadata-api) - [ReturnTypeEnum - API Reference - Post-Order API](#returntypeenum-api-reference-post-order-api) - [ErrorParameter - API Reference - Business Policies Management API](#errorparameter-api-reference-business-policies-management-api) - [FundingStatusEnum - API Reference - Post-Order API](#fundingstatusenum-api-reference-post-order-api) - [ReturnCloseInfoType - API Reference - Post-Order API](#returncloseinfotype-api-reference-post-order-api) - [CaseSummaryType - API Reference - Post-Order API](#casesummarytype-api-reference-post-order-api) - [EstimatedRefundType - API Reference - Post-Order API](#estimatedrefundtype-api-reference-post-order-api) - [ReturnSummaryType - API Reference - Post-Order API](#returnsummarytype-api-reference-post-order-api) - [Unknown](#unknown) - [Unknown](#unknown) - [CreateReturnRequest - API Reference - Post-Order API](#createreturnrequest-api-reference-post-order-api) - [ConsolidateShippingProfilesResponse - API Reference - Business Policies Management API](#consolidateshippingprofilesresponse-api-reference-business-policies-management-api) - [ActionDeadlines - API Reference - Post-Order API](#actiondeadlines-api-reference-post-order-api) - [RelistStatusEnum - API Reference - Post-Order API](#reliststatusenum-api-reference-post-order-api) - [LabelActionEnum - API Reference - Post-Order API](#labelactionenum-api-reference-post-order-api) - [Merchandising API | eBay Developers Program](#merchandising-api-ebay-developers-program) - [Unknown](#unknown) - [ActualRefund - API Reference - Post-Order API](#actualrefund-api-reference-post-order-api) - [GetProductSearchDataVersionResponse - API Reference - Product Metadata API](#getproductsearchdataversionresponse-api-reference-product-metadata-api) - [CreateReturnRequest - API Reference - Post-Order API](#createreturnrequest-api-reference-post-order-api) - [GetTrackingHistoryResponse - API Reference - Post-Order API](#gettrackinghistoryresponse-api-reference-post-order-api) - [CaseDetails - API Reference - Post-Order API](#casedetails-api-reference-post-order-api) - [FundingMethodBrandEnum - API Reference - Post-Order API](#fundingmethodbrandenum-api-reference-post-order-api) - [ErrorData - API Reference - Product Metadata API](#errordata-api-reference-product-metadata-api) - [ReturnUserRoleEnum - API Reference - Post-Order API](#returnuserroleenum-api-reference-post-order-api) - [Global ID Values - Product API](#global-id-values-product-api) - [ReturnSortType - API Reference - Return Management API](#returnsorttype-api-reference-return-management-api) - [ReturnStatusInputType - API Reference - Return Management API](#returnstatusinputtype-api-reference-return-management-api) - [TrackingStatusType - API Reference - Return Management API](#trackingstatustype-api-reference-return-management-api) - [CaseType - API Reference - Return Management API](#casetype-api-reference-return-management-api) - [ActivityOptionType - API Reference - Return Management API](#activityoptiontype-api-reference-return-management-api) - [MoneyMovementEntries - API Reference - Post-Order API](#moneymovemententries-api-reference-post-order-api) - [AppealGrantStatusEnum - API Reference - Post-Order API](#appealgrantstatusenum-api-reference-post-order-api) - [DecideReturnRequest - API Reference - Post-Order API](#decidereturnrequest-api-reference-post-order-api) - [Issue Case Refund - eBay Post-Order API Reference](#issue-case-refund-ebay-post-order-api-reference) - [ErrorSeverity - API Reference - Business Policies Management API](#errorseverity-api-reference-business-policies-management-api) - [ItemizedRefundDetailType - API Reference - Post-Order API](#itemizedrefunddetailtype-api-reference-post-order-api) - [ReturnUserRoleType - API Reference - Return Management API](#returnuserroletype-api-reference-return-management-api) - [ShipmentStatusType - API Reference - Return Management API](#shipmentstatustype-api-reference-return-management-api) - [UserFilterRoleType - API Reference - Return Management API](#userfilterroletype-api-reference-return-management-api) - [ProfileType - API Reference - Business Policies Management API](#profiletype-api-reference-business-policies-management-api) - [RefundAmounts - API Reference - Post-Order API](#refundamounts-api-reference-post-order-api) - [ReturnAddress - API Reference - Post-Order API](#returnaddress-api-reference-post-order-api) - [CreateInquiryRequest - API Reference - Post-Order API](#createinquiryrequest-api-reference-post-order-api) - [GetProductSearchDataVersionResponse - API Reference - Product Metadata API](#getproductsearchdataversionresponse-api-reference-product-metadata-api) - [ErrorCategory - API Reference - Business Policies Management API](#errorcategory-api-reference-business-policies-management-api) - [ProductDetailsRequestType - API Reference - Product API](#productdetailsrequesttype-api-reference-product-api) - [RefundFeeType - API Reference - Return Management API](#refundfeetype-api-reference-return-management-api) - [ReturnType - API Reference - Return Management API](#returntype-api-reference-return-management-api) - [CaseDetailsResponse - API Reference - Post-Order API](#casedetailsresponse-api-reference-post-order-api) - [GetCancelDetailResponse - API Reference - Post-Order API](#getcanceldetailresponse-api-reference-post-order-api) - [eBay Site ID to Global ID Mapping - Product API](#ebay-site-id-to-global-id-mapping-product-api) - [FindProductsRequest - API Reference - Product API](#findproductsrequest-api-reference-product-api) - [BaseServiceResponse - API Reference - Product Metadata API](#baseserviceresponse-api-reference-product-metadata-api) - [ClaimHistoryResponse - API Reference - Post-Order API](#claimhistoryresponse-api-reference-post-order-api) - [PartyEnum - API Reference - Post-Order API](#partyenum-api-reference-post-order-api) - [ReturnAddressType - API Reference - Post-Order API](#returnaddresstype-api-reference-post-order-api) - [CancelActivityHistory - API Reference - Post-Order API](#cancelactivityhistory-api-reference-post-order-api) - [ReturnHoldStatusEnum - API Reference - Post-Order API](#returnholdstatusenum-api-reference-post-order-api) - [TrackingStatusEnum - API Reference - Post-Order API](#trackingstatusenum-api-reference-post-order-api) - [RefundInfoType - API Reference - Post-Order API](#refundinfotype-api-reference-post-order-api) - [ReturnUserRoleEnum - API Reference - Post-Order API](#returnuserroleenum-api-reference-post-order-api) - [InquirySearchResponse - API Reference - Post-Order API](#inquirysearchresponse-api-reference-post-order-api) - [DecisionEnum - API Reference - Post-Order API](#decisionenum-api-reference-post-order-api) - [GetDetailResponse - API Reference - Post-Order API](#getdetailresponse-api-reference-post-order-api) - [EstimatedRefundType - API Reference - Post-Order API](#estimatedrefundtype-api-reference-post-order-api) - [Global ID Values - Product API](#global-id-values-product-api) - [FundingMethodBrandEnum - API Reference - Post-Order API](#fundingmethodbrandenum-api-reference-post-order-api) - [AckValue - API Reference - Product Metadata API](#ackvalue-api-reference-product-metadata-api) - [AppealDetails - API Reference - Post-Order API](#appealdetails-api-reference-post-order-api) - [Product search feed response definitions | eBay Developers Program](#product-search-feed-response-definitions-ebay-developers-program) - [Payment method | eBay Developers Program](#payment-method-ebay-developers-program) - [ProductRequest - API Reference - Product API](#productrequest-api-reference-product-api) - [CaseSearchResponse - API Reference - Post-Order API](#casesearchresponse-api-reference-post-order-api) - [ReturnCountFilterEnum - API Reference - Post-Order API](#returncountfilterenum-api-reference-post-order-api) - [EscalationInfoType - API Reference - Post-Order API](#escalationinfotype-api-reference-post-order-api) - [BaseRequest - API Reference - Business Policies Management API](#baserequest-api-reference-business-policies-management-api) - [ErrorData - API Reference - Business Policies Management API](#errordata-api-reference-business-policies-management-api) - [Quantity | eBay Developers Program](#quantity-ebay-developers-program) - [ShipmentType - API Reference - Post-Order API](#shipmenttype-api-reference-post-order-api) - [ReturnEligibilityItemPerCheckTypeResult - API Reference - Post-Order API](#returneligibilityitemperchecktyperesult-api-reference-post-order-api) - [RefundInfo - API Reference - Post-Order API](#refundinfo-api-reference-post-order-api) - [UserPartyEnum - API Reference - Post-Order API](#userpartyenum-api-reference-post-order-api) - [ActualRefundDetail - API Reference - Post-Order API](#actualrefunddetail-api-reference-post-order-api) - [ErrorMessage - API Reference - Business Policies Management API](#errormessage-api-reference-business-policies-management-api) - [Add a picture | eBay Developers Program](#add-a-picture-ebay-developers-program) - [Item location | eBay Developers Program](#item-location-ebay-developers-program) - [can:MoneyMovementDetailType - API Reference - Post-Order API](#can-moneymovementdetailtype-api-reference-post-order-api) - [ActualRefundDetailType - API Reference - Post-Order API](#actualrefunddetailtype-api-reference-post-order-api) - [Delete inventory feed response definitions | eBay Developers Program](#delete-inventory-feed-response-definitions-ebay-developers-program) - [ReturnFileType - API Reference - Post-Order API](#returnfiletype-api-reference-post-order-api) - [VersionDetails - API Reference - Product Metadata API](#versiondetails-api-reference-product-metadata-api) - [Locale enumerated values | eBay Developers Program](#locale-enumerated-values-ebay-developers-program) - [ErrorMessage - API Reference - Product Metadata API](#errormessage-api-reference-product-metadata-api) - [FindCancelResponse - API Reference - Post-Order API](#findcancelresponse-api-reference-post-order-api) - [Delete inventory feed definitions | eBay Developers Program](#delete-inventory-feed-definitions-ebay-developers-program) - [RefundStatusType - API Reference - Return Management API](#refundstatustype-api-reference-return-management-api) - [BaseServiceResponse - API Reference - Product Metadata API](#baseserviceresponse-api-reference-product-metadata-api) - [Buy online and pick up in store | eBay Developers Program](#buy-online-and-pick-up-in-store-ebay-developers-program) - [Relist using different API versions | eBay Developers Program](#relist-using-different-api-versions-ebay-developers-program) - [Test/preview a relisting | eBay Developers Program](#test-preview-a-relisting-ebay-developers-program) - [AckValue - API Reference - Business Policies Management API](#ackvalue-api-reference-business-policies-management-api) - [Response files | eBay Developers Program](#response-files-ebay-developers-program) - [Product Services Tutorials - Product API](#product-services-tutorials-product-api) - [Marketplace enumerated values | eBay Developers Program](#marketplace-enumerated-values-ebay-developers-program) - [Simple Schema Types - Return Management API](#simple-schema-types-return-management-api) - [ShipmentType - API Reference - Post-Order API](#shipmenttype-api-reference-post-order-api) - [Provides Return Address - eBay Post-Order API Reference](#provides-return-address-ebay-post-order-api-reference) - [BaseResponse - API Reference - Business Policies Management API](#baseresponse-api-reference-business-policies-management-api) - [Order fulfillment response file definitions | eBay Developers Program](#order-fulfillment-response-file-definitions-ebay-developers-program) - [Specify a return policy | eBay Developers Program](#specify-a-return-policy-ebay-developers-program) - [Specify shipping options | eBay Developers Program](#specify-shipping-options-ebay-developers-program) - [Administratively ended listings | eBay Developers Program](#administratively-ended-listings-ebay-developers-program) - [Business Policies Management API | Index](#business-policies-management-api-index) - [Business Policies Management API | Users Guide](#business-policies-management-api-users-guide) - [ExtensionType - API Reference - Business Policies Management API](#extensiontype-api-reference-business-policies-management-api) - [MetadataCodeType - API Reference - Return Management API](#metadatacodetype-api-reference-return-management-api) - [Listing duration | eBay Developers Program](#listing-duration-ebay-developers-program) - [Listing type | eBay Developers Program](#listing-type-ebay-developers-program) - [Order fulfillment feed definitions | eBay Developers Program](#order-fulfillment-feed-definitions-ebay-developers-program) - [FindProductsResponse - API Reference - Product API](#findproductsresponse-api-reference-product-api) - [Enumeration Index - API Reference - Product Metadata API](#enumeration-index-api-reference-product-metadata-api) - [Enumeration Index - API Reference - Product Metadata API](#enumeration-index-api-reference-product-metadata-api) - [Product search feed definitions | eBay Developers Program](#product-search-feed-definitions-ebay-developers-program) - [Preview a revision | eBay Developers Program](#preview-a-revision-ebay-developers-program) - [Availability feed response definitions | eBay Developers Program](#availability-feed-response-definitions-ebay-developers-program) - [Product combined feed response definitions | eBay Developers Program](#product-combined-feed-response-definitions-ebay-developers-program) - [Remove a field | eBay Developers Program](#remove-a-field-ebay-developers-program) - [Revise a US eBay motors listing | eBay Developers Program](#revise-a-us-ebay-motors-listing-ebay-developers-program) - [ConsolidationJob - API Reference - Business Policies Management API](#consolidationjob-api-reference-business-policies-management-api) - [Remove a field | eBay Developers Program](#remove-a-field-ebay-developers-program) - [ResponseHistoryAttributesType - API Reference - Post-Order API](#responsehistoryattributestype-api-reference-post-order-api) - [Release Notes Archive - Trading API](#release-notes-archive-trading-api) - [Location feed response definitions | eBay Developers Program](#location-feed-response-definitions-ebay-developers-program) - [Availability feed definitions | eBay Developers Program](#availability-feed-definitions-ebay-developers-program) - [Distribution feed response definitions | eBay Developers Program](#distribution-feed-response-definitions-ebay-developers-program) - [SiteID | eBay Developers Program](#siteid-ebay-developers-program) - [Revise a charity listing | eBay Developers Program](#revise-a-charity-listing-ebay-developers-program) - [Location feed definitions | eBay Developers Program](#location-feed-definitions-ebay-developers-program) - [CategoryID | eBay Developers Program](#categoryid-ebay-developers-program) - [Category versioning | eBay Developers Program](#category-versioning-ebay-developers-program) - [SKU identifiers | eBay Developers Program](#sku-identifiers-ebay-developers-program) - [Minimum advertised price | eBay Developers Program](#minimum-advertised-price-ebay-developers-program) - [Business Policies Management API | Release Notes](#business-policies-management-api-release-notes) - [Fee discounts | eBay Developers Program](#fee-discounts-ebay-developers-program) - [View a Second Chance Offer listing | eBay Developers Program](#view-a-second-chance-offer-listing-ebay-developers-program) - [Manage store categories | eBay Developers Program](#manage-store-categories-ebay-developers-program) - [Release Notes Archive - Trading API](#release-notes-archive-trading-api) - [Product feed response definitions | eBay Developers Program](#product-feed-response-definitions-ebay-developers-program) - [Associate pictures with a listing | eBay Developers Program](#associate-pictures-with-a-listing-ebay-developers-program) - [Terminate a second chance offer | eBay Developers Program](#terminate-a-second-chance-offer-ebay-developers-program) - [Relist with revised product details | eBay Developers Program](#relist-with-revised-product-details-ebay-developers-program) - [Include item specifics | eBay Developers Program](#include-item-specifics-ebay-developers-program) - [Strikethrough pricing | eBay Developers Program](#strikethrough-pricing-ebay-developers-program) - [Business Policies Management API | Making a Call](#business-policies-management-api-making-a-call) - [Revise immediate payment requirement | eBay Developers Program](#revise-immediate-payment-requirement-ebay-developers-program) - [Condition differences across categories | eBay Developers Program](#condition-differences-across-categories-ebay-developers-program) - [Change the reserve price | eBay Developers Program](#change-the-reserve-price-ebay-developers-program) - [Revise and relist with variations | eBay Developers Program](#revise-and-relist-with-variations-ebay-developers-program) - [Create a second chance offer | eBay Developers Program](#create-a-second-chance-offer-ebay-developers-program) - [Retrieve an eBay for Charity listing | eBay Developers Program](#retrieve-an-ebay-for-charity-listing-ebay-developers-program) - [Product identifiers | eBay Developers Program](#product-identifiers-ebay-developers-program) - [Release Notes - Product API](#release-notes-product-api) - [Edit a ConditionID | eBay Developers Program](#edit-a-conditionid-ebay-developers-program) - [Picture hosting | eBay Developers Program](#picture-hosting-ebay-developers-program) - [GetMyeBaySelling | eBay Developers Program](#getmyebayselling-ebay-developers-program) - [Promoted Listings priority strategy campaign flow | eBay Developers Program](#promoted-listings-priority-strategy-campaign-flow-ebay-developers-program) - [Enumeration Index - API Reference - Business Policies Management API](#enumeration-index-api-reference-business-policies-management-api) - [Fees for listing with zero quantity | eBay Developers Program](#fees-for-listing-with-zero-quantity-ebay-developers-program) - [Fees by marketplace | eBay Developers Program](#fees-by-marketplace-ebay-developers-program) - [Create an eBay for Charity listing | eBay Developers Program](#create-an-ebay-for-charity-listing-ebay-developers-program) - [Revise multiple-choice fields | eBay Developers Program](#revise-multiple-choice-fields-ebay-developers-program) - [Item eligibility | eBay Developers Program](#item-eligibility-ebay-developers-program) - [Change a listing`s category | eBay Developers Program](#change-a-listing-s-category-ebay-developers-program) - [Identify and select the right category | eBay Developers Program](#identify-and-select-the-right-category-ebay-developers-program) - [Revise product details | eBay Developers Program](#revise-product-details-ebay-developers-program) - [Amount - API Reference - Business Policies Management API](#amount-api-reference-business-policies-management-api) - [API versus UI feature comparison | eBay Developers Program](#api-versus-ui-feature-comparison-ebay-developers-program) - [Call Index - API Reference - Product API](#call-index-api-reference-product-api) - [Browse a seller`s items | eBay Developers Program](#browse-a-seller-s-items-ebay-developers-program) - [Retrieve data for one item | eBay Developers Program](#retrieve-data-for-one-item-ebay-developers-program) - [How to upload and manage feeds | eBay Developers Program](#how-to-upload-and-manage-feeds-ebay-developers-program) - [GetMyeBayBuying | eBay Developers Program](#getmyebaybuying-ebay-developers-program) - [Enable Out-of-Stock | eBay Developers Program](#enable-out-of-stock-ebay-developers-program) - [How Out-of-Stock works | eBay Developers Program](#how-out-of-stock-works-ebay-developers-program) - [Condition | eBay Developers Program](#condition-ebay-developers-program) - [Automatically accept or decline offers | eBay Developers Program](#automatically-accept-or-decline-offers-ebay-developers-program) - [Revise fixed-price items after purchases are made | eBay Developers Program](#revise-fixed-price-items-after-purchases-are-made-ebay-developers-program) - [Best Offer flow | eBay Developers Program](#best-offer-flow-ebay-developers-program) - [Promoted Listings general strategy campaign flow | eBay Developers Program](#promoted-listings-general-strategy-campaign-flow-ebay-developers-program) - [AdRateStrategyEnum: eBay Marketing API | eBay Developers Program](#adratestrategyenum-ebay-marketing-api-ebay-developers-program) - [Category ID mapping | eBay Developers Program](#category-id-mapping-ebay-developers-program) - [Qualifications to revise an item | eBay Developers Program](#qualifications-to-revise-an-item-ebay-developers-program) - [Revise prices | eBay Developers Program](#revise-prices-ebay-developers-program) - [Listing title | eBay Developers Program](#listing-title-ebay-developers-program) - [CustomerServiceMetricsFilterCriteria: eBay Feed API | eBay Developers Program](#customerservicemetricsfiltercriteria-ebay-feed-api-ebay-developers-program) - [Amount - API Reference - Post-Order API](#amount-api-reference-post-order-api) - [Item description | eBay Developers Program](#item-description-ebay-developers-program) - [Counteroffers | eBay Developers Program](#counteroffers-ebay-developers-program) - [findProducts - API Reference - Product API](#findproducts-api-reference-product-api) - [getProductCompatibilities - API Reference - Product API](#getproductcompatibilities-api-reference-product-api) - [getProductDetails - API Reference - Product API](#getproductdetails-api-reference-product-api) - [getProductDetails - API Reference - Product API](#getproductdetails-api-reference-product-api) - [findProducts - API Reference - Product API](#findproducts-api-reference-product-api) - [getProductCompatibilities - API Reference - Product API](#getproductcompatibilities-api-reference-product-api) - [GetProductSearchValuesResponse - API Reference - Product Metadata API](#getproductsearchvaluesresponse-api-reference-product-metadata-api) - [MoneyMovementEntries - API Reference - Post-Order API](#moneymovemententries-api-reference-post-order-api) - [Enumeration Index - API Reference - Product API](#enumeration-index-api-reference-product-api) - [SetSellerProfileRequest - API Reference - Business Policies Management API](#setsellerprofilerequest-api-reference-business-policies-management-api) - [GetSummaryResponse - API Reference - Post-Order API](#getsummaryresponse-api-reference-post-order-api) - [BaseServiceResponse - API Reference - Product API](#baseserviceresponse-api-reference-product-api) - [GetSellerProfilesResponse - API Reference - Business Policies Management API](#getsellerprofilesresponse-api-reference-business-policies-management-api) - [GetProductCompatiblitiesResponse - API Reference - Product API](#getproductcompatiblitiesresponse-api-reference-product-api) - [CreateReturnResponse - API Reference - Post-Order API](#createreturnresponse-api-reference-post-order-api) - [UploadFileRequest - API Reference - Post-Order API](#uploadfilerequest-api-reference-post-order-api) - [DecideReturnResponse - API Reference - Post-Order API](#decidereturnresponse-api-reference-post-order-api) --- # Develop | eBay Developers Program [Skip to main content](https://developer.ebay.com/develop#mainContent) * **New Feature:** The Inventory Mapping API helps you turn your existing product data into high-quality listings with AI-powered recommendations. Learn more [here](https://developer.ebay.com/updates/blog/explore-inventory-mapping-api) . * **API License Agreement Update:** We have made significant enhancements to our [API License Agreement](https://developer.ebay.com/join/api-license-agreement) , including detailed data protection measures and compliance with international regulations. Important restrictions have been applied to the use of Restricted APIs and AI content. Developers must review the updated agreement to ensure compliance. * **Important Update:** eBay's API integrations will be modified to address data handling requirements for select developers. Usernames will be replaced with immutable user IDs, and financial data will be protected for certain users. Learn more [here](https://developer.ebay.com/api-docs/static/data-handling-update.html) . As a member of the eBay Developers Program, you have access to eBay’s platform and technical resources. eBay APIs offer you the power to create a wide variety of solutions to meet the diverse needs of the millions of buyers and sellers on eBay. Using our program resources, you can create your own apps that communicate directly with eBay business logic and databases. Your apps can provide a custom interface, functionality, and specialized operations that are not available through the eBay web flow or mobile applications. ### Get Started with APIs Get up and running with eBay APIs and start innovating within the e-commerce space. [Learn more](https://developer.ebay.com/api-docs/static/gs_ebay-rest-getting-started-landing.html) [Let's go!](https://developer.ebay.com/develop/get-started) ### Develop Selling Applications Use our APIs to create selling applications tailored to each step of the online selling process. [Guide](https://developer.ebay.com/api-docs/sell/static/selling-ig-landing.html) [APIs](https://developer.ebay.com/develop/selling-apps) ### Develop Buying Applications Creating buying apps with eBay APIs can enhance the shopping experience for users. [Guide](https://developer.ebay.com/api-docs/buy/static/buying-ig-landing.html) [APIs](https://developer.ebay.com/develop/buying-apps) ### Application Settings & Insights Application Settings and Insights [APIs](https://developer.ebay.com/develop/application-settings-and-insights) ### SDKs & Widgets Get details on all eBay SDKs and Widgets. [View more](https://developer.ebay.com/develop/sdks-and-widgets) ### Tools Get details on all eBay tools. [View tools](https://developer.ebay.com/develop/tools) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # eBay Developers Program [Skip to main content](https://developer.ebay.com/keystone/base-layouts/ebay.co.uk#mainContent) * **API License Agreement Update:** We have made significant enhancements to our [API License Agreement](https://developer.ebay.com/join/api-license-agreement) , including detailed data protection measures and compliance with international regulations. Important restrictions have been applied to the use of Restricted APIs and AI content. Developers must review the updated agreement to ensure compliance. * **Important Update:** eBay's API integrations will be modified to address data handling requirements for select developers. Usernames will be replaced with immutable user IDs, and financial data will be protected for certain users. Learn more [here](https://developer.ebay.com/api-docs/static/data-handling-update.html) . Updates ======= Keep up-to-date with our [latest API enhancements.](https://developer.ebay.com/updates) ### eBay Developers Program Q4 2025 Newsletter Program news, API updates, and deprecations for the fourth quarter of 2025. [Learn more](https://developer.ebay.com/updates/newsletter/q4_2025) ### Explore the Inventory Mapping API The Inventory Mapping API helps you turn your existing product data into high-quality listings with AI-powered recommendations. [Learn more](https://developer.ebay.com/updates/blog/explore-inventory-mapping-api) ### A New Era of Partnership Accelerate your growth using eBay’s Developer Loyalty Program with upgraded concierge service, expanded benefits, and clearer guidelines. [Learn more](https://developer.ebay.com/updates/blog/new-partnership-era) Events ====== Plan for upcoming conferences and webinars, or [see what you missed at past events.](https://developer.ebay.com/grow/events) ![Background image](https://developer.ebay.com/cms/img/connect-2023/thumb.jpg) [Learn more](https://developer.ebay.com/grow/events/ebay-connect-2023) ![Background image](https://developer.ebay.com/cms/img/connect-2022/connect_2022_1.png) [Learn more](https://developer.ebay.com/grow/events/ebay-connect-2022) ![Background image](https://developer.ebay.com/cms/img/connect-2021/thumb.png) [Learn more](https://developer.ebay.com/grow/events/ebay-connect-2021) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Forgot Your Password | eBay Developers Program [Skip to main content](https://developer.ebay.com/fyp#mainContent) * **API License Agreement Update:** We have made significant enhancements to our [API License Agreement](https://developer.ebay.com/join/api-license-agreement) , including detailed data protection measures and compliance with international regulations. Important restrictions have been applied to the use of Restricted APIs and AI content. Developers must review the updated agreement to ensure compliance. * **Important Update:** eBay's API integrations will be modified to address data handling requirements for select developers. Usernames will be replaced with immutable user IDs, and financial data will be protected for certain users. Learn more [here](https://developer.ebay.com/api-docs/static/data-handling-update.html) . Reset your eBay Developers Program password ------------------------------------------- Enter the username you use to login to your eBay Developers Program account. If you can't remember it, enter your registered email instead. Please enter a valid username or email. ##### Select how you want to reset your password Email the PIN Text the PIN if the account includes a mobile phone number       \* Mobile carrier charges may apply Forgot your username or can't access your registered email or mobile phone? [Developer Account Support](https://developer.ebay.com/support/developer-account-support) for help. Send Now #### We will send your one-time PIN to the following: Email: Phone: \* \*By selecting this method, you agree to receive a text message to this mobile number. You understand that your mobile provider’s message and data rates may apply. Cancel Confirm ### Confirm Your Email Address Thank you! The account verification email was sent to the email address: Click on the link in the email to finish your registration. Check your spam box, if you don’t see it in your inbox. Re-send it #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Categorized Call Index - Trading API eBay Trading APIVersion 1451 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/api-docs/user-guides/static/make-a-call-landing.html) * [API Reference](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/index.html) * [Tutorials](https://developer.ebay.com/Devzone/xml/docs/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html) Categorized Call Index ====================== This Categorized Call Index contains links to groups of related Trading API calls. For the original alphabetical Call Index page, go [here](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/alphaindex.html) . | Call Category | Summary | | --- | --- | | [Standard Listing Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/StandardListingIndex.html) | The calls in this group are used to add, revise, relist, get, or end eBay listings. There are also calls in this group to revise inventory quantity for a fixed-priced listing, to upload pictures to the listing, and to retrieve items that you are currently bidding on or have won/purchased. | | [Order Management Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/OrderManagementIndex.html) | The calls in this group are used to retrieve the seller's orders and to perform other post-order tasks such as marking an item as shipped, providing shipment tracking information to the buyer, providing feedback to the buyer, updating the status of an order, and updating the buyer's shipping address. | | [Special Offer and Listing Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/SpecialOfferIndex.html) | The calls in this group are used to place an offer on a listing, to create a **Second-Chance Offer**, to get and respond to **Best Offers**, and to retrieve buyer interest leads for classified ads. | | [Buyer/Seller Communication Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/CommunicationIndex.html) | The calls in this group are used to communicate with other eBay members, to set and get eBay messaging preferences, to manage My Messages, to get, leave, and respond to feedback, and to create and manage PayPal Purhcase Protection disputes. | | [eBay Metadata Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/MetadataIndex.html) | The calls in this group are used to retrieve eBay site-specific (e.g. **GeteBayDetails**), eBay category-specific (e.g. **GetCategoryFeatures**, or eBay listing-specific (e.g. **GetItemShipping**) metadata. | | [eBay User Account Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/UserAccountIndex.html) | The calls in this group are used to retrieve detailed information on a user's account, to retrieve detailed buying and selling activity, to set and get current account settings and preferences, to set and get eBay platform notifications, and to perform various other tasks related to a user's account. | | [eBay Stores Calls](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/eBayStoresIndex.html) | The calls in this group are used to retrieve eBay Store settings, and to manage eBay Store categories. | --- # https://developer.ebay.com/docs/api-deprecationRSS for NodeSat, 28 Mar 2026 10:47:31 -0700/api-docs/sell/marketing/resources/methods1Marketing APIsetupQuickCampaignlaunchCampaign 2026/01/26 2026/03/31The listed methods have been deprecated from the Marketing API and will be decommissioned on March 31st, 2026. /devzone/xml/docs/Reference/eBay/index.html2Trading API  2026/01/21 2026/02/16 This field has been deprecated and is no longer supported by the AddItem family of calls. If it is used, it will be ignored and dropped. This field will be decommissioned and removed from the WSDL on February 16th, 2026./devzone/xml/docs/Reference/eBay/index.html3Trading API  2026/01/21 2026/02/16 This field has been deprecated and will no longer be supported by the GetItem, GetSellerEvents, and GetSellerList calls. This field will be decommissioned on February 16th, 2026./api-docs/sell/compliance/resources/methods4Compliance APIgetListingViolationsSummarygetListingViolations 2026/01/162026/03/30The Compliance API has been deprecated and will be decommissioned on March 30, 2026.https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/index.html5Trading APIUploadSiteHostedPictures2025/11/062026/09/30This call has been deprecated and will be decommissioned on September 30th, 2026. Users are recommended to migrate to the createImageFromFile and createImageFromUrl methods of the Media API.https://developer.ebay.com/Devzone/post-order/index.html6Post-Order APIClose CaseIssue Case RefundProvide Case Shipment InfoProvides Return Address2025/09/032026/03/02The listed methods have been deprecated from the Post-Order API and will be decommissioned on March 2, 2026.https://developer.ebay.com/Devzone/post-order/index.html7Post-Order APIConfirm Cancellation Refund2025/12/032026/03/02The Confirm Cancellation Refund method has been deprecated from the Post-Order API and will be decommissioned on March 2, 2026.https://developer.ebay.com/Devzone/product/CallRef/index.html8Product APIgetProductCompatibilities2025/07/082026/04/27This call has been deprecated and will be decommissioned on April 27th, 2026. Users are recommended to migrate to the getProductCompatibilities method of the Metadata API.https://developer.ebay.com/Devzone/product-metadata/CallRef/index.html9Product Metadata APIAll2025/07/082026/04/27All calls in the Product Metadata API have been deprecated and will be decommissioned on April 27th, 2026. Current users of this API are recommended to migrate to the compatibilities methods of the Metadata API.https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html10Trading APIGetCategoryFeatures 2025/07/012026/05/04 This call has been deprecated and will be decommissioned on May 4th, 2026. Users are recommended to migrate to the Metadata API to retrieve category metadata information. See GetCategoryFeatures migration guide for more information.https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html11Trading APIGetCategories2025/06/112026/04/15This call has been deprecated and will be decommissioned on April 15th, 2026. Users are recommended to migrate to the Taxonomy API and Metadata API to retrieve category taxonomy and metadata information. See GetCategories Migration Guide for more information.https://developer.ebay.com/devzone/merchandising/docs/CallRef/index.html12Merchandising APIAll2024/07/29TBDAll calls in the Merchandising API have been deprecated and will be decommissioned at a later date.https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html13Return Management API All2023/02/03TBD All methods of the Return Management API are scheduled to be decommisioned. The official decommission date will be announced once determined. This API is now out of synch with return management flows on eBay. Current users of the Return Management API and all users interested in programmatically managing return requests should make plans to migrate to the Post-Order API. https://developer.ebay.com/devzone/business-policies/CallRef/index.html14Business Policies Management APIAll2021/03/23TBDThe Business Policies Management API is deprecated and is scheduled for decommission at a later date. We recommend that you migrate to the fulfillment\_policy, payment\_policy, and return\_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies. --- # https://developer.ebay.com/support/api-statusRSS for NodeSat, 28 Mar 2026 10:47:32 -0700Application Keyset page is not displaying the existing sandbox keyset We are aware of the issue and actively working to get it fixed. \]\]>https://developer.ebay.com/support/api-status/Sandbox/application-keyset-page-is-not-displaying-the-existing-sandbox-keyset1Application Keyset page is not displaying the existing sandbox keysetSandboxSandboxResolvedTue Mar 03 2026AddOrder Trading API returns HTTP 500 during invoice generation, blocking invoicing.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-addorder-trading-api-returns-http-500-during-invoice-generation-blocking-invoicing2RESOLVED- AddOrder Trading API returns HTTP 500 during invoice generation, blocking invoicingTrading APIProductionResolvedMon Feb 09 2026The Application Keysets page is not displaying the existing production keysets, and the “Create new keyset” function does not work. We are aware of this issue and working on the fix. \]\]>https://developer.ebay.com/support/api-status/Production/application-keysets-page-not-showing-production-keyset-and-create-new-keyset-is-not-working3Application keysets page not showing production keyset and create new keyset is not workingDeveloper portalProductionResolvedThu Feb 05 2026Internal server error but listing being added in bulkCreateAdsByListingId of Marketing API call\]\]>https://developer.ebay.com/support/api-status/Production/internal-server-error-bulkcreateadsbylistingid4Internal server error bulkCreateAdsByListingIdMarketing API ProductionResolvedWed Jan 28 2026 GetItemTransactionsResponse.TransactionArray container is missing from AuctionCheckoutComplete notifications.\]\]>https://developer.ebay.com/support/api-status/Production/getitemtransactionsresponse-transactionarray-missing-from-auctioncheckoutcomplete-notifications5GetItemTransactionsResponse.TransactionArray missing from AuctionCheckoutComplete notificationsTrading APIProductionResolvedWed Jan 28 2026ReviseItem, ReviseInventoryStatus, and EndItem—are resulting this error: "Seller not found" This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-trading-api-reviseitem-reviseinventorystatus-enditem-api-calls-returning-seller-not-found-error6RESOLVED - Trading API - ReviseItem/ReviseInventoryStatus/EndItem API calls returning “Seller not found” error.Trading APIProductionResolvedWed Oct 29 2025Some of the Inventory API calls are returning the error: "The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. You need to specify the tax state." This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-inventory-api-returning-invalid-tax-information-you-need-to-specify-the-tax-state7RESOLVED - Inventory API returning “Invalid tax information – You need to specify the tax state”Inventory APIProductionResolvedThu Oct 23 2025The GetStore call of the Trading API is returning the error message "Store not found for user" even though an active store exists for some users. We are aware of the issue, and working on a fix. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-trading-api-getstore-method-returns-store-not-found-for-user8RESOLVED - Trading API GetStore method returns “Store not found for user”Trading APIProductionResolvedTue Oct 21 2025When attempting to publish the offer in Sandbox , the following error message appears: "A user error has occurred. System error. Unable to process your request. Please try again later. This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-publishoffer-fails-with-http-5009RESOLVED - Sandbox publishOffer fails with HTTP 500Trading APISandboxResolvedFri Oct 17 2025Activation of developer account support attempt fails without success. This blocks access to technical support for APIs and developer resources. This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-activate-developer-account-support-is-not-working10RESOLVED - Activate developer account support is not workingDeveloper PortalProductionResolvedMon Oct 13 2025getTopics API returning 500 Internal Server Error when attempting to access the endpoint: api.ebay.com/commerce/notification/v1/topic This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-gettopics-api-returning-500-internal-server-error11RESOLVED - getTopics API returning 500 Internal Server ErrorNotification APIProductionResolvedMon Sep 29 2025getItemConditionPolicies endpoint of Metadata API is returning Status Code 404. This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getitemconditionpolicies-api-currently-not-working-and-is-returning-404-response12RESOLVED - getItemConditionPolicies API currently not working and is returning 404 responsegetItemConditionPoliciesProductionResolvedFri Sep 26 2025 All newline characters (\\n) in the message content automatically removed. Previously, the old messages retained newline characters for clear viewing. This issue is resolved now. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-discrepancies-in-newline-character-display-between-messages-on-ui-and-email-content13RESOLVED - Discrepancies in newline character display between Messages on UI and email contentAddMemberMessageRTQ AddMemberMessageAAQToPartner APIsProductionResolvedTue Sep 23 2025 When attempting to create a new Sandbox User, the following error message appears: "An unknown issue has occurred. Please contact the website administrator." The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-user-creation-issue14RESOLVED- Sandbox User Creation IssueSandboxSandboxResolvedFri Sep 19 2025createShippingFulfillment API is returning error "Trailing token (of type START\_OBJECT) found after value (bound as \`com.ebay.selling.sellerorders.request.ShippingFulfillmentDetails\`): not allowed as per \`DeserializationFeature.FAIL\_ON\_TRAILING\_TOKENS" The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-createshippingfulfillment-api-is-currently-not-working-and-is-returning-400-response15RESOLVED- createShippingFulfillment API is currently not working and is returning 400 responsecreateShippingFulfillmentProductionResolvedFri Sep 19 2025All site categories hourly feed files are missing items since 2025-09-05T04:00:00Z GMT. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-category-hourly-feed-files-are-missing16RESOLVED - Category Hourly feed files are missingBuy Feed APIProductionResolvedFri Sep 05 2025View item page on sandbox environment is working. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-view-item-page-on-sandbox-environment-is-working17RESOLVED - View item page on sandbox environment is workingView Item PageSandboxResolvedMon Aug 25 2025UploadSiteHostedPictures API on sandbox environment is now working. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-the-uploadsitehostedpictures-api-call-in-the-sandbox-environment-is-not-working18RESOLVED - The UploadSiteHostedPictures API call in the sandbox environment is not workingTrading APISandboxResolvedMon Aug 25 2025Internal Server Error when calling createFulfillmentPolicy and updateFulfillmentPolicy API in sandbox environment. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-internal-server-error-when-calling-createfulfillmentpolicy-and-updatefulfillmentpolicy-api19RESOLVED - Internal Server Error when calling createFulfillmentPolicy and updateFulfillmentPolicy APIcreateFulfillmentPolicy and updateFulfillmentPolicy APISandboxResolvedThu Aug 14 2025OAuth User Token Generation and login is now working in the sandbox environment. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-oauth-user-token-generation-and-login-is-not-working-in-the-sandbox-environment-120RESOLVED - OAuth User Token Generation and login is not working in the Sandbox EnvironmentOAuth User Token GenerationSandboxResolvedMon Aug 11 2025The publishOffer method of the Inventory API is returning the error: "A system error has occurred. Sorry, error is encountered when creating your item." in the sandbox environment. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-the-publishoffer-method-of-the-inventory-api-is-not-working-in-the-sandbox-environment21RESOLVED - The publishOffer method of the Inventory API is not working in the sandbox environment.publishOffer APISandboxResolvedTue Aug 05 2025The getUser method of the Identity API is returning the error: "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." in the sandbox environment. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-the-getuser-method-of-the-identity-api-is-currently-non-functional-in-the-sandbox-environment22RESOLVED -The getUser method of the Identity API is currently non-functional in the sandbox environment.Identity APISandboxResolvedTue Aug 05 2025 OAuth User Token Generation and login is not working in the sandbox environment. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-oauth-user-token-generation-and-login-is-not-working-in-the-sandbox-environment23RESOLVED- OAuth User Token Generation and login is not working in the Sandbox EnvironmentOAuth User Token GenerationSandboxResolvedFri Aug 01 2025GetOrders API not returning orders when filter Completed is specified in the request The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getorders-api-not-returning-orders-when-filter-less-than-orderstatus-greater-than-completed-less-than-orderstatus-greater-than-is-specified-in-the-request24RESOLVED- GetOrders API not returning orders when filter Completed is specified in the requestGetOrders APIProductionResolvedThu Jul 31 2025Some categories in Snapshot feed files are unavailable since 2025-07-31T08:00:00Z GMT The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1825RESOLVED- Missing Categories in hourly feedBuy Feed APIProductionResolvedThu Jul 31 2025getFile API is returning error  "Internal Server Error" for PROMOTION , CURATE\_ITEM\_FEED ,PRODUCT\_FEED Feed Types The issue has been resolved \]\]>https://developer.ebay.com/support/api-status/Production/getfile-api-is-returning-error-internal-server-error-for-promotion-curate\_item\_feed-product\_feed-feed-types26getFile API is returning error "Internal Server Error" for PROMOTION , CURATE\_ITEM\_FEED ,PRODUCT\_FEED Feed TypesgetFile APIProductionResolvedWed Jul 30 2025 The getInventoryItem and bulkGetInventoryItem calls are returning the error, "We didn't find the resource/entity you are requesting." Additionally, the createOrReplaceProductCompatibility, publishOffer, and bulkMigrateListing APIs are returning the error, "Seller Inventory Service cannot publish the data. Availability not found. Please try again or contact customer service." The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-the-inventory-api-calls-are-returning-errors-stating-the-resource-entity-you-requested-could-not-be-found-and-seller-inventory-service-is-unable-to-publish-the-data-availability-not-found-please-try-again-or-reach-out-to-customer-service27RESOLVED-The Inventory API calls are returning errors stating, "The resource/entity you requested could not be found," and "Seller Inventory Service is unable to publish the data. Availability not found. Please try again or reach out to customer service."getInventoryItem, bulkGetInventoryItem, createOrReplaceProductCompatibility, publishOffer and bulkMigrateListing APIProductionResolvedMon Jul 28 2025The searchByImage Browse API call returning an unexpected result.  The issue has been resolved \]\]>https://developer.ebay.com/support/api-status/Production/resolved-the-searchbyimage-api-returns-an-unexpected-result28RESOLVED - The searchByImage API returns an unexpected resultBrowse APIProductionResolvedThu Jul 24 2025 GetAccount endpoint is encountering a persistent system error with an error code 10007 The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getaccount-endpoint-trading-api-error-code-1000829RESOLVED - GetAccount Endpoint Trading API - Error Code 10007Trading APIProductionResolvedMon Jul 14 2025GetCategories API call is returning the UpdateTime field in an unexpected format. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-getcategories-api-call-is-returning-the-updatetime-field-in-an-unexpected-format30RESOLVED - GetCategories API call is returning the UpdateTime field in an unexpected formatTrading APIProductionResolvedFri Jun 27 2025Users are not able to generate the OAuth User Token in the Sandbox environment. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-oauth-user-token-generation-is-not-working-in-sandbox-131RESOLVED - OAuth User Token generation is not working in SandboxOAuth User Token generationSandboxResolvedMon Jun 16 2025UploadSiteHositedPictures returned error Copy from ExternalPictureURL failed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-uploadsitehositedpictures-returned-500-error-with-message-copy-from-externalpictureurl32RESOLVED - UploadSiteHositedPictures Returned 500 Error with message " Copy from ExternalPictureURL"Trading APIProductionResolvedFri Jun 06 2025createFulfillmentPolicy API call returning Internal Server error in the sandbox. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-createfulfillmentpolicy-api-is-returning-internal-server-error-in-the-sandbox33RESOLVED - createFulfillmentPolicy API is returning Internal Server error in the sandboxSell Account APISandboxResolvedThu May 29 2025Feeds are getting stuck in queue and Sellers are unable to download Awaiting dispatch orders report with Sell Feed API.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-feeds-are-getting-stuck-in-queue-and-sellers-are-unable-to-download-awaiting-dispatch-orders-report-with-sell-feed-api34RESOLVED - Feeds are getting stuck in queue and Sellers are unable to download Awaiting dispatch orders report with Sell Feed APISell Feed APIProductionResolvedTue May 27 2025GetAccount endpoint is encountering a persistent system error with an error code 10007 The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getaccount-endpoint-trading-api-error-code-1000735RESOLVED - GetAccount Endpoint Trading API - Error Code 10007Trading APIProductionResolvedThu May 22 2025The GetOrders API is incorrectly assigning the ShippingService value as "NotSelected" for local pickup orders. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getorders-api-is-incorrectly-assigning-the-shippingservice-value-as-notselected-for-local-pickup-orders36RESOLVED - GetOrders API is incorrectly assigning the ShippingService value as "NotSelected" for local pickup ordersTrading APIProductionResolvedWed May 14 2025getStoreCategories and getStore API calls are failing with the error "The user must have an active store subscription." The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getstorecategories-and-getstore-api-calls-are-failing-with-the-error-the-user-must-have-an-active-store-subscription37RESOLVED - getStoreCategories and getStore API calls are failing with the error "The user must have an active store subscription."getStoreCategories and getStore APIProductionResolvedThu May 08 2025getPayout endpoint of Finance API are failing with an HTTP 500 error. This error suggests a problem within an eBay internal system or process, severely impacting the partner's operations. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getpayout-api-requests-failing-with-http-500-error-problem-with-ebay-internal-system38RESOLVED- getPayout API Requests Failing with HTTP 500 Error: "Problem with eBay Internal System"Finance APIProductionResolvedMon Apr 28 2025Some categories in Snapshot feed files are unavailable since 2025-04-24T07:00:00Z GMT . The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1739RESOLVED - Missing Categories in hourly feedSnapshot feed filesProductionResolvedThu Apr 24 2025The users are not able to create OAuth User Access Token in the Sandbox Environment and getting error message "Error Processing your request". The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-oauth-user-token-generation-is-not-working-in-sandbox40RESOLVED - OAuth User Token generation is not working in SandboxOAuth User Access Token generationSandboxResolvedThu Jan 09 2025Users are intermittently facing the issue when trying to get the user access token from the developer portal for the SANDBOX environment.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-users-are-facing-issue-when-trying-to-get-token-from-the-developer-portal-for-sandbox-environment41RESOLVED- Users are facing issue when trying to get token from the developer portal for SANDBOX environmentSandboxSandboxResolvedThu Dec 26 2024Sandbox 'Adding Redirect URL' is not working The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-adding-redirect-url-is-not-working42RESOLVED- Sandbox 'Adding Redirect URL' is not workingSandboxSandboxResolvedMon Dec 23 2024 The AddItem and AddFixedPriceItem API calls are returning a "User Not Found" error in the sandbox environment. The issue has been reolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-the-additem-and-addfixedpriceitem-api-calls-are-returning-a-user-not-found-error-in-the-sandbox-environment43RESOLVED: The AddItem and AddFixedPriceItem API calls are returning a "User Not Found" error in the sandbox environment.SandboxSandboxResolvedWed Dec 18 2024The AddItem/AddFixedPriceItemm API calls are unexpectedly returning system error messages in the sandbox environment.  The issue has been fixed. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-additem-addfixedpriceitem-api-calls-are-returning-unexpected-system-error-messages-in-sandbox44RESOLVED- AddItem/AddFixedPriceItem API Calls are Returning Unexpected System Error Messages in SandboxSandboxSandboxResolvedSun Dec 15 2024The GetItem call is not returning the Item.Regulatory container in response. The issue has been fixed. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getitem-call-is-not-returning-the-item-regulatory-container45RESOLVED- GetItem call is not returning the Item.Regulatory containerTrading APIProductionResolvedThu Dec 12 2024The GetItem method is returning a system error when a seller attempts to retrieve their own item.  The issue has been fixed. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-the-getitem-method-returns-a-system-error-when-sellers-retrieve-their-own-items-in-the-sandbox46RESOLVED- The GetItem method returns a system error when sellers retrieve their own items in the sandboxSandboxSandboxResolvedWed Dec 11 2024Sandbox enable OAuth is not working on Developer's Keys Page. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-enable-oauth-is-not-working47RESOLVED-Sandbox enable OAuth is not workingSandboxSandboxResolvedWed Nov 20 2024Sandbox Users are not able to login to Sandbox environment. The issue has been fixed.\]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-users-are-not-able-to-login-to-sandbox-environment48RESOLVED-Users are Not able to login to Sandbox environmentSandboxSandboxResolvedWed Nov 13 2024 Feed Beta API: getItemSnapshot Hourly files could be missing item updates intermittently.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1649RESOLVED-Missing Categories in hourly feedBuy.Feed APIProductionResolvedThu Nov 07 2024Requests sent to the getItem, getItemByLegacyId, or getItemsByItemGroup methods of the Buy Browse API which have the ADDITIONAL\_SELLER\_DETAILS fieldgroup specified are receiving a 500 “Internal Server Error” response intermittently. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-intermittent-failures-for-requests-to-the-item-resource-with-the-additional\_seller\_details-fieldgroup50RESOLVED-Intermittent failures for requests to the item resource with the ADDITIONAL\_SELLER\_DETAILS fieldgroupBuy Browse APIProductionResolvedTue Sep 10 2024Refresh token API call is failing with the error code 500 "Internal server error". The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-refresh-token-api-call-is-failing-with-the-error-code-500-internal-server-error51RESOLVED:Refresh token API call is failing with the error code 500 "Internal server error" Refresh tokenSandboxResolvedFri Aug 30 2024 The issue has been resolved. GetBestOffers API call is working as expected.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getbestoffers-api-call-is-returning-web-service-framework-internal-error-message52RESOLVED-GetBestOffers API call is returning Web Service framework internal error messageTrading APIProductionResolvedWed Aug 28 2024The view item page is having some issues so you may not be able to view listings in the sandbox. We are aware of this issue and actively working on getting it resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-view-item-page-is-not-working53RESOLVED-Sandbox view item page is not workingSandboxSandboxResolvedThu Aug 08 2024 GetSellerTransactions API call not returning the transactions and PaginationResult for some Pagination.PageNumber.  The issue has been resolved now.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getsellertransactions-call-not-returning-the-transactions-and-paginationresult-for-some-pagination-pagenumber54RESOLVED-GetSellerTransactions call not returning the transactions and PaginationResult for some Pagination.PageNumberTrading APIProductionResolvedFri Jul 26 2024 GeteBayDetails API call is returning empty details. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getebaydetails-api-call-is-returning-empty-details55RESOLVED: GeteBayDetails API call is returning empty detailsTrading APIProductionResolvedThu Jul 18 2024Refresh token API call is failing with the error code 500 "Internal server error" in the Sandbox. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-unable-to-refresh-user-token-in-the-sandbox56RESOLVED- Unable to Refresh user token in the SandboxRefresh tokenSandboxResolvedTue Jul 02 2024Some categories in Snapshot feed files are unavailable since 2024-07-01T15:00:00Z GMT. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1557RESOLVED- Missing Categories in hourly feedBuy.Feed APIProductionResolvedMon Jul 01 2024Feed beta API all getFeed methods are facing 500 errors. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-all-feed-beta-api-methods-are-facing-the-500-errors58RESOLVED- All Feed Beta API methods are facing the 500 errors.Buy.Feed APIProductionResolvedMon Jul 01 2024Some categories in Snapshot feed files are unavailable since 2024-06-07T07:00:00Z GMT The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1459RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedFri Jun 07 2024AddMemberMessageAAQToPartner API call is returning "**Recipient User Id is invalid**" error message. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-addmembermessageaaqtopartner-api-call-is-returning-recipient-user-id-is-invalid-error-message60RESOLVED-AddMemberMessageAAQToPartner API call is returning "Recipient User Id is invalid" error messageTrading APIProductionResolvedFri Apr 26 2024The users are not able to create an Auth'N'Auth and OAuth user access token in the sandbox and getting error message "upstream connect error or disconnect/reset before headers. reset reason: connection termination". The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-unable-to-generate-user-token-in-sandbox61RESOLVED-Unable to generate user token in sandboxSandboxSandboxResolvedThu Apr 18 2024Trading API Add/Revise/Relisting calls failing with System Error in Sandbox. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-trading-api-add-revise-relisting-calls-failing-with-system-error-in-sandbox62RESOLVED- Trading API Add/Revise/Relisting calls failing with System Error in SandboxSandboxSandboxResolvedTue Apr 16 2024ITEM\_GROUP\_FEED\_DAILY generated on 04/10 are delayed. The issue is resolved.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-item\_group\_feed\_daily-generated-on-04-10-are-delayed63RESOLVED- ITEM\_GROUP\_FEED\_DAILY generated on 04/10 are delayed.Buy.Feed APIProductionResolvedWed Apr 10 2024Add/Revise/Relisting Listing calls failing with System Error in Sandbox. The issue has been resolved now. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-add-revise-relisting-listing-calls-failing-with-system-error-in-sandbox64RESOLVED- Add/Revise/Relisting Listing calls failing with System Error in SandboxSandboxSandboxResolvedTue Apr 09 2024Sell Feed API Order Report returning the "Internal Application Error" for some marketplaces like EBAY\_GB & EBAY\_FR. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-sell-feed-api-order-report-is-returning-the-error-200465Resolved- Sell Feed API Order Report is returning the error 2004.Sell.Feed APIProductionResolvedMon Apr 08 2024Sandbox login(sandbox.ebay.com) failing with the error HTTP Status 400 Bad Request. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-login-sandbox-ebay-com-failing-with-the-error-http-status-400-bad-request66RESOLVED- Sandbox login(sandbox.ebay.com) failing with the error HTTP Status 400 Bad RequestSandboxSandboxResolvedTue Apr 02 2024Sandbox keysets are unavailable to view in the Developer's Keys Page nor are users able to generate the token in the Sandbox.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-sandbox-keysets-are-missing-and-unable-to-generate-the-token-167RESOLVED- Sandbox keysets are missing and unable to generate the tokenSandboxProductionResolvedMon Apr 01 2024The Sell Feed API tasks are taking a very long time to process and seem to be stuck in a queue. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-sell-feeds-are-being-queued68RESOLVED- Sell Feeds are being Queued Sell Feed APIProductionResolvedFri Mar 29 2024Sandbox keysets are unavailable to view in the Developer's Keys Page nor are users able to generate the token in the Sandbox.  The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-sandbox-keysets-are-missing-and-unable-to-generate-the-token69RESOLVED- Sandbox keysets are missing and unable to generate the tokenSandboxSandboxResolvedWed Mar 27 2024CreateShippingFulfillment API call failing with the error "Invalid line item id". The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-createshippingfulfillment-api-call-failing-with-the-error-invalid-line-item-id-170RESOLVED- CreateShippingFulfillment API call failing with the error "Invalid line item id"Fulfillment APIProductionResolvedTue Mar 19 2024GetMyeBaySelling API is failing with the error code 10007 "System error. Unable to process your request. Please try again later".  The issue has been fixed.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getmyebayselling-api-is-failing-with-the-error-code-10007-system-error-unable-to-process-your-request-please-try-again-later71RESOLVED- GetMyeBaySelling API is failing with the error code 10007 "System error. Unable to process your request. Please try again later". Trading APIProductionResolvedThu Mar 14 2024Daily item, item group and PL feed generation on 02/29 are delayed. The issue has been resolved.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-item-item-group-and-pl-feed-generation-on-02-29-are-delayed72RESOLVED-Daily item, item group and PL feed generation on 02/29 are delayed.Buy.Feed APIProductionResolvedThu Feb 29 2024GetCategories and GetCategoryFeatures API calls are returning error message "Sorry, something went wrong. Please wait a moment and try again." in the Sandbox.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/resolved-getcategories-and-getcategoryfeatures-api-calls-are-returning-error-message-sorry-something-went-wrong-please-wait-a-moment-and-try-again73RESOLVED-GetCategories and GetCategoryFeatures API calls are returning error message "Sorry, something went wrong. Please wait a moment and try again."Trading APISandboxResolvedWed Feb 14 2024Some categories in Snapshot feed files are unavailable since 2024-02-13T19:00:00Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1374RESOLVED-Missing Categories in hourly feedBuy.Feed APIProductionResolvedTue Feb 13 2024GetOrders/GetItemTransactions API calls are failing with the error when using the time filters.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getorders-getitemtransactions-are-failing-with-the-multiple-error-message75RESOLVED-GetOrders/GetItemTransactions are failing with the multiple error messageTrading APIProductionResolvedThu Feb 08 2024Some categories in Snapshot feed files are unavailable since 2024-01-23T10:00:00Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1276RESOLVED-Missing Categories in hourly feedBuy.Feed APIProductionResolvedTue Jan 23 2024Some categories in Snapshot feed files are unavailable since 2023-12-08T08:00:00Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1177RESOLVED-Missing Categories in hourly feedBuy.Feed APIProductionResolvedFri Dec 08 2023Some categories in Snapshot feed files are unavailable since 2023-12-04T08:00:00Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-1078RESOLVED-Missing categories in hourly feedBuy.Feed APIProductionResolvedMon Dec 04 2023Some categories in Snapshot feed files are unavailable since 2023-11-24T20:00:00Z GMT. We are aware of this issue and actively working on getting it resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-979RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedFri Nov 24 2023 Some categories in Snapshot feed files are unavailable since 2023-11-23T10:00:00Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-880RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedThu Nov 23 2023Some categories in Snapshot feed files are unavailable since 2023-10-23T21:00:00Z GMT The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-781RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedTue Oct 24 2023Some categories in Snapshot feed files are unavailable since 2023-10-20T18:00:00Z GMT. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-682RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedFri Oct 20 2023Some categories in Snapshot feed files are unavailable since 2023-10-20T07:00:00Z GMT. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-583RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedFri Oct 20 2023Some categories in Snapshot feed files are unavailable since 2023-10-17T07:00:00Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-484RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedTue Oct 17 2023Some of the Trading API calls are failing with the error "503 Service Unavailable". The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-trading-api-failing-with-the-error-503-service-unavailable85RESOLVED-Trading API failing with the error "503 Service Unavailable"Trading APIProductionResolvedTue Oct 10 2023Some categories in Snapshot feed files are unavailable since 2023-10-04T08:00:59.448Z GMT The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-386RESOLVED: Missing Categories in hourly feedBuy.Feed APIProductionResolvedWed Oct 04 2023Daily item, item group and PL feed generation on 09/24 are delayed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-item-item-group-and-pl-feed-generation-on-09-24-are-delayed87RESOLVED-Daily item, item group and PL feed generation on 09/24 are delayedBuy Feed APIProductionResolvedTue Sep 26 2023Daily item and item group feed on 09/18 are delayed. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-item-and-item-group-feed-on-09-18-are-delayed88RESOLVED-Daily item and item group feed on 09/18 are delayedBuy.Feed APIProductionResolvedWed Sep 20 2023Item and Item Group Feed Files 09/11 are delayed. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-item-and-item-group-feed-files-09-11-are-delayed89RESOLVED-Item and Item Group Feed Files 09/11 are delayed.Buy.Feed APIProductionResolvedWed Sep 13 2023CreateShippingFulfillment API call failing with the error "Invalid line item id". The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-createshippingfulfillment-api-call-failing-with-the-error-invalid-line-item-id90RESOLVED- CreateShippingFulfillment API call failing with the error "Invalid line item id"Fulfillment APIProductionResolvedMon Aug 28 2023fetchItemAspects Taxonomy API all failing with the error code 500.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-fetchitemaspects-taxonomy-api-all-failing-with-the-error-code-50091RESOLVED-fetchItemAspects Taxonomy API all failing with the error code 500Taxonomy APIProductionResolvedThu Jul 27 2023Some categories in Snapshot feed files on 07/03 were on unavailable. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-292RESOLVED-Missing Categories in hourly feedBuy Feed APIProductionResolvedMon Jul 03 2023Feed files are not available for Feed V1 API. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-feed-files-are-not-available-for-feed-v1-api93RESOLVED-Feed files are not available for Feed V1 APIBuy.Feed APIProductionResolvedWed Jun 07 2023Some categories in Snapshot feed files are unavailable since 2023-05-22T09:00:00Z GMT. We are aware of this issue and actively working on getting it resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed-194RESOLVED- Missing Categories in hourly feedBuy.Feed APIProductionResolvedMon May 22 2023Daily Feed Files on 03/15 are delayed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-feed-files-on-03-15-are-delayed95RESOLVED-Daily Feed Files on 03/15 are delayed.Buy.Feed APIProductionResolvedWed Mar 15 2023 Daily Feed Files on 02/21 are delayed.  The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-feed-files-on-02-21-are-delayed96RESOLVED-Daily Feed Files on 02/21 are delayedBuy.Feed APIProductionResolvedThu Feb 23 2023Snapshot feed files are unavailable since 2023-01-11T07:00:00.000 GMT. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-feed-files-are-unavailable-since-2023-01-11t10-00-00-000-gmt97RESOLVED-Snapshot feed files are unavailable since 2023-01-11T10:00:00.000 GMT. Buy.Feed APIProductionResolvedWed Jan 11 2023Daily Feed Files on 01/02 are delayed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-feed-files-on-01-02-are-delayed98RESOLVED-Daily Feed Files on 01/02 are delayedBuy.FeedProductionResolvedWed Jan 04 2023Priority Feed Files on 12/18 were delayed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-on-12-18-are-delayed99RESOLVED-Priority Feed Files on 12/18 are delayedBuy.Feed APIProductionResolvedTue Dec 20 2022Bootstrap files ( item and item\_group) for 12/11 were delayed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-bootstrap-files-item-and-item\_group-for-12-11-are-delayed100RESOLVED-Bootstrap files ( item and item\_group) for 12/11 are delayed.Buy.Feed APIProductionResolvedThu Dec 15 2022Some categories in Snapshot feed files are unavailable since 2023-05-22T09:00:00Z GMT We are aware of this issue and actively working on getting it resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-missing-categories-in-hourly-feed101RESOLVED- Missing Categories in hourly feedBuy.Feed APIProductionResolvedTue Dec 13 2022Priority Feed Files 12/10 were delayed The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-12-10-are-delayed102RESOLVED-Priority Feed Files 12/10 are delayedBuy.Feed APIProductionResolvedMon Dec 12 2022Priority Feed Files 12/03 were delayed. The issue has been resolved.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-12-03-were-delayed103RESOLVED-Priority Feed Files 12/03 were delayedBuy.Feed APIProductionResolvedMon Dec 05 2022eBay Trading API returning false call limits error from 2022-11-14T8:00 GMT The issue has been resolved on  2022-11-14T13:00 GMT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-ebay-trading-api-returning-false-call-limits-error-from-2022-11-14t8-00-to-2022-11-14t13-00-gmt104RESOLVED-eBay Trading API returning false call limits error from 2022-11-14T8:00 to 2022-11-14T13:00 GMTTrading APIProductionResolvedMon Nov 14 2022Priority Feed Files, Daily Feed Files and Bootstrap Feed Files 11/08 are delayed We are aware of the issue and actively working to get it fixed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-daily-feed-files-and-bootstrap-feed-files-11-08-are-delayed105RESOLVED-Priority Feed Files, Daily Feed Files and Bootstrap Feed Files 11/08 are delayedBuy.Feed APIProductionResolvedTue Nov 08 2022Priority Feed Files 08/27 are delayed The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-08-27-are-delayed106RESOLVED - Priority Feed Files 08/27 are delayedBuy.Feed APIProductionResolvedSat Aug 27 2022 Priority Feed Files 08/25 are delayed. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-08-25-are-delayed107RESOLVED-Priority Feed Files 08/25 are delayedBuy.Feed APIProductionResolvedThu Aug 25 2022Priority Feed Files 08/19 are delayed The issue has been resolved \]\]>https://developer.ebay.com/support/api-status/Production/resolved-priority-feed-files-08-19-are-delayed108RESOLVED-Priority Feed Files 08/19 are delayedBuy.Feed APIProductionResolvedFri Aug 19 2022 Daily Item, Item Group and Item Priority Feed Files 07/12 are delayed. The issue has been resolved. All the below daily files are available. * Item Feed * Item Group Feed * Item Priority Feed \]\]>https://developer.ebay.com/support/api-status/Production/resolved-daily-item-item-group-and-item-priority-feed-files-07-12-are-delayed109RESOLVED- Daily Item, Item Group and Item Priority Feed Files 07/12 are delayedBuy.Feed APIProductionResolvedThu Jul 14 2022Snapshot Feed Files are unavailable since 2022-07-04T20:00 GMT The issue has been resolved. Snapshot files are available except 2022-07-04T20:00 to 2022-07-05T03:00 GMT and 2022-07-05T07:00 GMT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-feed-files-are-unavailable-since-2022-07-04t20-00-gmt110RESOLVED-Snapshot Feed Files are unavailable since 2022-07-04T20:00 GMTBuy.Feed APIProductionResolvedTue Jul 05 2022Sell Feed API might fail with the following error: "There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance" We are actively working on the resolution of the issue. The issue has been resolved ~ Mar 01 202215:40 PM PDT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-sell-feed-api-might-fail-with-internal-server-error111RESOLVED-Sell Feed API might fail with internal server errorSell.Feed APIProductionResolvedTue Mar 01 2022Developers might notice that some of the search queries in Browse API, are resulting in Internal Server Error or Request Error and categories are missing in response payload. This issue is intermittent. We are aware of the issue and actively working to get it fixed.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-intermittent-issues-in-browse-api-search-only112RESOLVED-Intermittent issues in Browse API (search only)Browse APIProductionResolvedTue Jan 18 2022https://developer.ebay.com/support/api-status/Production/resolved-snapshot-hourly-feeds-returned-no-or-lower-volume-of-data-from-2021-05-21t18-00-gmt113RESOLVED-Snapshot Hourly Feeds returned no or lower volume of data from 2021-05-21T18:00 GMTFeed APIProductionResolvedFri May 21 2021* 2021-05-02T20:00 GMT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-feed-getitemsnapshot-api-is-returning-low-volume-since-2021-05-12t07-00-gmt114RESOLVED-Feed getItemSnapshot API is returning low volume since 2021-05-12T07:00 GMTFeed APIProductionResolvedWed May 12 2021The issue has been resolved. Snapshot files are available from 2021-05-3T06:00 GMT onwards. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-hourly-feeds-returned-no-or-low-volume-data-from-2021-05-02t20-00-gmt115RESOLVED-Snapshot hourly feeds returned no or low volume data from 2021-05-02T20:00 GMTFeed APIProductionResolvedSun May 02 2021Snapshot hourly feeds returned no or low volume data from 2021-04-28T17:00 to 2021-4-29T08:00 GMT The issue has been resolved. Snapshot files are available from 2021-04-29T04:00 GMT onwards. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-hourly-feeds-returned-no-or-low-volume-data-from-2021-04-28t17-00-to-2021-4-29t08-00-gmt116RESOLVED-Snapshot hourly feeds returned no or low volume data from 2021-04-28T17:00 to 2021-4-29T08:00 GMTFeed APIProductionResolvedThu Apr 29 2021https://developer.ebay.com/support/api-status/Production/resolved-feed-item-snapshot-is-not-available-from-2021-03-24t21-00-000-to-2021-03-25t01-00-000z-2021-03-25t10-00-000z-and-2021-03-25t11-00-000z-gmt117RESOLVED-Feed Item Snapshot is not available from 2021-03-24T21:00:000 to 2021-03-25T01:00:000Z, 2021-03-25T10-00-000Z and 2021-03-25T11-00-000Z GMTFeed APIProductionResolvedWed Mar 24 2021eBay APIs are returning 404 (Not Found) error intermittently. The following APIs are affected:  - Trading  - Browse  - Logistics The Issue has been fixed on Jan 14 2021 16:30 GMT-0800 (Pacific Standard Time) \]\]>https://developer.ebay.com/support/api-status/Production/resolved-ebay-apis-returning-404-error-intermittently118RESOLVED- eBay APIs returning 404 error intermittentlyTrading, BrowseProductionResolvedThu Jan 14 2021GetOrders API returning Error 10007 or Incomplete Orders xml response. We are actively working on this issue and will update the status soon The Issue has been fixed on September 03, 2020 02:05PM PDT. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getorders-api-returning-error-10007-or-incomplete-orders-xml-response119RESOLVED-GetOrders API returning Error 10007 or Incomplete Orders xml responseTrading APIProductionResolvedThu Sep 03 2020Snapshot hourly feeds returned no or low volume data starting 2020-09-01T08:00:000z GMT The issue has been resolved. Snapshot files are available from 2020-09-01T18:00:000 GMT onwards. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-hourly-feeds-returned-no-or-low-volume-data120RESOLVED--Snapshot hourly feeds returned no or low volume dataFeed APIProductionResolvedTue Sep 01 2020GetOrders and GetSellerTransactions APIs are returning ShippingServiceSelected.ShippingService 'Not Selected' for some orders. The issu has been fixed. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getorders-and-getsellertransactions-apis-are-returning-shippingserviceselected-shippingservice-not-selected-for-some-orders121RESOLVED- GetOrders and GetSellerTransactions APIs are returning ShippingServiceSelected.ShippingService 'Not Selected' for some ordersTrading APIProductionResolvedThu Jul 02 2020Snapshot hourly feeds not returning data started on 2020-06-11T11:00:000z GMT The issue was resolved. Snapshot files are available from 2020-06-12T15:00:000 GMT onwards. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-hourly-feeds-not-returning-data122RESOLVED-Snapshot hourly feeds not returning data Feed APIProductionResolvedThu Jun 11 2020Sellers might notice that FixedPriceTransaction notifications are not coming through. The issue has been resolved. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-some-platform-notifications-are-missing123RESOLVED-Some Platform Notifications are missing Platform NotificationProductionResolvedThu Jun 11 2020The following Sell Marketing APIs might fail 503 error **ad\_report** https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report/methods/getReport **ad\_report\_metadata** https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report\_metadata/methods/getReportMetadata https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report\_metadata/methods/getReportMetadataForReportType **ad\_report\_task** https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report\_task/methods/createReportTask https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report\_task/methods/deleteReportTask https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report\_task/methods/getReportTask https://developer.ebay.com/api-docs/sell/marketing/resources/ad\_report\_task/methods/getReportTasks \]\]>https://developer.ebay.com/support/api-status/Production/resolved-sell-marketing-report-api-might-fail-with-503-error124RESOLVED-Sell Marketing Report API might fail with 503 errorSell MarketingProductionResolvedFri May 29 2020Trading API calls failed with 404 error started on May 15, 2020 7:45AM PDT The Issue was fixed on May 15, 2020 11:50AM PDT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-trading-api-returning-404-error125RESOLVED-Trading API returning 404 errorTrading ProductionResolvedFri May 15 2020Snapshot feed not returning data started on 05/09/2020 00:00 GMT. The issue was resolved. All snapshot feeds have been recovered, and available now.  \]\]>https://developer.ebay.com/support/api-status/Production/resolved-snapshot-feed-not-returning-data-started-on-05-09-2020-00-00-gmt126RESOLVED-Snapshot feed not returning data started on 05/09/2020 00:00 GMTFeed APIProductionResolvedSat May 09 2020Fulfillment getOrders/getOrder returning empty "fulfillmentStartInstructions" without address details The Issue was fixed on May 07, 2020 10:10AM PDT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-fulfillment-getorders-getorder-returning-empty-fulfillmentstartinstructions-without-address-details127RESOLVED-Fulfillment getOrders/getOrder returning empty "fulfillmentStartInstructions" without address detailsFulfillment APIProductionResolvedThu May 07 2020Browse getItem API returning 'The specified item Id was not found' on some marketplaces as listed below: EBAY\_IT EBAY\_FR EBAY\_ES EBAY\_HK The Issue was fixed on April 16, 2020 03:30PM PDT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-browse-getitem-api-returning-the-specified-item-id-was-not-found-on-some-marketplaces128RESOLVED-Browse getItem API returning 'The specified item Id was not found' on some marketplacesBrowseProductionResolvedThu Apr 16 2020Trading API calls may fail with timeout errors. The Issue was fixed on April 11, 2020 04:09PM PDT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-trading-api-timeout-issue129RESOLVED-Trading API timeout issueTrading ProductionResolvedFri Apr 10 2020Trading API  UploadSiteHostedPictures call may fail with  302 :[https://pages.ebay.com/messages/page\_not\_found.html](https://pages.ebay.com/messages/page_not_found.html) We are investigating and working on the resolution of this issue. The issue has been resolved ~10:50AM PDT \]\]>https://developer.ebay.com/support/api-status/Production/resolved-uploadsitehostedpictures-api-returning-http-302130RESOLVED-UploadSiteHostedPictures API returning HTTP 302Trading APIProductionResolvedTue Mar 31 2020https://developer.ebay.com/support/api-status/Production/resolved-snapshot-feed-is-unavailable-started-on-03-03-2020-21-00-gmt131RESOLVED -Snapshot feed is unavailable started on 03/03/2020 21:00 GMTFeed APIProductionResolvedWed Mar 04 2020NotificationSignature value from eBay Platform notification doesn't match calculation base on formula outlined here: [https://developer.ebay.com/DevZone/guides/features-guide/default.html#Notifications/Notifications.html%3FTocPath%3DWorking%2520with%2520Platform%2520Notifications%7C\_\_\_\_\_0](https://developer.ebay.com/DevZone/guides/features-guide/default.html#Notifications/Notifications.html%3FTocPath%3DWorking%2520with%2520Platform%2520Notifications%7C_____0) We are investigating and working on the resolution of this issue \]\]>https://developer.ebay.com/support/api-status/Production/resolved-notification-signature-not-match132RESOLVED - Notification signature not matchPlatform NotificationProductionResolvedMon Sep 30 2019UploadSiteHostedPictures Trading API call is giving back "Internal error to the application" (error code 10007).  This is a known issue that eBay is actively working on. UPDATE: The issue was resolved ~230PM PST, but due to a large backlog of transactions you may experience some latency and/or timeouts.  This should slowly resolve itself throughout the day. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-uploadsitehostedpictures-internal-error-to-the-application-10007133RESOLVED: UploadSiteHostedPictures : Internal error to the application (10007)Trading APIProductionResolvedFri Sep 20 2019Currently, users are not able to view OAuth scopes for sandbox keyset, or generate sandbox OAuth token via [developer.ebay.com](http://developer.ebay.com/) We are actively working on this issue. If you are an existing sandbox API user and know the scopes your application authorized to, you may generate an OAuth token by following the steps in this KB article: [https://ebaydts.com/eBayKBDetails?KBid=5075](https://ebaydts.com/eBayKBDetails?KBid=5075) \]\]>https://developer.ebay.com/support/api-status/Production/resolved-unable-to-generate-sandbox-oauth-token-in-developer-portal134RESOLVED - Unable to generate sandbox OAuth token in Developer PortalDeveloper PortalProductionResolvedWed Sep 11 2019Inventory API calls are failing with 'A system error has occurred' The Issue was fixed on July 29 2019 12:07 PM PDT. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-inventory-api-calls-are-failing-with-a-system-error-has-occurred135RESOLVED- Inventory API calls are failing with 'A system error has occurred'Inventory APIProductionResolvedMon Jul 29 2019LMS startUploadJob API may falied with error 'There is failure during file upload and post-upload checking' The Issue was fixed on July 11 2019 08:10 PM PDT.\]\]>https://developer.ebay.com/support/api-status/Production/resolved-lms-jobs-failed-with-there-is-failure-during-file-upload136RESOLVED - LMS Jobs failed with "There is failure during file upload"LMSProductionResolvedWed Jul 10 2019When calling UploadFile API call, you may receive the below error: 11 Marketplace Error Application Please specify a File with Valid Format We are actively working on this and will update the status soon The Issue was fixed on July 09 2019 05:40 AM PDT. \]\]>https://developer.ebay.com/support/api-status/Production/resolved-uploadfile-failed-with-invalid-format-error137RESOLVED - UploadFile failed with Invalid Format errorLMSProductionResolvedMon Jul 08 2019Upload\\Download FileRequest: LMS Jobs are returning "Unable to create xml stream reader for XML"  The Issue was fixed on Jun 06 2019 00:35 AM PDT. \]\]>https://developer.ebay.com/support/api-status/Production/lms-jobs-are-returning-unable-to-create-xml-stream-reader-for-xml138LMS Jobs are returning "Unable to create xml stream reader for XML"LMSProductionResolvedThu Jun 06 2019LMS reports and Jobs are throwing "Internal Server Error"  We are working towards the resolution. Issue was fixed at 7:50 PM PST. \]\]>https://developer.ebay.com/support/api-status/Production/lms-jobs-are-being-aborted139LMS Jobs are being abortedLMSProductionResolvedWed May 29 2019 File Transfer\\Bulk Data Exchange API is returning "Internal Application Error". We are currently working on the fix. Note: This issue was resolved on 5/17/2019 \]\]>https://developer.ebay.com/support/api-status/Production/file-transfer-api-returning-internal-application-error140File Transfer API returning "Internal Application Error" File Transfer\\BulkDataExchangeProductionResolvedFri May 17 2019eBay will add Server Name Indication (SNI) support, the HTTPS-only standard, to our production Platform Notifications server. [https://ebaydts.com/eBayKBDetails?KBid=5095](https://ebaydts.com/eBayKBDetails?KBid=5095) Platform notifications will be down during the maintainence window on Tuesday May14th from 2.A.M Pacific Time Onwards. \]\]>https://developer.ebay.com/support/api-status/Production/platform-notifications-outage-due-to-sni-release-on-tuesday-05-14-2019-2-a-m-pacific-time-5-a-m-pacific-time141Platform Notifications Outage due to SNI Release on Tuesday - 05/14/2019 2 A.M. Pacific Time-5 A.M. Pacific TimePlatform NotificationsProductionResolvedThu May 09 2019Add Family of calls(AddFixedPriceItem, AddItem) is returning :  Error (3021): System temporarily unavailable, please try listing again. \]\]>https://developer.ebay.com/support/api-status/Sandbox/sandbox-error-3021-system-temporarily-unavailable-please-try-listing-again142Sandbox Error (3021): System temporarily unavailable, please try listing again.Add Family of calls.SandboxResolvedMon May 06 2019https://developer.ebay.com/support/api-status/Production/getalsoboughtbyproduct-api-call-not-working-properly143getAlsoBoughtByProduct API call not working properlyMarketing APIProductionUnresolvedFri Mar 15 2019GetCategorySpecifics not returning Name Value recommendations for some categories on some sites We are aware of this issue and actively working on getting is resolved. \]\]>https://developer.ebay.com/support/api-status/Production/getcategoryspecifics-not-returning-name-value-recommendations-for-some-categories-on-some-sites144GetCategorySpecifics not returning Name Value recommendations for some categories on some sitesTrading APIProductionResolvedWed Oct 24 2018Lot of LMS ActiveInventoryReport jobs have\\are been stuck for more than 30 minutes. If the job is stuck for more than an hour, we suggest that you abort it and start a new Download Job. eBay: We are working towards the solution. eBay on 10/24/2018: The issue has been resolved. Reports are processing normally \]\]>https://developer.ebay.com/support/api-status/Production/lms-activeinventoryreport-jobs-timeout-issue145LMS ActiveInventoryReport Jobs Timeout issueLMS JobsProductionResolvedFri Oct 19 2018GetOrders might fail with Internal Error to Application when the X-EBAY-API-SITEID request header sets to 0  We are aware of this issue anr actively working to get this issue resolved. **Workaround**: You can make the GetOrders API call against SiteID 3 (X-EBAY-API-SITEID=3) or any other international SiteID to retrieve Orders \]\]>https://developer.ebay.com/support/api-status/Production/resolved-getorders-might-fail-with-internal-error-to-application-when-the-x-ebay-api-siteid-request-header-sets-to-0146RESOLVED - GetOrders might fail with Internal Error to Application when the X-EBAY-API-SITEID request header sets to 0 Trading APIProductionResolvedFri Sep 28 2018 GetOrders/GetOrderTransactions are returning empty Buyer Shipping Address for Completed Orders We are aware of this issue anr actively working to get this issue resolved. **Workaround**: You can make the GetItemTransactions API Call to get the Buyer's Shipping Address. \]\]>https://developer.ebay.com/support/api-status/Production/getorders-getordertransactions-are-returning-empty-buyer-shipping-address-for-completed-orders147GetOrders/GetOrderTransactions are returning empty Buyer Shipping Address for Completed OrdersTrading, CheckoutProductionResolvedTue Sep 18 2018Add/Verify/Revise/Relist family of calls are failing with Error 10007: Internal Error to Application We are aware of this issue anr actively working to get this issue resolved. \]\]>https://developer.ebay.com/support/api-status/Sandbox/sandbox-add-verify-revise-relist-family-of-calls-are-failing-with-internal-error-to-application148Sandbox: Add/Verify/Revise/Relist family of calls are failing with Internal Error to ApplicationTradingSandboxResolvedFri Sep 14 2018New Developers are not able to Activate their Support Account We are aware of this issue and working on fixing it. \]\]>https://developer.ebay.com/support/api-status/Production/new-developers-are-not-able-to-activate-their-support-account149New Developers are not able to Activate their Support AccountDeveloper PortalProductionResolvedTue Aug 07 2018Developers who have active support tickets will see slow/delayed response from the Developer Support team. Rigth now we are experiencing some issues with our Ticket Management System and are actively working on fixing it. We appreciate your patience. \]\]>https://developer.ebay.com/support/api-status/Production/delayed-response-on-the-developer-support-tickets150Delayed response on the Developer Support Tickets SupportProductionResolvedMon Jul 30 2018Sandbox API users are getting the error "Internal error to the application" while making the Add/Revise/Relist Calls We are aware of this issue and actively looking into the issue. \]\]>https://developer.ebay.com/support/api-status/Sandbox/sandbox-add-revise-relist-calls-are-throwing-the-error-internal-error-to-the-application-1151Sandbox: Add/Revise/Relist Calls are throwing the error Internal Error to the ApplicationTrading APISandboxResolvedWed Jul 11 2018https://developer.ebay.com/support/api-status/Sandbox/sandbox-buy-it-now-button-is-broken152Sandbox - Buy it Now button is brokenSandboxSandboxResolvedWed May 30 2018 Variations not enabled in category Selected category is not enabled for variation listings 21916564 Error RequestError We are working on the resolution of this case. \]\]>https://developer.ebay.com/support/api-status/Production/edit-variations-missing-for-canada-site153Edit Variations missing for Canada SiteTrading APIProductionResolvedWed Apr 25 2018 The response to the call is a html response We are aware of this issue and currently working on the fix. \]\]>https://developer.ebay.com/support/api-status/sandbox/sandbox-all-finding-api-s-are-down154Sandbox: All Finding API's are downSearchsandboxresolvedWed Apr 11 2018https://developer.ebay.com/support/api-status/sandbox/sandbox-sell-link-is-not-working155Sandbox - Sell link is not workingSandboxsandboxunresolvedWed Apr 04 2018https://developer.ebay.com/support/api-status/sandbox/sandbox-uploadsitehostedpictures-not-working156Sandbox - UploadSiteHostedPictures not workingTrading APIsandboxresolvedMon Apr 02 2018 We are aware of this issue and are actively working on resolving it. \]\]>https://developer.ebay.com/support/api-status/production/getproductcompatibilities-api-is-returning-a-http-500-internal-server-error-for-any-epid157getProductCompatibilities API is returning a Http 500 Internal Server error for any ePIDTrading APIproductionresolvedFri Mar 16 2018 When logginginto your developer account or the API explorer, users are seeing an "Internal error to application" message, and are unable to view Sandbox Keys or generate any sandbox token. While trying to create a Sandbox User using the Sandbox Registration tool , users are getting an "Unknown Error". All Trading API Calls to the Sandbox endpoint are timing out. We are working on resolving the issues: \]\]>https://developer.ebay.com/support/api-status/sandbox/sandbox-keysets-are-unavailable-to-view-sandbox-user-creation-broken-in-the-developer-s-keys-page-all-trading-api-calls-in-sandbox-are-timing-out158Sandbox keysets are unavailable to view + Sandbox User Creation broken in the Developer's Keys Page + All Trading API Calls in Sandbox are timing outTrading API, SandboxsandboxresolvedTue Feb 06 2018https://developer.ebay.com/support/api-status/sandbox/lms-jobs-always-failed-in-sandbox159LMS jobs always failed in SandboxLarge Merchant ServicessandboxresolvedFri Jan 26 2018 They are seeing the below error: System.ServiceModel.FaultException: Transport outbound I/O exception in FileTransferPrivateServiceV2: java.util.concurrent.TimeoutException, at service location: [https://storage.sandbox.ebay.com/\_soa\_/services/Infrastructure/FileTrans...](https://storage.sandbox.ebay.com/_soa_/services/Infrastructure/FileTransferPrivateServiceV2/v2/) We are aware of this issue and working on it.\]\]>https://developer.ebay.com/support/api-status/sandbox/sandbox-users-are-not-able-use-lms-to-test160Sandbox Users are not able use LMS to testLarge Merchant ServicessandboxresolvedThu Jan 18 2018https://developer.ebay.com/support/api-status/production/resolved-developer-forums-users-not-able-to-login161RESOLVED - Developer Forums: Users not able to loginSDK's and Developer ToolsproductionresolvedWed Nov 01 2017https://developer.ebay.com/support/api-status/production/resolved-validation-of-the-authentication-token-in-api-request-failed-intermittently-for-valid-tokens162RESOLVED - "Validation of the authentication token in API request failed" intermittently for Valid TokensTrading APIproductionresolvedFri Oct 27 2017https://developer.ebay.com/support/api-status/sandbox/resolved-sandbox-users-are-not-able-to-complete-checkout-for-us-uk-and-au-sites163RESOLVED- Sandbox: Users are not able to complete checkout for US, UK and AU sitesSandboxsandboxresolvedFri Oct 27 2017 This issue is internittent . We are aware of the issue and actively working on getting it fixed. \]\]>https://developer.ebay.com/support/api-status/production/intermittent-some-notifications-are-not-getting-sent164Intermittent: Some Notifications are not getting sentTrading APIproductionresolvedWed Oct 18 2017https://developer.ebay.com/support/api-status/sandbox/eps-uploadsitehostedpictures-currently-not-working-in-sandbox165EPS UploadSiteHostedPictures Currently not working in SandboxTrading APIsandboxresolvedTue Oct 17 2017 Users are seeing the below error while trying to list on Motors site: All compatibilities invalid. All compatibilities are invalid, Item not listed 21917122 Error RequestError We are aware of this issue and working on it.\]\]>https://developer.ebay.com/support/api-status/production/sellers-are-not-able-to-list-motors-items-us-and-international166Sellers are not able to list Motors Items- US and InternationalTrading APIproductionresolvedThu Oct 12 2017https://developer.ebay.com/support/api-status/production/unable-to-receive-platform-notifications167Unable to receive Platform NotificationsTrading APIproductionresolvedThu Sep 21 2017https://developer.ebay.com/support/api-status/production/getsellerevent-missing-items-in-api-response-some-sellers-reported-that-getsellerevents-is-returning-only-1-record-no-matter-how-the-time-range-was-set168GetSellerEvent: missing items in API response. Some sellers reported that GetSellerEvents is returning only 1 record no matter how the time range was setTrading APIproductionresolvedFri Sep 15 2017https://developer.ebay.com/support/api-status/sandbox/resolved-sandbox-add-revise-relist-calls-are-throwing-the-error-system-temporarily-unavailable169RESOLVED - Sandbox: Add/Revise/Relist Calls are throwing the error System Temporarily UnavailableTrading APIsandboxresolvedTue Aug 22 2017 We are aware of the issue and working on fixing it. \]\]>https://developer.ebay.com/support/api-status/sandbox/all-shopping-api-in-sandbox-are-returning-a-503-service-unavailable-error170All Shopping API in Sandbox are returning a 503: Service Unavailable errorSandboxsandboxresolvedFri Aug 18 2017 and the are set to the same value. The error that you see is ErrorCode : 23005 ShortMessage: Auto Accept price must be higher than Auto Decline price. LongMessage: The price foraccepting offers cannot be lower than or equal to the price for declining offers. We are aware of this issue and working on fixing it\]\]>https://developer.ebay.com/support/api-status/production/add-revise-api-calls-for-some-items-with-bestoffer-on-them-are-failing-with-the-error-23005171Add/Revise API calls for some items with BestOffer on them are failing with the Error 23005Trading APIproductionresolvedThu Aug 17 2017 Issue 2) API Usage Report in developer.ebay.com is not showing data after July 13 2017. We are aware of this issue and currently working on a resolution. \]\]>https://developer.ebay.com/support/api-status/production/getapiaccessrules-and-api-usage-report-not-working172GetAPIAccessRules and API Usage Report Not WorkingTrading APIproductionresolvedThu Aug 17 2017https://developer.ebay.com/support/api-status/production/all-merchandising-api-are-failing-with-page-not-responding173All Merchandising API are failing with "Page Not Responding"Search, Trading APIproductionresolvedWed Aug 02 2017 We are aware of the issue and continuously working on getting the issue resolved. \]\]>https://developer.ebay.com/support/api-status/sandbox/sandbox-user-registration-is-currently-broken-on-the-developer-portal174Sandbox User Registration is currently broken on the Developer PortalSandboxsandboxresolvedWed Jul 19 2017We are working on resolving the following issues: * When logging into your developer account or the API explorer, users are seeing an "Internal error to application" message, and are unable to view Sandbox Keys or generate any sandbox token. * Some users are seeing timeout exceptions when making TradingAPI Calls in the Sandbox. \]\]>https://developer.ebay.com/support/api-status/sandbox/sandbox-keysets-unavailable-and-trading-api-calls-timing-out-in-sandbox175Sandbox Keysets Unavailable and Trading API Calls Timing Out in SandboxSandbox, Trading APIsandboxresolvedTue Jul 18 2017 The issue hasbeen resolved You can now submit self-hosted HTTPS images when list an item via Add/Revise/Relist families of calls \]\]>https://developer.ebay.com/support/api-status/production/resolved-vendor-hosted-https-gallery-image-is-not-showing176RESOLVED- Vendor hosted HTTPs Gallery Image is not showingTrading APIproductionresolvedMon Jul 10 2017https://developer.ebay.com/support/api-status/sandbox/trading-ap-is-down-in-sandbox177Trading AP is down in SandboxSandboxsandboxresolvedThu Jul 06 2017https://developer.ebay.com/support/api-status/sandbox/sandbox-keyset-missing-unable-to-generate-token178Sandbox keyset missing, unable to generate tokenSandboxsandboxresolvedMon Jun 12 2017https://developer.ebay.com/support/api-status/sandbox/sandbox-internal-error-to-the-application-unable-to-create-keyset179Sandbox: Internal Error to the application\\Unable to create KeySetTrading APIsandboxresolvedTue May 23 2017 We are aware of this issue and working on fixing this issue. \]\]>https://developer.ebay.com/support/api-status/production/finding-api-is-intermittently-returning-404-errors180Finding API is intermittently returning 404 errorsSearchproductionresolvedThu May 18 2017 We are aware of this issue and the engineering is working on fixing it. Workaround: Please set the GLOBAL-ID to EBAY-US to get results.\]\]>https://developer.ebay.com/support/api-status/production/finditemsadvanced-returning-very-few-or-no-results-for-motors-categories-using-the-global-id-ebay-motor181FindItemsAdvanced returning very few or no results for Motors categories using the GLOBAL-ID = EBAY-MOTORSearchproductionresolvedWed May 17 2017https://developer.ebay.com/support/api-status/sandbox/sandbox-managing-keysets-and-tokens-throwing-internal-error-to-the-application182Sandbox: Managing Keysets and Tokens throwing "Internal error to the application"SandboxsandboxresolvedTue Apr 11 2017https://developer.ebay.com/support/api-status/sandbox/sandbox-add-revise-relist-calls-are-throwing-the-error-internal-error-to-the-application183Sandbox: Add/Revise/Relist Calls are throwing the error "Internal error to the application."Sandbox, Trading APIsandboxresolvedTue Mar 28 2017https://developer.ebay.com/support/api-status/production/users-are-not-able-add-revise-items-due-to-error-brand-mpn-missing184Users are not able Add/Revise items due to error:Brand/MPN missingTrading APIproductionresolvedThu Mar 16 2017https://developer.ebay.com/support/api-status/production/findcompleteditems-is-returning-very-few-items-in-the-api-response185findCompletedItems is returning very few items in the API responseSearchproductionresolvedFri Feb 17 2017 We are aware of the issue and working on fixing the it. Workaround: Please use the earlier version i.e 983 to generate your stubs if its is urgent.\]\]>https://developer.ebay.com/support/api-status/production/users-are-not-able-to-generate-stub-code-with-the-latest-v989-trading-wsdl186Users are not able to generate stub code with the latest V989 Trading WSDLTrading APIproductionresolvedWed Feb 15 2017 Internal error to the application. Internal error to the application. 10007 Error RequestError We are aware of the issue and working on getting the issue fixed. \]\]>https://developer.ebay.com/support/api-status/sandbox/all-add-family-of-calls-are-failing-with-internal-error-to-application187All Add Family of calls are failing with Internal Error to ApplicationSandboxsandboxresolvedWed Dec 07 2016https://developer.ebay.com/support/api-status/production/developers-are-unable-to-access-the-support-ticket-knowledge-base-pages188Developers are unable to access the Support ticket/ Knowledge base pagesSDK's and Developer ToolsproductionresolvedFri Dec 02 2016https://developer.ebay.com/support/api-status/production/developers-cannot-access-the-support-ticket-knowledge-base-pages-1189Developers cannot access the Support ticket/ Knowledge base pagesSDK's and Developer ToolsproductionresolvedFri Oct 28 2016https://developer.ebay.com/support/api-status/production/developers-cannot-access-the-support-ticket-knowledge-base-pages190Developers cannot access the Support ticket/ Knowledge base pagesSDK's and Developer Tools, Trading APIproductionresolvedThu Oct 20 2016 ExternalPictureURL server not available The server specified by ExternalPictureURL is not responding 21916543 Error ExternalPictureURL RequestError \]\]>https://developer.ebay.com/support/api-status/production/uploadsitehostedpictures-api-call-fails-with-errorcode-21916543191UploadSiteHostedPictures API call fails with errorCode: 21916543Trading APIproductionresolvedWed Oct 12 2016https://developer.ebay.com/support/api-status/production/sell-your-item-flow-in-us-sandbox-in-broken192Sell Your Item flow in US Sandbox in brokenSandboxproductionresolvedMon Sep 12 2016https://developer.ebay.com/support/api-status/production/api-calls-are-sporadically-timing-out-or-slow-response-for-trading-finding-lms-api-products193API calls are sporadically timing out or slow response for Trading, Finding, LMS API ProductsTrading APIproductionresolvedWed Aug 31 2016https://developer.ebay.com/support/api-status/production/api-calls-are-sporadically-timing-out-trading-finding-lms194API calls are sporadically timing out (Trading, Finding, LMS)Trading APIproductionresolvedTue Aug 30 2016https://developer.ebay.com/support/api-status/production/access-issue-to-open-ebay-applications195Access issue to Open eBay ApplicationsResolutions, and OthersproductionresolvedMon Aug 01 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-users-are-not-able-to-login-to-sandbox-environment-1196Sandbox Users are Not able to login to Sandbox environmentSandboxsandboxresolvedMon Jul 25 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-users-are-not-able-to-login-to-sandbox-environment197Sandbox Users are Not able to login to Sandbox environmentSandboxsandboxresolvedTue Jul 12 2016https://developer.ebay.com/support/api-status/sandbox/developers-are-not-able-to-register-new-sandbox-users-via-the-developer-portal198Developers are not able to register new Sandbox Users via the developer portalSandboxsandboxresolvedTue Jul 12 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-additem-families-of-calls-is-throwing-error-as-internal-error-to-the-application-intermittently199SANDBOX: AddItem families of calls is throwing error as 'Internal error to the application' intermittently.Sandbox, Trading APIsandboxresolvedTue May 24 2016https://developer.ebay.com/support/api-status/sandbox/checkout-broken-on-sandbox200Checkout broken on SandboxSandboxsandboxresolvedFri May 20 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-not-able-to-login-to-sandbox-us201Sandbox: Not able to login to Sandbox USSandboxsandboxresolvedFri May 06 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-unable-to-generate-keyset-on-the-developer-site202SANDBOX: unable to generate keyset on the Developer SiteSandbox, Trading APIsandboxresolvedThu May 05 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-trading-api-calls-failing-with-error-503203SANDBOX Trading API calls failing with error 503Sandbox, Trading APIsandboxresolvedThu May 05 2016https://developer.ebay.com/support/api-status/sandbox/all-lms-jobs-in-sandbox-are-failing-with-the-http-503-server-unavailable-error204All LMS Jobs in Sandbox are failing with the Http "503 Server Unavailable" ErrorLarge Merchant Services, SandboxsandboxresolvedWed Apr 20 2016https://developer.ebay.com/support/api-status/production/ebay-developer-forums-are-down205eBay Developer Forums are downSDK's and Developer Tools, Large Merchant Services, Resolutions, and Others, Search, Trading APIproductionresolvedMon Apr 18 2016https://developer.ebay.com/support/api-status/sandbox/trading-api-calls-might-fail-with-10007-error206Trading API calls might fail with 10007 errorSandbox, Trading APIsandboxresolvedTue Apr 05 2016https://developer.ebay.com/support/api-status/production/trading-api-spradically-failing-with-503-http-1-1-service-unavailable-error207Trading API spradically failing with 503 Http 1.1 Service Unavailable errorTrading APIproductionresolvedMon Mar 28 2016https://developer.ebay.com/support/api-status/production/images-are-not-getting-revised-for-few-items-via-revise-calls208Images are not getting revised for few Items via Revise CallsTrading APIproductionresolvedMon Mar 28 2016https://developer.ebay.com/support/api-status/production/finding-api-calls-fail-with-error-28-invalid-seller-name-when-seller-itemfilter-is-used209Finding API calls fail with error 28 "Invalid seller name" when Seller ItemFilter is usedSearchproductionresolvedThu Feb 25 2016https://developer.ebay.com/support/api-status/production/captcha-is-broken-new-developers-are-unable-to-sign-up-for-developer-s-program-1210Captcha is Broken- New Developers are Unable to Sign-Up for Developer's ProgramSDK's and Developer ToolsproductionresolvedThu Feb 25 2016https://developer.ebay.com/support/api-status/sandbox/sandbox-checkout-broken-on-international-sites211Sandbox Checkout broken on International SitesSandboxsandboxresolvedWed Jan 13 2016https://developer.ebay.com/support/api-status/production/most-lms-jobs-are-failing212Most LMS jobs are failingLarge Merchant ServicesproductionresolvedThu Dec 31 2015https://developer.ebay.com/support/api-status/production/captcha-is-broken-new-developers-are-unable-to-sign-up-for-developer-s-program213Captcha is Broken- New Developers are Unable to Sign-Up for Developer's ProgramSDK's and Developer ToolsproductionresolvedTue Dec 29 2015https://developer.ebay.com/support/api-status/production/api-calls-might-fail-with-10007-error214API calls might fail with 10007 error.Large Merchant Services, Resolutions, and Others, Trading APIproductionresolvedWed Nov 25 2015https://developer.ebay.com/support/api-status/production/active-inventory-report-is-returning-wrong-quantity215Active Inventory Report is returning wrong QuantityLarge Merchant ServicesproductionresolvedFri Nov 20 2015https://developer.ebay.com/support/api-status/production/getitem-api-call-returns-error-10007216GetItem API call returns error 10007Trading APIproductionresolvedFri Nov 20 2015https://developer.ebay.com/support/api-status/sandbox/ebay-sandbox-and-trading-api-in-sandbox-is-down217eBay Sandbox and Trading API in Sandbox is downSandbox, Trading APIsandboxresolvedMon Nov 16 2015https://developer.ebay.com/support/api-status/sandbox/ebay-sandbox-is-undergoing-maintenance-on-11-11-wednesday-from-3-00-5-00-pm-pst218Ebay Sandbox is undergoing maintenance on 11/11, Wednesday from 3:00 - 5:00 pm PSTSandboxsandboxresolvedSat Nov 14 2015https://developer.ebay.com/support/api-status/production/lms-calls-are-failing-with-error-authentication-failed219LMS calls are failing with error 'Authentication failed..'Large Merchant ServicesproductionresolvedThu Nov 05 2015https://developer.ebay.com/support/api-status/production/additem-calls-are-failing-in-production-with-error-10007-internal-error-to-the-application220AddItem calls are failing in production with error-10007 “Internal error to the application”.Trading APIproductionresolvedMon Nov 02 2015https://developer.ebay.com/support/api-status/sandbox/all-lms-jobs-in-sandbox-are-failing-with-http-1-1-service-unavailable-error221All LMS jobs in Sandbox are failing with 'Http 1.1 Service Unavailable" errorTrading APIsandboxresolvedFri Oct 30 2015https://developer.ebay.com/support/api-status/sandbox/not-able-to-link-ebay-sandbox-account-with-paypal-sandbox-account222Not able to link eBay Sandbox account with PayPal Sandbox AccountSandboxsandboxresolvedThu Oct 29 2015https://developer.ebay.com/support/api-status/sandbox/user-s-are-not-able-to-checkout-items-with-autopay-true-in-sandbox223User's are not able to checkout items with AutoPay=true in SandboxSandboxsandboxresolvedMon Oct 19 2015https://developer.ebay.com/support/api-status/sandbox/not-able-to-create-shipping-business-policies-in-sandbox224Not able to create Shipping Business Policies in sandboxSandboxsandboxresolvedMon Oct 19 2015https://developer.ebay.com/support/api-status/sandbox/user-s-are-not-able-place-bids-on-auction-items-in-sandbox225User's are not able place bids on Auction Items in SandboxSandboxsandboxresolvedMon Oct 19 2015https://developer.ebay.com/support/api-status/sandbox/not-able-to-list-via-api-or-ui-in-sandbox-all-sites-are-affected226Not able to list via API or UI in Sandbox - All Sites are affectedTrading APIsandboxresolvedFri Oct 09 2015https://developer.ebay.com/support/api-status/sandbox/sandbox-outage-due-to-maintainence-on-thursday-10-09-2015-11pm-12am227Sandbox outage due to maintainence on Thursday - 10/09/2015 11pm -12amSandboxsandboxresolvedFri Oct 09 2015GetSellerTransactions is not returning half.com orders in the response. We are aware of this issue, and the engineering is actively looking into it. We sincerely apologize for the inconvenience. \]\]>https://developer.ebay.com/support/api-status/production/getsellertransactions-api-is-not-returning-any-half-com-orders-in-the-response228GetSellerTransactions api is not returning any half.com orders in the responseTrading APIproductionresolvedWed Aug 26 2015You may get Authentication error 11002 using the FileTransfer API in sandbox even with a valid token. We are aware of this issue, and the engineering team is currently looking into the issue. We sincerely apologize for the inconvenience this issue may have caused. \]\]>https://developer.ebay.com/support/api-status/sandbox/filetransfer-api-throwing-authentication-error-11002-in-sandbox229FileTransfer API throwing Authentication error-11002 in sandboxSandboxsandboxresolvedWed Jul 22 2015https://developer.ebay.com/support/api-status/sandbox/us-sandbox-is-down230US Sandbox is downSandboxsandboxresolvedFri Jul 17 2015Due to some technical issues, you may not be able to view listings in sandbox. We are aware of this issue, and the engineering team is actively working to resolve the issue. We sincerely apologize for the inconvenience this issue may have caused. \]\]>https://developer.ebay.com/support/api-status/sandbox/unable-to-view-items-in-sandbox231Unable to view items in sandboxSandboxsandboxresolvedFri Jul 17 2015Due to some technical issues, you may not be able to access Business Policies in sandbox via UI or api. We are aware of this issue, and the engineering team is actively working to resolve the issue. We sincerely apologize for the inconvenience this issue may have caused. \]\]>https://developer.ebay.com/support/api-status/sandbox/business-policies-feature-not-working-in-sandbox232Business Policies feature not working in sandboxSandboxsandboxresolvedWed Jul 15 2015Add/Revise/Relist/End API Call requests are timing out for all users in Sandbox. We are aware of this issue, and the engineering team is activelyworking to resolve the issue. \]\]>https://developer.ebay.com/support/api-status/sandbox/add-revise-relist-end-api-calls-in-sandbox-are-timing-out-for-all-users233Add/Revise/Relist/End api calls in sandbox are timing out for all UsersSandbox, Trading APIsandboxresolvedThu Jul 02 2015Users are not able to run LMS jobs in the Sandbox environment. When they try to do so, they are getting the error: "Http/1.1 Service Unavailable" We are aware of this issue and working to get this issue fixed. \]\]>https://developer.ebay.com/support/api-status/sandbox/lms-sandbox-users-are-seeing-http-1-1-service-unavailable-error234LMS Sandbox users are seeing "Http/1.1 Service Unavailable" errorLarge Merchant ServicessandboxresolvedMon Jun 15 2015https://developer.ebay.com/support/api-status/production/lms-activeinventoryreport-is-not-returning-sku235LMS ActiveInventoryReport is not returning SKULarge Merchant ServicesproductionresolvedFri Jun 12 2015When trying to execute UploadSiteHostedPictures api request in sandbox, it returns error-10007 ''Internal error to the application.'' in the api response. We are aware of this issue, and the engineering team is actively working to resolve the issue. \]\]>https://developer.ebay.com/support/api-status/sandbox/uploadsitehostedpictures-api-is-throwing-error-10007-in-sandbox-1236UploadSiteHostedPictures api is throwing error-10007 in SandboxSandboxsandboxresolvedWed May 20 2015Our Support Ticket system is currently down. We are working to restore access as quickly as possible. Meanwhile, please report the issues in the forum : [https://forums.developer.ebay.com/](https://forums.developer.ebay.com/) We sincerely apologize for the inconvenience this outage may have caused. \]\]>https://developer.ebay.com/support/api-status/production/support-ticket-system-is-down237Support Ticket system is downSDK's and Developer Tools, Large Merchant Services, Resolutions, and Others, Sandbox, Search, Trading APIproductionresolvedWed May 13 2015While trying to access MyeBay in sandbox, it is throwing 'Http/1.1 Service Unavailable ' error. We are aware of this issue, and the engineering team is actively working to resolve the issue. If you are still blocked due to this issue, please file a support request here : [http://developer.ebay.com/support/developersupport/default.aspx](http://developer.ebay.com/support/developersupport/default.aspx) , or report the issue in the forum : [https://forums.developer.ebay.com/spaces/15/ebay-apis-getting-tokens-not...](https://forums.developer.ebay.com/spaces/15/ebay-apis-getting-tokens-notifications-alerts-mess.html) We sincerely apologize for the inconvenience this issue may have caused. \]\]>https://developer.ebay.com/support/api-status/sandbox/myebay-in-sandbox-is-broken238MyeBay in sandbox is brokenSandboxsandboxresolvedMon May 11 2015MyeBay(Active/Sold pages) is showing blank information in Sandbox. We are aware of this issue, and the engineering team is actively working toresolve the issue. Workaround : If you are blocked due to this issue, please consider subscribing to 'Selling Manager Pro' to view your Active/Sold listings or End itemsetc. To subscribe for 'Selling Manager Pro', you need to go to My eBay > My Account > Subscriptions and subscribe for ‘Selling Manager Pro’. If you are still blocked due to this issue, please file a support request here : [http://developer.ebay.com/support/developersupport/default.aspx](http://developer.ebay.com/support/developersupport/default.aspx) , or report the issue in the forum : [https://forums.developer.ebay.com/spaces/12/ebay-apis-selling.html](https://forums.developer.ebay.com/spaces/12/ebay-apis-selling.html) We sincerely apologize for the inconvenience this issue may have caused. \]\]>https://developer.ebay.com/support/api-status/sandbox/unable-to-view-active-listings-in-sandbox239Unable to view Active listings in SandboxSandboxsandboxresolvedThu Apr 30 2015In some cases, the same OrderLineItem is appearing twice in GetOrders api i.e. once as a single order, and then as a part of combined order. If you are also facing this issue, please file a support ticket here :[http://developer.ebay.com/support/developersupport/default.aspx](http://developer.ebay.com/support/developersupport/default.aspx) , or report in the forum here : [https://forums.developer.ebay.com/spaces/8/default.html](https://forums.developer.ebay.com/spaces/8/default.html) \]\]>https://developer.ebay.com/support/api-status/production/getorders-api-combined-order-issue240GetOrders api : Combined order issueTrading APIproductionresolvedWed Apr 22 2015You might experience issues while using LMS in sandbox (for example :errors like Transport outbound I/O exception). We are aware of this issue, and the engineering team is actively working to resolve the issue. \]\]>https://developer.ebay.com/support/api-status/sandbox/lms-issues-in-sandbox241LMS issues in sandboxSandboxsandboxresolvedWed Apr 22 2015https://developer.ebay.com/support/api-status/sandbox/uploadsitehostedpictures-api-is-throwing-error-10007-in-sandbox242UploadSiteHostedPictures api is throwing error-10007 in SandboxSandboxsandboxresolvedThu Mar 19 2015https://developer.ebay.com/support/api-status/sandbox/sandbox-is-down-1243Sandbox is downSandboxsandboxresolvedFri Mar 13 2015https://developer.ebay.com/support/api-status/production/invalid-character-in-xml-lms-soldreport244Invalid character in XML LMS SoldReportLarge Merchant ServicesproductionresolvedThu Mar 12 2015https://developer.ebay.com/support/api-status/sandbox/unable-to-generate-user-token-in-sandbox245Unable to generate user token in sandboxSandboxsandboxresolvedMon Mar 09 2015https://developer.ebay.com/support/api-status/production/lms-activeinventoryreport-giving-back-invalid-quantities246LMS ActiveInventoryReport giving back invalid quantitiesLarge Merchant ServicesproductionresolvedTue Dec 16 2014The 'View My Store' link from : My eBay-> Account-> Subscriptions-> Manage My Store opens a page that throws "Server Not Found" error. We are actively working on getting this issue fixed. \]\]>https://developer.ebay.com/support/api-status/sandbox/view-my-store-link-broken-in-sandbox247'View My Store' link broken in SandboxSandboxsandboxresolvedTue Dec 16 2014Sandbox environment is currently very unstable. Users are unable to login to sandbox, search in sandbox or subscribe to stores in sandbox. We are aware of this issue and the engineering team is currently looking into the issue. \]\]>https://developer.ebay.com/support/api-status/sandbox/sandbox-is-down248Sandbox is downSandboxsandboxresolvedMon Nov 10 2014Sandbox homepage is down, sandbox.ebay.com. If you have other sandbox links saved that should work. Here is an example link, [http://cgi.sandbox.ebay.com/110151862957?ru=http%3A%2F%2Fwww.sandbox.eba...](http://cgi.sandbox.ebay.com/110151862957?ru=http%3A%2F%2Fwww.sandbox.ebay.com%3A80%2Fsch%2Fi.html%3F_from%3DR40%26_trksid%3Dp2588.m570.l1313.TR0.TRC0.H0.X110151862957%2B%26_nkw%3D110151862957%2B%26_sacat%3D0%26_fvi%3D1&_rdc=1#ht_852wt_1165) . Once you are in the sandbox you should beable to do most functionaltiy. \]\]>https://developer.ebay.com/support/api-status/sandbox/resolved-sandbox-homepage-down249RESOLVED: Sandbox homepage downSandboxsandboxresolvedThu Nov 06 2014https://developer.ebay.com/support/api-status/sandbox/resolved-unable-to-view-items-in-us-sandbox-site250RESOLVED : Unable to view items in US sandbox siteSandboxsandboxresolvedThu Nov 06 2014https://developer.ebay.com/support/api-status/sandbox/resolved-listing-page-in-sandbox-is-broken251RESOLVED : Listing page in sandbox is brokenSandboxsandboxresolvedThu Nov 06 2014https://developer.ebay.com/support/api-status/sandbox/resolved-sign-in-link-broken-in-sandbox252RESOLVED : Sign In link broken in sandboxSandboxsandboxresolvedThu Nov 06 2014LATEST UPDATE : This issue is now RESOLVED !!! Users may face issues while trying to login to their developer account. While trying to login to the developer account via [https://go.developer.ebay.com/developers/ebay](https://go.developer.ebay.com/developers/ebay) , you may get error like "This webpage has a redirect loop" We are aware of this issue and our engineering team is actively working to resolve the issue. As a workaround, please use : [https://developer.ebay.com/DevZone/account/appsettings/](https://developer.ebay.com/DevZone/account/appsettings/) to login. In order to file a support ticket, you can use : [http://developer.ebay.com/support/developersupport/request/default.aspx](http://developer.ebay.com/support/developersupport/request/default.aspx) We apologize for any inconvenience this issue may have caused. \]\]>https://developer.ebay.com/support/api-status/production/resolved-developer-account-login-is-not-working-use-the-workarounds253RESOLVED : Developer account login is not working - use the workaroundsSDK's and Developer ToolsproductionresolvedThu Nov 06 2014http://www2.ebay.com/aw/announce.shtml#2014-09-03174031\]\]>https://developer.ebay.com/support/api-status/production/some-trading-apis-are-failing254Some trading apis are failingTrading APIproductionresolvedThu Nov 06 2014https://developer.ebay.com/support/api-status/production/resolved-getsellerevents-is-throwing-error-10007-internal-error-to-the-application255RESOLVED : GetSellerEvents is throwing error-10007 'Internal error to the application'Trading APIproductionresolvedThu Nov 06 2014true is specified in the request :\]\]>https://developer.ebay.com/support/api-status/production/resolved-getsellertransactions-api-is-throwing-error-10007-internal-error-to-the-application256RESOLVED : GetSellerTransactions api is throwing error-10007 'Internal Error to the Application'Trading APIproductionresolvedThu Nov 06 2014https://developer.ebay.com/support/api-status/production/resolved-messages-sent-via-addmembermessagertq-api-not-getting-delivered-to-buyers257RESOLVED : Messages sent via AddMemberMessageRTQ api not getting delivered to buyersTrading APIproductionresolvedThu Nov 06 2014This issue is now RESOLVED !!! You might get the following error in the response when executing GetItem or GetSellerList api calls We are aware of this issue and the engineering team is currently looking into the issue. \]\]>https://developer.ebay.com/support/api-status/production/resolved-getitem-and-getsellerlist-throwing-web-service-framework-internal-error258RESOLVED : GetItem and GetSellerList throwing "Web Service framework internal error"Trading APIproductionresolvedThu Nov 06 2014 --- # Tutorials - Trading API eBay Trading API * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/api-docs/user-guides/static/make-a-call-landing.html) * [API Reference](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/index.html) * [Tutorials](https://developer.ebay.com/Devzone/xml/docs/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html) Trading API Tutorials ===================== The following tutorials have been written specifically for the Trading API: | Tutorial | Description | Source Code | | --- | --- | --- | | XML Workflow Tutorials (using API directly) | | | | [Getting Tokens](https://developer.ebay.com/Devzone/xml/docs/HowTo/Tokens/GettingTokens.html) | This tutorial illustrates the setup and the API calls needed for getting tokens that let you make calls on behalf of your users. | XML input/output | | [XML API FLow: Listing an Item](https://developer.ebay.com/Devzone/xml/docs/HowTo/XML_ListingAndSelling/ListingAndSelling_listing.html) | This tutorial illustrates the API workflow for listing an item on eBay. | XML input/output | | [XML API FLow: Buying an Item](https://developer.ebay.com/Devzone/xml/docs/HowTo/XML_ListingAndSelling/ListingAndSelling_buying.html) | This tutorial illustrates the API workflow for bidding on an auction item on eBay. | XML input/output | | [XML API FLow: Completing a Sale](https://developer.ebay.com/Devzone/xml/docs/HowTo/XML_ListingAndSelling/ListingAndSelling_completingSale.html) | This tutorial illustrates the API workflow for completing the sale of an auction item with a winning bid. | XML input/output | | [XML API Flow: Getting Notifications](https://developer.ebay.com/Devzone/xml/docs/HowTo/Notifications/Notifications_listing.html) | This tutorial uses a basic use case to illustrate how to subscribe to and receive Platform Notifications. | XML input/output | | PHP, Perl, C#, Java Tutorials (using API directly, no SDK) | | | | [Perl: XML API: Making your first call (GetUser)](https://developer.ebay.com/Devzone/xml/docs/HowTo/FirstCall/MakingCallXML.html) | This tutorial illustrates the basics of executing a call in the eBay Trading API (via Perl—specifically, the **GetUser** call. | N/A | | [C#: SOAP API: Making your first call (GetUser)](https://developer.ebay.com/Devzone/xml/docs/HowTo/FirstCall/MakingCallCSharp.html) | This tutorial walks you through the basics of executing a call—specifically, the **GetUser** call—for the eBay SOAP API. The **GetUser** call is the simplest call in the API. It can be used as a simple way to verify whether you are communicating with the eBay API servers. | See tutorial. | | [Java: SOAP API: Making your first call (GetUser)](https://developer.ebay.com/Devzone/xml/docs/HowTo/FirstCall/MakingCallJava.html) | This tutorial walks you through the basics of executing a call—specifically, the **GetUser** call—for the eBay SOAP API. The **GetUser** call is the simplest call in the API. It can be used as a simple way to verify whether you are communicating with the eBay API servers. | See tutorial. | | [Getting Started with a PHP Bidding/Buying Application](https://developer.ebay.com/Devzone/xml/docs/HowTo/PHP_PlaceOfferGS/PHP_PlaceOfferGS_TradingShopping.html) | The objective of this tutorial is to write a PHP sample that enables bidding and buying on eBay. | [PHP\_PlaceOfferGS\_TradingShopping.zip](https://developer.ebay.com/Devzone/xml/docs/HowTo/PHP_PlaceOfferGS/PHP_PlaceOfferGS_TradingShopping.zip) | --- # Release Notes - Trading API eBay Trading API * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/api-docs/user-guides/static/make-a-call-landing.html) * [API Reference](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/index.html) * [Tutorials](https://developer.ebay.com/Devzone/xml/docs/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html) Trading API Release Notes ========================= The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues. For older release notes, see the [Release Notes Archive](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotesArchive.html) . | Release Version | Release Date | Description of Release | | --- | --- | --- | | [1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451) | 2026-February-2 | Decommissioned **GetVeROReportStatus**, **GetVeROReasonCodeDetails**, and **VeROReportItems**. | | [1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423) | 2025-July-28 | Decommissioned **ExtendSiteHostedPictures** call; decommissioned **ExtensionInDays** field of the **UploadSiteHostedPictures** call; provided Inventory Mapping API support to the Add/Revise/Relist family of calls; new seller accepted value added to BestOfferStatusCodeType | | [1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421) | 2025-July-15 | Support for easy returns in P&A listings added; New MotorPurchase container added to TransactionProgramType to support Secure Purchase for motor vehicle orders; item fulfillment location information can now be returned the **GetOrders**, **GetItemTransactions**, and **GetSellerTransactions** responses; removed decommissioned enumerated values from **NotificationEventTypeCodeType** | | [1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415) | 2025-May-29 | EPS URL links are now required to be HTTPS for Revise/Relist calls; New Error Message Added in Version 1415; GetCategoryMappings Call Decommissioned; DescriptionReviseMode field use change | | [1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399) | 2025-February-5 | Launch of Buyer Protection for private seller purchases on ebay.co.uk; Added error message for 1399; GeteBayOfficialTime Call Decommissioned; ValidateTestUserRegistration Call Decommissioned; Challenge Calls Decommissioned | | [1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395) | 2025-January-14 | New ContactURL field added to ManufacturerType and ResponsiblePersonType, and two new pre-owned item conditions available for apparel categories. | | [1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391) | 2024-December-19 | New tax ID values added to **ValueTypeCodeType**.

Updated restrictions on P&A tuner category listings. | | [1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379) | 2024-October-14 | Decommissioned **GetClientAlertsAuthToken** call | | [1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375) | 2024-August-26 | Decommissioned DeletedFromUnsoldList and DeletedFromSoldList containers and their associated fields from the **GetMyeBaySelling** call; decommissioned UserData.**SummarySchedule** and UserData.**SMSSubscription** fields for the **GetNotificationPreferences** and **SetNotificationPreferences** calls; removed **UserIDChanged** enumerated value from **NotificationEventTypeCodeType**. | | [1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371) | 2024-July-17 | New schema added to support GPSR information

Removed economic operator fields from Add/Revise/Relist and VerifyItem family of calls | | [1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367) | 2024-July-1 | Decommissioned GetSuggestedCategories call; removed related types | | [1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363) | 2024-May-29 | New requirement when adding EPA approved products | | [1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359) | 2024-May-08 | New error codes for 1359 | | [1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357) | 2024-April-08 | New Fee and Credit enumerated values added to **GetAccount**. | | [1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355) | 2024-April-02 | Decommissioned GetSellerDashboard call; removed related types | | [1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349) | 2024-February-26 | Decommissioned TicketListingDetails and QuantityInfo containers and their associated fields for the Add/Revise/Relist/Verify and GetItem family of calls; Decommissioned UpdateReturnPolicy and UpdateSellerInfo fields in the ReviseItem call; decommissioned OriginatingPostalCode field | | [1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345) | 2024-February-05 | New schema added to support economic operator information.

Decommissioned GetOrderTransactions call; cleaned up decommissioned order-related fields in the GetOrders, GetSellerTransactions, GetItemTransactions, and GetMyeBaySelling calls | Version 1451 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-CC) | | [Schema Changes - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-SC) | | [Announcements - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-AN) | | [New Features - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-NF) | | [Changed Functionality - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-CF) | | [Document Changes and Errata - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1451 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1451 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**VeROReasonCodeDetailsType**` | Type | Removed | | `**VeROSiteDetailType**` | Type | Removed | | `**ReasonCodeDetailType**` | Type | Removed | | `**VeROReportedItemDetailsType**` | Type | Removed | | `**VeROReportedItemType**` | Type | Removed | | `**VeROItemStatusCodeType**` | Type | Removed | | `**VeROReportPacketStatusCodeType**` | Type | Removed | | `**VeROReportItemsType**` | Type | Removed | | `**VeROReportItemType**` | Type | Removed | | `**ShippingRegionCodeType**` | Type | Removed | ### Announcements - 1451 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1451 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-CF) . None for this release. ### Changed Functionality - 1451 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### VeRo Calls Decommissioned The **GetVeROReportStatus**, **GetVeROReasonCodeDetails**, and **VeROReportItems** calls have been decommissioned, and the associated call reference documentation has been removed. Additionally, all types exclusively used by these calls have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-SC) ### Documentation Changes and Errata - 1451 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-NF) and [Changed Functionality - 1451](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1451-CF) . None for this release. Version 1423 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-CC) | | [Schema Changes - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-SC) | | [Announcements - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-AN) | | [New Features - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-NF) | | [Changed Functionality - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-CF) | | [Document Changes and Errata - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1423 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItems.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [UploadSiteHostedPictures](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/UploadSiteHostedPictures.html#ChangeHistory) ### Schema Changes - 1423 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ExtendSiteHostedPicturesRequest**` | Type | Removed | | `**ExtendSiteHostedPicturesResponse**` | Type | Removed | | `**ExtensionInDays**` | Field | Removed | | `**ItemType**` | Type | Modified | | `**MappingReferenceId**` | Field | Added | | `**BestOfferStatusCodeType**` | Type | Modified | | `**Accepted**` | Enum | Modified | | `**SellerAccept**` | Enum | Added | ### Announcements - 1423 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1423 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-CF) . #### Provided **Inventory Mapping API** support to the Add/Revise/Relist family of calls A reference identifier, introduced through the **MappingReferenceId** field, has been added to attribute the source of data across API families. This ID is returned in the response of a call to the **Inventory Mapping API**. Using this ID helps associate requests with the original source used to create the listing. ### Changed Functionality - 1423 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### ExtendSiteHostedPictures Call Decommissioned The **ExtendSiteHostedPictures** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **ExtendSiteHostedPictures** have been removed from the Trading WSDL. You can see a full list of removed types in [Schema Changes - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-SC) #### ExtensionInDays field decommissioned The **ExtensionInDays** field of the **UploadSiteHostedPictures** call has been decommissioned and removed from the WSDL, as eBay no longer supports extending the life of unused EPS URLs beyond 30 days. #### New seller accepted value added to BestOfferStatusCodeType A new enumerated value, **SellerAccept**, was added to the **BestOfferStatusCodeType** to support seller acceptance of a buyer's offer. The **Accepted** enumerated value is now returned only after the buyer has completed the payment. See [Schema Changes - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-SC) for specifics. ### Documentation Changes and Errata - 1423 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-NF) and [Changed Functionality - 1423](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1423-CF) . None for this release. Version 1421 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-CC) | | [Schema Changes - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-SC) | | [Announcements - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-AN) | | [New Features - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-NF) | | [Changed Functionality - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-CF) | | [Document Changes and Errata - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1421 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItemTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetNotificationPreferences](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetNotificationPreferences.html#ChangeHistory) * [GetNotificationsUsage](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetNotificationsUsage.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [SetNotificationPreferences](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/SetNotificationPreferences.html#ChangeHistory) ### Schema Changes - 1421 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**TransactionProgramType**` | Type | Modified | | `**MotorPurchaseType**` | Type | Added | | `**NotificationEventTypeCodeType**` | Type | Modified | ### Announcements - 1421 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1421 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-CF) . #### New MotorPurchase container added to TransactionProgramType A new container, **MotorPurchase**, has been added to **TransactionProgramType** and will be returned by **GetOrders** and **GetItemTransactions** as applicable. This container provides details on a motor vehicle that is being ordered using Secure Purchase. ### Changed Functionality - 1421 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Support for easy returns in P&A listings added To facilitate easy returns on the eBay-US site exclusively, sellers of eligible Parts & Accessories (P&A) listings are required to offer buyers a minimum of 30-day free returns. Initially, starting July 15, 2025, eBay will automatically update return policy settings as applicable and return a warning. Beginning in late August, 2025, listing creation and revision will be blocked with error 2190443 returned. Eligible listings must meet specific criteria. For more information, visit the applicable [Seller Center help page](https://www.ebay.com/sellercenter/news/2025-june/parts-accessories-return-policy) . Also see [Support for easy returns in Parts and Accessories](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html) . To support the new functionality, the following error message and warning have been added in this release. * (error) **21920443**: This P&A listing has a non-compliant domestic return policy. Please update the return window to 30-days (or more) and/or update return shipping cost payer to Seller, and then make another call. Sellers using business policies must make the same changes to their return business policy and then make another call. To learn more, visit https://www.ebay.com/sellercenter/news/2025-june/parts-accessories-return-policy. * (warning) **21920444**: This P&A listing requires a minimum 30-day return period and seller-paid return shipping. eBay automatically updated the listing's return policy settings to meet these requirements. Sellers using business policies should update their return business policy for future P&A listings. To learn more, visit https://www.ebay.com/sellercenter/news/2025-june/parts-accessories-return-policy. #### Item fulfillment location information now returned Item fulfillment location information can now be returned in the **Location** field of the **GetOrders**, **GetItemTransactions**, and **GetSellerTransactions** calls if applicable. If the item is shipped from a fulfillment center location through the Multi-Warehouse Program, this field will return the location details (including the country and zip code) of the fulfillment center closest to the buyer. #### Removed decommissioned enumerated values from **NotificationEventTypeCodeType** The following notification event enumerated values were decommissioned: `AccountSuspended`, `BuyerNoShow`, `AccountSummary`, `AccountSuspended`, `EBNOrderCanceled`, `EBNOrderPickedUp`, `EmailAddressChanged`, `None`, `PasswordChanged`, `PasswordHintChanged`, `PaymentDetailChanged`, and `WebnextMobilePhotoSync`. These values are no longer available for the [GetNotificationPreferences](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetNotificationPreferences.html) , [GetNotificationsUsage](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetNotificationsUsage.html) , and [SetNotificationPreferences](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetNotificationPreferences.html) calls. ### Documentation Changes and Errata - 1421 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-NF) and [Changed Functionality - 1421](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1421-CF) . None for this release. Version 1415 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-CC) | | [Schema Changes - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-SC) | | [Announcements - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-AN) | | [New Features - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-NF) | | [Changed Functionality - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-CF) | | [Document Changes and Errata - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1415 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1415 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**CategoryMappingType**` | Type | Removed | | `**GetCategoryMappingsRequest**` | Type | Removed | | `**GetCategoryMappingsResponse**` | Type | Removed | ### Announcements - 1415 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1415 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-CF) . None for this release. ### Changed Functionality - 1415 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Message Added in Version 1415 To support EPS URL links now being required to use HTTPS (HyperText Transfer Protocol Secure) for Revise calls, the following error message has been added in this release. It is returned in **ReviseFixedPriceItem** and **ReviseItem** calls when attempting to add images using HTTP resources, specifically for the EBAY-US site only. **Note:** For **ReviseItem**/**ReviseFixedPriceItem** calls, error code **21920412** is no longer returned and has been replaced by **21919490**. * (Error Code: **21919490**): eBay security policy only allows HTTPS resources in listings, not HTTP. Please update or remove any HTTP resources. #### GetCategoryMappings Call Decommissioned The **GetCategoryMappings** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **getCategoryMappings** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1413](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1413-SC) #### DescriptionReviseMode field use change The **DescriptionReviseMode** field, used by the **ReviseItem** and **ReviseFixedPriceItem** calls, should no longer be used since it no longer supports the ability to append or prepend text using the **Append** or **Prepend** values, but only supports the **Replace** value. If this field is used and set to **Append** or **Prepend**, it will default to **Replace**, and whatever text is supplied in the **Item.Description** field will completely overwrite the current description for the active listing. If you wish to update the description for an active listing using a revise call, just provide the full description in the **Item.Description** field and do not use this field at all. This field will be completely removed from the WSDL within a few months. ### Documentation Changes and Errata - 1415 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-NF) and [Changed Functionality - 1415](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1415-CF) . None for this release. Version 1399 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-CC) | | [Schema Changes - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-SC) | | [Announcements - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-AN) | | [New Features - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-NF) | | [Changed Functionality - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-CF) | | [Document Changes and Errata - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1399 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [CompleteSale](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/CompleteSale.html#ChangeHistory) ### Schema Changes - 1399 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**[OrderType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/OrderType.html) **` | Type | Modified | | `**[PaymentInformationType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/PaymentInformationType.html) **` | Type | Modified | | `**[TaxDetailsType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/TaxDetailsType.html) **` | Type | Modified | | `**[TaxesType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/TaxesType.html) **` | Type | Modified | | `**GeteBayOfficialTimeRequestType**` | Type | Removed | | `**GeteBayOfficialTimeResponseType**` | Type | Removed | | `**ValidateTestUserRegistrationRequestType**` | Type | Removed | | `**ValidateTestUserRegistrationResponseType**` | Type | Removed | | `**ValidateChallengeInputResponseType**` | Type | Removed | | `**ValidateChallengeInputResponseType**` | Type | Removed | | `**GetChallengeTokenRequestType**` | Type | Removed | | `**GetChallengeTokenResponseType**` | Type | Removed | ### Announcements - 1399 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1399 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-CF) . None for this release. ### Changed Functionality - 1399 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Launch of Buyer Protection for private seller purchases on ebay.co.uk Going forward, buyers on UK marketplace will be charged a buyer protection fee. These fees will be reflected in the calls as noted in the applicable fields. For UK-based private sellers (excluding Vehicles, Classified Ads, and Property), a [Buyer Protection fee](https://www.ebay.co.uk/help/buying/paying-items/buyer-protection-fee?id=5594) will be added to their listings. This fee will be paid for by the buyer. See [Changed Calls - 1399](https://developer.ebay.com/Devzone/XML/docs/ReleaseNotes.html#1399-CC) for calls which have fields affected. #### Added error message for 1399 In order to support the new functionality of Buyer Protection, the following error message has been added in this release and is returned in **CompleteSale**: * (error) **21920438**: Invalid request: one of the items cannot be marked as paid. #### GeteBayOfficialTime Call Decommissioned The **GeteBayOfficialTime** call has been decommissioned decommissioned as of January 27, 2025, and the call reference documentation has been removed. Additionally, all types exclusively used by **GeteBayOfficialTime** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-SC) #### ValidateTestUserRegistration Call Decommissioned The **ValidateTestUserRegistration** call has been decommissioned as of January 30, 2025, and the call reference documentation has been removed. Additionally, all types exclusively used by **ValidateTestUserRegistration** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-SC) #### Challenge Calls Decommissioned The following challenge calls have been decommissioned as of January 30, 2025, and the call reference documentation has been removed: * GetChallengeToken * ValidateChallengeInput Additionally, all types exclusively used by either call have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-SC) ### Documentation Changes and Errata - 1399 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-NF) and [Changed Functionality - 1399](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1399-CF) . None for this release. Version 1395 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-CC) | | [Schema Changes - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-SC) | | [Announcements - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-AN) | | [New Features - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-NF) | | [Changed Functionality - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-CF) | | [Document Changes and Errata - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1395 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1395 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `Regulatory.**ManufacturerType**` | Type | Modified | | `Regulatory.ManufacturerType.**ContactURL**` | Field | Added | | `Regulatory.**ResponsiblePersonType**` | Type | Modified | | `Regulatory.ResponsiblePersonType.**ContactURL**` | Field | Added | ### Announcements - 1395 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1395 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-CF) . #### New ContactURL field added to ManufacturerType and ResponsiblePersonType A new field, **ContactURL**, has been added to **ManufacturerType** and **ResponsiblePersonType**. This field allows users to input a manufacturer's and/or a Responsible Person's contact URL as an electronic contact method when inputting GPSR information for a listing. The following error message has rolled out with the 1395 release. The long version of the message is used below: * (error) **21920435**: The contact URL is incorrectly formatted. Please update the formatting. ### Changed Functionality - 1395 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Two new pre-owned item conditions available for apparel categories in Australia As of January 22, the following two _Pre-owned_ item conditions are now supported for 222 apparel categories in Australia: * ConditionID 2990 for Pre-owned - Excellent * ConditionID 3010 for Pre-owned - Fair For the affected categories, the condition name for ConditionID 3000 has been changed from Pre-owned to Pre-owned - Good. The item condition names for all active listings with ConditionID 3000 will automatically be updated from Pre-owned to Pre-owned - Good. However, we strongly encourage you to revise your existing listings with Pre-owned Excellent (2990) or Pre-owned Fair (3010) if either of those conditions more accurately describe the condition of your item. See the [Q4 2024 Newsletter](https://developer.ebay.com/updates/newsletter/q4_2024) for more information on the affected categories, or you can also use [getItemConditionPolicies](https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getItemConditionPolicies) or [GetCategoryFeatures](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetCategoryFeatures.html) to see which apparel categories support the new item conditions. These same changes are expected to roll out to all eBay marketplaces in early February, and we will update release notes when that happens. #### Updated error messages for 1395 In order to support the new **ContactURL** field, the following error messages have been updated with the 1395 release. The long version of each message is used below: * (error) **21920432**: Seller must provide at least one form of contact info for Manufacturer - address, email, contact URL or phone. * (error) **21920433**: Seller must provide at least one form of contact info for Responsible Person - address, email, contact URL or phone. ### Documentation Changes and Errata - 1395 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-NF) and [Changed Functionality - 1395](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1395-CF) . None for this release. Version 1391 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-CC) | | [Schema Changes - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-SC) | | [Announcements - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-AN) | | [New Features - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-NF) | | [Changed Functionality - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-CF) | | [Document Changes and Errata - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1391 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItemTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1391 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ValueTypeCodeType**` | Type | Modified | | `ValueTypeCodeType.**CURP**` | Enum | Added | | `**ValueTypeCodeType**.RFC` | Enum | Added | | `**ValueTypeCodeType**.RUT` | Enum | Added | ### Announcements - 1391 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1391 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-CF) . None for this release. ### Changed Functionality - 1391 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New enumerated values added to ValueTypeCodeType Three new enumerated values were added to **ValueTypeCodeType** to support Mexican and Chilean Tax IDs. See [Schema Changes - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-SC) for specifics. #### Updated restrictions for P&A tuners category listings When creating a listing in the Auto Performance Tuning Devices & Software category, sellers must use an eBay catalog product. Previously, if a seller added any additional product details, like additional item specifics, the listing would be blocked and an error would occur. With this release, if a seller provides any additional product information, that information will now just be dropped, and a warning will be returned. To support this, the following error message has been added in the 1391 release. The long version of the message is used: * (warning) **21920437**: When listing in _replaceable\_value_, all product details come from eBay catalog. Any product information provided by the seller will be dropped. ### Documentation Changes and Errata - 1391 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-NF) and [Changed Functionality - 1391](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1391-CF) . None for this release. Version 1379 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-CC) | | [Schema Changes - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-SC) | | [Announcements - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-AN) | | [New Features - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-NF) | | [Changed Functionality - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-CF) | | [Document Changes and Errata - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1379 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1379 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**GetClientAlertsAuthTokenRequestType**` | Type | Removed | | `**GetClientAlertsAuthTokenResponseType**` | Type | Removed | ### Announcements - 1379 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1379 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-CF) . None for this release. ### Changed Functionality - 1379 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetClientAlertsAuthToken Call Decommissioned The **GetClientAlertsAuthToken** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetClientAlertsAuthToken** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-SC) ### Documentation Changes and Errata - 1379 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-NF) and [Changed Functionality - 1379](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1379-CF) . None for this release. Version 1375 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-CC) | | [Schema Changes - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-SC) | | [Announcements - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-AN) | | [New Features - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-NF) | | [Changed Functionality - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-CF) | | [Document Changes and Errata - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1375 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1375 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**SMSSubscriptionType**` | Type | Removed | | `**SummaryEventScheduleType**` | Type | Removed | | `**DeletedFromUnsoldList**` | Field | Removed | | `**DeletedFromSoldList**` | Field | Removed | | `**NotificationEventTypeCodeType**` | Type | Modified | ### Announcements - 1375 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1375 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-CF) . None for this release. ### Changed Functionality - 1375 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### DeletedFromUnsoldList and DeletedFromSoldList containers decommissioned The **DeletedFromUnsoldList** and **DeletedFromSoldList** containers and their associated fields in the [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetMyeBaySelling.html) call have been decommissioned and removed from the WSDL. #### SummarySchedule and SMSSubscription containers decommissioned The **UserData.SummarySchedule** and **UserData.SMSSubscription** containers and their associated fields in the [GetNotificationPreferences](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetNotificationPreferences.html) and [SetNotificationPreferences](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SetNotificationPreferences.html) calls have been decommissioned and removed from the WSDL. #### Removed non-working UserIDChanged enumerated value from NotificationEventTypeCodeType The notification platform does not support **UserIDChanged**, so it has been removed as an enumerated value from the [NotificationEventTypeCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) and the [GetNotificationPreferences](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetNotificationPreferences.html) , [GetNotificationsUsage](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetNotificationsUsage.html) , and [SetNotificationPreferences](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetNotificationPreferences.html) calls. ### Documentation Changes and Errata - 1375 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-NF) and [Changed Functionality - 1375](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1375-CF) . None for this release. Version 1371 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-CC) | | [Schema Changes - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-SC) | | [Announcements - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-AN) | | [New Features - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-NF) | | [Changed Functionality - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-CF) | | [Document Changes and Errata - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1371 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1371 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**RegulatoryType**` | Type | Modified | | `**DocumentsType**` | Type | Added | | `**DocumentType**` | Type | Added | | `**ManufacturerType**` | Type | Added | | `**ProductSafetyType**` | Type | Added | | `**ResponsiblePersonsType**` | Type | Added | | `**ResponsiblePersonType**` | Type | Added | | `**ResponsiblePersonCodeTypes**` | Type | Added | | `**ResponsiblePersonCodeType**` | Type | Added | ### Announcements - 1371 Economic Operator is being decommissioned and should no longer be used for the Add/Revise/Relist and VerifyItem family of calls. As it is currently still supported, Economic Operator-related fields will be returned if applicable for the GetItem call. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1371 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-CF) . #### New schema added to support GPSR information In preparation for new legal requirements by the European Union taking effect on December 13th 2024, schema changes have been made to support GPSR related fields. The **Documents**, **Manufacturer**, **ProductSafety**, and **ResponsiblePersons** containers provide GPSR information for products shipped or sold in the EU and Northern Ireland. The following new error messages related to using GPSR information were added in the 1371 release. The long version of each message is used below. * (error) **21920418**: Regulatory document ID(s) _replaceable\_value_ not found. Please use valid ID(s). * (error) **21920419**: Duplicate regulatory document ID(s) _replaceable\_value_ sent in the request. Duplicate ID(s) have been ignored. * (error) **21920420**: Regulatory document structure incorrect. Max allowed number of entries is _replaceable\_value_. * (error) **21920421**: Invalid document state for ID(s) _replaceable\_value_. Documents must be in the SUBMITTED or ACCEPTED state. * (error) **21920422**: Product Safety structure incorrect for _replaceable\_value_. Max allowed number of entries is _replaceable\_value_. * (error) **21920423**: Product Safety information incomplete. Your listing must include product safety pictograms & statements. * (error) **21920424**: Manufacturer address information is incomplete. When providing the address, please provide the street, city, postal code and country * (error) **21920425**: Manufacturer information is incomplete. Please provide the company name. * (error) **21920426**: Responsible Person structure incorrect for _replaceable\_value_. Max allowed number of entries is _replaceable\_value_. * (error) **21920427**: Responsible Person address information is incomplete. When providing the address, please provide the street, city, postal code and country * (error) **21920428**: Responsible Person information is incomplete. Please provide the company name. * (error) **21920429**: Either the Manufacturer or at least one of the Responsible Persons must be located in the EU. * (error) **21920430**: Please provide a minimum of _replaceable\_value_ and a maximum of _replaceable\_value_ types for a Responsible Person. * (error) **21920431**: Seller must provide at least one form of contact info for Economic Operator - either phone, email or address. * (error) **21920432**: Seller must provide at least one form of contact info for Manufacturer - either phone, email or address. * (error) **21920433**: Seller must provide at least one form of contact info for Responsible Person - either phone, email or address. These error messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Changed Functionality - 1371 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1371 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-NF) and [Changed Functionality - 1371](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1371-CF) . None for this release. Version 1367 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-CC) | | [Schema Changes - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-SC) | | [Announcements - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-AN) | | [New Features - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-NF) | | [Changed Functionality - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-CF) | | [Document Changes and Errata - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1367 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1367 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**SuggestedCategoryArrayType**` | Type | Removed | | `**SuggestedCategoryType**` | Type | Removed | ### Announcements - 1367 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1367 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-CF) . None for this release. ### Changed Functionality - 1367 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetSuggestedCategories Call Decommissioned The **GetSuggestedCategories** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetSuggestedCategories** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-SC) ### Documentation Changes and Errata - 1367 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1367-NF) and [Changed Functionality - 1367](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-CF) . None for this release. Version 1363 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-CC) | | [Schema Changes - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-SC) | | [Announcements - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-AN) | | [New Features - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-NF) | | [Changed Functionality - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-CF) | | [Document Changes and Errata - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1363 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1363 None for this release. ### Announcements - 1363 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1363 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-CF) . #### New requirement when adding EPA approved products A new requirement adding support for EPA approved tuning devices and software products was added to category Id 173651 (Auto Performance Tuning Devices & Software). See [New error messages for 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363Nwrrrmssgsfr1363) for updated errors. **Note:** When listing in **categoryID** 173651 (Tuning devices & software), use of catalog products is required. For more information, see [Tuning devices and software](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/tuning-devices-and-software.html) . ### Changed Functionality - 1363 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New error messages for 1363 Below is a list of new or changed error and warning messages that rolled out with the 1363 release and are related to specific parts and accessory categories. The long version of each message is used below: * (error) **21920416**: When listing in _replaceable\_value_, key information such as _replaceable\_value_ comes from eBay's catalog and should be left blank. * (error) **21920417**: When listing in _replaceable\_value_, sellers are required to adopt eBay's catalog data which will provide all the necessary details for the product. These error messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1363 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-NF) and [Changed Functionality - 1363](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1363-CF) . None for this release. Version 1359 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-CC) | | [Schema Changes - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-SC) | | [Announcements - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-AN) | | [New Features - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-NF) | | [Changed Functionality - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-CF) | | [Document Changes and Errata - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1359 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1359 None for this release. ### Announcements - 1359 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1359 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-CF) . None for this release. ### Changed Functionality - 1359 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New error messages for 1359 Below is a list of new or changed error and warning messages that rolled out with the 1359 release. The long version of each message is used below: * (warning) **21919456**: (changed severity and message text) Seller has opted into business policies. Please use policy IDs rather than legacy fields for Shipping, Payments or Returns or new policies may be automatically created seller's behalf. * (error) **21920409**: A minimum of _replaceable\_value_ photos is required to list in category _replaceable\_value_. * (warning) **21920410**: The selected shipping service _replaceable\_value_ is not supported with the selected shipping package type. The shipping service has been dropped from the listing. * (warning) **21920411**: The field _replaceable\_value_ is deprecated and will be decommissioned as of _replaceable\_value_ and will no longer be recognized or accepted. * (warning) **21920412**: eBay Picture Service (EPS) URL links are now required to be HTTPS links. HTTP links are converted to HTTPS links right now. Starting August 2024, HTTP EPS links will not be supported. * (error) **21920413**: The category chosen is not valid for this auto related item. Please choose another category. * (error) **21920414**: Seller is not eligible for Managed Shipping. Please opt out of Managed Shipping. * (error) **21920415**: The package dimensions required for calculated shipping are missing. Provide valid numbers for the dimensions. These error messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1359 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-NF) and [Changed Functionality - 1359](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1359-CF) . None for this release. Version 1357 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-CC) | | [Schema Changes - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-SC) | | [Announcements - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-AN) | | [New Features - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-NF) | | [Changed Functionality - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-CF) | | [Document Changes and Errata - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1357 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetAccount.html#ChangeHistory) ### Schema Changes - 1357 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**AccountDetailEntryCodeType**` | Type | Modified | | `AccountDetailEntryCodeType.**RegulatoryOperatingFee**` | Enum | Added | | `AccountDetailEntryCodeType.**RegulatoryOperatingFeeCredit**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLPaymentProcessingFee**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLPaymentProcessingFeeCredit**` | Enum | Added | ### Announcements - 1357 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1357 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-CF) . None for this release. ### Changed Functionality - 1357 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Fee and Credit enumerated values added to GetAccount Four enumerated values were added. See [Schema Changes - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-SC) for specifics. ### Documentation Changes and Errata - 1357 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-NF) and [Changed Functionality - 1357](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1357-CF) . None for this release. Version 1355 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-CC) | | [Schema Changes - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-SC) | | [Announcements - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-AN) | | [New Features - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-NF) | | [Changed Functionality - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-CF) | | [Document Changes and Errata - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1355 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1355 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**BuyerSatisfactionDashboardType**` | Type | Removed | | `**BuyerSatisfactionStatusCodeType**` | Type | Removed | | `**PerformanceDashboardType**` | Type | Removed | | `**PerformanceStatusCodeType**` | Type | Removed | | `**PolicyComplianceDashboardType**` | Type | Removed | | `**PolicyComplianceStatusCodeType**` | Type | Removed | | `**PowerSellerDashboardType**` | Type | Removed | | `**SearchStandingDashboardType**` | Type | Removed | | `**SearchStandingStatusCodeType**` | Type | Removed | | `**SellerAccountDashboardType**` | Type | Removed | | `**SellerAccountStatusCodeType**` | Type | Removed | | `**SellerDashboardAlertSeverityCodeType**` | Type | Removed | | `**SellerDashboardAlertType**` | Type | Removed | | `**SellerFeeDiscountDashboardType**` | Type | Removed | ### Announcements - 1355 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1355 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-CF) . None for this release. ### Changed Functionality - 1355 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetSellerDashboard Call Decommissioned The **GetSellerDashboard** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetSellerDashboard** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-SC) . The alternative for this API is [Seller Standards Profile](https://developer.ebay.com/api-docs/sell/analytics/resources/seller_standards_profile/methods/findSellerStandardsProfiles) methods of the [Sell Analytics API](https://developer.ebay.com/api-docs/sell/analytics/overview.html) . ### Documentation Changes and Errata - 1355 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-NF) and [Changed Functionality - 1355](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1355-CF) . None for this release. Version 1349 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-CC) | | [Schema Changes - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-SC) | | [Announcements - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-AN) | | [New Features - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-NF) | | [Changed Functionality - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-CF) | | [Document Changes and Errata - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1349 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1349 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**TicketListingDetailsType**` | Type | Removed | | `**QuantityInfoType**` | Type | Removed | | `**UpdateReturnPolicy**` | Field | Removed | | `**UpdateSellerInfo**` | Field | Removed | | `**OriginatingPostalCode**` | Field | Removed | ### Announcements - 1349 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1349 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-CF) . None for this release. ### Changed Functionality - 1349 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### TicketListingDetails and QuantityInfo containers decommissioned in Add/Revise/Relist/Verify calls The **TicketListingDetails** and **QuantityInfo** containers and their associated fields in Add/Revise/Relist/Verify and related calls have been decommissioned and removed from the WSDL. #### UpdateReturnPolicy and UpdateSellerInfo decommissioned in ReviseItem call The **UpdateReturnPolicy** and **UpdateSellerInfofields** fields in the ReviseItem call have been decommissioned and removed from the WSDL. #### OriginatingPostalCode field decommissioned The **OriginatingPostalCode** field, used by the Add/Revise/Relist/Verify and GetItem family, has been decommissioned and removed from the WSDL. ### Documentation Changes and Errata - 1349 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-NF) and [Changed Functionality - 1349](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1349-CF) . None for this release. Version 1345 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-CC) | | [Schema Changes - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-SC) | | [Announcements - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-AN) | | [New Features - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-NF) | | [Changed Functionality - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-CF) | | [Document Changes and Errata - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1345 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetMyeBaySelling](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetMyeBaySelling.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetOrders.html#ChangeHistory) \* * [GetSellerTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) \* * [GetItemTransactions](https://developer.ebay.com/Devzone/xml/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) \* * **GetOrderTransactions** (decommissioned) \* See [Schema Changes - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-SC) for numerous fields removed from response payloads. ### Schema Changes - 1345 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**EconomicOperator**` | Type | Added | | `**RegulatoryType**` | Type | Modified | | `**AddressUsageCodeType**` | Type | Removed | | `**ExternalTransactionType**` | Type | Removed | | `**GetOrderTransactionsRequestType**` | Type | Removed | | `**GetOrderTransactionsResponseType**` | Type | Removed | | `**ItemTransactionIDArrayType**` | Type | Removed | | `**ItemTransactionIDType**` | Type | Removed | | `**PaymentHoldDetailType**` | Type | Removed | | `**PaymentHoldReasonCodeType**` | Type | Removed | | `**PaymentTransactionStatusCodeType**` | Type | Removed | | `**RequiredSellerActionArrayType**` | Type | Removed | | `**RequiredSellerActionCodeType**` | Type | Removed | | `**SellingManagerProductDetailsType**` | Type | Removed | | `**UnpaidItemCaseOpenTypeCodeType**` | Type | Removed | | `**UnpaidItemCaseStatusTypeCodeType**` | Type | Removed | | `**UnpaidItemType**` | Type | Removed | Fields used exclusively by **GetOrderTransactions** were removed. Also, numerous fields in the response payloads of the **GetOrders**, **GetItemTransactions**, **GetSellerTransactions**, and **GetMyeBaySelling** calls were removed. See the [Deprecated Trading Order Management Fields](https://developer.ebay.com/devzone/deprecated_trading_ordermgmt_fields.pdf) document for a complete list of these fields and reasons. ### Announcements - 1345 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1345 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-CF) . #### New schema added to support Economic Operator information To support new legal requirements by the European Union and the UK to provide Economic Operator information, schema changes have been made. The **EconomicOperator** container (**EconomicOperatorType**) provides required Economic Operator information about the manufacturer and/or supplier of the item. The **EconomicOperator** field has also been added to **Regulatorytype**. The following new error messages related to using Economic Operator information were added in the 1345 release. The long version of each message is used below. * (Error) **21920388**: Economic Operator address information is incomplete. When providing the address, please provide the company name, street, city, postal code and country. * (Error) **21920399**: Economic Operator information is incomplete. Please provide the company name. * (Error) **21920403**: The email address provided is formatted incorrectly. These error messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Changed Functionality - 1345 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetOrderTransactions Call Decommissioned The **GetOrderTransactions** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetOrderTransactions** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-SC) #### Numerous Order-related Fields Decommissioned Removed numerous order-related fields in the **GetOrders**, **GetSellerTransactions**, **GetItemTransactions**, and **GetMyeBaySelling** calls. See the [Deprecated Trading Order Management Fields](https://developer.ebay.com/devzone/deprecated_trading_ordermgmt_fields.pdf) document for a complete list of these fields and reasons. ### Documentation Changes and Errata - 1345 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-NF) and [Changed Functionality - 1345](https://developer.ebay.com/Devzone/xml/docs/ReleaseNotes.html#1345-CF) . None for this release. --- # Making a Trading API call guide | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/make-a-call-landing.html#mainContent) The [Trading API](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html) allows sellers to create and manage listings, manage inventory, fulfill orders, and communicate with customers. However, to perform each of these tasks call requests must be issued using request-response style operations. This guide provides an overview of the programmatic and technical information necessary to developing applications which will issue these calls. * Call names are fairly self-explanatory and straightforward (e.g., [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) which lists an item). Refer to the [Call Index](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/alphaindex.html) for an alphabetized list of available Trading API calls. * The [schema](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/using-tapi.html#schema) defines the messages that are used to access the eBay database. API License Agreement and Usage ------------------------------- Your use of the eBay APIs is subject to all the rules described in your API Public License Agreement. A copy of the Licensing Agreement is available [here](https://developer.ebay.com/join/api-license-agreement) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Welcome to the Trading API User Guide | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide-landing.html#mainContent) The Trading API User Guide is your first resource for understanding how to work with eBay's [Trading API](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html) and the eBay Developers Program. The information provided here is intended to help you plan your application by introducing the application development process and describing the features and functionality that are available through eBay's [Trading API](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html) . **Note:** This user guide provides information about the [Trading API](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html) . If you are primarily interested in using REST-based selling APIs, refer to the [Selling Integration Guide](https://developer.ebay.com/api-docs/sell/static/selling-ig-landing.html) instead. The [Trading API](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html) allows sellers to create and manage listings, manage inventory, fulfill orders, and communicate with customers. Typographic conventions ----------------------- Throughout this guide the following typographic conventions are used: | Format | Meaning | | --- | --- | | **bold** | Language- and protocol-independent references to call names, data types and fields.

For example: "Use **AddItem** to list an item on an eBay marketplace." | | Dot.Separator | Association or containment relationship.

For example, **Item.ShippingDetails** means we are referring to the **ShippingDetails** field of the **Item** object. | | `monospace` | Literal values and messages, as well as snippets of sample code.

For example: "Specify a listing type of `FixedPriceItem` when you list an item on the eBay marketplace." | | _emphasis (italic)_ | Introduction of new terms.

For example: "The _Motors Local Market_ format lets subscribed motor dealers list motor vehicles for sale within a local area. | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Unknown eBay Connect 2021 Notifications Shekhar Banerjee Principal Architect, Developer Ecosystem eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Notification Highlights Key Concepts Notification API Deep Dive SDK Support Notification Highlights © 2021 eBay. All rights reserved.3 ●API-Firstapproach ●Full API support ●AsyncAPISpecification 2.0based contracts ●Enhanced security for messages ●Advanced monitoring, alertingand retrycapabilities ●SDKsupport Key Concepts Message Schema Message Integrity Endpoint Verification © 2021 eBay. All rights reserved.5 Notification Schema Consistent schema across all use cases AsyncAPISpecification 2.0 based contracts Header: X-EBAY-SIGNATURE { "metadata": { "topic": "string", "schemaVersion": "string", "deprecated": "false" }, "notification": { "notificationId": "string", "eventDate": "string", "publishDate": "string", "publishAttemptCount": "integer", "data": { ... } } } © 2021 eBay. All rights reserved.6 Message Integrity Elliptic Curve Cryptography for message integrity checks Backward compatibility in case of key rotation SDK Support! X-EBAY\_SIGNATURE-HEADER decoded { "alg":"ecdsa", "kid":"key\_id", "signature":"MEYCIQCfxfIWuxmWcIBQJ9c5/X7iGDJqs2RC...", "digest":"SHA256" } Payload integrity validation algorithm Step 1 Fetch the public key using the key\_idfrom the header. GET commerce/notification/v1/public\_key/{key\_id} Step 2 Initialize your crypto library and verify payload. fn( algo, digest,PublicKey,signature,payload) © 2021 eBay. All rights reserved.7 Endpoint Verification Notification Platform Webhook Endpoint Guarantees authenticity of the endpoint for receiving notifications Checks can happen on a periodic basis SDK Support! { endpoint, verificationToken} Where challengeResponse= SHA256(challengeCode,verificationToken,endpoint)->toHex() GET https://?challenge\_code= {challenge\_code} 200 OK { "challengeResponse": "string" } Notification API Deep Dive Browse Topics Configure Your App Create and Manage Destinations Create and Manage Subscriptions © 2021 eBay. All rights reserved.9 Topic Browse available topics, learn about authorizations required to subscribe, supported formats, and schema versions Supported methods GET/commerce/notification/v1/topic/ GET/commerce/notification/v1/topic/{topic\_id} Supported topics MARKETPLACE\_ACCOUNT\_DELETION AUTHORIZATION\_REVOCATION © 2021 eBay. All rights reserved.10 Topic: Resource { "topicId": "SAMPLE\_TOPIC", "description": "Sample topic", "status": "ENABLED", "context": "DEVELOPER", "scope": ”APPLICATION", "authorizationScopes": \[ "https://api.ebay.com/oauth/api\_scope" \], "supportedPayloads": \[ { "format": \["JSON"\], "schemaVersion": "1.0", "deliveryProtocol": "HTTPS", "deprecated": false } \] } © 2021 eBay. All rights reserved.11 Config Update your application configurations Supported methods PUT /commerce/notification/v1/config GET/commerce/notification/v1/config Config resource { "alertEmail": "alert@email.com" } © 2021 eBay. All rights reserved.12 Destination Create and manage your destinations Note: Your endpoint should be up and ready to respond to the verification challenge Supported methods POST /commerce/notification/v1/destination PUT /commerce/notification/v1/destination/{destination\_id} DELETE /commerce/notification/v1/destination/{destination\_id} GET/commerce/notification/v1/destination/{destination\_id} GET/commerce/notification/v1/destination/ © 2021 eBay. All rights reserved.13 Destination: Resource { "destinationId": "TEST\_DESTINATION\_ID", "name":"testdestination", "status":"ENABLED", "deliveryConfig": { "endpoint":"https:///", "verificationToken": "71745723-d031-455c-bfa5-f90" } } © 2021 eBay. All rights reserved.14 Subscription Create and manage your subscriptions Supported methods POST /commerce/notification/v1/subscription PUT /commerce/notification/v1/subscription/{subscription\_id} DELETE /commerce/notification/v1/subscription/{subscription\_id} GET /commerce/notification/v1/subscription/{subscription\_id} GET /commerce/notification/v1/subscription POST /commerce/notification/v1/subscription/{subscription\_id}/enable POST /commerce/notification/v1/subscription/{subscription\_id}/disable POST /commerce/notification/v1/subscription/{subscription\_id}/test © 2021 eBay. All rights reserved.15 Subscription: Resource { "subscriptionId": "36c3b9be-31da-499f-912c-38dcf4e790ad", "topicId": "SAMPLE\_TOPIC", "status": "ENABLED", "creationDate": "2021-06-04T15:10:12.807182", "payload": { "format": "JSON", "schemaVersion": "1.0", "deliveryProtocol": "HTTPS" }, "destinationId": "52e4c4e7-d89f-4594-a5b3-8e4516b7275b" } © 2021 eBay. All rights reserved.16 SDKs Deployable SDKs that incorporate •Endpoint verification algorithm •Message integrity check validation •Integration with Notification API •Credentials externalized •LRU cache enabled •Generic for any topic •OpenAPI-powered code generation •Topic specific message processors Git: https://github.com/eBay/event-notification-java-sdk https://github.com/eBay/event-notification-nodejs-sdk Our SDKs are currently in Node.js and Java Demo --- # Unknown eBay Connect 2020 Charity API Sekhar Banerjee Sr. MTS Architect, Developer Ecosystem eBay Connect 2020 Charity API -Agenda eBay for Charity Program Charity for Buying & Selling Experiences Charity API Demo © 2020 eBay. All rights reserved.2 eBay for Charity Program 360K+ Community Sellers 8K+ Direct Charity Sellers ~ $112M Raised by the eBay community through eBay for Charity in 2019 $1B+ Total funds raised 83,500 Number of charities enrolled © 2020 eBay. All rights reserved. Focus on Charity Charity Shop Explore your generous side. Buy to support charity. Charity Organizations Jumpstart your fundraising today! Sell for Charity Everyone benefits when you sell for charity on eBay. Charity for Community Sellers © 2020 eBay. All rights reserved.5 Select from over 83K+ trusted charities Easy integration through web or API Select custom donation percentage Featured with a Charity Ribbon eBay fee credits Uplift in conversion rates Charity for Direct Sellers © 2020 eBay. All rights reserved.6 Tap into eBay’s massive active buyers base Listings featured with Charity Ribbon & Giving Bar 100% eBay fee credits Gifts that give back Charity for Buyers © 2020 eBay. All rights reserved.7 Search integration for easy discovery Integrated with checkout flow Dashboard for easy management Charity API © 2020 eBay. All rights reserved.8 getCharities GET https://api.ebay.comcommerce/charity/ v1/charity\_org/?q= or GET https://api.ebay.comcommerce/charity/ v1/charity\_org/?registration\_ids= getCharity GET https://api.ebay.comcommerce/charity/ v1/charity\_org/{charity\_org\_id} Authorization scope https://api.ebay.com/oauth/api\_scope The Charity Resource © 2020 eBay. All rights reserved.9 GET https://api.ebay.com/commerce/charity/ v1/charity\_org/{charity\_org\_id} { "charityOrgId": "string", "name": "string", "description": "string", "missionStatement": "string", "location": { "address": { ... }, "geoCoordinates": { "latitude": "number", "longitude": "number" } }, "logoImage": { ... }, "registrationId": "string", "website": "string” } Seller Integration: 3 Simple Steps Enable sellers to select charities Enable charity search Sellers should be able to select their favorite charity for use in the next step Enable charity In createor updateoffer in Inventory API sell/inventory/v1/offer "charity" :{ "charityId":"", "donationPercentage":"" } Enable charity donation in Inventory API charity/v1/charity\_org?q= or charity/v1/charity\_org? registration\_ids= Buyer Integration: 3 Simple Steps Enable buyers to select charities Enable charity search Buyer should be able to select their favorite charities for use in the next step Use the buyer selected charity registration IDs in: buy/browse/v1/item\_summary /search?q=string& charity\_ids= Enable charity filter in item search charity/v1/charity\_org?q= or charity/v1/charity\_org? registration\_ids= Demo Integration powered by OpenAPI © 2020 eBay. All rights reserved.13 --- # Unknown eBay Connect 2020 API Security Updates Tanya Vlahovic Head of Developer Ecosystem KYD: Know Your Developer eBay Connect 2020 Agenda Recent Updates Upcoming Changes © 2020 eBay. All rights reserved.3 Access to data and capabilities, at scale Extensible, adaptable, and secure API Portfolio Front door to eBay marketplace platform \* Details are on Developer Portal API License Agreement Updated\* Link to 3 rd -party privacy policy is required: For authorization and user consent When eBay content or eBay member personal information is displayed Changes to User Agreement for Sandbox Sandbox is only for testing integration with eBay APIs Developers are prohibited from publishing confidential, personal, or restrictive data into the Sandbox. API Usage Analysis “Look beyond the numbers. Around them. Through them.” –Al Harrison Measure the Success of the API Program Operational metrics show how healthy the platform is Business metrics are the reasons the platform is built Rate Limiting Safeguard the system from Malicious attackers Spikes in consumption Inefficient applications Default rate limit will be decreased Applicable to certain APIs HTTPS for Shopping API Auth’n’Authprotocol Increased length of Session ID © 2020 eBay. All rights reserved.11 Authorization in Finding and Shopping APIs OAuth 2.0 authorization in Finding and Shopping APIs Application Secret Rotation API Deprecations Sold Report Revise Checkout Status Feedback API and DSR reports Get Category Specifics Revise Selling Manager Sale Record Markdown APIs eBay solutions directory © 2020 eBay. All rights reserved.14 Developers’ Success Is Our Success You extend our value proposition, bring your customers to us, and help shaping our products --- # Unknown eBay Connect 2021 Shipping and Member Communications Erik Selberg VP, Shipping and Member Communications eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Shipping progress Email intermediation Shipping eBay Standard Envelope (eSE) Customer Opportunity Tracking is too expensive for things that fit in a Plain White Envelope (trading cards, stamps, etc.). So customers skip it, resulting in untracked items and higher fraud (buyer claims to have not received it). Solution: eBay Standard Envelope (eSE) eSEis a solution to provide tracking information for low-weight, low-priced items. In details: •Max weight allowed 3oz •Plain White Envelope àStd 6 ¼x 11 ½Mailer •$0.51 -> $0.91 depending on weight •Insured up to $20 for single-item shipments, and up to $50 for multi- item shipments •Just acceptance / delivery scans, no intermediate updates Why is this important? •Buyers: Increase trust and confidence thanks to basic tracking. •Sellers: Access to a competitive shipping solution to ensure items are delivered. Status US launch: Jan 2021 (available in certain categories like trading cards, coins, stamps, etc.) eBay Fulfillment by Orange Connex Customer Opportunity Sellers, especially importers, want to outsource the storage and fulfillment operations to achieve cost savings or increase the standards of their deliveries What is eBay Fulfillment? eBay Fulfillment is a solution specifically designed by Orange Connex -an eBay Joint Venture, providing: •Seller protection for delivery-related issues •2-day delivery (in DE & UK) with late order cutoff time •Competitive pricing (cheaper than FBA multi-channel) Why is this important? •Importers (espimporters from Greater China / SEA) •Professional sellers looking to outsource their logistics Status DE launch: Sep 2020 Global expansion 2021: UK (Q2), AU (Q3), IT (Q3). US in 2022 Simplified Shipping Customer Opportunity Inexperienced sellers overwhelmed by shipping options and just give up Solution Provide better guidance to make it easier for the seller to complete the listing, and maximize the chance their item will sell with competitive shipping option Audience Casual sellers requiring more guidance and simplicity Approach Using our data, we’ll predict the weight of an item, and recommend the options more suitable by leveraging the carrier discounts offered through our label platform Why is this important? •Buyers: access to better and more competitive shipping options •Sellers: easier / quicker to list items on eBay Status AU: currently under testing Global expansion 2021: US (Q3), UK (Q4), DE (Q4) Improved recommendations Simplified size / weight picker New tracking events for authentication services Customer Opportunity Authenticity Guarantee (AG) on eBay is handled by having a 3 rd -party authenticator verity the item. This means items are shipped from Seller àAuthenticator àBuyer, or Buyer àAuthenticator àSeller for returns. New updates Tracking events now include authentication events •Shipping to Authenticator •In Authentication •Shipping from Authenticator Status Launched with Authentication program in US (July 2020) Inventory API —supporting multi-warehouse sellers Customer Opportunity Faster shipping times drives increased conversion. Large sellers use multiple warehouses to lower shipping times. However, eBay didn’t allow for sellers to identify multiple warehouses. Thus the shipping time from eBay was overly slow, inhibiting conversion. Solution Updated Inventory API (SIS) allows sellers to provide all their locations. eBay will pick the fastest shipping time, translating into higher velocity for sellers. Why is this important? •Buyers: See the best, realistic shipping time •Sellers: Increase velocity Status Launched as beta in Q4 20. Looking for early adopters. Next will support similar functionality for sellers on trading API Managed location(s) 1 Existing capability Managed inventory 2 Existing capability Publish inventory 3 Existing capability. NOW –sellers to provide multiple location as part of listing process. Seller fulfills item once a buyer buys the item 4 EDD takes location and makes the fastest EDD. Seller meets the EDD. No policy change or seller evaluation change for MVP Email intermediation Building trust between sellers and buyers Promote trustworthy communication Email intermediation Customer Opportunity Member-to-Member communication displayed buyer’s & seller’s email -which led to abuse, fraud and other issues Approach 1.Intermediate emails using per-pair anonymous email addresses 2.Inspect emails to ensure no policy violations (e.g. abuse, fraud, etc.) Why is this important? •Buyers: Reduce bad buyer experiences that are due to policy violating messages received. •Sellers: Change seller behavior to reduce policy violating messages. Status •Email Intermediation launched in August 2020. •Blocking policy violating emails launched April 2021, ramping to 100% globally by June 30, 2021. --- # Unknown eBay Connect 2021 API Security Updates Tanya Vlahovic Head of Developer Ecosystem Global, Large & Powerful Developers Program eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.3 Recent updates Upcoming changes eBay Marketplace Account Deletion © 2021 eBay. All rights reserved.4 eBay users have the right to request their personal data be deleted from eBay's systems, as well as deleted from the systems of all eBay partners who store/display their personal data eBay Marketplace Account Deletion: Flow Step 1 A user requests data deletion An eBay marketplace users requests their data to be deleted Step 2 eBay notifies developers eBay sends a marketplace account deletion request to 3 rd -party apps Step 3 Developers acknowledge A developer responds with acknowledgment of receipt eBay Marketplace Account Deletion: Our Solution © 2021 eBay. All rights reserved.6 3 rd -party applications provide data deletion callback POST request payloads contain user identifiers 3rd-party callbacks respond with the receipt confirmation eBay Marketplace Account Deletion: Setup © 2020 eBay. All rights reserved.7 •Email for alerts •Notification endpoint •Verification token eBay Marketplace Account Deletion: Terms and Agreements © 2021 eBay. All rights reserved.8 eBay’s responsibility ends once 3rd-party applications confirm the receipt of the data deletion request Failure to comply with the requirements may result in 3rd-party application being deactivated and developer account suspended Shopping API: Authorization © 2021 eBay. All rights reserved.9 OAuth 2.0 authorization Enforcement is coming Certificate Authority Change © 2021 eBay. All rights reserved.10 eBay is switching the certificate authority (CA) used for public certs from DigiCert to Sectigo(previously Comodo) Timelines: January 2022 SectigoCA is already supported in sandbox •svcs.sandbox.ebay.com •open.api.sandbox.ebay.com •api.sandbox.ebay.com API Deprecations © 2021 eBay. All rights reserved.11 Recommendations in Add/Revise/Verify Item API responses Selling Manager APIs Revise Checkout Status Business Policies APIs Get Category Specifics Custom Stores related capabilities in Trading API Quantity and start price in Revise Inventory Status API response Your Success Is Our Success --- # Unknown eBay Connect 2020 Listing API Jancy Vincent Sr Engineering Manager, Developer Ecosystem eBay Connect 2020 Agenda Key Capabilities Integration Demo Listing API © 2020 eBay. All rights reserved.2 Listing API –Key Capabilities © 2020 eBay. All rights reserved.3 •Allows users from partner platform to create Item Draft on eBay •Leverages eBay recommendations •Flexibility to review and update the draft on eBay User experience •Enables global reach of 182M buyers User Onboarding © 2020 eBay. All rights reserved.4 Register, if not an eBay seller Obtain authorization Account Linking & Create Item Draft Flow © 2020 eBay. All rights reserved.5 Start Accounts linked? Redirect to eBay Sign-in/Sign-up Listing API (create item draft) Redirect to partner UX Redirect to eBay UX No Yes Seamless Native Deep Linking © 2020 eBay. All rights reserved.6 Listing API Integration in FR © 2020 eBay. All rights reserved.7 Demo Integration With Listing API © 2020 eBay. All rights reserved.9 eBay Marketplace 1 Onboard user to eBay Marketplace / Get Authorization Onboards new user to eBay marketplace or gets an OAuth token for an existing user 2 4 Partner platform End user Listing API Deep link with draft ID to eBay UX 3 Synchronization Item on eBay Marketplace Ad / item on Partner Platform Listing API 6 Creates an ad/item and opts for an eBay listing Creates an item draft 5 Publishes an item draft POST https://api.ebay.com/sell/listing/v1\_beta/ item\_draft Create Item Draft Authorization Scope https://api.ebay.com/oauth/api\_scope/sell. item.draft { "categoryId": "string", "condition": "string", "format": "\[AUCTION,FIXED\_PRICE\]", "pricingSummary": { "auctionReservePrice": { "currency": "string", "value": "string" }, "auctionStartPrice": { "currency": "string", "value": "string" }, "price": { "currency": "string", "value": "string" } }, "product": { "aspects": \[ { "name": "string", "values": \[ "string" \] } \], "brand": "string", "description": "string", "epid": "string", "imageUrls": \[ "string" \], "title": "string" }, "charity": { "donationPercentage": "string", "charityId": "string" } } --- # Unknown eBay Connect 2020 Powered by You Tanya Vlahovic Agenda Date / TimeContent August 17 @ 10 AM PTAll About APIs Consumer Selling API eBay for Charity Translation API API Security Updates Fireside Chat August 18 –19eBay Connect Virtual Lounge © 2020 eBay. All rights reserved.2 Video Our new API has tremendous potential to revolutionize the way people do business on eBay and increase the amount of business transacted on the site. By openly providing the tools that developers need to create applications based on eBay technology, we believe eBay will eventually be tightly woven into many existing sites as well as future e-commerce ventures. eBay November 20, 2000 “ Agenda Today TITLESPEAKER Message from our CEOJamie Iannone All About APIsTanya Vlahovic Consumer Selling APIJancyVincent eBay for CharityShekar Banerjee Translation APIShruti Hulmani API Security UpdatesTanya Vlahovic Fireside ChatRandy Shoupand Tanya Vlahovic © 2020 eBay. All rights reserved.5 --- # Unknown eBay Connect 2021 Buy APIs Shruti Hulmani Sr. Product Manager, Developer Ecosystem Jancy Vincent Sr. Engineering Manager, Developer Ecosystem eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Buy API Enhancements eBay Items Widget Managed Payments in Buy APIs Buy APIs © 2021 eBay. All rights reserved.3 Curate Ingest Surface Purchase What’s New in Buy APIs? 4© 2021 eBay. All rights reserved. Browse APIFeed APIOrder API •General availability •Authenticity Verification program •Search in description •Marketplace expansion: IE, NL, PL •Certified Refurbished program •Marketplace expansion: SG, IE, NL, PL •Support for SELLER REFURBISHED and CERTIFIED REFURBISHED item conditions •Support for "in store pickup" and "pickup/drop off" delivery options •New listings in hourly feeds •Support for managed payments Compliance © 2021 eBay. All rights reserved.5 Tyre Label EEK (home appliances) EU VAT { "itemId": "v1|124565243316|0", "title": "BERLIN 195/55 R16 91 H XL...", ... "tyreLabelImageUrl": "https://.CLkAAOSwUJBgwL6G/s-l400.webp" } Tyre Label: Browse API © 2021 eBay. All rights reserved.6 Browse: Get Item and Order APIs VAT details included in the tax container "taxes": \[ { "taxJurisdiction": { "taxJurisdictionId": "DE" }, "taxType": "VAT", "taxPercentage": "19", "includedInPrice": true, "ebayCollectAndRemitTax": false } \] EU VAT © 2021 eBay. All rights reserved.7 Browse: Search, Feed and Deal APIs Item price and shipping costs when applicable show VAT inclusive pricing eBay Items Widget © 2021 eBay. All rights reserved.8 Gallery List Multiple items carousel Single item eBay Items Widget: Search © 2021 eBay. All rights reserved.9 Search options •Keyword •By image •By charity ID(s) Developer Tip: Fully customizable widget •Supports eBay marketplaces •Supports pagination eBay Items Widget: Sorting © 2021 eBay. All rights reserved.10 Sort options •Best match •By price: ascending and descending •By time: newly listed eBay Items Widget: Other Features © 2021 eBay. All rights reserved.11 Errors and warnings If there are any errors or warnings returned by the underlying Browse API those are shown on the top as alert dialogs. Alert dialog visibility The widget supports props to hide the errors and warnings or replace them with some static text. options.CLIENT\_ID = ''; options.CLIENT\_SECRET = ''; options.ENVIRONMENT = 'PRODUCTION'; options.AFFILIATE\_CAMPAIGN\_ID = ''; options.AFFILIATE\_REFERENCE\_ID = ''; options.CATEGORY\_IDS = ''; Example © 2021 eBay. All rights reserved.12 import EbayItemsWidget from 'ebay-items- react-widget';
new window.ebaypay.Button({ token: , sessionId: , paymentActions: { onSuccess: (data) => { // your code goes here }, onError: (error) => { // your code goes here } onCancel: (data) => { // your code goes here } } }).render('#checkout-with-ebay-container'); const script = document.createElement(\`script\`); script.src = \`https://checkout.ebay.com/sdk/js?locale= &token=&sessionid= \`; document.body.appendChild(script); ExistingNew Existing New: credit card payment New: PayPal payment Demo: Checkout with eBay --- # Unknown eBay Connect 2021 Videos on listings Shekhar Banerjee Principal Architect, Developer Ecosystem eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Why videos? Media API deep dive Attaching videos to listings Demo Why videos? © 2021 eBay. All rights reserved.3 •Showcaseyour listing better •Upload DIYvideos & installation guides •Demonstrate product compatibility •Enhance appeal& trust •Drive buyer engagement Enabling Seller uploaded videos © 2021 eBay. All rights reserved.4 •API-Firstapproach •Upload videos up to 150 MB •Incorporates resumable upload feature •Full support for videos on eBay native apps Supported uploads © 2021 eBay. All rights reserved.5 •The video’s input source must be an .mp4 file of the type •MPEG-4 Part 10 or •Advanced Video Coding (MPEG-4 AVC) •The maximum upload resolution is 1080p •Supported output resolutions are •240p, 360p, 480p, 720p Request POST https://apim.ebay.com/commerce/media/v1\_beta/video { "size": "integer", "title": "string", "description": "string", "classification": \[ITEM\] } Response HTTP Status: 201 (Created) Location Header: Points to the created resource Upload videos: © 2021 eBay. All rights reserved.6 Step 1 Submit the video metadata Request POST https://apim.ebay.com/commerce/media/v1\_beta/video/ {video\_id}/upload Content-Type: application/octet-stream Additional headers specific to resumable upload Content-Range Content-Length Upload videos: © 2021 eBay. All rights reserved.7 Step 2 Upload the video content Lifecycle of a video upload Failed ProcessingLive Pending Upload Blocked Get video 9© 2021 eBay. All rights reserved. Pre-uploadPost-uploadSuccess! { "videoId": "string”, "size": "integer" , "title": "string", "description": "string", "status": "PENDING\_UPLOAD", "expirationDate": "UTCDate", "classification": \["ITEM"\] } { "videoId": "string”, "size": "integer" , "title": "string", "description": "string", "status": ”PROCESSING", "expirationDate": "UTCDate", "classification": \["ITEM"\] } { "videoId": "string”, "size": "integer" , "title": "string", "description": "string", "status": "LIVE", "thumbnail": { "imageUrl": "image" }, "playLists": \[{ "protocol": "DASH or HLS", "playUrl": "play url" }\], "expirationDate": "UTCDate", "classification": \["ITEM"\] } GET https://apim.ebay.com/commerce/media/v1\_beta/video/{video\_id} ... ... ... Associate videos with listings © 2021 eBay. All rights reserved.10 Full Trading API support •AddItem •ReviseItem •RelistItem Limited to 1 seller uploaded video per listing Limited to US and UK marketplaces. Video End-to-End demo Upload a video Assign the video to a listing Play the listing video in eBay’s iOS app --- # Unknown eBay Connect 2023 Regulatory Support Liv Ellingsen Lead Product Manager - Technical eBay Connect 2023 Agenda © 2023 eBay. All rights reserved.2 Regulatory Overview Listing Level Account Level Regulatory Overview 133M Active buyers worldwide 1.8B Approximate number of live listings 190 Markets around the world 50% Of eBay revenue comes from non-US operations \* As at Q1, 2023. https://www.ebayinc.com/company/4© 2023 eBay. All rights reserved. eBay Global Scale & Reach Key Regulatory Changes in 2023 5 The Digital Services Act expands: Creating a safer digital space, protecting user rights and establishing a level playing field for businesses Provide key information about the products you sell Provide key information about the manufacturer, supplier or importer of products Provide key information about you, the Seller, and your business © 2023 eBay. All rights reserved. Product Releases Q4 2023 Listing level: Regional expansion ➔Energy Efficiency ➔Hamat ➔EPR FR Fee ➔EPR FR Repair Score ➔Take-back policy ➔Item (Seller) disclosures Under discussion ➔Global return policy description 2024 Account level: Introduction (TBC) ➔FR EPR Numbers ➔DE EPR Numbers ➔Additional custom policies Q3 2023 Listing level: Regional expansion (Europe) ➔Energy Efficiency ➔Hazmat ➔EPR FR Fee ➔EPR FR Repair Score ➔Take-back policy ➔Item (Seller) disclosures Deprecate from listing level ➔FR EPR Numbers Enabling Sellers to Inform Buyers 7 Information that varies by listing helps buyers compare items and find the product that is right for them Information specific to sellers gives buyers confidence that they’re purchasing from a seller that meets their needs and expectations © 2023 eBay. All rights reserved. Digital Services Act Listing level 9 Energy Efficiency (EEK) Supply details about the Energy Efficiency of certain durable goods like appliances and batteries. Range and rating generate the icon, brand and MPN are used if no documents are uploaded: Energieeffizienzklasse A EEK Spektrum A - G Brand string MPN string Documents can be uploaded directly as images: RegulatoryType EnergyEfficiencyType string anyURI anyURI Range and rating generate the icon, brand and MPN are used if no documents are uploaded: "product" : { "aspects" : "EEK Spektrum" : \["A - G"\], "Energieeffizienzklasse" : \["G"\], "Marke" : \["LG"\], "Herstellernummer" : \["OLED65B23LA"\] }, Documents can be uploaded directly as images: "regulatory" : { "energyEfficiencyLabel" : { "imageDescription" : "string", "imageURL" : "string", "productInformationSheet" : "string" } }, Trading API: Inventory API: Buyer Experience 10 Hazmat Help buyers understand if this product contains harmful chemicals or materials Trading API: Inventory API: Buyer Experience Only the regulatory container is used to upload the Hazardous Materials details : RegulatoryType HazmatType string PictogramsType string string StatementsType string Only the regulatory container is used to upload the Hazardous Materials details : "regulatory" : { "hazmat" : { "component" : "string", "pictograms" : \[ "string" \], "signalWord" : "string", "statements" : \[ "string" \] } }, Note: Use the getHazardousMaterialsLabels method in the Metadata API to find supported values for a specific marketplace/site. Refer to Pictogram sample values for additional information. 11 Repair Score A score from 1-10 indicating how easy it is to repair the product Trading API: Inventory API: Buyer Experience Only the regulatory container is used to provide Repair Score: RegulatoryType double Only the regulatory container is used to provide Repair Score: "regulatory" : { "repairScore" : "number" }, 12 Extended Producer Responsibility (EPR) FR Fee The fee paid by the manufacturer, importer, or distributor of a product to cover recycling /end-of-life cycle management Trading API: Inventory API: Buyer Experience Only the extendedProducerResponsibility container is used to upload the eco Participation Fee : ExtendedProducerResponsibilityType AmountType (double) Only the extendedProducerResponsibility container is used to upload the eco Participation Fee : "extendedProducerResponsibility" : {"ecoParticipationFee" : { /\* Amount \*/ "currency" : "string", "value" : "string" } }, Economic Operator (EO) The contact details for the European manufacturer, importer, or distributor of a product Trading API: Inventory API: Buyer Experience Only the extendedProducerResponsibility container is used to upload the eco Participation Fee : RegulatoryType string string string string countryCodeEnum string string string string Only the extendedProducerResponsibility container is used to upload the eco Participation Fee : "regulatory" : { "economicOperator" : { "companyName" : "string", "addressLine1" : "string", "addressLine2" : "string", "city" : "string", "country" : "countryCodeEnum", "postalCode" : "string", "stateOrProvince" : "string", "phone" : "string", "email" : "string" } }, Digital Services Act Account Level 15 Custom Policies: Take-Back Policy Custom policies are created at the account level and then applied to individual listings. Take-back covers the conditions under which the seller will take back the item that their new purchase is replacing. Trading API: Inventory API: Buyer Experience Policies are created using the account API: {"policyType": "TAKEBACK" "name": "string", "description": "string", "label": "string" }, Policies can be applied globally or regionally: Trading API CustomPoliciesType CountryPoliciesArrayType CountryPoliciesType CountryCodeType long long Inventory API "listingPolicies" : { "regionalTakeBackPolicies" : { "countryPolicies" : \[ { "country" : "CountryCodeEnum : \[AD,AE,AF...\]", "policyIds" : \[ "string" \] } \] }, "takeBackPolicyId" : "string" }, 16 Custom Policies: Item (Seller) Disclosures Custom policies are created at the account level and then applied to individual listings. Product Compliance Policies let sellers create custom policies relating to warranties or other policies they may want to inform buyers of. Trading API: Inventory API: Buyer Experience Policies are created using the account API: {"policyType": "PRODUCT\_COMPLIANCE" "name": "string", "description": "string", "label": "string" }, Policies can be applied globally or regionally: Trading API CustomPoliciesType long CountryPoliciesArrayType CountryPoliciesType CountryCodeType long Inventory API "listingPolicies" : { "productCompliancePolicyIds" : \[ "string" \], "regionalProductCompliancePolicies" : { /\* RegionalProductCompliancePolicies \*/ "countryPolicies" : \[ { /\* CountryPolicy \*/ "country" : "CountryCodeEnum : \[AD,AE,AF...\]", "policyIds" : \[ "string" \] } \] } }, --- # Unknown © 2022 eBay. All rights reserved.2 © 2022 eBay. All rights reserved.3 •Curation •Ingestion •Surface •Purchase 4 © 2022 eBay. All rights res erved. 4 •Marketplace expansion: AT, CH •Priority Listing indicators •Classified listings •ItemCreateTime, listingMarketPlaceID categoryPathIDin search and getItem family •Support for Add on services: Expert verification •Extended Producer Responsibility •US Exports •Marketplace expansion: AT, CH •Priority Listing indicators in daily and bootstrap feeds •Coupons in snapshot feeds •Extended Producer Responsibility •Support for Add on services: Expert verification •New attributes related to aspects added to item and snapshot feeds •New Feed V1 •Priority Feed •Support for Add on services: Expert verification •Canada Collect & Remit •FR VAT © 2022 eBay. All rights reserved.5 • • • • "taxes": \[ { "taxJurisdiction": { "taxJurisdictionId": ”FR" }, "taxType": "VAT", "taxPercentage": "19", "includedInPrice": true, "ebayCollectAndRemitTax": false, ”shippingAndHandlingTaxed": false } \] © 2022 eBay. All rights reserved.6 "sellerCustomPolicies":\[{ "description":"string", "label":"string", "type":"SellerCustomPolicyTypeEnum:\[PRODUCT\_COMPLI ANCE,TAKE\_BACK\]" }\] "ecoParticipationFee":{ convertedFromCurrency":"CurrencyCodeEnum:\[AED,AFN, ALL...\]", "convertedFromValue":"string", "currency":"CurrencyCodeEnum:\[AED,AFN,ALL...\]", "value":"string" } © 2022 eBay. All rights reserved.7 • • • • "taxes": \[ { "taxJurisdiction": { "taxJurisdictionId": ”DE" }, "taxType": "VAT", "taxPercentage": "19", "includedInPrice": true, "ebayCollectAndRemitTax": false, ”shippingAndHandlingTaxed": false } \] © 2022 eBay. All rights reserved.8 "taxDetails":\[ "amount":{"currency":"CurrencyCodeEnum:\[AED,AFN, ALL...\]", "value":"string" }, "taxClassification":"TaxClassificationEnum:\[DOMEST IC\_LEG\_TAX,HANDLING\_TAX,IMPORT\_TAX...\]", "taxClassificationDetails":\[{ "amount":{"currency":"CurrencyCodeEnum:\[AED,AFN, ALL...\]", "value":"string" }, "taxType":"TaxType:\[STATE\_SALES\_TAX,VAT,PROVINCE\_S ALES\_TAX...\]" } \] } \] © 2022 eBay. All rights reserved.9 © 2022 eBay. All rights reserved.10 • • "addonServices": \[ { "selected": true, "serviceFee": { "currency": "USD", "value": "80" }, "serviceId": "VAS101", "serviceTax": { "currency": "USD", "value": "8" }, "serviceType": "AUTHENTICITY\_GUARANTEE" } \] © 2022 eBay. All rights reserved.11 "addonServices":\[ { "selection":"OPTIONAL", "serviceFee":{ "convertedFromCurrency":"USD", "convertedFromValue":"80", "currency":"USD", "value":"80" }, "serviceId":"VAS101", "serviceType":"AUTHENTICITY\_GUARANTEE" } \] © 2022 eBay. All rights reserved.13 • • • • Feed Types: CURATED\_ITEM\_FEED, PRODUCT\_FEED Feed Scopes: DAILY, WEEKLY, HOURLY Access: Specific to Marketplace and Categories getFeedTypes getFeedType getAccess getFiles getFile downloadFile © 2022 eBay. All rights reserved.14 © 2022 eBay. All rights reserved.15 • • { "total": 2, "feedTypes": \[ { "feedTypeId": "CURATED\_ITEM\_FEED", "description": "eBay Partner Network Curated Item Feeds", "supportedFeeds": \[ { "feedScope": "DAILY", "authorizationScopes": \[ "https://api.ebay.com/oauth/api\_scope/buy.item.feed" \], "status": "ACTIVE", "supportedSchemas": \[ { "formats": \[ "TSV" \], "schemaVersion": "1.0", "definition": “{ \\"itemLocationCountry\\”..... \\"manufacturer\\": \\"string\\"}", "deprecated": false } \], "constraint": { "marketplaceIds": \[ "EBAY\_AU", "EBAY\_FR", "EBAY\_US", "EBAY\_GB", "EBAY\_DE", "EBAY\_IT" \] }, "lookBack": { "unit": "DAY", "value": 14 } } \] }, {...} \] } © 2022 eBay. All rights reserved.16 { "feedTypeId": "CURATED\_ITEM\_FEED", "description": "eBay Partner Network Curated Item Feeds", "supportedFeeds": \[ { "feedScope": "DAILY", "authorizationScopes": \[ "https://api.ebay.com/oauth/api\_scope/buy.item.feed" \], "status": "ACTIVE", "supportedSchemas": \[ { "formats": \[ "TSV" \], "schemaVersion": "1.0", "definition": "{ \\"itemLocationCountry\\": \\"string\\",...., \\"manufacturer\\": \\"string\\"}", "deprecated": false } \], "constraint": { "marketplaceIds": \[ "EBAY\_US", "EBAY\_GB", .... "EBAY\_AU" \] }, "lookBack": { "unit": "DAY", "value": 14 } } \] } • • © 2022 eBay. All rights reserved.17 { ""accesses": \[ { "feedType": "CURATED\_ITEM\_FEED", "constraints": \[ { "marketplaceId": "EBAY\_IT", "categoryIds": \[ "1249", "15032", "58058", "293", "625" \] } \] }, { "feedType": "PRODUCT\_FEED", "constraints": \[ { "marketplaceId": "EBAY\_AU", "categoryIds": \[ "1249", "58058", "15032", "293", "625" \] } © 2022 eBay. All rights reserved.18 { "href": "https://api.ebay.com/buy/feed/v1/file?limit=20&feed\_type\_id=CURATED\_ITEM\_FEED ", "next": "https://api.ebay.com/buy/feed/v1/file?limit=20&continuation\_token=Ci5vcmcubW9uc3 Rvci5zZXJ2aWNlLnYxLnByb3RvLl9Tb3J0VmFsdWVDdXJzb3JzEgu7AcGZFx1SeuUD ZA%3D%3D&feed\_type\_id=CURATED\_ITEM\_FEED", "total": 27, "limit": 20, "fileMetadata": \[ { "fileId": "EPN-CURATED\_ITEM\_FEED-US-6000-20220830-1-1.txt.gz", "feedTypeId": "CURATED\_ITEM\_FEED", "feedScope": "DAILY", "marketplaceId": "EBAY\_US", "dimensions": \[ { "dimensionKey": "CATEGORY", "values": \[ "6000" \] } \], "feedDate": "2022-08-30T00:00:00.000Z", "span": { "unit": "HOUR", "value": 24 }, "format": "TSV", "schemaVersion": "1.0", "size": 4999064155, "access": "ALLOWED" }, {....} {....} {....} \] } © 2022 eBay. All rights reserved.19 { "fileId": "EPN-CURATED\_ITEM\_FEED-US-6000-20220830-1-1.txt.gz", "feedTypeId": "CURATED\_ITEM\_FEED", "feedScope": "DAILY", "marketplaceId": "EBAY\_US", "dimensions": \[ { "dimensionKey": "CATEGORY", "values": \[ "6000" \] } \], "feedDate": "2022-08-30T00:00:00.000Z", "span": { "unit": "HOUR", "value": 24 }, "format": "TSV", "schemaVersion": "1.0", "size": 4999064155, "access": "ALLOWED" } © 2022 eBay. All rights reserved.20 © 2022 eBay. All rights reserved.22 • • • - - - --- # Unknown eBay Connect 2020 Powered by You Selling on eBayBuying on eBayMore KYC checks in Account API Transfer transaction type in Finances API Escrow payment method and fee netting support in Fulfillment API Deal API Fee breakdown in Order API HTML markups and new language pairs supported in Translation API 2 Other API Updates © 2020 eBay. All rights reserved. API Deprecations Alpha release of Finances API Sold Report Revise Checkout Status Feedback API and DSR reports eBay solutions directory Get Category Specifics Revise Selling Manager Sale Record © 2020 eBay. All rights reserved.3 Auth’n’Authprotocol Increased length of Session ID © 2020 eBay. All rights reserved.4 What is Next developer.ebay.com © 2020 eBay. All rights reserved.5 Date / TimeContent July 14 –15eBay Connect Virtual Lounge August 17 @ 10 AM PTAll about APIs Consumer Selling API eBay for Charity Translation API API Security Updates Fireside Chat with Randy Shoup August 18 –19eBay Connect Virtual Lounge --- # Unknown eBay Connect 2020 All About APIs Tanya Vlahovic Head of Developer Ecosystem Ensure consistency across APIs Define “the good citizen” API Business-to-Developer Model eBay Connect 2020 Agenda API Portfolio Buy Deal API Other API Updates © 2020 eBay. All rights reserved.3 182M active buyers 1.5B active listings 190 markets Q2 2020 250M API calls per hour A makeup product sellsevery 2 sec. An appliance sellsevery 5 sec. A tool sellsevery 4 sec. A smartphone case or cover sellsevery 7 sec. A watch sellsevery 5 sec. A sports trading card sellsevery 2 sec. USUK A video game sellsevery 11 sec. A car or truck part sellsevery 13 sec. GermanyAustralia 2019 Basics of Trade © 2020 eBay. All rights reserved.6 Established 150,000 years ago We are translating this into a digital model © 2020 eBay. All rights reserved.7 API Portfolio Marketplace Insights\* Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxonomy Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Translation Offer Analytics Listing Identity Recommen- dation Finances Charity Feed Sell Buy Commerce Developer \* Limited Release Deal Buy Deal API © 2020 eBay. All rights reserved.8 getEvents Sale events discovery getEvent Get details for a single sale event getEventItems Get items associated with sale events getDealItems Get items associated with deals Finances API: Active Cross- Border-Trade © 2020 eBay. All rights reserved.9 GET https://apiz.ebay.com/sell/finances/v1 /transaction { ... "...Amount": { "convertedFromValue": "string", "convertedFromCurrency": "string", "exchangeRate": "string", "value": "string", "currency": "string" }, ... } Finances API: Transfer Detail © 2020 eBay. All rights reserved.10 GET https://apiz.ebay.com/sell/finances/v1 /transfer/{transfer\_id} { "transferId": "string", "transactionDate": "string", "transferAmount": { ... }, "fundingSource": { "memo": "string", "brand": "string", "type": "string" }, "transferDetail": { "charges": \[ { "chargeNetAmount": { ... }, ”paymentDisputeId": "string", "cancellationId": "string", "refundId": "string", "caseId": "string", "returnId": "string", "inquiryId": "string", "orderId": "string" } \], "totalChargeNetAmount": { ... }, "balanceAdjustment": { "adjustmentType": "string”, "adjustmentAmount": { ... } } } } Post Order API: Active Cross-Border-Trade © 2020 eBay. All rights reserved.11 Cancelation detail Return detail { ... "refundInfo": { "actualRefundDetail": { "actualRefund": { "totalAmount": { "value": 70, "currency": "USD" //listing currency }, "feeCreditAmount": { "value": 9, "currency": "USD" //listing currency } }, "netChargeAmount": { "value": 51.94, "currency": "EUR", //payout currency "convertedFromValue": 61, "convertedFromCurrency": "USD", //listing currency "exchangeRate": "0.8515" }, } ... } } { ... "refundInfo": { "actualRefundDetail": { "actualRefund": { "totalAmount": { "value": 70, "currency": "USD" //listing currency }, "feeCreditAmount": { "value": 9, "currency": "USD" //listing currency } }, "netChargeAmount": { "value": 51.94, "currency": "EUR", //payout currency "convertedFromValue": 61, "convertedFromCurrency": "USD", //listing currency "exchangeRate": "0.8515" }, } ... } } Post Order API: Active Cross-Border-Trade © 2020 eBay. All rights reserved.12 Inquiry detail Case detail { ... "refundAmounts": { "refundAmount": { "value": 61, "currency": "USD" //listing currency }, "feeCreditAmount": { "value": 1, "currency": "USD" //listing currency }, }, "refundChargeAmount": { "value": 51.94, "currency": "EUR", //payout currency "convertedFromValue": 60, "convertedFromCurrency": "USD", //listing Currency "exchangeRate": "0.8515" }, "appealDetails": { "appealRefundAmount": { "value": 51.94, "currency": "EUR", //payout currency "convertedFromValue": 60, "convertedFromCurrency": "USD", //listing currency "exchangeRate": "0.8515" }, ... } ... } { ... "refundChargeAmount": { "value": 51.94, "currency": "EUR", //payout currency "convertedFromValue": 60, "convertedFromCurrency": "USD", //listing currency "exchangeRate": "0.8515" }, "appealDetails": { "appealRefundAmount": { "value": 51.94, "currency": "EUR", //payout currency "convertedFromValue": 60, "convertedFromCurrency": "USD", //listing currency "exchangeRate": "0.8515" }, ... } ... } ChangesActions to TakeImpacted APIs & Feeds Effective Sept.17, you can no longer use Manufacturer Refurbishedon ebay.com& ebay.com.au Beginning early September, existing inventory under Manufacturer Refurbishedwill be adjusted to the Seller Refurbished item condition Applicable to sellers using APIs, 3 rd -party tools, MIP listing tools, and eBay listing flows When creating new refurbished listings, list under the Seller Refurbisheditem condition When changing an existing Manufacturer Refurbishedlisting, select the Seller Refurbisheditem condition Inventory API Trading API Large Merchant Services Merchant Integration Platform 13 Manufacturer Refurbished Item Condition © 2020 eBay. All rights reserved. Selling on eBayBuying on eBayMore Soon to be required aspects in Compliance API Suggested ad rates tailored to items in Recommendation API Proof of pickup for payment disputes in Fulfillment API Escrow payment method in Fulfillment API Customer service metrics in Feed API OAuth tokens supported in LMS Feed API enabled for SingaporeAspect relevance in Taxonomy API 14 Other API Updates © 2020 eBay. All rights reserved. Keep the Marketplace Open Support eBay business initiatives Enable developers to innovate --- # Unknown eBay Connect 2022 AI Nitzan Mekel VP, Chief AI Officer, CoreAI eBay Connect 2022 Agenda © 2022 e Ba y. Al l ri ghts reserve d.2 Updates Foundations Image Similarity Text Translation Video Moderations Updates -Last 12 Months © 2022 e Ba y. Al l ri ghts reserve d.3 Image Similarity •New fields added to the response. Image similarity pipeline has been updated with further improvements coming. Text Translation •Launched translation between 13 language pairs Video Moderation •Videos moderated in < 48 hrs. Core AI Services Image Similarity © 2022 e Ba y. Al l ri ghts reserve d.5 Customer Opportunity Finding items by text is hard, especially when the customer doesn't know how to describe the item clearly. Text based search is also hard for non-native speakers or people who have trouble reading and writing. Solution Use an image to find similar items. The items are found based on item-based visual similarity between the input image and the primary image of the items. Benefit to Customers Buyers:Find similar items using an Image. Sellers: Find aspects from the item image. Make listingsmore relevant. Status Live as of now Input Output Image Similarity © 2022 e Ba y. Al l ri ghts reserve d.6 Input •Base64 String of an Image (jpeg) •Limit •Sort Method POST https://api.ebay.com/buy/browse/v1/item\_summary/search\_by\_image?&limit=3 &sort=-price Output List of items. $catinput-str.json { "image": "Base64 encoded image" } $curl -s -H "Authorization: Bearer $AUTH\_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json""https://api.ebay.com/buy/browse/v1/item\_summary/search\_by\_image?limit=3&sort=price" -d "$jsonstr" | jq. { "href": "https://api.ebay.com/buy/browse/v1/item\_summary/search\_by\_image?limit=3&sort=price&offset=0", "total": 21992, "next": "https://api.ebay.com/buy/browse/v1/item\_summary/search\_by\_image?limit=3&sort=price&offset=3", "limit": 3, "offset": 0, "itemSummaries": \[ { "itemId": "v1|133798300191|0", "title": "Staples Office Chair With Wheels, Swivel, And Height Adjustment", "leafCategoryIds": \[ "257900" \], "categories": \[ { "categoryId": "257900", "categoryName": "Chairs & Stools" }, { "categoryId": "12576", "categoryName": "Business & Industrial" }, { "categoryId": "25298", "categoryName": "Office" } \], "image": { "imageUrl": "https://i.ebayimg.com/thumbs/images/g/vOsAAOSwFyRg1OuK/s-l225.jpg" }, "price": { "value": "5.00", "currency": "USD" }, "itemHref": "https://api.ebay.com/buy/browse/v1/item/v1%7C133798300191%7C0", Text Translation © 2022 e Ba y. Al l ri ghts reserve d.7 Customer Opportunity Customers often don't find the items in their market. But the same item may be available in a different market and listed in a language that the buyer doesn't understand. Solution Seller can translate the item title and description and then list the item in a different market / language. This enables cross-border trading. Benefit to Customers Buyers:Enables them to buy items from other markets. Sellers:Expands the reach of sellers. Status Live as of now FromTo (en) English(de) German (en) English(zh) Chinese (Mandarin) (en) English(ja) Japanese (en) English(fr) French (en) English (it) Italian (en) English (pt) Portuguese (en) English (es) Spanish (en) English (ru) Russian (de) German (en) English (de) German (fr) French (de) German (it) Italian (de) German (es) Spanish (ja) Japanese (en) English Available Language Pairs Text Translation © 2021 e Ba y. Al l ri ghts reserve d.8 Input •"from" Language •"to" Language •"text": Text to be translated •"context": Title or Description Method POST https://api.ebay.com/commerce/translation/v1\_beta/translate Output Original text and translated text. $curl -s -H "Authorization: Bearer $AUTH\_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json""https://api.ebay.com/commerce/translation/v1\_beta/translate"-d '{ "from": "en", "to": "ja", "text": \["Welcome to eBay" \], "translationContext": "ITEM\_TITLE" }'| jq. { "from": "en", "to": "ja", "translations": \[ { "originalText": "Welcome to eBay", "translatedText": "EBayへようこそ" } \] } Video Moderation © 2022 e Ba y. Al l ri ghts reserve d.9 Customer Opportunity eBay listings can have videos attached to them. However, videos may have inappropriate content in them. So, the videos must be vetted before they can be shown to users. Solution Seller uploads the videos. A backend system processes the uploaded videos for any inappropriate content. If the video is good, it will be displayed to the users. If not, sellers can upload a new video. The entire process takes < 48 hours. Benefit to Customers Sellers:Provides feedback about the uploaded videos. Buyers:Provides a better shopping experience. Status Live as of now /video video pipeline media storage AI moderation uploading pending available --- # Unknown eBay Connect 2023 Buy API Shruti Hulmani Sr. Product Manager, Developer Ecosystem eBay Connect 2023 Agenda © 2023 eBay. All rights reserved.2 Buy APIs Real Time Item Updates Compliance Buy APIs Affiliate eBay Partner Network 4© 2023 eBay. All rights reserved. Buy Partners Non-Affiliate Partners + 5© 2023 eBay. All rights reserved. Global Marketplace 15 Supported Marketplaces ~$2B YTD >$14B lifetime GMB >50% Exposed Listings eBay shipping Auction checkout Digital Services Act Condition Grading New Language pairs Real time Item Updates Subscription Filters 6© 2023 eBay. All rights reserved. What’s New in Buy and Commerce APIs? Browse, FeedOrder Notification Translation 7 Condition Grading Item condition descriptor provides more information about an item’s condition in a structured way © 2023 eBay. All rights reserved. Browse: "conditionDescriptors" : \[ { /\* ConditionDescriptor \*/ "name" : "string", "values" : \[ { /\* ConditionDescriptorValue \*/ "additionalInfo" : \[ "string" \], "content" : "string" } \] } \], Feed: ●items.conditionDescriptors 8 Browse API ... "condition":"Graded", "conditionId":"2750", "conditionDescriptors":\[ { "name":"Professional Grader", "values":\[ { "content":"Professional Sports Authenticator (PSA)" } \] }, { "name":"Grade", "values":\[ { "content":"10" } \] } \], ... Ungraded © 2023 eBay. All rights reserved. Graded ... "condition": "Ungraded", "conditionId": "4000", "conditionDescriptors": \[ { "name": "Card Condition", "values": \[ { "content": "Near mint or better", "additionalInfo": \[ "Minor corner and edge wear" \] } \] } \], ... 9 Translation API © 2023 eBay. All rights reserved. Additional Translation Pairs ●German -> Polish ●Polish -> German ●French -> English, German, Italian, and Spanish ●Italian -> English, German, French, and Spanish ●Spanish -> English, German, French, and Italian ●Chinese (Mandarin) -> English Open Source - Translation Widget 10 Allows all language pairs supported via the Translation API © 2023 eBay. All rights reserved. https://github.com/eBay/ebay-translation-react-widget Real Time Updates 12 Notification API Methods © 2023 eBay. All rights reserved. Topics ITEM\_AVAILABILITY ITEM\_PRICE\_REVISION PRIORITY\_LISTING\_REVISION Topics •getTopic •getTopics Subscription •createSubscription •updateSubscription •enableSubscription •disableSubscription •getSubscription •getSubscriptions •deleteSubscription •testSubscription •createSubscriptionFilter •getSubscriptionFilter •deleteSubscriptionFilter Destination •createDestination •updateDestination •getDestination •getDestinations •deleteDestination 13 API Details createSubscriptionFilter POST https://api.ebay.com/commerce/notification/v1/subscription/ {subscription\_id}/filter Request Parameter: subscription\_id © 2023 eBay. All rights reserved. Scope https://api.ebay.com/oauth/api\_scope https://api.ebay.com/oauth/api\_scope/commerce.not ification.subscription Response : No Payload getSubscriptionFilterdeleteSubscriptionFilter GET https://api.ebay.com/commerce/notification/v1/subscription/ {subscription\_id}/filter/{filter\_id} Request Parameter: subscription\_id, filter\_id Response { "subscriptionId": "b\*\*\*\*\*8", "filterId": "8\*\*\*\*\*8", "creationDate": "2023-02-23T09:10:08.520Z", "filterSchema": { "type": "object", "properties": { "listingMarketplaceId": { "type": "string", "const": "EBAY\_GB" } } }, "filterStatus": "ENABLED" } DELETE https://api.ebay.com/commerce/notification/v1/subscription/ {subscription\_id}/filter/{filter\_id} Request Parameter: subscription\_id, filter\_id Response : No Payload Notification SDK 14 Use this eBay Open Source Java SDK for the latest eBay notifications that use ECC signatures and JSON payloads. © 2023 eBay. All rights reserved. Notification SDK Event Notification SDKs Java: https://github.com/eBay/event-notification-java-sdk Node.js: https://github.com/eBay/event-notification-nodejs-sdk NET: https://github.com/eBay/eBay-Notification-SDK-Dot-Net-Core PHP: https://github.com/eBay/event-notification-php-sdk GO: https://github.com/eBay/event-notification-golang-sdk Notification SDK 15© 2023 eBay. All rights reserved. Compliance Digital Service Act (DSA) 17 Help buyers understand if this product contains harmful chemicals or materials deemed as harmful © 2023 eBay. All rights reserved. Feed ●hazmatSignalWordId ●hazmatSignalWord ●hazmatStatementIds ●hazmatStatementDescriptions ●hazmatPictogramIds ●hazmatPictogramDescriptions ●azmatPictogramImageUrls ●hazmatAdditionalInformation ... "hazardousMaterialsLabels":{ "statements":\[ { "statementId":"H201", "statementDescription":"Explosif; danger d'explosion en masse." }, { "statementId":"H202", "statementDescription":"Explosif; danger sérieux de projection." } \], "pictograms":\[ { "pictogramId":"GHS02", "pictogramDescription":"flamme", "pictogramUrl":"https://i.qa.ebayimg.com/00/s/...." }, { "pictogramId":"GHS03", "pictogramDescription":"flamme au-dessus d'un cercle", "pictogramUrl":"https://i.qa.ebayimg.com/00/s/....." } \], "signalWordId":"Danger", "signalWord":"danger", "additionalInformation":"Higly dangerours" } ... Browse ●hazardousMaterialsLabels ○Pictograms ○Signal Word ○Statements Hazardous Materials 18 © 2023 eBay. All rights reserved. "repairScore" : "string" Example: “6.2” { "itemId": "v1|350033592291|0", "sellerItemRevision": "3", "title": "Article test 3243u2", ... "categoryId": "12", "listingMarketplaceId": "EBAY\_FR", "repairScore": "6.2", ..... } Browse and Feed APIs A score ranging from 0.1 to 10.0 is given to indicate how easy it is to repair the product. Repair Score 19 © 2023 eBay. All rights reserved. Browse API changes "weeeNumber" : "string" Example: “WEEE Reg.No.DE12345678” Browse WEEE Registration number is returned where applicable Waste Electrical and Electronic Equipment (WEEE) { "itemId":"v1|350033592291|0", "...""seller":{ "/\* SellerDetail \*/ ..."{ "/\* SellerLegalInfo \*/ ...""sellerProvidedLegalAddress":{ "..." }, "termsOfService":"string", "vatDetails":\[ { "/\* VatDetail \*/ .." } \], "weeeNumber":"DE12345678" }, } --- # Unknown • • • • ● ● ● ● ● ● ● ● ● ● ● ● ● • • • ••• • • • • • ••• • • • • • ••• • • • • • ••• • • • • • eBay Price Guide --- # Unknown eBay Connect 2023 eBay International Shipping Meghna Rao Gangavati Sr Product Manager, Shipping eBay International Shipping About eBay International Shipping API listing experience Our product roadmap 3© 2023 eBay. All rights reserved. Shipping internationally is complex Buyers •Less than 50% of Big 3 inventory is available internationally •High shipping costs •Unexpected customs and import costs •Long and uncertain delivery times Sellers •Lack of inventory exposure to international buyers •Too many service options, unfamiliar with export process •Higher seller fees internationally vs domestic •Complicated and expensive returns process 4© 2023 eBay. All rights reserved. “Enable everyone on eBay to buy and sell things globally without the need to think about complexities of cross-border trade” 5© 2023 eBay. All rights reserved. Our value proposition is to enable inventory availability, eliminate seller friction, and give buyers choice of delivery Reimagines the international selling experience making eBay the best exporting platform because it is so simple it feels like a domestic transaction. Greater inventory visibility Frictionless seller experience from listing to customs eBay manages international shipping on behalf of sellers & offers buyer’s choice Simplified returns & Seller protection on reputation 6© 2023 eBay. All rights reserved. eBay International Shipping streamlines the customer journey.. 7© 2023 eBay. All rights reserved. ..and brings multiple managed programs (and their combined benefits) under one umbrella A frictionless experience for sellers auto-opted in, international is as easy as domestic shipping Buyers will benefit from increased inventory availability, lower cost, and choice for duties/taxes payment eBay deals with all the friction (returns, claims, exports compliance) and liability Listing with eBay International Shipping 8© 2023 eBay. All rights reserved. Ensure seller has opted-in (shipping preferences in account settings). •eBay will auto enroll based on seller criteria Don't specify international shipping on listings, so transaction can go through eBay International Shipping. Applies to Business Policies as well All listings are automatically processed for qualification Use shipping exclusions to not sell the item internationally (worldwide or to a specific location) eBay International Standard Delivery migration •Deprecation process began on 5/22 •Migration of seller’s eligible listings to eBay International shipping in-progress Our product roadmap Nov-Dec 2022 DDP (Taxes and Duties paid) Full returns solution (Sold-is-Sold) Q1-Q2 2023 1.5M+ parcels delivered Completed GSP seller migration eBay International Standard Delivery seller migration Opened LA hub Sep-Oct 2022 Open Beta DDU (Taxes and Duties unpaid) Upcoming Simplified listing and exclusions experience Buyer choice on duties and taxes Combined shipping Improved tracking experience --- # Unknown eBay Connect 2021 Welcome! Tanya Vlahovic Head of Developer Ecosystem Welcome © 2021 eBay. All rights reserved.2 Date / TimeContent July 12 @ 9 AM PT All About APIs Buyer Experience Media API Buy APIs Shipping and Member Communications API Security Updates New Event Notifications Fireside Chat With eBay Chief Architect Randy Shoup July 13 –14eBay Connect Virtual Lounge © 2021 eBay. All rights reserved.3 API is a product First-class product Built by developers for developers eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.4 Global Marketplace API Updates Event Notifications Developer Experience A truly global marketplace 20M Active sellers worldwide 1.7B Live listings 187M Active buyers worldwide 190 Markets supported Q1 2021 eBay Velocity 6 A watch is purchased every 7 sec. A car part or accessory is purchased every 1 sec. A sneaker is purchased every 4 sec. A sports trading card is purchased every 1 sec. \*Data are full-year 2020 averages © 2021 eBay. All rights reserved. API-First Strategy © 2021 eBay. All rights reserved.7 •Media APIfor uploading videos •APIs for Promoted Listings Advanced coming in July eBay’s Buy APIs are changing the way we do business GMB = gross merchandise bought; Q1 2021 Acquire new buyers, sellers, and partners Grow GMB and revenue Empower buying and selling anywhere Expand our global reach Buy APIs Crossed $6 Billion GMB © 2021 eBay. All rights reserved. New in Buy APIs General Availability Geo-expansion Managed Payments Checkout with eBay button eBay Initiatives Authenticity Guarantee, Certified Refurbished © 2021 eBay. All rights reserved. Other API Updates Videos on Listings Enabled in UK Sell Feed API Supports scheduling Translation API Optimized for ecommerce © 2021 eBay. All rights reserved. Assets for Login with eBay © 2021 eBay. All rights reserved.11 •Support for Web, iOS, Android © 2021 eBay. All rights reserved.12 Event Notifications Delivered to 3 rd -party webhooks Notification schema treated as a contract SDKs to simplify integration Event Notification Payloads Versioning Semantic versioning Format JSON AsyncAPI For async API contracts © 2021 eBay. All rights reserved. { ... } Developer Experience © 2021 eBay. All rights reserved.14 Simple, secure, consistent and well-documented API portfolio Tools Communication and tech support © 2021 eBay. All rights reserved.15 API Portfolio Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxonomy Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Translation Offer Analytics Listing Identity Recommen- dation Charity Feed Sell BuyCommerceDeveloper \* Limited Release Deal Media Notification Finances Legacy APIs Trading API Shopping API Finding API SDKs © 2021 eBay. All rights reserved.16 •eBay OAuth(Java, Python, C#, Android) •Feed(Java, Python) •Taxonomy(Java) •Event notifications(Java, Node.js) https://github.com/eBay Drop-In Solutions Widgets Checkout With eBayeBay Items APIs eBay core marketplace capabilities Widgets (drop-in) Toolkits (UX) SDKsSamplesSpecsDocs Integration Models Bespoke Boilerplate OpenAPISpecification Vendor-neutral Human-readable Machine-readable Streamlines integration with APIs © 2021 eBay. All rights reserved. AsyncAPISpecification Vendor-neutral Human-readable Machine-readable Standard for defining asynchronous APIs © 2021 eBay. All rights reserved. © 2021 eBay. All rights reserved.20 Communication Important program updates API deprecations SYD: Support Your Developer © 2021 eBay. All rights reserved. --- # Unknown eBay Connect 2021 Buyer Experience Julie Katz COO Shopping Experience eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Buyer experience progress Growing eBay Customers through the API Toolkits Buyer Experience Focus Building lifelong Buyer relationships Winning in key verticals Improving shopping efficiency Winning in Key Verticals Trust and Authenticity are the number one concerns facing both our buyers and sellers in our vertical categories. Sellers want stronger protection from buyer fraud given the high ASPs. Fierce competition and explosive growth have made this a must-win focus area for eBay. Luxury: Authenticity Guarantee Watches © 2021 eBay. All rights reserved.6 Customer Opportunity 5% of luxury watch purchases are filed as SNAD (Significantly Not As Described) cases. The AG program for Watches is needed to build trust and engagement amongst buyers. Objective & Hypothesis Establish and expand AG program for Luxury Watches to other sites. Audience Luxury watches buyers purchasing Watches > $2000 (US, UK, DE, CA) Approach Expand new AG program for Watches globally. Why is this important? •Buyers: Increase trust and confidence by verifying the authenticity of the luxury watch purchase. •Sellers: Increase engagement and conversion with inventory covered by AG program. Status US launch: Aug 2020 Global expansion 2021: UK & DE later this year Customized Watches later this year Luxury: Authenticity Guarantee Sneakers © 2021 eBay. All rights reserved.7 Customer Opportunity 3% of all sneaker purchases are filed as SNAD (Significantly Not As Described) cases. More work is required to ensure Buyers and Sellers who want to transact on the platform can do so confidently in a safe, trusted, and supported way. Audience Enthusiast sneakerheads, particularly flippers Approach Expand category coverage under the AG program to include Sneakers. Why is this important? ●Buyers: Increase trust and confidence by verifying on their behalf whether or not the sneaker is authentic. ●Sellers: Increase engagement and conversion with inventory that have been tagged as part of the AG program. Status US launch: Oct 2020 UK and CA launch: May 2021 Global expansion 2021: UK & DE later this year Luxury: Authenticity Guarantee Sneakers eTag © 2021 eBay. All rights reserved.8 Customer Opportunity When buying luxury goods, buyers want confidence that their item is authentic, the purchase experience is memorable and unique and that “value” is transferable. Audience Sneakerheads, particularly flippers Approach Enable the Authenticity eTaglanding page within eBay’s mweband native app experience. Integrate with Bluebite(physical tag vendor) and leverage SneakerCon’sauthentication data. Why is this important? The Auth eTaghelps eBay differentiate itself among competitors and add value for buyers and sellers through confidence in the item and deeper integration into eBay’s post purchase experience. Status Q1: Native/mWebmigration and launch handbag experience Q2/Q3: Watches and integration into myeBayand digital collection Luxury: Authenticity Guarantee Handbags US © 2021 eBay. All rights reserved.9 Customer Opportunity A luxury handbag buyer had seen the exact same experience as a buyer purchasing in business & industrial. We were not providing the user with trust signals and complementary merchandising in a relevant and compelling way to enhance their luxury buying experience. Audience Luxury fashion buyers purchasing Handbags > $500 Approach Expand category coverage under the AG program to include luxury handbags in the US. Why is this important? •Buyers: Offer coverage of AG program for Handbags > $500 to build trust. •Sellers: Increase conversion and engagement. Status US launched in June 2021 Certified Refurbished Customer Opportunity eBay’s refurbished condition definitions are misleading to buyers. SNAD and returns rates for Manufacturer Refurbished are 3x that of new. No policies are in place to maintain a minimum quality of inventory, leading to a muddied value proposition Approach •Rename Manufacturing Refurbished item condition to Certified Refurbished globally •Gate new condition and migrate existing listings globally •On-board quality certified refurbished sellers Globally Why is this important? •Buyers: Trust (gated + verified sellers) & quality (must meet minimum functional and cosmetic standards) •Sellers:Increased velocity and sell-through rates Status •US, AU -Launched -Oct 2020 •UK, DE, IT, ES, CA other sited markets launched -H1 2021 Q4 Certified refurbished Certified refurbished Certified refurbished Education + Inventory Module © 2021 eBay. All rights reserved.11 Customer Opportunity The value proposition of eBay’s key strategic programs can be difficult to convey once buyers are already on the Search page. Existing mechanism like our headlines ads are limited, oftentimes forcing users out of the funnel. Audience All eBay Search Users Why is this important? •Education+ Inventory modules allow us to educate buyers about our programs while at the same time show them highly relevant and contextual inventory matching their intent. •Marrying education with inventory will allow users to confidently drive further down the purchase funnel. Status •Launched in the US for ‘Authenticity Guarantee ‘ and ‘Certified Refurbished’ programs. •Regional expansion in Q2 •Additional program and use case expansions planned Certified RefurbishedAuthenticity Guarantee Customer Opportunity It is difficult for buyers to find the fantastic inventory eBay has that’s coming direct from top Brands; many Brands offer great inventory at deep discounts. It’s not easy to browse the latest inventory from top Brands, or discover new Brands. Approach Create a more personalized, shoppable experience where buyers can easily browse the latest Brand Outlet inventory where all items include free delivery, 30-day returns, and prices up to 70% off. Buyers can shop by Brand, or browse through the latest Influencer-curated sales event. Why is this important? •Buyers: Create a dedicated, personalized space for buyers to discover Brand Outlet inventory. Personalize the experience to make it easy to shop the latest inventory from their favorite brands. •Sellers: Elevate our top Brands and their discounted inventory. Drive velocity through personalization, marketing, and an experience that gets buyers to keep checking back and discover what’s new. Status •Phase 1 -Updated Brand Outlet UK -May 10th Launched 朗  •Phase 2 -Expansion to new markets through 2021 and into 2022 Brand Outlet Shopping quality and efficiency Given our breadth of inventory, we invested in new capabilities for buyers to evaluate and compare the items to find the best deals on eBay. Mobile Filter Evolution © 2021 eBay. All rights reserved.15 Customer Opportunity Mobile users scroll (down) immediately upon landing on the SRP making sorting and filtering entry points disappear. When users did interact with them our prior filter panel was too cumbersome, especially for new customers. Audience All mobile eBay search users Why is this important? •Buyers: By making it easier for users to sort and filter eBay’s vast inventory we’re making shopping on eBay more efficient. •Guidance to Sellers: Search filters are derived from aspects (item specifics) and as we’ve increased filter engagement by ~10%.It is crucial for sellers to fill out as many item specifics as possible. Status •Launched Globally on iOS, Android, and mWeb New filter panel -full scroll Great Price Customer Opportunity •Sifting through eBay’s vast inventory for high quality items that are also competitively priced is tantamount to finding a goldenneedle in the haystack -buyers need assistance to quickly identify them. •Trustworthy sellers who provide great bargains along with superior quality of service need to stand out from the crowd. Why is this important? •By highlighting competitively priced items from trusted sellers in search results via a “Great Price” badge, buyers get to quickly identify great deals. •Sellers who provide excellent value for money get much deserved exposure for their listings, both on and off eBay (e.g. Google). Status •Launched on Big 4 on all platforms Guidance to sellers •Maintain good seller standards, provide high quality listing details(adopt catalogas much as possible), price items competitively. Q2 Diversity Module Customer Opportunity It’s difficult to find the products I want. Results are overwhelming and I have to work hard to understand the different types of products that eBay can offer. Approach Introduce a summary module on top of search results which provides users with a quick overview of the diverse result set, helping them narrow down on the exact type of product they may be interested in. Why is this important? ●Buyers: The diversity module helps users understand all the choices they may have and understand the trade-offs associated with different types of products. Users have navigational options to see more of the same type. ●Guidance to Sellers: Provide as many high quality item specifics as possible to accurately describe a listing. High aspect quality is critical to make this diversity module relevant and useful. Q2 Ranking, Filtering, Sorting and Comparing Unit of Measure © 2021 eBay. All rights reserved.18 Customer Opportunity As a buyer,I want to see all relevant inventory matching my search query, and return a 65’ TV when I search for a 65 inch TV Audience All Buyers Approach •Leverage the structured data knowledge service to identify unit of measure strings in item and query data •Use a canonicalized representation to match items to queries and return more relevant results Why is this important? •Increase selection for buyers, and reduce need to requery to find all relevant items •Simplify listing for sellers -now providing a single representation of the unit and measure queries for equivalent representations Status •Launched to US in Q1 and expanded to UK/AU/CA in Q2, and pending testing in DE After: 1200+ Results Before: 231 Results Promoted Listings Advanced is Launching Soon Promoted Listings Advanced Drive higher velocity at competitive ROAS •Preferred access to Slot 1 on search •Keyword level targeting and bidding •Cost-per-Click (CPC) billing with second price auction Why is this important? •Sellers: sellers can use this programto improve presence in slot 1 with keyword and budget control Status •Launched in beta in June and expanding in H2 Promoted Listings Advanced offers keyword targeting for preferred access to Slot 1 on search Videos on View Item © 2021 eBay. All rights reserved.20 Customer Opportunity Videos are a retail standard across many e-commerce sites. It helps sellers better showcase their items, and buyers to understand additional details about the item (installation, unique value proposition, etc). Audience All sellers using Trading APIs. Buyers can see the videos on iOS & Android. Web experience launching later this year. Why is this important? ●Buyers: Allowing buyers to view videos will help them better understand the details of the itemand thereby increase the likelihood of making an informed purchase decision. ●Guidance to Sellers: Sellers can upload videos using Media API and map to listings using Trading API. Status Launched in US. UK & DE coming soon. Improved Experience for View Item (iOS & Android) © 2021 eBay. All rights reserved.21 Customer Opportunity Information on View Item was inconsistent and key actions like sharing listings and asking sellers a question were hard to accomplish. In addition, the page lacked modern design standards. Audience All buyers on iOS & Android. Approach Make the information hierarchy consistent about the item. Easier access to key actions like sharing an item and asking seller question Why is this important? Organizing the information hierarchy on the page and modernizing the experience will help users make faster and more informed purchase decisions. Status Launched January 2020 December 2021 Saved Searches/Sellers in Autocomplete Customer Opportunity eBay does not provide an easy way to access my saved searches & saved sellers on the desktop experience Approach Add support for Saved Searches & Saved Sellers in Autocomplete empty state on dWeb(Native already supports it) Why is this important Saving searches and sellers is a popular feature with buyers. Providing easy access for saves in autocomplete results in faster and more relevant searches which in turn leads to improved conversion. Status ●Launched in dWebin US, May 2021 ●ETA for Intl launch is June 2021 Saves Improvements © 2021 eBay. All rights reserved.23 Customer Opportunity Allow me to easily save sellers with whom I’ve had a good experience, and searches I frequent. Make it easy for me to access my favorites. Approach After a buyer leaves positive seller feedback, they will see a nudge asking them if they want to save the seller. Why is this important? 15% of current repeat purchases from the same seller comes from buyers saving a seller. To be saved, sellers should ensure they’re delivering a positive customer experience, and encourage their buyers to leave feedback. Status: Launched! •Save a Search & Save a seller on Homepage •Save a Seller in the single & multi-item feedback flows •Access Saved Searches and Sellers in Search autocomplete Saving in Seller Feedback Activity: eBay Nudges Customer Opportunity Help me understand how eBay works and how to get the best shopping experience. Audience Customers with limited engagement on features but who are showing high propensity to benefit, with each nudge targeted to a buyer activity. Approach •Download the app:after you make an offer, purchase, or watch an item •Make 3 or more purchases: earn a discount •Sell your first item:earn a coupon •And many more! Why is this important? •Buyers: driving loyalty & engagement from one-and-done buyers •Sellers: increase number & frequency of items bought on eBay Status Most nudges are live in mobile web across big 8 Make an offer Download the app Sell your first item Earn a coupon mWeb footer Download the app Make 3 purchase Get a coupon Aspects in Search Customer Opportunity As a buyer, I want to see all relevant inventory matching my search query. As a seller, I would like eBay to use all relevant aspects I provide. Approach •Leverage Machine Learning to identify high quality and relevant seller provided item specifics.Increased predicted aspects by 2X from initial launch. •Increase relevant recall and improved ranking- relevance •Expansion beyond US to UK, DE and AU Why is this important? •Buyers: 55% of searches have aspects in the query and/or filters. Aspect matches are a key match component in Search. •Guidance to Sellers: Provide as many high quality item specificsas possible to accurately describe a listing. Visibility increases in search directly proportional on average to # of high quality relevant aspects per listing. Query: 2019 yeezy boost 350 v2 Q3 2020 Content, Item and Inventory Understanding: SEO New Model Experience Customer Opportunity eBay doesn’t have a permanent landing experience that features all inventory of a sneaker model/colorway. For buyers coming from search engines like Google: “I only find individual eBay sneakers listings and products that are not my size(s). When it is my size and I click to eBay, it is often already out of stock.” Audience: Shoppers who browse eBay categories (particularly Sneakerheads) Shoppers who land on eBay from Search engines Approach Test new page experience, starting w/ US mWebin JordansSneakers. Sellersto adopt eBay product catalog so their items shows up in the experience. Why is this important? ●Buyers: A new sneaker model experience better meets the needs of buyers. The page features product level information, and aggregates inventory of all sizes and conditions for shoppers to easily see. ●Sellers: For flippers, it would be a pathway to quickly sell with key product specs pre-selected.With higher SEO traffic to these pages, we also expect more buyers to see the listings. Buy-Side APIs Your role in growing our buyers Acquiring new customers Contextual inventory wherever our customers are Chrome Extension © 2021 eBay. All rights reserved.28 Customer Opportunity When buyers are on a website and they see an image of something that they are interested in purchasing, they often ask “what is it?” and “where can I buy it?” Approach ●eBayis releasinga chrome extension that will allow users to engage with images on any website to search eBay’s inventory for similar products using our image search engine. Why is this important? ●Buyers:Simplifies how buyers can find and purchase items on eBay based on images they see through their daily web browsing experience eBay Partner Network © 2021 eBay. All rights reserved.29 Customer Opportunity Publishers would like to show their users relevant items available for sale from eBay. Buyers may not be aware of the broad selection of items available for sale on the eBay marketplace. Approach ●Provide integrations with Public APIs or feeds to allow partners to curate and surface eBay items on their sites ●eBay Partner Network is a performance-based channel where publishers earn commission on converting transactions Why is this important? ●Sellers: Earn money by driving traffic and prompting sales across one of the world's largest and most diverse marketplaces. Buyer Experience Toolkit © 2021 eBay. All rights reserved.30 Customer Opportunity Third-party developers have a hard time finding the right inventory to show their users. Approach ●Extend eBay’s core buyer experience features and capabilities to our APIs ●Search by image or keyword and filter by key aspects like shipping options, item condition, color or location ●Get the item details for specific items needed to complete a transaction Why is this important? ●Partners: Create a consistent experience for your users by extending the same eBay advanced search features and capabilities through the APIs Optimize Listings to Maximum Buyer Experience © 2021 eBay. All rights reserved.31 Customer Opportunity When buying luxury goods, buyers want confidence that their item is authentic, and the purchase experience is memorable and unique. Solving this builds trust and engagement among buyers. Approach ●Extend eBay’s Authenticity Guarantee (AG) programs from eBay sites to our Public APIs, expanding the reach and allow developers to benefit from the AG program Why is this important? ●Buyers: Increase trust and confidence by verifying on their behalf the authenticity of the items. ●Partners: Build a trusted relationship with your users --- # Unknown eBay Connect 2020 Empowering Sellers with APIs Scot Hamilton eBay Connect 2020 Agenda Power Up Your Listings With Aspects Boost Sales With Offers to Buyers Take Things to the Next Level With the Selling Feed API API Enhancements Based on Your Feedback © 2020 eBay. All rights reserved.2 Power Up Your Listings With Aspects Aspects: Workflow, Which APIs to Use Creation of New Listings Listing Creation Flow FetchAspects, New API Features to Drive Max Adoption Find Listings to Optimize Live Listings FindListings With Missing Required / Recommended Aspects (Daily / Monthly / On Demand) Optimize Listings Listing Revision Flow FetchAspects, New API Features to Drive Max Adoption TradingAPI: GetCategorySpecifics(SOAP) Or Sell: TaxonomyAPI(REST) APIs to Use ComplianceAPI(REST) TradingAPI: GetCategorySpecifics(SOAP) Or Sell: TaxonomyAPI(REST) GetItemAddItemReviseItem Fetching Aspects: New Features in Metadata APIs New Features Bulk Fetch (Whole Tree, Multiple Leaves) -Live Now - TradingAPI: GetCategorySpecifics TaxonomyAPI: getItemAspectsByCategory Existing Smart Bucketing and Ordering (Required, Recommended, Optional) -Live Now - RelevanceIndicator\* (Weighting of Buyer Demand) -August 2020 - Soon To Be Required (Advanced Notice Before Mandate) -August 2020 - 5© 2018 eBay. All rights reserved. Fetching Aspects: New Features © 2020 eBay. All rights reserved.6 Sample Response 2020-05-18T07:14:42.120Z Success 1155 E1155\_CORE\_API6\_19197342\_R1 9355 Brand 65867680 Text 1 1 FreeText Recomended Disabled Unbranded ........... TradingAPI: GetCategorySpecifics Smart Bucketing/Ordering: •aspectUsageRequired, Recommended, Optional •Bucketing and Ordering is based on Buyer Demand Relevance Indicator: •SearchCount–Buyer Demand •Search, Left Nav. Browse Nodes Fetching Aspects: New Features TaxonomyAPI: getItemAspectsForCategory Smart Bucketing/Ordering: •aspectUsageREQUIRED, RECOMMENDED, OPTIONAL •Bucketing and Ordering is based on Buyer Demand Relevance Indicator: •SearchCount–Buyer Demand •Search, Left Nav. Browse Nodes Soon To Be Required: •Always have aspectUsageas “RECOMMENDED” •Be indicated by the presence of the “expectedRequiredByDate” field/value in the aspectConstraintcontainer •UTC format date value, which may be in the future or in the past Sample Response { "aspects": \[ { "localizedAspectName": "Game", "aspectConstraint": { "aspectDataType": "STRING", "itemToAspectCardinality": "SINGLE", "aspectMode": "FREE\_TEXT", "aspectRequired": true, "aspectUsage": "RECOMMENDED", "aspectEnabledForVariations": true "expectedRequiredByDate":"2020-08-18T00:00:00.000Z" }, "aspectValues": \[ { "localizedValue": "Anachronism" }, { "localizedValue": "Basket Ball" }\], "relevanceIndicator": { "searchCount": "655487" } } \] } New Compliance Type: OUTSIDE\_EBAY\_BUYING\_AND\_SELLING HTTPS RETURNS\_POLICY ASPECTS\_ADOPTION Finding Listings to Optimize (Missing Required / Recommended Aspects) © 2020 eBay. All rights reserved.8 ComplianceAPI: getListingViolations Finding Listings to Optimize (Missing Required / Recommended Aspects) ComplianceAPI: getListingViolations–(New Response) © 2020 eBay. All rights reserved.9 New ComplianceType-ASPECTS\_ADOPTION ComplianceState -Represents whether the listing is currently non-compliant or may be non-compliant very soon. A container that contains recommendations for the missing aspects Aspect Renames –Handling in the Listing API © 2020 eBay. All rights reserved.10 eBay will handle renames for existing aspects to a new like-for-likeaspect. We will match these on your listings automatically when your items are renewed (GTC), relisted, or revised. If the aspect has changed, and there is no exact match, we won’t do this / you will need to update these listings. Examples: BICYCLES (177831): From Type to Bike Type PRINTERS (1245): From Supported Printing Sizes to Supported Paper Sizes DVD & Blu-Ray Players (175711): From Recordable Disk Formats to Recordable Media Format Live Demos Fetch Aspects TradingAPI: GetCategorySpecifics Fetch AspectsFind Listings to Optimize TaxonomyAPI: getAspectsForCategory ComplianceAPI: getListingViolations 11© 2018 eBay. All rights reserved. Easily Capture / Identify Taxonomy Changes Taxonomy Metadata SDK https://github.com/eBay/taxonomy-sdk eBay's Category & Aspects metadata continually evolves. §With each Taxonomy Metadata Release: oChanges occur for Categories, Aspects, Aspect Values oEach can get added, modified, removed §It is vital for developers to keep this metadata in sync, gain understanding into what might have changed, highlight this to sellers. §Historically this has been a manual, painstaking, resource intensive process (Metadata Trees are Large, Complex) This just got easier.... eBay has created / open sourced an all new Taxonomy Metadata SDK -to support quick, efficient, identification of all metadata changes in a Taxonomy Metadata Release. This is now available to all developers! https://github.com/eBay/taxonomy-sdk/blob/master/schema/OutputSchema.json Investing in Aspect Adoption: Why do any of this? © 2020 eBay. All rights reserved.13 Increased Aspect Adoption is a direct lever for seller sales growth, full stop. For example in Home & Garden for UK, with the experience improvements eBay has made to our own seller tools, we saw an 18% increase in aspect adoption\*leading to an increase in conversion\* With what we have released in API’s, you can now make similar improvements to the seller tools you offer, to achieve similar impact for your sellers. If this is not compelling, I don’t know what is. \* Based on Test Experimentation run with and without Aspect Adoption Improvements in in seller tools H2 2019, H1 2020 Investing in Aspect Adoption: A Developer’s Own Experience © 2020 eBay. All rights reserved.14 Developer Testimonial: Tool Station Developer Reported 9 X In Sales Volume due to increased adoption of aspects Full API Spec / Details © 2020 eBay. All rights reserved.15 Trading API:GetCategorySpecifics(SOAP) -Legacy https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetCategorySpecifics.html Taxonomy APIs (REST) -Current https://developer.ebay.com/api-docs/commerce/taxonomy/static/overview.html Compliance APIs (REST) -Current https://developer.ebay.com/api-docs/sell/compliance/static/overview.html Taxonomy Open Source SDK -Current https://github.com/eBay/taxonomy-sdk Boost Sales With Offers to Buyers Offers to Buyers Seize opportunity Activate buyers that have “shown interest” in your items, but are on the fence. Send them a private offer. Control velocity / Perform Price Discovery Sellers control when to send offers, how long they last. Great way to drive conversion, discreetly test buyer / price sensitivity. Win-win A great deal is a win for buyers and sellers! WebAPI February -2019 October -2019 Offer Growth -Offers Sent -GMV Offers to Buyers Staggering growth in first 14 months, have surpassed 1.5M offers / day\* \* Data as of Q1 2020 Negotiation API: find\_eligible\_items Step 1: Find Listings with Interested Buyers Use find\_eligible\_items to find all listings for a seller that have “Interested Buyers”. “Interested Buyers” are buyers who have shown explicit or repeated interest in an Listing. ie -buyers watching a listing, or placing listings in their cart. “Interested Buyers” logic continues to expand and grow. 18© 2018 eBay. All rights reserved. Sample Response: { "href": "/sell/negotiation/v1/find\_eligible\_items?offset=0&limit=10", "eligibleItems": \[ { "listingId": "133455295099" }, { "listingId": "133458379202" }, { "listingId": "143650859736" } \], "limit": 10, "offset": 0, "total": 3 } Sample Request: https://api.ebay.com/sell/negotiation/v1/find\_eligible\_items Negotiation API: send\_offer\_to\_interested\_buyers Step 2: Send Offer to Interested Buyers Use send\_offer\_to\_interested\_buyers to send offers to “Interested Buyers”. Set item id, a personalized message, discount amount, counter offer status, offer duration. eBay takes care of the rest. ONEinvocation of send\_offers\_to\_interested\_buyers sends the offer to ALLinterested buyers. Buyers receive app notifications, messages from ebay, and calls to action across the site. Buyers Accept, Counter, or Decline Offers 19© 2018 eBay. All rights reserved. Sample Request: https://api.ebay.com/sell/negotiation/v1/send\_offer\_to\_interested\_buyers { "message": "Great News! Get my item at a discounted price.", "offeredItems": \[ { "quantity": "1", "listingId": "143650859736", "discountPercentage": "5" } \], "allowCounterOffer": "false", "offerDuration": { "unit": "DAY", "value": "2" } } Sample Response: { "offers": \[ { "offerId": "8252262110", "revision": "56330652011", "message": "Great News! Get my item at a discounted price.", "buyer": { "maskedUsername": "\*\*\*\*\*\*\*\*" }, "creationDate": "2020-07-06T16:48:13.850Z", "lastModifiedDate": "2020-07-06T16:48:13.850Z", "offerDuration": { "value": 2, "unit": "DAY" }, "offerStatus": "PENDING", "initiatedBy": "iamjain", "offeredItems": \[ { "listingId": "143650859736", "quantity": 1, "discountPercentage": "5" } \], "allowCounterOffer": false, "offerType": "SELLER\_INITIATED\_OFFER" }, { "offerId": "8248762214", "revision": "56330651011", "message": "Great News! Get my item at a discounted price.", "buyer": { "maskedUsername": "\*\*\*\*\*\*\*\*" }, "creationDate": "2020-07-06T16:48:13.850Z", "lastModifiedDate": "2020-07-06T16:48:13.850Z", "offerDuration": { "value": 2, "unit": "DAY" }, "offerStatus": "PENDING", "initiatedBy": "iamjain", "offeredItems": \[ { "listingId": "143650859736", "quantity": 1, "discountPercentage": "5" } \], "allowCounterOffer": false, "offerType": "SELLER\_INITIATED\_OFFER" } \] } Live Demos Find Listings With Interested Buyers Negotiation API: find\_eligible\_items Send Offers To Buyers Buyers Review / Respond To O f fe r s Negotiation API: send\_offer\_to\_buyers eBay Web Experience & Native Apps 20© 2018 eBay. All rights reserved. Selling Feed API –New! Selling Feed API (New) Programmatic Feed Management! Conduct Bulk Actions with Greater Ease and Flexibility than Ever Before: •Create Task Requests, Check Task Status, Get Result File Download URLS all via simple REST endpoints. •Fetch Operations → ie Fetch Order Reports •Bulk Actions → ie Update Order Status. •Both upload and download feed files are mass processed asynchronously by eBay. •The status of all upload and download tasks are tracked with a unique 'task ID'. •Each report can be customized with date ranges and other filter criteria. Supported Use Cases: Order Reports, Order Fulfilment, Customer Service Metrics (July). https://developer.ebay.com/api-docs/sell/feed/static/overview.html General WorkflowExample: Order Report API Enhacements Based on Your Feedback API Enhancements Based on Your Feedback © 2020 eBay. All rights reserved.24 §Analytics API -https://developer.ebay.com/api-docs/sell/analytics/overview.htm oSupport for customer service metrics (Available Now) §Marketing API -https://developer.ebay.com/api-docs/sell/marketing/overview.html oPromoted listings enabled in FRITES and CA (Available Now) oThe max number of items per campaign increased to 50K (Available Now) §Inventory API -https://developer.ebay.com/api-docs/sell/inventory/overview.html oSupport for charity donation percentage when creating offers enabled (Available Now) oSupport for auctions, secondary category, scheduling listings, and specifying availability across warehouse locations (Available Q1) --- # Unknown eBay Connect 2021 Tanya Vlahovic Head of Developer Ecosystem Other API Updates Selling on eBay Shipping rate tables available in US, CA, AU, UK, DE, IT Buying on eBayMore General availability Geo-expansion Authenticity verification Certified refurbished Support for managed payments EU VAT eBay items widget 2© 2021 eBay. All rights reserved. New language pairs in the Translation API Notification API SDKs for notifications Shopping API: Authorization OAuth 2.0 authorization Enforcement on 7/1/2021 © 2021 eBay. All rights reserved.3 API Deprecations Recommendations in Add/Revise/Verify Item API responses Selling Manager APIs Revise Checkout Status Business Policies APIs Get Category Specifics Custom Stores related capabilities in Trading API Quantity and start price in Revise Inventory Status API response © 2021 eBay. All rights reserved.4 RSS Feed on Developer Portal RSS feed for API Deprecation Status API Status © 2021 eBay. All rights reserved.5 What is Next? © 2021 eBay. All rights reserved.6 Date / TimeContent June 15 –16eBay Connect Virtual Lounge July 12 @ 9 AM PT All About APIs Buyer Experience Media API Buy APIs Fulfillment API Security Updates New Notifications Fireside Chat With eBay Chief Architect Randy Shoup July 13 –14eBay Connect Virtual Lounge developer.ebay.com --- # Unknown eBay Connect 2020 Translation API Shruti Hulmani Senior Product Manager, Developer Ecosystem eBay Connect 2020 Agenda Why Translate? Translation API Sample Experience Demo © 2020 eBay. All rights reserved.2 A Truly Global Marketplace 96% of U.S. small businesses export 57% export to 10 or more countries 182M Active buyers 1.5B Live listings 190 Markets Q2 2020 Crossing the Language- Barrier Connect buyers and sellers Promote cross-border trade In-house trained NLP models and state-of-the-art algorithms © 2020 eBay. All rights reserved.4 Content + Photo Translation Context © 2020 eBay. All rights reserved.5 Optimized for ecommerce Item title and description Supported Languages © 2020 eBay. All rights reserved.6 FromTo (en) English(de) German (en) English(zh) Chinese (Mandarin) (en) English(ja) Japanese (en) English(fr) French (en) English(it) Italian (en) English(es) Spanish (de) German(fr) French (de) German(it) Italian (de) German(es) Spanish (ja) Japanese(en) English Translation API: Request and Response © 2020 eBay. All rights reserved.7 Request { "from": "en", "to": "de", "text": \[ "Welcome to eBay" \], "translationContext": "ITEM\_TITLE" } Response { "from": "en", "to": "de", "translations": \[ { "originalText": "Welcome to eBay", "translatedText": "WillkommenbeieBay" } \] } POST https://api.ebay.com/commerce/translation/v1\_beta/translate Translations in Action Translations in Action Translations in Action Translations in Action Demo --- # Unknown eBay Connect 2023 Advertising Emily Wu Sr. Product Manager, Ads Promoted Listings Standard New release: Dynamic ad rate strategy Easily stay competitive in the marketplace with ad rates that automatically adjust to match eBay’s daily suggestions. Dynamic ad rate Stay competitive with ad rates that automatically updated to match eBay’s daily suggestions Control costs with ad rate caps and custom adjustments Fixed ad rate Manually select an ad rate that will not change unless edited 3© 2023 eBay. All rights reserved. Ad rate strategies Ad rate strategy update 4© 2023 eBay. All rights reserved. APIChangeDetails createCampaignAdd new optional fields "fundingStrategy" : { "adRateStrategy" : "AdRateStrategyEnum : \[DYNAMIC,FIXED\]", "bidPercentage" : "string", "dynamicAdRatePreferences" : \[ { /\* DynamicAdRatePreference \*/ "adRateAdjustmentPercent" : "string", "adRateCapPercent" : "string" } \], "fundingModel" : "FundingModelEnum : \[COST\_PER\_SALE,COST\_PER\_CLICK\]" }, ●adRateStrategy ○If not provided, the default value would be “FIXED” ●dynamicAdRatePreferences ○Applicable when adRateStrategy is “DYNAMIC” ○Optional fields ■adRateCapPercent ■adRateAdjustmentPercent getCampaign related APIs API to get the entire campaign settings, including newly introduced optional adRateStrategy and dynamicAdRatePreferences fields updateAdRateStrategyNewly introduced API API to update ad rate strategy after the campaign is created. Valid use cases are ●Switch from DYNAMIC to FIXED ●Switch from FIXED to DYNAMIC ●Update dynamic ad rate preferences 5© 2023 eBay. All rights reserved. APIChangeDetails createCampaignAdd new optional fields "fundingStrategy" : { "adRateStrategy" : "AdRateStrategyEnum : \[DYNAMIC,FIXED\]", "bidPercentage" : "string", "dynamicAdRatePreferences" : \[ { /\* DynamicAdRatePreference \*/ "adRateAdjustmentPercent" : "string", "adRateCapPercent" : "string" } \], "fundingModel" : "FundingModelEnum : \[COST\_PER\_SALE,COST\_PER\_CLICK\]" }, ●adRateStrategy ○If not provided, the default value would be “FIXED” ●dynamicAdRatePreferences ○Applicable when adRateStrategy is “DYNAMIC” ○Optional fields ■adRateCapPercent ■adRateAdjustmentPercent getCampaign related APIs API to get the entire campaign settings, including newly introduced optional adRateStrategy and dynamicAdRatePreferences fields updateAdRateStrategyNewly introduced APIAPI to update ad rate strategy after the campaign is created. Valid use cases are ●Switch from DYNAMIC to FIXED ●Switch from FIXED to DYNAMIC ●Update dynamic ad rate preferences Ad rate strategy update 6 createCampaign { "adRateStrategy": "DYNAMIC", "dynamicAdRatePreferences": \[ { "adRateAdjustmentPercent": "5", "adRateCapPercent": "30" } \] } updateAdRateStrategy { "campaignName": "Summer Sale", "startDate": "2023-06-07T21:43:00Z", "fundingStrategy": { "adRateStrategy" : "FIXED", "bidPercentage": "10.0", "fundingModel": "COST\_PER\_SALE" }, "marketplaceId": "EBAY\_US" } © 2023 eBay. All rights reserved. Example: Create a Promoted Listings Standard campaign with FIXED as the ad rate strategy and 10% as the ad rate Example: Update an existing Promoted Listings Standard campaign to have Dynamic as the ad rate strategy with 5% adjustment and 30% as the cap API Details --- # Unknown © 2021 eBay. All rights reserved.2 © 2021 eBay. All rights reserved.3 © 2021 eBay. All rights reserved.5 • • • © 2021 eBay. All rights reserved.6 © 2021 eBay. All rights reserved.7 © 2021 eBay. All rights reserved.8 © 2021 eBay. All rights reserved.9 • • © 2021 eBay. All rights reserved.12 © 2021 eBay. All rights reserved.13 © 2021 eBay. All rights reserved.14 Sell BuyCommerceDeveloper \* Limited Release --- # Unknown eBay Connect 2021 EU VAT & IOSS Mohit Kumar, Sr. Director, Product Management Richard McCann, Lead Product Manager eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 EU VAT APIs being updated to pass IOSS info Trading API Fulfillment API Timing EU VAT: Background © 2021 eBay. All rights reserved.3 •July 1st, 2021: EU implements rules requiring marketplaces and platforms to collect VAT based on the delivery address of the goods •eBay is responsible for collecting and remitting VAT for certain tax scenarios (Low value imports and Foreign Sellers, fulfilling from inventory deployed in the EU) •EU 27 Countries each with their own rates •As low as 17% and as high as 27% •1-2 Reduced Rates: Countries may have additional lower rates for items like books, food, baby or hygiene products EU VAT: eBay Collect & Remit Scenarios 4© 2021 eBay. All rights reserved. ScenarioPolicy Detail Imports into EU•Order value is <= 150 EUR and located outside of the EU, eBay is responsible for collecting and remitting VAT. •eBay will not collect VAT from buyers with a verified EU VAT ID. Domestic / Intra EU -Foreign Seller •Item’s location within the EU, but the seller is registered outside of the EU (foreign seller), eBay is responsible for collecting and remitting of VAT. No thresholds. •eBay will not collect VAT from buyers with a verified EU VAT ID AND the seller also has a verified VAT ID from the “ship from” country. IOSS & Customs © 2021 eBay. All rights reserved.5 •For shipments arriving at EU Customs where eBay has already collected VAT, we want to ensure that buyers do not get charged with additional VAT by customs. •To avoid additional VAT at the border, sellers must provide eBay’s IOSS # number on the electronic customs declaration. Putting the IOSS # on the label is not enough. •To help our developers with this new challenge we are doing the following actions to help share our eBay IOSS # when we have collected EU VAT on an import. •1. Passing the IOSS # on specific APIs •2. Displaying the IOSS # on order details/packing slips •IOSS # should only be used when eBay has collected EU VAT on an import. •eBay’s EU IOSS Number is IM2760000742 APIs being updated to pass IOSS info Fulfillment API Trading API §GetOrders §GetOrderTransactions §GetItemTransactions §GetSellerTransactions Sell Feed API Business buyer VAT ID & eBay reference 7© 2021 eBay. All rights reserved. ScenarioNameValue EU importsIOSSeBay EU IOSS number EU domestic ordersOSSeBay DE VAT ID UK importsIOSSeBay UK IOSS number AU importsABNeBay AU tax number NZ importsIRDeBay NZ tax number Norway importsVOECeBay NO number 1. Business Buyer VAT ID New VATIN buyer tax identifier added 2. eBay Reference ebayTaxNumber "eBayReference":{ "name":"IOSS" "value":"ebayTaxNumber" } Trading API Fulfillment API <...Response> : true : : IM2760000742 16.8 GST GST 16.8 : : : VATIN AT 213234234 : Trading API © 2021 eBay. All rights reserved.8 eBay reference For IOSS scenarios “name”: “IOSS” “value”: “IM2760000742” \* For OSS scenarios “name”: “OSS” “value”: “DE 1111111111” (eBay’s VAT ID) Business buyer VAT ID New VATIN buyer tax identifier added Trading API: Shipping address street 2 upcoming changes © 2021 eBay. All rights reserved.9 OrderArray.Order.ShippingAddress.Street2 TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.Street2 Shipping address street2 field will be repurposed to include eBayReferencefor API version < 1211. E.g., IOSS: IM2760000742 , OSS: 1234567 Shipping address street2 decoration will not be available for versions 1211and above. After 1/31/2022, all shipping address street 2 decorations will be removed for all of the API versions. Fulfillment API © 2021 eBay. All rights reserved.10 eBay reference For IOSS scenarios “name”: “IOSS” “value”: “IM2760000742” \* For OSS scenarios “name”: “OSS” “value”: “DE 1111111111” (eBay’s VAT ID) { ... "ebayCollectAndRemitTaxes": \[ { "amount": { "convertedFromCurrency":\[AED,AFN,ALL...\]", "convertedFromValue": "string", "currency": \[AED,AFN,ALL...\]", "value" :"string" }, "taxType": "\[GST,...\]", "eBayReference":{ "name":"string" "value":"string" }, "collectionMethod" : "\[INVOICE,NET\]" } \], ... } Fulfillment API © 2021 eBay. All rights reserved.11 Business buyer VAT ID New VATIN buyer tax identifier added { ... "buyer": { "taxAddress": { "city": "string", "countryCode": "\[AD,AE,AF...\]", "postalCode": "string", "stateOrProvince": "string" }, "taxIdentifier": { "taxpayerId": "string", "taxIdentifierType": \[VATIN,DNI,...\]", "issuingCountry": "\[AD,AE,AF...\]" }, "username" : "string" } ... } Fulfillment API © 2021 eBay. All rights reserved.12 Item location At the line item level { ... "lineItems": \[ { ... "itemLocation": { "location": "string", "countryCode": "\[AD,AE,AF...\]", "postalCode" : "string" } ... } \] ... } Timings © 2021 eBay. All rights reserved.13 Live in sandbox: By end of June Live in production: By end of June Visit developer.ebay.com for updates --- # Unknown eBay Connect 2021 Empowering API sellers to grow faster Scot Hamilton Vice President, Seller Experience Engineering eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Bring your listing to life with Video Drive sales, repeat buyers, with Coded Coupons Discover and unlock potential with Terapeak API enhancements based on your feedback Bring your listings to life with video Life cycle of a video upload © 2021 eBay. All rights reserved.4 ProcessingModerationLIVE on Site BLOCKED By Moderation Create Video Object ID FAILED Processing Upload Video Create Video Object ID Attach Video Object ID to Listing Media API Trading API (or LMS) Step 1Step 2 Step 3 •Video Object ID’s can be attached to a listing right after step 2 •Moderation runs in parallel •Videos are visible to buyers after passing moderation Media API: Upload videos to eBay © 2021 eBay. All rights reserved.5 Step 1: Create Video •Initialize Video to eBay using Media API createVideo •Obtain the unique Video ID for the uploaded video Step 2: Upload Video •Upload Video to eBay using Media API Upload •Capture upload response Things to note: •Supported Format(s): .mp4 •(MPEG-4 Part 10, or MPEG-4 AVC) •Max Size: 150 MB •Max Length: < 1 min •eBay will moderate content, and •Reserves the right to take down •Retention: 365 Days (behavior while in beta, subject to change) Step 1 –Create video: Sample request: POST https://apim.ebay.com/commerce/media/v1\_beta/video { /\* CreateVideoRequest\*/ "classification" : \[ "Classification : \[ITEM\]" \], "size" : "integer", "title" : "string", "description" : "string" } /\* returns videoID \*/ Step 2 –Upload video: Sample response: POST https://apim.ebay.com/commerce/media/v1\_beta/ video/{video\_id}/upload New features: Video Attach video to listing © 2021 eBay. All rights reserved.6 Step 3: Attach video to listing •Attach Video to listings using Trading API, Large Merchant Services -Live Now •Trading API -Supported Operations •AddItem •AddItems •AddFixedPriceItem •ReviseItem •ReviseFixedPriceItem •RelistItem •RelistFixedPriceItem •Available for all US listings •Inventory API, MIP, and File Exchange coming in Q3 Step 3 –Attach video to item: en\_US 1193 High 8d1f40c81760a4e24976c322ffffff33 10 11 Video test 1 ..... Videos on View Item © 2021 eBay. All rights reserved.7 Mobile: Now live! Desktop: Coming Q3 Live demo: Listings with videos! Drive sales, repeat buyers with Coded Coupons Coded Coupons: Highly visible, everywhere. 10 Highly visible! ●Buyer Engagement at every stage of the purchase funnel ●Search, View Item, Checkout ●Mobile and Desktop! Coded Coupons: Rapid adoption, rapid impact 11 Fast, easy, effective. ●Sellers love creating them! ●Buyers can’t resist them! ●Fastest adopted, most impactful velocity driver, ever. (Rivaled only by last year’s launch of Seller Initiated Offer) Marketing API: Coded Coupons (launches in Q3) © 2021 eBay. All rights reserved.12 Support for new promotion type: CODED\_COUPON Feature Parity with existing Marketing API •discountRules •inventoryCriterion •ruleCriteria New Attributes for Coded Coupon •couponCode •couponType : PromotionSubTypeEnum •maxCouponDiscountAmount •maxCouponRedemptionPerUser •setABudget •budget Note: This is planned for an upcoming release and the specification might be slightly different from what is depicted above. POST https://api.ebay.com/sell/marketing/v1/item\_promotion ..... { "promotionType": “CODED\_COUPON", "startDate": "string", "couponCode": "string", "couponType": "PromotionSubTypeEnum: \[PRIVATE\_SINGLE\_SELLER\_COUPON, PUBLIC\_SINGLE\_SELLER\_COUPON\]", "maxCouponDiscountAmount": { "currency": "CurrencyCodeEnum : \[....\]", "value": "string" }, "maxCouponRedemptionPerUser": "integer", "setABudget": "boolean", "budget" : { "currency": "CurrencyCodeEnum : \[...\]", "value": "string" } .... } GET https://api.ebay.com/sell/marketing/v1/item\_promotion/{promotion\_id} Live demo: Marketing API –Coded Coupons (Sneak peak, launching in Q3) Discover, and unlock potential with Terapeak Terapeak product research © 2021 eBay. All rights reserved.15 ●Identify sourcing opportunities, price trends, sell-through rates and other key sales metrics for any listing sold in the past year ●Perform deeper analysis using powerful filters to narrow down to a smaller subset of specific listings ●Interpret data visually using charts and trendlines Terapeak Beta API available to limited partners in Q3 ‘21 © 2021 eBay. All rights reserved. Evaluating an access control approach that would provide API access to qualifying accounts that meet sales and or other seller quality benchmarks Access to the same data available through Terapeak Product Research in Seller Hub, including aggregate metrics and details of sold items Connect with your eBay Developers Program representative to be added to a waitlist for access to the Terapeak Beta API Support for ‘Product Research’ Access control Sign-up to be added to the waitlist •Tiered Access Based on: •Account Type •Category Sales Volumes •Call Volume, Category Breadth. •1-3 full years of transaction history •Auction, Fixed Price, Best Offer •PL Usage, Marketing Tool Usage •1 full year of unsold items •Research and “Sell Past Purchase” Sign up fast. Beta spots are limited. Live demo: Terapeak API –Product Research (Sneak peak, launching in Q3) API enhancements based on your feedback. API enhancements based on your feedback. © 2021 eBay. All rights reserved.19 Inventory API -https://developer.ebay.com/api-docs/sell/inventory/overview.html •Support for (now live) •Auctions •Secondary Category •Scheduling listings •Specifying availability across warehouse locations Recommendations API •Support for (now live) •item-level recommended bid percentages for Promoted Listing campaigns and •formerly only available at category-level, trending recommendations Fulfilment API •Support for (now live) •Authenticity Guarantee •BOPIS -Proof of Pickup •Advanced Payment Dispute •Tax Location Fields --- # Unknown eBay Connect 2023 Advertising Jay Chen Head of Ads Global Partner Development, eBay Ads eBay Connect 2023 Agenda © 2023 eBay. All rights reserved.2 eBay Advertising Promoted Listings Advanced API Updates Global Ads Partner Development; Who are we? About Me In Advertising Industry for 11+ years and Tech for 6+ years •Started agency side and transitioned to tech and partnerships in 2017 •Energized by the constant evolution of technology Product, Partnerships, and Business Development •Started in eBay Ads within the Product and Engineering organization focused on Product Partnerships •In 2023, took over management of the Global Ads Partner Development (Product + GTM) 2023 vision and onward •Revamp how eBay Ads approaches Partnerships, API development, and support eBay Advertising Proprietary + Confidential Advertising solutions for sellers of all sizes and expertise looking to drive sales. Choose the campaign type that’s right for your business. Promoted Listings Standard Promoted Listings Advanced What it is Cost model Listing format Placement Connect your items with the right buyers across the eBay network, including search and listing pages, and you only pay when you sell. Cost-per-sale (CPS) Fixed price Eligible to appear in over 100+ placements across the eBay network Grow your business and drive sales with preferred access to premium ad placements. Cost-per-click (CPC) Fixed price Best for Sellers who need guided setup, automation. Sellers who need velocity, predictability & standardization. Listings that are popular/trending items. Preferred access to premium placements including top of search. API Available API Available Ad products to meet your needs $285M Revenue from Promoted Listings in Q1 2023 2M+ Over 2 million sellers used Promoted Listings in Q1 2023 50% additional sales, on average, sellers see when using Promoted Listings Advanced BETA , compared to non-promoted items.\* \*Sept ‘22 - Feb ‘23 eBay Ads stats 6© 2023 eBay. All rights reserved. Advertising Business Promoted Listings Advanced Updates and Product Roadmap Expand opportunities to reach buyers with Promoted Listings Advanced 8 1.Unlock preferred access to premium placements on eBay, including the top of the search results page. 2.Scale the impact of your keywords with additional keyword match type options, like broad match. 3.Use features like quick setup and suggested keywords/bids that help you easily create, expand, and manage campaigns. © 2023 eBay. All rights reserved. Product Releases : Promoted Listings Advanced Q4 2022 Launch on eBay.ca, cafr.eBay.ca sites Launch quick setup campaign API - Transaction report enhancements Q1 2023 Launch broad match Expand the definition of click attribution Expand placements Q3 2022 API - Documentation changed via restricted access to general availability\* API - Playbook transitioned via PDF to developer.ebay.com Top 4 slots of search H2 2023 Exited BETA July ‘23 Dynamic bidding (Upcoming) \*Note: While API documentation is now publicly available, integrators who have not been approved for Promoted Listings Advanced API integration, will not be able to leverage the applicable endpoints in the production environment. Global Ads Partner Development Team (AGPD) Who are we? AGPD Team Introduction and Support 11 Objective: Support strategic 3rd-party partners (3PPs), so that they accelerate the velocity of eBay sellers working with them through the use of Promoted Listings. How do we do this? We collaborate with select 3PPs (Invite-Only) through Joint Business Plan (JBPs) to align on mutual goals and objectives for Product and GTM support. Team Structure: © 2023 eBay. All rights reserved. Head of Ads Global Partner Development Product Partnerships TeamGTM Partnerships Team Product Partnerships Manager (Product Flywheel Consulting) Technical Account Manager (White-Glove Technical Support) GTM Partnerships Manager (Joint Business Plan Project Lead) Advise on strategic product changes and collaborate with partners to build feature capabilities through API integration. Technical support through resolving API issues, inquiries, and documenting API feature requests within Service-Level-Agreements to expedite product enhancements. Lead overall JBP through co-marketing webinars, trainings, promos, incentives, and case studies to scale business growth. Partner Consulting Example: 12 PLA Campaign Quick Setup © 2023 eBay. All rights reserved. Product Partnerships Product Partnerships ManagerTechnical Account Manager Product Flywheel ProjectWhite-Glove Technical Support Identify pain-points from sellers: •“Most eBay sellers feel difficult to create PLA campaigns properly.” Share eBay’s plan to resolve it via eBay UI(Demo) Consult partners to build within their solution via API, providing guidance throughout the process Provide technical support when partners get stuck in leveraging API solution: •Explain technical details how to build solution based on the existing campaign creation method in API documentation. •Partner’s feature request to eBay: Request an API endpoint for PLA campaign quick setup solution (Upcoming) Reach out to DECO if you’re interested in learning more! A seller wants to create a CPC Promoted Listings campaign Call createCampaign to create and establish the structure of a CPC Promoted Listings campaign Call suggestitems to see which listings are prime for a CPC Promoted Listings campaign Call createAdGroup to create an ad group in the CPC Promoted Listings campaign Call createAdsByListingId or bulkcreateAdsByListingId to add listings to the ad group Call suggestKeywords to see which keywords are recommended for the ad group and its listings Call suggestBids to see which bids are recommended for the keywords Call createKeyword or bulkcreateKeyword to add keywords to the ad group Use the CPC Promoted Listings reports to monitor your campaigns --- # Unknown eBay Connect 2022 Shipping and Member Communications Erik Selberg VP, Shipping and Member Communications eBay Connect 2022 Agenda © 2022 e Bay. All rights reserved. 2 Shipping & Member Communications Progress eBay International Shipping Shipping & Member Communications Customer Problem •In US, the native labels app is outdated, and doesn’t support several recent carrier additions like UPS and eBay Standard Envelope •In DE / UK, we didn’t have support to purchase labels on native Approach •Modernize the tech stack to allow a global solution for shipping labels, with extended functionalities Why is it important •Users are increasingly using native app to conduct their business, including to buy shipping labels •Sellers without printer, can use their mobile to purchase a label and download a QR code to present to the carrier Status •Fully live in UK, DE and US. Additional features (egsupport for international carriers in US) coming later in Q4 Labels on Native app (UK / DE / US) © 2022 e Ba y. Al l ri ghts reserve d.4 Customer Problem •Users need access to a variety of carrier services for their needs –whether it’s for international shipments, age- verification, or tracked services Approach •Expanded services in UK with the launch of Royal Mail International •Expanded services in DE with the launch of Deutsche Post Prio, and DHL Age Verification Why is it important •Increase the value proposition of eBay Label platform as one-stop-shop for sellers, who can use their proceeds to buy labels on-platform in a convenient and easy way Status •Fully launched New carrier services on labels platform © 2022 e Ba y. Al l ri ghts reserve d.5 Customer Problem •eBay fulfillment was launched in DE in 2020 to help sellers meeting retail standards, by forward deploying inventory to professional warehouses managed by eBay partners Approach •After launching UK and DE last, we further increased our presence with eBay Fulfillment in Australia and Italy, with US coming soon •New features launched this year include multi-listing and multi-SKU support, optimization of delivery estimates, weekend operations, listing and order limits exemption for eBay fulfillment items Why is it important •eBay Fulfillment increases velocity for sellers by making it easier to meet retail standard and earn top rated status Additional benefits •Sellers are protected against any delivery related defects •Multichannel fulfillment •Integration with third-party providers such as Linnworks,ChannelAdvisor Status •Fully launched in DE / UK / AU / IT. Expansion to US is planned for September eBay Fulfillment expansion © 2022 e Ba y. Al l ri ghts reserve d.6 Customer Problem •Sellers today are not given intuitive feedback to correct mistakes when providing tracking numbers for their shipments to eBay.As a result, buyers do not know when their item will arrive, causing anxiety when shopping on eBay.This also impacts seller standards due to invalid tracking. Approach •Improved iOS and Android label barcode scanning •Guide sellers intuitively to provide accurate tracking •A consistent experience across eBay with better messaging Why is it important •Improvement in valid shipment tracking on eBay (more buyers know when their item will arrive) •Reduction in Item Not Received claims •Reduction in customer service contacts Additional benefits •Modularized UX for easy internal partner team onboarding •Autocompletes carrier name on behalf of seller •Machine Learning + Regular Expression matching iteratively improves accuracy of carrier prediction Status •Fully launched in all markets / platforms Add / Edit Tracking Seller Tools © 2022 e Ba y. Al l ri ghts reserve d.7 Customer Problem •Information overload for buyers and sellers: delivery date estimates, package location and other status updates aren't clear •Users aren't provided updates or warnings around delays due to weather, COVID, unrest, and general carrier issues Approach •A curated experience that highlights the most important information, and improve messaging when something goes wrong •Add contextual messaging to help the user understand exactly where their package is and when it will arrive Why is it important •Buyer NPS improvement •Reduction in Item Not Received claims •Reduction in Customer Service contacts Additional benefits •Modularized UX for easy internal partner team onboarding, such as the INR, Returns, and Help Hub experiences Status •Fully launched in all markets / platforms New Shipment Tracking Experience © 2022 e Ba y. Al l ri ghts reserve d.8 NewOld Customer Problem •As a customer, I expect a modern and easy to use messaging system to communicate with buyers and sellers. Approach •Move to a modern chat-like experience; it’s familiar and expected by modern apps and sites.Build more tools for sellers that help them manage and respond to messages. Why is it important •It provides members with full context of a conversation, helping resolve questions or concerns quickly •Supporting consistent and seamless experience across all devices keep users informed Status •iOS and Android: Optall users to the new experienceglobally (with option to opt out) by Oct •Desktop: Beta starts mid-September globally M2M Modernization © 2022 e Ba y. Al l ri ghts reserve d.9 eBay International Shipping Delivering customers extraordinary value © 2022 e Ba y. Al l ri ghts reserve d.11 International buyers want US products.. © 2022 e Ba y. Al l ri ghts reserve d.12 I am unsure which international shipping service is right for me It takes too long to reach buyers I cannot afford the international shipping fee and hassle of customs I am concerned about fraudulent returns andcosts I don’t know the buyer country regulations and restrictions I am worried that my items get lost or damaged during transit ..but sellers have their barriers to shipping internationally © 2022 e Ba y. Al l ri ghts reserve d.13 •<50% of inventory available internationally on Big 3 sites •Expensive and slow shipping •Lack of taxes & duties options •Higher seller international fees vs domestic •International returns is a complex process International buyers are accessing a fraction of the inventory, while sellers are challengedwith complex shipping and returns Problem Statement Global Shipping Program (GSP): Challenges © 2022 e Ba y. Al l ri ghts reserve d.14 © 2022 e Ba y. Al l ri ghts reserve d.15 A new shipping program to simplify seller experience, maximize inventory exportability, and provide competitive options to buyers internationally Introducing eBay International Shipping (eIS) eBay International Shipping: Customer Journey © 2022 e Ba y. Al l ri ghts reserve d.16 How does eBay International Shipping compare to GSP Ship to Domestic Hub eISGSP 17© 2022 e Ba y. Al l ri ghts reserve d. Intermediated Intl leg Customs Compliance Seller Protections Shipping speed and tracking Seller Intl shipping fee Buyer choice Duties and Taxes Lower Shipping costs Intermediated Returns 17 © 2022 e Ba y. Al l ri ghts reserve d.18 APIs eBay Developers Program •Seller enrolled in the program at the account level •Client doesn’t require the seller intent at the listing level •All listings are automatically processed for qualification •Listing API •No changes to Business Policies ,Trading API, GetItem API •Order Fulfillment API •eBay International Shipping as a program •shipToand finalDestinationaddresses --- # Unknown Managed Payments APIs June 26, 2019 Shan Vosseller VP of Product, Payments What’s new with managed payments Payouts, transactions & orders New APIs Changes to existing APIs 1 2 3 4 Agenda We now have the ability to control and enhance all payments-related functions on eBay itself! No more logging into PayPal, or calling PayPal APIs –it is all happening on eBay Managed payments fundamentally changes eBay BeforeAfter Onboarding Register on eBay Register on PayPal, providing KYC and Bank information Register on eBay, providing KYC and Bank information Payouts Per order, to PayPal Account See status on PayPal web/API Per day/week/month, all orders See status on eBay Seller Hub Payment Tab/API Refunds Through PayPal web/API With cases through eBay returns and cancellations Through eBay Seller Hub/API Critical definitions for new and changed APIs Orders One or more items paid to the same seller in a single checkout Transactions Funds flowing in from orders to a seller’s payments balance on eBay Funds flowing out from returns, cancellations, and refunds from a seller’s payments balance on eBay Payouts A positive payments balance transferred to a seller’s bank account at the end of the day for all transactions that have cleared eBay’s account New APIs Account API Payments Program Fulfillment API Refunds, Unique Order ID Finances API Payouts & Transactions LMS OrderReport OrderAck SetShipmentTrackingInfo FeeSettlementReport OrderReport SoldReport Post Order API Submit Cancellation Request Check Cancellation Eligibility getGuestPurchaseOrder getPurchaseOrder Search Cancellations Changed APIs Trading API CompleteSale GetOrders GetOrderTransactions GetSellingManagerEmailLog GetSellingManagerSaleRecord ReviseCheckoutStatus ReviseSellingManagerSaleRecord SendInvoice GetItemTransactions GetOrders GetOrderTransactions GetSellerTransactions GetMyeBayBuying GetMyeBaySelling Account API Payments Program Eligible sellers can now opt-in to eBay’s managed payments offering This call returns the seller’s status for the specified payment program within a specific marketplace Account API: Payments Program Finances API Payouts & Transactions Phase one of the Finances API enable sellers to get payout status and balances for financial and reconciliation operations. You can now track your funds on eBay Get Payouts Get Transactions Demo Parameter NameTypeRequiredDescriptionLocation payee\_idstringtruepayee idtoken filter array:FilterField false payoutStatus \[SUCCEEDED, RETRYABLE\_FAILED, TERMINAL\_FAILED, REVERSED\] payoutDate query Get Payout Summary by Payee ID Endpoint: GET/sell/finances/v1\_alpha/payout\_summary Parameters: Get Payout Summary by Payee ID Sample response Get Payout by Payee ID Endpoint: GET /sell/finances/v1\_alpha/payout Parameters: Parameter NameTypeRequiredDescriptionLocation payee\_idstringtruepayee idtoken limitstringfalsepagination for lists of payouts, default value 20query vstringfalsepagination for lists of payouts, default value 0query sortarray:SortFieldfalsepayoutDatequery filter array:FilterField false payoutStatus \[SUCCEEDED, RETRYABLE\_FAILED, TERMINAL\_FAILED, REVERSED\] payoutDate query Sample response Get Payout by Payee ID Get Payout Endpoint: GET /sell/finances/v1\_alpha/payout/{payout\_id} Parameters: Parameter NameTypeRequiredDescriptionLocation payout\_idstringtruepayout idpath Sample response Get Payout Get Transactions Endpoint: GET /sell/finances/v1\_alpha/transaction Parameters: Parameter NameTypeRequiredDescriptionLocation payee\_idstringtruepayee idtoken limitstringfalsepagination for lists of payouts, default value 20query offsetstringfalsepagination for lists of payouts, default value 0query sortarray:SortFieldfalsetransactionDatequery filter array:FilterField false transactionStatus \[FUNDS\_ON\_HOLD, FUNDS\_PROCESSING, FUNDS\_AVAILABLE\_FOR\_PAYOUT, PAYOUT\] transactionType \[SALE, REFUND, CREDIT\] transactionDate buyerUsername salesRecordReference Payoutid transactionid query Sample response Get Transactions Get Transaction Summary by Payee ID Endpoint: GET /sell/finances/v1\_alpha/transaction\_summary Parameters: Parameter NameTypeRequiredDescriptionLocation payee\_idstringtruepayee idtoken filter array:FilterField false transactionStatus \[FUNDS\_ON\_HOLD, FUNDS\_PROCESSING, FUNDS\_AVAILABLE\_FOR\_PAYOUT, PAYOUT\] transactionType \[SALE, REFUND, CREDIT\] transactionDate buyerUsername salesRecordReference Payoutid transactionid query Sample response Get Transaction Summary by Payee ID Fulfillment API Seller Initiated Refunds You can now process full or partial refunds outside of claims and cancellation flows! Fulfillment API: Seller Initiated Refunds Fulfillment API: Seller Initiated Refunds Endpoint: GET /sell/fulfillment/v1/order/{order\_id}/issue\_refund Parameters: N/A Fulfillment API: Seller Initiated Refunds Sample requestSample response Unique Order IDs We have added a unique order ID to orders, visible to both buyers and sellers, requiring changes to order APIs Field NameCall Names (request)Call Names (response)API Name OrderIDCompleteSale GetOrders GetOrderTransactions GetSellingManagerEmailLog GetSellingManagerSaleRecord ReviseCheckoutStatus ReviseSellingManagerSaleRecord SendInvoice AddOrder GetItemTransactions GetMyeBayBuying GetMyeBaySelling GetOrders GetOrderTransactions GetSellerTransactions Trading API ExtendedOrderIDGetItemTransactions GetOrders GetOrderTransactions GetSellerTransactions N/ATrading API orderIdgetOrder createShippingFulfillment getShippingFulfillment getShippingFulfillment getOrder getOrders Fulfillment API orderIdsgetOrdersN/AFulfillment API legacyOrderIdN/AgetOrder getOrders Fulfillment API ExtendedOrderID N/AOrderReportLarge Merchant Services OrderIDOrderAck SetShipmentTrackingInfo FeeSettlementReport OrderReport SoldReport Large Merchant Services legacyOrderIdSubmit Cancellation Request Check Cancellation Eligibility Submit Cancellation Request Check Cancellation Eligibility Search Cancellations Post Order API purchaseOrderIdgetGuestPurchaseOrder getPurchaseOrder getGuestPurchaseOrder getPurchaseOrder Buy Order API legacyOrderIdN/AgetGuestPurchaseOrder getPurchaseOrder Buy Order API Seize the Opportunity! Give Feedback Come upstairs to meet with the team File a developer support ticket Talk about it at the developer council Start Now We will be moving sellers to managed payments Starting now will help you be ready for larger volumes over the next few years You’ll be able to offer new integrated payments capabilities in your application Let us Help If you don’t have a managed payments seller in your portfolio already, let us get you connected to one! Thank you! Q&A eBay Connect 2019 June 25-26, 2019 --- # Unknown eBay Connect 2020 All In For Aspects Michael Cuttone, Senior Director, Seller Experience Product Management eBay Connect 2020 Agenda Importance of Aspects Collecting Aspects Recap © 2020 eBay. All rights reserved.2 Importance of Aspects What are Aspects? © 2020 eBay. All rights reserved.4 Aspects are attributes that describe the item you’re selling. It’s important for these details to be filled in as accurately and fully as possible. Why fill them in? •Helps buyers find the item •Describes the item in a standardized, structured way giving buyers a clear overview of the item •Used by eBay to match to similar products Help Buyers Find Your Item Aspects have a direct impact on your visibility in search results. Aspects are used when buyers: •Search by keywords in the search box. Title + keywords used in search. Title is limited to 80 characters. •Filter using left nav and top page filters. If your item doesn’t have the aspects filled in, it will not be returned in the results. •Browse nodes –commonly visited by buyers clicking through search engines. © 2020 eBay. All rights reserved.5 UK Dresses Test © 2020 eBay. All rights reserved.6 Data shows listings populated with mandated aspects have higher conversion and GMV 82% 43% 35% Color Style Length Filteringallows quick & easy identification of suitable products Collecting Aspects Prioritize The Most Important Aspects © 2020 eBay. All rights reserved.8 Aspects are prioritized in two ways. Grouped by: •Required •Recommended •Additional Within in each bucket, ranked based on required soon and buyer demand data Developer Tip: Use Taxonomy API (AspectConstraint) or GetCategorySpecifics (MinValuesand UsageConstraints) to retrieve aspects Advance Notification of Required Soon © 2020 eBay. All rights reserved.9 Give sellers advance notice of aspects that will be required soon, along with date it will become required. Developer Tip: Use Taxonomy API for aspect details. Use Compliance API to find listings with missing required soon aspects (coming in Q3). Indicators in listing flow Filters and notifications for active listings Give Data to Show Impact © 2020 eBay. All rights reserved.10 Buyer demand data shows searches and filters used for the aspects in last 30 days. Used to populate the “recent searches” count in progress indicator. Developer Tip: Buyer Demand Data (BDD) available on a whitelist basis via Taxonomy API and GetCategorySpecifics. Gamify The Experience to Encourage Action © 2020 eBay. All rights reserved.11 Encourage sellers to fill in recommended aspects by gamifying the experience. Progress indicator shows fill-in as item specifics are populated.Total of possible searches shown based on buyer demand data.As values are provided, count increases. eBay Handles Aspect Renames © 2020 eBay. All rights reserved.12 Examples: BICYCLES (177831): From Type to Bike Type PRINTERS (1245): From Supported Printing Sizes to Supported Paper Sizes DVD & Blu-Ray Players (175711): From Recordable Disk Formats to Recordable Media Format eBay will handle renames for existing aspects to a new like-for-like aspect. We will match these on your listings automatically when your items are renewed, relisted, or revised. If the aspect has changed and there is no exact match, we won’t do thisand you will need to update these listings. Collect Missing Aspects for Active Listings © 2020 eBay. All rights reserved.13 Notify sellers of listings missing required and recommended aspects for active listings. Quick filters and at-a- glance aspects column help sellers find listings.Contextual editing directly from Active Listings provides an efficient way to update missing info. Developer Tip: Use Compliance API to retrieve missing aspects for listings by seller •Get list of listings missing required aspects •Get list of listings missing soon to be required aspects •Get list of listings missing recommended aspects •Dismiss compliance for recommended aspects •ASPECTS\_ADOPTION type Allow Sellers to Dismiss Recommended © 2020 eBay. All rights reserved.14 Sellers should be highly encouraged to fill in recommended aspects. However, after providing as much info as available, sellers may want to dismiss any open recommended aspects for the listing so they’re not bothered with reminders to fill in the remaining values. Developer Tip: Use suppressViolationvia Compliance API Update Aspects in Bulk Using File Upload and Download © 2020 eBay. All rights reserved.15 Available through Seller Hub Active Listings, sellers can download a file of listings with missing required, required soon, and recommended aspects. Using a “smart file,” sellers can fill in missing aspects by choosing from supported eBay values or typing in their own custom values. Once done, upload back to eBay and listings are updated in bulk. Emails to Remind Sellers to Provide Aspects © 2020 eBay. All rights reserved.16 Email reminders of missing required, required soon, and recommended aspects are sent to sellers on a recurring basis to identify listings and encourage action to fill in missing info. Recap Key Takeaways © 2020 eBay. All rights reserved.18 •Aspects help buyers find what they’re looking for. Without them, items may not show up in search and filters. •Prioritize most important aspects first to collect the most relevant, impactful info. •Build experiences to collect aspects during listing, and post-list for active listings. •Use eBay Selling Tools as a reference for implementing your own tools. --- # Unknown eBay Connect 2023 Payments Deepak Sharma / Raphael Tsow VP Payments Tech / Architect 2© 2023 eBay. All rights reserved. Payments Serving millions of buyers and sellers across 190 markets globally Buyer Choice Simplified Seller Operations Business Growth 3© 2023 eBay. All rights reserved. High Value Payment Split Payment Wire Transfer 4© 2023 eBay. All rights reserved. Buyer FX Support 40 buyer currencies through 280 corridors 5© 2023 eBay. All rights reserved. Split Payout 6© 2023 eBay. All rights reserved. Fulfillment API updates Support for multiple country tax launches. getTransactions response (Malaysia): { ... "ebayCollectAndRemitTaxes" : \[ { ... "taxType" : "TaxTypeEnum : \[SST\]", ... "collectionMethod": "CollectionMethodEnum : \[NET\]", "ebayReference": { "name": "SST", "value": "123455" } ... 7© 2023 eBay. All rights reserved. Fulfillment API updates Suppress PII for orders > 90 days GetOrder response will suppress these PII information for all orders older than 90 days •Buyer name •Buyer’s eBay email •Phone number •Recipient name •Address line 1 and address line 2 •Recipient phone number •Gift details 8© 2023 eBay. All rights reserved. Order API updates Support for EU Digital Services Act (DSA) violations. Under DSA, eBay is obliged to allow anyone to report illegal content and offer an appeal process for contesting eBay's decisions. When appeals are successful, eBay must reverse its actions. GetPurchaseOrder response: { ... "lineItems" : \[{ ... "itemOnHold" : "true", "title" : "\*\*\*", "image" : { ... "imageUrl" : "string" } ... 9© 2023 eBay. All rights reserved. Payment Disputes API updates Support for DSA violations. GetPaymentDispute response: { ... "warnings" : \[{ ... "errorId" : 50003, "domain" : "API\_FILFILLMENT", "category" : "BUSINESS", "message" : "Content has been removed due to policy violation" }\] ... 10© 2023 eBay. All rights reserved. Payment Disputes API updates Support for adding and updating optional notes for certain disputes. AddEvidence/updateEvidence request: { ... "evidenceType": "EvidenceTypeEnum : \[OPTIONAL\_SUPPORTING\_DOCUMENTS\]", ... 11© 2023 eBay. All rights reserved. Payout Settings Update Finances API enhanced to support split payout for sellers in China who need to have funds in multiple accounts and currencies. payoutSettings response: { "payoutInstruments": \[ { "instrumentId": "string", "instrumentType": "PAYONEER", "instrumentStatus": "ACTIVE", "nickname": "PAYONEER", "accountLastFourDigits": "0001", "payoutPercentage": "50" }, { "instrumentId": "string", "instrumentType": "BANK", "instrumentStatus": "ACTIVE", "nickname": "HSBC", "accountLastFourDigits": "0002", "payoutPercentage": "50" } \] } 12© 2023 eBay. All rights reserved. Finances API Update Finances API enhanced to support split payout for sellers in China who need to have funds in multiple accounts and currencies. getPayout response: { "payouts": \[{ "payoutId": "500000456", ... "transactionCount": 7, "payoutInstrument": { "instrumentType": "PAYONEER", "nickname": "PAYONEER", "accountLastFourDigits": "0001", "payoutPercentage": "40" }, }, { "payoutId": "500000789", ... "transactionCount": 7, "payoutInstrument": { "instrumentType": "BANK", "nickname": "HSBC", "accountLastFourDigits": "0002", "payoutPercentage": "60" }, ... --- # Unknown © 2022 eBay. All rights reserved.2 - - - - - - • • • Output Container/FieldTypeDescription orders.program.ebayManagedShippingEbayManagedShippingThis field provides information about eBay shipping that has been selected for this order. This is returned only for those items that are eligible for eBay shipping. Occurrence: Conditional Structure: EbayManagedShipping{ booleanfreeShippingLabelByEbay; } orders.program.ebayManagedShipping. freeShippingLabelByEbay booleanfreeShippingLabelByEbaywill be true if order qualified for eBay shipping; Else it will be false. Occurrence: Conditional Output Container/FieldTypeDescription lineItems.ebayCollectedChargesEbayCollectedChargesThis container shows breakdown of all costs that are collected by ebay from buyer. Occurrence: Conditional Structure: EbayCollectedCharges { Amount ebayManagedShipping } lineItems.ebayCollectedCharges.deliveryCost. shippingCost AmountThis field shows the flat shipping charge collected by ebayfrom the buyer for ebayshipping. Occurrence: Conditional APIFieldChangeDetails AddItemItem.HitCounter DeprecatedeBay used to provide a way for sellers to add a Visitor counter to their listings (View Item pages). This screenshot is from the old SYI (Sell Your Item) listing tool: This feature is no longer supported, so this field has been deprecated. The field is ignored if passed in and a warning message is returned. GetItemItem.HitCount DeprecatedThis field is no longer applicable. eBay View Item page will show the 30-day view count from the Ads system for the seller view. Item.HitCounter DeprecatedThis field is no longer applicable. GetSellerList and GetSellerEvents Item.HitCount ModifiedThe logic of HitCount has been modified to return the 30-day view count from the Ads system instead of the previous lifetime view count from the old system. Item.HitCounter DeprecatedThis field is no longer applicable. Sellers can always get views up to 2 years from Marketing API getTrafficReport. getTrafficReport SALES\_CONVERSION\_RATE ModifiedSorting by this value has been deprecated and no longer supported TRANSACTION ModifiedCan only sort in descending order, not ascending order LISTING\_VIEWS\_SOURCE\_DIRECT ModifiedCan only support a query of up-to 2 years, rather than a seller’s complete history. ○Producer Product ID ○Product Package ID ○Shipment Package ID ○Product Document ID ○Eco Participation Fee ○Take Back Policy ○Producer Product ID ○Product Package ID ○Shipment Package ID ○Product Document ID ○Eco Participation Fee ○Take Back Policy Retrieve EPR info for categories: { "extendedProducerResponsibilities": \[ { "categoryTreeId": "71", "categoryId": "183598", "supportedAttributes": \[ { "name": "PRODUCER\_PRODUCT\_ID", "usage": "OPTIONAL", "enabledForVariations": false }, { "name": "PRODUCT\_PACKAGE\_ID", "usage": "OPTIONAL", "enabledForVariations": false }, { "name": "SHIPMENT\_PACKAGE\_ID", "usage": "OPTIONAL", "enabledForVariations": false }, { "name": "PRODUCT\_DOCUMENTATION\_ID", "usage": "OPTIONAL", "enabledForVariations": false }, { "name": "ECO\_PARTICIPATION\_FEE", "usage": "OPTIONAL", "enabledForVariations": true }, { "name": "TAKE\_BACK\_POLICY", "usage": "REQUIRED", "enabledForVariations": false } \] }, \] } string string string string string string string double "extendedProducerResponsibility": { "producerProductId": "string", "productPackageId": "string", "shipmentPackageId": "string", "productDocumentationId": "string", "ecoParticipationFee": { "value": double, "currency": "currency” } }, "listingPolicies": { "takeBackPolicyId": "string", “productCompliancePolicyId”: “string” \], Create a custom policy { "policyType": "CustomPolicyEnum: \[PRODUCT\_COMPLIANCE,TAKEBACK\]", "name": "String", "description": "String", "label": "String" } Retrieve all custom policies: { "customPolicies" : \[ { "customPolicyId": String, "policyType": "CustomPolicyEnum: \[PRODUCT\_COMPLIANCE,TAKEBACK\]" , "name": "String", "description": "String", "label": "String" } \] } • • 1.LMS\_ADD\_ITEM (AddItem) 2.LMS\_REVISE\_ITEM (ReviseItem) 3.LMS\_VERIFY\_ADD\_ITEM (VerifyAddItem) 4.LMS\_RELIST\_ITEM (RelistItem) 5.LMS\_END\_ITEM 6.LMS\_REVISE\_INVENTORY\_STATUS (ReviseInventoryStatus) 7.LMS\_ORDER\_ACK 8.LMS\_SET\_SHIPMENT\_TRACKING\_INF 9.LMS\_ACTIVE\_INVENTORY\_REPORT (lmsActiveInventory) • • • • • --- # Unknown Deprecated fields for GetOrders, GetSellerTransactions, GetItemTransactions, and GetMyeBaySelling Deprecation date: 5/3/23 Decommission date: 1/31/24 Field/Container NameTypeCallsReason PayPalPreferredGetItemTransactionsResponseTypeGITOld checkout field PayPalPreferredGetSellerTransactionsResponseTypeGSTOld checkout field Item.ConditionIDItemTypeGITNot necessary for orders Item.ConditionDisplayItemTypeGITNot necessary for orders Item.PaymentMethodsItemTypeGITNot necessary for orders Item.Seller.AboutMePageUserTypeGITNot necessary for orders Item.Seller.FeedbackRatingStarUserTypeGITNot necessary for orders Item.Seller.IDVerifiedUserTypeGITNot necessary for orders Item.Seller.SellerInfo\*SellerTypeGITNot necessary for orders Item.Seller.UserFirstNameUserTypeGITNot necessary for orders Item.Seller.UserLastNameUserTypeGITNot necessary for orders Item.Variations\*ItemTypeGITVariation identified at Transaction level Seller.AboutMePageUserTypeGSTNot necessary for orders Seller.FeedbackRatingStarUserTypeGSTNot necessary for orders Seller.IDVerifiedUserTypeGSTNot necessary for orders Seller.RegistrationAddress\*UserTypeGSTNot necessary for orders Seller.SellerInfo\*UserTypeGSTNot necessary for orders Seller.UserFirstNameUserTypeGSTNot necessary for orders Seller.UserLastNameUserTypeGSTNot necessary for orders Order.ExternalTransaction\*OrderTypeGOUse MonetaryDetails instead Order.IntegratedMerchantCreditCardEnabledOrderTypeGODeprecated feature Order.PaymentHoldDetails\*OrderTypeGOOld checkout field Transaction. Buyer.BuyerInfo. ShippingAddress.AddressUsageAddressTypeGST, GITOld checkout field Transaction. Buyer.BuyerInfo. ShippingAddress.ExternalAddressIDAddressTypeGST, GITOld checkout field Transaction. Buyer.AboutMePageUserTypeGST, GITNot necessary for orders Transaction. Buyer.eBayGoodStandingUserTypeGST, GITNot necessary for orders Transaction. Buyer.FeedbackRatingStarUserTypeGST, GITNot necessary for orders Transaction. Buyer.IDVerifiedUserTypeGST, GITNot necessary for orders Transaction. Buyer.NewUserUserTypeGST, GITNot necessary for orders Transaction. Buyer.RegistrationAddress\*UserTypeGSTNot necessary for orders Transaction. Buyer.StaticAliasUserTypeGO, GST, GIT, GMESNot necessary for orders Transaction. Buyer.UserIDLastChangedUserTypeGST, GITNot necessary for orders Transaction.BuyerGuaranteePriceTransactionTypeGST, GITDeprecated feature Transaction.ContainingOrder. BuyerPackageEnclosures\*OrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. BuyerTaxIdentifier\*OrderTypeGST, GITReturned in BuyerInfo container Transaction.ContainingOrder. eBayCollectAndRemitTaxOrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. IntegratedMerchantCreditCardEnabledOrderTypeGST, GITDeprecated feature Transaction.ContainingOrder. IsMultiLegShippingOrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. LogisticsPlanTypeOrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. MonetaryDetails\*OrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. MultiLegShippingDetails\*OrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. PaymentHoldDetails\*OrderTypeGST, GITReturned at Transaction level Transaction.ContainingOrder. PaymentHoldStatusOrderTypeGST, GIT Returned in Transaction.Status container Transaction.ExternalTransaction\*TransactionTypeGO, GST, GITUse MonetaryDetails instead Transaction.PayPalEmailAddressTransactionTypeGST, GITOld checkout field Transaction.SellingManagerProductDetails\* TransactionTypeGST, GITNo Selling Manager support in APIs Transaction.UnpaidItem\*TransactionTypeGO, GST, GITDeprecated feature Transaction.Item.BuyerProtectionItemTypeGST, GITDeprecated feature Transaction.Item.ConditionIDItemTypeGO, GSTNot necessary for orders Transaction.Item.ConditionDisplayNameItemTypeGO, GSTNot necessary for orders Transaction.Item.GetItFastItemTypeGO, GSTDeprecated feature Transaction.Item. IntegratedMerchantCreditCardEnabledItemTypeGO, GST, GITDeprecated feature Transaction.Item.PaymentMethodsItemTypeGSTNot necessary for orders Transaction.Item.ListingDetails.AdultListingDetailsTypeGST, GITNot necessary for orders Transaction.Item.ListingDetails. BindingAuctionListingDetailsTypeGST, GITDeprecated feature Transaction.Item.ListingDetails. CheckoutEnabledListingDetailsTypeGST, GITDeprecated feature Transaction.Item.ListingDetails. ConvertedBuyItNowPriceListingDetailsTypeGST, GIT, GMESNot necessary for orders Transaction.Item.ListingDetails. ConvertedReservePriceListingDetailsTypeGST, GIT, GMESNot necessary for orders Transaction.Item.ListingDetails. ConvertedStartPriceListingDetailsTypeGST, GIT, GMESNot necessary for orders Transaction.Item.ListingDetails. HasPublicMessagesListingDetailsTypeGST, GITNot necessary for orders Transaction.Item.ListingDetails. HasReservePriceListingDetailsTypeGST, GITNot necessary for orders Transaction.Item.ListingDetails. MinimumBestOfferPriceListingDetailsTypeGST, GITNot necessary for orders Transaction.Item.ListingDetails. RelistedItemIDListingDetailsTypeGST, GITNot necessary for orders Transaction.Item.ListingDetails. TCROriginalItemIDListingDetailsTypeGST, GITDeprecated feature Transaction.Item.ListingDetails. ViewItemURLListingDetailsTypeGST, GITNot necessary for orders Transaction.Item.ListingDetails. ViewItemURLForNaturalSearchListingDetailsTypeGST, GITNot necessary for orders Transaction.MultiLegShippingDetails . SellerShipmentToLogisticsProvider. ShipToAddress.ExternalAddressID AddressTypeGO, GST, GITOld checkout field Transaction.ShippingDetails. ChangePaymentInstructions ShippingDetailsTypeGST, GITDeprecated feature Transaction.ShippingDetails. ExcludeShipToLocation ShippingDetailsTypeGO, GST, GITNot necessary for orders Transaction.ShippingDetails.GetItFast ShippingDetailsTypeGO, GST, GITDeprecated feature Transaction.ShippingDetails. ShippingRateErrorMessage ShippingDetailsTypeGST, GITDeprecated feature Transaction.ShippingDetails. ThirdPartyCheckout ShippingDetailsTypeGST, GITOld checkout field Transaction.Status. IntegratedMerchantCreditCardEnabledTransactionStatusTypeGST, GITDeprecated feature Exclusively used Types being removed SellingManagerProductDetailsType Call Key GO: GetOrders GIT: GetItemTransactions GST: GetSellerTransactions GMES: GetMyeBaySelling \* Indicates whole container being deprecated --- # Unknown eBay Connect 2020 Powered by You Tanya Vlahovic Agenda Date / TimeContent July 13 @ 9 AM PTAll in for Aspects Buyer Experience New Selling API Capabilities QA Session July 14 –15eBay Connect Virtual Lounge August 17 @ 10 AM PTAll about APIs Consumer Selling API eBay for Charity Translation API API Security Updates Fireside Chat with Randy Shoup August 18 –19eBay Connect Virtual Lounge © 2020 eBay. All rights reserved.2 Our new API has tremendous potential to revolutionize the way people do business on eBay and increase the amount of business transacted on the site. By openly providing the tools that developers need to create applications based on eBay technology, we believe eBay will eventually be tightly woven into many existing sites as well as future e-commerce ventures. eBay November 20, 2000 “ © 2020 eBay. All rights reserved.4 API Portfolio Marketplace Insights\* Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxonomy Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Translation Offer Analytics Listing Identity Recommen- dation Finances Charity Feed Sell Buy Commerce Developer \* Limited Release Deal Agenda Today TITLESPEAKER Message from VP of Selling ExperienceHarry Temkin All In for AspectsMike Cuttone Buyer ExperienceNicole Inouye BREAK New Selling API CapabilitiesScot Hamilton QA SessionMike Cuttone& Scot Hamilton Message from CTOMazenRawashdeh © 2020 eBay. All rights reserved.5 --- # Unknown eBay Connect 2021 Empowering API sellers to grow faster Michael Cuttone Sr. Director, Seller Experience Product eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Bring your listing to life with Video Drive Sales, Repeat buyers, with Coded Coupons Discover and Unlock Potential with Terapeak Improve sales through Listing Quality Report recommendations Bring your listing to life with Video Enabling videos on listings © 2021 eBay. All rights reserved.4 1.API-First approach, available to all API sellers in the US 2.Upload .mp4 videos, upto 150MB, using Media API 3.Attach to listings using AddItem family of API 4.After video is moderated, it will be visible to buyers on eBay native apps 5.Currently, limited to 1 seller video per listing 6.Expanding to other regions, and to Selling UI clients, is on the roadmap Drive Sales, Repeat buyers, with Coded Coupons What are Coded Coupons? © 2021 eBay. All rights reserved.6 ●Coded Coupons enable sellers to offer buyers a discount through a coupon code ●They replace the previous codeless coupons ●There are many different types of discounts sellers can offer. The discount is applied at checkout. Promotion capabilities © 2021 eBay. All rights reserved.7 ●More control over management of your promotion ●Set budget ●Max savings and per user redemption settings ●Target coupons by using private setting ●Share coupon to social networks ●Available under Seller Hub Marketing tab New coupon campaign creation (seller view) Social sharing at the end of campaign creation Seller experience flow © 2021 eBay. All rights reserved.8 1 234 5 Buyer experience © 2021 eBay. All rights reserved.9 View item (web and native) Search results Check out Encourage repeat purchases by printing out coupons © 2021 eBay. All rights reserved.10 Thank you card available with subscription shipping supplies, with printable side Print coupons on packing slips Print standalone coupon with seller note Features coming soon.... © 2021 eBay. All rights reserved.11 •Send a coupon to previous customers •Send a coupon when sending an offer to buyers •Repeat buyer indicators Discover and Unlock Potential with Terapeak Terapeak product research © 2021 eBay. All rights reserved.13 ●Identify sourcing opportunities, price trends, sell-through rates and other key sales metrics for any listing sold in the past year ●Perform deeper analysis using powerful filters to narrow down to a smaller subset of specific listings ●Interpret data visually using charts and trendlines Terapeak sourcing insights © 2021 eBay. All rights reserved.14 ●Identify category level sourcing opportunities, including demand, supply and opportunity metrics ●Deep dive into combinations of Item Specifics to find trending products ●Use charts and graphs to understand category trends over time Terapeak insights coming to new listing flow © 2021 eBay. All rights reserved.15 Terapeak Beta API available to limited partners in Q3 ‘21 © 2021 eBay. All rights reserved. Evaluating an access control approach that would provide API access to qualifying accounts that meet sales and or other seller quality benchmarks Access to the same data available through Terapeak Product Research in Seller Hub, including aggregate metrics and details of sold items Connect with your eBay Developers Program representative to be added to a waitlist for access to the Terapeak Beta API Support for ‘Product Research’ Access control Sign-up to be added to the waitlist Improve sales through Listing Quality Report recommendations What is the Listing Quality Report? © 2021 eBay. All rights reserved.18 ●Actionable recommendations at category and listing-level by comparing your items to similar items/seller benchmark ●Designed with input from the seller community ●Select up to 10 categories with the most live listings ●Evolving and improving over time We compare your listings to all others in the same category and condition © 2021 eBay. All rights reserved.19 We analyse ●Title keywords ●Item specifics ●Photos ●Handling time ●Free shipping ●Returns policy ●Promotions ●and more... Fewest impressions Most impressions 100% of listings in this category and condition Top 10% Bottom 10%Bottom 10% Top 10% The Listing Quality report is available from Seller Hub > Performance tab © 2021 eBay. All rights reserved.20 STEP 1 Download the report STEP 2 Open and browse tabs Seller hub > Performance tab Currently available as .xls file. Google sheets and Apple Numbers also supported. ●Summary tab ●Google Shopping Rejections tab ●Category tabs Summary tab provides category-level data and recommendations © 2021 eBay. All rights reserved.21 The category tab givesrecommendations for the buyer funnel © 2021 eBay. All rights reserved.22 Google Shopping Rejections are listed in a dedicated tab © 2021 eBay. All rights reserved.23 What’s coming next? © 2021 eBay. All rights reserved.24 ●Alternative file options (PDF, CSV etc) ●Choose categories for analysis ●Ramp to all store subscribers ●Search and Trust signals and recommendations ●Continuous improvements –come back regularly to check new insights! --- # Unknown eBay Advertising Business Promoted Listings Standard Promoted Listings Advanced API • • • • • • • • • • Developer Tip:Seller eligibility status can now be checked via APIfor eBay advertising programs throughdocumentationat https://developer.ebay.com (URI): Suggest Keywords POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_id}/ad\_g roup/{ad\_group\_id}/suggest\_keywords { "suggestedKeywords": \[ { "matchType": "EXACT", "additionalInfo": \[ { "infoType": "KEYWORD\_INSIGHTS", "metrics": \[ { "metricKey": "SEARCH\_VOLUME", "value": "25000" }, { "metricKey": "ACTIVE\_SELLER\_COUNT", "value": "10" } \] } \], "keywordText": "apple" }, { "matchType": "EXACT", "additionalInfo": \[ { "infoType": "KEYWORD\_INSIGHTS", "metrics": \[ { "metricKey": "SEARCH\_VOLUME", "value": "45000" }, { "metricKey": "ACTIVE\_SELLER\_COUNT", "value": "20" } \] } \], "keywordText": "iphone" } \] } Response: Sample Request { "listingIds": \[ "523764764138", "594746353789" \], "matchType": "EXACT", "additionalInfo": \[ "KEYWORD\_INSIGHTS" \], "exclusions": \[ "ADOPTED\_KEYWORDS" \] } { "suggestedBids": \[ { "matchType": "EXACT", "proposedBid": { "rangeStart": "0.4", "currency": "USD", "value": "0.55", "rangeEnd": "0.65" }, "keywordText": "apple" }, { "matchType": "PHRASE", "proposedBid": { "rangeStart": "0.25", "currency": "USD", "value": "0.35", "rangeEnd": "0.5" }, "keywordText": "apple" } \] } Suggest BidsResponse: (URI): POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_id}/ad\_g roup/{ad\_group\_id}/suggest\_bids Sample Request { "keywords": \[ { "matchType": "EXACT", "keywordText": "apple" }, { "matchType": "PHRASE", "keywordText": "apple" } \] } --- # Unknown eBay Connect 2023 Sneakers Monetization Minh Tran-Lee Product Manager, Buyer Experience Authenticity Guarantee (AG): Sneakers Monetization Customer Problem As a sneaker seller, a free shipping label will help offset my fees and a simplified listing flow will make it easier & faster for me to list my items. Objective Monetizing shipping for buyers is a way to ensure we can sustainably support authentication operations on a managed marketplace. Approach Real-time AG eligibility checks in listing flows, free shipping labels for Sellers, eBay shipping fee for Buyers. Launched in the US last year; expanding to the UK in H2 2023. Key metrics GMV Conversion Customer Satisfaction AG inventory coverage eBay label adoption AG Sneakers Managed Shipping & Buyer Fees Listing Flow AG eligibility evaluations are done at time of listing and criteria includes category, item specifics, price and keyword exclusions. Sellers are informed that their item is eligible for Authenticity Guarantee. The domestic shipping service defaults to eBay shipping via FedEx and sellers are informed that they will receive a free shipping label. Handling time options are same day, 1, 2, or 3 business days. Search The eBay shipping fee is shown on the search results page along with the AG badging. View Item Along with showing the eBay shipping fee, we include a tooltip on the View Item page to explain that the fee will be paid to eBay and covers shipping, handling and secure delivery from the authentication center to the buyer. Checkout We continue to provide e2e transparency to buyers through checkout where the eBay shipping fee is shown along with tooltip content. Shipping Labels Once an AG sneakers item with eBay shipping is sold, a seller will be provided with a free FedEx shipping label to ship their order to the authentication center. --- # Unknown eBay Connect 2020 Powered by You Nicole Inouye, Director of Product Management, Buyer Engagement & Personalization eBay Connect 2020 Agenda Where Do You Begin? The Principles of Buyer Experience Simplify Modernize Personalize Key Takeaways © 2020 eBay. All rights reserved.2 Where Do You Begin? Go Where The People Are Reinvest in Native, Where They’re Going (or gone) Start With Your Best Customer, Graduate Others The Principles of Buyer Experience Simplify Modernize Personalize Simplify © 2020 eBay. All rights reserved.6 “We have to jump through hoops to shop on eBay and I’m a frequent and loyal eBay user. It’s frustrating...” Social Linking: Apple Sign-In Customer Opportunity Users of the Apple ecosystem are unable to use the seamless and secure “Sign in with Apple” feature on eBay Approach ●Provide “Sign in with Apple” as an option on registration and sign in ●Eligible platform - iOS/web/mweb © 2020 eBay. All rights reserved.7 Guest to Member Upgrade Customer Opportunity As an eBay customer, creating an eBay account seems like a lot of work and I don’t understand the value of doing it. Approach ●Enable guest registration module with social sign-in on dWeb © 2020 eBay. All rights reserved.8 Aspects in Search © 2020 eBay. All rights reserved.9 Customer Opportunity As abuyer, I want to see all relevant inventory matching my search query. As a seller, eBay doesn’t use all the information I provide while listing the item. Approach ●Leverage Machine Learning to identify high quality and relevant seller provided item specifics ●Increase relevant recall by matching relevant item specifics Why is this important? ●Buyers: 55% of searches have aspects in the query and/or filters. Aspect matches are a key match component in Search. ●Sellers: Provide as many high qualityitem specifics as possible to accurately describe a listing. Visibility increases in search directly proportional on average to # of high qualityrelevant aspects per listing. Query: 2019 yeezyboost 350 v2 Simple and Powerful Left-Hand Navigation © 2020 eBay. All rights reserved.10 Customer Opportunity Left Hand Navigation (LHN) was a dated and non-intuitive experience. Users could not select multiple values and could only see multiple values on ‘See all’ layer. Selection of an aspect (e.g. Brand) collapsed the aspect and moved it to the bottom of the LHN. The selected states and the LHN itself had dated UI and was not easy to use. Audience All Desktop Users Approach ●Selection of an aspect (e.g. Brand) does not collapse the aspect, making it easy to select multiple values. ●Updated UI for ‘selected’ states, eBay Plus and ‘Size’. Why is this important? ●Increase in Searches with aspects applied ●Guidance for sellers: Focus on providing more, high quality aspects for your listings, ensuring your items remain visible with the increased usage of filters. Updated ‘Size’ aspect UI ‘Brand’ aspect remains available Updated ‘eBay Plus’UI Updated Selected Values Improved Multi Aspect Guidance (MAG) © 2020 eBay. All rights reserved.11 Customer Opportunity Buyers either saw the price guidance or the aspect guidance on top of Search . They could not use both together. Audience : All Desktop users Approach ●UK and DE users are no longer restricted to seeing either Price or Aspect Guidance. Through MAG they are able touse both. ●New, DS6.5 design on dWebfurther enhances the look and discoverability of our guidance modules. Why is this important? ●Increase in Searches with aspects applied. ● Guidance for sellers: Focus on providing more, high quality aspects for your listings, ensuring your items remain visible with the increased usage of filters. MAG on eBay.co.uk Category Prediction & Filter Accuracy © 2020 eBay. All rights reserved.12 Customer Opportunity When I search on eBay, I get irrelevant filters on the left-hand navigation. I have to spend a lot of effort to identify the right listing. Approach ●Increase overall category prediction accuracy & coverage. ●Increase category prediction coverage for L2/L3 categories to make the filters more relevant. Why is this important? ●With improvements in category prediction, eBay shows more relevant filters in more searches. As a results, buyers use filters more often. ● Guidance for sellers: Select the right categories for your listing and provide more high quality item specifics to make sure that you see increased visibility when buyers apply filters. MSKU Improvement © 2020 eBay. All rights reserved.13 Customer Opportunity ●As a buyer, I see many low priced SKUs in Deterministic sort. These irrelevant low- priced items bundled in MSKU listings ruin my Low-to-High Price-sort experience, causing increased churn. Approach ●Identify these low-quality MSKU listings and demote their relevance before applying the standard relevance filter. Why is this important? ●These MSKU listings cause buyer dissatisfaction and buyers may not buy on eBay as it is difficult for them to search for the right listing. ● Guidance for sellers: Avoid adding irrelevant variant to your MSKU listings as it hurts the overall marketplace and buyer conversion. Query: Leather messenger bag (Price Low to High Sort) Shipping Fee Inflation © 2020 eBay. All rights reserved.14 Customer Opportunity eBay charges fees for promoted listings on an item’s list price but not on the item’s shipping fee. This incentivizes sellers to reduce the item price and increase the shipping fee. Doing this enables sellers to pay less ad fee and gain visibility in search. Approach ●Best match ranker reduced the visibility provided to such items in search. The reduction in visibility is proportional to the extent of shipping fee increase (with price decrease). Why is this important? Guidance for sellers: Decreasing the price by increasing the shipping fee does not help in increasing visibility or decreasing PL fees. Please set the appropriate price for your listing and reflect the correct shipping fee. This leads to better buyer experience as buyers can see the correct price of the listing and need to spend less effort in computing the total cost. Before: query ‘earbuds’ showed ads with high shipping fee After: query ‘earbuds’ shows ads with reasonable shipping fee Coupons on Search Results Page © 2020 eBay. All rights reserved.15 Customer Opportunity As a buyer , I don’t necessarily see the best deal on eBay’s Search page since coupons aren’t visible on Search. As a seller , the coupon dollars I spend to make my listings more attractive are not necessarily driving velocity for my listings on search. Approach ●Showcase coupons on Search item cards Why is this important? ● Buyers are able to find “well priced items with coupons” faster -Increase in Engagement ● Seller velocity: Spend on coupon campaigns makes listings more visible and drive more velocity for the sellers Modernize © 2020 eBay. All rights reserved.17 “The site feels overwhelming, old, and tired. Not very modern or easy, let alone enjoyable to shop. The app is much better!” Dark Mode / Dark Theme © 2020 eBay. All rights reserved.18 Customer Opportunity Using the eBay app at night hurts my eyes. I wish it had Dark Mode like my other apps. Objective ●Leverage Common Components to support app-level theming. ●Enable Dark Mode (iOS) and Dark Theme (Android). Search Modernization: Desktop Filters, Aspects © 2020 eBay. All rights reserved.19 Customer Opportunity The Search Experience looks dated on desktop and mWeb. It currently delivers an inconsistent buying experience from page to page. Approach ●Update the web experience to the latest design standards (DS6.5) and move to eBay UI components to provide a cleaner, clearer, more consistent user experience. Why is this important? ●Modern experiences can make eBay more relevant for new users and more engaging for our current users. ● Guidance for sellers: Provide high quality images and more relevant aspects for your listings, since this modern experience will drive more engagement on your listings. Search Modernization Mobile Filters, Aspects © 2020 eBay. All rights reserved.20 Customer Opportunity As a buyer, I scroll (down) almost immediately upon landing on the SRP hiding current ‘Sort’ and ‘Filter’ entry points. If I do interact with them the current filter panel is cumbersome, especially for new eBay buyers. Approach ●Ever-present access to Search, Save, Sort & Filter (FAB). ●Optimized and completely redesigned Filter Panel. Why is this important? ●This modernized experience has increased sort and filter engagement by ~10% (varies by region), increasing overall search efficiency and enabling a frictionless mobile shopping experience. ● Guidance for sellers: Focus on providing more, high quality aspects for your listings, ensuring your items remain visible with the increased usage of filters. New Filter Panel -Full Scroll Search Speed © 2020 eBay. All rights reserved.21 Customer Opportunity Users abandon a page if it takes too long to load. Approach ●Investigate and optimize every layer of the search. response, optimizing payload and predicting subsequent user activity. Why is this important? ●Page-loadtimes are as fast as our fastest competitor, and significantly faster than our slowest competitor. ●Improved above-the-foldrendering time across all platforms up to ~13% while launching new features in 2019 and 2020. ●More users in the US have their pages loaded in under 1 second. Figure 3. Page Load times: eBay vs. industry benchmarks. Figure 1. Percentage of improvements in Above The Fold rendering time since November 2018 View Item Modernization Customer Opportunity The desktop experience looks really old and dated. Objective ●Provide a cleaner, more consistent and scalable user experience. ●Quick iterations based on qualitative and quantitative feedback © 2020 eBay. All rights reserved.22 Events | Search within Events © 2020 eBay. All rights reserved.23 Customer Opportunity Enables users to quickly locate the inventory they are looking for within a Sale. Allows curators to create larger events -currently large events are created using interstitials and a search bar injection. If they can not find the item they are looking for in an event, they hit a dead-end. Approach ●Add capability to search within an event on mWeb and mobile. ●Add pivots from low/null results to search results -remove dead-ends. Stores on Native © 2020 eBay. All rights reserved.24 Customer Opportunity Our sellers pay us to have ‘storefronts’ for their inventory and to build brand equity on eBay, and yet we don’t have them on the highest-traffic platform: Native. Our sellers are losing out on major exposure and buyers are losing out on being able to find and experience the branded experience from sellers. This project aims to close that gap and adapt the Stores experience seamlessly and meaningfully onto iOS and Android. Approach ●Bring the goodness of Storefronts to iOS and Android, increasing inventory exposure and boosting seller presence ●Surface Seller Spotlight modules as relevant, targeted placements throughout the experience to qualified buyers Personalize © 2020 eBay. All rights reserved.26 “By now, eBay should KNOW ME” Inline Messaging: Seller Offers © 2020 eBay. All rights reserved.27 Customer Opportunity Unless a buyer is very engaged on eBay, they don’t always know about the most valuable, important or compelling information. Objective ●Add Seller Initiated Offer notification to the App and mobile Web so that buyers can see right away that they’ve been sent a Seller Offer. Recommended Sale Events © 2020 eBay. All rights reserved.28 Customer Opportunity ● Buyers : It is hard to discover the great promotions I'm interested in. My shopping activity does not seem to be reflected by eBay. ● Sellers : I want qualified buyers seeing my inventory Objective ●Leverage past buying behavior to surface the most relevant sales to our buyers. Recommended Searches © 2020 eBay. All rights reserved.29 Customer Opportunity Repeatedly searching for the same thing over and over to see new inventory is time consuming, especially if filters are applied. Save me time by showing me inventory from these repeated searches, please! Approach •Allow users to easily see the latest inventory from their recent searches from Home Page, and educate users on the benefits of saving the search. Recommended Sellers © 2020 eBay. All rights reserved.30 Customer Opportunity As a buyer, I am currently only shown images for Sellers recommended to me. I would like to see items that I might be interested in. Approach •By showing items from Sellers that are recommended for users, we should be able to increase module and over HP engagement. Concept Only –For Illustration Increase Save Limits © 2020 eBay. All rights reserved.31 Customer Opportunity This was a top customer request –“increase the number of Saved Searches and Sellers!” Objective ●Let users further personalize their eBay experience by saving more things. In-Session Search Personalization © 2020 eBay. All rights reserved.32 Customer Opportunity Search does not remember my preferences within session, and I need to spend more effort to get to the right set of listings Approach ●Remember in-session preferences for Buyers ●Use in-session learned preferences to rank listings matching the preference higher in later searches Why is this important? ●Buyerstend to have sticky preferences for specific attributes. They show their implicit preference by clicking on the items that meet their need. Through in- session personalization, we recognize that need and show listings that satisfy their implicit needs at the top of search ●Guidance for sellers: Describe the title and item specifics accurately. As Search detects implicit buyer preferences, your listings that satisfy the need have better visibility Query: nikeshoesQuery: nike air jordan clicks on “white shoes” Show more “white nikeair jordanshoes” Teach Buyers how to Make eBay More Personalized Save a Search WatchApp Downloads App Activation: App-Only Coupons © 2020 eBay. All rights reserved.34 Customer Opportunity As a customer, I need a reminder and a nudge to download and use the eBay app even though it’s a better experience Approach ●Registered customers who are not actively using the native app will be targeted with the coupons ●When a customer with one of these coupons available visits eBay on mWebor dWeb, we will alert them of the available coupon and provide a direct link to download the app. Once they are logged in on the app, they will see the coupon in the drawer. Next Best Actions Concept Only –For Illustration Key Takeaways Key Takeaways © 2020 eBay. All rights reserved.36 Aspects & Category to power meaningful and relevant search experiences: Select the right categories for your listing and provide more high quality aspects; this directly drives better visibility of your listings and more conversion High data quality for Shipping fee, MSKU variants to drive higher performance: Avoid listing irrelevant variants along with your MSKU listings as this will drag down performance Do not arbitrarily inflate the shipping cost to reduce the perceived price of a listing We’re continuing to invest in the buying experience: Simplify. Modernize. Personalize. --- # Unknown eBay Connect 2021 Advertising Alex Kazim VP, GM, Global Advertising eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Value of Using Advertising Promoted Listings Our Expanding Portfolio NEW! Promoted Listings Advanced (PLA) About me © 2021 eBay. All rights reserved.3 Once-upon-a-time developer Started my career writing software and APIs at Apple 9 years at eBay Inc. including stints in engineering, PayPal, Classifieds and Skype Launched the eBay API Launched in Nov 2000, created the first Developer Program Rejoined eBay in July 2020 Running the global Advertising business Value of Using Advertising Velocity Efficiency Long-term Halo Effect Why do eBay Sellers use Advertising? © 2021 eBay. All rights reserved.5 Velocity Increases exposure which ultimately drives more sales Efficiency Return on Ad Spend (ROAS) is very high Long-term Halo Effect Increase in sales ultimately increases your organic rank in search and merchandising Advertising Business Top-20 eBay’s Ad business would rank in top-20 ad businesses worldwide\* $1B eBay’s Advertising businessgenerated $1B in revenue in2020 1M+ Over a million sellers use Promoted Listings in a quarter +\_\_% Sellers see double-digit lift in sales using Promoted Listings \* Based on data from eMarketer© 2021 eBay. All rights reserved.6 Promoted Listings What are Promoted Listings? Q1 Update What are Promoted Listings? © 2021 eBay. All rights reserved.8 Cost-per-Sale Ad format Boosts the ranking of your keyword- relevant item in search Displays your items in sponsored merchandising modules including View Item Boosts impressions in off-eBay channels, e.g. Google PLA No-risk: only pay an ad fee if your item sells Search Merchandising Q1 API Update Launched 2-way UI/API Visibility and Editability © 2021 eBay. All rights reserved.9 For API users and 3PPs, all campaigns will be successfully returned and editable regardless of where they were created This means that sellers can edit campaigns that were created via API in Seller Hub and vice versa. Before After Our Expanding Portfolio Expanding the Promoted Listings Portfolio © 2021 eBay. All rights reserved. Promoted Listings Advanced Industry Standard Cost-per-Click Drives more velocity w/ keyword control Top-slot in Search, more to follow Perfect for Larger Merchants Promoted Listings Standard No-Risk Cost-per-Sale Appear in Search, Merchandising, Off-eBay Perfect for SMBs Promoted Listings Express Perfect for Auctions Stay tuned... ExistingNew Promoted Listings Advanced API Format Details 13© 2021 eBay. All rights reserved. FeaturePromoted Listings StandardPromoted Listings Advanced Budget ControlNot AvailableSet Daily Budgets Keyword TargetingAutomaticSelect suggested and/or manual keywords Keyword BiddingNot AvailableSuggested or Fixed bidding with Real-Time 2 nd Price Auction PlacementsSearch Merchandising Modules Off-eBay Preferred access toSearch Top Slot More placements to come ReportingCampaign, Listing reportsCampaign, Listing, and Keyword reports Search query report Timeline © 2021 eBay. All rights reserved.14 Launch Full Rollout Jun UI Closed Beta Campaign management Reporting capabilities Item,keyword,bid recommendations Jul API Full Launch (Invitation) Enhanced reporting and guidance Multiple ad groups per campaign More keyword match types Mar API Beta Campaign management Reporting capabilities Item,keyword, bidrecommendations Sep UI Open Beta Enhanced reporting and guidance Multiple ad groups per campaign More keyword match types --- # Unknown All In for Aspects June 25, 2019 Era Johal Senior Technical Product Manager Agenda What we learned in 2018 Pivoting to item specifics Case study Findability API overview 1 2 3 4 5 What we learned in 2018 2018 APPROACH Explicit Association with Product Catalog Product-Based Shopping Experience Catalog API Inventory or Trading API Compliance API Category Specifics and Features through Trading API New APIs and capabilities to facilitate (and mandate) sellers to adopt products from eBay’s product catalog. eBay mandates compliance and shares violations. New Listing –Recommended Workflow We Hear You Requiring sellers to pick an ePID and/or file a change request was problematic Updated Approach Top-Down ePID Unique identifier specific to a product SKU Links to an eBay- specific code Change request to create or edit products Bottom-Up Item Specifics Use top item specifics to describe item Improve relevance & findability Enrich existing products with more aspects Associate that grouping of aspects with a product— i.e., an ePID Item Specifics NAME LABEL VALUE DESCRIPTOR Brand Size Style Levis 34 Bootcut Item Specifics, Products, & Entity Types Blue: Required Green: Preferred PRODUCT LINE CODY JAMES CASEY Brand Size Style Material Color Heel height Toe type Cody James 11 Men’s Boot Leather Brown 3′′ Square Product Product Product Product 65–80% of eBay inventory do not have the top 3 item specifics & the listings “unavailable in filters” when buyers filter But We Have a Problem... 80% of customers use filters to search 82% 43% 35% Color Style Length Filteringallows quick & easy identification of suitable products UK Women’s Dress Example SalesYear-Over-YearOutperformance 0 % 20182019 Women’s clothing summer categories CONTROL Women’s dress TEST Item specifics up-rev results UK Women’s Dresses Findability Engine 1.Search recall enhancements 2.Filtered experiences & personalization 3. Demand based search engine indexing API Updates: Trading API –GetCategorySpecifics High 9355 TOKEN 400 Request Response Response 9355 Brand Text 1 Required 1 Model Text 1 Recommended FreeText Style Text 1 Optional FreeText API Updates: Taxonomy API –getItemAspectsForCategory POST https://api.ebay.com/commerce/taxonomy/v1\_beta/category\_tree/0/ get\_item\_aspects\_for\_category?category\_id=9355 { "localizedAspectName": "Model", "aspectConstraint": { "aspectDataType": "STRING", "itemToAspectCardinality": "SINGLE", "aspectMode": "FREE\_TEXT", "aspectRequired": false, "aspectUsage": "OPTIONAL", "aspectEnabledForVariations": false }, "aspectValues": \[ ... \], }, "localizedAspectName": "Style", "aspectConstraint": { "aspectDataType": "STRING", "itemToAspectCardinality": "SINGLE", "aspectMode": "FREE\_TEXT", "aspectRequired": false, "aspectUsage": "RECOMMENDED", "aspectEnabledForVariations": false }, "aspectValues": \[ ... \], } Request Response Response { "aspects": \[ "localizedAspectName": "Brand", "aspectConstraint": { "aspectDataType": "STRING", "itemToAspectCardinality": "SINGLE", "aspectMode": "FREE\_TEXT", "aspectRequired": true, "aspectUsage": "RECOMMENDED", "aspectEnabledForVariations": false }, "aspectValues": \[ ... \], }, Required, Recommended, Optional RequiredRecommendedOptional This item specific is critical for buyer purchase decision making Item specific is typical for this category & is highly influential to buyer purchase decision making Item Specific may apply to smaller portion of the listings for this category Must include to prevent getting blocked Provide this to increase competitiveness within a category Include it if the item specific is relevant for your inventory Does Not Apply?! A CLOSER LOOK AT 3P LISTINGS High Volume, Low Fill, Low Precision Root Cause Analysis Does Not Apply was pre-filled by the 3P Tool Diapers has a 13% does not apply Rate! Next Steps To create the best experience for your sellers and their buyers Adoptaspect usage metadata Promote use of recommended item specifics Revise existing listings using eBay recommendations Stay in touch erjohal@ebay.com Thank you! Q&A eBay Connect 2019 June 25-26, 2019 --- # Unknown eBay Connect 2020 Powered by You Tanya Vlahovic Selling on eBayBuying on eBayMore Bulk support for aspect metadata in Taxonomy API Marketing API supports promoted listings in France, Italy, Spain, and Canada Feed API for scheduling and retrieving feeds and reports Customer service metrics in Analytics API Negotiation API to send offers to interested buyers GSP import charges Coupons Auto-spelled keyword corrections Supported eBay Guaranteed Delivery Eligibility for eBay Plus for qualified listings Supported GST in Australia across buy APIs Charity API for charity discovery Support for charity donations in Inventory API SDK for category tree comparison https://github.com/eBay/taxono my-sdk 2 Other API Updates © 2020 eBay. All rights reserved. API Deprecations Alpha release of Finances API Sold Report Revise Checkout Status Feedback API and DSR reports solutions.ebay.com © 2020 eBay. All rights reserved.3 What is Next developer.ebay.com © 2020 eBay. All rights reserved.4 Date / TimeContent June 16 –17eBay Connect Virtual Lounge July 13 @ 10 AM PTAll in for Aspects Buyer Experience New Selling API Capabilities Sell Feed and Negotiation API Listing optimizing July 14 –15eBay Connect Virtual Lounge August 17 @ 10 AM PTAll about APIs Consumer Selling API eBay for Charity Translation API API Security Updates August 18 –19eBay Connect Virtual Lounge --- # Unknown What’s New in Buy APIs Gail Frederick VP Mobile and Developer Ecosystem June 26, 2019 Agenda 1 API Portfolio Buy APIs are (more) Global Offer API Parts Compatibility Demos 2 3 4 5 Trading API Manage listings and fulfill orders Member-to-Member messaging Seller account management eBay’s catch-all API -huge feature set Shopping API Get listing details Get categories and products Finding API Search live listings Search completed transactions Legacy APIs 10+ years old: SOAP and XML interface, Auth’n’Authauthentication, ancient semantics API Portfolio: 2000–2016 API Portfolio: 2017 Fulfillme nt Marketin g Complia nce Metadata Analytics Marketing FulfillmentInventory Taxonomy Browse Feed OrderMarketing Sell \* Limited Release Buy Commerce Trading API Shopping API Finding API Legacy APIs (10+ years old) Account API Portfolio: 2018 3 4 Fulfillme nt Marketin g Complia nce Marketplace Insights Metadata Compliance Analytics Marketing Fulfillment Inventory TaxonomyCatalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Advertising\* Media Developer Insights Account Trading API Shopping API Finding API Legacy APIs (10+ years old) Sell \* Limited Release Buy Commerce API Portfolio: 2019 Fulfillment Marketing Compliance Marketplace Insights Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxonomy Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Offer SellBuy Commerce Translation Developer Analytics \* Limited Release Listing Identity Recommen- dation Finances Trading API Shopping API Finding API Legacy APIs (10+ years old) Buy APIs are (More) Global CapabilitySupported Countries Browse API Australia, Canada, Germany, France, Italy, Spain, UK, US Order API (Guest Checkout) Feed API Marketing API Australia, Germany, Spain, France, Italy, UK, US Marketplace Insights API Australia, Canada, Germany, France, Italy, Spain, UK, US Offer API Australia, Canada, Germany, France, Italy, Spain, UK, US RESTful API for auction bidding getBidding Get auction info in the context of a buyer, including bidding info, auction status, and current price placeProxyBid Place bid on behalf of buyer Offer API In Taxonomy API , use getCompatibilityPropertiesand getCompatibilityPropertyValuesto find parts aspects for parts compatibility. In Browse API , search by compatibility using search filters. Parts compatibility for cars, trucks and motorcycles are currently supported. Marketplaces US, Canada, UK, Germany, Australia, France, Italy, Spain Parts Compatibility Demo Thank you! Q&A eBay Connect 2019 June 25-26, 2019 { How to Curate Inventory Feeds } { Tanya Vlahovic} { Principal Architect, Developer Ecosystem } { June 26, 2019 } Surface the greatest selection of inventory Unleash the Power of Data to Drive Smarter Commerce Agenda Global Marketplace Items and Products Feed Platform Inventory Curation Steps 1 2 3 4 A Truly Global Marketplace 180M Active buyers 63% of Sellers use eBay to reach global markets and customers 190 Markets 1.2B Livelistings Q1 2019 A makeup product sellsevery 2 sec. An appliance sellsevery 5 sec. A tool sellsevery 4 sec. A smartphone case or cover sellsevery 7 sec. A watch sellsevery 5 sec. A sports trading card sellsevery 2 sec. USUK A video game sellsevery 11 sec. A car or truck part sellsevery 13 sec. GermanyAustralia eBay Item: Single Variation eBay Item: Multi–Variation Product –Item –Item Group Relationship Item Aspects and Product Data Structured Data Sneakers Watches Cars & TrucksPurses Video Games eBay Marketplace 8 Items from inventory feed are curated and listed for sale on Partner Site . Partner experience may be a mobile app or mobile/desktop website (or other). Partner leverages Order API to purchase inventory. Partner gets latest inventory changes from incremental and snapshot feeds. Browseson partner experience Buys inventory on partner experience 6 Integration Model –APIs and Feeds 1 7 Partner catalog Curated inventory 4 Downloads incremental and snapshot inventory feeds 5 Downloads bootstrap inventory feeds Inventory feeds 2 Buysinventory using OrderAPI filter 1 filter 2 filter n API call 3 Gets latest item data including first-mile shipping cost and delivery dates Partner platform / Experience End buyer Feed Platform ~150TB of Data processed to generate feeds 4k+ nodes to Process the data 1.2B Livelistings Modified Lambda Architecture Batch layer eBay Serving layer Partner platform Speed layer eBay All data (HDFS) Daily feeds Batch views Near real-time views Merged views Stream processing Hourly snapshot feeds Feed Files –Categories\* \*Available to eligible partners Item Purchasable items Item group Supports seller-defined variation Productcatalog Product title, description, identifiers, aspects, and images \*Available to eligible partners Item IDPrimary item group IDPrimary item group typeEPID... v1|113705355355|413834761010 113705355355SELLER\_DEFINED\_VARIATIONS v1|113705355355|413834761011 113705355355SELLER\_DEFINED\_VARIATIONS v1|223468969567|0 225203100 Purchasable items across marketplaces and categories Item Feed Item group level data for seller-defined variations Item Group Feed Item group IDItem group typeTitle... 113705355355SELLER\_DEFINED\_VARIATIONS VBESTLIFE W480 3200-5600K... 113705571572SELLER\_DEFINED\_VARIATIONS 5839 8x Zoom HD Recorder... eBay catalog structured data Product Feed EPIDTitle... 225203100 Apple iPhone 7 Plus -128GB -Rose Gold (Verizon) A1661 (CDMA + GSM) 25023700377 Apple iPhone XS -256GB -Space Gray (AT&T) A1920 (CDMA + GSM) Step 0 Step 1 Step 2 Step 0Understand eBay taxonomy Step 1Download Bootstrap feeds (use SDK) Step 2Apply initial set of filters (use SDK) Step 3Get the latest item data in the context of integration Step 4Import items Step 5Use snapshot feeds to synchronize inventory Step 6Repeat the same process for daily feeds Inventory Curation –Steps Marketplace category tree Metadata Item aspects for each category Category suggestions List of relevant categories based on keyword Step 0: Understand eBay Taxonomy Lightweight Open-sourced Java Python Step 1: Download Bootstrap Feeds https://github.com/eBay/FeedSDK https://github.com/eBay/FeedSDK-Python Feed file downloadConfigurable filters Filter-funnel approach Apply criteria based on various item attributes: category, brand, item location... Use feed SDKs to apply filters Step 2: Apply Initial Set of Filters Leaf category Price Aspects API callto get availability, estimated shipping cost and delivery date Ship to region ... Retrieve item availability and attributes not present in the feed Get information in the context of partner’s integration Shipping options Shipping cost Estimated delivery dates Step 3: Browse API – Get Item Import curated inventory Enrich item details with product catalog data Step 4: Import Items Snapshot feeds generated hourly The latest item data Step 5: Process Snapshot Feeds Incremental feeds generated daily Newly listed items Step 6: Process Daily Feeds Demo Buy API Portfolio TaxonomyBrowse Marketing Feed Marketplace Insights Catalog Order Offer Identity Translation APIs for real-time data Feeds for bulk updates When APIs Meet Data Feeds Thank you! Q&A eBay Connect 2019 June 25-26, 2019 --- # Unknown eBay Connect 2021 Payments Shan Vosseller VP of Product, Payments eBay Connect 2021 Agenda © 2021 eBay. All rights reserved.2 Managed Payments progress and next steps Cross-border trade Fee netting & charging Further enhancements & changes ahead Managed Payments Progress We are on track to transition the majority of sellers onto managed payments by 2022 © 2021 eBay. All rights reserved.4 •The majority of sales volume on eBay is already on managed payments •Millions of sellers worldwide are seeing the benefits of increased buyer choice, easier selling and simpler fees •All sellers are invited and migration is not optional •More benefits are coming in the months ahead As of this week, managed payments is available globally © 2021 eBay. All rights reserved.5 June All eBay sites and markets worldwide are enabled for managed payments Launch Full Rollout July All newly registered sellers globally will be on managed payments by default Any remaining listings which have not migrated will be ended Sellers will need to go through reactivation process to re-enable selling privileges and re-list H2 Required participation ultimately reflects in API © 2021 eBay. All rights reserved.6 After a period of not onboarding, we revoke selling privileges Trading API: Error code 120 -“You need to create a seller's account.” Sellers must then go to Seller Hub / My eBay Selling to update their account Depending on their entity type, some additional data and documentation may be required. Once reactivated, they can relist ended listings up to 90 days after end date Cross-Border Trade Sellers are normally paid in the currency of their domicile © 2021 eBay. All rights reserved.8 Sellers are paid in the default currency of their domicile, regardless of what site they list on Example: US seller lists on UK site (GBP), gets paid in USD Currency conversion happens at transaction time and is reflected in holding currency Some sites do or will support choice of holding currency at onboarding time: CA: CAD or USD HK: HKD or USD SG: SGD or USD PL: PLN or EUR Sellers in markets without eBay sites will default to EUR for EEA or USD for the rest of the world In our rest of world markets, payouts go through our partner, Payoneer APIs reflect the transacted price/currency and converted price/currency Recent enhancements in multi-currency support © 2021 eBay. All rights reserved. GetCancellation, GetInquiry, GetCaseand GetReturnAPIs now show: •Claim amount in listing currency •Fee credit details in listing currency •Amount seller owed for a refund in both listing currency and seller’s holding currency •Reimbursement details in seller’s holding currency getPaymentDisputemethod now shows: •Listing site's currency (convertedFromCurrency) •Seller's default currency (currency) •Exchange rate for the conversion (exchangeRate) The DisputeAmounttype was added to support this capability. getPayout(),getPayouts(), getPayoutSummary(), getTransaction(), GetTransactionSummary(), getTransfer(),and getSellerFundsSummarynow show: •Converted from and converted to currency •Converted from and converted to amount •Exchange rate at the time of transaction Disputes APIPost-order APIFinances API Fee Netting & Charging Fees are netted from proceeds of sales © 2021 eBay. All rights reserved.11 Sellers no longer will have a separate monthly fee invoice billed in arrears Charges of any kind are debited from available funds in the seller account Policy determines trigger points for when account is debited Bank is the default top-up method, but sellers can specify their preferred payment instrument in payment settings Recent enhancements in fee netting & charging © 2021 eBay. All rights reserved. New fields added to the following types used by the getPaymentDispute method under PaymentDispute type •monetaryTransactions: new array to provide details on transactions that occur when a dispute is resolved. •protectedAmount: new field that shows the amount that the seller is protected against in a dispute under eBay's seller protection policy. •totalFeeCredit: new field that shows the amount of money in selling fee credits due back to the seller Disputes API Added new fields to the GetCancellation, GetInquiry, GetCaseand GetReturnAPIs to expose the following details: •Fee credits due for a refund as per eBay’s fee credit policy •Net charge amount derived from subtracting the fee credit amount from the total charge •Details on the seller payment instrument used to fund buyer refunds Post-order API Recent enhancements in fee netting & charging © 2021 eBay. All rights reserved. Added a new endpoint getTransfer() to provide more details for seller transferring money to eBay for reimbursement of one or more charges. •A new transaction type ‘TRANSFER’ and a filter condition added getTransactions(), to explain seller transferring money to eBay for reimbursement of one or more charges. •In addition to the amount, funding source, currency, exchange rate and relevant identifiers for cancellations, returns, refunds, or other charges are provided •Mixed sources of funds are supported between balance, bank, and cards getTransactions() and getTransactionSummary() are updated: •To net the non-transaction fees(and corresponding credits) from the seller account balance. •A new transaction type ‘NON\_SALE\_CHARGE’ added for insertion fees, listing upgrade fees, and ad fees •A new transaction type ‘Adjustment’ added to notify any adjustments made to seller funds. •Updated transaction type –“SHIPPING\_LABEL” to help get details on the post-paid shipping charge Finances APIFinances API: getTransfer Further Enhancements & Changes Ahead Post-Order API © 2021 eBay. All rights reserved.15 New Post-Order APIs (as part of the fulfilment set of APIs): •In 2021, eBay will launch new post order APIs (as a part of the fulfilment API) that will enable sellers to cancel orders and manage cancellation requests, returns and item not received requests from buyers. •Additionally, new Refund Details API will be introduced to expose granular refund details including: •Fee credits due for a refund as per eBay’s fee credit policy •Details on the seller payment instrument used to fund buyer refunds Expected Improvements: •Simplified API structure with a fewer number of endpoints compared to to the existing Post-Order APIs •Light-weight response payload •Search improvements (includes supporting search by order number, issue ID, issue status and buyer username) •Next available actions based on the state of the issue •New endpoint for detailed activity history •Improved documentation with clearly defined error codes and failure reasons •Support for item-level cancellation Finances API © 2021 eBay. All rights reserved.16 Add International fee memo: Added international fee memo to the the getTransactions(), to provide more info (buyer country) about International fees added to the Final value Fee. Finances API planned enhancements: •Adding a memo to the the getTransactions() method for the orders on hold, to explain reason for transaction hold and timeframe of hold release. •Adding Bank reference ID to the getTransactions(), getPayout() and getPayouts() method, for easy reconciliation of payouts with seller’s bank account. •Adding Funds sent timeframe to the getTransactions(), getPayout() and getPayouts() method, to provide the timeframe it takes for funds to reach seller’s bank account after payout sent from eBay. --- # Unknown eBay Connect 2023 Condition Grading - Trading Cards Barry Lewis Sr. Product Manager, Selling - Inventory Management What Problems are We Trying to Solve with this Launch? Add consistency and structure to provide a clear understanding of an item’s condition for buyers & sellers Current aspect model does follow industry standards for condition grading, but it is unstructured as some aspects are optional with open fields Improve trust in the platform for buyers, while reducing the risk of fraud and returns for sellers Offering additional condition types on individual cards across sports trading cards, non-sports trading cards, and collectible card games will improve the quality of the listing. Simplify the seller experience Remove ambiguity Trading API Schema Schema Int String String String String Example 2750 27501 275010 27502 10 25703 A233434 Inventory API Schema Schema "conditionDescriptors": \[ { "name": "(string)", "values": \[ "(string)" \], "additionalInfo": ”(string)" } \] Example "conditionDescriptors": \[ { "name" : "27501", /\*Grader\*/ "values": \["275010"\] /\*PSA\*/ }, { "name" : "27502", /\*Grade\*/ "values": \["10"\] }, { "name" : "25703", /\*Certification Number\*/ "additionalInfo": "A233434" } \] The Sell Metadata Service for IDs and Conical Names Enhancements have been made to the Sell Metadata API: getItemConditionPolicies . This API will now return the condition descriptors for applicable categories 1 . Schema "conditionDescriptors": \[ { "conditionDescriptorName": "string", "conditionDescriptorId": "integer", "conditionDescriptorConstraint": { "cardinality": \[ "SINGLE", "MULTI" \], "usage": "REQUIRED", "mode": \[ "FREE\_TEXT", "SELECTION\_ONLY" \], "maxLength": "integer" }, "conditionDescriptorValues": \[ { "valueName": "string", "valueId": "integer", "valueConstraints": \[ { "applicableToDescriptorName": "string", "applicableToDescriptorValues": \[ "string" \] } \] } \] } \] 1 Sports Trading Cards (261328 ), Non-sports Trading Cards ( 183050), Collectible Card Games( 183454) Sample "conditionDescriptors": \[ { "conditionDescriptorName": "GRADE", "conditionDescriptorId": 1003, "conditionDescriptorConstraint": { "cardinality": \[ "MULTI" \], "usage": "REQUIRED", "mode": \[ "SELECTION\_ONLY" \] }, "conditionDescriptorValues": \[ { "valueName": "EXCELLENT-MT10", "valueId": 10031, "valueConstraints": \[ { "applicableToDescriptorName": "GRADER", "applicableToDescriptorValues": \[ "ABC", "XYZ" \] } \] } \] } \] The Buyer Experience Launch & Full Match Migration UI Mandate on New CG Structure Required for UI Clients June 26 Oct 2023 API Mandate on New CG Structure Required API Mandate on Revise CG Structure Required Jan 2024 UI Mandate on Revise & Partial Match Migration CG Structure Required for UI Clients Dates subject to change “Used” No Longer Recognized Condition Description Dropped UK & IE US & ROW July Launch Timeline --- # Unknown Ulrich Herberg Distinguished Engineer, Payments Deepak Sharma VP Payments and Risk Technology eBay Connect 2022 Payments Changes for Developer Ecosystem (DECO) Serving millions of buyersandsellersacross190 markets globally Managed Payments Buyer Choice Simplified Seller Operations Business Growth © 2022 e Bay. All rights reserved. 2 Support for eBay vault added to Trading API’s order management calls getOrdersresponse: ... ... eBay Vault ... ... EBAY ... © 2022 e Bay. All rights reserved. 3 Fulfillment API enhanced to return eBay Vault and new tax information getOrdersresponse: { ... "orders" : \[ { ... "program" : ... "ebayVault" : { "fulfillmentType" : "\[SELLER\_TO\_VAULT, VAULT\_TO\_VAULT, VAULT\_TO\_BUYER\]"}, eBay Vault Finances API updates © 2022 e Ba y. Al l ri ghts reserve d.4 getTransactionsnow provides additional information about three new VAT and income tax-related charges getTransactionsresponse: ... "transactions" : \[ { ... "feeJurisdiction" : { "regionName" : "string", "regionType" : "\[COUNTRY\]" }, "feeType" : "FeeTypeEnum: \[INCOME\_TAX\_WITHHOLDING, VAT\_WITHHOLDING, TAX\_DEDUCTION\_AT\_SOURCE\]", ... Finances API updates © 2022 e Ba y. Al l ri ghts reserve d.5 Motor vehicle listings that require initial deposits are now subject to a Deposit processing fee getTransactionsresponse: { ... "transactions" : \[ { ... "feeType" : "FeeTypeEnum: \[DEPOSIT\_PROCESSING\_FEE\]", ... Finances API updates © 2022 e Ba y. Al l ri ghts reserve d.6 Finances API enhanced to support on- demand payouts getTransactionSummaryresponse: { ... "withdrawalAmount" : { "convertedFromCurrency" : "\[AED,AFN,ALL...\]", "convertedFromValue" : "string", "currency" : "\[AED,AFN,ALL...\]", "exchangeRate" : "string", "value" : "string" }, "withdrawalBookingEntry" : "\[CREDIT,DEBIT\]", "withdrawalCount" : "integer" } Finances API updates © 2022 e Ba y. Al l ri ghts reserve d.7 Detailed order-level tax information now returned in Order v1 API getOrderv1 response: { ... "taxDetails": \[ { "amount": { "currency": " \[AED,AFN,ALL,...\]", "value": "string" }, "taxClassification": "\[DOMESTIC\_LEG\_TAX,HANDLING\_TAX,IMPORT\_TAX,INTERNATI ONAL\_LEG\_TAX,ITEM\_TAX,SERVICE\_TAX,SHIPPING\_IMPORT\_TA X,SHIPPING\_TAX\]", "taxClassificationDetails": \[ { "amount": { "currency": "\[AED,AFN,ALL,...\]", "value": "string" }, "taxType": "\[STATE\_SALES\_TAX,VAT,PROVINCE\_SALES\_TAX,REGION,GST\] " } © 2022 e Ba y. Al l ri ghts reserve d.8 Domestic and international shipping rate tables allow sellers to set fixed shipping costs based on the buyer’s location and the buyer’s selected shipping service option. getRateTableresponse: { "marketplaceId": "\[EBAY\_AT,EBAY\_AU,...\]", "name": "string", "rates": \[ { "additionalCost": { "currency": "\[AED,AFN,ALL,...\]", "value": "string" }, "rateId": "string", "shippingCategory": "\[ONE\_DAY,EXPEDITED,STANDARD,ECONOMY,EXPRESS\]", "shippingCost": { "currency": "\[AED,AFN,ALL,...\]", "value": "string" }, "shippingRegionNames": \[ "string" \], "shippingServiceCode": "string" } \], "rateTableBasis": "\[ITEM,WEIGHT,SURCHARGE\]", "rateTableId": "string", "shippingOptionType": "\[DOMESTIC,INTERNATIONAL\]" } New Shipping Rate Table APIs © 2022 e Ba y. Al l ri ghts reserve d.9 Additionally, sellers can also set weight and handling charges to shipping costs. updateShippingCostresponse: { "rates": \[ { "additionalCost": { "currency": "\[AED,AFN,ALL,...\]", "value": "string" }, "rateId": "string", "shippingCost": { "currency": "\[AED,AFN,ALL,...\]", "value": "string" } } \] } New Shipping Rate Table APIs eBay Connect 2022 Payment Account Ulrich Herberg Distinguished Engineer, Payments What is a Payment Account and why do we need to support it? © 2022 e Ba y. Al l ri ghts reserve d.12 EU and UK law requires that if a payment institution allows payment service users (for eBay: sellers) to initiate payments to a third party, those services must be structured as a “payment account.” The following features require support for Payment Accounts: •Seller-initiated refunds and returns •On-demand payouts •Stored value (eBay balance payment at checkout) •Shipping labels (purchase and refund) Multi-factor authentication (MFA) requirements at various user flows © 2022 e Ba y. Al l ri ghts reserve d.13 MFA for transactional and non-transactional flows •MFA for accessing and updating payment sensitive data •Customer name, email address, phone #, user ID, password and CC/bank account information •MFA for payment initiation •MFA required before initiating payment using Stored value What are we asking from developers? © 2022 e Ba y. Al l ri ghts reserve d.14 •European regulation on Strong Customer Authentication (SCA) requires us to perform multi-factor authentication for our EU/UK sellers •As per our Legal guidance, we can perform the SCA on the developer application making API calls •SCA has to be performed for: •Certain APIs only (retrieving payment sensitive data or initiating payments) •For EU/UK sellers only •We require the following two factors: •OAuth access token (existing, nothing new) •Digital Signature added as HTTP header •Details here:https://developer.ebay.com/develop/guides/digital-signatures-for-apis Which APIs are Impacted? © 2022 e Ba y. Al l ri ghts reserve d.15 •All methods in theFinances API •issueRefundin the Fulfillment API •GetAccountin the Trading API •The following methods in the Post-Order API: •Issue Inquiry Refund •Issue case refund •Issue return refund •Process Return Request •Approve Cancellation Request •Create Cancellation Request How to add the Digital Signatures? © 2022 e Ba y. Al l ri ghts reserve d.16 •Standards-based solution based on upcoming IETF standards: •https://www.ietf.org/archive/id/draft-ietf-httpbis-message-signatures-11.html •https://www.ietf.org/archive/id/draft-ietf-httpbis-digest-headers-10.html •There are some open-source implementations out there, and more will follow once these drafts become RFCs •Four HTTP headers need to be added: •Content-Digest:SHA-256 digest over the HTTP payload, if any. •x-ebay-signature-key:JWE as provided via the developer portal •Signature-Input:Indicates which headers and pseudo-headers and in which order •Signature:Actual signature Sample Signature © 2022 e Ba y. Al l ri ghts reserve d.17 HTTP Message: POST http://localhost:8080/verifysignature HTTP/1.1 Host: localhost:8080 Date: Wed, 31 Aug 2022 02:07:55 GMT Content-Type: application/json Content-Length: 18 {"hello": "world"} Additional Headers: Signature-Input: sig1=("content-digest" "x-ebay- signature-key" "@method" "@path" "@authority");created=1658440308 Content-Digest: sha- 256=:X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=: Signature: sig1=:ZMUpAejnqrt6POSx02ltx3cT9YODV2r+Cem/BKOagDSfztKOtC sjP/MxZqmY+FVJ3/8E4BL76T9Fjty8oJnsAw==: x-ebay-signature-key: eyJ6aXAiOiJERUYiLCJlbmMiOiJBMjU2R0NNIiwidGFnIjoiSXh2dVRM b0FLS0hlS0Zoa3BxQ05CUSIsImFsZyI6IkEyNTZHQ01LVyIsIml2Ijoi aFd3YjNoczk2QzEyOTNucCJ9.2o02pR9SoTF4g\_5qRXZm6tF4H52Tari lIAKxoVUqjd8.3qaF0KJN-rFHHm\_P.AMUAe9PPduew09mANIZ- O\_68CCuv6EIx096rm9WyLZnYz5N1WFDQ3jP0RBkbaOtQZHImMSPXIHVa B96RWshLuJsUgCKmTAwkPVCZv3zhLxZVxMXtPUuJ- ppVmPIv0NzznWCOU5Kvb9Xux7ZtnlvLXgwOFEix- BaWNomUAazbsrUCbrp514GIea3butbyxXLNi6R9TJUNh8V2uan- optT1MMyS7eMQnVGL5rYBULk.9K5ucUqAu0DqkkhgubsHHw How to test digital signature implementation © 2022 e Ba y. Al l ri ghts reserve d.18 •In Sandbox and production starting September 30, 2022. •Invalid signatures will lead to a 403 •Missing signatures will be enforced by January 31, 2023 •Key material can be acquired on the developer portal when logged in, starting Sep 30, 2022 •Until then, developers can test it using a local test environment •See https://developer.ebay.com/develop/guides/digital-signatures-for-apisfor githubcode and Docker container Demo --- # Unknown eBay Connect 2020 Managed Payments API Overview June 2020 eBay Connect 2020 Agenda Managed Payments Journey Account API Listings & Business Policies Orders Finances API & Trading: Account API Post Transaction Q & A © 2020 e Ba y. Al l ri ghts reserve d.2 Our Payments Journey © 2020 e Ba y. Al l ri ghts reserve d.3 2018 Announced we’d offer managed payments Launch Full Rollout 2019 Introduced Google Pay and PayPal at checkout Expand managed payments experience across eBay’s global marketplace 2021 Journey will be largely complete 2020 Managed payments rolled out to select US sellers Introduced Apple Pay at checkout Expanded managed payments offering to Germany Account API Onboarding status, program enrollment & KYC Account API: Onboarding Status & Payments Program © 2020 e Ba y. Al l ri ghts reserve d.5 Check if the seller is in Managed Payments Check the seller's eligibility Encourage them to complete registration Account API: Managed Payments Onboarding Status GET https://api.ebay.com/sell/account/v1/ payments\_program/EBAY\_US/EBAY\_PAYMENTS/ onboarding © 2020 e Ba y. Al l ri ghts reserve d.6 API consumers can: •Check aseller’s eligibility for Managed Payments •Their current onboarding step •Retrieve the URL to continue the flow on eBay { "onboardingStatus": "ELIGIBLE\_TO\_ONBOARD", "steps": \[ { "name": "1. businessType", "status": "IN\_PROGRESS", "webUrl": "https://ebay.com/validate-user" }, { "name": "2. accountInfo", "status": "NOT\_STARTED" }, { "name": "3. payoutInfo", "status": "NOT\_STARTED" }, { "name": "4. review", "status": "NOT\_STARTED" } \] } May Account API: Payments Program GET https://api.ebay.com/sell/account/v1/ payments\_program/EBAY\_US/EBAY\_PAYMENTS © 2020 e Ba y. Al l ri ghts reserve d.7 { "marketplaceId": "EBAY\_US", "paymentProgramType": "EBAY\_PAYMENTS", "status": "OPTED\_IN", "wasPreviouslyOptedIn": "false" } May Account API: KYC GET https://api.ebay.com/sell/account/v1/kyc © 2020 e Ba y. Al l ri ghts reserve d.8 { "kycChecks": \[ { "dataRequired": "COMPANY\_DETAILS", "alert": "Update business info now.", "remedyUrl":"https://www.ebay.com/sellerhub", "dueDate": "2020-07-22T00:00:00.000Z", "detailMessage": "Please update your business info by July 22, 2020 to get your account back in good standing." }, { "dataRequired": "BANK\_DETAILS", "alert": "Upload bank document now.", "remedyUrl": "https://www.ebay.com/sellerhub", "dueDate": "2020-08-01T00:00:00.000Z", "detailMessage": "Please upload a bank document by August 1, 2020 to get your account back in good standing." } \] } June Listings & Business Policies Changes in Listings & Business Policies for Managed Payments © 2020 e Ba y. Al l ri ghts reserve d.10 Trading API & Inventory API No value is required for Payment Method or PayPal payment address. Any data provided will be dropped. Business Policies No value is required for Payment Method or PayPal payment address. Any data provided or in existing policies will be dropped. Orders Order details for purchased items Order Payment Methods © 2020 e Ba y. Al l ri ghts reserve d.12 The paymentMethodfield in the getOrdermethods returns the payment method used by a buyer to pay for an order. Fulfillment API: getOrder EBAYvalue will be returned for all orders where payment is made on the eBay platform. Other offline values may also be available. Trading API: GetOrders CheckoutStatus.PaymentMethodenumvalue will be CreditCardfor managed payments orders or CCAcceptedfor orders paid with eBay Gift Card. Fulfillment API Designation Description EBAY The buyer payment is managed by eBay, and payment can be considered complete from seller’s perspective CASHIER\_CHECKThe buyer will pay with a cashier’s check or money order offline PERSONAL\_CHECKThe buyer will pay with a personal check CASH\_ON\_PICKUPThe buyer will pay with cash EFTThe buyer will pay with an off-platform electronic funds transfer Fulfillment API: Get Order GET https://api.ebay.com/sell/fulfillment/v1/ order/1234567?fieldgroups=TAX\_BREAKDOWN Trading API getOrderand getItemTransactions methods also return tax and recycling fee details. © 2020 e Ba y. Al l ri ghts reserve d.13 { "ebayCollectAndRemitTax": true, "pricingSummary": { ... "fee": { "value": "6.0", "currency": "USD" } }, "lineItems": \[ { "lineItemId": "6319232829195", "taxes": \[ { "amount": { "value": "24.33", "currency": "USD" }, "taxType": "STATE\_SALES\_TAX" }, { "amount": { "value": "6.0", "currency": "USD" }, "taxType": "ELECTRONIC\_RECYCLING\_FEE" }\], "ebayCollectAndRemitTaxes": \[ { "taxType": "STATE\_SALES\_TAX", "amount": { "value": "24.33", "currency": "USD" }, "collectionMethod": "NET" }, { "taxType": "ELECTRONIC\_RECYCLING\_FEE", "amount": { "value": "6.0", "currency": "USD" }, "collectionMethod": "NET" }\], } \] } June Finances API Financial activity and fees You Can Now Track Your Funds on eBay Finances API enables sellers to get payout status and balances for financial and reconciliation operations. © 2020 e Ba y. Al l ri ghts reserve d.15 eBay Payout User Experience © 2020 e Ba y. Al l ri ghts reserve d.16 Seller Funds Summary eBay Payout User Experience © 2020 e Ba y. Al l ri ghts reserve d.17 Seller Funds Summary Finances API: Get Seller Funds Summary GET https://apiz.ebay.com/sell/finances/v1/ seller\_funds\_summary © 2020 e Ba y. Al l ri ghts reserve d.18 { "totalFunds": { "value": "334.86", "currency": "USD" }, "processingFunds": { "value": "198.6", "currency": "USD" }, "availableFunds": { "value": "118.47", "currency": "USD" }, "fundsOnHold": { "value": "17.79", "currency": "USD" } } October 2019 eBay Payout User Experience © 2020 e Ba y. Al l ri ghts reserve d.19 Payout Id Payout Summary Payouts Finances API: Get Payout Summary Retrieve cumulative values for payouts in a particular state, or all states GET https://apiz.ebay.com/sell/finances/v1/ payout\_summary © 2020 e Ba y. Al l ri ghts reserve d.20 { { "payoutCount": 4, "transactionCount": 10, "amount": { "value": "467.9", "currency": "USD" } } October 2019 Finances API: Get Payouts GET https://apiz.ebay.com/sell/finances/v1/payout © 2020 e Ba y. Al l ri ghts reserve d.21 { "href": "https://apiz.ebay.com/sell/finances...", "limit": 20, "offset": 0, "payouts": \[ { "payoutId": "57777854584", "payoutStatus": "SUCCEEDED", "payoutStatusDescription": "Funds sent", "amount": { "value": "317.93", "currency": "USD" }, "payoutDate": "2018-12-20T03:50:53.000Z", "transactionCount": 7, "payoutInstrument": { "instrumentType": "BankAccount", "nickname": "Chase", "accountLastFourDigits": ”1234" } } ... \], "total": 10 } October 2019 Finances API: Get Transactions Retrieve one or monetary transactions. In this case, 'monetary transactions' include sales orders, buyer refunds, and seller credits, along with their status GET https://apiz.ebay.com/sell/finances/v1/ transaction?filter=transactionType: {SALE}&filter=transactionStatus:{FUNDS\_ON\_HOLD} © 2020 e Ba y. Al l ri ghts reserve d.22 "transactions": \[ { "transactionId": "200009081244-9734029010!", "orderId": "01-03955-36441", "salesRecordReference": "441", "buyer": { "username": "rrpbuyer2" }, "transactionType": "SALE", "amount": { "value": "207", "currency": "USD" }, "bookingEntry": "CREDIT", "transactionDate": "2018-11-09T02:42:14.000Z", "transactionStatus": "FUNDS\_ON\_HOLD" }, { "transactionId": "200009081244-9734028010!700822310", "orderId": "01-04966-46542", "salesRecordReference": "440", "buyer": { "username": "rrpbuyer2" }, "transactionType": "SALE", "amount": { "value": "207", "currency": "USD" }, "bookingEntry": "CREDIT", "transactionDate": "2018-11-09T02:38:40.000Z", "transactionStatus": "FUNDS\_ON\_HOLD"}\] October 2019 Support for Shipping Labels © 2020 e Ba y. Al l ri ghts reserve d.23 eBay is billing sellers' accounts directlyfor eBay-generated shipping labels when the seller is in Managed Payments. eBay shipping label fees are returnedinthe getTransactionsand getTransactionSummary methods Finances API: Get Transactions (Shipping Labels) GET https://apiz.ebay.com/sell/finances/v1/ transaction?filter=transactionType: {SHIPPING\_LABEL} © 2020 e Ba y. Al l ri ghts reserve d.24 { "href": "https://apiz.ebay.com/finances/v1...", "limit": 20, "offset": 0, "transactions": \[ { "transactionId": "26-000-7350", "orderId": "07-00010-54953", "payoutId": "50077766689863", "salesRecordReference": "0", "buyer": { "username": "rrp\_buyer1" }, "transactionType": "SHIPPING\_LABEL", "amount": { "value": "1.87", "currency": "USD" }, "bookingEntry": "CREDIT", "transactionDate": "2020-02-10T07:51:10.000Z", "transactionStatus": "PAYOUT", "transactionMemo": "Refund -underpaid postage dispute accepted" }, .... \], "total": 16 } February Finances API: Dispute Transactions © 2020 e Ba y. Al l ri ghts reserve d.25 getTransactionsand getTransactionSummary methods now return dispute information when adispute is initiated by the buyer through their payment provider The new DISPUTEvalue intheTransactionTypeEnumtype canbeused withthetransactionTypefilter in agetTransactionsorgetTransactionSummary method to limit transaction type to payment disputes. Finances API Fee Updates: New Fields © 2020 e Ba y. Al l ri ghts reserve d.26 FieldDescription amount Amount by which seller’s virtual account balance is adjusted.For sellers with fees netted, fees are removed. totalFeeBasisAmount Amount paid to seller for order before eBay fees. Includes price discounts & shipping. totalFeeAmountAmount of fees paid to eBay at time of order. orderLineItems Order line item level specific fees paid to eBay at time of order. Finances API Fee Updates: Get Transactions GET https://apiz.ebay.com/sell/finances/v1/ transaction?filter=transactionType: {SALE}&filter=transactionDate: \[2020-05-01T00:00:01.000Z..2020-05 10T00:00:01.000Z\] © 2020 e Ba y. Al l ri ghts reserve d.27 { "transactions": \[ { "transactionId": "200009081244-...", "orderId": "01-03955-1111", "salesRecordReference": "44", "buyer": { "username": "rrpbuyer2" }, "transactionType": "SALE", "amount": { "value": “175", "currency": "USD" }, "totalFeeBasisAmount": { "value": “200", "currency": "USD" }, "totalFeeAmount": { "value": “25", "currency": "USD" }, "bookingEntry": "CREDIT", "transactionDate": "2020-02-09T02:42:14.000Z", "transactionStatus": "FUNDS\_ON\_HOLD" "paymentsEntity": "eBay S.àr.l." }, ... \], ... } June Finances API Fee Updates: Fee Types © 2020 e Ba y. Al l ri ghts reserve d.28 Fee typeDescription BELOW\_STANDARD\_FEEFee for below standard performance BELOW\_STANDARD\_SHIPPING\_FEE Fee on shipping for Below Standard performance FINAL\_VALUE\_FEE\_PER\_ORDERFixed FVF for fee-netted sellers FINAL\_VALUE\_FEEVariable FVF for fee-netted sellers INTERNATIONAL\_FEEFee for cross-border orders HIGH\_ITEM\_NOT\_AS\_DESCRIBED\_FEE Fee charged for buyer Significantly Not as Described claim HIGH\_ITEM\_NOT\_AS\_DESCRIBED\_SHIPPING\_FEE Fee charged on shipping for buyer Significantly Not as Described claim OTHER\_FEES Any other fees assessed The feeTypefieldin thegetTransaction methods returns the fee type associated with the OrderLineItem Finances API Fee Updates: Order Line Items GET https://apiz.ebay.com/sell/finances/v1/ transaction?filter=transactionType:{SALE}& filter=transactionDate: \[2020-05-01T00:00:01.000Z..2020-05- 10T00:00:01.000Z\] ‘orderLineItems’ = array of specific fees paid to eBay at time of order © 2020 e Ba y. Al l ri ghts reserve d.29 June { "transactions": \[ { ... "orderLineItems" : { "orderLineItemId" : "323438071240-0", "feeBasisAmount" : { "currency": "EUR", "value": "150" } "fees" : \[ { "feeType" : "Final\_Value\_Fee", "amount": { "currency": "EUR", "value": "15” } }, { "feeType" :"Below\_Standard\_Fee", "amount" : { "currency": "EUR", "value": "2“ } } }, ... \], ... } Trading API: GetAccount ... boolean ... © 2020 e Ba y. Al l ri ghts reserve d.30 string AmountType(double) AmountType(double) AmountType(double) boolean ... ... June Post Transaction Disputes, Refunds, Returns, Cancellations Fulfillment API: Payment Disputes © 2020 e Ba y. Al l ri ghts reserve d.32 For sellers to manage buyer-initiated payment disputes Payment dispute detail includes •Current status of payment dispute •Amount of the payment dispute •Reason the payment dispute was opened •Order and line items associated with the payment dispute •Seller response options if an action is currently required on the payment dispute •Details on the results of the payment dispute if it has been closed •Details on any evidence that was provided by the seller Sellers respond by •Accepting the payment dispute •Contesting •Adding evidence and uploading evidence files •Updating evidence Fulfillment API: Get Payment Dispute GET https://api.ebay.com/sell/fulfillment/v1/ payment\_dispute/7654321 © 2020 e Ba y. Al l ri ghts reserve d.33 { "paymentDisputeId": "7654321", "paymentDisputeStatus": "OPEN", "revision": 2, "reason": "FRAUD", "orderId": "22-00009-21", "buyerUsername": "ebaybuyer", "openDate": "2019-10-03T20:07:17.000Z", "respondByDate": "2019-10-09T06:59:59.000Z", "lineItems": \[ { "itemId": "300013704248", "lineItemId": "5712077022“ } \], "amount": { "value": "250.0", "currency": "USD" }, "sellerResponse": "SELLER\_ACCEPT", "buyerProvided": { "note": "I have issue with the transaction" } } March Fulfillment API: Contest Payment Dispute POST https://api.ebay.com/sell/fulfillment/v1/ payment\_dispute/1234567/contest © 2020 e Ba y. Al l ri ghts reserve d.34 { "revision": 1, "returnAddress": { "primaryPhone": { "number": "4081234567", "countryCode": "US" }, "fullName": "Joe Smith", "addressLine1": ”2050 Hamilton Ave", "addressLine2": "Apt 77", "city": "Sunnyvale", "stateOrProvince": "CA", "postalCode": "94087-5527", "country": "US" } } March Fulfillment API: Seller Initiated Refunds © 2020 e Ba y. Al l ri ghts reserve d.35 Fulfillment API: Seller Initiated Refund POST https://api.ebay.com/sell/fulfillment/v1/order/ {order\_id}/issue\_refund © 2020 e Ba y. Al l ri ghts reserve d.36 June 2019 Request { "orderLevelRefundAmount": { "value": "1.0", "currency": "USD" }, "reasonForRefund": "BUYER\_CANCEL", "comment": "Buyer changed mind and requested cancellation of order" } Response { "refundId": "5000000453", "refundStatus": "PENDING" } Post-Order API © 2020 e Ba y. Al l ri ghts reserve d.37 All Post Order 1.0 features will be available for managed payment sellers. Coming in July: Refund summary with information on how the refund was funded Ability to offer partial refunds via Post Order API when a buyer requests a return with the same eligibility rules as in 1.0 Coming post-July: Support for converted refund and held amounts based on FX conversion rates for Active CBT transactions Sell-side post order functionality as part of Fulfillment API Post-Order API: funding for refunds/returns GET https://api.ebay.com/post- order/v2/inquiry/{inquiryId} © 2020 e Ba y. Al l ri ghts reserve d.38 2019 "moneyMovementEntryList": \[ { "date": { "value": "2020-04-13T20:54:00.823Z" }, "amount": { "value": -24.0, "convertedFromValue": -24.0, "convertedFromCurrency": "USD", "currency": "USD" }, "type": "REFUND", "fundingSource": { "type": "CREDIT\_CARD", "brand": "VISA", "memo": "Last four digits is 0007" }, "fundingStatus": "FUNDED", } \] © 2020 e Ba y. Al l ri ghts reserve d.39 --- # Unknown eBay Connect 2023 Developer Program Updates Nandha Palanisamy Head of Developer Ecosystem eBay Connect 2023 © 2023 eBay. All rights reserved.2 July 25, 2023 @ 9am Content: •Developer program updates •Payment updates •Focus Categories •Seller Experience Updates •Buy APIs •DSA •Awards eBay Connect 2023 Agenda © 2023 eBay. All rights reserved.3 Global Marketplace Developer Program Updates New in APIs API Security Deprecations 133M Active Buyers Worldwide 1.8B Active Listings 190 Supported Marketplaces $18.4B GMV Q2 2023 4© 2023 eBay. All rights reserved. Global Marketplace \*The stats are as of; Q1,2023 Acquire new buyers, sellers, and partners eBay’s APIs are changing the way partners do business \*GMB = gross merchandise bought; Q1,2023 Unlocking API Potential © 2023 eBay. All rights reserved. Grow GMB and revenue Empower buying and selling anywhere Expand our global reach Developer Program © 2023 eBay. All rights reserved.6 Simple, secure, consistent and well-documented API portfolio Tools and SDK’s Communication and tech support New Developer Forums Partner Testimony - Linnworks © 2021 eBay. All rights reserved.7 © 2023 eBay. All rights reserved.8 API Portfolio Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxonomy Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Translation Offer Analytics Listing Identity Recommen- dation Charity Feed Sell BuyCommerceDeveloper \* Limited Release Deal Media Notification Finances Legacy APIs Trading API Shopping API Finding API Client Registration Key Management New in APIs Compliance Digital Service Act EU Payments Buyer and Seller Success Condition Grading Certified Refurbished Shipping Initiatives eBay Managed Shipping eBay International Shipping © 2023 eBay. All rights reserved.9 Other API Updates Order API Auctions Checkout Notification API Real Time Item Updates Subscription Filters Translation API New Language Pairs © 2023 eBay. All rights reserved.10 SDKs © 2023 eBay. All rights reserved.11 Digital Signature SDK (Node.js) Digital Signature SDK (Java) Priority Listing Revisions topic in Notification SDK ( Node.js ) Priority Listing Revisions topic in Notification SDK (Java ) https://github.com/eBay © 2023 eBay. All rights reserved.12 HTTPS Enforcement TLS 1.2 API Security HTTPS Enforcement TLS 1.2 © 2023 eBay. All rights reserved.13 API(s)/Field(s)Decommission Date GetMyeBayReminders7/17/23 GetCharities9/18/23 GetOrderTransactions1/31/24 GetSellerDashboard4/2/24 ShippingDetails.CODCost field (AddItem family of calls)7/17/23 PictureDetails.PhotoDisplay (AddItem family of calls)7/31/23 Numerous fields in Trading order management calls1/31/24 (see Deprecation Status page for full list) Return Management APITBD Deprecations --- # Unknown eBay Connect 2021 Welcome! Tanya Vlahovic Head of Developer Ecosystem Welcome / Agenda © 2021 eBay. All rights reserved.2 Date / TimeContent June 14 @ 9 AM PT Managed Payments APIs Ads Selling Product Updates New Sell API Capabilities EU VAT Fireside Chat With eBay CTO MazenRawashdeh June 15 –16eBay Connect Virtual Lounge July 12 @ 9 AM PT All About APIs Buyer Experience Media API New Buy API Capabilities Fulfillment API Security Updates New Notifications Fireside Chat With eBay Chief Architect Randy Shoup July 13 –14eBay Connect Virtual Lounge APIs for Good Cause U.K. NHS PPE Portal More than 3B PPE items distributed eBay for Charity $35M raised in Q1 © 2021 eBay. All rights reserved.4 API Portfolio Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxo no my Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Translation Offer Analytics Listing Identity Recommen- dation Charity Feed Sell Buy Commerce Developer \* Limited Release Deal Media Notification Finances --- # Unknown What’s New in Buying Nicole Inouye Director of Product Management, Buyer Engagement & Personalization June 25, 2019 Search Experiences Refine by Item Specifics Refining Search Results Search Results for New Customers \` Image Search Search by Item Specifics Promoted Listings on Search Improved Buying Experiences Guest Checkout Guest to Member Upgrades Compressed Browse Pages Volume Discounts Buy it Again Coupons Best Offer Offer to Buyers Personalized Experiences 62 Improved Watching and Saving Personalized Promoted Listings Guest Personalization Improved Home Page Personalization Trending in Your Interests Thank you! Q&A eBay Connect 2019 June 25-26, 2019 --- # Unknown Seller Ad & Marketing Levers June 25, 2019 Gwendoline Tuma Senior Manager, Strategic Product & Planning Agenda Why Are Ads Relevant For Sellers? Feature Overview Developer Workflows Integrating the Promoted Listing Experience 1 2 3 4 Promoted Listings Why Are Ads Relevant For Sellers? Promoted Listings Why Promote? Stand out from the crowd Show up in sponsored placements across the site, including search and listing modules Drive visibility Boost item visibility by 36% with Promoted Listings Increase sales Sellers pay only when their Promoted Listings sell \*Average based on a comparison of item page views before and after activating promoted listings in 2018. Where are Promoted Listings Found? Listing pages across platformsSearch river across platforms “Since November 1 st , we have done $147K in sales with only $9.4K in ad fees.” –Spokesperson –Kenneth Hanson, Digital Marketplace Manager, Reebok Reebok Doubles Sales with Promoted Listings ObjectiveStrategy Increase sales and exposure for Reebok products such as shoes, athletic clothing, and more with eBay’s Promoted Listings Promote inventory with more than 100 units Follow eBay’s trending ad rate guidance to stay competitive 55% Lift in overall sales 142% Lift in sales for promoted items 15:1 Return on ad spend +130% 5,33512,259 Units sold of the promoted items “We take an aggressive approach to our marketing strategy on eBay.We believe visibility is everything, and key to getting sales.” –Bodybuilding Warehouse, 2018 Bodybuilding Warehouse Grew Brand by Investing in Promoted Listings Sales velocity Boost visibility for new listings or newly launched brands 7X Return on advertising through Promote Your Listings\* \*1st January –31 October 2018 Objective Invest heavily into retail moments and seasonality with competitive ad rates Combine visibility levers with deals for additional exposure Strategy Promoted Listings Feature Overview APIs for Promoted Listings Sellers promote listings created through either Inventory API or Trading API Inventory API Trading API Marketing API Promoted listings experience Recommendation API Extensive Capabilities Unlocked through the Marketing and Recommendations APIs Campaign Management Listing/Bid ManagementReporting createCampaign getCampaign cloneCampaign deleteCampaign pauseCampaign endCampaign updateCampaignIdentification createAd getAd updateBid bulkCreateAds bulkUpdateAdsBid findListingRecommendations •promoteWithAd •bidPercentage createReportTask getReport getReportMetadata getReportMetadataforReportType We Power Recommendations to Create Stronger and Effective Campaigns... eBay’s algorithms determine which seller listings can benefit the most with the increased visibility that Promoted Listings provides Trending ad rates give sellers insight into average Promoted Listings rates for sold listings within the same category. 14 Promoted Listing Recommendations Trending Ad Rates ...To Make Promoted Listings Available at Sellers’ Fingertips 15 Developer Workflows Promoted Listings Yes No Use the Marketing API to add recommended listings and ad rates to the campaign\* Use the Recommendation API for listings’ recommended ad rates\* Use the Marketing API to add listings and ad rates to the campaign The campaign is ready Use the Marketing API to create the campaign Rule-based campaign? No Yes \*SKU based inventory is currently not supported Use Recommendation API for PL recommendations A seller wants to create a campaign Additional listings? Use Marketing API to create the campaign WORKFLOW Creating Campaigns Yes Yes Yes No No No \*SKU based inventory is currently not supported A seller wants to create a campaign Rule-based campaign? Use Recommendation API for PL recommendations Use the Marketing API to add recommended listings and ad rates to the campaign\* Use the Recommendation API for listings’ recommended ad rates\* Use the Marketing API to update ad rates for the existing ads The campaign is ready The rule-based campaign can not be changed Use the Marketing API to add listings or update ad rates Apply recommended ad rates to existing ads? WORKFLOW Updating Existing Campaigns Add recommended listings? Yes No A seller wants to get a campaign performance report Use Marketing API to retrieve report metadata Use the Marketing API to request report Use the Marketing API to poll for the report generation status Report ready? The report is ready Use the Marketing API to download the report WORKFLOW Download Campaign Performance Report Integrating the Promoted Listing Experience Promoted Listings POST https://api.ebay.com/sell/marketing/v1/ ad\_campaign Authorization scope: https://api.ebay.com/oauth/api\_scope/ sell.marketing { "campaignCriterion": "listingId":"190007022517", "campaignName": "Spring Sale", "startDate": "2019-03-27T10:00:000Z", "endDate": "2019-05-27T11:00:00.000Z", "fundingStrategy": { "bidPercentage": "10", "fundingModel": "COST\_PER\_SALE" }, "marketplaceId": "EBAY\_US" } MARKETING API Promote Listings POST https://api.ebay.com/sell/marketing/v1/ ad\_campaign Authorization scope: https://api.ebay.com/oauth/api\_scope/ sell.marketing { "campaignCriterion": "listingId":"190007022517", "campaignName": "Spring Sale", "startDate": "2019-03-27T10:00:000Z", "endDate": "2019-05-27T11:00:00.000Z", "fundingStrategy": { "bidPercentage": "10", "fundingModel": "COST\_PER\_SALE" }, "marketplaceId": "EBAY\_US" } Support for rules-based, listingID, and SKU-based selections MARKETING API Promote Listings Rule-Based Campaigns Select items to include in a campaign using a set of criteria, or “rules”, that you specify when you create the campaign Set rules according to a combination of brands, category IDs, item conditions, and max/min prices ... "campaignCriterion" : { "criterionType" : "INVENTORY\_PARTITION", "selectionRules" : \[ { "brands" : \["string"\], "categoryIds" : \["string"\], "categoryScope" : "MARKETPLACE or STORE", "listingConditionIds" : \["string"\], "maxPrice" : { "currency" : "string", "value" : "string" }, "minPrice" : { "currency" : "string", "value" : "string" } } \] } ... Create Campaign in Full Campaign Management Experience Integrate a Simple Experience Active Listings OverlayListing Flow Overlay Integrate a Simple Experience Marketing API: "fundingStrategy": { "bidPercentage": "10", "fundingModel": "COST\_PER\_SALE" Active Listings OverlayListing Flow Overlay Recommendation API: "listingId": "190007022517", "marketing": { "ad": { "promoteWithAd": "RECOMMENDED", "bidPercentages": \[ { "value": "10", "basis": "TRENDING" Active Listings OverlayListing Flow Overlay \*Note, Recommendation API returns Trending Ad Rate values for existing listingIDs. MARKETING API Integrate a Simple Experience MARKETING API Integrate a Simple Experience Marketing API: "campaignName": ”US Campaign June 18, 2019 13:32:56", "startDate": "2019-03-27T10:00:000Z", "endDate": ”null", getCampaign to return a list of existing campaigns or Auto-generate a campaignName with a unique string using a Counter or Timestamp mechanism Active Listings OverlayListing Flow Overlay MARKETING API Integrations for Bulk Use Cases POST https://api.ebay.com/sell/recommendation/v1/ Listing\_recommendation/find? filter=recommendationType={AD} Authorization scope: https://api.ebay.com/oauth/api\_scope/ sell.marketing { "listingRecommendations": \[ { "listingId": "190007022517", "marketing": { "ad": { "promoteWithAd": "RECOMMENDED", "bidPercentages": \[ { "value": "10", "basis": "TRENDING" } \], } } } ... \] } { "listingIds": \["190007022517", "180007603375"\] } RECOMMENDATION API Find Ads Recommendations POST https://api.ebay.com/sell/marketing/v1/ ad\_campaign/100052103014/ad { "listingId": "190007022517", "bidPercentage": "10" } MARKETING API Ad Listings to Campaign POST https://api.ebay.com/sell/marketing/v1/ ad\_campaign/100052103014/ bulk\_create\_ads\_by\_inventory\_reference { "responses": \[ { "statusCode": 201, "inventoryReferenceType": "INVENTORY\_ITEM", "inventoryReferenceId": "66352443", "ads": \[ { "adId": "10039758018", "href": "https://.../10001741014/ad/10039758018" } \] }, { "statusCode": 201, "inventoryReferenceType": "INVENTORY\_ITEM", "inventoryReferenceId": "66352444", "ads": \[ { "adId": "10039759018", "href": "https://.../10001741014/ad/10039759018" } \] } \] } { "requests": \[ { "bidPercentage": "12", "inventoryReferenceId": "66352443", "inventoryReferenceType":"INVENTORY\_ITEM" }, { "bidPercentage": "10", "inventoryReferenceId": "66352444", "inventoryReferenceType":"INVENTORY\_ITEM" } \] } MARKETING API Add Inventory to Campaign in Bulk Pause Managing Campaigns { "campaignId": "100052103014", "startDate": "2019-03- 27T11:00:00.000Z", "endDate": "2019-05- 27T11:00:00.000Z", "campaignName": "Spring Sale", "fundingStrategy": { "fundingModel": "COST\_PER\_SALE", "bidPercentage": "10" }, "campaignStatus": "RUNNING", "marketplaceId": "EBAY\_US" } Resumes a paused campaign Pauses an active campaign Ends an active or paused campaign Deletes an ended campaign Resume DeleteEnd Reporting Promoted Listings Capabilities to Build Robust Interfaces or Simple Downloadable Reports CAMPAIGN\_PERFORMANCE\_REPORT CAMPAIGN\_PERFORMANCE\_SUMMARY\_REPORT ACCOUNT\_PERFORMANCE\_REPORT LISTING\_PERFORMANCE\_REPORT INVENTORY\_PERFORMANCE\_REPORT Report types impressions clicks ad\_clicks sales sale\_amount ctr avg\_cost\_per\_sale ... campaign\_id listing\_id day inventory\_reference\_id inventory\_reference\_type listing\_title \* listing\_start\_date \* ... Dimensions (the attributes of the data included in the reports) Metrics (the quantitative measurements) \* Dimension annotation MARKETING API Report Dimensions and Metrics POST https://api.ebay.com/sell/marketing/v1/ ad\_report\_task Authorization scope: https://api.ebay.com/oauth/api\_scope/ sell.marketing { "marketplaceId": "EBAY\_US", "reportType": "CAMPAIGN\_PERFORMANCE\_REPORT", "dateFrom": "2019-03-01T00:00:00.000Z", "dateTo": "2019-03-27T00:00:00.000Z", "dimensions": \[ { "annotationKeys": \[ "campaign\_name", "campaign\_start\_date", "campaign\_end\_date" \], "dimensionKey": "campaign\_id" }, { "annotationKeys": \[ "listing\_title", "listing\_quantity\_sold" \], "dimensionKey": "listing\_id" } \], "metricKeys": \["CLICKS"\], "reportFormat": "TSV\_GZIP", "campaignIds": \["10000000019"\] } MARKETING API Initiate Report Generation GET https://api.ebay.com/sell/marketing/v1/ ad\_report\_task/10000049014 { "marketplaceId": "EBAY\_US", "reportType": "CAMPAIGN\_PERFORMANCE\_REPORT", "reportTaskId": "10000049014", "reportTaskExpectedCompletionDate": "2017-03-11T19:41:54.000Z", "reportTaskCreationDate": "2017-03-09T19:41:54.000Z", "reportTaskCompletionDate": "2017-03-09T19:43:59.000Z", "reportTaskStatus": "SUCCESS", "reportId": "10000049014", "reportHref": "https://api.ebay.com/sell/.../v1/ad\_report/10000749017", "dateFrom": "2019-03-01T00:00:00.000Z", "dateTo": "2019-03-27T00:00:00.000Z", "dimensions": \[...\], "metricKeys": \["CLICKS"\], "reportFormat": "TSV\_GZIP", "campaignIds": \["10000000019"\] } MARKETING API Get Report Generation Task Driving Growth Promoted Listings Consistent Triple-Digit Promoted Listings Growth Sellers are benefiting from increased listing visibility when they use Promoted Listings, increasing overall adoption and driving even more GMV and revenue growth. 201720182019 ▲ 120% ▲ 150% ▲ 110% Thank you! Q&A eBay Connect 2019 June 25-26, 2019 --- # Unknown eBay Connect 2020 Powered by You Tanya Vlahovic Welcome / Agenda Date / TimeContent June 15 @ 10 AM PTAll about Payments June 16 –17eBay Connect Virtual Lounge July 13 @ 10 AM PTAll in for Aspects Buyer Experience New Selling API Capabilities Sell Feed and Negotiation API Listing optimizing July 14 –15eBay Connect Virtual Lounge August 17 @ 10 AM PTAll about APIs Consumer Selling API eBay for Charity Translation API API Security Updates August 18 –19eBay Connect Virtual Lounge © 2020 eBay. All rights reserved.2 © 2020 eBay. All rights reserved.3 NHS PPE Portal: Built on eBay APIs Our new API has tremendous potential to revolutionize the way people do business on eBay and increase the amount of business transacted on the site. By openly providing the tools that developers need to create applications based on eBay technology, we believe eBay will eventually be tightly woven into many existing sites as well as future e-commerce ventures. eBay November 20, 2000 “ © 2020 eBay. All rights reserved.5 API Portfolio Marketplace Insights\* Metadata Compliance Analytics Marketing Fulfillment Inventory Account Taxonomy Catalog Browse Feed Order Logistics\* Marketing Marketplace Insights\* Translation Offer Analytics Listing Identity Recommen- dation Finances Charity Feed Sell Buy Commerce Developer \* Limited Release --- # Unknown What’s New in Selling? Scot Hamilton Vice President Of Engineering at eBay June 25, 2019 Agenda Approach to Helping Sellers in 2019 Showing Up Being Competitive Closing the Deal FAQ 1 2 3 4 5 Inside every eBay seller is a superhero and it’s our job to get this strength into the open. For sellers, superhero strength is fed entirely through volume and pace of sales . This is conversion. Across 2019, eBay is delivering a number of new capabilities to drive seller conversion. This talk is about: Showing you these capabilities in eBay tools Equipping you to do the same in yours 2019 Is BIG for Sellers New Capabilities, New Strengths Show up best Maximum Exposure in search Clarity for Buyers Consistency across listings Compete to win Know what’s best to sell Be the best at selling it Close with buyers Open up new ways to transact Drive volume purchases “I make 50 cents for showing up... and the other 50 cents is based on my performance .” —Steve Jobs Show Up Best Show Up Best –What it Takes Findability in Search Clarity, consistency for Buyers Common Ingredients Well-formed titles Aspect Adoption eBay’s Catalog Viewed as the Best Means For Years 2003–2018 (optional) 2018 (required) Listing API Listing prefilled Title, Aspects EPID Adopt Seller Search Select/Skip List Search Select Create (Appeal) Edit (Appeal) List eBay Prefill listing Findability: Hard, Low Precision Appeals: Frequency, Turn Around Ineffective, Unfair Balance of Work Prefill listing Findings ~ 13% adoption When adopted, works well Limited catalog coverage We Were Wrong—Very Wrong eBay Define relevant aspects by category Seller Fill in aspects (some required) eBay Leverage Item Specifics Directly Find / Create / Products Prefill Future Listings Findings Aspects coverage goes up Product adoption goes up Conversion goes UP (details later today) Friction is far less, but solving it still matters Building a catalog is not required to get all the right aspects. Asking for the right aspects, in the right way, is all we need to do. Building a catalog is valuable, but is a byproduct of having the right aspects. New Plan for 2019 → All in on aspects! Efficiency Effective ordering of aspect names/values Identification of popular Item aspect values Preselection of aspect values Articulation of value Ensure sellers know what they are getting out of it. Keep it enticing, engaging Side-by-side walk-through of the changes! https://ebay.invisionapp.com/share/QYRX938TXAF#/screens Demo: All In on Aspects, Improved Listing Flows B2C seller, single listing flow Timeline: All In on Aspects Listing flow, Post list experiences Desktop, Business, Consumer, Native/Mobile US July UK, Germany, Australia, Canada Q3 France, Italy, Spain Q4 Rest of World Q1, 2020 API support Category Metadata June Post Listing Guidance Q3 Buyer Demand Data, Aspect Value Details Q4 (API timelines above reflect US launch, API dates for other countries match the dates listing tools roll out). “Being properly prepared is one of the biggest assets in business.” —Warren Buffett Compete to Win New tools for sellers Research and Insights Knowing what to sell Identify what’s hot in the marketplace Current, historical trends Who’s the competition Being the best at selling Competitive pricing insights Competitive shipping insights Available in listing flows Terapeakresearch v1.0 (July) Best-in-class research on eBay’s Marketplace Fully searchable, 1 year of transaction data •All types of goods •All transactions Overlay with active and unsold listings Aggregated Statistics •Price/Velocity Trends •Sell through rates •Competing sellers The Power of Terapeak, Now in Seller Hub Terapeakresearch v1.0 (July) Best-in-class research on eBay’s Marketplace Fully searchable, 1 year of transaction data •All types of goods •All transactions Overlay with active and unsold listings Aggregated Statistics •Price/Velocity Trends •Sell through rates •Competing sellers The Power of Terapeak, Now in Seller Hub Additional features throughout 2019/2020 H2 2019 •Saved searches •Category aligned research •Item specific based pivots •API support begins rolling out H1 2020 •eBay SEO Title Builder •Deep competitor research Real Time Competitor Comparison (Live) Easily compare key competitor details •Price •Shipping Costs •Returns Settings •Best Offer Support •Seller Feedback/Rating Impact: 55% seller adoption, 15% increase in conversion Currently limited to catalog listings Competitive Insights Module, in Listing Flows Real Time Competitor Comparison (Live) Easily compare key competitor details •Price •Shipping Costs •Returns Settings •Best Offer Support •Seller Feedback/Rating Impact: 55% seller adoption, 15% increase in conversion Currently limited to catalog listings Competitive Insights Module, in Listing Flows Additional features throughout 2019 H2 2019 •Expand to non catalog listings •Incorporation of TerapeakTransaction Data Q1 2020 •API Support Begins rolling out Terapeak(Research) Demo of Pre-release Code V1.0 of Marketing Tools Demo: Research and Insights Competitive Insights (Insights) Demo of live, released code B2C Seller Single Listing Flow “Give us the tools, and we will finish the job.” —Winston Churchill Close With Buyers Create opportunity Activate potential buyers that may have been on the fence or looking elsewhere Control velocity Create targeted opportunities to sell slow-moving merchandise and take more control of your business Win-win A great deal is a win for buyers and sellers! Launched Web February, API Launching in Q3 Negotiation: Offer to Buyers Daily Offer CountDaily GMV Staggering growth in first 6 months, more to come +1727%+1599% Negotiation: Basket Best Offer (Same Seller) Web set to Launch in Q4, 2019; APIs in 2020 Volume Pricing: An Overview Volume Pricing: Benefits Visibility Stand out in Search results Increase sales Drive up to 15% item level lift on multi-quantity purchases Win-Win A great deal is a win for buyers and sellers! Available Seller Hub Marketing, Listing Flows, Marketing API “There is no good way to waste time. Wasting time is just wasting time.” —Helen Mirren Your Game Plan APIs to adopt... Your 6 Month Guide to Drive Seller Conversion Now Aspects All In (Aspect Ranking) Taxonomy, Trading API Adopt Best Offer: Trading API Volume Pricing: Marketing API Q3 Aspect All In (Post List Guidance) Selling Recommendation API Offers to Buyers: Negotiation API Q4, Q1 2020 Aspect All In (Listing Enhancements) Taxonomy, Trading API TerapeakAPI: Seller Insights API Competitive Insights: Seller Insights API Thank you! Q&A eBay Connect 2019 June 25-26, 2019 --- # Identity API indexes | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/buy/identity/fields#mainContent) Index:FieldsTypesEnumerations This is a list of all fields in the schema. Select a method to learn more about how a call uses a field. Field Parent field Applicable resources and methods A accountType (method-level) GET [/user/accountType - - /api-docs/buy/identity/resources/user/methods/getUser#response.accountType](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.accountType) address businessAccount GET [/user/address - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address) addressLine1 businessAccount.address GET [/user/addressLine1 - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.addressLine1](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.addressLine1) individualAccount.registrationAddress GET [/user/addressLine1 - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.addressLine1](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.addressLine1) addressLine2 businessAccount.address GET [/user/addressLine2 - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.addressLine2](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.addressLine2) individualAccount.registrationAddress GET [/user/addressLine2 - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.addressLine2](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.addressLine2) B businessAccount (method-level) GET [/user/businessAccount - - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount) C city businessAccount.address GET [/user/city - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.city](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.city) individualAccount.registrationAddress GET [/user/city - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.city](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.city) country businessAccount.address GET [/user/country - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.country](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.country) individualAccount.registrationAddress GET [/user/country - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.country](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.country) countryCode businessAccount.primaryPhone GET [/user/countryCode - businessAccount.primaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone.countryCode](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone.countryCode) businessAccount.secondaryPhone GET [/user/countryCode - businessAccount.secondaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone.countryCode](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone.countryCode) individualAccount.primaryPhone GET [/user/countryCode - individualAccount.primaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone.countryCode](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone.countryCode) individualAccount.secondaryPhone GET [/user/countryCode - individualAccount.secondaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone.countryCode](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone.countryCode) county businessAccount.address GET [/user/county - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.county](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.county) individualAccount.registrationAddress GET [/user/county - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.county](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.county) D doingBusinessAs businessAccount GET [/user/doingBusinessAs - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.doingBusinessAs](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.doingBusinessAs) E email businessAccount GET [/user/email - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.email](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.email) individualAccount GET [/user/email - individualAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.email](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.email) F firstName businessAccount.primaryContact GET [/user/firstName - businessAccount.primaryContact - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryContact.firstName](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryContact.firstName) individualAccount GET [/user/firstName - individualAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.firstName](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.firstName) I individualAccount (method-level) GET [/user/individualAccount - - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount) L lastName businessAccount.primaryContact GET [/user/lastName - businessAccount.primaryContact - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryContact.lastName](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryContact.lastName) individualAccount GET [/user/lastName - individualAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.lastName](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.lastName) N name businessAccount GET [/user/name - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.name](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.name) number businessAccount.primaryPhone GET [/user/number - businessAccount.primaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone.number](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone.number) businessAccount.secondaryPhone GET [/user/number - businessAccount.secondaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone.number](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone.number) individualAccount.primaryPhone GET [/user/number - individualAccount.primaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone.number](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone.number) individualAccount.secondaryPhone GET [/user/number - individualAccount.secondaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone.number](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone.number) P phoneType businessAccount.primaryPhone GET [/user/phoneType - businessAccount.primaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone.phoneType](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone.phoneType) businessAccount.secondaryPhone GET [/user/phoneType - businessAccount.secondaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone.phoneType](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone.phoneType) individualAccount.primaryPhone GET [/user/phoneType - individualAccount.primaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone.phoneType](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone.phoneType) individualAccount.secondaryPhone GET [/user/phoneType - individualAccount.secondaryPhone - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone.phoneType](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone.phoneType) postalCode businessAccount.address GET [/user/postalCode - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.postalCode](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.postalCode) individualAccount.registrationAddress GET [/user/postalCode - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.postalCode](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.postalCode) primaryContact businessAccount GET [/user/primaryContact - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryContact](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryContact) primaryPhone businessAccount GET [/user/primaryPhone - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.primaryPhone) individualAccount GET [/user/primaryPhone - individualAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.primaryPhone) R registrationAddress individualAccount GET [/user/registrationAddress - individualAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress) registrationMarketplaceId (method-level) GET [/user/registrationMarketplaceId - - /api-docs/buy/identity/resources/user/methods/getUser#response.registrationMarketplaceId](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.registrationMarketplaceId) S secondaryPhone businessAccount GET [/user/secondaryPhone - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.secondaryPhone) individualAccount GET [/user/secondaryPhone - individualAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.secondaryPhone) stateOrProvince businessAccount.address GET [/user/stateOrProvince - businessAccount.address - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.stateOrProvince](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.address.stateOrProvince) individualAccount.registrationAddress GET [/user/stateOrProvince - individualAccount.registrationAddress - /api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.stateOrProvince](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.individualAccount.registrationAddress.stateOrProvince) status (method-level) GET [/user/status - - /api-docs/buy/identity/resources/user/methods/getUser#response.status](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.status) U userId (method-level) GET [/user/userId - - /api-docs/buy/identity/resources/user/methods/getUser#response.userId](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.userId) username (method-level) GET [/user/username - - /api-docs/buy/identity/resources/user/methods/getUser#response.username](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.username) W website businessAccount GET [/user/website - businessAccount - /api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.website](https://developer.ebay.com/api-docs/buy/identity/resources/user/methods/getUser#response.businessAccount.website) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # eBay Developers Program [Skip to main content](https://developer.ebay.com/Devzone/return-management/CallRef/my/push#mainContent) * **API License Agreement Update:** We have made significant enhancements to our [API License Agreement](https://developer.ebay.com/join/api-license-agreement) , including detailed data protection measures and compliance with international regulations. Important restrictions have been applied to the use of Restricted APIs and AI content. Developers must review the updated agreement to ensure compliance. * **Important Update:** eBay's API integrations will be modified to address data handling requirements for select developers. Usernames will be replaced with immutable user IDs, and financial data will be protected for certain users. Learn more [here](https://developer.ebay.com/api-docs/static/data-handling-update.html) . Updates ======= Keep up-to-date with our [latest API enhancements.](https://developer.ebay.com/updates) ### eBay Developers Program Q4 2025 Newsletter Program news, API updates, and deprecations for the fourth quarter of 2025. [Learn more](https://developer.ebay.com/updates/newsletter/q4_2025) ### Explore the Inventory Mapping API The Inventory Mapping API helps you turn your existing product data into high-quality listings with AI-powered recommendations. [Learn more](https://developer.ebay.com/updates/blog/explore-inventory-mapping-api) ### A New Era of Partnership Accelerate your growth using eBay’s Developer Loyalty Program with upgraded concierge service, expanded benefits, and clearer guidelines. [Learn more](https://developer.ebay.com/updates/blog/new-partnership-era) Events ====== Plan for upcoming conferences and webinars, or [see what you missed at past events.](https://developer.ebay.com/grow/events) ![Background image](https://developer.ebay.com/cms/img/connect-2023/thumb.jpg) [Learn more](https://developer.ebay.com/grow/events/ebay-connect-2023) ![Background image](https://developer.ebay.com/cms/img/connect-2022/connect_2022_1.png) [Learn more](https://developer.ebay.com/grow/events/ebay-connect-2022) ![Background image](https://developer.ebay.com/cms/img/connect-2021/thumb.png) [Learn more](https://developer.ebay.com/grow/events/ebay-connect-2021) Documentation content survey ---------------------------------- ### Overall, how easy or difficult was it for you to find what you are looking for? Please answer this question before sending.  Please leave the following fields untouched. Don't include personal information like your name, address, or phone number. When you select Send, you are giving eBay full rights to use your comments, and agreeing to the User Agreement. Submit #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # CheckoutBuyerRequestsTotal | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/static/pn_buyer-requests-total.html#mainContent) This notification is sent to a subscribed seller when a buyer/winning bidder is requesting a total price before paying for the item. This notification is applicable for auction listings and for fixed-price listings that do not require immediate payment. * For _fixed-price_ items, a **CheckoutBuyerRequestsTotal** notification would be received by the seller before a **FixedPriceTransaction** notification. * For _auction_ items, a **CheckoutBuyerRequestsTotal** notification would be received by the seller after an **EndOfAuction** notification, but before an **AuctionCheckoutComplete** notification. A **CheckoutBuyerRequestsTotal** notification may be sent multiple times for the same listing if a buyer requests a total more than once. Data Fields Returned -------------------- **API Call that displays this notification:** [GetItemTransactions](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetItemTransactions.html) with default detail level The data fields returned by the **CheckoutBuyerRequestsTotal** notification are the same as those returned by **GetItemTransactions** with default details requested. Refer to the [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#GetItemTransactions) call reference documentation for additional information. Refer to [SOAP Message Body](https://developer.ebay.com/api-docs/static/platform-notifications-landing.html#soap-body) for information about the standard elements returned for all notifications. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # BidReceived | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/static/pn_bid-received.html#mainContent) eBay sends a **BidReceived** notification to sellers subscribed whenever a buyer places a bid on a seller's auction item. The typical flow of events is: * The seller subscribes to the **BidReceived** notification. * A buyer bids on an auction item. * eBay sends the **BidReceived** notification to the seller, indicating a buyer just bid on the seller'sauction item. eBay also sends **BidReceived** notifications to the seller for all auction items a buyer bids on, either through the eBay sites or programmatically from an API or SDK. Data Fields Returned -------------------- **API Call that displays this notification:** [GetItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetItem.html) with default detail level The data fields returned by the **BidReceived** notification are the same as those returned by **GetItemResponse** with default details requested. Refer to the [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#GetItem) call reference documentation for additional information. Refer to [SOAP Message Body](https://developer.ebay.com/api-docs/static/platform-notifications-landing.html#soap-body) for information about the standard elements returned for all notifications. Example ------- In this example, the seller _MagicalBookSeller_ is notified that buyer _BountifulBuyer_ has bid on a copy of "Harry Potter and the Philosopher's Stone" listed on eBay. **Sample BidReceived Notification** pwMi7Lr+Rv3O5CY1geIzSg== 2011-01-06T08:08:21.443Z Success 4\*\*\*\*\*\*\*\*0 699 E699\_CORE\_BUNDLED\_12457306\_R1 BidReceived t\*\*\*\*\*\*\*\*er n\*\*\*\*\*\*\*\*\*s false ItemIneligible 0.0 US USD NoHitCounter 1\*\*\*\*\*\*\*\*9 false false true 0.0 1.0 0.0 false 2011-01-06T08:08:17.000Z 2011-01-13T08:08:17.000Z https://ebay.com/ws/eBayISAPI.dll?ViewItem&item=1\*\*\*\*\*\*\*\*9&category=377 false false Days\_7 Chinese S\*\*\*\*\*\*\*\*a 377 Books:Fiction & Literature false 1 0.0 false false t\*\*\*\*\*\*\*\*r@\*\*\*\*\*\*\*\*.com 31 100.0 false Yellow true true false 2010-01-01T00:00:00.000Z US Confirmed t\*\*\*\*\*\*\*\*r false 2007-11-29T18:43:54.000Z NoVATTax true true false true false OptIn false true http://www.stores.ebay.com/id=1\*\*\*\*\*\*\*\*6 false false t\*\*\*\*\*\*\*\*r@\*\*\*\*\*\*\*\*.com 31 100.0 false Yellow true true false 2010-01-01T00:00:00.000Z US Confirmed t\*\*\*\*\*\*\*\*er false 2007-11-29T18:43:54.000Z NoVATTax true true false true false OptIn false true http://www.stores.ebay.com/id=1\*\*\*\*\*\*\*\*6 false false 1 0.25 1.0 1.0 false n\*\*\*\*\*\*\*\*= b\*\*\*\*\*\*\*\*r@\*\*\*\*\*\*\*\*.com 32 100.0 false Yellow false true false 1995-01-01T00:00:00.000Z US Confirmed t\*\*\*\*\*\*\*\*er false 2009-02-12T05:01:49.000Z NoVATTax US 9\*\*\*2 false 0 1.25 0 true false Active false USPSMedia 2.5 1 false 2 9 Flat Asia Middle East Southeast Asia true US US 1.0 1 0 http://www.stores.ebay.com/id=132854966 P6DT23H59M56S Harry Potter and the Philosopher's Stone C\*\*\*\*\*\*\*\*D 0 true 9\*\*\*5 Gallery PicturePack http://i1.ebayimg.com/03/i/00/61/35/e7\_1.JPG?set\_id=8800005007 3 false 20000.0 false MoneyBack Money Back Days\_30 30 Days ReturnsAccepted Returns Accepted Buyer Buyer eBayMotors CanadaFrench Canada US 3000 Like New #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Unknown Quarterly Statistics on Availability and Performance of Dedicated Interfaces Nil Return Daily statistics Reporting Period Information Reporting Period: Oct 01, 2025 to Dec 31, 2025 A 1.Do you wish to make a nil return? No Interface 1 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC Approve CancellationDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 1 of28 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 2 of28 90100.000.00 91100.000.00 92100.000.00 Interface 2 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC Create Cancellation RequestDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 3 of28 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 3 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC GetAccountDedicated interfaceNo Availability statisticsPerformance statistics Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 4 of28 Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 5 of28 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 4 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getPayoutDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 6 of28 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 7 of28 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 5 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getPayoutsDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 8 of28 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 9 of28 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 6 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getPayoutSummaryDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 10 of28 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 11 of28 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 7 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getSellerFundsSummaryDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 12 of28 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 8 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 13 of28 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getTransactionsDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 14 of28 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 9 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getTransactionSummaryDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 15 of28 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 16 of28 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 10 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC getTransferDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 17 of28 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 18 of28 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 11 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC Issue Case RefundDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 19 of28 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 20 of28 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 12 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC Issue Inquiry RefundDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 21 of28 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 22 of28 Interface 13 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC Issue Return RefundDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 23 of28 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 14 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC issueRefundDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 24 of28 Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 25 of28 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Interface 15 Day Interface Name/IdInterface type Has exemption been granted for dedicated interface? ABC Process Return RequestDedicated interfaceNo Availability statisticsPerformance statistics Uptime (%)Downtime (%) Payment services user interface Dedicated interface Response (millisecs) AISP response (millisecs) PISP response (millisecs) CBPII / PISP Yes/No response (millisecs) Error response rate (%) DEFGHIJ 1100.000.00 2100.000.00 3100.000.00 4100.000.00 5100.000.00 6100.000.00 7100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 26 of28 8100.000.00 9100.000.00 10100.000.00 11100.000.00 12100.000.00 13100.000.00 14100.000.00 15100.000.00 16100.000.00 17100.000.00 18100.000.00 19100.000.00 20100.000.00 21100.000.00 22100.000.00 23100.000.00 24100.000.00 25100.000.00 26100.000.00 27100.000.00 28100.000.00 29100.000.00 30100.000.00 31100.000.00 32100.000.00 33100.000.00 34100.000.00 35100.000.00 36100.000.00 37100.000.00 38100.000.00 39100.000.00 40100.000.00 41100.000.00 42100.000.00 43100.000.00 44100.000.00 45100.000.00 46100.000.00 47100.000.00 48100.000.00 49100.000.00 50100.000.00 51100.000.00 52100.000.00 53100.000.00 54100.000.00 55100.000.00 56100.000.00 57100.000.00 58100.000.00 59100.000.00 60100.000.00 61100.000.00 62100.000.00 63100.000.00 64100.000.00 65100.000.00 66100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 27 of28 67100.000.00 68100.000.00 69100.000.00 70100.000.00 71100.000.00 72100.000.00 73100.000.00 74100.000.00 75100.000.00 76100.000.00 77100.000.00 78100.000.00 79100.000.00 80100.000.00 81100.000.00 82100.000.00 83100.000.00 84100.000.00 85100.000.00 86100.000.00 87100.000.00 88100.000.00 89100.000.00 90100.000.00 91100.000.00 92100.000.00 Quarterly Statistics on Availability and Performance of Dedicated InterfacesPage 28 of28 --- # geteBayDetails (ShippingServiceDetails) 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. 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. 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. The request that triggered the error was processed successfully but with one or more warnings. 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. This is the base class for request container for all service operations. Reserved for future use. No Base response container for all service operations. Contains error information associated with the request. A token representing the application-level acknowledgement code that indicates the response status, such as success. The AckValue list specifies the possible values for ack. Always Information for an error or warning that occurred when eBay processed the request. Conditionally The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. 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). Always Reserved for future use. Returned errors are categorized as either Application, Request, or System errors. Request and application errors are often caused by passing invalid data in the call request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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. 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. 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. A container for 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 in which the error occurred. Conditionally Name of the subdomain in which the error occurred. 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused the error. Conditionally Unique identifier for an exception associated with an error. 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. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. The root request container of the getVersion call. getVersion Yes This call is used to return the current version of Business Policies Management API. This call can be used to monitor the service for availability. This call has no input parameters and the response contains only the standard output fields. Returns the current version of the Business Policies Management API. The root response container of the getVersion call. getVersion Always Response container for the getVersion API call. The root request container of the removeProfile call. removeProfile Yes The root response container of the removeProfile call. removeProfile Always This call is used to delete an existing business policy for a seller. Unique identifier for a business policy. Each payment, shipping, and return business policy has its own unique profileId value. The seller passes in this profileId value to identify the business policy to delete. A profileId value can be obtained through the site or by making a getSellerProfiles call. removeProfile Yes The response container for the removeProfile call. The root request container of the addSellerProfile call. addSellerProfile Yes The root response container of the addSellerProfile call. addSellerProfile Always Sellers use this call to create one or more business policies. With one call instance, the seller can create a payment policy, a return policy, a shipping policy, or any combination of the three policy types. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group(s) to which the payment policy will be applied.

The paymentProfile container is conditionally required if the seller wants to create a new payment policy. addSellerProfile Yes getSellerProfiles Always Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group(s) to which the return policy will be applied.

The returnPolicyProfile container is conditionally required if the seller wants to create a new return policy. addSellerProfile Conditionally getSellerProfiles Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group(s) to which the shipping policy will be applied.

The shippingPolicyProfile container is conditionally required if the seller wants to create a new shipping policy. addSellerProfile Conditionally getSellerProfiles Conditionally Response container for the addSellerProfile call. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied.

The paymentProfile container is only returned if the seller created a payment policy in the addSellerProfile request. addSellerProfile Conditionally Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied.

The returnPolicyProfile container is only returned if the seller created a return policy in the addSellerProfile request. addSellerProfile Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied.

The shippingPolicyProfile container is only returned if the seller created a shipping policy in the addSellerProfile request. addSellerProfile Conditionally The root request container of the getSellerProfiles call. getSellerProfiles Yes The root response container of the getSellerProfiles call. getSellerProfiles Always The root request container of the setSellerProfile call. setSellerProfile Yes The root response container of the setSellerProfile call. setSellerProfile Always Sellers use this call to modify one or more business policies. With one call instance, the seller can modify a payment policy, a return policy, a shipping policy, or any combination of the three policy types. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied.

The paymentProfile container is conditionally required if the seller wants to modify an existing payment policy.

Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field. setSellerProfile Conditionally Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied.

The returnPolicyProfile container is conditionally required if the seller wants to modify an existing return policy.

Sellers only pass in values for the fields that they want to change. To delete an optional field, sellers can pass an empty value into the field. setSellerProfile Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied.

The shippingPolicyProfile container is conditionally required if the seller wants to modify an existing shipping policy.

Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field. setSellerProfile Conditionally Response container for the setSellerProfile call. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied.

The paymentProfile container is only returned if the seller modified a payment policy in the setSellerProfile request. setSellerProfile Conditionally Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied.

The returnPolicyProfile container is only returned if the seller modified a return policy in the setSellerProfile request. setSellerProfile Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied.

The shippingPolicyProfile container is only returned if the seller modified a shipping policy in the setSellerProfile request. setSellerProfile Conditionally Response container for the getSellerProfiles call. Container consisting of one or more payment policies that match the input criteria in the getSellerProfiles request. This container is not returned if no payment policies match the input criteria. getSellerProfiles Conditionally Container consisting of one or more return policies that match the input criteria in the getSellerProfiles request. This container is not returned if no return policies match the input criteria. getSellerProfiles Conditionally Container consisting of one or more shipping policies that match the input criteria in the getSellerProfiles request. This container is not returned if no shipping policies match the input criteria. getSellerProfiles Conditionally This call is used to retrieve one or more business policies for a seller. Specific business policies can be retrieved by passing in profileId or profileName values, or all policies of a certain type (payment, return, or shipping) can be retrieved. The seller passes in one or more profileType enumeration values to retrieve all business policies of that type. Valid values for this field are PAYMENT, RETURN\_POLICY, and SHIPPING.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all policies that match any of the supplied filters are retrieved in the response. SHIPPING\_RATE, SHIPPING\_EXCLUSION, SHIPPING\_DISCOUNT getSellerProfiles No Unique identifier for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all business policies that match any of the supplied filters are retrieved in the response. getSellerProfiles No Unique name for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all business policies that match any of the supplied filters are retrieved in the response. getSellerProfiles Conditionally This optional flag determines whether or not detailed information is retrieved for each business policy in the response. If included and set to 'true' or not included (since 'true' is the default), all applicable containers and fields for each business policy are returned in the response. If included and set to 'false', the following containers are not returned in the response:
  • paymentInfo (for all retrieved payment policies)
  • returnPolicyInfo (for all retrieved return policies)
  • shippingPolicyInfo (for all retrieved shipping policies)
true getSellerProfiles No Type that defines the deliveryEstimateMetaInfo container, which consists of the entity and its value that item delivery estimates are based on. The entity that item delivery estimates are based on. Valid entities include:
  • ExternalID
  • ItemID
  • SellerID
  • BuyerID
  • SGuid
  • PGuid
  • TransactionID
addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value corresponds to the value in the key field and identifies the instance of that entity. addSellerProfile setSellerProfile No getSellerProfiles Conditionally Type defining the domesticShippingPolicyInfoService and internationalShippingPolicyInfoService containers, which consists of detailed information on domestic and international shipping service options. An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.

If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.

If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

All shipToLocation fields specified for the shipping policy are always returned in the getSellerProfiles call. addSellerProfile setSellerProfile Conditionally getSellerProfiles Always A domestic or international shipping service being offered by the seller to ship an item to a buyer.

For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing.

The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing.

If 'Get It Fast' shipping is being enabled for the shipping policy (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE\_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally geteBayDetails (ShippingServiceDetails) http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails This value indicates the shipping cost model used by the shipping service option. The two applicable values are 'Flat' and 'Calculated'. To verify that the shipping service supports calculated shipping, call geteBayDetails, using ShipppingServiceDetails as a DetailName value in the request, and then look at the ShippingServiceDetails container that corresponds to the specified shipping service option (see ShippingServiceDetails.ShippingService). One of the ShippingServiceDetails.ServiceType values in that same container should be 'Flat'.

This field is optional in an addSellerProfile or setSellerProfile request, and defaults to 'Flat'.

This field is always returned in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile setSellerProfile, or getSellerProfiles response. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails geteBayDetails (ShippingServiceDetails) http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ShippingTypeCodeType.html ShippingTypeCodeType This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages.

Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options.

Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.

If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. 1 4 (for domestic shipping service) or 5 (for international shipping service) addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This flag is used by the seller to offer free shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call. The freeShipping field is not applicable for internationalShippingPolicyInfoService containers. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles intlShippingPolicyInfoService Conditionally This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the buyer selects the 'COD' payment method and if the selected shipping service option suppports the Cash-on-Delivery option.

To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This flag indicates whether or not a 'Get It Fast' shipping service option is available for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.

To enable 'Get It Fast' shippping for a listing, the seller must:
  • offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;
  • set the shippingPolicyInfo.dispatchTimeMax value to '0' (same-day shipping) or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer.
Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment business policy, this option is turned on with the paymentInfo.immediatePay flag. To enable the immediate payment feature on a listing, the seller must:
  • have a Premier or Business PayPal account;
  • provide a valid Item.PayPalEmailAddress value;
  • offer 'PayPal' as the single payment method in the Item.PaymentMethods field.
The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers.

Not supported for UK Half.com items. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles intlShippingPolicyInfoService Conditionally This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used.

This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer.

The total shipping costs for an order line item is calculated with the following formula:

Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)).

This field is not applicable to calculated shipping. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping.

This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the freeShipping field is set to 'true'.

The total shipping costs for an order line item is calculated with the following formula:

Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)). addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas.

In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
  • a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response;
  • flat-rate shipping is used
addSellerProfile setSellerProfile No getSellerProfiles Conditionally geteBayDetails (ShippingServiceDetails) http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails The dollar amount in this field represents the actual total price of shipping if the total shipping costs (shippingServiceCost + shippingServiceAdditionalCost + shippingSurcharge) set for the corresponding shipping service in the shipping policy are overridden through a ShippingServiceCostOverride container in an AddItem call (Trading). addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This field is only applicable to motor vehicle categories on eBay Motors (US and Canada).

If this field is included and set to 'true' (or omitted because the default value is 'true'), the buyer is responsible for the shipment/pickup of the motor vehicle. If this field is included and set to 'false', the seller should specify the vehicle shipping arrangements in the item description for the listing.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. true addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally Type that defines the depositDetails container, which is used by the seller to specify amounts and due dates for deposits and full payment on eBay Motors (US and CA) vehicle listings. The depositDetails container is conditionally required if the the payment policy is for eBay Motors (US and CA) vehicles listings (categoryGroup.name=MOTORS\_VEHICLE). This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'.

In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment policy:
  • CashOnPickup
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (payment instructions are in the item's description)
  • PersonalCheck
7 3 14 addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make an initial deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'.

The deposit amount is specified in the depositAmount field. If not specified, the depositAmount value defaults to '0.0', in which case, a deposit on the vehicle is not required.

In order for a buyer to make an initial deposit on a US or CA motor vehicle, one of the acceptedPaymentMethod values must be 'PayPal' (in addition to the payment methods offered for the full payment).

24 72 48 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This dollar value indicates the initial deposit amount that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to '0.0'. If this value is specified, the seller must also specify an hoursToDeposit value.

Deposits on motor vehicles can only be paid using PayPal, so if depositAmount is specified, then one of the acceptedPaymentMethod values must be 'PayPal' (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit from the buyer.

The deposit amount appears in the shipping, payment details and return policy sections of the View Item page.

0.0 2000.0 0.0 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the paymentProfile container, which is the container used to define one payment policy for a seller. This container consists of detailed payment information for a seller's payment policy. This container is conditionally required if the caller is creating a new payment policy or modifying an existing payment policy.

This container is returned by getSellerProfiles if one or more payment policies match the input criteria in the call request, and is returned in the response of addSellerProfile or setSellerProfile if a payment policy is being created or modified, respectively. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Container consisting of one or more payment policies that match the input criteria in a getSellerProfiles< /b> call request. Container consisting of details for a specific payment policy. A PaymentProfile container is returned in getSellerProfiles for each payment policy that matches the input criteria. getSellerProfiles Conditionally Type defining the returnPolicyInfo container, which consists of detailed information on a seller's return policy. This free-form string field allows the seller to provide a detailed explanation of the return policy. The maximum length of this optional field is 5000.

eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references. If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character.

5000 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This value indicates how the seller will compensate the buyer for a returned item. Use the returnPolicyInfo.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details).

Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.Refund.RefundOption values in the response to determine which refund options are supported for your site.

For the Add/Revise/Relist calls in the Trading API, if the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted), the RefundOption value will be set with a default value (such as 'MoneyBack') on some eBay sites, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set his/her desired value here.

The only allowed values for RefundOption on the US site are 'MoneyBack', 'MoneyBackOrExchange', or 'MoneyBackOrReplacment'.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, this value cannot be modified. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This value is used by the seller to indicate whether the buyer or the seller is responsible for paying return shipping charges. Possible values are 'Buyer' or 'Seller'. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.ShippingCostPaidBy values in the response to determine which enumeration values are supported for your site. It is good practice for the seller to indicate the party responsible for return shipping in the returnPolicy.description field.

This field is returned in getSellerProfiles if set for a matching return policy.

If a seller is revising a listing that has bids or sales and/or ends within 12 hours, this value cannot be modified. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally If the return policy specifies that the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted), then the returnsWithinOption field is required. This field's value determines the number of business days that the buyer has to return the item (after receiving the item). It is good practice to call this value out in the returnPolicy.description field.

The three allowed values on the US site are 'Days\_14', 'Days\_30', and 'Days\_60'.

Some eBay sites may set a default value (such as 'Days\_14') if the seller accepts returns but the returnsWithinOption field is omitted.

If the listing has bids or sales and/or ends within 12 hours, this value cannot be modified. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Indicates whether the seller allows the buyer to return the item. This is a required field for a return policy.

All sites allow the seller to choose between accepting (specify 'ReturnsAccepted') or not accepting (specify 'ReturnsNotAccepted') returns. An exception to this rule is on some eBay European sites (UK, Ireland, DE), where some categories require business sellers to accept returns for fixed-price items and auction items purchased with the Buy It Now option. The GetUser Trading API call can be used by DE/IE/UK sellers to determine a user's current business seller status (look at User.SellerInfo.SellerBusinessType).

Note that Top-Rated sellers must accept item returns for a listing in order for that listing to receive a Top-Rated Plus badge on the View Item page or search results page. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally (GeteBayDetails) ReturnsAcceptedOption sites that support this field, and applicable values GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsAccepted.ReturnsAcceptedOption Returns and the Law (UK) http://pages.ebay.co.uk/businesscentre/law-policies/returns.html This value indicates whether a seller offers a warranty. Valid values are 'None' and 'WarrantyOffered'. Currently, only the eBay India site supports warranties on eBay items. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This value indicates the type of warranty that is offered with the product. This value is applicable if the seller accepts returns and a warranty is offered (returnPolicyInfo.warrantyOfferedOption=WarrantyOffered). Valid values are 'DealerWarranty', 'ManufacturerWarranty', and 'ReplacementWarranty'. Currently, only the eBay India site supports warranties on eBay items.

Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.WarrantyType values in the response to determine which enumeration values are supported.

If the listing has bids or sales and/or ends within 12 hours, this value cannot be modified. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally WarrantyTypeOptionsCodeType http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/WarrantyTypeOptionsCodeType.html This value indicates the warranty period for a product. This value is applicable if the seller accepts returns and a warranty is offered (returnPolicyInfo.warrantyOfferedOption=WarrantyOffered). Valid values are 'Months\_1', 'Months\_3', 'Months\_6', 'Years\_1', 'Years\_2', 'Years\_3', and 'Years\_MoreThan3'. Currently, only the eBay India site supports warranties on eBay items.

Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.WarrantyDuration values in the response to determine which enumeration values are supported.

If the listing has bids or sales and/or ends within 12 hours, this value cannot be modified. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally WarrantyDurationOptionsCodeType http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/WarrantyDurationOptionsCodeType.html Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned. A restocking fee only comes into play when an item is returned, as this fee will reduce the total amount that the buyer is refunded for the returned item.

Possible values are:
  • NoRestockingFee: no restocking fee is charged to the buyer
  • Percent\_10: 10 percent of the item price is charged to the buyer as a restocking fee
  • Percent\_15: 15 percent of the item price is charged to the buyer as a restocking fee
  • Percent\_20: 20 percent of the item price is charged to the buyer as a restocking fee
This field is returned in getSellerProfiles if seller has set this value for the corresponding return policy. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Note: The Extended Holiday Returns feature is available for Sandbox testing on the eBay US and UK sites as of version 873, and on the eBay CA/CAFR, DE, AT and AU sites as of version 881. It will be available for Production use on the eBay US and UK sites as of early September 2014, and approximately one year later for the eBay CA/CAFR, DE, AT and AU sites. This field is used to enable a holiday returns policy for a listing. A value of true indicates that the seller is offering an extended holiday returns period for purchased items within the listing.

The extended holiday returns period is defined by three dates:
  • The start date - November 3, 2014.
  • The purchase cutoff date - December 31, 2014.
  • The end date - January 31, 2015.
Note: These dates may vary by a few days each year. Sellers will be notified of the current dates on their eBay site before the holiday period starts. Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in the listings until the current year's holiday returns period start date, at which point it overrides the non-holiday returns policy. Buyers will see and be subject to the Extended Holiday Returns offer in listings purchased through the purchase cutoff date, and will be able to return those purchases through the end date.

After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from the listings, and the seller's non-holiday returns period reappears. Purchases made from that point on are subject to the non-holiday returns period, while purchases made before the cutoff date still have until the end date to be returned.

If the value of holidayReturns is false for an item, the returns period specified by the returnsWithinOption field applies, regardless of the purchase date. If the item is listed with a policy of no returns, holidayReturns is automatically reset to false.

For the AddItem family of calls, the value of holidayReturns is false by default.

For the ReviseItem family of calls, you can omit holidayReturns from the input if its value does not need to change. If the listing being revised has bids or orders, you can add the extended holiday returns option to the listing, but you can't remove it. If the listing does not have bids or orders, you can add or remove the extended holiday returns option; however, this is a significant revision, triggering a version change in the listing.

For the RelistItem family of calls, you can omit holidayReturns from the input if its value does not need to change. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Type defining the returnPolicyProfile container, which is the container used to define one return policy for a seller. This container consists of detailed information on a seller's return policy. This container is conditionally required if the caller is creating a new return policy or modifying an existing return policy.

This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Type defining the returnPolicyProfileList container, which consists of one or more return policies that match the input criteria in the getSellerProfiles request. Container consisting of detailed information for a specific return policy that matches the input criteria. getSellerProfiles Always Type defining the categoryGroups container, which contains one or more categoryGroup containers. This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS\_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always Enumerated type that defines the business policy types. SHIPPING\_RATE, SHIPPING\_EXCLUSION, SHIPPING\_DISCOUNT This value indicates the business policy is a payment policy. This value indicates the business policy is a return policy. This value indicates the business policy is a shipping policy. This value is for future use. This value is for future use. This value is for future use. This type defines the common elements used by all business policies. This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always The unique identifier of a business policy. This value is created by eBay when a business policy is created (on the site or through the API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific business policy to retrieve. This field is always returned with all Business Policies Management calls.

A profileId value returned in the response of an addSellerProfile call indicates that the business policy was successfully created. removeSellerProfile setSellerProfile Yes getSellerProfiles Conditionally getSellerProfiles removeSellerProfile setSellerProfile addSellerProfile Always This field indicates the type of the business policy. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve business policies of a specific type. SHIPPING\_RATE, SHIPPING\_EXCLUSION, SHIPPING\_DISCOUNT addSellerProfile setSellerProfile Yes getSellerProfiles Conditionally getSellerProfiles addSellerProfile setSellerProfile Always This field is for internal use only. This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy.
250 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This timestamp indicates when a business policy was deleted. This field is only returned in getSellerProfiles for business policies that have been deleted. For business policies that have been deleted by the seller, deletedDate is the only field that will be returned for the matching policy (in addition to the identifying fields like profileId and profileName). getSellerProfiles Conditionally Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always Type defining the shippingPolicyProfile container, which is the container used to define one shipping policy for a seller. This container consists of detailed shipping information for a seller's shipping policy. This container is conditionally required if the caller is creating a new shipping policy or modifying an existing shipping policy.

This container is returned by getSellerProfiles if one or more shipping policies match the input criteria in the call request. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the shipingPolicyProfile container, which consists of one or more shipping policies that match the input criteria in the getSellerProfiles request. Container consisting of one or more shipping policies that match the input criteria in the getSellerProfiles request. This container is not returned if no shipping policies match the input criteria. getSellerProfiles Conditionally This type defines the additionalServiceShippingOption container, which contains an additional shipping service option available to buyers (in addition to the shipping service option specified in the domesticShippingPolicyInfoService field. The name of the additional shipping service option available to buyer. For a list of valid shipping service options, call the Trading API's GeteBayDetails call with the DetailName field set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present in the GeteBayDetails response. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This flag indicates whether the additional shipping service is enabled or disabled. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally The root response container of the removeSellerProfiles call. removeSellerProfiles Always The root request container of the removeSellerProfiles call. removeSellerProfiles Yes Sellers use this call to delete one or more existing business policies. Unique identifier for a business policy. Each payment policy, shipping policy, and return policy has its own unique profileId. The seller passes in one or more profileIds values to identify the business policies to delete. The profileId values can be obtained through the site or by making a getSellerProfiles call. removeSellerProfiles Yes The response container for the removeSellerProfiles call. Container consisting of the profileId values for business policies that were successfully deleted, as well as an ack value to indicate if the call was successful. An errorMessage container will be returned if the call generated any errors or warnings. addSellerProfile Conditionally Type defining the sellerProfileResponseStatus container, which is returned in the removeSellerProfiles response, and indicates whether or not the business policies specified in the call request were successfully deleted. Unique identifier for a business policy. Each payment policy, shipping policy, and return policy has its own unique profileId. A profileId value is returned for all business policies that were successfully deleted. For business policies that were not successfully deleted, the reason may be found in the errorMessage container. removeSellerProfiles Yes A token representing the application-level acknowledgement code that indicates the success of the call. Always Information for an error or warning that occurred when eBay processed the request. Conditionally Type defining the PaymentInfo container, which contains payment information related to the corresponding payment policy. Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. At least one payment method is required to be specified in each payment policy. If you specify multiple acceptablePaymentMethod fields, the repeating fields must be contiguous.

Note: Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call GetCategoryFeatures, specifying 'PaymentMethods' as a FeatureID value in the call request, and then look for the Category.PaymentMethod values in the call response.
For motor vehicle payment policies (CategoryGroup.name=MOTORS\_VEHICLE), 'PayPal' must be one of acceptedPaymentMethod values if a deposit is required (the paymentInfo.depositDetails container exist for the payment policy), and in order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified:
  • CashOnPickup
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (payment instructions are in the paymentInstructions field)
  • PersonalCheck
addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally To create an immediate payment requirement that can be applied to a listing, immediatePay must be included and set to 'true' for the payment policy. If the seller does not want to apply an immediate payment requirement for an item, this field is either omitted, or included and set to 'false'. The seller can change the immediate payment requirement at any time during the lifecyle of a listing.

In the Trading API calls that return the AutoPay field (immediatePay equivalent), be aware that the field's appearance in the output does not necessarily indicate that the listing qualifies for immediate payment, but only that the seller attempted to create (by including and setting immediatePay to 'true' in the payment policy) an immediate payment requirement.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account;
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal payments;
  • the category supports PayPal payments;
  • the listing type is fixed-price or auction (with Buy It Now option).
To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid paymentProfile.paymentInfo.paypalEmailAddress value;
  • seller must offer PayPal as the only payment method;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the shippingProfileDiscountInfo container values if promotional shipping discounts will be used;
false addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This free-form string field allows the seller to give payment instructions to the buyer. These instructions will appear on eBay's View Item and Checkout pages. This field allows 1000 characters.

It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment policies to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle.

1000 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally The valid email address linked to the seller's PayPal account. This field is required in the payment policy if 'PayPal' is one of the acceptedPaymentMethod values in the payment policy. eBay uses this email address to identify the correct PayPal account when the buyer pays via PayPal during the checkout process.

For digital listings, sellers must use an email address that is associated with a PayPal Premier or Business account. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings on eBay Motors (US and CA). This container is only applicable if the categoryGroup.name field is set to 'MOTORS\_VEHICLE'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'.

In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment business policy:
  • CashOnPickup
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (payment instructions are in the item's description)
  • PersonalCheck
7 3 14 addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally The root request container of the consolidateShippingProfiles call. consolidateShippingProfiles Yes The root response container of the consolidateShippingProfiles call. consolidateShippingProfiles Always This call can be used to consolidate shipping policies that have identical data with the exception of shipping costs. The response container for the consolidateShippingProfiles call. Container consisting of details related to the shipping policies consolidation job, including a unique ID, the status of the job, and the eBay site ID. consolidateShippingProfiles Always The root request container of the getConsolidationJobStatus call. getConsolidationJobStatus Yes The root response container of the getConsolidationJobStatus call. getConsolidationJobStatus Always This call can be used to retrieve the status of a shipping policies consolidation job. 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. getConsolidationJobStatus No The response container for the getConsolidationJobStatus call. Container consisting of details related to the shipping policies consolidation job, including the status of the job and the eBay site ID. getConsolidationJobStatus Always Enumerated type defining the possible status values for a shipping policies consolidation job. This value indicates that the shipping policies consolidation job is currently in progress. This value indicates that the shipping policies consolidation job has successfully completed. 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. Type defining the Job container that is returned in the consolidateShippingProfiles and GetConsolidationJobStatus calls. The Job container consists of a unique ID for the job, the status of the job, and the eBay site ID. 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. getConsolidationJobStatus Always consolidateShippingProfiles Conditionally The type of shipping policies consolidation job. Currently, only one value is applicable. consolidateShippingProfiles getConsolidationJobStatus Always This field indicates the status of the shipping policies consolidation job. consolidateShippingProfiles getConsolidationJobStatus Always Unique identifier of the eBay listing site. consolidateShippingProfiles getConsolidationJobStatus Always Enumerated type defining the possible shipping policies consolidation job types. This value indicates that the job type is a shipping policies consolidation job. The root response container of the removeOverrides call. removeOverrides Always The root request container of the removeOverrides call. removeOverrides Yes This call is used to remove shipping cost overrides for a specific shipping policy. The only input parameter for this call is the unique identifier of the shipping policy, and the response contains only the standard output fields. Removes shipping cost overrides for a specific shipping policy. The unique identifier of the shipping policy. The seller provides the profileId of the shipping policy for which he/she would like to remove shipping cost overrides. removeOverrides Yes Monetary amount. This type is used in several locations in payment policies and return policies. This attribute identifies the currency in which the monetary amount is specified. For a full list of 3-digit ISO 4217 currency codes, see the Trading API's CurrencyCodeType. Type defining the deliveryEstimate container, which provides details on the estimated time of delivery of the item to the buyer. The maximum number of business days that a buyer may need to wait for delivery of an item after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. addSellerProfile setSellerProfile No getSellerProfiles Conditionally The minimum number of business days that a buyer may need to wait for delivery of an item after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. addSellerProfile setSellerProfile No getSellerProfiles Conditionally The latest date that an item may be delivered to the buyer after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. Non-business days are disregarded when determining this date. addSellerProfile setSellerProfile No getSellerProfiles Conditionally The earliest date that an item may be delivered to the buyer after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. Non-business days are disregarded when determining this date. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This integer value indicates the minimum level of confidence that the item delivery estimates will be met. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This integer value indicates the maximum level of confidence that the item delivery estimates will be met. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value indicates how item delivery estimates will be treated. addSellerProfile setSellerProfile No addSellerProfile setSellerProfile getSellerProfiles Conditionally This value indicates the maximum number of days after payment, including weekends and any holidays, that a buyer may have to wait for the item to be delivered. This value is based on the dispatchTimeMax value, the shipping service option being used to ship the item, plus the number of weekend or holiday days between tha payment date and the maxDeliveryDate. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value indicates the minimum number of days after payment, including weekends and any holidays, that a buyer may have to wait for the item to be delivered. This value is based on the dispatchTimeMax value, the shipping service option being used to ship the item, plus the number of weekend or holiday days between tha payment date and the minDeliveryDate. addSellerProfile setSellerProfile No getSellerProfiles Conditionally Type defining the freightShipping container, which consists of details related to freight shipping. This container is required to be set in a shipping policy if the seller offers freight shipping. String value indicating whether the freight item is being picked up from a residence or from a commercial location. Valid values are 'Residential' and 'Commercial'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Flag indicating if the freight item will be picked up inside or outside of the pickup location. If this value is 'true', the item will be picked up inside of the pickup location, and if 'false', the item will be picked up outside of the pickup location. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Flag indicating if help is required to pick up the freight item. If this value is 'true', help picking up the item is required, and if 'false', help picking up the item is not required. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally A string value classifying the freight item to be shipped. Valid values for this field include:
  • MACHINERY\_USED
  • MACHINERY\_NEW
  • FRAGILE\_HOUSEHOLD\_USED
  • FRAGILE\_HOUSEHOLD\_NEW
  • NON\_FRAGILE\_HOUSEHOLD\_USED
  • NON\_FRAGILE\_HOUSEHOLD\_NEW
  • RESTAURANT\_EQUIPMENT\_USED
  • RESTAURANT\_EQUIPMENT\_NEW
  • COMPUTER\_ELECTRONICS\_USED
  • COMPUTER\_ELECTRONICS\_NEW
  • VENDING\_MACHINE\_USED
  • VENDING\_MACHINE\_NEW
  • MOTORCYCLE\_USED
  • MOTORCYCLE\_NEW
This is a required field if freight shipping is included in the shipping policy. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Value indicating the shipping class of the freight item. The shipping class corresponds to the weight of the item (in pounds). Valid values include '50.0', '55.0', '60.0', '65.0', '70.0', '77.5', '85.0', '92.5', '100.0', '110.0', '125.0', '150.0', '175.0', '200.0', '225.0', '250.0', '300.0', '400.0', and '500.0'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally String value indicating whether the freight item is being delivered to a residence or to a commercial location. Valid values are 'Residential' and 'Commercial'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Flag indicating if the freight item will be dropped off inside or outside of the delivery location. If this value is 'true', the item will be dropped off inside of the delivery location, and if 'false', the item will be dropped off outside of the delivery location. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the insurance container, which contains the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer. This dollar value indicates the cost to the buyer to purchase domestic shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering domestic shipping insurance to the buyer, and the domesticInsuranceOption is 'Optional' or 'Required'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This string value indicates the seller's policy on offering domestic shipping insurance to the buyer. Valid values include:
  • IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item
  • NotOffered: the seller does not offer shipping insurance to the buyer
  • Optional: purchasing shipping insurance for the item is at the discretion of the buyer
  • Required: the seller requires that the buyer purchase shipping insurance for the item
This field is required if an AU, FR, or IT seller is offering domestic shipping insurance to the buyer. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This string value indicates the seller's policy on offering international shipping insurance to the buyer. Valid values include:
  • IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item
  • NotOffered: the seller does not offer shipping insurance to the buyer
  • Optional: purchasing shipping insurance for the item is at the discretion of the buyer
  • Required: the seller requires that the buyer purchase shipping insurance for the item
This field is required if an AU, FR, or IT seller is offering international shipping insurance to the buyer. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This dollar value indicates the cost to the buyer to purchase international shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering international shipping insurance to the buyer, and the internationalInsuranceOption is 'Optional' or 'Required'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This enumeration type defines the values that can be set as a currencyId attribute for Business Policies Management elements that use Amount type, such as depositDetails.depositAmount in payment policies, or shippingServiceCost in shipping policies. USD, CAD, GBP, AUD, EUR, CHF, CNY, HKD, PHP, PLN, SEK, SGD, TWD, INR, MYR U.S. Dollar; country - United States; ISO currency code - 840 Canadian Dollar; country - Canada; ISO currency code - 124 Pound Sterling; country - United Kingdom; ISO currency code - 826 German Mark; country - Germany; ISO currency code - 276 (Not valid in shippingPolicyCurrency field) Australian Dollar; country - Australia; ISO currency code - 036 Japanese Yen; country - Japan; ISO currency code - 392 (Not valid in shippingPolicyCurrency field) Euro; entity - European Union; ISO currency code - 978 French Franc; country - France; ISO currency code - 250 (Not valid in shippingPolicyCurrency field) Austrian Schilling; country - Austria; ISO currency code - 040 (Not valid in shippingPolicyCurrency field) Belgian Franc; country - Belgium; ISO currency code - 056 (Not valid in shippingPolicyCurrency field) Swiss Franc; country - Switzerland; ISO currency code - 756 Chinese Yuan Renminbi; country - China; ISO currency code - 156 Czech Koruna; country - Czech Republic; ISO currency code - 203 (Not valid in shippingPolicyCurrency field) Danish Krone; country - Denmark; ISO currency code - 208 (Not valid in shippingPolicyCurrency field) Spanish Peseta; country - Spain; ISO currency code - 724 (Not valid in shippingPolicyCurrency field) Finnish Markka; country - Finland; ISO currency code - 246 (Not valid in shippingPolicyCurrency field) Greek Drachma; country - Greece; ISO currency code - 300 (Not valid in shippingPolicyCurrency field) Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 Hungarian Forint; country - Hungary; ISO currency code - 348 (Not valid in shippingPolicyCurrency field) Indonesian Rupiah; country - Indonesia; ISO currency code - 360 (Not valid in shippingPolicyCurrency field) Irish Pound; country - Ireland; ISO currency code - 372 (Not valid in shippingPolicyCurrency field) Israeli New Shekel; country - Israel; ISO currency code - 376 (Not valid in shippingPolicyCurrency field) Italian Lira; country - Italy; ISO currency code - 380 (Not valid in shippingPolicyCurrency field) Dutch Guilder; country - Netherlands; ISO currency code - 528 (Not valid in shippingPolicyCurrency field) Norwegian Krone; country - Norway; ISO currency code - 578 (Not valid in shippingPolicyCurrency field) New Zealand Dollar; country - New Zealand; ISO currency code - 554 (Not valid in shippingPolicyCurrency field) Philippine Peso; country - Philippines; ISO currency code - 608 Polish New Zloty; country - Poland; ISO currency code - 985 Portuguese Escudo; country - Portugal; ISO currency code - 620 (Not valid in shippingPolicyCurrency field) Russian Ruble; country - Russian Federation; ISO currency code - 810 (Not valid in shippingPolicyCurrency field) Swedish Krona; country - Sweden; ISO currency code - 752 Singapore Dollar; country - Singapore; ISO currency code - 702 Thai Baht; country - Thailand; ISO currency code - 764 (Not valid in shippingPolicyCurrency field) New Taiwan Dollar; country - Taiwan; ISO currency code - 901 South African Rand; country - South Africa; ISO currency code - 710 (Not valid in shippingPolicyCurrency field) Indian Rupee; country - India; ISO currency code - 356 Peruvian New Sol; country - Peru; ISO currency code - 604 (Not valid in shippingPolicyCurrency field) Malaysian Ringgit; country - Malaysia; ISO currency code - 458 Vietnamese New Dong; country - Vietnam; ISO currency code - 704 (Not valid in shippingPolicyCurrency field) South Korean Won; country - South Korea; ISO currency code - 410 (Not valid in shippingPolicyCurrency field) New Turkish Lira; country - Turkey; ISO currency code - 949 (Not valid in shippingPolicyCurrency field) Antillian Guilder; country - Netherlands Antilles; ISO currency code - 532 (Not valid in shippingPolicyCurrency field) Aruban Guilder; country - Aruba; ISO currency code - 533 (Not valid in shippingPolicyCurrency field) Bermudan Dollar; country - Bermuda; ISO currency code - 060 (Not valid in shippingPolicyCurrency field) Costa Rican Colon; country - Costa Rica; ISO currency code - 188 (Not valid in shippingPolicyCurrency field) Romanian New Leu; country - Romania; ISO currency code - 946 (Not valid in shippingPolicyCurrency field) Venezuelan Bolivar Fuerte; country - Venezuela; ISO currency code - 937 (Not valid in shippingPolicyCurrency field) Barbados Dollar; country - Barbados; ISO currency code - 052 (Not valid in shippingPolicyCurrency field) Bulgarian Lev; country - Bulgaria; ISO currency code - 975 (Not valid in shippingPolicyCurrency field) Brunei Dollar; country - Brunei; ISO currency code - 096 (Not valid in shippingPolicyCurrency field) Bahamian Dollar; country - Bahamas; ISO currency code - 044 (Not valid in shippingPolicyCurrency field) Columbian Peso; country - Columbia; ISO currency code - 170 (Not valid in shippingPolicyCurrency field) Dominican Peso; country - Dominican Republic; ISO currency code - 214 (Not valid in shippingPolicyCurrency field) Guatemalan Quetzal; country - Guatemala; ISO currency code - 320 (Not valid in shippingPolicyCurrency field) Cayman Isles Dollar; country - Cayman Islands; ISO currency code - 136 (Not valid in shippingPolicyCurrency field) Maldivian Rufiyaa; country - Maldives; ISO currency code - 462 (Not valid in shippingPolicyCurrency field) Qatari Rial; country - Qatar; ISO currency code - 634 (Not valid in shippingPolicyCurrency field) Saudi Riyal; country - Saudi Arabia; ISO currency code - 682 (Not valid in shippingPolicyCurrency field) Trinidadian and Tobagonian Dollar; country - Trinidad and Tobago; ISO currency code - 780 (Not valid in shippingPolicyCurrency field) Ukrainian Hryvnia; country - Ukraine; ISO currency code - 980 (Not valid in shippingPolicyCurrency field) Peso Uruguayo; country - Uruguay; ISO currency code - 858 (Not valid in shippingPolicyCurrency field) East Caribbean Dollar; entity - East Caribbean Currency Area; ISO currency code - 951 (Not valid in shippingPolicyCurrency field) French Polynesian Franc; country - French Polynesia; ISO currency code - 953 (Not valid in shippingPolicyCurrency field) Jamaican Dollar; country - Jamaica; ISO currency code - 388 (Not valid in shippingPolicyCurrency field) Russian ruble; country - Russian Federation; ISO currency code - 643 (Not valid in shippingPolicyCurrency field) Brazilian real; country - Brazil; ISO currency code - 986 (Not valid in shippingPolicyCurrency field) Chilean peso; country - Chile; ISO currency code - 152 (Not valid in shippingPolicyCurrency field) Mexican peso; country - Mexico; ISO currency code - 484 (Not valid in shippingPolicyCurrency field) Honduran lempira; country - Honduras; ISO currency code - 340 (Not valid in shippingPolicyCurrency field) Nicaraguan cordoba; country - Nicaragua; ISO currency code - 558 (Not valid in shippingPolicyCurrency field) Bolivian boliviano; country - Bolivia; ISO currency code - 068 (Not valid in shippingPolicyCurrency field) Paraguayan guarani; country - Paraguay; ISO currency code - 600 (Not valid in shippingPolicyCurrency field) Type definining the rateTableInfo container, which identifies the domestic and international shipping rate tables referenced to determine flat-rate shipping costs based on shipping service level (Economy, Standard, Expedited, One-day) and delivery location. Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.

Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined.

This field is returned in getSellerProfiles if it is defined for the shipping policy. 50 addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.

Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined.

This field is returned in getSellerProfiles if it is defined for the shipping policy. 50 addSellerProfile setSellerProfile No getSellerProfiles Conditionally This type is reserved for future use. This field is reserved for future use. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This field is reserved for future use. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This field is reserved for future use. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This field is reserved for future use. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This type is for internal use. This field is for future use. This field is for internal use. addSellerProfile setSellerProfile No getSellerProfiles Conditionally Type defining the shippingPolicyInfo container, which consists of detailed information for a seller's shipping policy. This string value indicates the name of the shipping policy. This business policy name must be unique among all of seller's shipping policies. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping policy.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Conditionally The domestic shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping.

If 'FreightFlat' is specified as the domestic shipping type, the freightShipping container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Flat addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Shipping http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay\_XML\_API&topic=Shipping The international shipping cost model used by the seller. Valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping.

If 'FreightFlat' is specified as the international shipping type, the freightShipping container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Flat addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment for an order. This time does not include the shipping time (the carrier's transit time). Valid values can vary by site and by category. To obtain supported values for a site, call GeteBayDetails, using DispatchTimeMaxDetails as a DetailName value in the request, and then look at the DispatchTimeMaxDetails container in the response for supported values for the site.

Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. To offer zero-day or one-day handling, the seller should include the dispatchTimeMax field in the shipping business policy and set the value of this field to '0' or '1', respectively.

The dispatchTimeMax field must be included in the shipping policy and set to '0' or '1' if the fastShipping flag is included and set to 'true' in the shipping policy.

Note: Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a DispatchTimeMax value of '0' to indicate that no handling time is specified for the listing. However, with the onboarding of same-day shipping, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Now, sellers that do not want to specify a handling time for their shipping policy, should omit the < b>dispatchTimeMax field, or they can include it but set it to null.
This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
1 30 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Always This free-form string field is used by the seller to provide more details to the buyer about handling time.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This optional field helps summarize the locations/regions that the seller will ship an item to. The integer value that is used in this field for an addSellerProfile or setSellerProfile call should be in synch with the values that are specified in the shipToLocation and excludeShipToLocation fields used in the same call.

The possible values are listed below:
  • 0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site).
  • 1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the shipToLocation field.
  • 2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an excludeShipToLocation field.
  • 3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle.
  • 4 ('TermsAndConditionsOnly'): this value is for future use.
If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Sellers can use this field to exclude one or more international regions, countries, or special domestic locations (such as 'PO Box' in US or 'Packstation' in Germany) as possible shipping locations. To obtain valid 'exclude Ship-To locations', the seller must call GeteBayDetails, using ExcludeShipppingLocationDetails as a DetailName value in the request, and then scan the ExcludeShippingLocationDetails.Location values that are returned in the response. The seller may include as many valid excludeShipToLocation values as necessary based on where they are not willing to ship an item.

If a buyer's primary ship-to location is a location that the seller has listed as an excluded ship-to location, that buyer will receive an error message if they attempt to buy or place a bid on your item.

This field works in conjunction with the shipToLocation values to create a set of international regions, countries, and domestic locations to where the seller will (and will not) ship. You can list a region in the shipToLocation field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a shipToLocation value, yet exclude Egypt by including an excludeShipToLocation field with its value set to 'EG', which is Egypt's two-digit country code. In addition, if a seller used only one shipToLocation value and set it to 'Worldwide', that seller can use one or more excludeShipToLocation fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations.

Each excluded ship-to location is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Container consisting of flat-rate or calculated shipping discount profile IDs (that identify the shipping discount rules to apply when domestic and/or international buyers purchase multiple items), as well as flags indicating if promotional shipping discounts are offered to domestic and/or international buyers.

Shipping discounts can be created by the seller through My eBay, or by using the SetShippingDiscountProfiles call of the Trading API.

If shipping discounts are used for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles This container consists of details related to freight shipping. This container and its values are required to be set in a shipping policy if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat').

If freight shipping is specified for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally An international region (such as Asia, Europe, or Latin America) or country (represented by two-letter country code) to where the seller will ship an item.

It is not necessary to include the shipToLocation field in the domesticShippingPolicyInfoService container when using the addSellerProfile and setSellerProfile calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the shipToLocation field is always returned for each shipping policy in the addSellerProfile, setSellerProfile, and getSellerProfiles calls.

If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to offer shipping to one or more specific shipping regions, the seller must include that shipping region in a shipToLocation field. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should use one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

Applicable shipping region values are defined in ShippingRegionCodeType and applicable country codes are defined in CountryCodeType. However, it is best practice for sellers to call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response.

Each specified ship-to location is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html GeteBayDetails http://developer.ebay.com/devzone/xml/docs/reference/ebay/types/ShippingRegionCodeType.html ShippingRegionCodeType http://developer.ebay.com/devzone/xml/docs/reference/ebay/types/CountryCodeType.html CountryCodeType Container that consists of detailed information for a domestic shipping service, including shipping costs, ship-to locations, and flags to indicate Fast and/or Free shipping. Up to four domestic shipping service options can be specified in one shipping business policy.

Each specified domestic shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Container that consists of detailed information for an international shipping service, including shipping costs and ship-to locations. Up to five international shipping service options can be specified in one shipping policy.

Each specified international shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This container consists of the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer.

If shipping insurance options are specified for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.

Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined.

If set for the shipping policy (Germany and UK only), this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.

50 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.

Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.

50 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field allows the seller to add package handling costs for shipping an item to a domestic location.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field allows the seller to add package handling costs for shipping an item to an international location.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call GeteBayDetails, using CurrencyDetails as a DetailName value in the request, and then scanning the CurrencyDetails.Currency values that are returned in the response.

If this field is not included in an addSellerProfile or setSellerProfile call, the currency code will default to the standard currency used by the listing site.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always This container is for future use. This flag should be included and set to 'true' if the seller wants to enable the Global Shipping Program feature in the shipping policy. If the value of globalShipping is 'true', the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally).

To make use of this field and the Global Shipping Program, the seller and the item being listed must be eligible for the Global Shipping Program. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID 3).

In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the paymentInfo.immediatePay flag in the payment business policy and set its value to 'true';
    • Include only one paymentInfo.acceptedPaymentMethod field in the payment business policy and set its value to 'PayPal';
    • Include a valid PayPal payment address in the paymentInfo.paypalEmailAddress field.
When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always Type defining the shippingPolicyInfoService container, which consists of detailed information for a shipping service option being offered to the buyer. An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.

If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.

If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

Each ship-to location specified for the shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingLocationDetails GeteBayDetails (ShippingLocationDetails) A domestic or international shipping service being offered by the seller to ship an item to a buyer.

For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing.

The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing.

If 'Get It Fast' shipping is being enabled for the shipping policy (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE\_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping.

Each shipping service specified for the shipping policy is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html GeteBayDetails This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages.

Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options.

Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.

If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call.

This field is always returned (for each shipping service) with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.

1 4 (for domestic shipping service) or 5 (for international shipping service) addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This flag is used by the seller to offer free domestic shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call.

If free shipping is set for a domestic shipping service, this field is returned in the shipping business policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option.

To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service.

If a Cash-on-Delivery shipping service is defined for the shipping policy, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This flag indicates whether or not the seller is offering 'Get It Fast' shipping for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.

To enable 'Get It Fast' shippping for a listing, the seller must:
  • offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;
  • set the shippingPolicyInfo.dispatchTimeMax value to '0' or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. A DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping.
Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment policy, this option is turned on with the paymentInfo.immediatePay flag. To enable the immediate payment feature on a listing, the seller must:
  • have a Premier or Business PayPal account;
  • provide a valid Item.PayPalEmailAddress value;
  • offer 'PayPal' as the single payment method in the Item.PaymentMethods field.
The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers.

Not supported for UK Half.com items.

If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used.

This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer.

The total shipping costs for an order line item is calculated with the following formula:

Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)).

This field is not applicable to calculated shipping.

If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping.

This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the freeShipping field is set to 'true'.

The total shipping costs for an order line item is calculated with the following formula:

Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)).

This field is always returned (for each shipping service) with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Determining Shipping Costs for a Listing http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay\_XML\_API&topic=ShippingGettingCosts addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas.

In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
  • a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response;
  • flat-rate shipping is used
If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field is only applicable to vehicle categories on eBay Motors (US and Canada).

If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. true addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This field is only applicable to vehicle categories on eBay Motors (US and Canada).

If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.

true addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the shippingProfileDiscountInfo container, which consists of details related to flat-rate, calculated, and promotional shipping discounts that are offered to domestic and/or international buyers. Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, a domestic buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API.

The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the domesticShippingType ('Flat' or 'Calculated') value in the shipping policy.

Shipping discount profiles are not applicable when Freight shipping is used. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, an international buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API.

The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the intlShippingType ('Flat' or 'Calculated') value in the shipping policy.

Shipping discount profiles are not applicable when Freight shipping is used. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles If this field is included and set to 'true', a domestic buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles If this field is included and set to 'true', an international buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles Enumerated type defining the shipping rates that the seller will receive through USPS, UPS, or Federal Express to ship an item. The shipping rate also affects how much the buyer will pay for shipping. This value indicates that the seller gets On Demand shipping rates through United Parcel Service (UPS). This value indicates that the seller gets Daily Pickup shipping rates through United Parcel Service (UPS). This value indicates that the seller gets Standard shipping rates through Federal Express (FedEx). This value indicates that the seller gets Counter shipping rates through Federal Express (FedEx). This value indicates that the seller gets Discounted shipping rates through US Postal Service (USPS). This value indicates that the seller gets Commercial Plus shipping rates through US Postal Service (USPS). This value indicates that the seller gets discounted shipping rates through Federal Express (FedEx). This value indicates that the seller gets gold/silver-level shipping rates. This value indicates that the seller gets platinum/titanium-level shipping rates. This value indicates that the seller gets standard eBay shipping rates. This value indicates that the seller gets standard retail shipping rates. Type defining the categoryGroup container, which indicates the category group to which the payment, return, or shipping business policy applies to. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. This flag indicates if the corresponding business policy defined for the assigned category group is used by default for listings in a category group that does not have a business policy assigned to it. For example, if a seller has only created a business policy for motor vehicles (categoryGroup=MOTORS\_VEHICLE), and this category group is set as the default, all applicable settings/values in this business policy will also apply to non-motor vehicle categories. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings.

If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always This string value indicates the name of the category group to which the corresponding business policy applies. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always This flag is returned as 'true' if the corresponding business policy meets all eBay Top-Rated Listing requirements for the category group. To qualify as an ETRS business policy, the seller must meet Top-Rated Seller requirements, and the business policy must include a 14-day (or longer) money back return policy and same-day or one-day handling. For more information on Top-Rated Seller and Top-Rated Plus listings, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic. getSellerProfiles addSellerProfile setSellerProfile Conditionally Documentation goes here. 1.0.0 --- # GetCategoryFeatures This is a request object containing input for the find product operation Finds products for a given category and search criteria. ProductMetadata http://developer.ebay.com/DevZone/product-metadata/CallRef getProductSearchNames Retrieves all properties available for a given catalog-enabled category. getProductSearchValues Retrieves property values for the specified property. User can findproducts for one catalog at a time or batch up to 10 catalogs. 10 findProducts No Retrieve product details for the specified product ID, including whether the product has fitment information or not. Retrieve product details for the specified product ID, including whether the product has fitment information or not. Contains product details. getProductDetails No Container for product details. Details for a single product. getProductDetails Conditionally Response container for the product search results. Container for the products that matched the search criteria. The data for each product is returned in individual containers, if any matches were found. findProducts findProductsByCompatibility Conditionally This is a request object containing input for the findProductsByCompatibility operation. Finds products for the specified category, catalog property name-value pairs, and compatibility property name-value pairs. ProductMetadata http://developer.ebay.com/DevZone/product-metadata/CallRef getCompatibilitySearchNames Retrieves all compatibilities available for a given compatibility-enabled category. getCompatibilitySearchValues Retrieves values for the specified compatibility. Container for an individual product search query. findProductsByCompatibility No Request object for getProductFitmentDetails operation. Returns all available compatibility details for the specified product. The ProductIdentifierType and a value for one of the supported ProductIdentifierTypes which are unique across all sites (ePID, MementoString) getProductCompatibilities Yes Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). getProductCompatibilities No This will contain the property name value pairs of the application, such as a particular vehicle make and model. Application property filters are specified as name-value pairs. getProductCompatibilities No This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. getProductCompatibilities No We need to allow multiple sort orders. This is very specific to fitment. We allow the caller sorty by Make + Model + year. To start with we will only allow 5 sorts. getProductCompatibilities No Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. getProductCompatibilities No Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. getProductCompatibilities Yes Response object for getProductFitmentDetails operation. Indicates the pagination of the result set. Child elements indicate the maximum number of item listings returned per response and which page of data has been returned. getProductCompatibilities Always Compatibility details for a single product. getProductCompatibilities Conditionally Thumbnail and standard stockphoto URLs. Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. Conditionally Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. Conditionally Container for a single compatibility filter. Filter consisting of name-value pairs that describe compatibilities for a product. findProductsByCompatibility No Not used. Ignore Not used. Ignore Container for request data used in product search calls. A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed.

If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number . \-9223372036854775808 9223372036854775807 findProducts findProductsByCompatibility Yes Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled.

Your request must contain categoryId and/or keywords. 10 findProducts findProductsByCompatibility Conditionally http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html GetCategoryFeatures information to identify compatibility-enabled categories. Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint.

Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported.

Your request must contain categoryId and/or keywords. 350\. The maximum length for a single word is 98 findProducts findProductsByCompatibility Conditionally One or more name-value pairs that describe the product. findProducts findProductsByCompatibility No Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. findProducts findProductsByCompatibility No This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. Searchable findProducts findProductsByCompatibility No Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. findProducts findProductsByCompatibility No Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). findProducts findProductsByCompatibility No Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com. findProducts findProductsByCompatibility No Container for product information returned by product search calls. Container for multiple products. findProducts findProductsByCompatibility Conditionally Indicates the pagination of the result set. Child elements indicate the maximum number of item listings returned per response and which page of data has been returned. findProducts findProductsByCompatibility Conditionally A unique identifer for a given product response, corresponding to a specific product request. \-9223372036854775808 9223372036854775807 findProducts findProductsByCompatibility Conditionally This is the base class for product queries by compatible application. This will contain the property name-value pairs of the application. For example, an application property filter can consist of name-value pairs that describe a particular make and model of a car. findProductsByCompatibility No User can findproducts for one catalog at a time or batch up to 10 catalogs. findProductsByCompatibility No Container for request data for retrieving product details. The product identifier type and value. Product identifiers, such as ePID values or ISBN values, are unique across all sites. getProductDetails Yes Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. getProductDetails No This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. getProductDetails No Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. getProductDetails No This is the base class for request container for all service operations. 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. The request that triggered the error was processed successfully but with some warnings. The request that triggered the error was processed successfully but with some warnings. Base response container for all service operations. Contains error information associated with the request. Indicates whether or not errors or warnings were generated during the processing of the request. Always Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. Conditionally The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. Always This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Always There are three categories of error: request errors, application errors, and system errors. Request and application errors are often caused by passing invalid data in the request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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 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, 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. 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. A container for 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 in which the error occurred.
domain values:
Marketplace
A business or validation error occurred in the service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.
Conditionally Name of the subdomain in which the error occurred.
subdomain values:
MarketplaceCatalog
The error is specific to the Marketplace Catalog subdomain.
MarketplaceCommon
The error is common to all Marketplace services.
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, re-send 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused in the error. Conditionally Unique identifier for an exception associated with an error. 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. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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 case, 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. Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls which listings are returned in the response, but does not control the details associated with the returned items. Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return. 1 100 No Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used. 100 100 No Shows the pagination data for the item search. Child elements include the page number returned, the maximum entries returned per page, the total number of pages that can be returned, and the total number of items that match the search criteria. The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any items that match the search criteria. Conditionally The total number of items found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any items that match the search criteria. Conditionally The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of items matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of item data.

This returned value indicates the page number of item data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. Conditionally The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. Conditionally Type to specify order for sorting compatibility properties. The property with its associated sort order, ascending or descending. findCompatibilitiesBySpecification getProductCompatibilities No Indicates where in the sequence of ordering the property should ordered. There are five sorting steps, Sort1 through Sort5. When a property is assigned Sort1 as its sort priority, its values are sorted first. Values for the property assigned Sort2, are sorted second, and so on. findCompatibilitiesBySpecification getProductCompatibilities No Defines the order type as Ascending or Descending The results will be sorted by the specified attribute in ascending (low to high) order. The results will be sorted by the specified attribute in descending (high to low) order. Sort order input for the result set. Any of the searchable properties can be used for property name and order can be either Ascending or Descending. Output can be sorted by one or more property names. You can look these values up using the getProductSearchNames call in the Product Metadata API. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Order of the sort, either Ascending or Descending. Descending findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Specifies the order in which properties will considered for sorting. Specifies that the associated property should be sorted first. Specifies that the associated property should be sorted second. Specifies that the associated property should be sorted third. Specifies that the associated property should be sorted fourth. Specifies that the associated property should be sorted fifth. This operation returns all the compatiblilities for a given specification. User can constrain the output further by specifiying the compatibility propertiesthat they are interested in. Retrieves compatible applications for a product based on its specifications. Category ID for which we want to find out the compatibility details findCompatibilitiesBySpecification No This filter is used to restrict the number of compatible vehicles that can be returned. Properties that can be used here include Make, Model, Year and Trim findCompatibilitiesBySpecification No The specifications for which we need the compatibility. Examples include Aspect Ratio, Section Width etc. findCompatibilitiesBySpecification Yes This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. findCompatibilitiesBySpecification No User can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. findCompatibilitiesBySpecification No For certain specification properties the compatibility is defined not by an exact match but by an expanded match on the input value by greater or lesser values as well. E.g For Load Index a compatible vehicle is the one which has a load index requirement which is less than or equal to the input. By default we will do an expanded compatibility match whenever it applies. However if you need to do only exact match then you can specify that using this input. false findCompatibilitiesBySpecification No Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). findCompatibilitiesBySpecification No Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. findCompatibilitiesBySpecification No Container for the Compatibility by specification operation output. Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. findCompatibilitiesBySpecification Always List of compatibilties. findCompatibilitiesBySpecification Always Name-Value pairs for each compatiblility property. Name-Value pairs for each compatiblility property. findCompatibilitiesBySpecification Always Container for notes related to a product in the eBay catalog. Additional comments about the product in the form of name-value pairs. Conditionally This class holds a numeric value A numeric value. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Conditionally Unit of measure for a numeric value.
Allowed values:
bps
Bits per second. A unit of data transmission.
kbps
Kilobits per second. A unit of data transmission.
bit
Binary digit. A unit of information storage.
byte
An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.
kb
Kilobit. A unit of information storage equal to 1024 bits.
MB
Megabyte. A unit of information storage equal to one million bytes.
mW
Megawatt. A unit of power equal to one million watts.
W
Watt. The base SI unit of power.
Hz
Hertz. A unit of frequency equal to one cycle per second.
kHz
Kilohertz. A unit of frequency equal to 1,000 cycles per second.
m
Meter. The base unit of distance.
mm
Megameter. A unit of distance equal to one million meters.
rph
Revolutions per hour. A unit of frequency.
hr
Hour. A unit of time equal to 3,600 seconds.
min
Minute. A unit of time equal to 60 seconds.
ms
Microsecond. A unit of time equal to one millionth of a second.
ns
Nanosecond. A unit of time equal to 10-9 seconds.
sec
Seconds. The base unit of time.
g
Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.
lbs
Pounds. The base Imperial unit of mass.
The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. findProducts findProductsByCompatibility getProductCompatibilities No findProducts findProductsByCompatibility getProductDetails Conditionally Container type for product data. The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. Conditionally Thumbnail and standard stockphoto URLs. Conditionally Details about the product in the form of name-value pairs. Conditionally Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. Conditionally The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. ComingSoon Conditionally Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.
Allowed values:
Head
The product is the the head of the product family.
Member
The product is a variant of the head product.
Conditionally Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. Conditionally Type could be ePID, MementoString as well as ISBN, UPC, EAN, Brand\_MPN. eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). 38 getProductCompatibilities getProductDetails Conditionally Conditionally ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. 13 getProductCompatibilities getProductDetails Conditionally Conditionally eBay Product ID. 12 getProductCompatibilities getProductDetails Conditionally Conditionally European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. 13 getProductCompatibilities getProductDetails Conditionally Conditionally eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) 4000 getProductCompatibilities getProductDetails Conditionally Conditionally This will indicate if the product is disabled for the specific application like selling flow, review flow or half sell flow. Product cannot be used in selling flows on eBay. false No Conditionally Product cannot be used in product review flows. false No Conditionally Product cannot be used in selling flows on half.com. false No Conditionally A property name and corresponding value (a name/value pair). This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. findProducts findProductsByCompatibility getProductCompatibilities No findCompatibilitiesBySpecification compatibilityPropertyFilter No findCompatibilitiesBySpecification specification Yes Conditionally A value for the property. findProducts findProductsByCompatibility getProductCompatibilities No findCompatibilitiesBySpecification compatibilityPropertyFilter No findCompatibilitiesBySpecification specification Yes Conditionally This class holds a String value A string value. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Conditionally This class holds a URL value As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Conditionally A value can be one of the types: text (string), a number ( For string value type. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Conditionally For numeric value type. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Conditionally For URL value type. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Conditionally 1.3 This service provides the ability to find products, get product details and get compatibility details for a product. 1.3.0 --- # Unknown POST https://api.ebay.com/post-order/v2/cancellation/check\_eligibility { "legacyOrderId":"1\*\*\*\*\*\*\*\*\*\*6-8\*\*\*\*\*\*\*\*7" } --- # Unknown POST https://api.ebay.com/post-order/v2/cancellation/ { "legacyOrderId": "1\*\*\*\*\*\*\*\*\*\*6-8\*\*\*\*\*\*\*\*7", "cancelReason":"ORDER\_MISTAKE", "buyerPaid": "false" } --- # FindItemsAdvanced documentation Returns the current version of the service. This simple call can be used to monitor the service for availability. This call has no input parameters and the response contains only the standard output fields. Returns the current service version. Response container for the getVersion call. This is the base class for request container for all service operations. This is the base class for request container for all operations in the Merchandising Service. Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value you specify, the lower number is returned. Values less than 1 or greater than 50 (or 20 in the case of getTopSellingProducts) will be ignored. 1 50 20 getMostWatchedItems getRelatedCategoryItems getSimilarItems No 1 20 20 getTopSellingProducts No Container for affiliate details. eBay uses the specified affiliate details to build a View Item URL and Product URL string in the response that includes your affiliate tracking information in the correct format. When a user clicks through these URLs to eBay and performs certain tasks, you may get an affiliate commission.

See the eBay Partner Network for information about commissions. No Retrieves data for items with the highest watch counts for the entire site or for a specific category. The top 20 most watched items, if any, are returned unless maxResults is used to specify a smaller or larger result set. The top items are determined by the watch count totals from the preceding day. Ranking of the most watched items is calculated with the latest watch count information.

Only active items are returned. Auction items are returned only when they have one or more bids. Retrieves data for items with the highest watch count. Specifies the category from which to retrieve item listings. This field takes the same category ID data as used with other eBay APIs.

Category IDs are site-specific. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories, you can use either the Shopping API or the Trading API. In the Shopping API, use the FindItemsAdvanced call with the CategoryHistogram value in the IncludeSelector field to retrieve matching category information. In the Trading API, use calls like GetCategories and GetCategoryFeatures to determine valid values for the site. 10 getMostWatchedItems No http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html FindItemsAdvanced documentation information on retrieving a category histogram. http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html GetCategories documentation information on retrieving categories. http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html GetCategoryFeatures documentation information on retrieving category details.
Important: This API call is no longer actively managed and cannot be relied upon to retrieve current product data, and in some cases, will not retrieve any data. As an alternative to this call, we recommend using the getMerchandisedProducts call of the Buy Marketing API.

Retrieves the 20 top selling products on eBay, unless maxResults is used to specify a smaller result set. Products in the response are sorted in sales rank order, with the top selling products first. There are no call-specific input parameters for this call.

Retrieves eBay's top selling products. Products in the reponse are sorted in sales rank order, with the top selling products first. Retrieves recommended items from categories related to a specified category or item. If categoryId is specified, then items are returned from categories related to the given category. If itemId is specified, then items are returned from categories related to the given item's category. In either case, the response contains items from the three best matching categories. The selection of items is evenly distributed between the best matching categories. The recommended items are sorted by end time, with items ending soonest first.

The request must contain either categoryId or ItemId. If both itemId and categoryId are specified, categoryId takes precedence.

Note: In some cases, the item recommendations returned by getRelatedCategoryItems are not closely related to the item specified in the request. Refer to the getRelatedCategoryItems does not return related items thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.

Retrieves items related to a specified category or item. The ID of an active item listing. Related categories are determined from the primary category in which the item is listed. If both categoryId is also specified, it takes precedence. 19 getRelatedCategoryItems Conditionally Specifies the category used to determine related categories from which to retrieve item listings. This field takes the same category ID data as used with other eBay APIs.

Category IDs are site-specific. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories, you can use either the Shopping API or the Trading API. In the Shopping API, use the FindItemsAdvanced call with the CategoryHistogram value in the IncludeSelector field to retrieve matching category information. In the Trading API, use calls like GetCategories and GetCategoryFeatures to determine valid values for the site. 10 getRelatedCategoryItems Conditionally http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html FindItemsAdvanced documentation information on retrieving a category histogram. http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html GetCategories documentation information on retrieving categories. http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindItemsAdvanced.html GetCategoryFeatures documentation information on retrieving category details. Filters items based on the allowed set of name value pairs. 19 getRelatedCategoryItems No Retrieves data for top 20 "best deal" items on eBay that match a simple keyword query. Items that provide the best value to buyers, such as items that are on sale or items with free shipping) are considered best deals. The query searches item titles only, and results, if any, must match all terms specified in the required keywords field. Items in the results are sorted by Best Match, which is based on community buying activity and other relevance- based factors.

Important: The getDeals call is not returning any item recommendations. Refer to the getDeals call not returning results thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.

Retrieves data for "best deal" items that match a simple keyword query. Best deal items include items that are on sale and items that offer free shipping. samples A query string for searching titles of items on eBay. The query is limited to a maximum of 7 space-delimited terms. Any additional terms will be ignored. Results must match all terms in the query.

The keywords field does not support wildcards, such as asterisks ("\*") or question marks ("?"), or Boolean search operators, such as "AND" (or the plus sign "+"), "OR," or "NOT" (or the minus sign "-"). Search wildcard or operator characters (e.g., "\*" or "+") will be ignored. The words "and" and "or" and "not" are treated like any other word, and should be used only if you are searching for listings containing these words.

Note: If you are using an HTTP GET (i.e., URL) request, use "%20" to delimit terms specified in keywords. For example, use Harry%20Potter to search for items containing those words in any order. getDeals Yes For a specified item, retrieves recommended similar items. Items are considered similar if they can serve as a replacement for the specified item. Similar items from a catalog are associated with the same product. For items not associated with a product, similarity with other items is determined from keywords in the title and attribute value matches. This call can be used to recommend items to buyers who have lost items they were bidding on, or to recommend items as alternatives for watched items that have ended.

The recommended similar items returned can be restricted by category, maximum price, or end time for the listing.

The request must contain itemId. Retrieves items that are similar to the specified item. The ID of an active item listing or a listing that has ended less than two weeks ago. 19 getSimilarItems Yes Results are limited to items from the specified category only. Up to three category IDs can be specified. You cannot specify both categoryId and categoryIdExclude in the same request. getSimilarItems No Items from the specified category are excluded from the results. Up to three category IDs can be specified. You cannot specify both categoryId and categoryIdExclude in the same request. 19 getSimilarItems No Filters items based on the format of the listing. If listingType is not specified, all listing types can be returned unless another relevant filter is specified.

Applicable values:
AdType
Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.
Chinese
Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.
Dutch
Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.
FixedPriceItem
A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner.
LeadGeneration
Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).
StoresFixedPrice
A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Starting in early June 2008, on the Italy site, stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format).
19 getSimilarItems No Limits the results to items ending before the specified time. within a time range. If you are specifying a time range with EndTimeFrom, EndTimeFrom must be specified (with a value equal to or earlier than EndTimeTo). Specify the time in GMT. 19 getSimilarItems No Limits the results to items ending after the specified time. Specify a time in the future. If you specify a time in the past, the current time is used. Specify the time in GMT. 19 getSimilarItems No Specifies the maximum current price an item can have to be included in the response. The currencyId you specify must match the currency corresponding to the global ID value passed in the request. If no global ID is specified, you must specify USD. getSimilarItems No Filters items based on the allowed set of name value pairs. 19 getSimilarItems No Base response container for all service operations. Contains error information associated with the request. Indicates whether there are any errors or warnings associated with the processing of the request. Always Information for an error or warning that occurred when eBay processed the request. Not returned when responseStatus is Success. See Errors by Number for a list of errors and warnings that can be returned by Merchandising API calls. Conditionally The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. Developer Technical Support may ask you for the version value when you work with them to troubleshoot issues. 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). See the "dateTime" type for information about this time format and converting to and from the GMT time zone. Always Indicates the status of the call. The request was processed successfully without errors or warnings. Errors occurred that prevented the request from being processed successfully. The request was processed successfully, but some warnings were returned. Reserved for future use. Base response container for all service operations in the Merchandising Service. This is a response for operations that return item recommendations. Results consist of an itemRecommendations array containing one or more item containers. A list of items matching the given criteria. Item sort order is different for each call. Returned when there are items that match the search criteria. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Always Note: This type and the productRecommendations container are no longer applicable, as the getTopSellingProducts call is no longer functional. This complex type is used by the base response of the getTopSellingProducts call. Note: This container is no longer applicable, as the getTopSellingProducts call is no longer functional. An array of top selling products. This container is returned when there are one or more products that match the search criteria. getTopSellingProducts Conditionally This is a container for list of item recommendations. Contains details for a single recommended item. Returned when there is at least one item that matches the search criteria. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Note: This type and the product container are no longer applicable, as the getTopSellingProducts call is no longer functional. List of suggested products sorted by sales rank, with top selling products listed first. Note: This container is no longer applicable, as the getTopSellingProducts call is no longer functional. An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. Returned when there is at least one product that matches the search criteria. getTopSellingProducts Conditionally Contains details for an active item listing. The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. 19 getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Always Name of the item as it appears in the listing or search results. 55 getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Always The URL of the web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network). getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Always For competitive-bidding listings (Chinese and Dutch auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price, Store Inventory, or Ad type listings, this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Original price of an item whose price a seller has reduced with the Promotional Price Display feature. Only returned if the price has been revised. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally The site upon which the item is listed. Returns a Global ID, which is a unique identifier for combinations of site, language, and territory.

For a list of possible enumeration values and how they map to eBay sites, see Global ID Values. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Time left before the item listing ends. The duration is represented in the ISO 8601 duration format (PnDTnHnMnS). For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.)
Note: Currently, the Merchandising API calls do not return a listing's secondary category, if any. 10 getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks). 30 getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Subtitle of the item. Only returned if the seller included a subtitle for the listing. 55 getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally The number of bids that have been placed on the item. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed.

For Chinese auctions (Quantity=1, competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls can still return the Buy It Now Price that the seller set for the listing. Use the item.bidCount field to determine whether an auction with Buy It Now has bids or not.

Some eBay sites also support Buy It Now for Dutch auctions (multi- quantity, competitive bidding), where you can buy multiple items from the same listing at a fixed price, instead of bidding. On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids.

For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see currentPrice instead.

Only returned if an item was listed with Buy It Now. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally Two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally The shipping cost associated with the first shipping service. Only returned when shipping type is flat. getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally The shipping cost model offered by the seller.

Applicable values:
Calculated
Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.
CalculatedDomesticFlatInternational
The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.
Flat
Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.
FlatDomesticCalculatedInternational
The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.
Free
Free shipping: Seller has specified free shipping for the item. The cost of shipping is zero for the first domestic shipping service (for flat or calculated shipping).
Freight
Freight shipping model: The cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code).
NotSpecified
The seller did not specify the shipping type.
getDeals getMostWatchedItems getRelatedCategoryItems getSimilarItems Conditionally The number of watches placed on this item from buyers' My eBay accounts. getMostWatchedItems Always The format type of the listing, such as online auction, fixed price, or advertisement. getMostWatchedItems getSimilarItems Conditionally Strike through price Miminum Advertised Price None Note: This type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. The eBay or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The productId values can be used as input for calls in the Shopping and Trading APIs to retrieve products, item listings, or guides and reviews.
The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Shopping http://developer.ebay.com/DevZone/shopping/docs/CallRef FindItemsAdvanced Searches for items based on many possible input fields, including the product ID. Provides detailed item information. FindProducts When product ID is specified, retrieve product details for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying. FindReviewsAndGuides When product ID is specified, retrieves reviews (not guides) for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying. 4000 getTopSellingProducts Always Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. The title of the product, as specified in the catalog. Always returned when Product is returned. getTopSellingProducts Always Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. This is usually always returned when Product is returned, but it may be safest to check for the existence of this field. getTopSellingProducts Always Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. Name of the catalog the product is in. Only returned if product is in a catalog. getTopSellingProducts Always Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. Fully qualified URL for a stock image (if any) associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. getTopSellingProducts Conditionally Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. The total number of reviews available for this product on the eBay Web site. Always returned when product is returned. getTopSellingProducts Conditionally Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. The lowest price for items listed as this product. getTopSellingProducts Conditionally Note: The Product type and all of its fields are no longer applicable, as the getTopSellingProducts call is no longer functional. The highest price for items listed as this product. getTopSellingProducts Conditionally Basic type for specifying monetary amounts. A double value (e.g.,1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An AmountType expresses both the value (a double) and the currency. Details such as prices, fees, costs,and payments are specified as amount types. Currency in which the monetary amount is specified.

For a list of possible enumeration values, see currencyId Values. Always eBay uses the specified details to build a View Item URL and Product URL string in the response that includes your affiliate tracking information in the correct format. When a user clicks through the URL to eBay and performs certain tasks, you may get a commission.

For information about commissions, see the eBay Partner Network. The value you specify is obtained from your tracking partner. For eBay Partner Network, the TrackingID is the Campaign ID ("campid") provided by eBay Partner Network. A Campaign ID is a 10-digit, unique number to be used for associating traffic. A Campaign ID is valid across all programs to which you have been accepted. Another example is the Affiliate ID given to you by TradeDoubler. No Specifies your tracking partner for affiliate commissions. Affiliates earn money from eBay for driving traffic to eBay. Required if you specify a TrackingID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only eBay Partner Network and Mediaplex are valid:
2 = Be Free
3 = Affilinet
4 = TradeDoubler
5 = Mediaplex
6 = DoubleClick
7 = Allyes
8 = BJMT
9 = eBay Partner Network For information about commissions, see the eBay Partner Network. No Need not be specified. You can define an AffiliateUserID (up to 256 characters) if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateUserID, the tracking URL returned by eBay Partner Network will contain the AffiliateUserID, but it will be referred to as a "customid". No Unique identifier for a product. Defines the type of ProductId.
Enumeration Values:
EAN
EAN value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.

Max length of corresponding value: 13
ISBN
ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.

Max length of corresponding value: 13
Reference
The global reference ID for an eBay catalog product. A reference ID is a fixed reference to a product (regardless of version). Use this instead of CatalogItem when you know a product's reference ID (because older CatalogItem IDs are more likely to become obsolete over time.) One reference ID can be associated with multiple CatalogItem IDs. To determine valid reference IDs for products, first call FindProducts with QueryKeywords (or ProductID). Each product in the response includes a reference ID.
UPC
UPC value for products in Music (e.g., CDs), DVDs & Movies, and Video Games categories (or domains). If you know a product's UPC, you can use this instead of the eBay CatalogItem or Reference ID to search for that product.

Max length of corresponding value: 12
getTopSellingProducts Always Reduce the number of items returned by a request using itemFilters. Use the itemFilter container to specify itemFilter Name/Value pairs. In addition to filter Name/Value pairs, some item filters use an additional parameter Name/Value pair.

For example, if you use the WorldOfGoodOnly item filter, you can optionally specify a parameter name of WOGCategory with a parameter value that specifies the World of Good category. This restricts the item recommendations to items available in the specified World of Good category only.

Note: To locate a specific World of Good category, go to the worldofgood.ebay.com home page. Top-level categories are listed under Shop by Category on the left-hand side of the page. Click the category you want to use to restrict your search results. The resultant URL contains the category ID as a numeric value, appearing before "/list" at the end of the URL (e.g., http://worldofgood.ebay.com/Belts-Hats-Scarves-Shawls/40/list). If a category has children categories, they will be displayed under the Category on the left-hand side of the page. The numeric category ID can be determined from the URL for child categories in the same fashion.

getRelatedCategoryItems getSimilarItems No The value for the parameter name used in an item filter.

For example, if your item filter is WorldOfGoodOnly (true), you can further restrict the item recommendations in the response to items available in a specific World of Good category. In this case, the paramter name is set to WOGCategory and the parameter values is a numeric World of Good category ID. getRelatedCategoryItems getSimilarItems No Name of the item filter from the set of allowed filters. The Merchandising API supports a World of Good item filter only. getRelatedCategoryItems getSimilarItems No The value associated with the respective item filter name. getRelatedCategoryItems getSimilarItems No Values that can be used for the itemFilter.name field. If true, returns only items listed in the World of Good marketplace. Defaults to false.

Allowed values (boolean):
true, false

ErrorMessage to indicate any Error/Warning that occured as part of service call. Any run time error will not be reported here, but will be reported as part of a 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.
Domains include:
Marketplace
A business or validation error occurred for the Merchandising Service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.
Conditionally Indicates whether the error caused the request to fail (Error) or not (Warning).

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.

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.

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.
Subdomains include:
Merchandising
The error is specific to the Merchandising service.
MarketplaceCommon
The error is common to all Marketplace services.
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 list 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. 1.5.0 --- # GetCategoryFeatures This is a request object containing input for the find product operation Finds products for a given category and search criteria. ProductMetadata http://developer.ebay.com/DevZone/product-metadata/CallRef getProductSearchNames Retrieves all properties available for a given catalog-enabled category. getProductSearchValues Retrieves property values for the specified property. User can findproducts for one catalog at a time or batch up to 10 catalogs. 10 findProducts No Retrieve product details for the specified product ID, including whether the product has fitment information or not. Retrieve product details for the specified product ID, including whether the product has fitment information or not. Contains product details. getProductDetails No Container for product details. Details for a single product. getProductDetails Conditionally Response container for the product search results. Container for the products that matched the search criteria. The data for each product is returned in individual containers, if any matches were found. findProducts findProductsByCompatibility Conditionally Request object for getProductFitmentDetails operation. Returns all available compatibility details for the specified product. The ProductIdentifierType and a value for one of the supported ProductIdentifierTypes which are unique across all sites (ePID, MementoString) getProductCompatibilities Yes Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). getProductCompatibilities No This will contain the property name value pairs of the application, such as a particular vehicle make and model. Application property filters are specified as name-value pairs. getProductCompatibilities No This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. getProductCompatibilities No We need to allow multiple sort orders. This is very specific to fitment. We allow the caller sorty by Make + Model + year. To start with we will only allow 5 sorts. getProductCompatibilities No Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. getProductCompatibilities No Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. getProductCompatibilities Yes Response object for getProductFitmentDetails operation. Indicates the pagination of the result set. Child elements indicate the maximum number of compatibilityDetails nodes returned per response and which page of data has been returned. getProductCompatibilities Always Compatibility details for a single product. getProductCompatibilities Conditionally Thumbnail and standard stockphoto URLs. Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. 400 Conditionally Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. 400 Conditionally Container for request data used in product search calls. A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed.

If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number . \-9223372036854775808 9223372036854775807 findProducts findProductsByCompatibility Yes Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled.

Your request must contain categoryId and/or keywords. 10 findProducts findProductsByCompatibility Conditionally http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html GetCategoryFeatures information to identify compatibility-enabled categories. Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint.

Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported.

Your request must contain categoryId and/or keywords. 350\. The maximum length for a single word is 98 findProducts findProductsByCompatibility Conditionally One or more name-value pairs that describe the product. findProducts findProductsByCompatibility No Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. findProducts findProductsByCompatibility No This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. Searchable findProducts findProductsByCompatibility No Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. findProducts findProductsByCompatibility No Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). findProducts findProductsByCompatibility No Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com. findProducts findProductsByCompatibility No Container for product information returned by product search calls. Container for multiple products. findProducts findProductsByCompatibility Conditionally Indicates the pagination of the result set. Child elements indicate the maximum number of productSearchResult nodes returned per response and which page of data has been returned. findProducts findProductsByCompatibility Conditionally A unique identifer for a given product response, corresponding to a specific product request. \-9223372036854775808 9223372036854775807 findProducts findProductsByCompatibility Conditionally Container for request data for retrieving product details. The product identifier type and value. Product identifiers, such as ePID values or ISBN values, are unique across all sites. getProductDetails Yes Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. getProductDetails No This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. getProductDetails No Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. getProductDetails No This is the base class for request container for all service operations. 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. The request that triggered the error was processed successfully but with some warnings. The request that triggered the error was processed successfully but with some warnings. Base response container for all service operations. Contains error information associated with the request. Indicates whether or not errors or warnings were generated during the processing of the request. Always Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. Conditionally The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. Always This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Always There are three categories of error: request errors, application errors, and system errors. Request and application errors are often caused by passing invalid data in the request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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 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, 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. 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. A container for 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 in which the error occurred.
domain values:
Marketplace
A business or validation error occurred in the service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.
Conditionally Name of the subdomain in which the error occurred.
subdomain values:
MarketplaceCatalog
The error is specific to the Marketplace Catalog subdomain.
MarketplaceCommon
The error is common to all Marketplace services.
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, re-send 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused in the error. Conditionally Unique identifier for an exception associated with an error. 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. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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 case, 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. Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls which listings are returned in the response, but does not control the details associated with the returned items. Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return. 1 100 No Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used. 100 100 No Shows the pagination data for the item search. Child elements include the page number returned, the maximum entries returned per page, the total number of pages that can be returned, and the total number of entries that match the search criteria. The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any entries that match the search criteria. Conditionally The total number of entries found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any entries that match the search criteria. Conditionally The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data.

This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. Conditionally The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. Conditionally Type to specify order for sorting compatibility properties. The property with its associated sort order, ascending or descending. findCompatibilitiesBySpecification getProductCompatibilities No Indicates where in the sequence of ordering the property should ordered. There are five sorting steps, Sort1 through Sort5. When a property is assigned Sort1 as its sort priority, its values are sorted first. Values for the property assigned Sort2, are sorted second, and so on. findCompatibilitiesBySpecification getProductCompatibilities No Defines the order type as Ascending or Descending The results will be sorted by the specified attribute in ascending (low to high) order. The results will be sorted by the specified attribute in descending (high to low) order. Sort order input for the result set. Any of the searchable properties can be used for property name and order can be either Ascending or Descending. Output can be sorted by one or more property names. You can look these values up using the getProductSearchNames call in the Product Metadata API. 100 findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Order of the sort, either Ascending or Descending. Descending findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No Specifies the order in which properties will considered for sorting. Specifies that the associated property should be sorted first. Specifies that the associated property should be sorted second. Specifies that the associated property should be sorted third. Specifies that the associated property should be sorted fourth. Specifies that the associated property should be sorted fifth. This operation returns all the compatiblilities for a given specification. User can constrain the output further by specifiying the compatibility propertiesthat they are interested in. Retrieves compatible applications for a product based on its specifications. Category ID for which we want to find out the compatibility details findCompatibilitiesBySpecification No This filter is used to restrict the number of compatible vehicles that can be returned. Properties that can be used here include Make, Model, Year and Trim findCompatibilitiesBySpecification No The specifications for which we need the compatibility. Examples include Aspect Ratio, Section Width etc. findCompatibilitiesBySpecification Yes This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. findCompatibilitiesBySpecification No User can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. findCompatibilitiesBySpecification No For certain specification properties the compatibility is defined not by an exact match but by an expanded match on the input value by greater or lesser values as well. E.g For Load Index a compatible vehicle is the one which has a load index requirement which is less than or equal to the input. By default we will do an expanded compatibility match whenever it applies. However if you need to do only exact match then you can specify that using this input. false findCompatibilitiesBySpecification No Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). findCompatibilitiesBySpecification No Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. findCompatibilitiesBySpecification No Container for the Compatibility by specification operation output. Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. findCompatibilitiesBySpecification Always List of compatibilties. findCompatibilitiesBySpecification Always Name-Value pairs for each compatiblility property. Name-Value pairs for each compatiblility property. findCompatibilitiesBySpecification Always Container for notes related to a product in the eBay catalog. Additional comments about the product in the form of name-value pairs. Conditionally This class holds a numeric value A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No addProducts Conditionally Conditionally Unit of measure for a numeric value.
Allowed values:
bps
Bits per second. A unit of data transmission.
kbps
Kilobits per second. A unit of data transmission.
bit
Binary digit. A unit of information storage.
byte
An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.
kb
Kilobit. A unit of information storage equal to 1024 bits.
MB
Megabyte. A unit of information storage equal to one million bytes.
mW
Megawatt. A unit of power equal to one million watts.
W
Watt. The base SI unit of power.
Hz
Hertz. A unit of frequency equal to one cycle per second.
kHz
Kilohertz. A unit of frequency equal to 1,000 cycles per second.
m
Meter. The base unit of distance.
mm
Megameter. A unit of distance equal to one million meters.
rph
Revolutions per hour. A unit of frequency.
hr
Hour. A unit of time equal to 3,600 seconds.
min
Minute. A unit of time equal to 60 seconds.
ms
Microsecond. A unit of time equal to one millionth of a second.
ns
Nanosecond. A unit of time equal to 10-9 seconds.
sec
Seconds. The base unit of time.
g
Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.
lbs
Pounds. The base Imperial unit of mass.
The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. findProducts findProductsByCompatibility getProductCompatibilities No findProducts findProductsByCompatibility getProductDetails Conditionally Container type for product data. The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. Conditionally Thumbnail and standard stockphoto URLs. Conditionally Details about the product in the form of name-value pairs. Conditionally Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. Conditionally The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. ComingSoon Conditionally Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.
Allowed values:
Head
The product is the the head of the product family.
Member
The product is a variant of the head product.
Conditionally Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. Conditionally Type could be ePID, MementoString as well as ISBN, UPC, EAN, Brand\_MPN. eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). 38 getProductCompatibilities getProductDetails Conditionally Conditionally ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. 13 getProductCompatibilities getProductDetails Conditionally Conditionally eBay Product ID. 12 getProductCompatibilities getProductDetails Conditionally Conditionally European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. 13 getProductCompatibilities getProductDetails Conditionally Conditionally eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) 4000 getProductCompatibilities getProductDetails Conditionally Conditionally This will indicate if the product is disabled for the specific application like selling flow, review flow or half sell flow. Product cannot be used in selling flows on eBay. false No Conditionally Product cannot be used in product review flows. false No Conditionally Product cannot be used in selling flows on half.com. false No Conditionally A property name and corresponding value (a name/value pair). This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. findProducts findProductsByCompatibility getProductCompatibilities No findCompatibilitiesBySpecification compatibilityPropertyFilter No findCompatibilitiesBySpecification specification Yes addProducts Yes Conditionally A value for the property. findProducts findProductsByCompatibility getProductCompatibilities No findCompatibilitiesBySpecification compatibilityPropertyFilter No findCompatibilitiesBySpecification specification Yes addProducts Yes Conditionally This class holds a String value A string value. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No addProducts Conditionally Conditionally This class holds a URL value As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). 400 findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No addProducts Conditionally Conditionally A value can be one of the types: text (string), a number ( For string value type. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No addProducts Conditionally Conditionally For numeric value type. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No addProducts Conditionally Conditionally For URL value type. findCompatibilitiesBySpecification findProducts findProductsByCompatibility getProductCompatibilities No addProducts Conditionally Conditionally 1.5.0 1.4.0 --- # Unknown POST https://api.ebay.com/post-order/v2/inquiry/ { "itemId": "2\*\*\*\*\*\*\*\*\*\*9", "transactionId": "1\*\*\*\*\*\*\*\*\*5" } --- # Unknown Response containing the list of properties The category specified in the request. 10 getCompatibilitySearchNames getProductSearchNames Always This contains all the properties for the specified category, as well as the dataset from which the properties are returned (e.g., DisplayableSearchResults). The properties container also includes the metatdata version associated with the most recent update of the properties. getCompatibilitySearchNames getProductSearchNames Always This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. getCompatibilitySearchValues getProductSearchValues Yes Base request type used by the GetProductSearchValuesRequest type. Specifies the category from which you want to retrieve property values that can be used to search for products.

If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API GetCategories call. 10 getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Yes Constrains the output of values for the given PropertyLiteral (or group of properties) as per given ConstrainingPropertyLiteral:ConstrainingValueLiteral pair (or pairs) according to the respective dependency graph. AND-logic will be applied within the constraint. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No Return properties for a given catalog enabled category. We will throw an error if the category is not catalog enabled. false getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No Sort order for property values in the result set. You can sort by any of the searchable properties, such as Year, Make, or Model. If no sort order is specified then values are sorted in ascending order.

Sorting can be applied only when the response is in list format (i.e., treeFormat in the response is false).

For sorting, characters are compared at each position (i.e., first character, second character, etc.). When values are sorted in ascending order, numbers (0-9) sort before uppercase letters (A-Z), which sort before lowercase letters (a-z). For example, 268 precedes 3, CTS comes before Camry, and 911 comes before A3.

Descending order is the opposite of ascending, with lowercase letters (z-a) before uppercase letters (Z-A) and numbers last (9-0). getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No Version information reflects the last update of the values within the dependency graph. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally This will be populated for the non-fitment enabled category getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally This will be populated for non-fitment enabled category getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally Indicates whether the response is flat or in a hierarchical tree format. false getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Always Sort order input for the result set. Any of the searchable properties can be used for property name and order can be either Ascending or Descending. Output can be sorted by one or more (for bulk calls) property names. You can look up valid values using either the getProductSearchNames call or the getCompatibilitySearchNames call. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No Order of the sort, either Ascending or Descending. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No \[NOT USED BY ANY CALLS\] Orphan type. Sorts results in ascending (low to high) order. Sorts results in descending (high to low) order. This operation will provide the ability to get properties of the application. For example, if the input category is tires, then the response would return the following properties:
  • Make
  • Model
  • Year
  • Trim
  • Engine
Returns all properties within a fitment category of the specified catalog- enabled category. getCompatibilitySearchDataVersion, getCompatibilitySearchValues, getCompatibilitySearchValuesBulk Specifies the category from which you want to retrieve compatibility property names that can be used to search for products. Provide the interface category ID. For example, to get the cars properties, provide tires category ID. The category must be compatibility- enabled.

If a specified category ID doesn't match an existing compatibility- enabled category for the site, eBay returns an error. To determine valid compatibility-enabled categories, use the Trading API GetCategoryFeatures call. 10 getCompatibilitySearchNames Yes This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
DisplayableSearchResults getCompatibilitySearchNames No Response containter for getCompatibilitySearchValuesBulk call. TBD getCompatibilitySearchValuesBulk Always Container for request to retrieve product search values in bulk. Retrieves property values for multiple fields (up to 10). This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. 10 100 getCompatibilitySearchValuesBulk getProductSearchValuesBulk No This will return the metadata version of the name and/or value metadata for the input catalog id. Get the metadata version for the specified category. Specifies the category for which you want to retrieve version information about the product metadata.

If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API GetCategories call. 10 getCompatibilitySearchDataVersion getProductSearchDataVersion Yes Response container for getCompatibilitySearchDataVersion and getProductSearchDataVersion calls. Time and version for the most recent update of catalog property names for the specified category. getCompatibilitySearchDataVersion getProductSearchDataVersion Conditionally Time and version for the most recent update of catalog property values for the specified category. getCompatibilitySearchDataVersion getProductSearchDataVersion Conditionally Details about the current version of the metadata used for searching for compatibilities or products. Version number for the current search metadata (product or compatibility). If you are maintaining search metadata locally, compare this value to the version of the search metadata you last downloaded to determine whether the data may have changed. getCompatibilitySearchDataVersion getProductSearchDataVersion Always Indicates the date and time the current search metadata was updated. getCompatibilitySearchDataVersion getProductSearchDataVersion Always 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. Indicates whether or not errors or warnings were generated during the processing of the request. Always Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. Conditionally The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. Always This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Always There are three categories of error: request errors, application errors, and system errors. Request and application errors are often caused by passing invalid data in the request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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 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, 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. 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. A container for 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 in which the error occurred.
domain values:
Marketplace
A business or validation error occurred in the service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.
Conditionally Name of the subdomain in which the error occurred.
subdomain values:
MarketplaceCatalog
The error is specific to the Marketplace Catalog subdomain.
MarketplaceCommon
The error is common to all Marketplace services.
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, re-send 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused in the error. Conditionally Unique identifier for an exception associated with an error. 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. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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 case, 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. This type holds a numeric value. A number value. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally Unit of measure for a numeric value.
Allowed values:
bps
Bits per second. A unit of data transmission.
kbps
Kilobits per second. A unit of data transmission.
bit
Binary digit. A unit of information storage.
byte
An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.
kb
Kilobit. A unit of information storage equal to 1024 bits.
MB
Megabyte. A unit of information storage equal to one million bytes.
mW
Megawatt. A unit of power equal to one million watts.
W
Watt. The base SI unit of power.
Hz
Hertz. A unit of frequency equal to one cycle per second.
kHz
Kilohertz. A unit of frequency equal to 1,000 cycles per second.
m
Meter. The base unit of distance.
mm
Megameter. A unit of distance equal to one million meters.
rph
Revolutions per hour. A unit of frequency.
hr
Hour. A unit of time equal to 3,600 seconds.
min
Minute. A unit of time equal to 60 seconds.
ms
Microsecond. A unit of time equal to one millionth of a second.
ns
Nanosecond. A unit of time equal to 10-9 seconds.
sec
Seconds. The base unit of time.
g
Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.
lbs
Pounds. The base Imperial unit of mass.
The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally Properties about ... Version information reflects the latest update of the properties or values. getCompatibilitySearchNames getProductSearchNames Conditionally This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. getCompatibilitySearchNames getProductSearchNames Conditionally This will define what are properties that will be returned for this catelog-enabled category.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
getCompatibilitySearchNames getProductSearchNames Conditionally Container for details about an individual compatibility or product property. This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. getCompatibilitySearchNames getProductSearchNames Conditionally Metadata for the property. getCompatibilitySearchNames getProductSearchNames Conditionally This will be the display name of the property getCompatibilitySearchNames getProductSearchNames Conditionally This will contain any metadata about the propert name. A numeric value indicating the ordering position for the property. getCompatibilitySearchNames getProductSearchNames Conditionally Container type for property name value pairs. This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally A value for the property. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally Property name value pairs that are children to other properties. Only returned when the response is returned as a propertyValuesTree. 2 getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally Contains a property name and corresponding value or values. This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally A value for the property. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally This class holds a String value A string value. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally This class holds a URL value As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally Defines the different types of values that a property can have. For string value type. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally For numeric value type. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk Conditionally For URL value type. getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk No getCompatibilitySearchValues getCompatibilitySearchValuesBulk getProductSearchValues getProductSearchValuesBulk 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. The request that triggered the error was processed successfully but with some warnings. Retrieves all available values and their dependencies for a given compatibility property or a group of compatibility properties. These values, along with their respective properties, can be used to search for products . 1.3 This service provides the ability to get product medata. Metadata includes product property names and values. This also provides the ability to get metadata about specific kind of properties like searchable, sortable, displayable etc 1.3.0 1.3.0 --- # Global ID Values - API Reference [![](https://developer.ebay.com/DevZone/assets/eBayDevLogo_sm.gif)](https://go.developer.ebay.com/) eBay Business Policies Management API * [Home](https://go.developer.ebay.com/) * [All Docs](https://go.developer.ebay.com/api-documentation) * [Support](https://go.developer.ebay.com/dev-help-center) * [Knowledge Base](https://go.developer.ebay.com/knowledge-base) * [Forums](https://forums.developer.ebay.com/) * [Resources](https://go.developer.ebay.com/dev-help-center) * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) ![](https://developer.ebay.com/DevZone/assets/magglass.png) Global ID Values ================ The Global ID ([string](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpleTypes.html) ) is a unique identifier for combinations of site, language, and territory. Global ID values are returned in **globalId** and are used as input for the X-EBAY-SOA-GLOBAL-ID header. The global ID you use must correspond to an eBay site with a valid site ID. See [eBay Site ID to Global ID Mapping](https://developer.ebay.com/devzone/business-policies/Concepts/SiteIDToGlobalID.html) for a list of global IDs you can use with the API calls. **Enumeration Values (active sites only)** | Global ID | Language | Territory | Site Name | eBay Site ID | | --- | --- | --- | --- | --- | | EBAY-AT | de-AT | AT | eBay Austria | 16 | | EBAY-AU | en-AU | AU | eBay Australia | 15 | | EBAY-CH | de-CH | CH | eBay Switzerland | 193 | | EBAY-DE | en-DE | DE | eBay Germany | 77 | | EBAY-ENCA | en-CA | CA | eBay Canada (English) | 2 | | EBAY-ES | es-ES | ES | eBay Spain | 186 | | EBAY-FR | fr-FR | FR | eBay France | 71 | | EBAY-FRBE | fr-BE | BE | eBay Belgium (French) | 23 | | EBAY-FRCA | fr-CA | CA | eBay Canada (French) | 210 | | EBAY-GB | en-GB | GB | eBay UK | 3 | | EBAY-HK | zh-Hant | HK | eBay Hong Kong | 201 | | EBAY-IE | en-IE | IE | eBay Ireland | 205 | | EBAY-IN | en-IN | IN | eBay India | 203 | | EBAY-IT | it-IT | IT | eBay Italy | 101 | | EBAY-MOTOR | en-US | US | eBay Motors | 100 | | EBAY-MY | en-MY | MY | eBay Malaysia | 207 | | EBAY-NL | nl-NL | NL | eBay Netherlands | 146 | | EBAY-NLBE | nl-BE | BE | eBay Belgium (Dutch) | 123 | | EBAY-PH | en-PH | PH | eBay Philippines | 211 | | EBAY-PL | pl-PL | PL | eBay Poland | 212 | | EBAY-SG | en-SG | SG | eBay Singapore | 216 | | EBAY-US | en-US | US | eBay United States | 0 | Copyright © 2009–2022 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement. --- # Unknown A token representing the application-level acknowledgement code that indicates the response status. Always 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. 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. The request that triggered the error was processed successfully but with one or more warnings. 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. This is the base class for the request container for all service operations. This is the base class for the response container for all service operations. Returns error information associated with the request. A token representing the application-level acknowledgement code that indicates the response status, such as "Success". The AckValue enumeration type specifies the possible values for ack. Always Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success. Conditionally The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. 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). See Time Values in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Always Reserved for future use. Returned errors are categorized as either Application, Request, or System errors. Request and application errors are often caused by passing invalid data in the call request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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. 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. 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. A container for 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 in which the error occurred. Conditionally Name of the subdomain in which the error occurred. 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused the error. Conditionally Unique identifier for an exception associated with an error. 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. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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 Return, 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. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. This call is used to return the current version of Return Management Service. This call can be used to monitor the service for availability. This call has no input parameters and the response contains only the standard output fields. Returns the current version of Return Management Service. Response container for the getVersion API call. Type defining the getUserReturns request. This call is used by a seller or buyer to retrieve returns in which the eBay member is involved. This call can retrieve all returns, or filtering criteria can be used. This call can be used by a seller or buyer to retrieve returns in which the eBay member is involved. This call can retrieve all returns created within the last 30 days, or filtering criteria can be used. getReturnDetail ResoCase http://developer.ebay.com/Devzone/resolution-case-management/CallRef getUserCases Retrieves all eBay Buyer Protection cases and older disputes filed against the eBay member. Container used to retrieve all returns related to a specific eBay listing, or to retrieve a return related to a specific order line item. Boolean OR logic is used if an eBay Item ID and Transaction ID are both specified.

If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No A unique identifier of an eBay order. This field will accept an eBay-generated OrderID value or an OrderLineItemID value, which is a concatenation of ItemID and TransactionID with a hyphen separating these two IDs.

If an orderId value is specified, any return filed against this order is retrieved. It is possible that multiple returns can be retrieved if the order has multiple line items, and the buyer filed a return against more than one of these order line items. getUserReturns No Container used to restrict results to returns created within a specified date range. The specified date range is inclusive. The maximum date range that can be specified with this filter is 90 days. Returns with creation dates dating back more than 18 months cannot be retrieved. To retrieve returns for a period longer than 90 days, multiple getUserReturns calls must be made using this filter and specifying different date ranges in each subsequent call.

If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No Container consisting of one or more ReturnStatus filters. If one or more ReturnStatus filters are used, results are restricted to returns in the specified states. If return status filtering is not used, returns in all states are retrieved. The ReturnStatusFilter container uses Boolean OR logic, which means that all returns matching the specified states are retrieved.

If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No Container used to retrieve all returns related to a specific eBay member, who is identified by role and either by user ID or login name or both. This other user must be on the other side of one or more returns from the calling user.

If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No Container used to control the pagination of the result set, including the number of returns to retrieve per page and the page number you want to retrieve in the output. Pagination is typically used when the result set is expected to be large. The caller can then use subsequent getUserReturns calls to retrieve results page by page by incrementing the pageNumber value in the request each time. The caller will know the total number of pages that need to be retrieved by looking at the paginationOutput.totalPages value in the response.

If the paginationInput container is not used, all returns matching the filter criteria are retrieved and displayed on one "page" of the response. getUserReturns No This field is used to sort returns in the response based on either return filing date, estimated refund amount, refund due date, or buyer login name. If this field is not used, returns are sorted by filing date. FilingDate getUserReturns No This field is used to sort returns in the response in descending or ascending order. So, if FilingDate is the sortType being used, and sortOrderType is set to Descending, returns are sorted in the response from the most recent filing date to the oldest filing date. Descending is the default value, so here is how the results will appear for each sortType:
  • BuyerLoginName: Results are sorted based on name from Z to A
  • EstimatedAmount: Results are sorted based on dollar amount from highest to lowest value
  • FilingDate: Results are sorted based on filing date from most recent to oldest
  • RefundDueDate: Results are sorted based on the date a refund is due to the seller from a date further in the future to a date less further in the future
Descending getUserReturns No Type defining the response container for the getUserReturns call. High-level information is shown for each return that is retrieved. Container consisting of high-level information for each return matching the input criteria. This information includes the creation and modification dates for the return, the reason for the return, item information, response date, and the current status of the return. getUserReturns Always Pagination container consisting of fields that indicate the total number of pages and returns that match the input criteria, the number of returns per page, and the current page number being viewed. The paginationOutput container is always returned even if pagination values are not specified in the request. getUserReturns Always Type defining the otherUserFilter container, which is a filter used in getUserReturns to restrict results to returns involving a specific buyer or seller. getUserReturns No The eBay user ID for the other party involved in the return. Either a userId or a userLoginName value must be specified in the otherUserFilter container. getUserReturns Conditionally The eBay user login name for the other party involved in the return. Either a userId or a userLoginName value must be specified in the otherUserFilter container. getUserReturns Conditionally The role (such as buyer or seller) of the other party involved in the return. This field is required if the otherUserFilter container is used. getUserReturns Conditionally Enumerated type that contains the valid values to use in the otherUserFilter.role field if a user filter is used in a getUserReturns request. This value is specified in the otherUserFilter.role field to retrieve returns where the other user's role is buyer. This value is specified in the otherUserFilter.role field to retrieve returns where the other user's role is seller. This value is specified in the otherUserFilter.role field to retrieve returns where the other user's role is buyer or seller. Type defining the unique identifier for a return. This string value is the unique identifier for a return, and is returned in the responses of getUserReturns and getReturnDetail. For getReturnDetail, getActivityOptions, issueRefund, provideSellerInfo, provideTrackingInfo, and setItemAsReceived, a ReturnId value is a required input field. 38 getReturnDetail getActivityOptions issueRefund provideSellerInfo Yes getReturnDetail getUserReturns Always Enumerated type that contains the valid values to use in the sortType field. This field is used to sort returns in the response based on either return filing date, estimated refund amount, refund due date, or buyer login name. If this field is not used, returns are sorted by filing date. If this value is specified, returns are sorted based on the filing date of the return. If sortOrder is set to Descending, the most recent returns will appear first in the results set. If sortOrder is set to Ascending, the oldest returns will appear first in the results set. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. If this value is specified, returns are sorted based on the estimated amount of the return. If sortOrder is set to Descending, the highest value returns will appear first in the results set. If sortOrder is set to Ascending, the lowest value returns will appear first in the results set. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. If this value is specified, returns are sorted alphabetically based on the buyer's eBay login name. If sortOrder is set to Ascending, returns are sorted in alphabetical order according to eBay login name. If sortOrder is set to Descending, returns are sorted in reverse alphabetical order according to eBay login name. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. If this value is specified, returns are sorted based on the refund due date. If sortOrder is set to Descending, returns with refund due dates the furthest in the future will appear first in the results set. If sortOrder is set to Ascending, returns with refund due dates the nearest in the future will appear first in the results set. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. Enumerated type that contains the possible values that can be returned in the deliveryStatus field of the provideTrackingInfo response. This value will indicate the status of the package shipment. This value indicates that the package has been delivered. This value indicates that the package is in transit. This value indicates that the shipping status of the package is unknown. This type defines the getReturnDetails request. This call requires the caller to pass in an Authentication Token as described in Getting Tokens tutorial. This call can be used by a seller or buyer to retrieve detailed information about a specific return in which they are involved. Container consisting of the unique identifier for a return. A return ID value is the only input parameter for getReturnDetail, and is required. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 getReturnDetail Yes Type defining the getReturnDetail response. Container consisting of high-level information for the return matching the return ID specified in the request. This information includes the creation and modification dates for the return, the estimated refund amount, the reason for the return, item information, response date, and the current status of the return. getReturnDetail Always Container consisting of detailed, dynamic information for the return matching the return ID specified in the request. This information includes the return status, return activity log, returned item status, return shipping information (including an RMA if applicable), refund details, and eBay Buyer Protection case information (if applicable). getReturnDetail Always Type defining the getActivityOptions request. This call is used by a seller to retrieve one or more actions that can be performed based on the status of the return. This call is used by a seller to retrieve one or more actions that can be performed based on the status of the return. Container consisting of the unique identifier for a return. A return ID value is the only input parameter for getActivityOptions, and is required. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 getActivityOptions Yes Type defining the getActivityOptions response. The seller's possible next step(s) is returned in activityOptions field. Consumers of this service can map the activity to the corresponding Return Management API call. The returned value indicates the next possible action that a seller can take to resolve a return. If ISSUE\_REFUND is returned, the next logical step would be to call issueRefund. If PROVIDE\_SELLER\_INFO is returned, the next logical step would be to call provideSellerInfo. The value that is returned is dependent on the status of the return. getActivityOptions Always Type defining the issueRefund request. This call is used by a seller to issue a refund (PayPal only) to the buyer to resolve a return. The refund operation may involve one or more of the following: purchase price refund, original shipping refund, and/or a restocking fee charge. This call is used by a seller to issue a refund (PayPal only) to the buyer. Container consisting of the unique identifier for a return. A return ID value is required and the seller should take all precautions to make sure this value is correct before making the call. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 issueRefund Yes Container consisting of details related to the type and amount of the refund to the buyer. issueRefund Yes In this optional field, the seller can include a message to the buyer regarding the refund. issueRefund No Type defining the issueRefund response. The only call-specific output field of issueRefund is RefundStatus. The returned value indicates the result of the attempted refund. The three possible values are 'SUCCESS', 'FAILED', or 'PENDING'. issueRefund Always Type defining the provideSellerInfo request. This call is used by a seller to provide a Return Merchandise Authorization number and/or a return shipping address to the buyer. This call is used by a seller to provide a Return Merchandise Authorization number and/or an alternative return shipping address. Container consisting of the unique identifier for a return. A return ID value is required and the seller should take all precautions to make sure this value and the Return Merchandise Authorization number match before making the call. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 provideSellerInfo Yes The Return Merchandise Authorization number associated with the item to be returned. An RMA number is a unique identifier that is provided by a manufacturer and authorizes the return of an item. 15 provideSellerInfo Conditionally This optional container allows the seller to provide an alternative return shipping address to the buyer. If not provided, the seller's primary return address on record is used as the return address. provideSellerInfo No Type defining the provideSellerInfo response. There are no call-specific fields in the provideSellerInfo response. The caller should look for an ack value of 'Success' to determine the success of the call. Type defining the provideTrackingInfo request. This call is used to provide shipment tracking information. This action can be performed based on the status of the return case. This call is used to provide a shipping tracking number and shipping carrier. Container consisting of the unique identifier for a return case. A return ID value is required and the seller should take all precautions to make sure this value and the shipping tracking number match before making the call. Return IDs are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 provideTrackingInfo Yes The tracking number assigned by the shipping carrier to the item shipment. This value should be passed in without hyphens or spaces. The seller is responsible for the accuracy of this value, as eBay can only validate that the format is consistent with the format that is used by the specified shipping carrier. provideTrackingInfo Yes The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or 'USPS'. provideTrackingInfo Yes This field is optional and can be used to provide additional information about the shipment and/or the status of the return. provideTrackingInfo No Type defining the provideTrackingInfo response. The caller should look for an ack value of 'Success' to determine the success of the call. This field indicates the status of the shipment identified by the tracking number in the request. provideTrackingInfo Always Type defining the setItemAsReceived request. This call is used by a buyer or seller to mark an order line item as received. This action can be performed based on the status of the return. This call is used by a buyer or seller to mark an order line item as received. Container consisting of the unique identifier for a return. The ReturnId.id value is required and will indicate the eBay-Managed return that is being marked as received. Return IDs are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 setItemAsReceived Yes Type defining the setItemAsReceived response. There are no call-specific fields in the setItemAsReceived response. The caller should look for an ack value of 'Success' to determine the success of the call. Type defining the getReturnMetadata request. This call is used by a seller to get a list of possible return reasons, the refund due date, the RMA due date, or all three pieces of information. This call is used by a seller to get a list of possible return reasons, the refund due date, the RMA due date, or all three pieces of information. This optional, repeatable filter allows the seller to control which return metadata is retrieved in the response. If no filter is used, all return metadata is retrieved in the response. getReturnMetadata No Type defining the getReturnMetadata response. Container consisting of a return metadata type and value. The return metadata that is retrieved is dependent on the metadataEntryCode value(s) that are passed in the request. If no metadataEntryCode value(s) are passed in the request, all return metadata is retrieved. getReturnMetadata Always Type defining the itemFilter container in the getUserReturns request. This container is used to retrieve all returns related to a specific eBay listing or to a specific order line item. The unique identifier for an eBay listing. If specified, all returns filed against any of this listing's order line items are retrieved.

An itemId value is required if the itemFilter container is used. If a transactionId value is used to identify a specific eBay order line item, that transactionId value must be associated with the itemId value or an error occurs. 19 getUserReturns Conditionally The unique identifier for an eBay order line item. If a transactionId value is specified, any return filed against this order line item is retrieved. The transactionId value must be associated with the itemId value or an error occurs. 19 getUserReturns No Type defining the dateRangeFilter container in the getUserReturns request. This container is used to restrict results to returns created within a specified date range. The starting date for the date range. The fromDate must be older than the toDate, and it cannot be set back more than 18 months in the past. This field is required if the dateRangeFilter container is used.

If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns Conditionally The ending date for the date range. The toDate must be more recent than the fromDate. This field is optional. If it is omitted, all returns created from the fromDate up to the present (system date) are returned, unless the range specified by the fromDate and the present date is greater than 90 days, in which case the toDate defaults to 90 days forward from the fromDate. getUserReturns No Type defining the ReturnStatusFilter container. This container is used to retrieve returns in specific states. If one or more ReturnStatus filters are used, results are restricted to returns in the specified states. If return status filtering is not used, returns in all states are retrieved. The ReturnStatusFilter container uses Boolean OR logic, which means that all returns matching the specified states are retrieved. To retrieve returns in a specific state (such as open, closed, item shipped, etc.), pass in a ReturnStatusInputType value. At least one ReturnStatus field is required if the ReturnStatusFilter container is used, and multiple ReturnStatus values are allowed. getUserReturns Conditionally Type defining the metadataCodeValues container that is returned in the getReturnMetadata response. The metadataCodeValues container consists of either a REFUND\_DUE\_UPON\_ITEM\_ARRIVAL, a RMA\_DUE\_UPON\_RETURN\_START, or a RETURN\_REASONS value. The metadata that is returned is dependent on the metadataEntryCode value(s) that are passed in the request. Either RETURN\_REASONS, REFUND\_DUE\_UPON\_ITEM\_ARRIVAL, or RMA\_DUE\_UPON\_RETURN\_START is returned in this field, based on the use (or omittance) of the metadataEntryCode field of the getReturnMetadata request. getReturnMetadata Always The string (token) value that appears here is associated with the codeName value.

For RETURN\_REASONS, values include CHANGED\_MY\_MIND, ARRIVED\_DAMAGED, and NOT\_AS\_DESCRIBED. These values are dependent on the return reason the buyer selects when the return is opened.

For REFUND\_DUE\_UPON\_ITEM\_ARRIVAL, the value indicates the maximum number of business days a seller has to issue a refund to the buyer after the seller receives the returned item.

For RMA\_DUE\_UPON\_RETURN\_START, the value indicates the maximum number of business days a seller has to provide a Return Merchandise Authorization number (if an RMA is requested) to the buyer once a return is opened. getReturnMetadata Always Enumerated type that defines the possible values that can be passed into the metadataEntryType field of the getReturnMetadata request. If this value is passed in, only information related to specific metadata is returned in the getReturnMetadata response. If this value is passed in, all metadata information is returned in the getReturnMetadata response. ALL is the default value if the metadataEntryType field is not used in the getReturnMetadata request. Enumerated type that defines the metadata values used by the getReturnMetadata call. In the getReturnMetadata request, these values are passed into the metadataEntryCode field, and in the getReturnMetadata response, these values are returned in the metadataCodeValues.codeName field. This value is passed into the metadataEntryCode field of the getReturnMetadata request to retrieve the maximum number of business days a seller has to issue a refund to the buyer upon receiving the returned item. The number of days can be found in the metadataCodeValues.value field of the getReturnMetadata response. A refund can be issued to the buyer through the issueRefund call. This value is passed into the metadataEntryCode field of the getReturnMetadata request to retrieve the maximum number of business days after the return filing date that a seller has to provide an Return Merchandise Authorization number (if requested) to the buyer. The number of days can be found in the metadataCodeValues.value field of the getReturnMetadata response. An RMA can be provided to the buyer through the provideSellerInfo call. This value is passed into the metadataEntryCode field of the getReturnMetadata request to retrieve the reason the buyer is returning the item. The return reasons are found in the metadataCodeValues.value field of the getReturnMetadata response. Enumerated type that defines the return status values that can be passed into the ReturnStatusFilter container and used as filters for the getUserReturns call. CLOSED, ITEM\_SHIPPED, MY\_RESPONSE\_DUE, OTHER\_PARTY\_RESPONSE\_DUE, RETURN\_STARTED This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all open returns. If RETURN\_STARTED is used as a filter, returns in the following states (these values are indicated in the Returns.ReturnSummary.status field) are returned:
  • MY\_PAYMENT\_DUE
  • MY\_RESPONSE\_DUE
  • OTHER\_PARTY\_CONTACTED\_CS\_AWAITING\_RESPONSE
  • OTHER\_PARTY\_RESPONSE\_DUE
  • PAID
  • WAITING\_DELIVERY
  • YOU\_CONTACTED\_CS\_AWAITING\_RESPONSE
This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all closed returns. If CLOSED is used as a filter, returns in the following states (these values are indicated in the Returns.ReturnSummary.status field) are returned:
  • CLOSED
  • CS\_CLOSED
  • EXPIRED
  • YOU\_CONTACTED\_CS\_ABOUT\_CLOSED\_Return
This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all returns with the status of WAITING\_DELIVERY. Return status values are indicated in the Returns.ReturnSummary.status field. This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all returns in which the seller's response is due. The two applicable return status values returned in the Returns.ReturnSummary.status field are MY\_PAYMENT\_DUE and MY\_RESPONSE\_DUE. The MY\_PAYMENT\_DUE value indicates that the seller is expected to issue a refund to the buyer. The MY\_RESPONSE\_DUE value can indicate that the seller must provide an RMA number to the buyer, or the seller must contact eBay customer support. This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all returns in which the other party's response is due. The only applicable return status value returned in Returns.ReturnSummary.status field is OTHER\_PARTY\_RESPONSE\_DUE. Enumerated type that determines whether returns in the getUserReturns response are displayed in ascending or descending order. This value is passed into the sortOrderType field of the getUserReturns call to display all retrieved returns in ascending order. See the ReturnSortType documentation to get an idea about how Ascending affects the four different sort types. This value is passed into the sortOrderType field of the getUserReturns call to display all retrieved returns in descending order. See the ReturnSortType documentation to get an idea about how Descending affects the four different sort types. Descending is the default value and will be used if the sortOrderType field is not included in the getUserReturns request. Type defining the Returns container in the getUserReturns response. The Returns container is a root container that consists of one or more returns. A ReturnsSummary node is returned for each return that is retrieved. Container consisting of high-level information for a return. A ReturnSummary containerg is returned in the getUserReturns request for each return matching the input criteria. This information includes the creation and modification dates for the return, the estimated refund amount, the reason for the return, item information, response date, and the current status of the return. getUserReturns Always Type defining the responseDue container returned in the requests of the getUserReturns and getReturnDetail calls. The responseDue container is only returned if a response is due from the seller or other party involved in the return. Container that identifies the party whose response is due. The party is identified by eBay user ID and role (BUYER or SELLER). getUserReturns getReturnDetail Conditionally This date indicates the due date of the party's response. getUserReturns getReturnDetail Conditionally Type defining the ReturnSummary container. A ReturnSummary container is returned in the requests for the getUserReturns and getReturnDetail calls for each return matching the input criteria. Container consisting of the unique identifier for a return. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns and getReturnDetail calls. getUserReturns getReturnDetail Always This field indicates the return type. Through the Return Center, the buyer selects whether he/she wants to be refunded for the purchase or wants a replacement item. getUserReturns getReturnDetail Always Container that identifies the other party involved in the return. The party is identified by eBay user ID and role (BUYER or SELLER). getUserReturns getReturnDetail Always Container consisting of details on the item being returned and the return reason. getUserReturns getReturnDetail Always This field indicates the current status of the return. This value will often give the seller a good idea about the next step to take in the return. getUserReturns getReturnDetail Always This container consists of the party whose response is due and the due date of that response. This container is only returned in the requests of the getUserReturns and getReturnDetail calls if a response is due from the seller or other party involved in the return. getUserReturns getReturnDetail Conditionally This date indicates the date on which the return was created. getUserReturns getReturnDetail Always This date indicates the date on which the return was last modified. getUserReturns getReturnDetail Always Type used by the ReturnSummary.user and ReturnSummary.otherParty containers in the getUserReturns and getReturnDetail calls to identify a user involved in a return. getUserReturns getReturnDetail Always The eBay user ID for the party involved in the return. getUserReturns getReturnDetail Always The role (such as buyer or seller) of the party involved in the return. getUserReturns getReturnDetail Always Enumerated type that defines the return types that are possible. Through the Return Center, the buyer selects whether he/she wants to be refunded for the purchase or wants a replacement item. This value indicates that the buyer is returning/has returned the item for a refund. This value indicates that the buyer is requesting/has received a replacement item for the original item. This value is only returned if client/user is running a version of the Return Management API that is out-of-date, and does not contain the latest values of ReturnType. Enumerated type that defines the user roles in a return. This value indicates that the user's role in the return is buyer. This value indicates that the user's role in the return is seller. This value indicates that the user's role in the return is eBay. This value indicates that the user's role in the return is system. This value is reserved for future use. Enumerated type that defines all possible shipment states relating to the buyer returning an item to the seller. The status of a buyer's return shipment is shown in the ReturnDetail.buyerReturnShipment.shipmentStatus field of the getReturnDetail response. This value indicates that the buyer is waiting for an Return Merchandise Authorization (RMA) number and/or an alternative return shipping address before returning the item to the seller. A seller can provide a buyer with this information by using the provideSellerInfo call. This value indicates that the item is ready to be return shipped by the buyer. This value indicates that the item has been shipped by the buyer. This value indicates that the returned item has been received by the seller. This value is reserved for future use. Enumerated type that indicates whether or not a seller's refund to a buyer using the issueRefund call was successful. This type is used by the RefundStatus field of the issueRefund request. This value indicates that the seller's refund to the buyer was successful. This value indicates that the seller's refund to the buyer failed. Enumerated type that indicates the current status of a seller's refund to a buyer. This value indicates that the seller's refund to the buyer was successful. This value indicates that the seller's refund to the buyer is pending. This value is commonly returned if the payment method was eCheck. This value indicates that the seller's refund to the buyer failed. This type defines the buyer's reason for returning an item, and is used by the ReturnSummary.returnRequest.returnReason field in the response of the getUserReturns and getReturnDetail calls. The returnReason is always returned. Enumerated type that defines the reasons why a return is closed. These values are returned in getReturnDetail for closed returns. This value indicates that the seller has refunded the buyer and the return has been closed. This value indicates that the return expiration date has been reached, so the return has been closed. This value indicates that customer service has closed the return. This value indicates that the return has been closed due to the buyer opening up an eBay Buyer Protection case against the item. This value is reserved for future use. Type defining the returnItem container that is returned in the getUserReturns and getReturnDetail calls. The returnItem container consists of the eBay Item ID, the Transaction ID, and quantity of the item being returned to the seller. The unique identifier for an eBay listing. 19 getUserReturns getReturnDetail Always The unique identifier for an eBay order line item. getUserReturns getReturnDetail Always This value indicates the quantity of items to be returned. This value is usually '1' unless multiple identical items were purchased by the buyer. 1 getUserReturns getReturnDetail Always Monetary amount. This type is used in several locations in the getUserReturns, getReturnDetails, and issueRefund responses. This attribute identifies the currency in which the monetary amount is specified. Type defining the totalRefundAmount container. This container contains the estimated and actual refund amounts. This field contains the estimated refund amount for the return. The estimated refund amount is based on the subtotal value of the order line item. getUserReturns getReturnDetail Always This field contains the actual refund amount for the return. This value reads '0.0' until a refund is actually issued by the seller to the buyer. getUserReturns getReturnDetail Always Type defining the returnRequest container that is returned in the getUserReturns and getReturnDetail calls. The returnRequest container consists of the return reason, the eBay item and transaction IDs, and the item quantity. Container consisting of the eBay Item ID, the Transaction ID, and quantity of the item being returned to the seller. The returnItem container is returned in the getUserReturns and getReturnDetail calls. getUserReturns getReturnDetail Always This value indicates the buyer's reason for returning an item. Possible values include I\_DONT\_WANT\_IT (buyer remorse) and SNAD (item Significantly Not As Described). getUserReturns getReturnDetail Always This field contains any comments posted by the buyer upon opening the return. For a SNAD case, the buyer might state the discrepancies between the actual item received and the item described in the listing. getUserReturns getReturnDetail Conditionally Type defining the ReturnDetail container returned in getReturnDetail. All information for a single return is returned under the ReturnDetail container. Unique identifier of the eBay site (such as 'EBAY-US') where the order occurred. getReturnDetail Always Repeatable container consisting of details related to each activity in a return. A returnHistory node is returned for each activity that has occurred with the return, and each node contains the type of activity, the timestamp for the activity, the initiator of the activity, and any notes related to the return. Additionally, if the activity is related to a money movement transaction, a ReturnDetail.returnHistory.attributes container is returned providing more information on the transaction. getReturnDetail Always Container consisting of details and values related to estimated, actual, and itemized refunds to the buyer. getReturnDetail Always Container consisting of flags which indicate whether the seller is willing to provide the buyer a Return Merchandise Authorization number (if requested), and if the seller accepts returns to more than one address. These return policy preferences are set by the seller in the Return Center. This container will only be returned if at least one of the flags is turned on. getReturnDetail Conditionally This field is deprecated. Please see the shipmentInfo container to obtain both seller and buyer shipping information. 1.0.0 01-14-2013 NotReturned shipmentInfo 1.0.0 getReturnDetail Conditionally Container consisting of details related to the buyer and/or seller shipments. Information in the shipmentInfo container includes the destination shipping address on record, the expected delivery date, the shipping carrier used, the tracking number, and the delivery status. getReturnDetail Conditionally Container consisting of the eBay Buyer Protection case ID and case type. This container is only returned if a return is escalated to the eBay Buyer Protection system and accepted as an eBP case. getReturnDetail Conditionally Type defining the caseId container, which consists of a case ID and case type that uniquely identifies an eBay Buyer Protection case. Unique identifier of an eBay Buyer Protection case. 38 getReturnDetail Conditionally This value indicates the type of eBay Buyer Protection case. For an escalated return case, the value will most likely be EBP\_SNAD (item Significantly Not As Described). getReturnDetail Conditionally Enumerated type that defines the eBay Buyer Protection case types. This value indicates that the eBay Buyer Protection case involves a "significantly not as described" item. This value is reserved for future use. Enumerated type that defines the types of itemized refunds. This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases). This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases). This is the only RefundFeeType value that will be a negative dollar value, as a restocking fee is a charge against the buyer for returning the item. In order to enforce a restocking fee on an item, the seller must include a restocking fee value as part of the listing's return policy. In the listing APIs, this field is Item.ReturnPolicy.RestockingFeeValue. This value is reserved for future use. Type defining the refundInfo container, which consists of details and values related to estimated, actual, and itemized refunds to the buyer. This field indicates the refund due date, and will only appear if a refund to the buyer has not been issued by the seller. getReturnDetail Conditionally Container consisting of the estimated amount of a seller's refund to the buyer. The estimatedRefundDetail container will contain one itemizedRefund container for each refund fee type due to the buyer (such as purchase price or original shipping). Similarly, if the seller elects to issue additional refund(s) beyond what is required, one itemizedOptionalRefund container will be present for each optional refund issued to the buyer. getReturnDetail Always Container consisting of the actual amount of a seller's refund to the buyer. The actualRefundDetail container will contain one itemizedRefund container for each refund fee type issued to the buyer (such as purchase price or original shipping). Similarly, one itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer. getReturnDetail Conditionally Type defining the returnPolicy container, which consists of a flag to indicate whether the seller is willing to provide the buyer a Return Merchandise Authorization number (if requested), and a flag to indicate if the seller accepts returns to more than one address. This field indicates that the seller has agreed to provide a Return Merchandise Authorization (RMA) number to buyers upon request. A seller can provide an RMA to the buyer by using the returnMerchandiseAuthorization field of the provideSellerInfo call. A seller will use the provideSellerInfo call to provide an RMA to the buyer when the status of the return is 'WAITING\_FOR\_SELLER\_INFO'. This field is only returned if 'true'. getReturnDetail Conditionally This field indicates that the seller has agreed to accept returns at multiple return addresses. A seller can provide an alternative return address to the buyer by using the returnAddress container of the provideSellerInfo call. A seller will use the provideSellerInfo call to provide an alternative return address to the buyer when the status of the return is 'WAITING\_FOR\_SELLER\_INFO'. This field is only returned if 'true'. If the seller has not agreed to accept returns at multiple return addresses, the seller's primary return address in My eBay is used. getReturnDetail Conditionally Type defining the refundDetail container, which is the root container of all details related to actual and estimated refunds. This dollar value indicates the total amount of actual refunds issued by the seller to the buyer. This is a dynamic value while the return is open. The refundDetail.totalAmount value is required in the issueRefund call and it should match the refundDetail.itemizedRefundAmount value (if only one refund type is being issued by the seller) or the composite value of multiple refundDetail.itemizedRefundAmount values (if multiple refund types are being issued by the seller). getReturnDetail Conditionally issueRefund Yes Container used to track estimated and actual individual refund amounts by fee type (such as purchase price, original shipping, or restocking fee). At least one itemizedRefund container is required when the seller is issuing a refund to the buyer through the issueRefund call. getReturnDetail Always issueRefund Yes Type defining the actualRefundDetail container, which consists of details related to an actual seller refund, including the total refund amount, the date of the refund, the status of the refund, and an itemized list of one or more refund fee types (such as purchase price or original shipping). Container consisting of the total refund amount awarded to the buyer and one or more itemizedRefund containers. One itemizedRefund container will be present for each refund fee type (such as purchase price or original shipping). This container is only returned if a refund has been issued by the seller. getReturnDetail Conditionally This value indicates the result of the seller's refund attempt. The two valid values are SUCCESS or FAILED. PENDING is for future use. getReturnDetail Conditionally This date indicates the date of the seller's refund to the buyer. This field is only returned if a refund has been issued by the seller. getReturnDetail Conditionally Type defining the estimatedRefundDetail container, which consists of details related to an estimated seller refund, including the total refund amount, an itemized list of one or more anticipated refund fee types (such as purchase price or original shipping), and an itemized list of one or more optional refund fee types. Container consisting of the total estimated refund amount due to the buyer and one or more itemizedRefund containers. One itemizedRefund container will be present for each refund fee type (such as purchase price or original shipping). getReturnDetail Always One itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer. getReturnDetail Conditionally Type defining the itemizedRefund container. One itemizedRefund container appears under an estimatedRefundDetail or an actualRefundDetail container per refund fee type. The idea behind the itemizedRefund container is to track estimated and actual individual refund amounts by fee type (such as purchase price, original shipping, or restocking fee). This value indicates the type of refund fee, such as purchase price or original shipping. getReturnDetail Conditionally issueRefund Yes This dollar amount indicates the amount of the corresponding refund fee type. getReturnDetail Conditionally issueRefund Yes Type defining the returnHistory container, which consists of details related to each activity in a return. A returnHistory node is returned for each activity that has occurred with the return. This field is returned if the party initiating the action included a note. The text in this field will mirror any text input into the text box in the Return Management Center. getReturnDetail Conditionally Container that identifies the initiator of the action by eBay user ID and role in the return. getReturnDetail Always This container consists of the enumeration ID value and description of the return activity. Note that the content element of this container is reserved for future use. getReturnDetail Conditionally The timestamp of the return activity. getReturnDetail Always Type defining the buyerReturnShipment container, which consists of details related to the buyer's return shipment to the seller. Information in the buyerReturnShipment container include the seller's primary return address on record, the expected delivery date, the shipping carrier and tracking number, the delivery status, and the shipping costs. This value indicates the current shipping status of the item. getReturnDetail Conditionally This value is the tracking number used by the shipping carrier. getReturnDetail Conditionally This value is the name of the shipping carrier. getReturnDetail Conditionally This value indicates the actual date of delivery for the returned item. This field is only returned after the seller has received the returned item from the buyer. getReturnDetail Conditionally This dollar value indicates the total shipping costs incurred by the buyer to ship the returned item. getReturnDetail Conditionally This container consists of the seller's primary return address in My eBay, or the return address provided by the seller through the provideSellerInfo call. getReturnDetail Conditionally This value is the Return Merchandize Authorization (RMA) number associated with the item. The RMA number for an item is expected to be provided by the seller to the buyer upon request. This field is only returned if the buyer requests an RMA number and it is provided by the seller. getReturnDetail Conditionally This date is the earliest date that the seller can expect to receive a returned item from the buyer. getReturnDetail Conditionally This date is the latest date that the seller can expect to receive a returned item from the buyer. getReturnDetail Conditionally This type defines the return shipping address of the seller, and it is used by the returnAddress container of the provideSellerInfo request and by the shippingAddress container of the getReturnDetail response. The name on record for the seller's shipping address. getReturnDetail Conditionally provideSellerInfo No The street address on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The second line of the street address on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call. getReturnDetail Conditionally provideSellerInfo No The city on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The county on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call. getReturnDetail Conditionally provideSellerInfo No The state or province on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The country on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The postal code on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No Type defining the paginationInput container, which is used to control the pagination of the result set, including the number of returns to return per page and the page number you want to return in the output. This integer value is used to specify the "page" of data to return in the call response. The total number of result pages is determined by the total number of returns (returned in paginationOutput.totalEntries) matching the request criteria divided by the number of returns to display per page of data (specified in entriesPerPage). This value defaults to '1' if not specified. If there are multiple pages of returns (see paginationOutput.totalPages) to view, multiple getUserReturns calls can be made to view all returns, and the pageNumber value can be incremented by 1 in each subsequent call. 1 100 1 getUserReturns No This integer value is used to specify the maximum number of returns to display in a single "page" of data. This value, along with the number of returns that match the input criteria, will determine the total pages (see paginationOutput.totalPages) in the result set. This value defaults to '200' (the maximum allowed value) if not specified. 1 200 200 getUserReturns No Type defining the paginationOutput container, which consists of fields that indicate the total number of pages and returns that match the input criteria, the number of returns per page, and the current page number being viewed. This integer value indicate the "page" number of the results set. The total number of result pages is determined by the total number of returns (returned in paginationOutput.totalEntries) matching the request criteria divided by the number of returns to display per page of data (indicated in paginationOutput.entriesPerPage). If there are multiple pages of returns (see paginationOutput.totalPages) to view, multiple getUserReturns calls can be made to view all returns, and the paginationInput.pageNumber value can be incremented by 1 in each subsequent call. 1 200 1 getUserReturns Always This integer value indicates the maximum number of returns to return in a single "page" of data. This value, along with the number of returns that match the input criteria, determines the total pages (see paginationOutput.totalPages) in the result set. 1 100 1 getUserReturns Always This value indicates the total number of result pages that exist based on the current input criteria, including the paginationInput fields. If totalPages is more than 1, multiple getUserReturns calls must be made to view all result pages, with the paginationInput.pageNumber value being incremented by 1 in each subsequent call. getUserReturns Always This value indicates the total number of returns that exist based on the current input criteria. Once this value is known, the caller may want to considering tweaking the paginationInput fields in the getUserReturns request and making another call. getUserReturns Always Parent type of the ActivityDetailType and ReturnReasonType enumeration types. Unique identifier of the enumeration value. getReturnDetail getUserReturns Always A description of the enumeration value. getReturnDetail Always Reserved for future use. getReturnDetail Always Parent type for the ProvideSellerInfoOptionType and IssueRefundOptionType types returned in the getActivityOptions response. This field indicates the action that the buyer is seeking from the seller. This field is only returned for the activity option if it is 'true'.

Only one activity option returned to a seller in the getActivityOptions response can be the buyer's preference. In other words, the buyerPreference field can only be 'true' for one activity option returned to the seller in the response. Typically, the buyerPreference field is returned 'true' for the IssueRefundOptionType field, but if the buyer is requesting an RMA number, the buyerPreference field is returned 'true' for the ProvideSellerInfoOptionType field instead. getActivityOptions Conditionally Type defining the ISSUE\_REFUND activity option. If the ISSUE\_REFUND activity option is returned in the getActivityOptions response, the seller can use the issueRefund call to issue a refund to the buyer. container. getActivityOptions Conditionally This integer value indicates the maximum number of business days that a seller has to issue a refund to the buyer once the seller has received the returned item. getActivityOptions Conditionally Type defining the provideSellerInfo activity option. If the provideSellerInfo activity option is returned in the getActivityOptions response, the seller can use the provideSellerInfo call to provide an RMA (Return Merchandise Authorization) number to the buyer. The buyerPreference child field will indicate whether an RMA number is the buyer's preference. getActivityOptions Conditionally Enumerated type that defines a seller's next possible actions to take in a return. This value indicates that the seller's next action is to issue a refund to the buyer through the issueRefund call. This value indicates that the seller's next action is to provide an RMA (Return Merchandise Authorization) number to the buyer through the provideSellerInfo call. This value indicates that the seller's next action is to print a shipping label for the replacement item This value indicates that the seller's next action is to upload a tracking number for the replacement item through the provideTrackingInfo call. This value indicates that the seller's next action is to mark the returned item as received through the setItemAsReceived call. This value is reserved for future use. Type that defines the activityOptions field, which contains an enumeration value that indicates the next possible action that a seller can take to resolve a return. This value is returned in the activityOptions field if the seller's next action is to issue a refund to the buyer. A selller can issue a refund to a buyer by using the issueRefund call. getActivityOptions Conditionally This value is returned in the activityOptions field if the seller's next action is to provide an RMA to the buyer. A selller can provide an RMA (Return Merchandise Authorization) number to a buyer by using the provideSellerInfo call. getActivityOptions Conditionally This type defines the returnDetail.returnHistory.activityDetail container returned in the getReturnDetail response. This container is always returned. The description child field describes the return activity. Enumerated type containing the possible states for a return. This value indicates that the the buyer is expecting to receive an RMA (Return Merchandise Authorization) number and/or an alternative return shipping address from the seller before the item is shipped back to the seller. This value indicates that the buyer is cleared to ship the item back to the seller. This value indicates that the buyer has shipped the item back to the seller. This value indicates that the returned item has been received by the seller. This value indicates that the return has been closed. This value indicates that the buyer has escalated the return to an eBay Buyer Protection case. When a return is escalated to an eBay Buyer Protection case, the return is closed. This value indicates that the status of the return is unknown. Type defining the NotificationEvent element. One of the eight possible Platform Notification events for the Return Management API. See also http://developer.ebay.com/devzone/xml/docs/reference/ebay/SetNotificationPreferences.html#Request.EventProperty.EventType The user ID of the eBay user subscribed to Platform Notifications. Echo back of user data. See also http://developer.ebay.com/devzone/xml/docs/reference/ebay/SetNotificationPreferences.html#Request.UserData.ExternalUserData The unique identifier of an eBay Return. Timestamp for the creation of the Platform Notification (in UTC). The eBay user ID of the other party involved in the return. The other party's role in the return. The current return status of the item in the return. Global ID (such as EBAY-US) of the eBay site where the order occurred. Enumerated type containing the Platform Notification events associated with eBay Returns and the Return Management API. This notification type is sent to the subscribed user or application when a return is created by the buyer. This notification type is sent to the subscribed user or application when a return is waiting for the seller to provide an RMA number to the buyer. This notification type is sent to the subscribed user or application when the due date for an RMA is overdue. This notification type is sent to the subscribed user or application when the item associated with a return is shipped back to the seller. This notification type is sent to the subscribed user or application when the item associated with a return has been delivered to the seller. This notification type is sent to the subscribed user or application when the refund to the buyer is overdue. This notification type is sent to the subscribed user or application when a return is closed by the system. This notification type is sent to the subscribed user or application when a (SNAD) return is escalated to the eBay Buyer Protection system. Get current service version. Get list of Returns for an eBay member. Gets details on a specific Return. Get activity options for the current state of the Return. Issues full refund. Allow seller to provide the RMA and return address information. Allows third party developers to get the details of return management system. Accepts the tracking info and associate the tracking info to the Return. Operation to set the item as received by seller or buyer 1.1.0 Service allows consumers to get Resolution Return information, and its details. --- # geteBayDetails (ShippingServiceDetails) 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. 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. 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. The request that triggered the error was processed successfully but with one or more warnings. 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. This is the base class for the request container for all service operations. Reserved for future use. No Base response container for all service operations. Contains error information associated with the request. 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. Always Information for an error or warning that occurred when eBay processed the request. Conditionally The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. 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). Always Reserved for future use. Returned errors are categorized as either Application, Request, or System errors. Request and application errors are often caused by passing invalid data in the call request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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. 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. 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. A container for 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 in which the error occurred. Conditionally Name of the subdomain in which the error occurred. 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused the error. Conditionally Unique identifier for an exception associated with an error. 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. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. The root request container of the getVersion call. getVersion Yes This call is used to return the current version of Business Policies Management API. This call can be used to monitor the service for availability. This call has no input parameters and the response contains only the standard output fields. Returns the current version of the Business Policies Management API. The root response container of the getVersion call. getVersion Always Response container for the getVersion API call. The root request container of the removeProfile call. removeProfile Yes The root response container of the removeProfile call. removeProfile Always This call is used to delete an existing business policy for a seller. Unique identifier for a business policy. Each payment, shipping, and return business policy has its own unique profileId value. The seller passes in this profileId value to identify the business policy to delete. A profileId value can be obtained through the site or by making a getSellerProfiles call. removeProfile Yes The response container for the removeProfile call. The root request container of the addSellerProfile call. addSellerProfile Yes The root response container of the addSellerProfile call. addSellerProfile Always Sellers use this call to create one or more business policies. With one call instance, the seller can create a payment policy, a return policy, a shipping policy, or any combination of the three policy types.

Important! This API is deprecated and will be decommissioned later in 2022, on a date TBD. We recommend that you migrate to the fulfillment\_policy, payment\_policy, and return\_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies.

Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group(s) to which the payment policy will be applied.

The paymentProfile container is conditionally required if the seller wants to create a new payment policy. addSellerProfile Yes getSellerProfiles Always Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group(s) to which the return policy will be applied.

The returnPolicyProfile container is conditionally required if the seller wants to create a new return policy. addSellerProfile Conditionally getSellerProfiles Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group(s) to which the shipping policy will be applied.

The shippingPolicyProfile container is conditionally required if the seller wants to create a new shipping policy. addSellerProfile Conditionally getSellerProfiles Conditionally Response container for the addSellerProfile call. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied.

The paymentProfile container is only returned if the seller created a payment policy in the addSellerProfile request. addSellerProfile Conditionally Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied.

The returnPolicyProfile container is only returned if the seller created a return policy in the addSellerProfile request. addSellerProfile Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied.

The shippingPolicyProfile container is only returned if the seller created a shipping policy in the addSellerProfile request. addSellerProfile Conditionally The root request container of the getSellerProfiles call. getSellerProfiles Yes The root response container of the getSellerProfiles call. getSellerProfiles Always The root request container of the setSellerProfile call. setSellerProfile Yes The root response container of the setSellerProfile call. setSellerProfile Always Sellers use this call to modify one or more business policies. With one call instance, the seller can modify a payment policy, a return policy, a shipping policy, or any combination of the three policy types. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied.

The paymentProfile container is conditionally required if the seller wants to modify an existing payment policy.

Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field. setSellerProfile Conditionally Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied.

The returnPolicyProfile container is conditionally required if the seller wants to modify an existing return policy.

Sellers only pass in values for the fields that they want to change. To delete an optional field, sellers can pass an empty value into the field. setSellerProfile Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied.

The shippingPolicyProfile container is conditionally required if the seller wants to modify an existing shipping policy.

Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field. setSellerProfile Conditionally Response container for the setSellerProfile call. Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied.

The paymentProfile container is only returned if the seller modified a payment policy in the setSellerProfile request. setSellerProfile Conditionally Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied.

The returnPolicyProfile container is only returned if the seller modified a return policy in the setSellerProfile request. setSellerProfile Conditionally Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied.

The shippingPolicyProfile container is only returned if the seller modified a shipping policy in the setSellerProfile request. setSellerProfile Conditionally Response container for the getSellerProfiles call. Container consisting of one or more payment policies that match the input criteria in the getSellerProfiles request. This container is not returned if no payment policies match the input criteria. getSellerProfiles Conditionally Container consisting of one or more return policies that match the input criteria in the getSellerProfiles request. This container is not returned if no return policies match the input criteria. getSellerProfiles Conditionally Container consisting of one or more shipping policies that match the input criteria in the getSellerProfiles request. This container is not returned if no shipping policies match the input criteria. getSellerProfiles Conditionally This call is used to retrieve one or more business policies for a seller. Specific business policies can be retrieved by passing in profileId or profileName values, or all policies of a certain type (payment, return, or shipping) can be retrieved. The seller passes in one or more profileType enumeration values to retrieve all business policies of that type. Valid values for this field are PAYMENT, RETURN\_POLICY, and SHIPPING.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all policies that match any of the supplied filters are retrieved in the response. SHIPPING\_RATE, SHIPPING\_EXCLUSION, SHIPPING\_DISCOUNT getSellerProfiles No Unique identifier for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all business policies that match any of the supplied filters are retrieved in the response. getSellerProfiles No Unique name for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all business policies that match any of the supplied filters are retrieved in the response. getSellerProfiles Conditionally This optional flag determines whether or not detailed information is retrieved for each business policy in the response. If included and set to 'true' or not included (since 'true' is the default), all applicable containers and fields for each business policy are returned in the response. If included and set to 'false', the following containers are not returned in the response:
  • paymentInfo (for all retrieved payment policies)
  • returnPolicyInfo (for all retrieved return policies)
  • shippingPolicyInfo (for all retrieved shipping policies)
    • lt;/ul> true getSellerProfiles No Type that defines the deliveryEstimateMetaInfo container, which consists of the entity and its value on which the item delivery estimates are based. The entity that item delivery estimates are based on. Valid entities include:
    • ExternalID
    • ItemID
    • SellerID
    • BuyerID
    • SGuid
    • PGuid
    • TransactionID
    addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value corresponds to the value in the key field and identifies the instance of that entity. addSellerProfile setSellerProfile No getSellerProfiles Conditionally Type defining the domesticShippingPolicyInfoService and internationalShippingPolicyInfoService containers, which consists of detailed information on domestic and international shipping service options. An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.

    If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.

    If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

    All shipToLocation fields specified for the shipping policy are always returned in the getSellerProfiles call. addSellerProfile setSellerProfile Conditionally getSellerProfiles Always A domestic or international shipping service being offered by the seller to ship an item to a buyer.

    For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing.

    The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing.

    If 'Get It Fast' shipping is being enabled for the shipping policy (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE\_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally geteBayDetails (ShippingServiceDetails) https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails This value indicates the shipping cost model used by the shipping service option. The two applicable values are 'Flat' and 'Calculated'. To verify that the shipping service supports calculated shipping, call geteBayDetails, using ShipppingServiceDetails as a DetailName value in the request, and then look at the ShippingServiceDetails container that corresponds to the specified shipping service option (see ShippingServiceDetails.ShippingService). One of the ShippingServiceDetails.ServiceType values in that same container should be 'Flat'.

    This field is optional in an addSellerProfile or setSellerProfile request, and defaults to 'Flat'.

    This field is always returned in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile setSellerProfile, or getSellerProfiles response. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails geteBayDetails (ShippingServiceDetails) https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ShippingTypeCodeType.html ShippingTypeCodeType This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages.

    Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options.

    Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.

    If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. 1 4 (for domestic shipping service) or 5 (for international shipping service) addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This flag is used by the seller to offer free shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call. The freeShipping field is not applicable for internationalShippingPolicyInfoService containers. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles intlShippingPolicyInfoService Conditionally This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the buyer selects the 'COD' payment method and if the selected shipping service option suppports the Cash-on-Delivery option.

    To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This flag indicates whether or not a 'Get It Fast' shipping service option is available for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.

    To enable 'Get It Fast' shippping for a listing, the seller must:
    • offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;
    • set the shippingPolicyInfo.dispatchTimeMax value to '0' (same-day shipping) or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer.
    Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment business policy, this option is turned on with the paymentInfo.immediatePay flag.
    The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers.

    addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles intlShippingPolicyInfoService Conditionally This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used.

    This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer.

    The total shipping costs for an order line item is calculated with the following formula:

    Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

    So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)).

    This field is not applicable to calculated shipping. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping.

    This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the freeShipping field is set to 'true'.

    The total shipping costs for an order line item is calculated with the following formula:

    Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

    So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)). addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas.

    In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
    • a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response;
    • flat-rate shipping is used
    addSellerProfile setSellerProfile No getSellerProfiles Conditionally geteBayDetails (ShippingServiceDetails) https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails The dollar amount in this field represents the actual total price of shipping if the total shipping costs (shippingServiceCost + shippingServiceAdditionalCost + shippingSurcharge) set for the corresponding shipping service in the shipping policy are overridden through a ShippingServiceCostOverride container in an AddItem call (Trading). addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This field is only applicable to motor vehicle categories on eBay Motors (US and Canada).

    If this field is included and set to 'true' (or omitted because the default value is 'true'), the buyer is responsible for the shipment/pickup of the motor vehicle. If this field is included and set to 'false', the seller should specify the vehicle shipping arrangements in the item description for the listing.

    If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. true addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally Type that defines the depositDetails container, which is used by the seller to specify amounts and due dates for deposits and full payment on eBay Motors (US and CA) vehicle listings. The depositDetails container is conditionally required if the the payment policy is for eBay Motors (US and CA) vehicles listings (categoryGroup.name=MOTORS\_VEHICLE). This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'.

    In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment policy:
    • CashOnPickup
    • LoanCheck
    • MOCC (money order or cashier's check)
    • PersonalCheck
    7 3 14 addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make an initial deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'.

    The deposit amount is specified in the depositAmount field. If not specified, the depositAmount value defaults to '0.0', in which case, a deposit on the vehicle is not required.
    Note: The hoursToDeposit value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle. 24 72 48 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS\_VEHICLE'.

    If not specified, this value defaults to '0.0'. If this value is specified, the seller must also specify an hoursToDeposit value.

    The deposit amount appears in the shipping, payment details and return policy sections of the View Item page. 0.0 2000.0 0.0 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the paymentProfile container, which is the container used to define one payment policy for a seller. This container consists of detailed payment information for a seller's payment policy. This container is conditionally required if the caller is creating a new payment policy or modifying an existing payment policy.

    This container is returned by getSellerProfiles if one or more payment policies match the input criteria in the call request, and is returned in the response of addSellerProfile or setSellerProfile if a payment policy is being created or modified, respectively. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Container consisting of one or more payment policies that match the input criteria in a getSellerProfiles< /b> call request. Container consisting of details for a specific payment policy. A PaymentProfile container is returned in getSellerProfiles for each payment policy that matches the input criteria. getSellerProfiles Conditionally Type defining the returnPolicyInfo container, which consists of detailed information on a seller's return policy. This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
    • Germany (DE)
    • Spain (ES)
    • France (FR)
    • Italy (IT)
    Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML and avoid character entity references (such as &pound; or &#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £). 5000 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace.

    On EBAY\_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

    Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

    Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

    Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response.

    Note: In version 1.1.0, the options for this field were reduced. An error will be thrown if you attempt to list an item with invalid business policy settings. See the Release Notes for details. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This required field indicates whether or not the seller accepts returns.

    Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for an item if the seller does not accept returns.

    On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

    Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (returnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the Item.DispatchTimeMax field.
    Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.



    For setSellerProfile: Updating the values in a business profile can effect the profiles in currently-listed items. In most cases, the updates made to a business policy can be streamlined into existing listings. However, if you update a business policy and the policy is invalid in the category where an item is listed, no error will be thrown and the policy will carry through the regular life of the listing. Sellers will be unable to re-list an item if it refers an invalid policy. Also note eBay will not update the policy's of a description if the listing has bids or sales, or if the listing ends within 12 hours. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally (GeteBayDetails) ReturnsAcceptedOption sites that support this field, and applicable values GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsAccepted.ReturnsAcceptedOption Returns and the Law (UK) http://pages.ebay.co.uk/businesscentre/law-policies/returns.html This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. 1.0.0 NoOp 1139 Conditionally 1.0.0 NoOp 1139 Conditionally This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. 1061 NoOp 1139 Conditionally 1061 NoOp 1139 Conditionally WarrantyTypeOptionsCodeType https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/WarrantyTypeOptionsCodeType.html This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. 1061 NoOp 1139 Conditionally 1061 NoOp 1139 Conditionally WarrantyDurationOptionsCodeType https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/WarrantyDurationOptionsCodeType.html This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports restocking fees for returned items. 1061 NoOp 1139 Conditionally 1061 NoOp 1139 Conditionally This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports holiday returns. v1.1.0 NoOp Conditionally 1061 NoOp Conditionally Type defining the returnPolicyProfile container, which is the container used to define one return policy for a seller. This container consists of detailed information on a seller's return policy. This container is conditionally required if the caller is creating a new return policy or modifying an existing return policy.

    This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This container consists of detailed information on a seller's international return policy (returns that require an international shipping service to ship). This container is optional and allows for a seller to establish an international return policy that differs from their domestic return policy.

    This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Type defining the returnPolicyProfileList container, which consists of one or more return policies that match the input criteria in the getSellerProfiles request. Container consisting of detailed information for a specific return policy that matches the input criteria. getSellerProfiles Always Type defining the categoryGroups container, which contains one or more categoryGroup containers. This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS\_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always Enumerated type that defines the business policy types. SHIPPING\_RATE, SHIPPING\_EXCLUSION, SHIPPING\_DISCOUNT This value indicates the business policy is a payment policy. This value indicates the business policy is a return policy. This value indicates the business policy is a shipping policy. This value is for future use. This value is for future use. This value is for future use. This value is for future use. This type defines the common elements used by all business policies. This value is for future use. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always The unique identifier of a business policy. This value is created by eBay when a business policy is created (on the site or through the API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific business policy to retrieve. This field is always returned with all Business Policies Management calls.

    A profileId value returned in the response of an addSellerProfile call indicates that the business policy was successfully created. removeSellerProfile setSellerProfile Yes getSellerProfiles Conditionally getSellerProfiles removeSellerProfile setSellerProfile addSellerProfile Always This field indicates the type of the business policy. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve business policies of a specific type. SHIPPING\_RATE, SHIPPING\_EXCLUSION, SHIPPING\_DISCOUNT addSellerProfile setSellerProfile Yes getSellerProfiles Conditionally getSellerProfiles addSellerProfile setSellerProfile Always This field is for internal use only. This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. 250 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This timestamp indicates when a business policy was deleted. This field is only returned in getSellerProfiles for business policies that have been deleted. For business policies that have been deleted by the seller, deletedDate is the only field that will be returned for the matching policy (in addition to the identifying fields like profileId and profileName). getSellerProfiles Conditionally Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always Type defining the shippingPolicyProfile container, which is the container used to define one shipping policy for a seller. This container consists of detailed shipping information for a seller's shipping policy. This container is conditionally required if the caller is creating a new shipping policy or modifying an existing shipping policy.

    This container is returned by getSellerProfiles if one or more shipping policies match the input criteria in the call request. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the shipingPolicyProfile container, which consists of one or more shipping policies that match the input criteria in the getSellerProfiles request. Container consisting of one or more shipping policies that match the input criteria in the getSellerProfiles request. This container is not returned if no shipping policies match the input criteria. getSellerProfiles Conditionally This type defines the additionalServiceShippingOption container, which contains an additional shipping service option available to buyers (in addition to the shipping service option specified in the domesticShippingPolicyInfoService field. The name of the additional shipping service option available to buyer. For a list of valid shipping service options, call the Trading API's GeteBayDetails call with the DetailName field set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present in the GeteBayDetails response. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This flag indicates whether the additional shipping service is enabled or disabled. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally The root response container of the removeSellerProfiles call. removeSellerProfiles Always The root request container of the removeSellerProfiles call. removeSellerProfiles Yes Sellers use this call to delete one or more existing business policies. Unique identifier for a business policy. Each payment policy, shipping policy, and return policy has its own unique profileId. The seller passes in one or more profileIds values to identify the business policies to delete. The profileId values can be obtained through the site or by making a getSellerProfiles call. removeSellerProfiles Yes The response container for the removeSellerProfiles call. Container consisting of the profileId values for business policies that were successfully deleted, as well as an ack value to indicate if the call was successful. An errorMessage container will be returned if the call generated any errors or warnings. addSellerProfile Conditionally Type defining the sellerProfileResponseStatus container, which is returned in the removeSellerProfiles response, and indicates whether or not the business policies specified in the call request were successfully deleted. Unique identifier for a business policy. Each payment policy, shipping policy, and return policy has its own unique profileId. A profileId value is returned for all business policies that were successfully deleted. For business policies that were not successfully deleted, the reason may be found in the errorMessage container. removeSellerProfiles Yes A token representing the application-level acknowledgement code that indicates the success of the call. Always Information for an error or warning that occurred when eBay processed the request. Conditionally Type defining the PaymentInfo container, which contains payment information related to the corresponding payment policy. Note:This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item. This field specifys one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform. If you specify multiple acceptedPaymentMethod fields, the repeating fields must be contiguous. Note: Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call GetCategoryFeatures, specifying 'PaymentMethods' as a FeatureID value in the call request, and then look for the Category.PaymentMethod values in the call response. In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified:
    • CashOnPickup
    • LoanCheck
    • MOCC (money order or cashier's check)
    • PersonalCheck
    addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This field should be included and set to true if the seller wants to require immediate payment from the buyer for:
    • A fixed-price item
    • An auction item where the buyer is using the 'Buy it Now' option
    • A deposit for a motor vehicle listing

    Note: In the Trading API calls that return the AutoPay field (immediatePay equivalent), be aware that the field's appearance in the output does not necessarily indicate that the listing qualifies for immediate payment, but only that the seller attempted to create (by including and setting immediatePay to 'true' in the payment policy) an immediate payment requirement.
    To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:

    • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
    • seller must include and set the shippingProfileDiscountInfo container values if promotional shipping discounts will be used;
    false addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally

    Important: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.

    This free-form string field allows the seller to give payment instructions to the buyer. These instructions will appear on eBay's View Item and Checkout pages. This field allows 1000 characters.

    It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment policies to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle.

    1000 addSellerProfile setSellerProfile v1.1.0 NoOp No getSellerProfiles addSellerProfile setSellerProfile v1.1.0 NoOp Conditionally

    Important: This field is deprecated. Do not use this field.

    addSellerProfile setSellerProfile v1.1.0 NoOp No getSellerProfiles addSellerProfile setSellerProfile v1.1.0 NoOp Conditionally This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS\_VEHICLE'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'.

    In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment business policy:
    • CashOnPickup
    • LoanCheck
    • MOCC (money order or cashier's check)
    • PersonalCheck
    7 3 14 addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally The root request container of the consolidateShippingProfiles call. consolidateShippingProfiles Yes The root response container of the consolidateShippingProfiles call. consolidateShippingProfiles Always This call can be used to consolidate shipping policies that have identical data with the exception of shipping costs. The response container for the consolidateShippingProfiles call. Container consisting of details related to the shipping policies consolidation job, including a unique ID, the status of the job, and the eBay site ID. consolidateShippingProfiles Always The root request container of the getConsolidationJobStatus call. getConsolidationJobStatus Yes The root response container of the getConsolidationJobStatus call. getConsolidationJobStatus Always This call can be used to retrieve the status of a shipping policies consolidation job. 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. getConsolidationJobStatus No The response container for the getConsolidationJobStatus call. Container consisting of details related to the shipping policies consolidation job, including the status of the job and the eBay site ID. getConsolidationJobStatus Always Enumerated type defining the possible status values for a shipping policies consolidation job. This value indicates that the shipping policies consolidation job is currently in progress. This value indicates that the shipping policies consolidation job has successfully completed. 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. Type defining the Job container that is returned in the consolidateShippingProfiles and GetConsolidationJobStatus calls. The Job container consists of a unique ID for the job, the status of the job, and the eBay site ID. 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. getConsolidationJobStatus Always consolidateShippingProfiles Conditionally The type of shipping policies consolidation job. Currently, only one value is applicable. consolidateShippingProfiles getConsolidationJobStatus Always This field indicates the status of the shipping policies consolidation job. consolidateShippingProfiles getConsolidationJobStatus Always Unique identifier of the eBay listing site. consolidateShippingProfiles getConsolidationJobStatus Always Enumerated type defining the possible shipping policies consolidation job types. This value indicates that the job type is a shipping policies consolidation job. The root response container of the removeOverrides call. removeOverrides Always The root request container of the removeOverrides call. removeOverrides Yes This call is used to remove shipping cost overrides for a specific shipping policy. The only input parameter for this call is the unique identifier of the shipping policy, and the response contains only the standard output fields. Removes shipping cost overrides for a specific shipping policy. The unique identifier of the shipping policy. The seller provides the profileId of the shipping policy for which he/she would like to remove shipping cost overrides. removeOverrides Yes Monetary amount. This type is used in several locations in payment policies and return policies. This attribute identifies the currency in which the monetary amount is specified. For a full list of 3-digit ISO 4217 currency codes, see the Trading API's CurrencyCodeType. Type defining the deliveryEstimate container, which provides details on the estimated time of delivery of the item to the buyer. The maximum number of business days that a buyer may need to wait for delivery of an item after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. addSellerProfile setSellerProfile No getSellerProfiles Conditionally The minimum number of business days that a buyer may need to wait for delivery of an item after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. addSellerProfile setSellerProfile No getSellerProfiles Conditionally The latest date that an item may be delivered to the buyer after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. Non-business days are disregarded when determining this date. addSellerProfile setSellerProfile No getSellerProfiles Conditionally The earliest date that an item may be delivered to the buyer after the buyer pays for the order. This value is based on the dispatchTimeMax value and the shipping service option being used to ship the item. Non-business days are disregarded when determining this date. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This integer value indicates the minimum level of confidence that the item delivery estimates will be met. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This integer value indicates the maximum level of confidence that the item delivery estimates will be met. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value indicates how item delivery estimates will be treated. addSellerProfile setSellerProfile No addSellerProfile setSellerProfile getSellerProfiles Conditionally This value indicates the maximum number of days after payment, including weekends and any holidays, that a buyer may have to wait for the item to be delivered. This value is based on the dispatchTimeMax value, the shipping service option being used to ship the item, plus the number of weekend or holiday days between tha payment date and the maxDeliveryDate. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value indicates the minimum number of days after payment, including weekends and any holidays, that a buyer may have to wait for the item to be delivered. This value is based on the dispatchTimeMax value, the shipping service option being used to ship the item, plus the number of weekend or holiday days between tha payment date and the minDeliveryDate. addSellerProfile setSellerProfile No getSellerProfiles Conditionally Type defining the freightShipping container, which consists of details related to freight shipping. This container is required to be set in a shipping policy if the seller offers freight shipping. String value indicating whether the freight item is being picked up from a residence or from a commercial location. Valid values are 'Residential' and 'Commercial'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Flag indicating if the freight item will be picked up inside or outside of the pickup location. If this value is 'true', the item will be picked up inside of the pickup location, and if 'false', the item will be picked up outside of the pickup location. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Flag indicating if help is required to pick up the freight item. If this value is 'true', help picking up the item is required, and if 'false', help picking up the item is not required. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally A string value classifying the freight item to be shipped. Valid values for this field include:
    • MACHINERY\_USED
    • MACHINERY\_NEW
    • FRAGILE\_HOUSEHOLD\_USED
    • FRAGILE\_HOUSEHOLD\_NEW
    • NON\_FRAGILE\_HOUSEHOLD\_USED
    • NON\_FRAGILE\_HOUSEHOLD\_NEW
    • RESTAURANT\_EQUIPMENT\_USED
    • RESTAURANT\_EQUIPMENT\_NEW
    • COMPUTER\_ELECTRONICS\_USED
    • COMPUTER\_ELECTRONICS\_NEW
    • VENDING\_MACHINE\_USED
    • VENDING\_MACHINE\_NEW
    • MOTORCYCLE\_USED
    • MOTORCYCLE\_NEW
    This is a required field if freight shipping is included in the shipping policy. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Value indicating the shipping class of the freight item. The shipping class corresponds to the weight of the item (in pounds). Valid values include '50.0', '55.0', '60.0', '65.0', '70.0', '77.5', '85.0', '92.5', '100.0', '110.0', '125.0', '150.0', '175.0', '200.0', '225.0', '250.0', '300.0', '400.0', and '500.0'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally String value indicating whether the freight item is being delivered to a residence or to a commercial location. Valid values are 'Residential' and 'Commercial'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Flag indicating if the freight item will be dropped off inside or outside of the delivery location. If this value is 'true', the item will be dropped off inside of the delivery location, and if 'false', the item will be dropped off outside of the delivery location. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the insurance container, which contains the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer. This dollar value indicates the cost to the buyer to purchase domestic shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering domestic shipping insurance to the buyer, and the domesticInsuranceOption is 'Optional' or 'Required'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This string value indicates the seller's policy on offering domestic shipping insurance to the buyer. Valid values include:
    • IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item
    • NotOffered: the seller does not offer shipping insurance to the buyer
    • Optional: purchasing shipping insurance for the item is at the discretion of the buyer
    • Required: the seller requires that the buyer purchase shipping insurance for the item
    This field is required if an AU, FR, or IT seller is offering domestic shipping insurance to the buyer. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This string value indicates the seller's policy on offering international shipping insurance to the buyer. Valid values include:
    • IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item
    • NotOffered: the seller does not offer shipping insurance to the buyer
    • Optional: purchasing shipping insurance for the item is at the discretion of the buyer
    • Required: the seller requires that the buyer purchase shipping insurance for the item
    This field is required if an AU, FR, or IT seller is offering international shipping insurance to the buyer. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This dollar value indicates the cost to the buyer to purchase international shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering international shipping insurance to the buyer, and the internationalInsuranceOption is 'Optional' or 'Required'. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This enumeration type defines the values that can be set as a currencyId attribute for Business Policies Management elements that use Amount type, such as depositDetails.depositAmount in payment policies, or shippingServiceCost in shipping policies. USD, CAD, GBP, AUD, EUR, CHF, CNY, HKD, PHP, PLN, SEK, SGD, TWD, INR, MYR U.S. Dollar; country - United States; ISO currency code - 840 Canadian Dollar; country - Canada; ISO currency code - 124 Pound Sterling; country - United Kingdom; ISO currency code - 826 German Mark; country - Germany; ISO currency code - 276 (Not valid in shippingPolicyCurrency field) Australian Dollar; country - Australia; ISO currency code - 036 Japanese Yen; country - Japan; ISO currency code - 392 (Not valid in shippingPolicyCurrency field) Euro; entity - European Union; ISO currency code - 978 French Franc; country - France; ISO currency code - 250 (Not valid in shippingPolicyCurrency field) Austrian Schilling; country - Austria; ISO currency code - 040 (Not valid in shippingPolicyCurrency field) Belgian Franc; country - Belgium; ISO currency code - 056 (Not valid in shippingPolicyCurrency field) Swiss Franc; country - Switzerland; ISO currency code - 756 Chinese Yuan Renminbi; country - China; ISO currency code - 156 Czech Koruna; country - Czech Republic; ISO currency code - 203 (Not valid in shippingPolicyCurrency field) Danish Krone; country - Denmark; ISO currency code - 208 (Not valid in shippingPolicyCurrency field) Spanish Peseta; country - Spain; ISO currency code - 724 (Not valid in shippingPolicyCurrency field) Finnish Markka; country - Finland; ISO currency code - 246 (Not valid in shippingPolicyCurrency field) Greek Drachma; country - Greece; ISO currency code - 300 (Not valid in shippingPolicyCurrency field) Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 Hungarian Forint; country - Hungary; ISO currency code - 348 (Not valid in shippingPolicyCurrency field) Indonesian Rupiah; country - Indonesia; ISO currency code - 360 (Not valid in shippingPolicyCurrency field) Irish Pound; country - Ireland; ISO currency code - 372 (Not valid in shippingPolicyCurrency field) Israeli New Shekel; country - Israel; ISO currency code - 376 (Not valid in shippingPolicyCurrency field) Italian Lira; country - Italy; ISO currency code - 380 (Not valid in shippingPolicyCurrency field) Dutch Guilder; country - Netherlands; ISO currency code - 528 (Not valid in shippingPolicyCurrency field) Norwegian Krone; country - Norway; ISO currency code - 578 (Not valid in shippingPolicyCurrency field) New Zealand Dollar; country - New Zealand; ISO currency code - 554 (Not valid in shippingPolicyCurrency field) Philippine Peso; country - Philippines; ISO currency code - 608 Polish New Zloty; country - Poland; ISO currency code - 985 Portuguese Escudo; country - Portugal; ISO currency code - 620 (Not valid in shippingPolicyCurrency field) Russian Ruble; country - Russian Federation; ISO currency code - 810 (Not valid in shippingPolicyCurrency field) Swedish Krona; country - Sweden; ISO currency code - 752 Singapore Dollar; country - Singapore; ISO currency code - 702 Thai Baht; country - Thailand; ISO currency code - 764 (Not valid in shippingPolicyCurrency field) New Taiwan Dollar; country - Taiwan; ISO currency code - 901 South African Rand; country - South Africa; ISO currency code - 710 (Not valid in shippingPolicyCurrency field) Indian Rupee; country - India; ISO currency code - 356 Peruvian New Sol; country - Peru; ISO currency code - 604 (Not valid in shippingPolicyCurrency field) Malaysian Ringgit; country - Malaysia; ISO currency code - 458 Vietnamese New Dong; country - Vietnam; ISO currency code - 704 (Not valid in shippingPolicyCurrency field) South Korean Won; country - South Korea; ISO currency code - 410 (Not valid in shippingPolicyCurrency field) New Turkish Lira; country - Turkey; ISO currency code - 949 (Not valid in shippingPolicyCurrency field) Antillian Guilder; country - Netherlands Antilles; ISO currency code - 532 (Not valid in shippingPolicyCurrency field) Aruban Guilder; country - Aruba; ISO currency code - 533 (Not valid in shippingPolicyCurrency field) Bermudan Dollar; country - Bermuda; ISO currency code - 060 (Not valid in shippingPolicyCurrency field) Costa Rican Colon; country - Costa Rica; ISO currency code - 188 (Not valid in shippingPolicyCurrency field) Romanian New Leu; country - Romania; ISO currency code - 946 (Not valid in shippingPolicyCurrency field) Venezuelan Bolivar Fuerte; country - Venezuela; ISO currency code - 937 (Not valid in shippingPolicyCurrency field) Barbados Dollar; country - Barbados; ISO currency code - 052 (Not valid in shippingPolicyCurrency field) Bulgarian Lev; country - Bulgaria; ISO currency code - 975 (Not valid in shippingPolicyCurrency field) Brunei Dollar; country - Brunei; ISO currency code - 096 (Not valid in shippingPolicyCurrency field) Bahamian Dollar; country - Bahamas; ISO currency code - 044 (Not valid in shippingPolicyCurrency field) Columbian Peso; country - Columbia; ISO currency code - 170 (Not valid in shippingPolicyCurrency field) Dominican Peso; country - Dominican Republic; ISO currency code - 214 (Not valid in shippingPolicyCurrency field) Guatemalan Quetzal; country - Guatemala; ISO currency code - 320 (Not valid in shippingPolicyCurrency field) Cayman Isles Dollar; country - Cayman Islands; ISO currency code - 136 (Not valid in shippingPolicyCurrency field) Maldivian Rufiyaa; country - Maldives; ISO currency code - 462 (Not valid in shippingPolicyCurrency field) Qatari Rial; country - Qatar; ISO currency code - 634 (Not valid in shippingPolicyCurrency field) Saudi Riyal; country - Saudi Arabia; ISO currency code - 682 (Not valid in shippingPolicyCurrency field) Trinidadian and Tobagonian Dollar; country - Trinidad and Tobago; ISO currency code - 780 (Not valid in shippingPolicyCurrency field) Ukrainian Hryvnia; country - Ukraine; ISO currency code - 980 (Not valid in shippingPolicyCurrency field) Peso Uruguayo; country - Uruguay; ISO currency code - 858 (Not valid in shippingPolicyCurrency field) East Caribbean Dollar; entity - East Caribbean Currency Area; ISO currency code - 951 (Not valid in shippingPolicyCurrency field) French Polynesian Franc; country - French Polynesia; ISO currency code - 953 (Not valid in shippingPolicyCurrency field) Jamaican Dollar; country - Jamaica; ISO currency code - 388 (Not valid in shippingPolicyCurrency field) Russian ruble; country - Russian Federation; ISO currency code - 643 (Not valid in shippingPolicyCurrency field) Brazilian real; country - Brazil; ISO currency code - 986 (Not valid in shippingPolicyCurrency field) Chilean peso; country - Chile; ISO currency code - 152 (Not valid in shippingPolicyCurrency field) Mexican peso; country - Mexico; ISO currency code - 484 (Not valid in shippingPolicyCurrency field) Honduran lempira; country - Honduras; ISO currency code - 340 (Not valid in shippingPolicyCurrency field) Nicaraguan cordoba; country - Nicaragua; ISO currency code - 558 (Not valid in shippingPolicyCurrency field) Bolivian boliviano; country - Bolivia; ISO currency code - 068 (Not valid in shippingPolicyCurrency field) Paraguayan guarani; country - Paraguay; ISO currency code - 600 (Not valid in shippingPolicyCurrency field) Type definining the rateTableInfo container, which identifies the domestic and international shipping rate tables referenced to determine flat-rate shipping costs based on shipping service level (Economy, Standard, Expedited, One-day) and delivery location. Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
    This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.

    Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined.

    This field is returned in getSellerProfiles if it is defined for the shipping policy. 50 addSellerProfile setSellerProfile No getSellerProfiles Conditionally This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.

    Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined.

    This field is returned in getSellerProfiles if it is defined for the shipping policy. 50 addSellerProfile setSellerProfile No getSellerProfiles Conditionally This type is reserved for future use. This field is reserved for future use. addSellerProfile setSellerProfile No getSellerProfiles Conditionally This field is reserved for future use. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This field is reserved for future use. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This field is reserved for future use. addSellerProfile setSellerProfile Conditionally getSellerProfiles Conditionally This type is for internal use. This field is for future use. This field is for internal use. addSellerProfile setSellerProfile No getSellerProfiles Conditionally Type defining the shippingPolicyInfo container, which consists of detailed information for a seller's shipping policy. This string value indicates the name of the shipping policy. This business policy name must be unique among all of seller's shipping policies. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping policy.

    This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Conditionally The domestic shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping.

    If 'FreightFlat' is specified as the domestic shipping type, the freightShipping container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API.

    This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Flat addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Shipping https://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay\_XML\_API&topic=Shipping The international shipping cost model used by the seller. Valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping.

    If 'FreightFlat' is specified as the international shipping type, the freightShipping container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API.

    This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Flat addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment for an order. This time does not include the shipping time (the carrier's transit time). Valid values can vary by site and by category. To obtain supported values for a site, call GeteBayDetails, using DispatchTimeMaxDetails as a DetailName value in the request, and then look at the DispatchTimeMaxDetails container in the response for supported values for the site.

    Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results. To offer zero-day or one-day handling, the seller should include the dispatchTimeMax field in the shipping business policy and set the value of this field to '0' or '1', respectively.

    The dispatchTimeMax field must be included in the shipping policy and set to '0' or '1' if the fastShipping flag is included and set to 'true' in the shipping policy.

    Note: Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a DispatchTimeMax value of '0' to indicate that no handling time is specified for the listing. However, with the onboarding of same-day shipping, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Now, sellers that do not want to specify a handling time for their shipping policy, should omit the < b>dispatchTimeMax     field, or they can include it but set it to null.
    This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
    1 30 addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Always This free-form string field is used by the seller to provide more details to the buyer about handling time.

    If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This optional field helps summarize the locations/regions that the seller will ship an item to. The integer value that is used in this field for an addSellerProfile or setSellerProfile call should be in synch with the values that are specified in the shipToLocation and excludeShipToLocation fields used in the same call.

    The possible values are listed below:
    • 0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site).
    • 1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the shipToLocation field.
    • 2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an excludeShipToLocation field.
    • 3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle.
    • 4 ('TermsAndConditionsOnly'): this value is for future use.
    If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Sellers can use this field to exclude one or more international regions, countries, or special domestic locations (such as 'PO Box' in US or 'Packstation' in Germany) as possible shipping locations. To obtain valid 'exclude Ship-To locations', the seller must call GeteBayDetails, using ExcludeShipppingLocationDetails as a DetailName value in the request, and then scan the ExcludeShippingLocationDetails.Location values that are returned in the response. The seller may include as many valid excludeShipToLocation values as necessary based on where they are not willing to ship an item.

    If a buyer's primary ship-to location is a location that the seller has listed as an excluded ship-to location, that buyer will receive an error message if they attempt to buy or place a bid on your item.

    This field works in conjunction with the shipToLocation values to create a set of international regions, countries, and domestic locations to where the seller will (and will not) ship. You can list a region in the shipToLocation field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a shipToLocation value, yet exclude Egypt by including an excludeShipToLocation field with its value set to 'EG', which is Egypt's two-digit country code. In addition, if a seller used only one shipToLocation value and set it to 'Worldwide', that seller can use one or more excludeShipToLocation fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations.

    Each excluded ship-to location is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Container consisting of flat-rate or calculated shipping discount profile IDs (that identify the shipping discount rules to apply when domestic and/or international buyers purchase multiple items), as well as flags indicating if promotional shipping discounts are offered to domestic and/or international buyers.

    Shipping discounts can be created by the seller through My eBay, or by using the SetShippingDiscountProfiles call of the Trading API.

    If shipping discounts are used for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles This container consists of details related to freight shipping. This container and its values are required to be set in a shipping policy if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat').

    If freight shipping is specified for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally An international region (such as Asia, Europe, or Latin America) or country (represented by two-letter country code) to where the seller will ship an item.

    It is not necessary to include the shipToLocation field in the domesticShippingPolicyInfoService container when using the addSellerProfile and setSellerProfile calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the shipToLocation field is always returned for each shipping policy in the addSellerProfile, setSellerProfile, and getSellerProfiles calls.

    If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to offer shipping to one or more specific shipping regions, the seller must include that shipping region in a shipToLocation field. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should use one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

    Applicable shipping region values are defined in ShippingRegionCodeType and applicable country codes are defined in CountryCodeType. However, it is best practice for sellers to call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response.

    Each specified ship-to location is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html GeteBayDetails https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/ShippingRegionCodeType.html ShippingRegionCodeType https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/CountryCodeType.html CountryCodeType Container that consists of detailed information for a domestic shipping service, including shipping costs, ship-to locations, and flags to indicate Fast and/or Free shipping. Up to four domestic shipping service options can be specified in one shipping business policy.

    Each specified domestic shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Container that consists of detailed information for an international shipping service, including shipping costs and ship-to locations. Up to five international shipping service options can be specified in one shipping policy.

    Each specified international shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This container consists of the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer.

    If shipping insurance options are specified for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
    This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.

    Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined.

    If set for the shipping policy (Germany and UK only), this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. 50 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.

    Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined.

    If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. 50 addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field allows the seller to add package handling costs for shipping an item to a domestic location.

    If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field allows the seller to add package handling costs for shipping an item to an international location.

    If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call GeteBayDetails, using CurrencyDetails as a DetailName value in the request, and then scanning the CurrencyDetails.Currency values that are returned in the response.

    If this field is not included in an addSellerProfile or setSellerProfile call, the currency code will default to the standard currency used by the listing site.

    This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always This container is for future use. This flag should be included and set to 'true' if the seller wants to enable the Global Shipping Program feature in the shipping policy. If the value of globalShipping is 'true', the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally).

    To make use of this field and the Global Shipping Program, the seller and the item being listed must be eligible for the Global Shipping Program. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID 3).

    In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
    • Have inventory for the product at one or more physical stores tied to the merchant's account
    • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to include the paymentInfo.immediatePay flag in the payment business policy and set its value to 'true'
When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Always Type defining the shippingPolicyInfoService container, which consists of detailed information for a shipping service option being offered to the buyer. An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.

If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.

If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

Each ship-to location specified for the shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingLocationDetails GeteBayDetails (ShippingLocationDetails) A domestic or international shipping service being offered by the seller to ship an item to a buyer.

For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, thatspecific shipping service option is no longer valid and cannot be offered to buyers through a listing.

The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing.

If 'Get It Fast' shipping is being enabled for the shipping policy (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE\_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping.

Each shipping service specified for the shipping policy is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html GeteBayDetails This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages.

Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options.

Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.

If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call.

This field is always returned (for each shipping service) with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.

1 4 (for domestic shipping service) or 5 (for international shipping service) addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This flag is used by the seller to offer free domestic shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call.

If free shipping is set for a domestic shipping service, this field is returned in the shipping business policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option.

To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service.

If a Cash-on-Delivery shipping service is defined for the shipping policy, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This flag indicates whether or not the seller is offering 'Get It Fast' shipping for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.

To enable 'Get It Fast' shipping for a listing, the seller must:
  • offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;
  • set the shippingPolicyInfo.dispatchTimeMax value to '0' or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. A DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping.
Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment policy, this option is turned on with the paymentInfo.immediatePay flag. The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers.

If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally getSellerProfiles addSellerProfile setSellerProfile intlShippingPolicyInfoService Conditionally This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used.

This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer.

The total shipping costs for an order line item is calculated with the following formula:

Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)).

This field is not applicable to calculated shipping.

If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping.

This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the freeShipping field is set to 'true'.

The total shipping costs for an order line item is calculated with the following formula:

Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost \* quantity purchased)

So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)).

This field is always returned (for each shipping service) with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Determining Shipping Costs for a Listing https://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay\_XML\_API&topic=ShippingGettingCosts addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas.

In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
  • a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response;
  • flat-rate shipping is used
If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally This field is only applicable to vehicle categories on eBay Motors (US and Canada).

If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. true addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally This field is only applicable to vehicle categories on eBay Motors (US and Canada).

If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.

true addSellerProfile setSellerProfile Conditionally getSellerProfiles addSellerProfile setSellerProfile Conditionally Type defining the shippingProfileDiscountInfo container, which consists of details related to flat-rate, calculated, and promotional shipping discounts that are offered to domestic and/or international buyers. Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, a domestic buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API.

The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the domesticShippingType ('Flat' or 'Calculated') value in the shipping policy.

Shipping discount profiles are not applicable when Freight shipping is used. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, an international buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API.

The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the intlShippingType ('Flat' or 'Calculated') value in the shipping policy.

Shipping discount profiles are not applicable when Freight shipping is used. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles If this field is included and set to 'true', a domestic buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles If this field is included and set to 'true', an international buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. addSellerProfile setSellerProfile No getSellerProfiles addSellerProfile setSellerProfile Conditionally https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html SetShippingDiscountProfiles https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html GetShippingDiscountProfiles Enumerated type defining the shipping rates that the seller will receive through USPS, UPS, or Federal Express to ship an item. The shipping rate also affects how much the buyer will pay for shipping. This value indicates that the seller gets On Demand shipping rates through United Parcel Service (UPS). This value indicates that the seller gets Daily Pickup shipping rates through United Parcel Service (UPS). This value indicates that the seller gets Standard shipping rates through Federal Express (FedEx). This value indicates that the seller gets Counter shipping rates through Federal Express (FedEx). This value indicates that the seller gets Discounted shipping rates through US Postal Service (USPS). This value indicates that the seller gets Commercial Plus shipping rates through US Postal Service (USPS). This value indicates that the seller gets discounted shipping rates through Federal Express (FedEx). This value indicates that the seller gets gold/silver-level shipping rates. This value indicates that the seller gets platinum/titanium-level shipping rates. This value indicates that the seller gets standard eBay shipping rates. This value indicates that the seller gets standard retail shipping rates. Type defining the categoryGroup container, which indicates the category group to which the payment, return, or shipping business policy applies to. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings.

Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.

addSellerProfile setSellerProfile v1.1.0 NoOp No getSellerProfiles addSellerProfile setSellerProfile v1.1.0 NoOp No Conditionally This string value indicates the name of the category group to which the corresponding business policy applies. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. addSellerProfile setSellerProfile Yes getSellerProfiles addSellerProfile setSellerProfile Always This flag is returned as 'true' if the corresponding business policy meets all eBay Top-Rated Listing requirements for the category group. To qualify as an ETRS business policy, the seller must meet Top-Rated Seller requirements, and the business policy must include a 14-day (or longer) money back return policy and same-day or one-day handling. For more information on Top-Rated Seller and Top-Rated Plus listings, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic. getSellerProfiles addSellerProfile setSellerProfile Conditionally Populate this complex object if your international return policy differs from your domestic return policy (by default, international return policies inherit their settings from the settings in the domestic return policy).

For example, you might want to offer free returns for domestic shipments, but have a return policy where the buyer pays for returns from non-domestic regions. This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service).

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify ReturnsNotAccepted.

On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted.

Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This option specifies either the buyer or the seller as the party who pays for return shipping charges for international returns. Accepted values are Buyer or Seller. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted.

Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted.

Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs.

On EBAY\_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack. addSellerProfile setSellerProfile Conditionally addSellerProfile setSellerProfile getSellerProfiles Conditionally Documentation goes here. 1.0.0 --- # Finding API: Simple Schema Types eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/FindingAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) Simple Schema Types =================== The eBay Schema makes use of many simple schema types. Further, some eBay-defined types (e.g., [Amount](https://developer.ebay.com/devzone/business-policies/CallRef/types/Amount.html) ) are based on simple schema types. Except where specified, the data types in the table below follow the conventions for XML Schema simple types as described by the World Wide Web Consortium in [XML Schema Part 2: Datatypes](http://www.w3.org/TR/xmlschema-2/) . | Data Type | Description | | --- | --- | | anyURI | Specifies a Uniform Resource Identifier (URI), a compact sequence of characters that identifies an abstract or physical resource.

The anyURI type is used most often to specify Uniform Resource Locators (URLs), such as a web page URL (e.g., ViewItemURL) or a file location URL (e.g., PictureURL), but can also be used for email addresses and other valid URI schemes. | | boolean | Specifies binary-valued logic (true/false). Possible input values are true, false, 1, and 0. Possible output values are true and false only (not 1 or 0). | | dateTime | A specific instant of time.

Date-time values are in the ISO 8601 date and time format. Hours are in 24-hour format (e.g., 2:00:00pm is 14:00:00). Unless otherwise specified, all date-time values are recorded in Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT) or Zulu (because the time portion of the time stamp ends with a Z). That is, time values do not reflect the time zone shown on the eBay Web site. Here is an example of the date-time format:

YYYY-MM-DDTHH:MM:SS.SSSZ (e.g., 2004-08-04T19:09:02.768Z)

See [Time Values](https://developer.ebay.com/devzone/guides/features-guide/default.html#basics/DataTypes.html#TimeValues)
for information about how to convert between local time zones and GMT.

We use the dateTime data type to convey start and end times, the official eBay time, and other time values. | | decimal | A decimal value of arbitrary precision.

In the API, most fields of type decimal can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Decimal values should never include a thousands separator.

A whole number (i.e., without a period) can be passed as a decimal value.

We typically use the decimal data type to convey values related to units of measure. See individual topics for specific restrictions beyond this for fields of type decimal. | | double | A double-precision 64-bit floating point type.

In the API, most fields of type double can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Double values should never include a thousands separator.

We typically use the double data type to convey values related to monetary amounts. See AmountType, below.

In some cases, a whole number (i.e., without a period) can be passed or returned as a double value. See individual topics for specific restrictions beyond this for fields of type double. | | duration | A length of time.

Duration values are in the ISO 8601 duration format, where P represents "Period", nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes, and nS the number of seconds. So P2DT23H32M51S means "A period of 2 days, 23 hours, 32 minutes, and 51 seconds".

PnYnMnDTnH nMnS (e.g., P2DT23H32M51S)

We use the duration data type to convey values like the time left until a listing ends. For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). | | float | A single-precision 32-bit floating point type.

In the API, most fields of type float can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Float values should never include a thousands separator.

We typically use the float data type to convey values related to percentages. See individual topics for specific restrictions beyond this for fields of type float. | | int | A 32-bit integer value between -2147483648 and 2147483647.

In the API, most fields of type int can contain digits 0-9, and hyphen to indicate negative numbers. Some input fields restrict the input to particular values or a range of values. These cases are noted in the associated topic for the specific input field.

We typically use the int data type for enumerations, counts (e.g., how many items are returned), quantities, certain kinds of IDs (other IDs are strings), and similar concepts. | | long | A value between -9223372036854775808 and 9223372036854775807. | | positiveInteger | An integer value greater than or equal to 1. | | string | A string of characters. All characters in the Unicode character set are supported.

Character entity references are used for escaping markup-significant characters. For example, use & for the & (ampersand) character, < for the < (less-than sign) character, and > for the > (greater-than sign) character. It is a good idea to escape such characters in requests instead of using a CDATA construct. Responses from eBay do not include CDATA constructs.

Note that messages from eBay may contain HTML or XML markup within the message text. In this case, the markup elements within the text are escaped (e.g., <!\[CDATA\[ ... \]\]>).

Some string input fields (e.g., [keywords](https://developer.ebay.com/devzone/business-policies/CallRef/findItemsByKeywords.html#Request.keywords)
) do not have a known set of possible values. For these fields, the documentation specifies the maximum permitted length in characters. If you are using a URL for your request, and you need to use the & (ampersand) character as part of a string value (e.g. Bausch & Lomb in xxxkeywords), use &.

xs:string is part of the XML schema namespace defined as:

xmlns:xs="http://www.w3.org/2001/XMLSchema" | | token | A set of normalized strings.

In the API, this type of string contains no white space, by convention.

We typically use token to constrain a field to a specified set of normalized string values. For such a field, we define these values in an enumeration that uses token as its base type. | | [Amount](https://developer.ebay.com/devzone/business-policies/CallRef/types/Amount.html) | An eBay-defined complex type for specifying monetary amounts.

A double value (e.g., 1.00 or 1.0) is meaningful as an amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency.

In the API, an object of type Amount expresses both the value (a decimal) and the currency.

We typically use the Amount data type to specify details such as prices, fees, costs, and payments.

In some cases, a whole number (i.e., without a period) can be passed or returned as a monetary value. This is necessary to support certain currencies that are only expressed as whole numbers (like the Italian Lira and Spanish Peseta).

Because a double is used to represent the amount, this also means whole monetary amounts may be returned with only one 0 after the decimal. For example, a dollar value could be returned as 5.0 instead of 5.00 in calls like [findItemsByKeywords](https://developer.ebay.com/devzone/business-policies/CallRef/findItemsByKeywords.html)
. See individual topics for specific restrictions beyond this for fields of type Amount. | Repeatable (Unbounded) Fields ----------------------------- If the multiplicity of an element is defined as maxOccurs="unbounded" or a value greater than 1 in the schema, it means you can specify the field multiple times in a request (like you are specifying an array), or eBay can return the field multiple times in the response. In this case, the fields must be contiguous. That is, in a request, you cannot insert other fields between the repeating fields. Otherwise, some of the data will be dropped in an unpredictable manner. For example, **findItemsByKeywords** can return multiple items. Here is the definition of the **item** element in the **searchResult** schema (SearchResult complexType): In the response, the **item** fields are always contiguous, with no other fields between them: ... 170192529715 ... 330233123051 ... 320247274638 ... ... ... If you are using URL-style input or Name-Value Pair input, repeatable fields can be expressed with a comma-separated format **in most cases**. Multiplicity Notation --------------------- | Sample XML notation | Corresponding doc notation | Meaning § | | --- | --- | --- | | minOccurs="0" maxOccurs="unbounded" | \[0..\*\] | Zero or more | | minOccurs="0" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="1" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="6" | \[0..6\] | Zero to six | §  While this is the general meaning, be sure to read the description of the particular field: it may state an exception for a particular use. --- # Enumeration Index - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) Enumeration Index ================= This is a list of all enumeration values in the schema. The same enumeration value name may be used by several calls. A - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byApplication | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorCategory.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | Ascending | | | | --- | --- | | [ReturnSortOrderType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSortOrderType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | B - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byBUYER | | | | --- | --- | | [ReturnUserRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnUserRoleType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [UserFilterRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/UserFilterRoleType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | BuyerLoginName | | | | --- | --- | | [ReturnSortType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSortType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | BUYERORSELLER | | | | --- | --- | | [UserFilterRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/UserFilterRoleType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | C - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byCLOSED | | | | --- | --- | | [ReturnStatusInputType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusInputType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | D - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byDELIEVERED | | | | --- | --- | | [TrackingStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/TrackingStatusType.html) | [provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html) | Descending | | | | --- | --- | | [ReturnSortOrderType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSortOrderType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | E - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byEBAY | | | | --- | --- | | [ReturnUserRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnUserRoleType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | EBP\_SNAD | | | | --- | --- | | [CaseType](https://developer.ebay.com/Devzone/return-management/CallRef/types/CaseType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | Error | | | | --- | --- | | [ErrorSeverity](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorSeverity.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | ESCALATED | | | | --- | --- | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | EstimatedAmount | | | | --- | --- | | [ReturnSortType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSortType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | F - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byFAILED | | | | --- | --- | | [RefundStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | Failure | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/return-management/CallRef/types/AckValue.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | FilingDate | | | | --- | --- | | [ReturnSortType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSortType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | I - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byIN\_TRANSIT | | | | --- | --- | | [TrackingStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/TrackingStatusType.html) | [provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html) | ISSUE\_REFUND | | | | --- | --- | | [ActivityOptionType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActivityOptionType.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) | ITEM\_DELIVERED | | | | --- | --- | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ShipmentStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ShipmentStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | ITEM\_SHIPPED | | | | --- | --- | | [ReturnStatusInputType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusInputType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ShipmentStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ShipmentStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | M - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byMONEY\_BACK | | | | --- | --- | | [ReturnType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | MY\_RESPONSE\_DUE | | | | --- | --- | | [ReturnStatusInputType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusInputType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | O - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byORIGINAL\_SHIPPING | | | | --- | --- | | [RefundFeeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundFeeType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | OTHER | | | | --- | --- | | [ActivityOptionType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActivityOptionType.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) | | [CaseType](https://developer.ebay.com/Devzone/return-management/CallRef/types/CaseType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | | [RefundFeeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundFeeType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | | [ReturnUserRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnUserRoleType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ShipmentStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ShipmentStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | OTHER\_PARTY\_RESPONSE\_DUE | | | | --- | --- | | [ReturnStatusInputType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusInputType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | P - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byPartialFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/return-management/CallRef/types/AckValue.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | PENDING | | | | --- | --- | | [RefundStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | PROVIDE\_SELLER\_INFO | | | | --- | --- | | [ActivityOptionType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActivityOptionType.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) | PURCHASE\_PRICE | | | | --- | --- | | [RefundFeeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundFeeType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | R - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byREADY\_FOR\_SHIPPING | | | | --- | --- | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ShipmentStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ShipmentStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | REFUND\_DUE\_UPON\_ITEM\_ARRIVAL | | | | --- | --- | | [MetadataCodeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/MetadataCodeType.html) | [getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html) | RefundDueDate | | | | --- | --- | | [ReturnSortType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSortType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | REPLACEMENT | | | | --- | --- | | [ReturnType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | Request | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorCategory.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | RESTOCKING\_FEE | | | | --- | --- | | [RefundFeeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundFeeType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | RETURN\_REASONS | | | | --- | --- | | [MetadataCodeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/MetadataCodeType.html) | [getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html) | RETURN\_STARTED | | | | --- | --- | | [ReturnStatusInputType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusInputType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | RMA\_DUE\_UPON\_RETURN\_START | | | | --- | --- | | [MetadataCodeType](https://developer.ebay.com/Devzone/return-management/CallRef/types/MetadataCodeType.html) | [getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html) | S - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed bySELLER | | | | --- | --- | | [ReturnUserRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnUserRoleType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [UserFilterRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/UserFilterRoleType.html) | [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | SELLER\_MARK\_AS\_RECEIVED | | | | --- | --- | | [ActivityOptionType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActivityOptionType.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) | SELLER\_PRINT\_SHIPPING\_LABEL | | | | --- | --- | | [ActivityOptionType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActivityOptionType.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) | SELLER\_PROVIDE\_TRACKING\_INFO | | | | --- | --- | | [ActivityOptionType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActivityOptionType.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) | Success | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/return-management/CallRef/types/AckValue.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | SUCCESS | | | | --- | --- | | [RefundStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/RefundStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) | SYSTEM | | | | --- | --- | | [ReturnUserRoleType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnUserRoleType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | System | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorCategory.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | U - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byUNKNOWN | | | | --- | --- | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ReturnType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [TrackingStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/TrackingStatusType.html) | [provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html) | W - [A](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#F)   [I](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#S)   [U](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byWAITING\_FOR\_SELLER\_INFO | | | | --- | --- | | [ReturnStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) | | [ShipmentStatusType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ShipmentStatusType.html) | [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) | Warning | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/return-management/CallRef/types/AckValue.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | | [ErrorSeverity](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorSeverity.html) | [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html)

[getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html)

[getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html)

[getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html)

[getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html)

[issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html)

[provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html)

[provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html)

[setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) | --- # eBay Site ID to Global ID Mapping - Product API Product API * [Features Guide](https://developer.ebay.com/DevZone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/DevZone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product/ReleaseNotes.html) eBay Site ID to Global ID Mapping ================================= Each eBay site maps to a unique [eBay global ID](https://developer.ebay.com/DevZone/product/CallRef/Enums/GlobalIdList.html) . You must specify a global ID in the `X-EBAY-SOA-GLOBAL-ID` HTTP header for each API call. The global ID you use must correspond to one of the eBay site IDs in the following table: | eBay Site ID | Site Name | Global ID | | --- | --- | --- | | 0 | eBay United States | EBAY-US | | 2 | eBay Canada (English) | EBAY-ENCA | | 3 | eBay UK | EBAY-GB | | 15 | eBay Australia | EBAY-AU | | 16 | eBay Austria | EBAY-AT | | 23 | eBay Belgium (French) | EBAY-FRBE | | 71 | eBay France | EBAY-FR | | 77 | eBay Germany | EBAY-DE | | 100 | eBay Motors | EBAY-MOTOR | | 101 | eBay Italy | EBAY-IT | | 123 | eBay Belgium (Dutch) | EBAY-NLBE | | 146 | eBay Netherlands | EBAY-NL | | 186 | eBay Spain | EBAY-ES | | 193 | eBay Switzerland | EBAY-CH | | 201 | eBay Hong Kong | EBAY-HK | | 203 | eBay India | EBAY-IN | | 205 | eBay Ireland | EBAY-IE | | 207 | eBay Malaysia | EBAY-MY | | 210 | eBay Canada (French) | EBAY-FRCA | | 211 | eBay Philippines | EBAY-PH | | 212 | eBay Poland | EBAY-PL | | 216 | eBay Singapore | EBAY-SG | --- # CaseTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) CaseTypeEnum ============ This enumeration type lists the types of cases that may be created by the buyer or seller. Type that uses CaseTypeEnum: [CaseDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/CaseDetailsResponse.html) Call that uses one or more values of CaseTypeEnum: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ITEM\_NOT\_RECEIVED | This enumeration value indicates that the case was created by the buyer because the item wasn't received within the expected delivery window. INR inquiries can also be escalated to INR cases. | | RETURN | This enumeration value indicates that the case was created after a return request was escalated by the buyer or seller. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # RlspTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RlspTypeEnum ============ This enumerated type defines the values that can be returned for an Australian-based shipping service. Type that uses RlspTypeEnum: [ResponseHistoryAttributesType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html) Calls that use one or more values of RlspTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AU\_PARCELPOINT | This enumeration value indicates that the shipping service is a Parcel Point shipping service. | | AU\_PARCELPOINT\_AUPOST | This enumeration value indicates that the shipping service is a Parcel Point/Australia Post shipping service used for low coverage/remote areas. | | AU\_PARCELPOINT\_AUPOST\_DROP | This enumeration value indicates that the shipping service is a Parcel Point/Australia Post shipping service with dropoff. | | AU\_PARCELPOINT\_COURIER\_PICKUP | This enumeration value indicates that the shipping service is a Parcel Point shipping service with courier pickup. | | UNKNOWN | This enumeration value indicates that the shipping serviceis not known. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # CategoryGroup - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) CategoryGroup ============= Type defining the **categoryGroup** container, which indicates the category group to which the payment, return, or shipping business policy applies to. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. Type that uses CategoryGroup: [CategoryGroups](https://developer.ebay.com/Devzone/business-policies/CallRef/types/CategoryGroups.html) Calls that use CategoryGroup: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ default ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) **Important:** This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#default) to learn which calls use default. ETRS ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This flag is returned as 'true' if the corresponding business policy meets all eBay Top-Rated Listing requirements for the category group. To qualify as an ETRS business policy, the seller must meet Top-Rated Seller requirements, and the business policy must include a 14-day (or longer) money back return policy and same-day or one-day handling. For more information on Top-Rated Seller and Top-Rated Plus listings, see the [Becoming a Top Rated Seller and qualifying for Top Rated Plus](http://pages.ebay.com/help/sell/top-rated.html) help topic. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#ETRS) to learn which calls use ETRS. name ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This string value indicates the name of the category group to which the corresponding business policy applies. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#name) to learn which calls use name. --- # ShippingMethodEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ShippingMethodEnum ================== This enumerated type lists the values that indicate whether the buyer/seller used an eBay shipping label or arranged for shipping on their own. Type that uses ShippingMethodEnum: [ShipmentTrackingType](https://developer.ebay.com/Devzone/post-order/types/ShipmentTrackingType.html) Calls that use one or more values of ShippingMethodEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | SELF\_MAIL | This enumeration value indicates that the buyer or seller handled the shipping of an item on their own, and did not use an eBay shipping label. | | SHIPPING\_LABEL | This enumeration value indicates that the buyer or seller used an eBay shipping label to ship an item. | | UNKNOWN | This enumeration value indicates it is unknown whether the buyer or seller used an eBay shipping label to ship an item, or handled the shipping on their own. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # FundingMethodTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FundingMethodTypeEnum ===================== This enumeration type lists the possible funding methods that can be used by eBay to fund a seller's refund to a buyer. Types that use FundingMethodTypeEnum: [FundingSource](https://developer.ebay.com/Devzone/post-order/types/FundingSource.html) , [FundingSourceType](https://developer.ebay.com/Devzone/post-order/types/FundingSourceType.html) Calls that use one or more values of FundingMethodTypeEnum: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AVAILABLE\_FUNDS | This enumeration value indicates that the refund will be funded by the seller's available payout funds that have not yet been deposited into the seller's bank account. | | CREDIT\_CARD | This enumeration value indicates that the seller's credit card will be used to fund the buyer's refund. | | DIRECT\_DEBIT | This enumeration value indicates that the seller's bank account on file will be debited to fund the buyer's refund. | | PAY\_UPON\_INVOICE | This enumeration value indicates that the eBay will cover the buyer's refund, but will bill the seller through an invoice. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # URIValue - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) URIValue ======== This class holds a URL value Types that use URIValue: [StockPhotoURL](https://developer.ebay.com/devzone/product/CallRef/types/StockPhotoURL.html) , [Value](https://developer.ebay.com/devzone/product/CallRef/types/Value.html) Calls that use URIValue: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Field ----- value ( _[anyURI](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#anyURI) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#value) to learn which calls use value. --- # ReturnPayoutRecoupInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnPayoutRecoupInfoType ========================== This type provides the amount of money that eBay needs to recoup from the seller to fund a buyer refund and the unique identifier of the seller payout that is associated with the purchase of the line item. Type that uses ReturnPayoutRecoupInfoType: [ReturnDetailType](https://developer.ebay.com/Devzone/post-order/types/ReturnDetailType.html) Calls that use ReturnPayoutRecoupInfoType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ amountToRecoup ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount of money that eBay needs to recoup from the seller to fund a buyer refund. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#amountToRecoup) to learn which calls use amountToRecoup. payoutId ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) A unique eBay-assigned ID that identifies the seller payout that is associated with the purchase of the line item. The seller payout that is associated with the purchase of the line item will often by used as the funding source if payout funds are still available. The seller's funding source for a buyer refund is shown in the **fundingSource.type** field. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#payoutId) to learn which calls use payoutId. --- # FileFormatEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FileFormatEnum ============== This enumerated type lists the file types that can be used for files that are associated with a return request or return request draft. Type that uses FileFormatEnum: [ReturnFileType](https://developer.ebay.com/Devzone/post-order/types/ReturnFileType.html) Calls that use one or more values of FileFormatEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BMP | This enumeration value indicates that the file format extension of the file is .BMP (Bitmap file). | | GIF | This enumeration value indicates that the file format extension of the file is .GIF. | | JPEG | This enumeration value indicates that the file format extension of the file is .JPEG. | | JPG | This enumeration value indicates that the file format extension of the file is .JPG. | | PNG | This enumeration value indicates that the file format extension of the file is .PNG (Portable Network Graphics file). | | UNKNOWN | This enumeration value indicates that the file format extension of the file isunknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ProductResponse - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ProductResponse =============== Container for product information returned by product search calls. Type that uses ProductResponse: [FindProductsResponse](https://developer.ebay.com/devzone/product/CallRef/types/FindProductsResponse.html) Call that uses ProductResponse: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) Fields ------ invocationId ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) A unique identifer for a given product response, corresponding to a specific product request. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#invocationId) to learn which calls use invocationId. paginationOutput ( _[PaginationOutput](https://developer.ebay.com/devzone/product/CallRef/types/PaginationOutput.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Indicates the pagination of the result set. Child elements indicate the maximum number of productSearchResult nodes returned per response and which page of data has been returned. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#paginationOutput) to learn which calls use paginationOutput. products ( _[Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Container for multiple products. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#products) to learn which calls use products. --- # CaseTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CaseTypeEnum ============ This enumeration type lists the types of cases that may be created by the buyer or seller. Type that uses CaseTypeEnum: [CaseDetailsResponse](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html) Call that uses one or more values of CaseTypeEnum: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ITEM\_NOT\_RECEIVED | This enumeration value indicates that the case was created by the buyer because the item wasn't received within the expected delivery window. INR inquiries can also be escalated to INR cases. | | RETURN | This enumeration value indicates that the case was created after a return request was escalated by the buyer or seller. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # RefundType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RefundType ========== This enumeration type contains the possible types of refunds - partial or full. Type that uses RefundType: [CaseDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html) Call that uses one or more values of RefundType: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FULL | This enumeration value indicates that the buyer is scheduled to, or has already received a full refund. | | OTHER | This enumeration value indicates that it is unknown whether the buyer is scheduled to, or has already received a full or a partial refund. | | PARTIAL | This enumeration value indicates that the buyer is scheduled to, or has already received a partial refund |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnHoldStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnHoldStatusEnum ==================== This enumerated type lists the possible states of a return request that has been put on hold. Type that uses ReturnHoldStatusEnum: [ReturnHoldInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnHoldInfoType.html) Calls that use one or more values of ReturnHoldStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | HOLD\_CREATION\_SUCCESS | This enumeration value indicates that the hold placed on the return request was created successfully. | | HOLD\_RELEASE\_FAILED | This enumeration value indicates that the attempt to release the hold on the return request failed. | | HOLD\_RELEASE\_SUCCESS | This enumeration value indicates that the hold on the return request was released successfully. | | INELIGIBLE\_TO\_RELEASE\_HOLD | This enumeration value indicates that the hold on the return request is not yet eligible to be released. | | OTHER | This enumeration value indicates that the status of the hold on the return request is not classified or is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnPolicyInfo - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ReturnPolicyInfo ================ Type defining the **returnPolicyInfo** container, which consists of detailed information on a seller's return policy. Type that uses ReturnPolicyInfo: [ReturnPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfile.html) Calls that use ReturnPolicyInfo: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [description](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#description) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [holidayReturns](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#holidayReturns) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [refundOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#refundOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [restockingFeeValue](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#restockingFeeValue) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [returnsAcceptedOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#returnsAcceptedOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [returnsWithinOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#returnsWithinOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [shippingCostPaidByOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#shippingCostPaidByOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [warrantyDurationOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#warrantyDurationOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [warrantyOfferedOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#warrantyOfferedOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [warrantyTypeOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html#warrantyTypeOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) description ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored): * Germany (DE) * Spain (ES) * France (FR) * Italy (IT) Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML and avoid character entity references (such as £ or £). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £). See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#description) to learn which calls use description. holidayReturns ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports holiday returns. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#holidayReturns) to learn which calls use holidayReturns. refundOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field indicates how the seller compensates buyers for [remorse returns](https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/post-order-returns.html#return-reasons) . You must set this value to `MoneyBack` for all eBay marketplaces except for the US marketplace. On `EBAY_US`: You can set this value to either `MoneyBack` or `MoneyBackOrReplacement`. If a seller has the depth of inventory to support an exchange for an identical item, you can set `MoneyBackOrReplacement`. Otherwise, eBay recommends you set this value to its default value, `MoneyBack`. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#refundOption) to learn which calls use refundOption. restockingFeeValue ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports restocking fees for returned items. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#restockingFeeValue) to learn which calls use restockingFeeValue. returnsAcceptedOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This required field indicates whether or not the seller accepts returns. Applicable values are `ReturnsAccepted` or `ReturnsNotAccepted`. When set to `ReturnsAccepted`, this option indicates the seller allows items to be returned. Specify **ReturnsNotAccepted** for an item if the seller does not accept returns. On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call **GetUser** to determine the status of an eBay business seller in DE, IE, and UK. Review the **User.SellerInfo.SellerBusinessType** field in the response. **Note:** In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (**returnsAcceptedOption** = `ReturnsAccepted`) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the **Item.DispatchTimeMax** field. Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the [Becoming a Top Rated Seller and qualifying for Top Rated Plus](http://pages.ebay.com/help/sell/top-rated.html) page. **For setSellerProfile:** Updating the values in a business profile can effect the profiles in currently-listed items. In most cases, the updates made to a business policy can be streamlined into existing listings. However, if you update a business policy and the policy is invalid in the category where an item is listed, no error will be thrown and the policy will carry through the regular life of the listing. Sellers will be unable to re-list an item if it refers an invalid policy. Also note eBay will not update the policy's of a description if the listing has bids or sales, or if the listing ends within 12 hours. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnsAcceptedOption) to learn which calls use returnsAcceptedOption. returnsWithinOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if **ReturnsAcceptedOption=ReturnsAccepted**. **Applicable values:** Retrieve the values supported by a marketplace by calling **GeteBayDetails** with **DetailName** set to `ReturnPolicyDetails`, then review **ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption** in the response. **Note:** In version 1.1.0, the options for this field were reduced. An error will be thrown if you attempt to list an item with invalid business policy settings. See the [Release Notes](https://developer.ebay.com/Devzone/business-policies/CallRef//devzone/business-policies/releasenotes.html#v1.1.0) for details. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnsWithinOption) to learn which calls use returnsWithinOption. shippingCostPaidByOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are `Buyer` or `Seller`. eBay sites often set `Seller` as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if **ReturnsAcceptedOption=ReturnsAccepted**. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Use **GeteBayDetails** (with **DetailName=ReturnPolicyDetails**) and review the returned **ReturnPolicyDetails.ShippingCostPaidBy** values to see the values supported by a marketplace. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingCostPaidByOption) to learn which calls use shippingCostPaidByOption. warrantyDurationOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#warrantyDurationOption) to learn which calls use warrantyDurationOption. warrantyOfferedOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#warrantyOfferedOption) to learn which calls use warrantyOfferedOption. warrantyTypeOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#warrantyTypeOption) to learn which calls use warrantyTypeOption. --- # ReturnShippingCostType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnShippingCostType ====================== This enumerated type lists the types of shipping costs, including the cost of the shipping label, shipping insurance, and certified shipping. Type that uses ReturnShippingCostType: [ItemizedReturnShippingCostType](https://developer.ebay.com/devzone/post-order/types/ItemizedReturnShippingCostType.html) Calls that use one or more values of ReturnShippingCostType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | INSURANCE | This enumeration value indicates that the shipping cost is the price of shipping insurance to ship the return item. | | LABEL\_COST | This enumeration value indicates that the shipping cost is the price of the shipping label for the return item. | | OTHER | This enumeration value indicates that the shipping cost is not classified or is not known. | | SIGNATURE\_CONFIRMATION\_COST | This enumeration value indicates that the shipping cost is the price to ship the return item using certified shipping. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ErrorMessage - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ErrorMessage ============ Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault. Type that uses ErrorMessage: [BaseServiceResponse](https://developer.ebay.com/devzone/product/CallRef/types/BaseServiceResponse.html) Calls that use ErrorMessage: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Field ----- error ( _[ErrorData](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Details about a single error. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#error) to learn which calls use error. --- # ReturnStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnStatusEnum ================ This enumeration type lists the possible statuses for a return request. Type that uses ReturnStatusEnum: [ReturnSummaryType](https://developer.ebay.com/Devzone/post-order/types/ReturnSummaryType.html) Calls that use one or more values of ReturnStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CLOSED | This enumeration value indicates that the return request has been closed | | ESCALATED | This enumeration value indicates that the return request has been escalated to a return case. | | ITEM\_DELIVERED | This enumeration value indicates that the return request item has been delivered to the seller. | | ITEM\_SHIPPED | This enumeration value indicates that the return request item has been shipped by the buyer. | | LESS\_THAN\_A\_FULL\_REFUND\_ISSUED | This enumeration value indicates that a partial buyer refund was issued by the seller. | | PARTIAL\_REFUND\_DECLINED | This enumeration value indicates that the buyer has declined the partial refund amount that the seller has proposed. | | PARTIAL\_REFUND\_FAILED | This enumeration value indicates that the partial refund operation has failed. | | PARTIAL\_REFUND\_INITIATED | This enumeration value indicates that a partial refund to the buyer has been initiated by the seller. | | PARTIAL\_REFUND\_REQUESTED | This enumeration value indicates that a partial refund has been requested by the buyer. | | READY\_FOR\_SHIPPING | This enumeration value indicates that the return request item is ready to be shipped back by the buyer to the seller. | | REPLACED | This enumeration value indicates that the buyer has acknowledged the receipt of the replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_CLOSED | This enumeration value indicates that the replacement item has been received and the return request has been closed.

**Note:** This value is not currently supported. | | REPLACEMENT\_DELIVERED | This enumeration value indicates that the replacement item has been delivered to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_LABEL\_REQUESTED | This enumeration value indicates that the seller has requested a shipping label for the replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_REQUESTED | This enumeration value indicates that the buyer has requested a replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_SHIPPED | This enumeration value indicates that the replacement item has been shipped to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_STARTED | This enumeration value indicates that the process for the seller to send a replacement item to the buyer has started. | | REPLACEMENT\_WAITING\_FOR\_RMA | This enumeration value indicates that the seller still needs to provide a Return Merchandise Authorization (RMA) number for the replacement item.

**Note:** This value is not currently supported. | | RETURN\_LABEL\_REQUESTED | This enumeration value indicates that the buyer has requested a return shipping label. | | RETURN\_REJECTED | This enumeration value indicates that the buyer's return request has been rejected by the seller. | | RETURN\_REQUESTED | This enumeration value indicates that a return request has been initiated by the buyer. | | RETURN\_REQUESTED\_TIMEOUT | This enumeration value indicates that a return request has been initiated by the buyer, but the system has timed out. | | UNKNOWN | This enumeration value indicates that the current status of the return request is unknown. | | WAITING\_FOR\_RETURN\_LABEL | This enumeration value indicates that the return request is currently waiting for an eBay return shipping label to be available. | | WAITING\_FOR\_RMA | This enumeration value indicates that the return request is currently waiting for the seller to provide a Return Merchandise Authorization (RMA) number to the buyer. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # FileFormatEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FileFormatEnum ============== This enumerated type lists the file types that can be used for files that are associated with a return request or return request draft. Type that uses FileFormatEnum: [ReturnFileType](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html) Calls that use one or more values of FileFormatEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BMP | This enumeration value indicates that the file format extension of the file is .BMP (Bitmap file). | | GIF | This enumeration value indicates that the file format extension of the file is .GIF. | | JPEG | This enumeration value indicates that the file format extension of the file is .JPEG. | | JPG | This enumeration value indicates that the file format extension of the file is .JPG. | | PNG | This enumeration value indicates that the file format extension of the file is .PNG (Portable Network Graphics file). | | UNKNOWN | This enumeration value indicates that the file format extension of the file isunknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # DesiredOutcomeTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) DesiredOutcomeTypeEnum ====================== This enumerated type lists the desired outcomes that the buyer may specify when creating an INR inquiry. Type that uses DesiredOutcomeTypeEnum: [CreateInquiryRequest](https://developer.ebay.com/devzone/post-order/types/CreateInquiryRequest.html) Call that uses one or more values of DesiredOutcomeTypeEnum: [/post-order/v2/inquiry POST](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FULL\_REFUND | This enumeration value indicates that the buyer no longer wants the item, and prefers a full refund from the seller instead. If this value is specified by the buyer, and the order line item still hasn't been shipped, the seller can use the **POST /post-order/v2/inquiry/{inquiryId}/issue\_refund** method to issue a refund to the buyer instead of fulfilling and shipping the order line item. | | STILL\_WANT\_ITEM | This enumeration value indicates that the buyer still wants the seller to ship the missing order line item. If this value is specified by the buyer, the seller should ship the order line item as soon as possible (to avoid the inquiry being escalated to a case), and then use the **POST /post-order/v2/inquiry/{inquiryId}/provide\_shipment\_info** method to provide shipment tracking information and inform the buyer that the order line item is on its way. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ErrorData - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ErrorData ========= A container for error details. Type that uses ErrorData: [ErrorMessage](https://developer.ebay.com/devzone/product/CallRef/types/ErrorMessage.html) Calls that use ErrorData: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ [category](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#category) ( _[ErrorCategory](https://developer.ebay.com/devzone/product/CallRef/types/ErrorCategory.html) _ ) [domain](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#domain) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [errorId](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#errorId) ( _[long](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#long) _ ) [exceptionId](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#exceptionId) ( _[token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) _ ) [message](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#message) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [parameter](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#parameter) ( _[ErrorParameter](https://developer.ebay.com/devzone/product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) )_ ) [severity](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#severity) ( _[ErrorSeverity](https://developer.ebay.com/devzone/product/CallRef/types/ErrorSeverity.html) _ ) [subdomain](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html#subdomain) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) category ( _[ErrorCategory](https://developer.ebay.com/devzone/product/CallRef/types/ErrorCategory.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) There are three categories of errors: request errors, application errors, and system errors. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#category) to learn which calls use category. domain ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Name of the domain in which the error occurred. **domain values:** Marketplace A business or validation error occurred in the service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#domain) to learn which calls use domain. errorId ( _[long](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#long) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#errorId) to learn which calls use errorId. exceptionId ( _[token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Unique identifier for an exception associated with an error. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#exceptionId) to learn which calls use exceptionId. message ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) A detailed description of the condition that caused in the error. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#message) to learn which calls use message. parameter ( _[ErrorParameter](https://developer.ebay.com/devzone/product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) )_ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#parameter) to learn which calls use parameter. severity ( _[ErrorSeverity](https://developer.ebay.com/devzone/product/CallRef/types/ErrorSeverity.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) 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, re-send 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. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#severity) to learn which calls use severity. subdomain ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Name of the subdomain in which the error occurred. **subdomain values:** MarketplaceCatalog The error is specific to the Marketplace Catalog subdomain. MarketplaceCommon The error is common to all Marketplace services. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#subdomain) to learn which calls use subdomain. --- # InquirySummaryType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) InquirySummaryType ================== This type is used to provide a summary of information on each INR inquiry that is returned in the **GET /post-order/v2/inquiry/search** response. Type that uses InquirySummaryType: [InquirySearchResponse](https://developer.ebay.com/devzone/post-order/types/InquirySearchResponse.html) Call that uses InquirySummaryType: [/post-order/v2/inquiry/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry_search__get.html) Fields ------ [buyer](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#buyer) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [claimAmount](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#claimAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [inquiryId](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#inquiryId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [inquiryStatusEnum](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#inquiryStatusEnum) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [itemId](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#itemId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [lastModifiedDate](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#lastModifiedDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [respondByDate](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#respondByDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [seller](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#seller) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [transactionId](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html#transactionId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) buyer ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The eBay user ID of the buyer involved in the INR inquiry. **Note:** Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to [Data Handling Compliance](https://developer.ebay.com/devzone/post-order//api-docs/static/data-handling-update.html) . See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyer) to learn which calls use buyer. claimAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container displays the dollar value of the order line item associated with the INR inquiry, which is generally the amount of the refund that the buyer will receive if the buyer is looking for a refund, or if the seller voluntarily refunds the buyer. **Note:** There's a possibility that this value can be inaccurate if the buyer passed in an inaccurate value into the **claimQuantity** field when the INR inquiry was created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#claimAmount) to learn which calls use claimAmount. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This timestamp indicates when the INR inquiry was created by the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. inquiryId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryId) to learn which calls use inquiryId. inquiryStatusEnum ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the INR inquiry. If the value is `WAITING_SELLER_RESPONSE` or `WAITING_BUYER_RESPONSE`, the seller or buyer, respectively, should make sure they respond no later than the date and time found in the **respondByDate** container. The list of enumeration values that may be returned in this field are defined in the [InquiryStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/InquiryStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryStatusEnum) to learn which calls use inquiryStatusEnum. itemId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the **transactionId** field to identify a line item that has not been received by the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemId) to learn which calls use itemId. lastModifiedDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This timestamp indicates when the last action was performed on the INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastModifiedDate) to learn which calls use lastModifiedDate. respondByDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This timestamp indicates the deadline for when a buyer or a seller must perform the next action on the INR inquiry. This field will only be returned if there is a deadline associated with the next action. This 'deadline' will apply to the seller if the **inquiryStatusEnum** value is `WAITING_SELLER_RESPONSE`, or will apply to the buyer if the **inquiryStatusEnum** value is `WAITING_BUYER_RESPONSE`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#respondByDate) to learn which calls use respondByDate. seller ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The eBay user ID of the seller involved in the INR inquiry. **Note:** Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to [Data Handling Compliance](https://developer.ebay.com/devzone/post-order//api-docs/static/data-handling-update.html) . See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#seller) to learn which calls use seller. transactionId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the purchase transaction. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the **itemId** field to identify a line item that has not been received by the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionId) to learn which calls use transactionId. --- # PropertyNameValue - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) PropertyNameValue ================= Container type for property name value pairs. Types that use PropertyNameValue: [GetProductSearchValuesResponse](https://developer.ebay.com/devzone/product-metadata/CallRef/types/GetProductSearchValuesResponse.html) , [PropertyNameValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/PropertyNameValue.html) Calls that use PropertyNameValue: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ childPropertyNameValue ( _[PropertyNameValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/PropertyNameValue.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Property name value pairs that are children to other properties. Only returned when the response is returned as a propertyValuesTree. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#childPropertyNameValue) to learn which calls use childPropertyNameValue. propertyName ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#propertyName) to learn which calls use propertyName. value ( _[Value](https://developer.ebay.com/devzone/product-metadata/CallRef/types/Value.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) A value for the property. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#value) to learn which calls use value. --- # FreightShipping - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) FreightShipping =============== Type defining the **freightShipping** container, which consists of details related to freight shipping. This container is required to be set in a shipping policy if the seller offers freight shipping. Type that uses FreightShipping: [ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) Calls that use FreightShipping: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [commodityType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#commodityType) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [destPickupInside](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#destPickupInside) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [destPickupLocationType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#destPickupLocationType) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [freightShippingClass](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#freightShippingClass) ( _[double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) _ ) [originPickupInside](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#originPickupInside) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [originPickupLocationType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#originPickupLocationType) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [packagingHelpRequired](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html#packagingHelpRequired) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) commodityType ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) A string value classifying the freight item to be shipped. Valid values for this field include: * MACHINERY\_USED * MACHINERY\_NEW * FRAGILE\_HOUSEHOLD\_USED * FRAGILE\_HOUSEHOLD\_NEW * NON\_FRAGILE\_HOUSEHOLD\_USED * NON\_FRAGILE\_HOUSEHOLD\_NEW * RESTAURANT\_EQUIPMENT\_USED * RESTAURANT\_EQUIPMENT\_NEW * COMPUTER\_ELECTRONICS\_USED * COMPUTER\_ELECTRONICS\_NEW * VENDING\_MACHINE\_USED * VENDING\_MACHINE\_NEW * MOTORCYCLE\_USED * MOTORCYCLE\_NEW This is a required field if freight shipping is included in the shipping policy. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#commodityType) to learn which calls use commodityType. destPickupInside ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Flag indicating if the freight item will be dropped off inside or outside of the delivery location. If this value is 'true', the item will be dropped off inside of the delivery location, and if 'false', the item will be dropped off outside of the delivery location. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#destPickupInside) to learn which calls use destPickupInside. destPickupLocationType ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) String value indicating whether the freight item is being delivered to a residence or to a commercial location. Valid values are 'Residential' and 'Commercial'. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#destPickupLocationType) to learn which calls use destPickupLocationType. freightShippingClass ( _[double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Value indicating the shipping class of the freight item. The shipping class corresponds to the weight of the item (in pounds). Valid values include '50.0', '55.0', '60.0', '65.0', '70.0', '77.5', '85.0', '92.5', '100.0', '110.0', '125.0', '150.0', '175.0', '200.0', '225.0', '250.0', '300.0', '400.0', and '500.0'. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#freightShippingClass) to learn which calls use freightShippingClass. originPickupInside ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Flag indicating if the freight item will be picked up inside or outside of the pickup location. If this value is 'true', the item will be picked up inside of the pickup location, and if 'false', the item will be picked up outside of the pickup location. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#originPickupInside) to learn which calls use originPickupInside. originPickupLocationType ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) String value indicating whether the freight item is being picked up from a residence or from a commercial location. Valid values are 'Residential' and 'Commercial'. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#originPickupLocationType) to learn which calls use originPickupLocationType. packagingHelpRequired ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Flag indicating if help is required to pick up the freight item. If this value is 'true', help picking up the item is required, and if 'false', help picking up the item is not required. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#packagingHelpRequired) to learn which calls use packagingHelpRequired. --- # FileStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FileStatusEnum ============== This enumerated type contains the possible states that a return-associated file can be in. Type that uses FileStatusEnum: [ReturnFileType](https://developer.ebay.com/Devzone/post-order/types/ReturnFileType.html) Calls that use one or more values of FileStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CREATED | This enumeration value indicates that the file has been created, but has yet to be associated with a return request or draft. | | DELETED | This enumeration value indicates that the file has been removed, or unassociated with a return request or draft. | | PUBLISHED | This enumeration value indicates that the file has been associated with a return request or draft. | | UNKNOWN | This enumeration value indicates that the status of the file is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # UserPartyEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) UserPartyEnum ============= This enumerated type lists the types of users who can possibly perform an action on an INR inquiry or a case. Types that use UserPartyEnum: [CaseDetailsResponse](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html) , [ClaimHistoryEventModel](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html) , [InquiryDetailsResponse](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html) Calls that use one or more values of UserPartyEnum: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This enumeration value indicates that the initiator of the action is the buyer. | | CSR | This enumeration value indicates that the initiator of the action is an eBay customer support representative. | | SELLER | This enumeration value indicates that the initiator of the action is the seller. | | SYSTEM | This enumeration value indicates that the initiator of the action is the eBay system. | | UNKNOWN | This enumeration value indicates that the initiator of the action cannot be determined. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # PaginationOutput - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) PaginationOutput ================ Shows the pagination data for the item search. Child elements include the page number returned, the maximum entries returned per page, the total number of pages that can be returned, and the total number of entries that match the search criteria. Types that use PaginationOutput: [GetProductCompatiblitiesResponse](https://developer.ebay.com/devzone/product/CallRef/types/GetProductCompatiblitiesResponse.html) , [ProductResponse](https://developer.ebay.com/devzone/product/CallRef/types/ProductResponse.html) Calls that use PaginationOutput: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) Fields ------ entriesPerPage ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage. The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#entriesPerPage) to learn which calls use entriesPerPage. pageNumber ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data. This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set. The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#pageNumber) to learn which calls use pageNumber. totalEntries ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The total number of entries found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any entries that match the search criteria. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#totalEntries) to learn which calls use totalEntries. totalPages ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any entries that match the search criteria. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#totalPages) to learn which calls use totalPages. --- # ShippingPolicyInfo - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ShippingPolicyInfo ================== Type defining the **shippingPolicyInfo** container, which consists of detailed information for a seller's shipping policy. Type that uses ShippingPolicyInfo: [ShippingPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfile.html) Calls that use ShippingPolicyInfo: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [dispatchTimeMax](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#dispatchTimeMax) ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [dispatchTimeReason](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#dispatchTimeReason) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [domesticRateTable](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#domesticRateTable) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [domesticShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#domesticShippingPolicyInfoService) ( _[ShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html) _ ) [domesticShippingType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#domesticShippingType) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [EligibleForPickupDropOff](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#EligibleForPickupDropOff) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [excludeShipToLocation](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#excludeShipToLocation) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [freightShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#freightShipping) ( _[FreightShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html) _ ) [GlobalShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#GlobalShipping) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [insurance](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#insurance) ( _[Insurance](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Insurance.html) _ ) [internationalPackagingHandlingCosts](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#internationalPackagingHandlingCosts) ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [intlRateTable](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#intlRateTable) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [intlShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#intlShippingPolicyInfoService) ( _[ShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html) _ ) [intlShippingType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#intlShippingType) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [packagingHandlingCosts](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#packagingHandlingCosts) ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [shippingOption](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#shippingOption) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [shippingPolicyCurrency](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#shippingPolicyCurrency) ( _[IsoCurrencyCode](https://developer.ebay.com/Devzone/business-policies/CallRef/types/IsoCurrencyCode.html) _ ) [shippingPolicyIdentity](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#shippingPolicyIdentity) ( _ShippingPolicyIdentity_ ) [shippingPolicyName](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#shippingPolicyName) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [shippingProfileDiscountInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#shippingProfileDiscountInfo) ( _[ShippingProfileDiscountInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingProfileDiscountInfo.html) _ ) [shipToLocations](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html#shipToLocations) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) dispatchTimeMax ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment for an order. This time does not include the shipping time (the carrier's transit time). Valid values can vary by site and by category. To obtain supported values for a site, call **GeteBayDetails**, using **DispatchTimeMaxDetails** as a **DetailName** value in the request, and then look at the **DispatchTimeMaxDetails** container in the response for supported values for the site. Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results. To offer zero-day or one-day handling, the seller should include the **dispatchTimeMax** field in the shipping business policy and set the value of this field to '0' or '1', respectively. The **dispatchTimeMax** field must be included in the shipping policy and set to '0' or '1' if the **fastShipping** flag is included and set to 'true' in the shipping policy. **Note:** Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a **DispatchTimeMax** value of '0' to indicate that no handling time is specified for the listing. However, with the onboarding of same-day shipping, a **DispatchTimeMax** value of '0' will indicate that the seller is offering same-day shipping. Now, sellers that do not want to specify a handling time for their shipping policy, should omit the **dispatchTimeMax** field, or they can include it but set it to null. This field is always returned with all shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#dispatchTimeMax) to learn which calls use dispatchTimeMax. dispatchTimeReason ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This free-form string field is used by the seller to provide more details to the buyer about handling time. If set for the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#dispatchTimeReason) to learn which calls use dispatchTimeReason. domesticRateTable ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for **domesticRateTable** is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced. Including this field in an **addSellerProfile** or **setSellerProfile** call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined. If set for the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domesticRateTable) to learn which calls use domesticRateTable. domesticShippingPolicyInfoService ( _[ShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container that consists of detailed information for a domestic shipping service, including shipping costs, ship-to locations, and flags to indicate Fast and/or Free shipping. Up to four domestic shipping service options can be specified in one shipping business policy. Each specified domestic shipping service is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domesticShippingPolicyInfoService) to learn which calls use domesticShippingPolicyInfoService. domesticShippingType ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) The domestic shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an **addSellerProfile** or **setSellerProfile** call, it defaults to 'Flat' shipping. If 'FreightFlat' is specified as the domestic shipping type, the **freightShipping** container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the **CalculatedShippingRate** container must be used when listing, revising, or relisting an item through the Trading API. This field is always returned with all shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domesticShippingType) to learn which calls use domesticShippingType. EligibleForPickupDropOff ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID 3). In addition to setting the **EligibleForPickupDropOff** boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing: * Have inventory for the product at one or more physical stores tied to the merchant's account * Set an immediate payment requirement on the item. The immediate payment feature requires the seller to include the **paymentInfo.immediatePay** flag in the payment business policy and set its value to 'true' When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#EligibleForPickupDropOff) to learn which calls use EligibleForPickupDropOff. excludeShipToLocation ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Sellers can use this field to exclude one or more international regions, countries, or special domestic locations (such as 'PO Box' in US or 'Packstation' in Germany) as possible shipping locations. To obtain valid 'exclude Ship-To locations', the seller must call **GeteBayDetails**, using **ExcludeShipppingLocationDetails** as a **DetailName** value in the request, and then scan the **ExcludeShippingLocationDetails.Location** values that are returned in the response. The seller may include as many valid **excludeShipToLocation** values as necessary based on where they are not willing to ship an item. If a buyer's primary ship-to location is a location that the seller has listed as an excluded ship-to location, that buyer will receive an error message if they attempt to buy or place a bid on your item. This field works in conjunction with the **shipToLocation** values to create a set of international regions, countries, and domestic locations to where the seller will (and will not) ship. You can list a region in the **shipToLocation** field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a **shipToLocation** value, yet exclude Egypt by including an **excludeShipToLocation** field with its value set to 'EG', which is Egypt's two-digit country code. In addition, if a seller used only one **shipToLocation** value and set it to 'Worldwide', that seller can use one or more **excludeShipToLocation** fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations. Each excluded ship-to location is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#excludeShipToLocation) to learn which calls use excludeShipToLocation. freightShipping ( _[FreightShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/FreightShipping.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container consists of details related to freight shipping. This container and its values are required to be set in a shipping policy if the seller offers freight shipping (**domesticShippingType** and/or **intlShippingType** is set to 'FreightFlat'). If freight shipping is specified for a shipping policy, this container is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#freightShipping) to learn which calls use freightShipping. GlobalShipping ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) **Note:** On the US marketplace, the **Global Shipping Program** is scheduled to be replaced by a new intermediated international shipping program called **eBay International Shipping**. US Sellers opted in to the **Global Shipping Program** will automatically get opted into **eBay International Shipping** once it becomes available to them. All US sellers will be migrated by March 31, 2023. **eBay International Shipping** is an account level setting, and no field will need to be set in a Fulfillment business policy to enable this setting. As long as the US seller's account is opted in to **eBay International Shipping**, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into **eBay International Shipping**, that same seller can still also specify individual international shipping service options for a Fulfillment business policy. This flag should be included and set to 'true' if the seller wants to enable the **Global Shipping Program** feature in the shipping policy. If the value of **globalShipping** is 'true', the **Global Shipping Program** is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of **GlobalShipping** is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally). To make use of this field and the Global Shipping Program, the seller and the item being listed must be eligible for the Global Shipping Program. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#GlobalShipping) to learn which calls use GlobalShipping. insurance ( _[Insurance](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Insurance.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container consists of the type and cost of domestic and international shipping insurance. The **insurance** container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer. If shipping insurance options are specified for a shipping policy, this container is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#insurance) to learn which calls use insurance. internationalPackagingHandlingCosts ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field allows the seller to add package handling costs for shipping an item to an international location. If set for the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#internationalPackagingHandlingCosts) to learn which calls use internationalPackagingHandlingCosts. intlRateTable ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) **Note:** International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites. This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for **intlRateTable** is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced. Including this field in an **addSellerProfile** or **setSellerProfile** call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined. If set for the shipping policy (Germany and UK only), this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#intlRateTable) to learn which calls use intlRateTable. intlShippingPolicyInfoService ( _[ShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container that consists of detailed information for an international shipping service, including shipping costs and ship-to locations. Up to five international shipping service options can be specified in one shipping policy. Each specified international shipping service is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#intlShippingPolicyInfoService) to learn which calls use intlShippingPolicyInfoService. intlShippingType ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) The international shipping cost model used by the seller. Valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an **addSellerProfile** or **setSellerProfile** call, it defaults to 'Flat' shipping. If 'FreightFlat' is specified as the international shipping type, the **freightShipping** container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the **CalculatedShippingRate** container must be used when listing, revising, or relisting an item through the Trading API. This field is always returned with all shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#intlShippingType) to learn which calls use intlShippingType. packagingHandlingCosts ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field allows the seller to add package handling costs for shipping an item to a domestic location. If set for the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#packagingHandlingCosts) to learn which calls use packagingHandlingCosts. shippingOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This optional field helps summarize the locations/regions that the seller will ship an item to. The integer value that is used in this field for an **addSellerProfile** or **setSellerProfile** call should be in synch with the values that are specified in the **shipToLocation** and **excludeShipToLocation** fields used in the same call. The possible values are listed below: * 0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site). * 1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the **shipToLocation** field. * 2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an **excludeShipToLocation** field. * 3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle. * 4 ('TermsAndConditionsOnly'): this value is for future use. If set for the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingOption) to learn which calls use shippingOption. shippingPolicyCurrency ( _[IsoCurrencyCode](https://developer.ebay.com/Devzone/business-policies/CallRef/types/IsoCurrencyCode.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call **GeteBayDetails**, using **CurrencyDetails** as a **DetailName** value in the request, and then scanning the **CurrencyDetails.Currency** values that are returned in the response. If this field is not included in an **addSellerProfile** or **setSellerProfile** call, the currency code will default to the standard currency used by the listing site. This field is always returned with all shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingPolicyCurrency) to learn which calls use shippingPolicyCurrency. shippingPolicyIdentity ( _ShippingPolicyIdentity_ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This container is for future use. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingPolicyIdentity) to learn which calls use shippingPolicyIdentity. shippingPolicyName ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This string value indicates the name of the shipping policy. This business policy name must be unique among all of seller's shipping policies. A **shippingPolicyName** value is required when using the **addSellerProfile** and **setSellerProfile** calls to create or update a shipping policy. This field is always returned with all shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingPolicyName) to learn which calls use shippingPolicyName. shippingProfileDiscountInfo ( _[ShippingProfileDiscountInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingProfileDiscountInfo.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of flat-rate or calculated shipping discount profile IDs (that identify the shipping discount rules to apply when domestic and/or international buyers purchase multiple items), as well as flags indicating if promotional shipping discounts are offered to domestic and/or international buyers. Shipping discounts can be created by the seller through My eBay, or by using the **SetShippingDiscountProfiles** call of the Trading API. If shipping discounts are used for a shipping policy, this container is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingProfileDiscountInfo) to learn which calls use shippingProfileDiscountInfo. shipToLocations ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) An international region (such as Asia, Europe, or Latin America) or country (represented by two-letter country code) to where the seller will ship an item. It is not necessary to include the **shipToLocation** field in the **domesticShippingPolicyInfoService** container when using the **addSellerProfile** and **setSellerProfile** calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the **shipToLocation** field is always returned for each shipping policy in the **addSellerProfile**, **setSellerProfile**, and **getSellerProfiles** calls. If the seller does want to offer international shipping as part of the shipping policy, at least one **shipToLocation** field in the **internationalShippingPolicyInfoService** container is required when using the **addSellerProfile** and **setSellerProfile** calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a **shipToLocation** value. If the seller wants to offer shipping to one or more specific shipping regions, the seller must include that shipping region in a **shipToLocation** field. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should use one or more instances of the **shippingPolicyInfo.excludeShipToLocation** field. Applicable shipping region values are defined in **ShippingRegionCodeType** and applicable country codes are defined in **CountryCodeType**. However, it is best practice for sellers to call **GeteBayDetails**, using **ShipppingLocationDetails** as a **DetailName** value in the request, and then scanning the **ShippingLocationDetails.ShippingLocation** values that are returned in the response. Each specified ship-to location is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shipToLocations) to learn which calls use shipToLocations. --- # ErrorCategory - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ErrorCategory ( [token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) ) =========================================================================================================== There are three categories of error: request errors, application errors, and system errors. Request and application errors are often caused by passing invalid data in the request. System errors are primarily caused by application failures and cannot be corrected by changing request values. Type that uses ErrorCategory: [ErrorData](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html) Calls that use one or more values of ErrorCategory: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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 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. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # FundingMethodTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FundingMethodTypeEnum ===================== This enumeration type lists the possible funding methods that can be used by eBay to fund a seller's refund to a buyer. Types that use FundingMethodTypeEnum: [FundingSource](https://developer.ebay.com/devzone/post-order/types/FundingSource.html) , [FundingSourceType](https://developer.ebay.com/devzone/post-order/types/FundingSourceType.html) Calls that use one or more values of FundingMethodTypeEnum: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AVAILABLE\_FUNDS | This enumeration value indicates that the refund will be funded by the seller's available payout funds that have not yet been deposited into the seller's bank account. | | CREDIT\_CARD | This enumeration value indicates that the seller's credit card will be used to fund the buyer's refund. | | DIRECT\_DEBIT | This enumeration value indicates that the seller's bank account on file will be debited to fund the buyer's refund. | | PAY\_UPON\_INVOICE | This enumeration value indicates that the eBay will cover the buyer's refund, but will bill the seller through an invoice. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Applicable values for addSellerProfileRequest.shippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ### Applicable values for addSellerProfileRequest.shippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency AUD Australian Dollar; country - Australia; ISO currency code - 036 CAD Canadian Dollar; country - Canada; ISO currency code - 124 CHF Swiss Franc; country - Switzerland; ISO currency code - 756 CNY Chinese Yuan Renminbi; country - China; ISO currency code - 156 EUR Euro; entity - European Union; ISO currency code - 978 GBP Pound Sterling; country - United Kingdom; ISO currency code - 826 HKD Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 INR Indian Rupee; country - India; ISO currency code - 356 MYR Malaysian Ringgit; country - Malaysia; ISO currency code - 458 PHP Philippine Peso; country - Philippines; ISO currency code - 608 PLN Polish New Zloty; country - Poland; ISO currency code - 985 SEK Swedish Krona; country - Sweden; ISO currency code - 752 SGD Singapore Dollar; country - Singapore; ISO currency code - 702 TWD New Taiwan Dollar; country - Taiwan; ISO currency code - 901 USD U.S. Dollar; country - United States; ISO currency code - 840 --- # ErrorParameter - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ErrorParameter ( [string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) ) ============================================================================================================== Contextual data associated with an error. Type that uses ErrorParameter: [ErrorData](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html) Calls that use ErrorParameter: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ This type has no fields. Attribute --------- name ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. --- # ErrorSeverity - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ErrorSeverity ( [token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) ) =========================================================================================================== Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. Type that uses ErrorSeverity: [ErrorData](https://developer.ebay.com/devzone/product/CallRef/types/ErrorData.html) Calls that use one or more values of ErrorSeverity: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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 case, 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. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # Insurance - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) Insurance ========= Type defining the **insurance** container, which contains the type and cost of domestic and international shipping insurance. The **insurance** container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer. Type that uses Insurance: [ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) Calls that use Insurance: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ domesticInsuranceFee ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This dollar value indicates the cost to the buyer to purchase domestic shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering domestic shipping insurance to the buyer, and the **domesticInsuranceOption** is 'Optional' or 'Required'. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domesticInsuranceFee) to learn which calls use domesticInsuranceFee. domesticInsuranceOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This string value indicates the seller's policy on offering domestic shipping insurance to the buyer. Valid values include: * **IncludedInShippingHandling**: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item * **NotOffered**: the seller does not offer shipping insurance to the buyer * **Optional**: purchasing shipping insurance for the item is at the discretion of the buyer * **Required**: the seller requires that the buyer purchase shipping insurance for the item This field is required if an AU, FR, or IT seller is offering domestic shipping insurance to the buyer. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domesticInsuranceOption) to learn which calls use domesticInsuranceOption. intlInsuranceFee ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This dollar value indicates the cost to the buyer to purchase international shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering international shipping insurance to the buyer, and the **internationalInsuranceOption** is 'Optional' or 'Required'. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#intlInsuranceFee) to learn which calls use intlInsuranceFee. intlInsuranceOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This string value indicates the seller's policy on offering international shipping insurance to the buyer. Valid values include: * **IncludedInShippingHandling**: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item * **NotOffered**: the seller does not offer shipping insurance to the buyer * **Optional**: purchasing shipping insurance for the item is at the discretion of the buyer * **Required**: the seller requires that the buyer purchase shipping insurance for the item This field is required if an AU, FR, or IT seller is offering international shipping insurance to the buyer. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#intlInsuranceOption) to learn which calls use intlInsuranceOption. --- # ShippingPolicyProfileList - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ShippingPolicyProfileList ========================= Type defining the **shipingPolicyProfile** container, which consists of one or more shipping policies that match the input criteria in the **getSellerProfiles** request. Type that uses ShippingPolicyProfileList: [GetSellerProfilesResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/GetSellerProfilesResponse.html) Call that uses ShippingPolicyProfileList: [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) Field ----- ShippingPolicyProfile ( _[ShippingPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfile.html) _ ) [\[1..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of one or more shipping policies that match the input criteria in the **getSellerProfiles** request. This container is not returned if no shipping policies match the input criteria. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#ShippingPolicyProfile) to learn which calls use ShippingPolicyProfile. --- # ShippingPolicyInfoService - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ShippingPolicyInfoService ========================= Type defining the **shippingPolicyInfoService** container, which consists of detailed information for a shipping service option being offered to the buyer. Type that uses ShippingPolicyInfoService: [ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) Calls that use ShippingPolicyInfoService: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [buyerResponsibleForPickup](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#buyerResponsibleForPickup) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [buyerResponsibleForShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#buyerResponsibleForShipping) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [codFee](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#codFee) ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [fastShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#fastShipping) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [freeShipping](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#freeShipping) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [shippingService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#shippingService) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [shippingServiceAdditionalCost](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#shippingServiceAdditionalCost) ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [shippingServiceCost](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#shippingServiceCost) ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [shippingSurcharge](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#shippingSurcharge) ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [shipToLocation](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#shipToLocation) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [sortOrderId](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html#sortOrderId) ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) buyerResponsibleForPickup ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#buyerResponsibleForPickup) to learn which calls use buyerResponsibleForPickup. buyerResponsibleForShipping ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#buyerResponsibleForShipping) to learn which calls use buyerResponsibleForShipping. codFee ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option. To see if a domestic shipping service option supports the Cash-on-Delivery option, call **GeteBayDetails**, including 'ShippingServiceDetails' as a **DetailName** value, and then look for a **CODService=true** flag for the corresponding shipping service. If a Cash-on-Delivery shipping service is defined for the shipping policy, this field is returned in the shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#codFee) to learn which calls use codFee. fastShipping ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This flag indicates whether or not the seller is offering 'Get It Fast' shipping for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option. To enable 'Get It Fast' shipping for a listing, the seller must: * offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight; * set the **shippingPolicyInfo.dispatchTimeMax** value to '0' or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. A **DispatchTimeMax** value of '0' will indicate that the seller is offering same-day shipping. Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment policy, this option is turned on with the **paymentInfo.immediatePay** flag. The **fastShipping** field should only be included and set to 'true' in **domesticShippingPolicyInfoService** containers where the shipping service option is a one-day shipping service. The **fastShipping** field is not applicable for **internationalShippingPolicyInfoService** containers. If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#fastShipping) to learn which calls use fastShipping. freeShipping ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This flag is used by the seller to offer free domestic shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a **sortOrderId** value of '1', or, if the **sortOrderId** field is not used, the shipping service option specified first in the API call. If free shipping is set for a domestic shipping service, this field is returned in the shipping business policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#freeShipping) to learn which calls use freeShipping. shippingService ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) A domestic or international shipping service being offered by the seller to ship an item to a buyer. For a list of valid **shippingService** values, call **GeteBayDetails**, including **ShippingServiceDetails** as a **DetailName** value, and then look through the **ShippingServiceDetails** containers returned in the response. International shipping services are marked with an **InternationalService** flag. All shipping services without this flag are domestic shipping services. The **ShippingServiceDetails.ValidForSellingFlow** flag must be present for both domestic and international shipping services, otherwise, thatspecific shipping service option is no longer valid and cannot be offered to buyers through a listing. The seller must specify one shipping service in each **domesticShippingPolicyInfoService** and **internationalShippingPolicyInfoService** container in an **addSellerProfile** or **setSellerProfile** request. Up to four domestic and five international shipping service may be offered to the buyer per listing. If 'Get It Fast' shipping is being enabled for the shipping policy (**fastShipping**\=true), the first specified domestic shipping service (specified in the first **domesticShippingPolicyInfoService.shippingService** field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call **GeteBayDetails**, including 'ShippingServiceDetails' as a **DetailName** value, and then look for a **ShippingCategory** value of 'ONE\_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. Each shipping service specified for the shipping policy is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingService) to learn which calls use shippingService. shippingServiceAdditionalCost ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used. This value is at the seller's discretion. Generally, it should be the same price or lower than the **shippingServiceCost** value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = **shippingServiceCost** + (**shippingServiceAdditionalCost** \* quantity purchased) So, if a buyer purchases four identical items, and the seller has specified **shippingServiceCost** as $6.00 and **shippingServiceAdditionalCost** as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)). This field is not applicable to calculated shipping. If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingServiceAdditionalCost) to learn which calls use shippingServiceAdditionalCost. shippingServiceCost ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping. This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the **freeShipping** field is set to 'true'. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = **shippingServiceCost** + (**shippingServiceAdditionalCost** \* quantity purchased) So, if a buyer purchases four identical items, and the seller has specified **shippingServiceCost** as $6.00 and **shippingServiceAdditionalCost** as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 \* 3)). This field is always returned (for each shipping service) with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingServiceCost) to learn which calls use shippingServiceCost. shippingSurcharge ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas. In order for sellers to add a shipping surcharge at the shipping service level, the following must be true: * a surcharge is applicable for the shipping service (call **GeteBayDetails** with **DetailName** set to **ShippingServiceDetails**, and then look for **ShippingServiceDetails.SurchargeApplicable=true** in the response; * flat-rate shipping is used If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingSurcharge) to learn which calls use shippingSurcharge. shipToLocation ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call **GeteBayDetails**, using **ShipppingLocationDetails** as a **DetailName** value in the request, and then scanning the **ShippingLocationDetails.ShippingLocation** values that are returned in the response. The shipping regions and countries that may be specified as **shipToLocation** values will vary according to eBay site. The seller may include as many valid **shipToLocation** values as necessary based on where they are willing to ship an item. If no **shipToLocation** field is included in the **domesticShippingPolicyInfoService** container when using the **addSellerProfile** or **setSellerProfile** calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'. If the seller does want to offer international shipping as part of the shipping policy, at least one **shipToLocation** field in the **internationalShippingPolicyInfoService** container is required when using the **addSellerProfile** and **setSellerProfile** calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a **shipToLocation** value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a **shipToLocation** value, but then exclude one or more countries in that region by including one or more instances of the **shippingPolicyInfo.excludeShipToLocation** field. Each ship-to location specified for the shipping service is returned with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shipToLocation) to learn which calls use shipToLocation. sortOrderId ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages. Sellers can specify up to four domestic shipping services (in four separate **domesticShippingPolicyInfoService** containers), so valid values are 1, 2, 3, and 4. A shipping service option with a **sortOrderId** value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a **sortOrderId** value of '4' appears at the bottom of a list of four shipping service options. Sellers can specify up to five international shipping services (in five separate **internationalShippingPolicyInfoService** containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the **sortOrderId** value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. If the **sortOrderId** field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. This field is always returned (for each shipping service) with shipping policies returned in the **getSellerProfiles**, **addSellerProfile**, or **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#sortOrderId) to learn which calls use sortOrderId. --- # BuyerCloseReturnReasonEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) BuyerCloseReturnReasonEnum ========================== This enumerated type lists all possible reasons that a buyer can give for cancelling a return request. A buyer would typically close a return request after they receive a refund or if they initiated the return request by mistake. Type that uses BuyerCloseReturnReasonEnum: [ReturnCloseInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnCloseInfoType.html) Calls that use one or more values of BuyerCloseReturnReasonEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER\_NO\_LONGER\_WANTS\_RETURN | This enumeration value indicates the buyer closed the return request because he/she no longer wants to return the item. | | BUYER\_RECEIVED\_REFUND | This enumeration value indicates the buyer closed the return request after receiving a refund from the seller. | | BUYER\_RECEIVED\_REPLACEMENT | This enumeration value indicates the buyer closed the return request after receiving a replacement item from the seller.

**Note:** This value is not currently supported as a reason for closing a return request. | | BUYER\_STARTED\_RETURN\_ACCIDENTALLY | This enumeration value indicates the buyer closed the return request after opening the request accidentally. | | CHARGE\_BACK\_OPENED | This enumeration value indicates the eBay system closed the return request because the buyer opened a chargeback request. | | OTHER | This enumeration value indicates the buyer's reason for closing the return is unclassified. | | UNKNOWN | This enumeration value indicates the buyer's reason for closing the return is unknown.

**Note:** This value is not currently supported as a reason for closing a return request. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Applicable values for getSellerProfilesResponse.shippingPolicyProfile.ShippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ### Applicable values for getSellerProfilesResponse.shippingPolicyProfile.ShippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency AUD Australian Dollar; country - Australia; ISO currency code - 036 CAD Canadian Dollar; country - Canada; ISO currency code - 124 CHF Swiss Franc; country - Switzerland; ISO currency code - 756 CNY Chinese Yuan Renminbi; country - China; ISO currency code - 156 EUR Euro; entity - European Union; ISO currency code - 978 GBP Pound Sterling; country - United Kingdom; ISO currency code - 826 HKD Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 INR Indian Rupee; country - India; ISO currency code - 356 MYR Malaysian Ringgit; country - Malaysia; ISO currency code - 458 PHP Philippine Peso; country - Philippines; ISO currency code - 608 PLN Polish New Zloty; country - Poland; ISO currency code - 985 SEK Swedish Krona; country - Sweden; ISO currency code - 752 SGD Singapore Dollar; country - Singapore; ISO currency code - 702 TWD New Taiwan Dollar; country - Taiwan; ISO currency code - 901 USD U.S. Dollar; country - United States; ISO currency code - 840 --- # ShippingProfileDiscountInfo - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ShippingProfileDiscountInfo =========================== Type defining the **shippingProfileDiscountInfo** container, which consists of details related to flat-rate, calculated, and promotional shipping discounts that are offered to domestic and/or international buyers. Type that uses ShippingProfileDiscountInfo: [ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) Calls that use ShippingProfileDiscountInfo: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ applyDomesticPromoShippingProfile ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) If this field is included and set to 'true', a domestic buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the **SetShippingDiscountProfiles** call of the Trading API. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#applyDomesticPromoShippingProfile) to learn which calls use applyDomesticPromoShippingProfile. applyIntlPromoShippingProfile ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) If this field is included and set to 'true', an international buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the **SetShippingDiscountProfiles** call of the Trading API. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#applyIntlPromoShippingProfile) to learn which calls use applyIntlPromoShippingProfile. domesticFlatCalcDiscountProfileId ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, a domestic buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the **SetShippingDiscountProfiles** and **GetShippingDiscountProfiles** calls of the Trading API. The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the **domesticShippingType** ('Flat' or 'Calculated') value in the shipping policy. Shipping discount profiles are not applicable when Freight shipping is used. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domesticFlatCalcDiscountProfileId) to learn which calls use domesticFlatCalcDiscountProfileId. intlFlatCalcDiscountProfileId ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, an international buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the **SetShippingDiscountProfiles** and **GetShippingDiscountProfiles** calls of the Trading API. The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the **intlShippingType** ('Flat' or 'Calculated') value in the shipping policy. Shipping discount profiles are not applicable when Freight shipping is used. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#intlFlatCalcDiscountProfileId) to learn which calls use intlFlatCalcDiscountProfileId. --- # Applicable values for addSellerProfileResponse.shippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ### Applicable values for addSellerProfileResponse.shippingPolicyProfile.shippingPolicyInfo.shippingPolicyCurrency AUD Australian Dollar; country - Australia; ISO currency code - 036 CAD Canadian Dollar; country - Canada; ISO currency code - 124 CHF Swiss Franc; country - Switzerland; ISO currency code - 756 CNY Chinese Yuan Renminbi; country - China; ISO currency code - 156 EUR Euro; entity - European Union; ISO currency code - 978 GBP Pound Sterling; country - United Kingdom; ISO currency code - 826 HKD Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 INR Indian Rupee; country - India; ISO currency code - 356 MYR Malaysian Ringgit; country - Malaysia; ISO currency code - 458 PHP Philippine Peso; country - Philippines; ISO currency code - 608 PLN Polish New Zloty; country - Poland; ISO currency code - 985 SEK Swedish Krona; country - Sweden; ISO currency code - 752 SGD Singapore Dollar; country - Singapore; ISO currency code - 702 TWD New Taiwan Dollar; country - Taiwan; ISO currency code - 901 USD U.S. Dollar; country - United States; ISO currency code - 840 --- # MarketplaceIdEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) MarketplaceIdEnum ================= This enumerated type defines the unique eBay-assigned IDs for each of the eBay marketplaces. Types that use MarketplaceIdEnum: [CancelDetail](https://developer.ebay.com/Devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/Devzone/post-order/types/CancelSummary.html) , [ReturnDetailType](https://developer.ebay.com/Devzone/post-order/types/ReturnDetailType.html) Calls that use one or more values of MarketplaceIdEnum: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | EBAY\_AT | This enumeration value indicates the eBay marketplace for Austria (https://www.ebay.at). | | EBAY\_AU | This enumeration value indicates the eBay marketplace for Australia (https://www.ebay.com.au). | | EBAY\_BE | This enumeration value indicates the French version of the eBay Belgium marketplace. Although the category taxonomy and inventory are more or less identiical, there are technically two eBay marketplaces in Belgium - a French version at https://www.befr.ebay.be/, and a Dutch version at https://www.benl.ebay.be/. There is no enumeration value that directly represents the Dutch version of the eBay Belgium marketplace, but a user can use the **Accept-Language** HTTP header and set its value to `nl-BE` to get applicable response fields returned in Dutch instead of French. | | EBAY\_CA | This enumeration value indicates the English version of the eBay Canada marketplace. Although the category taxonomy and inventory are more or less identiical, there are technically two eBay marketplaces in Canada - an English version at https://www.ebay.ca/, and a French version at https://www.cafr.ebay.ca/. There is no enumeration value that directly represents the French version of the eBay Canada marketplace, but a user can use the **Accept-Language** HTTP header and set its value to `fr-CA` to get applicable response fields returned in French instead of English. | | EBAY\_CH | This enumeration value indicates the eBay marketplace for Switzerland (https://www.ebay.ch). | | EBAY\_CN | Reserved for future use. | | EBAY\_CZ | Reserved for future use. | | EBAY\_DE | This enumeration value indicates the eBay marketplace for Germany (https://www.ebay.de). | | EBAY\_DK | Reserved for future use. | | EBAY\_ES | This enumeration value indicates the eBay marketplace for Spain (https://www.ebay.es). | | EBAY\_FI | Reserved for future use. | | EBAY\_FR | This enumeration value indicates the eBay marketplace for France (https://www.ebay.fr). | | EBAY\_GB | This enumeration value indicates the eBay marketplace for the UK (https://www.ebay.co.uk). | | EBAY\_GR | Reserved for future use. | | EBAY\_HALF\_US | This enumeration is deprecated since the Half.com site no longer exists. | | EBAY\_HK | This enumeration value indicates the eBay marketplace for Hong Kong (https://www.ebay.com.hk). | | EBAY\_HU | Reserved for future use. | | EBAY\_ID | Reserved for future use. | | EBAY\_IE | This enumeration value indicates the eBay marketplace for Ireland (https://www.ebay.ie). | | EBAY\_IL | Reserved for future use. | | EBAY\_IN | This enumeration value is not currently applicable, as there is no longer an eBay marketplace in India. | | EBAY\_IT | This enumeration value indicates the eBay marketplace for Italy (https://www.ebay.it). | | EBAY\_JP | Reserved for future use. | | EBAY\_MOTORS\_US | This enumeration value indicates the parent category for "Auto Parts and Vehicles" on the EBAY\_US marketplace (https://www.ebay.com/motors). | | EBAY\_MY | This enumeration value indicates the eBay marketplace for Malaysia (https://www.ebay.com.my). | | EBAY\_NL | This enumeration value indicates the eBay marketplace for the Netherlands (https://www.ebay.nl). | | EBAY\_NO | Reserved for future use. | | EBAY\_NZ | Reserved for future use. | | EBAY\_PE | Reserved for future use. | | EBAY\_PH | This enumeration value indicates the eBay marketplace for the Philippines (https://www.ebay.ph). | | EBAY\_PL | This enumeration value indicates the eBay marketplace for Poland (https://www.ebay.pl). | | EBAY\_PR | Reserved for future use. | | EBAY\_PT | Reserved for future use. | | EBAY\_RU | Reserved for future use. | | EBAY\_SE | Reserved for future use. | | EBAY\_SG | This enumeration value indicates the eBay marketplace for Singapore (https://www.ebay.com.sg). | | EBAY\_TH | This enumeration value is not currently applicable, as there is no longer an eBay marketplace in Thailand. | | EBAY\_TW | This enumeration value indicates the eBay marketplace for Taiwan (https://www.ebay.com.tw). | | EBAY\_US | This enumeration value indicates the eBay marketplace for the United States (https://www.ebay.com). | | EBAY\_VN | This enumeration value is not currently applicable, as there is no longer an eBay marketplace in Vietnam. | | EBAY\_ZA | Reserved for future use. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnResponseDueType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnResponseDueType ===================== This type is used to provide the type of response due from the buyer or seller on a return request, and when this response is due. Type that uses ReturnResponseDueType: [ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) Calls that use ReturnResponseDueType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ activityDue ( _[ActivityOptionEnum](https://developer.ebay.com/devzone/post-order/types/ActivityOptionEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#activityDue) to learn which calls use activityDue. respondByDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the deadline for when a buyer or seller must perform the next action (indicated in **activityDue** field) on the return request. This field will only be returned if there is a deadline associated with the next action. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#respondByDate) to learn which calls use respondByDate. --- # ReturnReasonTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnReasonTypeEnum ==================== This enumeration type lists the broad categories about why a buyer opens a return request. Type that uses ReturnReasonTypeEnum: [ReturnCreationInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html) Calls that use one or more values of ReturnReasonTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CANCEL | This enumeration value is returned if a cancellation request was made by the buyer after the item was already shipped by the seller. | | INSTORE | This enumeration value is returned if the return item was part of an In-Store Pickup or a Click and Collect order, and the buyer is returning the item to a local brick-and-mortar store. | | REMORSE | This enumeration value is returned if the buyer is returning the item for a _buyer's remorse_ reason, which means that there is nothing actually wrong with the item. | | SNAD | This enumeration value is returned if the buyer found the item to be Significantly Not As Described, so the buyer wants to return the item. | | UNKNOWN | This enumeration value is returned if the return reason category is not known. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnShippingCostType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnShippingCostType ====================== This enumerated type lists the types of shipping costs, including the cost of the shipping label, shipping insurance, and certified shipping. Type that uses ReturnShippingCostType: [ItemizedReturnShippingCostType](https://developer.ebay.com/Devzone/post-order/types/ItemizedReturnShippingCostType.html) Calls that use one or more values of ReturnShippingCostType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | INSURANCE | This enumeration value indicates that the shipping cost is the price of shipping insurance to ship the return item. | | LABEL\_COST | This enumeration value indicates that the shipping cost is the price of the shipping label for the return item. | | OTHER | This enumeration value indicates that the shipping cost is not classified or is not known. | | SIGNATURE\_CONFIRMATION\_COST | This enumeration value indicates that the shipping cost is the price to ship the return item using certified shipping. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # AppealGrantStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) AppealGrantStatusEnum ===================== This enumeration type contains the possible outcomes of a case decision that has been appealed by the buyer or seller. Type that uses AppealGrantStatusEnum: [AppealDetails](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html) Calls that use one or more values of AppealGrantStatusEnum: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | DENIED | This enumeration value indicates that the buyer's or seller's appeal was denied. | | GRANTED | This enumeration value indicates that the buyer's or seller's appeal was granted. | | OTHER | This enumeration value indicates that the outcome of the buyer's or seller's appeal is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # RefundFundingType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RefundFundingType ================= This type is used to provide more information about the seller's funding source used for a buyer's refund in the case of a returned item or order cancellation. Types that use RefundFundingType: [ActualRefundDetail](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html) , [ActualRefundDetailType](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html) Calls that use RefundFundingType: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ amount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount debited/charged to the seller's funding source for the buyer refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#amount) to learn which calls use amount. date ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the seller's funding source was debited/charged for the buyer refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#date) to learn which calls use date. fundingSource ( _[FundingSourceType](https://developer.ebay.com/devzone/post-order/types/FundingSourceType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides information about the seller's funding source for the buyer refund. A funding source can be available seller payout funds, a bank account on file, or a credit card on file. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fundingSource) to learn which calls use fundingSource. fundingStatus ( _[FundingStatusEnum](https://developer.ebay.com/devzone/post-order/types/FundingStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value returned in this field indicates if the debit/charge to the funding source was successful or not. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fundingStatus) to learn which calls use fundingStatus. --- # FileStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FileStatusEnum ============== This enumerated type contains the possible states that a return-associated file can be in. Type that uses FileStatusEnum: [ReturnFileType](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html) Calls that use one or more values of FileStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CREATED | This enumeration value indicates that the file has been created, but has yet to be associated with a return request or draft. | | DELETED | This enumeration value indicates that the file has been removed, or unassociated with a return request or draft. | | PUBLISHED | This enumeration value indicates that the file has been associated with a return request or draft. | | UNKNOWN | This enumeration value indicates that the status of the file is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # IsoCurrencyCode - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) IsoCurrencyCode ( [token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) ) ======================================================================================================================= This enumeration type defines the values that can be set as a currencyId attribute for Business Policies Management elements that use **Amount** type, such as **depositDetails.depositAmount** in payment policies, or **shippingServiceCost** in shipping policies. Type that uses IsoCurrencyCode: [ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) Calls that use one or more values of IsoCurrencyCode: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AUD | Australian Dollar; country - Australia; ISO currency code - 036 | | CAD | Canadian Dollar; country - Canada; ISO currency code - 124 | | CHF | Swiss Franc; country - Switzerland; ISO currency code - 756 | | CNY | Chinese Yuan Renminbi; country - China; ISO currency code - 156 | | EUR | Euro; entity - European Union; ISO currency code - 978 | | GBP | Pound Sterling; country - United Kingdom; ISO currency code - 826 | | HKD | Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 | | INR | Indian Rupee; country - India; ISO currency code - 356 | | MYR | Malaysian Ringgit; country - Malaysia; ISO currency code - 458 | | PHP | Philippine Peso; country - Philippines; ISO currency code - 608 | | PLN | Polish New Zloty; country - Poland; ISO currency code - 985 | | SEK | Swedish Krona; country - Sweden; ISO currency code - 752 | | SGD | Singapore Dollar; country - Singapore; ISO currency code - 702 | | TWD | New Taiwan Dollar; country - Taiwan; ISO currency code - 901 | | USD | U.S. Dollar; country - United States; ISO currency code - 840 |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # MoneyMovementEntry - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) MoneyMovementEntry ================== This type is used to provide details on every monetary transaction that occurs in regards to an Item Not Received inquiry or eBay case. Type that uses MoneyMovementEntry: [MoneyMovementEntries](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntries.html) Calls that use MoneyMovementEntry: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [amount](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html#amount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [date](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html#date) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [fundingSource](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html#fundingSource) ( _[FundingSource](https://developer.ebay.com/devzone/post-order/types/FundingSource.html) _ ) [fundingStatus](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html#fundingStatus) ( _[FundingStatusEnum](https://developer.ebay.com/devzone/post-order/types/FundingStatusEnum.html) _ ) [type](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html#type) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) amount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount of the monetary transaction. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#amount) to learn which calls use amount. date ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date/time of the monetary transaction. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#date) to learn which calls use date. fundingSource ( _[FundingSource](https://developer.ebay.com/devzone/post-order/types/FundingSource.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides details about the seller's funding source to issue a buyer refund, such as available seller payout funds, a bank account, or a credit card on file. This container is only applicable and returned if the monetary transaction is related to a buyer refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fundingSource) to learn which calls use fundingSource. fundingStatus ( _[FundingStatusEnum](https://developer.ebay.com/devzone/post-order/types/FundingStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates if eBay was able to successfully 'fund' a refund to the buyer using the seller's preferred method of payment for buyer refunds. This field is only applicable and returned if the monetary transaction is related to a buyer refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fundingStatus) to learn which calls use fundingStatus. type ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates the type of monetary transaction, such as a refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#type) to learn which calls use type. --- # PaymentProviderEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) PaymentProviderEnum =================== This token type lists the external payment system used for the monetary transaction. Type that uses PaymentProviderEnum: [MoneyMovementDetailType](https://developer.ebay.com/Devzone/post-order/types/MoneyMovementDetailType.html) Calls that use one or more values of PaymentProviderEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | PAYPAL | **THIS VALUE IS DEPRECATED**. | | UNKNOWN | This value indicates that the payment system used for the monetary transaction is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # StatusType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) StatusType ========== This enumerated type lists the values that can be returned in the responses of the **GET /post-order/v2/return/check\_eligibility** and **POST /post-order/v2/return** methods. See the enumeration descriptions for more information about what these values indicate based on which response these values are returned in. Type that uses StatusType: [EligibilityResultType](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html) Call that uses one or more values of StatusType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | If this value is returned in the **GET /post-order/v2/return/check\_eligibility** or **POST /post-order/v2/return** responses, it means that the return eligibility check or the creation of return request failed. This generally indicates that there was either an issue with the request payload or there was a system error. | | SELLER\_APPROVAL | If this value is returned in the **GET /post-order/v2/return/check\_eligibility** or **POST /post-order/v2/return** responses, it indicates that the buyer is eligible to create a return request for the order line item, but the return request will have to be accepted by the seller. | | SUCCESS | If this value is returned in the **GET /post-order/v2/return/check\_eligibility** response, it indicates that the buyer is eligible to create a return request for the order line item. If this value is returned in the **POST /post-order/v2/return** response, it indicates that the return request for the order line item was created successfully. | | UNKNOWN | This enumeration value may get returned in the **GET /post-order/v2/return/check\_eligibility** or **POST /post-order/v2/return** responses if the status of the return eligibility check or the creation of the return request is unknown. | | WARNING | If this value is returned in the **GET /post-order/v2/return/check\_eligibility** or **POST /post-order/v2/return** responses, it means that the return eligibility check or the creation of return request succeeded, but with a warning. The user should check for a **eligibilityErrorDetail** container to possibly get more information about the warning |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnStatusEnum ================ This enumeration type lists the possible statuses for a return request. Type that uses ReturnStatusEnum: [ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) Calls that use one or more values of ReturnStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CLOSED | This enumeration value indicates that the return request has been closed | | ESCALATED | This enumeration value indicates that the return request has been escalated to a return case. | | ITEM\_DELIVERED | This enumeration value indicates that the return request item has been delivered to the seller. | | ITEM\_SHIPPED | This enumeration value indicates that the return request item has been shipped by the buyer. | | LESS\_THAN\_A\_FULL\_REFUND\_ISSUED | This enumeration value indicates that a partial buyer refund was issued by the seller. | | PARTIAL\_REFUND\_DECLINED | This enumeration value indicates that the buyer has declined the partial refund amount that the seller has proposed. | | PARTIAL\_REFUND\_FAILED | This enumeration value indicates that the partial refund operation has failed. | | PARTIAL\_REFUND\_INITIATED | This enumeration value indicates that a partial refund to the buyer has been initiated by the seller. | | PARTIAL\_REFUND\_REQUESTED | This enumeration value indicates that a partial refund has been requested by the buyer. | | READY\_FOR\_SHIPPING | This enumeration value indicates that the return request item is ready to be shipped back by the buyer to the seller. | | REPLACED | This enumeration value indicates that the buyer has acknowledged the receipt of the replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_CLOSED | This enumeration value indicates that the replacement item has been received and the return request has been closed.

**Note:** This value is not currently supported. | | REPLACEMENT\_DELIVERED | This enumeration value indicates that the replacement item has been delivered to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_LABEL\_REQUESTED | This enumeration value indicates that the seller has requested a shipping label for the replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_REQUESTED | This enumeration value indicates that the buyer has requested a replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_SHIPPED | This enumeration value indicates that the replacement item has been shipped to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_STARTED | This enumeration value indicates that the process for the seller to send a replacement item to the buyer has started. | | REPLACEMENT\_WAITING\_FOR\_RMA | This enumeration value indicates that the seller still needs to provide a Return Merchandise Authorization (RMA) number for the replacement item.

**Note:** This value is not currently supported. | | RETURN\_LABEL\_REQUESTED | This enumeration value indicates that the buyer has requested a return shipping label. | | RETURN\_REJECTED | This enumeration value indicates that the buyer's return request has been rejected by the seller. | | RETURN\_REQUESTED | This enumeration value indicates that a return request has been initiated by the buyer. | | RETURN\_REQUESTED\_TIMEOUT | This enumeration value indicates that a return request has been initiated by the buyer, but the system has timed out. | | UNKNOWN | This enumeration value indicates that the current status of the return request is unknown. | | WAITING\_FOR\_RETURN\_LABEL | This enumeration value indicates that the return request is currently waiting for an eBay return shipping label to be available. | | WAITING\_FOR\_RMA | This enumeration value indicates that the return request is currently waiting for the seller to provide a Return Merchandise Authorization (RMA) number to the buyer. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # NoSellerUploadLabelReasonEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) NoSellerUploadLabelReasonEnum ============================= This enumerated type lists the possible values that a seller can provide in the **noLabelReason** field of the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** to indicate the reason why a shipping label is not being supplied to the buyer. Type that uses NoSellerUploadLabelReasonEnum: [ProvideLabelRequest](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html) Call that uses one or more values of NoSellerUploadLabelReasonEnum: [/post-order/v2/return/{returnId}/add\_shipping\_label POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ITEM\_TOO\_LARGE | This enumeration value is used in the **noLabelReason** field if the item is too large to be shipped using a return shipping label. Many shipping carriers have a weight limit. | | OTHER | This enumeration value is used in the **noLabelReason** field if there is another reason why the seller is not providing a return shipping label to the buyer. If this value is used, it is good idea if the seller includes the **comments** container of the request to provide more details on the reason why no shipping label is being provided. | | REIMBURSE | This enumeration value is used in the **noLabelReason** field if the seller will not provide a return shipping label to the buyer, but will reimburse the buyer for the return shipping cost. | | RETURN\_TO\_INTL\_LOCATION | This enumeration value is used in the **noLabelReason** field if a return shipping label is not being provided to the buyer because the return address is located in another country. | | RETURN\_TO\_STORE | This enumeration value is used in the **noLabelReason** field if the seller is asking the buyer to return the item to the store. This value is applicable for In-Store Pickup and Click and Collect orders. | | WORK\_WITH\_BUYER | This enumeration value is used in the **noLabelReason** field if the seller will work with the buyer to determine how return shipping costs will be handled. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ScanDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ScanDetailType ============== This type is used by the **scanHistory** container that is returned in the **GET /post-order/v2/return/{returnId}/tracking** response to provide details on each time a shipment is scanned by the shipping carrier. The **scanHistory** container will be returned if shipment tracking is active for the order line item, and at least one scan has been made on the package. Type that uses ScanDetailType: [GetTrackingHistoryResponse](https://developer.ebay.com/devzone/post-order/types/GetTrackingHistoryResponse.html) Call that uses ScanDetailType: [/post-order/v2/return/{returnId}/tracking GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_tracking__get.html) Fields ------ [eventCity](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventCity) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventCode](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventCode) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventDesc](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventDesc) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventPostalCode](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventPostalCode) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventStateOrProvince](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventStateOrProvince) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventStatus](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventStatus) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventTime](https://developer.ebay.com/devzone/post-order/types/ScanDetailType.html#eventTime) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) eventCity ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the city in which the shipment event occurred. This field is always returned with the **scanHistory** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventCity) to learn which calls use eventCity. eventCode ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value represents the shipment event that occurred. This field is returned if available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventCode) to learn which calls use eventCode. eventDesc ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field contains the description of the shipment event that occurred. This field is returned if available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventDesc) to learn which calls use eventDesc. eventPostalCode ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the postal code for the scan location. This field is always returned with the **scanHistory** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventPostalCode) to learn which calls use eventPostalCode. eventStateOrProvince ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the state or province in which the shipment event occurred. This field is always returned with the **scanHistory** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventStateOrProvince) to learn which calls use eventStateOrProvince. eventStatus ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field contains shows the latest delivery status of the shipment based on the event (scan) that just occurred. This field is always returned with the **scanHistory** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventStatus) to learn which calls use eventStatus. eventTime ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date and time when the shipment event occurred. This field is always returned with the **scanHistory** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventTime) to learn which calls use eventTime. --- # ShippingPolicyProfile - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ShippingPolicyProfile ( [SellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html) ) ================================================================================================================================= Type defining the **shippingPolicyProfile** container, which is the container used to define one shipping policy for a seller. Types that use ShippingPolicyProfile: [AddSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileRequest.html) , [AddSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileResponse.html) , [SetSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileRequest.html) , [SetSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileResponse.html) , [ShippingPolicyProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfileList.html) Calls that use ShippingPolicyProfile: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Field ----- shippingPolicyInfo ( _[ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container consists of detailed shipping information for a seller's shipping policy. This container is conditionally required if the caller is creating a new shipping policy or modifying an existing shipping policy. This container is returned by **getSellerProfiles** if one or more shipping policies match the input criteria in the call request. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingPolicyInfo) to learn which calls use shippingPolicyInfo. --- # InternationalReturnPolicyInfo - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) InternationalReturnPolicyInfo ============================= Populate this complex object if your international return policy differs from your domestic return policy (by default, international return policies inherit their settings from the settings in the domestic return policy). For example, you might want to offer free returns for domestic shipments, but have a return policy where the buyer pays for returns from non-domestic regions. Type that uses InternationalReturnPolicyInfo: [ReturnPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfile.html) Calls that use InternationalReturnPolicyInfo: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ refundOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field indicates how the seller compensates buyers for [remorse returns](https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/post-order-returns.html#return-reasons) . You must set this value to `MoneyBack` for all eBay marketplaces except for the US marketplace. This value is required for international returns when **ReturnsAcceptedOption=ReturnsAccepted**. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. On `EBAY_US`: You can set this value to either `MoneyBack` or `MoneyBackOrReplacement`. If a seller has the depth of inventory to support an exchange for an identical item, you can set `MoneyBackOrReplacement`. Otherwise, eBay recommends you set this value to its default value, `MoneyBack`. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#refundOption) to learn which calls use refundOption. returnsAcceptedOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service). Applicable values are `ReturnsAccepted` or `ReturnsNotAccepted`. When set to `ReturnsAccepted`, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify **ReturnsNotAccepted**. On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call **GetUser** to determine the status of an eBay business seller in DE, IE, and UK. Review the **User.SellerInfo.SellerBusinessType** field in the response. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnsAcceptedOption) to learn which calls use returnsAcceptedOption. returnsWithinOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required for international returns when **ReturnsAcceptedOption=ReturnsAccepted**. **Applicable values:** Retrieve the values supported by a marketplace by calling **GeteBayDetails** with **DetailName** set to `ReturnPolicyDetails`, then review **ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption** in the response. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnsWithinOption) to learn which calls use returnsWithinOption. shippingCostPaidByOption ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This option specifies either the buyer or the seller as the party who pays for return shipping charges for international returns. Accepted values are `Buyer` or `Seller`. This value is required for international returns when **ReturnsAcceptedOption=ReturnsAccepted**. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Use **GeteBayDetails** (with **DetailName=ReturnPolicyDetails**) and review the returned **ReturnPolicyDetails.ShippingCostPaidBy** values to see the values supported by a marketplace. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingCostPaidByOption) to learn which calls use shippingCostPaidByOption. --- # PaymentProviderEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) PaymentProviderEnum =================== This token type lists the external payment system used for the monetary transaction. Type that uses PaymentProviderEnum: [MoneyMovementDetailType](https://developer.ebay.com/devzone/post-order/types/MoneyMovementDetailType.html) Calls that use one or more values of PaymentProviderEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | PAYPAL | **THIS VALUE IS DEPRECATED**. | | UNKNOWN | This value indicates that the payment system used for the monetary transaction is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # RelistStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RelistStatusEnum ================ This enumerated type defines the different possible response values that can be returned to indicate the relisting status of an item that was involved in an order cancellation or return request. Type that uses RelistStatusEnum: [ItemDetailType](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html) Calls that use one or more values of RelistStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | This enumeration value indicates that the attempt to relist the item has failed. | | RELIST\_ELIGIBLE | This enumeration value indicates that the item is eligible to be relisted automatically by eBay upon the successful cancellation of an order or once a returned item is marked as received by the seller. | | SUCCESS | This enumeration value indicates that the item has been successfully relisted upon the successful cancellation of an order, or after a returned item has been marked as received by the seller. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnPolicyProfileList - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ReturnPolicyProfileList ======================= Type defining the **returnPolicyProfileList** container, which consists of one or more return policies that match the input criteria in the **getSellerProfiles** request. Type that uses ReturnPolicyProfileList: [GetSellerProfilesResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/GetSellerProfilesResponse.html) Call that uses ReturnPolicyProfileList: [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) Field ----- ReturnPolicyProfile ( _[ReturnPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfile.html) _ ) [\[1..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of detailed information for a specific return policy that matches the input criteria. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#ReturnPolicyProfile) to learn which calls use ReturnPolicyProfile. --- # FundingStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FundingStatusEnum ================= This enumerated type is used to indicate if eBay was able to successfully 'fund' a refund to the buyer using the seller's preferred method of payment for refunds. Types that use FundingStatusEnum: [MoneyMovementEntry](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html) , [RefundFundingType](https://developer.ebay.com/devzone/post-order/types/RefundFundingType.html) Calls that use one or more values of FundingStatusEnum: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | This enumeration value indicates that the refund was not successfully funded, which can mean there were insufficient funds in the account, or that the transaction failed for another reason. | | FUNDED | This enumeration value indicates that the buyer refund was successfully funded. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # StockPhotoURL - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) StockPhotoURL ============= Thumbnail and standard stockphoto URLs. Type that uses StockPhotoURL: [Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) Calls that use StockPhotoURL: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ standard ( _[URIValue](https://developer.ebay.com/devzone/product/CallRef/types/URIValue.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#standard) to learn which calls use standard. thumbnail ( _[URIValue](https://developer.ebay.com/devzone/product/CallRef/types/URIValue.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#thumbnail) to learn which calls use thumbnail. --- # TotalRefundAmountType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) TotalRefundAmountType ===================== This type is used by the **buyerTotalRefund** and **sellerTotalRefund** containers, which provide the estimated and actual refund amounts due to the buyer. Type that uses TotalRefundAmountType: [ReturnSummaryType](https://developer.ebay.com/Devzone/post-order/types/ReturnSummaryType.html) Calls that use TotalRefundAmountType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ actualRefundAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the actual refund amount paid to the buyer. Is is only returned after a refund has been issued to the buyer. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#actualRefundAmount) to learn which calls use actualRefundAmount. estimatedRefundAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the estimated refund amount expected to be paid to the buyer. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#estimatedRefundAmount) to learn which calls use estimatedRefundAmount. --- # AckValue - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) AckValue ( [string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) ) ======================================================================================================== 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. Type that uses AckValue: [BaseServiceResponse](https://developer.ebay.com/devzone/product/CallRef/types/BaseServiceResponse.html) Calls that use one or more values of AckValue: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | Failure | The request was processed successfully, but something occurred that may affect your application or the user. | | PartialFailure | The request that triggered the error was processed successfully but with some warnings. | | Success | 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. | | Warning | The request that triggered the error was processed successfully but with some warnings. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ShipmentTrackingDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ShipmentTrackingDetailType ========================== This type is used to show detailed shipment tracking information if an INR item is being shipped to the buyer, or if the buyer is returning an item to the seller. Type that uses ShipmentTrackingDetailType: [ClaimHistoryResponse](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryResponse.html) Calls that use ShipmentTrackingDetailType: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [carrier](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingDetailType.html#carrier) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [currentStatus](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingDetailType.html#currentStatus) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [estimateFromDate](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingDetailType.html#estimateFromDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [estimateToDate](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingDetailType.html#estimateToDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [trackingNumber](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingDetailType.html#trackingNumber) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [trackingURL](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingDetailType.html#trackingURL) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) carrier ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The name of the shipping carrier handling the shipment. This field is generally always returned with the **shipmentTrackingDetails** container unless the tracking number has yet to be provided for the order line item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#carrier) to learn which calls use carrier. currentStatus ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The current status of the shipment, such as delivered or still in-transit. This field is returned if it is known and available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#currentStatus) to learn which calls use currentStatus. estimateFromDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The date and time in this container is the earliest date that the shipment is estimated to be delivered, based on the shipping service being used, the stated handling time, and when the package was shipped. This container is returned if it is known and available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#estimateFromDate) to learn which calls use estimateFromDate. estimateToDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The date and time in this container is the latest date that the shipment is estimated to be delivered, based on the shipping service being used, the stated handling time, and when the package was shipped. If the package is not received by this date, the buyer or seller should contact their order partner to get status, and then ask eBay to step in if the problem cannot be resolved. This container is returned if it is known and available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#estimateToDate) to learn which calls use estimateToDate. trackingNumber ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) A unique identifier used to track the shipment of the order line item. This field is generally always returned with the **shipmentTrackingDetails** container unless the tracking number has yet to be provided for the order line item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#trackingNumber) to learn which calls use trackingNumber. trackingURL ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field provides the URL to the shipping carrier's shipment tracking page. This field is returned if available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#trackingURL) to learn which calls use trackingURL. --- # OrderType - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) OrderType ( [string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) ) ========================================================================================================= Defines the order type as Ascending or Descending Type that uses OrderType: [SortOrder](https://developer.ebay.com/devzone/product/CallRef/types/SortOrder.html) Calls that use one or more values of OrderType: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | Ascending | The results will be sorted by the specified attribute in ascending (low to high) order. | | Descending | The results will be sorted by the specified attribute in descending (high to low) order. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # PaymentInfo - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) PaymentInfo =========== Type defining the **PaymentInfo** container, which contains payment information related to the corresponding payment policy. Type that uses PaymentInfo: [PaymentProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfile.html) Calls that use PaymentInfo: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [acceptedPaymentMethod](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html#acceptedPaymentMethod) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [daysToFullPayment](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html#daysToFullPayment) ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [depositDetails](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html#depositDetails) ( _[DepositDetails](https://developer.ebay.com/Devzone/business-policies/CallRef/types/DepositDetails.html) _ ) [immediatePay](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html#immediatePay) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [paymentInstructions](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html#paymentInstructions) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [paypalEmailAddress](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html#paypalEmailAddress) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) acceptedPaymentMethod ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) **Note:**This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item. This field specifys one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform. If you specify multiple **acceptedPaymentMethod** fields, the repeating fields must be contiguous. **Note:** Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call **GetCategoryFeatures**, specifying 'PaymentMethods' as a **FeatureID** value in the call request, and then look for the **Category.PaymentMethod** values in the call response. In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following **acceptedPaymentMethod** values must be specified: * CashOnPickup * LoanCheck * MOCC (money order or cashier's check) * PersonalCheck See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#acceptedPaymentMethod) to learn which calls use acceptedPaymentMethod. daysToFullPayment ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following **acceptedPaymentMethod** values must be specified for the corresponding payment business policy: * CashOnPickup * LoanCheck * MOCC (money order or cashier's check) * PersonalCheck See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#daysToFullPayment) to learn which calls use daysToFullPayment. depositDetails ( _[DepositDetails](https://developer.ebay.com/Devzone/business-policies/CallRef/types/DepositDetails.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the **categoryGroup.name**field is set to 'MOTORS\_VEHICLE'. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#depositDetails) to learn which calls use depositDetails. immediatePay ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field should be included and set to `true` if the seller wants to require immediate payment from the buyer for: * A fixed-price item * An auction item where the buyer is using the 'Buy it Now' option * A deposit for a motor vehicle listing **Note:** In the Trading API calls that return the **AutoPay** field (**immediatePay** equivalent), be aware that the field's appearance in the output does not necessarily indicate that the listing qualifies for immediate payment, but only that the seller attempted to create (by including and setting **immediatePay** to 'true' in the payment policy) an immediate payment requirement. To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call: * seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges; * seller must include and set the **shippingProfileDiscountInfo** container values if promotional shipping discounts will be used; See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#immediatePay) to learn which calls use immediatePay. paymentInstructions ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) **Important:** DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies. This free-form string field allows the seller to give payment instructions to the buyer. These instructions will appear on eBay's View Item and Checkout pages. This field allows 1000 characters. It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment policies to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#paymentInstructions) to learn which calls use paymentInstructions. paypalEmailAddress ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) **Important:** This field is deprecated. Do not use this field. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#paypalEmailAddress) to learn which calls use paypalEmailAddress. --- # ReturnStateEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnStateEnum =============== This enumerated type lists the possible states for a return request. These state values are returned in the responses of the **GET /post-order/v2/return/{returnId}** and **POST /post-order/v2/return** methods. Types that use ReturnStateEnum: [ReturnResponseHistoryType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html) , [ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) Calls that use one or more values of ReturnStateEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AUTO\_REFUND\_INITIATED | This enumeration value indicates that the auto refund to the buyer has been initiated. | | CLOSED | This enumeration value indicates that the return request has been closed. | | INITIAL | This enumeration value indicates the return request is in the initial stages. | | ITEM\_DELIVERED | This enumeration value indicates the return item has been received by the seller. | | ITEM\_KEPT | This enumeration value indicates that the buyer has decided to keep the item instead of returning it to the seller. This requires the seller's approval. | | ITEM\_READY\_TO\_SHIP | This enumeration value indicates the return item is ready to be shipped back to the seller. | | ITEM\_SHIPPED | This enumeration value indicates the return item has been shipped by the buyer. | | LESS\_THAN\_A\_FULL\_REFUND\_ISSUED | This enumeration value indicates that a full refund was expected, but only a partial refund has been issued. | | PARTIAL\_REFUND\_AS\_PAYOUT\_INITIATED | This enumeration value indicates that a partial refund to be funded by the seller's payout was initiated. | | PARTIAL\_REFUND\_DECLINED | This enumeration value indicates that the partial refund offer was declined. | | PARTIAL\_REFUND\_FAILED | This enumeration value indicates that the partial refund operation failed. | | PARTIAL\_REFUND\_INITIATED | This enumeration value indicates that a partial refund was initiated. | | PARTIAL\_REFUND\_NON\_PAYPAL\_INITIATED | This enumeration value indicates that a partial refund was initiated. | | PARTIAL\_REFUND\_REQUESTED | This enumeration value indicates that a partial refund was requested. | | PARTIAL\_REFUNDED | This enumeration value indicates that a partial refund was issued to the buyer. | | PAYOUT\_INITIATED | This enumeration value indicates that the payout to the seller has been initiated. | | REFUND\_AS\_PAYOUT\_INITIATED | This enumeration value indicates that the buyer's refund has been initiated through the seller's payout funds. | | REFUND\_FAILED | This enumeration value indicates that the refund transaction failed. | | REFUND\_INITIATED | This enumeration value indicates that a buyer refund was initiated. | | REFUND\_SENT\_PENDING\_CONFIRMATION | This enumeration value indicates that a refund was sent to the buyer and it awaiting confirmation from the buyer that it was received. | | REFUND\_TIMEOUT | This enumeration value indicates that the seller attempted a refund action to the buyer, but the refund action timed out. | | REPLACED | This enumeration value indicates that the buyer has received a replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_CLOSED | This enumeration value indicates that the replacement item has been received and the return request has been closed.

**Note:** This value is not currently supported. | | REPLACEMENT\_DELIVERED | This enumeration value indicates that the replacement item has been delivered to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_LABEL\_PENDING | This enumeration value indicates that the buyer is currently waiting for the shipping label of a replacement item to be generated. This value is only applicable if a replacement item is being sent to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_LABEL\_PENDING\_TIMEOUT | This enumeration value indicates that the buyer is currently waiting for the shipping label of a replacement item to be generated, but the request timed out. This value is only applicable if a replacement item is being sent to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_LABEL\_REQUESTED | This enumeration value indicates that the seller has requested a shipping label for the replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_LABEL\_REQUESTED\_TIMEOUT | This enumeration value indicates that the seller has requested a shipping label for the replacement item, but the request has timed out.

**Note:** This value is not currently supported. | | REPLACEMENT\_OFFER\_PENDING | This enumeration value indicates that the seller is awaiting a response from the buyer in regards to a replacement offer.

**Note:** This value is not currently supported. | | REPLACEMENT\_REQUEST\_TIMEOUT | This enumeration value indicates that the buyer has requested a replacement item, but the request has timed out.

**Note:** This value is not currently supported. | | REPLACEMENT\_REQUESTED | This enumeration value indicates that the buyer has requested a replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_RMA\_PENDING | This enumeration value indicates that the seller still needs to provide a Return Merchandise Authorization (RMA) for the replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_SHIPPED | This enumeration value indicates that the replacement item has been sent to the buyer.

**Note:** This value is not currently supported. | | REPLACEMENT\_STARTED | This enumeration value indicates that the process for the seller to send a replacement item to the buyer has started.

**Note:** This value is not currently supported. | | RETURN\_LABEL\_PENDING | This enumeration value indicates that the buyer is currently waiting for a return shipping label to be generated/provided. | | RETURN\_LABEL\_PENDING\_TIMEOUT | This enumeration value indicates that the buyer is currently waiting for a return shipping label to be generated, but the operation timed out. | | RETURN\_LABEL\_REQUESTED | This enumeration value indicates that a return shipping label was requested by the buyer. | | RETURN\_LABEL\_REQUESTED\_TIMEOUT | This enumeration value indicates that a return shipping label request by the buyer timed out. | | RETURN\_REJECTED | This enumeration value indicates that a return request was rejected by seller. | | RETURN\_REQUEST\_TIMEOUT | This enumeration value indicates that buyer attempted to initiate a return request, but the request timed out. | | RETURN\_REQUESTED | This enumeration value indicates that a return request was initiated by the buyer, and is waiting for the seller's response. | | RMA\_PENDING | This enumeration value indicates the return request is currently pending, awaiting for the seller to provide a Return Merchandise Authorization (RMA) to the buyer. | | UNKNOWN | This enumeration value indicates the current state of the return request is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # CloseReturnReasonEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CloseReturnReasonEnum ===================== This enumerated type lists all possible reasons why a return request is closed. A buyer would typically close a return request after they receive a refund or if they initiated the return request by mistake. Type that uses CloseReturnReasonEnum: [ReturnCloseInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnCloseInfoType.html) Calls that use one or more values of CloseReturnReasonEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AUTO\_PARTIAL\_REFUNDED | This enumeration value indicates that the return request was closed after eBay automatically issued a partial refund to the buyer. | | AUTO\_REFUNDED | This enumeration value indicates that the return request was closed after eBay automatically issued a full refund to the buyer. | | BUYER\_ACCEPT\_LESS\_THAN\_FULL\_REFUND | This enumeration value indicates that the return request was closed after the buyer accepted a partial refund. | | BUYER\_ACCEPT\_LESS\_THAN\_FULL\_REFUND\_AS\_PAYOUT | This enumeration value indicates that the return request was closed after the buyer accepted a partial refund as a payout. | | BUYER\_CLOSED | This enumeration value indicates that the return request was closed by the buyer. | | BUYER\_NO\_ACTION | This enumeration value indicates that the return request was closed because there was no evidence of activity from the buyer in the system. | | BUYER\_PARTIAL\_REFUND\_AS\_PAYOUT | This enumeration value indicates that the return request was closed because the system issued a partial refund to the buyer. | | BUYER\_PAYOUT | This enumeration value indicates that the return request was closed because the buyer was paid out. | | BUYER\_PAYOUT\_FAILED | This enumeration value indicates that the return request was closed because the payout to the buyer failed. | | BUYER\_REFUND\_AS\_PAYOUT | This enumeration value indicates that the return request was closed because the system paid out the refund amount to the buyer. | | CHARGEBACK\_DISPUTE\_FILED | This enumeration value indicates that the return request was closed because the buyer created a chargeback dispute. | | ESCALATED | This enumeration value indicates that the return request was closed because the buyer escalated the return request into a case. | | FULL\_REFUNDED | This enumeration value indicates that the return request was closed after the buyer received a full refund from the seller. | | FULL\_REFUNDED\_BY\_DISPOSITION\_RULE | This enumeration value indicates that the return request was closed because the buyer was auto-refunded by eBay. | | ITEM\_REJECTED | This enumeration value indicates that the returned item was rejected by eBay and no refund issued to buyer. | | LVT\_IMMEDIATE\_REFUND | This enumeration value indicates that the return request was closed because the system issued an immediate refund. | | MARK\_PARTIAL\_REFUND\_RECEIVED | This enumeration value indicates that the return request was closed because the buyer marked the partial refund as received. | | MARK\_REFUND\_RECEIVED | This enumeration value indicates that the return request was closed because the buyer marked the full refund as received. | | MARK\_REFUND\_RECEIVED\_TIMEOUT | This enumeration value indicates that the return request was closed because the buyer attempted to mark the refund as received, but the operation timed out. | | OTHER | This enumeration value indicates that the return request was closed due to an unknown reason. | | PARTIALLY\_REFUNDED | This enumeration value indicates that the return request was closed after the buyer received a mutually agreed upon partial refund. | | REFUND\_TIMEOUT | This enumeration value indicates that the return request was closed because the system timed out waiting for the seller to refund the buyer. | | REPLACED | This enumeration value indicates that the return request was closed because the seller offered and the buyer accepted the seller's offer of a replacement item.

**Note:** This value is not currently supported. | | REPLACEMENT\_PAYOUT\_RECOUP | This enumeration value indicates that the return request was closed after eBay paid out the seller for the auto-refund after the seller sent the buyer a replacement item.

**Note:** This value is not currently supported. | | REQUEST\_DECLINED | This enumeration value indicates that the return request was closed because the request was declined. | | REQUEST\_TIMEOUT | This enumeration value indicates that the return request was closed because the request timed out. | | RETURN\_REJECTED | This enumeration value indicates that the return request was closed because the request was rejected by seller, or possibly eBay if the order line item was not eligible for a return request. | | SELLER\_INVOICED | This enumeration value indicates that the return request was closed because the seller was invoiced so eBay could recoup the buyer refund money from seller. | | SELLER\_PAYOUT\_FAILED | This enumeration value indicates that the return request was closed because the payout to the seller failed. | | SHIPMENT\_TIMEOUT | This enumeration value indicates that the return request was closed because the system timed out waiting for return shipment information from the buyer. | | STORE\_CREDIT\_REFUNDED | **THIS ENUMERATION VALUE IS DEPRECATED**. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Amount - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) Amount ( [double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) ) ================================================================================================================ Monetary amount. This type is used in several locations in payment policies and return policies. Types that use Amount: [DepositDetails](https://developer.ebay.com/Devzone/business-policies/CallRef/types/DepositDetails.html) , [Insurance](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Insurance.html) , [ShippingPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) , [ShippingPolicyInfoService](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html) Calls that use Amount: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ This type has no fields. Attribute --------- currencyId ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) This attribute identifies the currency in which the monetary amount is specified. For a full list of 3-digit ISO 4217 currency codes, see the Trading API's [CurrencyCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/CurrencyCodeType.html) . --- # FilePurposeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FilePurposeEnum =============== This enumerated type contains the list of purposes for which a file is uploaded and attached to a return request or draft. Types that use FilePurposeEnum: [ReturnFileType](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html) , [UploadFileRequest](https://developer.ebay.com/devzone/post-order/types/UploadFileRequest.html) Calls that use one or more values of FilePurposeEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/file/upload POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_file_upload__post.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ITEM\_RELATED | This enumeration value indicates that the file is intended to provide more information about the item. For example, in a case where the buyer and seller are in disagreement over the condition of the item, the buyer or seller may provide a photo of the item that visually shows the condition of the item. | | LABEL\_RELATED | This enumeration value indicates that the file is intended to provide more information about a shipping label or shipment tracking information. For example, in a case where the buyer and seller are in disagreement over whether shipment tracking information has been provided or not, the buyer or seller may provide a photo of the shipping label itself, or they may provide a file that proves a package has been shipped or delivered. | | REFUND\_RELATED | This enumeration value indicates that the file is intended to provide more information about a buyer refund. For example, in a case where the buyer is saying that they have not recieved their refund, the seller may provide a file that proves that a refund has been issued. | | UNKNOWN | This enumeration value should not be used in a Submit/Upload File request, but it is possible that this value may get returned in a response if the purpose of the file is not known. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnPayoutRecoupInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnPayoutRecoupInfoType ========================== This type provides the amount of money that eBay needs to recoup from the seller to fund a buyer refund and the unique identifier of the seller payout that is associated with the purchase of the line item. Type that uses ReturnPayoutRecoupInfoType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ReturnPayoutRecoupInfoType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ amountToRecoup ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount of money that eBay needs to recoup from the seller to fund a buyer refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#amountToRecoup) to learn which calls use amountToRecoup. payoutId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) A unique eBay-assigned ID that identifies the seller payout that is associated with the purchase of the line item. The seller payout that is associated with the purchase of the line item will often by used as the funding source if payout funds are still available. The seller's funding source for a buyer refund is shown in the **fundingSource.type** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#payoutId) to learn which calls use payoutId. --- # StringValue - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) StringValue =========== This class holds a String value Type that uses StringValue: [Value](https://developer.ebay.com/devzone/product/CallRef/types/Value.html) Calls that use StringValue: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Field ----- value ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) A string value. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#value) to learn which calls use value. --- # ReturnPolicyProfile - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ReturnPolicyProfile ( [SellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html) ) =============================================================================================================================== Type defining the **returnPolicyProfile** container, which is the container used to define one return policy for a seller. Types that use ReturnPolicyProfile: [AddSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileRequest.html) , [AddSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileResponse.html) , [ReturnPolicyProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfileList.html) , [SetSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileRequest.html) , [SetSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileResponse.html) Calls that use ReturnPolicyProfile: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ internationalReturnPolicyInfo ( _[InternationalReturnPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/InternationalReturnPolicyInfo.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container consists of detailed information on a seller's international return policy (returns that require an international shipping service to ship). This container is optional and allows for a seller to establish an international return policy that differs from their domestic return policy. This container is returned by **getSellerProfiles** if one or more return policies match the input criteria in the call request. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#internationalReturnPolicyInfo) to learn which calls use internationalReturnPolicyInfo. returnPolicyInfo ( _[ReturnPolicyInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyInfo.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container consists of detailed information on a seller's return policy. This container is conditionally required if the caller is creating a new return policy or modifying an existing return policy. This container is returned by **getSellerProfiles** if one or more return policies match the input criteria in the call request. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnPolicyInfo) to learn which calls use returnPolicyInfo. --- # URIValue - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) URIValue ======== This class holds a URL value Type that uses URIValue: [Value](https://developer.ebay.com/devzone/product-metadata/CallRef/types/Value.html) Calls that use URIValue: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Field ----- value ( _[anyURI](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#anyURI) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#value) to learn which calls use value. --- # OrderType - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) OrderType ( [string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) ) ================================================================================================================== \[NOT USED BY ANY CALLS\] Orphan type. Type that uses OrderType: [SortOrder](https://developer.ebay.com/devzone/product-metadata/CallRef/types/SortOrder.html) Calls that use one or more values of OrderType: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | Ascending | Sorts results in ascending (low to high) order. | | Descending | Sorts results in descending (high to low) order. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product-metadata/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # InquiryDetails - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) InquiryDetails ============== Type used by the **inquiryDetails** container of the **GET /post-order/v2/inquiry/{inquiryId}** response. The **inquiryDetails** container provides details about a specific INR inquiry that is identified through a path parameter in the request. Type that uses InquiryDetails: [InquiryDetailsResponse](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html) Call that uses InquiryDetails: [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [appealDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#appealDetails) ( _[AppealDetails](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [escalationDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#escalationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [expirationDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#expirationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [lastBuyerRespDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#lastBuyerRespDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [refundAmounts](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#refundAmounts) ( _[RefundAmounts](https://developer.ebay.com/devzone/post-order/types/RefundAmounts.html) _ ) [refundChargeAmount](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#refundChargeAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [refundDeadlineDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#refundDeadlineDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [totalAmount](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html#totalAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) appealDetails ( _[AppealDetails](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of information related to the appeal of a case decision. This container is only returned for an INR inquiry that was escalated into a case and the case decision was appealed by the buyer or seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealDetails) to learn which calls use appealDetails. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the INR inquiry was created by the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. escalationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the INR inquiry was escalated to a case. This container is not returned if the inquiry was not escalated. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalationDate) to learn which calls use escalationDate. expirationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the INR inquiry will naturally expire if no further action is taken. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#expirationDate) to learn which calls use expirationDate. lastBuyerRespDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the buyer last responded to, or performed an action on the INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastBuyerRespDate) to learn which calls use lastBuyerRespDate. refundAmounts ( _[RefundAmounts](https://developer.ebay.com/devzone/post-order/types/RefundAmounts.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of details related to the expected and actual buyer refund amounts related to an INR inquiry or case. This container is only returned if a refund is scheduled to, or has been issued to the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundAmounts) to learn which calls use refundAmounts. refundChargeAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount charged to the seller for this buyer refund. The value will be in the seller's default currency. This container is only applicable and is only returned if a refund has been issued to the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundChargeAmount) to learn which calls use refundChargeAmount. refundDeadlineDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the seller is required to issue a refund for the INR inquiry. This container is only returned if the buyer is seeking a full refund and no longer wants the missing item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundDeadlineDate) to learn which calls use refundDeadlineDate. totalAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total cost of the order, including the item price and shipping fees. This will generally be the amount that the buyer will expect to receive if the buyer is seeking a full refund for the missing item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#totalAmount) to learn which calls use totalAmount. --- # SortOrder - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) SortOrder ========= Sort order input for the result set. Any of the searchable properties can be used for property name and order can be either Ascending or Descending. Type that uses SortOrder: [GetProductSearchValuesBaseRequest](https://developer.ebay.com/devzone/product-metadata/CallRef/types/GetProductSearchValuesBaseRequest.html) Calls that use SortOrder: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ order ( _[OrderType](https://developer.ebay.com/devzone/product-metadata/CallRef/types/OrderType.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Order of the sort, either Ascending or Descending. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#order) to learn which calls use order. propertyName ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Output can be sorted by one or more (for bulk calls) property names. You can look up valid values using either the **getProductSearchNames** call or the **getCompatibilitySearchNames** call. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#propertyName) to learn which calls use propertyName. --- # InquiryDetailsResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) InquiryDetailsResponse ====================== The base response type for the **GET /post-order/v2/inquiry/{inquiryId}** method. This type provides full details on an INR inquiry. Call that uses InquiryDetailsResponse: [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [claimAmount](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#claimAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [creationReason](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#creationReason) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [extTransactionId](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#extTransactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [initiator](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#initiator) ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [inquiryClosureDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#inquiryClosureDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [inquiryContentOnHold](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#inquiryContentOnHold) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [inquiryDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#inquiryDetails) ( _[InquiryDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html) _ ) [inquiryHistoryDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#inquiryHistoryDetails) ( _[ClaimHistoryResponse](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryResponse.html) _ ) [inquiryId](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#inquiryId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [inquiryQuantity](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#inquiryQuantity) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [itemDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#itemDetails) ( _[ItemDetails](https://developer.ebay.com/devzone/post-order/types/ItemDetails.html) _ ) [itemId](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#itemId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [returnDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#returnDetails) ( _[ReturnAddress](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html) _ ) [sellerMakeItRightByDate](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#sellerMakeItRightByDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [shippingCost](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#shippingCost) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [state](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#state) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [status](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#status) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [transactionId](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#transactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [viewPPTrasanctionUrl](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html#viewPPTrasanctionUrl) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) claimAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container displays the dollar value of the order line item associated with the inquiry, which is generally the amount of the refund that the buyer will receive if the buyer is looking for a refund, or if the seller voluntarily refunds the buyer. **Note:** There's a possibility that this value can be inaccurate if the buyer passed in an inaccurate value into the **claimQuantity** field when the inquiry was created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#claimAmount) to learn which calls use claimAmount. creationReason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value in this field indicates why the buyer created an INR inquiry for the line item. The list of enumeration values that may be returned in this field are defined in the [INRCreationReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/INRCreationReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationReason) to learn which calls use creationReason. extTransactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the unique identifier of the payment transaction for the order. This field will only be returned if the payment transaction happened outside of eBay's system. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#extTransactionId) to learn which calls use extTransactionId. initiator ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The party who created this inquiry. In most cases, this value will be `BUYER`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#initiator) to learn which calls use initiator. inquiryClosureDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the inquiry was closed. This container will only be returned if the INR inquiry has been closed. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryClosureDate) to learn which calls use inquiryClosureDate. inquiryContentOnHold ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field indicates the item content related to the inquiry is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding inquiry content is on hold due to eBay policy violation; false otherwise. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryContentOnHold) to learn which calls use inquiryContentOnHold. inquiryDetails ( _[InquiryDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides details on the specified INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryDetails) to learn which calls use inquiryDetails. inquiryHistoryDetails ( _[ClaimHistoryResponse](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryResponse.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of information about the events and actions that have occurred throughout the course of the specified INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryHistoryDetails) to learn which calls use inquiryHistoryDetails. inquiryId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the INR inquiry for which details have been retrieved. All information returned in the response is relevant to this specific INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryId) to learn which calls use inquiryId. inquiryQuantity ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This integer is the quantity of the line item purchased by the buyer. This value is the same value passed into the **claimQuantity** field when the INR inquiry was created. If the **claimQuantity** field was omitted when the INR inquiry was created, this value defaults to `1`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#inquiryQuantity) to learn which calls use inquiryQuantity. itemDetails ( _[ItemDetails](https://developer.ebay.com/devzone/post-order/types/ItemDetails.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of details related to the item associated with the INR inquiry, including the item title, price, and the URL of the gallery picture. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemDetails) to learn which calls use itemDetails. itemId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the **transactionId** field to identify a line item that is associated with the INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemId) to learn which calls use itemId. returnDetails ( _[ReturnAddress](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of information related to a buyer returning an order to the seller, including the seller's return address and the RMA number (if applicable). This container is only returned under the following circumstances: * The INR inquiry was escalated to a case. * The seller already shipped the order line item * The buyer's desired outcome upon creating the INR inquiry was to get a full refund for the missing order line item See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnDetails) to learn which calls use returnDetails. sellerMakeItRightByDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the seller is expected to resolve this INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerMakeItRightByDate) to learn which calls use sellerMakeItRightByDate. shippingCost ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the cost of shipping the order line item associated with this inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#shippingCost) to learn which calls use shippingCost. state ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current state of the INR inquiry. The list of enumeration values that may be returned in this field are defined in the [InquiryStateEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/InquiryStateEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#state) to learn which calls use state. status ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the INR inquiry. The list of enumeration values that may be returned in this field are defined in the [InquiryStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/InquiryStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#status) to learn which calls use status. transactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the purchase transaction. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the **itemId** field to identify the line item that is associated with the INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionId) to learn which calls use transactionId. viewPPTrasanctionUrl ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) **THIS FIELD IS DEPRECATED**. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#viewPPTrasanctionUrl) to learn which calls use viewPPTrasanctionUrl. --- # NumericValue - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) NumericValue ============ This class holds a numeric value Type that uses NumericValue: [Value](https://developer.ebay.com/devzone/product/CallRef/types/Value.html) Calls that use NumericValue: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ unitOfMeasurement ( _[token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Unit of measure for a numeric value. **Allowed values:** bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10\-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#unitOfMeasurement) to learn which calls use unitOfMeasurement. value ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#value) to learn which calls use value. --- # Notes - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) Notes ===== Container for notes related to a product in the eBay catalog. Type that uses Notes: [Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) Calls that use Notes: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Field ----- noteDetails ( _[PropertyValue](https://developer.ebay.com/devzone/product/CallRef/types/PropertyValue.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Additional comments about the product in the form of name-value pairs. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#noteDetails) to learn which calls use noteDetails. --- # RefundInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RefundInfoType ============== This type is used by the **refundInfo** container, which provides detailed information on the estimated and actual refund amounts. Type that uses RefundInfoType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use RefundInfoType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ actualRefundDetail ( _[ActualRefundDetailType](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the itemized refund information after the seller issues a refund to the buyer. This container is only returned if the seller has issued a refund to the buyer. Until the refund is actually successfully processed, only information on the estimated refund may be seen in the **estimatedRefundDetail** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actualRefundDetail) to learn which calls use actualRefundDetail. estimatedRefundDetail ( _[EstimatedRefundDetailType](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows estimated refund information for the buyer. There will be one **itemizedRefundDetail** container returned under this container for each refund fee type (such as purchase price and original shipping). See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#estimatedRefundDetail) to learn which calls use estimatedRefundDetail. --- # DepositDetails - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) DepositDetails ============== Type that defines the **depositDetails** container, which is used by the seller to specify amounts and due dates for deposits and full payment on eBay Motors (US and CA) vehicle listings. The **depositDetails** container is conditionally required if the the payment policy is for eBay Motors (US and CA) vehicles listings (**categoryGroup.name=MOTORS\_VEHICLE**). Type that uses DepositDetails: [PaymentInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html) Calls that use DepositDetails: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ daysToFullPayment ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following **acceptedPaymentMethod** values must be specified for the corresponding payment policy: * CashOnPickup * LoanCheck * MOCC (money order or cashier's check) * PersonalCheck See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#daysToFullPayment) to learn which calls use daysToFullPayment. depositAmount ( _[Amount](https://developer.ebay.com/Devzone/business-policies/CallRef/types/Amount.html) ([double](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#double) )_ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the **categoryGroup.name**field is set to 'MOTORS\_VEHICLE'. If not specified, this value defaults to '0.0'. If this value is specified, the seller must also specify an **hoursToDeposit** value. The deposit amount appears in the shipping, payment details and return policy sections of the View Item page. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#depositAmount) to learn which calls use depositAmount. hoursToDeposit ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make an initial deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'. The deposit amount is specified in the **depositAmount** field. If not specified, the **depositAmount** value defaults to '0.0', in which case, a deposit on the vehicle is not required. **Note:** The **hoursToDeposit** value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#hoursToDeposit) to learn which calls use hoursToDeposit. --- # RlspTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RlspTypeEnum ============ This enumerated type defines the values that can be returned for an Australian-based shipping service. Type that uses RlspTypeEnum: [ResponseHistoryAttributesType](https://developer.ebay.com/Devzone/post-order/types/ResponseHistoryAttributesType.html) Calls that use one or more values of RlspTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AU\_PARCELPOINT | This enumeration value indicates that the shipping service is a Parcel Point shipping service. | | AU\_PARCELPOINT\_AUPOST | This enumeration value indicates that the shipping service is a Parcel Point/Australia Post shipping service used for low coverage/remote areas. | | AU\_PARCELPOINT\_AUPOST\_DROP | This enumeration value indicates that the shipping service is a Parcel Point/Australia Post shipping service with dropoff. | | AU\_PARCELPOINT\_COURIER\_PICKUP | This enumeration value indicates that the shipping service is a Parcel Point shipping service with courier pickup. | | UNKNOWN | This enumeration value indicates that the shipping serviceis not known. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Refund_MoneyMovementStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) Refund\_MoneyMovementStatusEnum =============================== This enumerated type defines the possible values that can be returned for the status of a buyer refund. Types that use Refund\_MoneyMovementStatusEnum: [ActualRefundDetailType](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html) , [DecideReturnResponse](https://developer.ebay.com/devzone/post-order/types/DecideReturnResponse.html) , [IssueRefundResponse](https://developer.ebay.com/devzone/post-order/types/IssueRefundResponse.html) Calls that use one or more values of Refund\_MoneyMovementStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/decide POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_decide__post.html) , [/post-order/v2/return/{returnId}/issue\_refund POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_issue_refund__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | This enumeration value indicates that the buyer refund transaction failed. | | PENDING | This enumeration value indicates that the buyer refund is in the pending state. | | REQUESTED | This enumeration value indicates that a refund has been requested by the buyer. | | SUCCESS | This enumeration value indicates that the buyer refund was successful. | | UNKNOWN | This enumeration value indicates that the result of the buyer refund transaction is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # PaymentProfileList - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) PaymentProfileList ================== Container consisting of one or more payment policies that match the input criteria in a **getSellerProfiles** call request. Type that uses PaymentProfileList: [GetSellerProfilesResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/GetSellerProfilesResponse.html) Call that uses PaymentProfileList: [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) Field ----- PaymentProfile ( _[PaymentProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfile.html) _ ) [\[1..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of details for a specific payment policy. A **PaymentProfile** container is returned in **getSellerProfiles** for each payment policy that matches the input criteria. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#PaymentProfile) to learn which calls use PaymentProfile. --- # ProvideLabelRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ProvideLabelRequest =================== The base request type of the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** method. Call that uses ProvideLabelRequest: [/post-order/v2/return/{returnId}/add\_shipping\_label POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) Fields ------ [carrierEnum](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#carrierEnum) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [carrierName](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#carrierName) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [comments](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#comments) ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [fileId](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#fileId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [forwardShippingLabelProvided](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#forwardShippingLabelProvided) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [labelAction](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#labelAction) ( _[LabelActionEnum](https://developer.ebay.com/devzone/post-order/types/LabelActionEnum.html) _ ) [labelSentDate](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#labelSentDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [noLabelReason](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#noLabelReason) ( _[NoSellerUploadLabelReasonEnum](https://developer.ebay.com/devzone/post-order/types/NoSellerUploadLabelReasonEnum.html) _ ) [returnLabelCost](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#returnLabelCost) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [trackingNumber](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html#trackingNumber) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) carrierEnum ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) One of the values defined in the [ShippingCarrierEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/ShippingCarrierEnum.html) type definition must be used in this field to indicate the shipping carrier that will be used to ship the return item. This field is conditionally required if the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** method is being used to initiate an eBay shipping label. Otherwise, the **carrierName** field can be used to indicate which shipping carrier will be used. Note that the [ShippingCarrierEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/ShippingCarrierEnum.html) type defines enumeration values for some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete global list. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#carrierEnum) to learn which calls use carrierEnum. carrierName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is used to show the name of the shipping carrier. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#carrierName) to learn which calls use carrierName. comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container can be used to include any applicable comments about the shipping label. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. fileId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique ID of a file attached to the return request. This field may be used if the seller has associated a shipping label related file to the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileId) to learn which calls use fileId. forwardShippingLabelProvided ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field should be provided and set to `true` if the seller has already provided the buyer with a return shipping label. This field is generally provided if the **labelAction** value is set to `MARK_AS_SENT`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#forwardShippingLabelProvided) to learn which calls use forwardShippingLabelProvided. labelAction ( _[LabelActionEnum](https://developer.ebay.com/devzone/post-order/types/LabelActionEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This required field indicates what action is being taken with the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** request. Based on what value is supplied here, the **noLabelReason**, **forwardShippingLabelProvided**, and **labelId** fields may become conditionally required. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#labelAction) to learn which calls use labelAction. labelSentDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the shipping label was sent to the buyer or seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#labelSentDate) to learn which calls use labelSentDate. noLabelReason ( _[NoSellerUploadLabelReasonEnum](https://developer.ebay.com/devzone/post-order/types/NoSellerUploadLabelReasonEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is conditionally required if the **labelAction** value is set to `NO_LABEL`. If no shipping label is being provided, the seller must state the reason why through this field. The supported value for this field can be found in the [NoSellerUploadLabelReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/NoSellerUploadLabelReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#noLabelReason) to learn which calls use noLabelReason. returnLabelCost ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the cost of the return shipping label. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnLabelCost) to learn which calls use returnLabelCost. trackingNumber ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The tracking number on the shipping label. If providing the tracking number, the shipping carrier must also be provided through the **carrierEnum** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#trackingNumber) to learn which calls use trackingNumber. --- # EscalationEligibilityInfo - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) EscalationEligibilityInfo ========================= This type is used to indicate if the buyer or seller is eligible to escalate a return request to a case. Type that uses EscalationEligibilityInfo: [EscalationInfoType](https://developer.ebay.com/devzone/post-order/types/EscalationInfoType.html) Calls that use EscalationEligibilityInfo: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ eligible ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This boolean value indicates whether or not the buyer or seller is eligible to escalate the return request to a case. If the value is `true`, the time window in which the buyer or seller can escalate the case is found in the **startTime** and **endTime** containers. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eligible) to learn which calls use eligible. endTime ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container provides the deadline in which the buyer or seller may escalate the return request to a case. As soon as this time expires, the buyer or seller may no longer escalate the return request to a case. This field will not be returned if the value of the **eligible** field is `false`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#endTime) to learn which calls use endTime. startTime ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container provides the earliest date in which the buyer or seller may escalate the return request to a case. As soon as this time arrives, up until the time shown in the **end** field, the buyer or seller is eligible to escalate the return request to a case. This field will not be returned if the value of the **eligible** field is `false`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#startTime) to learn which calls use startTime. --- # SortOrder - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) SortOrder ========= Sort order input for the result set. Any of the searchable properties can be used for property name and order can be either Ascending or Descending. Types that use SortOrder: [CompatibilitySort](https://developer.ebay.com/devzone/product/CallRef/types/CompatibilitySort.html) , [ProductRequest](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html) Calls that use SortOrder: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) Fields ------ order ( _[OrderType](https://developer.ebay.com/devzone/product/CallRef/types/OrderType.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Order of the sort, either Ascending or Descending. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#order) to learn which calls use order. propertyName ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Output can be sorted by one or more property names. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#propertyName) to learn which calls use propertyName. --- # ret:MoneyMovementDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ret:MoneyMovementDetailType =========================== This type is used by the **moneyMovementInfo** container, which consists of detailed information on a monetary transaction. Type that uses ret:MoneyMovementDetailType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ret:MoneyMovementDetailType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [actualAmount](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#actualAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [externalPaymentId](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#externalPaymentId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [moneyMovementType](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#moneyMovementType) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [paymentProvider](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#paymentProvider) ( _[PaymentProviderEnum](https://developer.ebay.com/devzone/post-order/types/PaymentProviderEnum.html) _ ) [requestedAmount](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#requestedAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [status](https://developer.ebay.com/devzone/post-order/types/ret_MoneyMovementDetailType.html#status) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) actualAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the actual amount of the monetary transaction. The **actualAmount** field will only show up if the monetary transaction was confirmed to be successful (**moneyMovementStatusType** values shows as `SUCCESS`. Until then, the expected amount of the monetary transaction can be seen in the **requestedAmount** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actualAmount) to learn which calls use actualAmount. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date and time when the monetary transaction occurred. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. externalPaymentId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the unique ID of a monetary transaction that occurred outside of eBay's system. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#externalPaymentId) to learn which calls use externalPaymentId. moneyMovementType ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the type of monetary transaction that is either in the process of being executed or has already been executed. The supported enumeration values representing monetary transactions are defined in the [MoneyMovementTypeEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/ret_MoneyMovementTypeEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#moneyMovementType) to learn which calls use moneyMovementType. paymentProvider ( _[PaymentProviderEnum](https://developer.ebay.com/devzone/post-order/types/PaymentProviderEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the external payment system used for the monetary transaction. If returned, the value of this field should be `UNKNOWN`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#paymentProvider) to learn which calls use paymentProvider. requestedAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the monetary amount of the transaction. This field is returned regardless of the value shown in the **moneyMovementStatusType** field. The **actualAmount** field displays only when the monetary transaction was confirmed to be successful (**moneyMovementStatusType** equals `SUCCESS`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#requestedAmount) to learn which calls use requestedAmount. status ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the success or failure of the monetary transaction. The enumeration values that may be returned in this field are defined in the [MoneyMovementStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/ret_MoneyMovementStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#status) to learn which calls use status. --- # StringValue - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) StringValue =========== This class holds a String value Type that uses StringValue: [Value](https://developer.ebay.com/devzone/product-metadata/CallRef/types/Value.html) Calls that use StringValue: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Field ----- value ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) A string value. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#value) to learn which calls use value. --- # CategoryGroups - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) CategoryGroups ============== Type defining the **categoryGroups** container, which contains one or more **categoryGroup** containers. Types that use CategoryGroups: [PaymentProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfile.html) , [ReturnPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfile.html) , [ShippingPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfile.html) Calls that use CategoryGroups: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Field ----- categoryGroup ( _[CategoryGroup](https://developer.ebay.com/Devzone/business-policies/CallRef/types/CategoryGroup.html) _ ) [\[1..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS\_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS\_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#categoryGroup) to learn which calls use categoryGroup. --- # MarkAsReceivedRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) MarkAsReceivedRequest ===================== The base request type of the **POST /post-order/v2/return/{returnId}/mark\_as\_received** method, which is used to mark a return item as received by the seller. Call that uses MarkAsReceivedRequest: [/post-order/v2/return/{returnId}/mark\_as\_received POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_mark_as_received__post.html) Field ----- comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container can be used to provide any related comments about marking the order line item as received. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. --- # ItemizedReturnShippingCostType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ItemizedReturnShippingCostType ============================== This type is used by the **itemizedReturnShippingCost** container, which consists of the estimated or actual costs to ship an item. An **itemizedReturnShippingCost** container is required for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service. Type that uses ItemizedReturnShippingCostType: [ReturnShippingCostDetailType](https://developer.ebay.com/Devzone/post-order/types/ReturnShippingCostDetailType.html) Calls that use ItemizedReturnShippingCostType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ amount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount for the shipping cost type shown in the **returnShippingCostType** field. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#amount) to learn which calls use amount. returnShippingCostType ( _[ReturnShippingCostType](https://developer.ebay.com/Devzone/post-order/types/ReturnShippingCostType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the type of shipping cost, such as the cost of the shipping label, shipping insurance, or the signature confirmation service. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#returnShippingCostType) to learn which calls use returnShippingCostType. --- # NumericValue - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) NumericValue ============ This type holds a numeric value. Type that uses NumericValue: [Value](https://developer.ebay.com/devzone/product-metadata/CallRef/types/Value.html) Calls that use NumericValue: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ unitOfMeasurement ( _[token](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Unit of measure for a numeric value. **Allowed values:** bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10\-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#unitOfMeasurement) to learn which calls use unitOfMeasurement. value ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) A number value. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#value) to learn which calls use value. --- # ReturnRefundInitiatorEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnRefundInitiatorEnum ========================= This enumerated type lists the values that indicate the initiator of the refund. Type that uses ReturnRefundInitiatorEnum: [ActualRefundDetailType](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html) Calls that use one or more values of ReturnRefundInitiatorEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AUTO\_REFUND | This enumeration value indicates that eBay automatically refunded the buyer. | | OTHER | This enumeration value indicates that the initiator of the refund is unknown. | | SELLER\_INITIATED | This enumeration value indicates that the refund was initiated by the seller. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ActivityOptionEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) � ActivityOptionEnum ================== This enumerated type lists all possible activities that may occur during the return process. If these values are returned in the **activityDue** fields of the **buyerResponseDue** or **sellerResponseDue** containers, it is the buyer's or seller's next expected action on the return request. If these values are returned under the **responseHistory** container, it is a return request action that has already occurred. Types that use ActivityOptionEnum: [AvailableOptionType](https://developer.ebay.com/devzone/post-order/types/AvailableOptionType.html) , [ReturnResponseDueType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseDueType.html) , [ReturnResponseHistoryType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html) Calls that use one or more values of ActivityOptionEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AUTO\_APPROVE\_REMORSE | This enumeration value indicates that the auto-approve disposition rule for a remorse return has been activated by the system. | | BUYER\_ACCEPT\_REPLACEMENT\_OFFER | This enumeration value indicates that the buyer has accepted, or has the option to accept the offered replacement item.

**Note:** This value is not currently supported. | | BUYER\_ACCEPTS\_NON\_PAYPAL\_PARTIAL\_REFUND | This enumeration value indicates that the buyer accepted the seller's partial refund offer. | | BUYER\_ACCEPTS\_PARTIAL\_REFUND | This enumeration value indicates that the buyer accepted the seller's partial refund offer. | | BUYER\_CLOSE\_RETURN | This enumeration value indicates that the buyer closed the return request. | | BUYER\_CREATE\_RETURN | This enumeration value indicates that the buyer created a return request. | | BUYER\_DECLINE\_PARTIAL\_REFUND | This enumeration value indicates that the buyer declined the seller's partial refund offer. | | BUYER\_DECLINE\_REPLACEMENT\_OFFER | This enumeration value indicates that the buyer has declined, or has the option to decline the offered replacement item.

**Note:** This value is not currently supported. | | BUYER\_ESCALATE | This enumeration value indicates that the buyer escalated the return request to a return case. | | BUYER\_MARK\_AS\_RECEIVED | This enumeration value indicates that the buyer has marked, or is expected to mark a replacement item as received.

**Note:** This value is not currently supported. | | BUYER\_MARK\_REFUND\_RECEIVED | This enumeration value indicates that the buyer has marked, or is expected to mark a refund as received. | | BUYER\_MARK\_RETURN\_SHIPPED | This enumeration value indicates that the buyer has marked, or is expected to mark the return item as shipped. | | BUYER\_PRINT\_SHIPPING\_LABEL | This enumeration value indicates that the buyer's next action is to print the return shipping label that is available. | | BUYER\_PROVIDE\_LABEL | This enumeration value indicates that the buyer has provided, or is expected to provide a return shipping label. | | BUYER\_PROVIDE\_TRACKING\_INFO | This enumeration value indicates that the buyer has provided, or is expected to provide shipment tracking information for the item that is being returned to the seller. | | BUYER\_SEND\_MESSAGE | This enumeration value indicates that the buyer's next possible action is to send a message to the seller and/or eBay. | | BUYER\_UPDATE\_TRACKING | This enumeration value indicates that the buyer's next possible action is to update the shipment tracking information. | | BUYER\_VOID\_LABEL | This enumeration value indicates that the buyer voided the shipping label that was available. | | CHARGEBACK\_OPEN | This enumeration value indicates that system cancelled the return request because the buyer opened a chargeback request. | | DELETE\_FILE | This enumeration value indicates that a file associated with a return request was deleted. | | EBAY\_RULE\_AUTO\_APPROVE | This enumeration value indicates that eBay's automated business rules have approved a return request. | | EMAIL\_SHIPPING\_LABEL | This enumeration value indicates that the buyer's or seller's next action is to email the link to a shipping label for themselves or for their order partner. | | EXTERNAL\_CLAIM\_OPENED | This enumeration value indicates that the system has been notified that an external claim has been opened. | | GENERAL\_TIME\_OUT | This enumeration value indicates that the system timed out. | | NOTIFIED\_DELIVERED | This enumeration value indicates that the eBay system has been notified that a return item has been delivered to the recipient. | | NOTIFIED\_SHIPPED | This enumeration value indicates that the eBay system has been notified that a return item has been shipped. | | NOTIFY\_REPLACEMENT\_DELIVERED | This enumeration value indicates that the system has been notified that a replacement item has been delivered to the buyer.

**Note:** This value is not currently supported. | | NOTIFY\_REPLACEMENT\_SHIPPED | This enumeration value indicates that the system has been notified that a replacement item has been shipped by the seller.

**Note:** This value is not currently supported. | | NOTIFY\_UPDATE\_REFUND\_STATUS | This enumeration value indicates that the system has been notified that the refund status has to be updated. | | OTHER | This enumeration value indicates that action or next possible action cannot be determined. | | REMINDER\_BUYER\_TO\_RESPOND\_RE\_OFFER | This enumeration value indicates that the system was reminded that the buyer has to respond to a reply to a seller's offer to resolve the return request. | | REMINDER\_BUYER\_TO\_SHIP | This enumeration value indicates that the system was reminded that the buyer has to return ship the item. | | REMINDER\_FOR\_REFUND | This enumeration value indicates that the system was reminded that the seller must refund the buyer. | | REMINDER\_FOR\_REFUND\_NO\_SHIPPING | This enumeration value indicates that the system was reminded that the seller must refund the buyer and that the buyer is not expected to return ship the item. | | REMINDER\_FOR\_RMA | This enumeration value indicates that the system was reminded that a Return Merchandise Authorization (RMA) is associated with the return request. | | REMINDER\_FOR\_SHIPPING | This enumeration value indicates that the system was reminded that an item must be shipped. | | REMINDER\_SELLER\_TO\_RESPOND | This enumeration value indicates that the system was reminded that the seller has to make a response on the return request. | | REMINDER\_SELLER\_TO\_SHIP | This enumeration value indicates that the system was reminded that the seller has to ship the replacement item.

**Note:** This value is not currently supported. | | SELLER\_APPROVE\_REQUEST | This enumeration value is returned if the seller has approved a return request, or if approving the return request is one of their next options. | | SELLER\_DECLINE\_REQUEST | This enumeration value is returned if the seller has declined a return request, or if declining the return request is one of their next options. | | SELLER\_ESCALATE | This enumeration value indicates that the seller escalated the return request to a return case. | | SELLER\_ISSUE\_REFUND | This enumeration value indicates that the seller has issued a refund. | | SELLER\_ISSUE\_STORE\_CREDIT\_REFUND | **THIS ENUMERATION VALUE IS DEPRECATED.** | | SELLER\_MARK\_AS\_RECEIVED | This enumeration value indicates that the seller has marked, or is expected to mark a return item as received. | | SELLER\_MARK\_REFUND\_SENT | This enumeration value indicates that the seller has marked, or is expected to mark the refund as sent. | | SELLER\_MARK\_REPLACEMENT\_SHIPPED | This enumeration value indicates that the seller has marked, or is expected to mark the replacement item as shipped.

**Note:** This value is not currently supported. | | SELLER\_OFFER\_PARTIAL\_REFUND | This enumeration value indicates that the seller has offered, or has the option to offer a partial refund to the buyer. | | SELLER\_OFFER\_REPLACEMENT | This enumeration value indicates that the seller has offered, or has the option to offer a replacement item to the buyer.

**Note:** This value is not currently supported. | | SELLER\_OFFER\_RETURNS | This enumeration value indicates that the seller offer returns to buyers. | | SELLER\_PRINT\_SHIPPING\_LABEL | This enumeration value indicates that the seller's next action is to print the shipping label that is available. | | SELLER\_PROVIDE\_LABEL | This enumeration value indicates that the seller has provided, or is expected to provide a shipping label. | | SELLER\_PROVIDE\_RMA | This enumeration value indicates that the seller's next possible action is to provide a return merchandise authorization (RMA) number to the buyer. | | SELLER\_PROVIDE\_TRACKING\_INFO | This enumeration value indicates that the seller has provided, or is expected to provide shipment tracking information for the replacement item that is being sent to the buyer.

**Note:** This value is not currently supported. | | SELLER\_RETRY\_REFUND | This enumeration value indicates that the seller's next possible action is to retry the refund operation. | | SELLER\_SEND\_MESSAGE | This enumeration value indicates that the seller's next possible action is to send a message to the buyer and/or eBay. | | SELLER\_UPDATE\_TRACKING | This enumeration value indicates that the seller's next possible action is to update the shipment tracking information. | | SELLER\_VOID\_LABEL | This enumeration value indicates that the seller voided the shipping label that was available. | | SUBMIT\_FILE | This enumeration value indicates that a file was associated with a return request. | | SYSTEM\_BUYER\_PARTIAL\_REFUND\_AS\_PAYOUT | This enumeration value indicates that the system paid the buyer a partial refund. | | SYSTEM\_BUYER\_REFUND\_AS\_PAYOUT | This enumeration value indicates that the payment system paid the buyer the refund amount. | | SYSTEM\_CLOSE\_RETURN | This enumeration value indicates that the system closed the return request. | | SYSTEM\_CREATE\_RETURN | This enumeration value indicates that the system created the return request. | | SYSTEM\_IMMEDIATE\_REFUND | This enumeration value indicates that the payment system initiated an immediate refund to the buyer. | | SYSTEM\_INITIATED\_REFUND | This enumeration value indicates that the system has automatically initiated a refund to the buyer. | | SYSTEM\_SELLER\_CHARGE | This enumeration value indicates that eBay has automatically initiated a refund from the seller for the return. | | TIME\_OUT\_AFTER\_DECLINE | This enumeration value indicates that the system timed out after the return request was declined. | | TIME\_OUT\_AFTER\_REFUNDED | This enumeration value indicates that the system timed out after the refund. | | TIME\_OUT\_AFTER\_REFUNDED\_AS\_PAYOUT | This enumeration value indicates that the system timed out after the system paid out the buyer. | | TIME\_OUT\_AFTER\_REPLACED | This enumeration value indicates that the system timed out after the replacement item operation.

**Note:** This value is not currently supported. | | TIME\_OUT\_FOR\_AUTHENTICATION | For [Returns with Authenticity Guarantee](https://www.ebay.com/help/selling/selling-tools/selling-authenticity-guarantee?id=4644&st=3&pos=2&query=Selling%20with%20Authenticity%20Guarantee&intent=Authenticity&lucenceai=lucenceai&docId=HELP1344#section3)
items, this enumeration value indicates the authenticator took too long to authenticate the returned item. | | TIME\_OUT\_FOR\_AUTHORIZE | This enumeration value indicates that the system timed out while waiting for the seller to authorize the return request. | | TIME\_OUT\_FOR\_AUTO\_REFUND | This enumeration value indicates that the system timed out while waiting for the auto refund operation. | | TIME\_OUT\_FOR\_BUYER\_RECOUP | This enumeration value indicates that the system timed out while waiting for the buyer recoupment operation. | | TIME\_OUT\_FOR\_DELIVERY | This enumeration value indicates that the system timed out for delivery. | | TIME\_OUT\_FOR\_ESCALATION | This enumeration value indicates that the system timed out while waiting for the return request to be escalated. | | TIME\_OUT\_FOR\_ESCALATION\_AFTER\_SMIR | This enumeration value indicates that the system timed out while waiting for the return request to be escalated after the 'Seller make it right' period has ended. | | TIME\_OUT\_FOR\_ITEM\_REPLACED | This enumeration value indicates that the system timed out while waiting for the replacement item operation.

**Note:** This value is not currently supported. | | TIME\_OUT\_FOR\_MARK\_REFUND\_RECEIVED | This enumeration value indicates that the system timed out for mark refund received operation. | | TIME\_OUT\_FOR\_MARK\_REFUND\_SENT | This enumeration value indicates that the system timed out for mark refund sent operation. | | TIME\_OUT\_FOR\_MASS\_PAYOUT | This enumeration value indicates that the system timed out while waiting for the mass payout operation. | | TIME\_OUT\_FOR\_PAYOUT | This enumeration value indicates that the system timed out while waiting for the seller payout operation. | | TIME\_OUT\_FOR\_PROVIDE\_LABEL | This enumeration value indicates that the system timed out while waiting for the buyer or seller to create/provide a shipping label. | | TIME\_OUT\_FOR\_REFUND | This enumeration value indicates that the system timed out while trying to process a refund operation. | | TIME\_OUT\_FOR\_REPLACEMENT\_DELIVERED\_ITEM\_NOT\_RETURNED | This enumeration value indicates that the system timed out while waiting for the replacement item to be marked as delivered.

**Note:** This value is not currently supported. | | TIME\_OUT\_FOR\_REPLACEMENT\_SHIPPED | This enumeration value indicates that the system timed out while waiting for the seller to mark the replacement item as shipped.

**Note:** This value is not currently supported. | | TIME\_OUT\_FOR\_RETURN\_SHIPPING | This enumeration value indicates that the system timed out while waiting for return shipping operation. | | TIME\_OUT\_FOR\_RMA | This enumeration value indicates that the system timed out while waiting for the seller to provide the Return Merchandise Authorization (RMA). | | TIME\_OUT\_FOR\_SELLER\_INVOICE | This enumeration value indicates that the system timed out while waiting for the seller to be invoiced for the buyer refund. | | TIME\_OUT\_FOR\_SELLER\_PAYOUT | This enumeration value indicates that the system timed out while waiting for the seller payout operation. | | TIME\_OUT\_FOR\_SHIPMENT\_TRACKING | This enumeration value indicates that the system timed out for shipment tracking. | | TIME\_OUT\_FOR\_SHIPPING | This enumeration value indicates that the system timed out while waiting for shipment tracking information. | | TIME\_OUT\_FOR\_SHIPPING\_SYSTEM\_CLOSE | This enumeration value indicates that the system timed out while waiting for shipment tracking system to close the tracking number. | ��\* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Appeal Case Decision - eBay Post-Order API Reference eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) Appeal Case Decision ==================== POST /post-order/v2/casemanagement/{caseId}/appeal -------------------------------------------------- Buyers and sellers can use this method to appeal a case decision that was not ruled in their favor by eBay customer support. Optionally, the buyer or seller can include an explanation of why they appealing the case decision through the **comments** container. This method is not supported in the Sandbox environment. Input ----- See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Samples) . #### Resource URI (production) POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/appeal #### URI parameters | Parameter | Type | Required? | Meaning | | --- | --- | --- | --- | | **caseId** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The unique identifier of a case. This URI parameter is required in order to identify the case for which an appeal will be filed against. The case ID value is passed in as part of the call URI. | #### HTTP request headers All requests made to eBay REST operations require you to provide the `authorization` HTTP header for authentication. See [HTTP request headers](https://developer.ebay.com/ebay-rest/content/rest-request-components.html#HTTP) for details. #### Authorization This call uses standard authorization tokens. See [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) for details. #### Payload model The following lists _all fields that could be included_ in the request. { /\* _[AppealRequest](https://developer.ebay.com/Devzone/post-order/types/AppealRequest.html) _ \*/ "[comments](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Request.comments) ": { /\* [Text](https://developer.ebay.com/Devzone/post-order/types/Text.html) \*/ "[content](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Request.comments.content) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[language](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Request.comments.language) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[translatedFromContent](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Request.comments.translatedFromContent) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[translatedFromLanguage](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Request.comments.translatedFromLanguage) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) } } #### Request field descriptions | Input Container/Field | Type | Occurrence | Meaning | | --- | --- | --- | --- | | **comments** | [Text](https://developer.ebay.com/Devzone/post-order/types/Text.html) | Optional | This container is used if the buyer or seller wants to add a note or explanation about why an appeal is being made against the case decision. | | comments.**content** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This field displays the actual textual content in the language specified in the **language** field. This field is always used for containers using the **Text** type. | | comments.**language** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This two-letter code indicates the language used to display the content in the **content** field. The language will default to the language used on the eBay site if a specific language is not specified through the **Accept-Language** HTTP header. This field is always used for containers using the **Text** type.

The full list of language enumeration values are defined in the [LanguageEnum](https://developer.ebay.com/devzone/post-order/types/LanguageEnum.html)
type definition.

**Applicable values**: See [LanguageEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageEnum.html) | | comments.**translatedFromContent** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | If language translation/localization is required, this field displays the actual textual content in the language specified in the **translatedFromLanguage** field. If language translation was not required, this field is not applicable. | | comments
  .**translatedFromLanguage** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | If language translation/localization is required, this two-letter code indicates the language used to display the content in the **translatedFromContent** field. If language translation was not required, this field is not applicable.

The full list of language enumeration values are defined in the [LanguageEnum](https://developer.ebay.com/devzone/post-order/types/LanguageEnum.html)
type definition.

**Applicable values**: See [LanguageEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageEnum.html) | Output ------ See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_appeal__post.html#Samples) . #### Payload model This call has no response payload. null Samples ------- New to making API calls? Please see [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) . 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. Sample: Appeal a Case Decision This operation files a case decision appeal for a buyer or a seller. **Description** Use this operation to file an appeal on behalf of the buyer or the seller when eBay customer support rules against them in a case decision. **Input** The **caseId** path parameter identifies the INR or Return case being appealed, and the optional **comments** container enables the user to provide the desired degree of detail. **URL format**. See also the [non-wrapped](https://developer.ebay.com/Devzone/post-order/Samples/post-order_v2_casemanagement-caseid_appeal__post_basic_in_url_json.txt) version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/5\*\*\*\*\*\*\*\*7/appeal { "comments":{ "content": "I am not happy with this case decision." } } **Output** There is no output payload with this response. A successful call contains an HTTP status code of 200. **JSON format**. Change History -------------- | Change Date | Description | | --- | --- | --- # ReturnCreationInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnCreationInfoType ====================== This type is used by the **creationInfo** container, which provides details about the buyer's return request, including the order line item (and quantity) that is being returned and the reason for the return. Type that uses ReturnCreationInfoType: [ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) Calls that use ReturnCreationInfoType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [comments](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html#comments) ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [item](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html#item) ( _[ReturnItemType](https://developer.ebay.com/devzone/post-order/types/ReturnItemType.html) _ ) [reason](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html#reason) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [reasonType](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html#reasonType) ( _[ReturnReasonTypeEnum](https://developer.ebay.com/devzone/post-order/types/ReturnReasonTypeEnum.html) _ ) [type](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html#type) ( _[ReturnTypeEnum](https://developer.ebay.com/devzone/post-order/types/ReturnTypeEnum.html) _ ) comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) If provided by the buyer at return creation time, this container provides more information to the seller about why a return is being requested. This container is only returned if the buyer made a comment at the time of creating the return request or draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date/time when the return request was created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. item ( _[ReturnItemType](https://developer.ebay.com/devzone/post-order/types/ReturnItemType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides information on the return item, including listing ID, listing title, order line item ID, and the quantity of the line item that is being returned. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#item) to learn which calls use item. reason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the buyer's reason for creating a return request or draft. The supported enumeration values representing valid return reasons are defined in the [ReturnReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/ReturnReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#reason) to learn which calls use reason. reasonType ( _[ReturnReasonTypeEnum](https://developer.ebay.com/devzone/post-order/types/ReturnReasonTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This value indicates the broad reason why the buyer is opening the return request, such as `SNAD` or `REMORSE`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#reasonType) to learn which calls use reasonType. type ( _[ReturnTypeEnum](https://developer.ebay.com/devzone/post-order/types/ReturnTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the buyer's desired outcome. **Note:** Currently, the only supported value is `MONEY_BACK`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#type) to learn which calls use type. --- # Value - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) Value ===== A value can be one of the types: text (string), a number ( Type that uses Value: [PropertyValue](https://developer.ebay.com/devzone/product/CallRef/types/PropertyValue.html) Calls that use Value: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ number ( _[NumericValue](https://developer.ebay.com/devzone/product/CallRef/types/NumericValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) For numeric value type. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#number) to learn which calls use number. text ( _[StringValue](https://developer.ebay.com/devzone/product/CallRef/types/StringValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) For string value type. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#text) to learn which calls use text. URL ( _[URIValue](https://developer.ebay.com/devzone/product/CallRef/types/URIValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) For URL value type. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#URL) to learn which calls use URL. --- # ErrorSeverity - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) ErrorSeverity ( [token](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#token) ) ==================================================================================================================== Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. Type that uses ErrorSeverity: [ErrorData](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html) Calls that use one or more values of ErrorSeverity: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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 case, 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. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product-metadata/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ItemDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ItemDetailType ============== This type is used by the **itemDetail** container, which consists of information about the order line item, including listing ID, transaction ID, price, transaction date, and quantity being returned. Type that uses ItemDetailType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ItemDetailType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [ebayPlusTxn](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#ebayPlusTxn) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [itemId](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#itemId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [itemOnHold](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#itemOnHold) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [itemPicUrl](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#itemPicUrl) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [itemPrice](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#itemPrice) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [itemTitle](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#itemTitle) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [listingSiteId](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#listingSiteId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [relistedItemId](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#relistedItemId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [relistStatus](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#relistStatus) ( _[RelistStatusEnum](https://developer.ebay.com/devzone/post-order/types/RelistStatusEnum.html) _ ) [returnQuantity](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#returnQuantity) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [transactionDate](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#transactionDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [transactionId](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html#transactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) ebayPlusTxn ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field indicates if the order line item was part of an eBay Plus order. eBay Plus is currently available on the eBay Australia and eBay Germany marketplaces. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#ebayPlusTxn) to learn which calls use ebayPlusTxn. itemId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the **transactionId** field to identify a line item within an order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemId) to learn which calls use itemId. itemOnHold ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field indicates the item related to the return is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding item is on hold due to eBay policy violation; false otherwise. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemOnHold) to learn which calls use itemOnHold. itemPicUrl ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The URL of the gallery image for the listing. This field is returned when available. If the item is on hold, the returned value will be masked. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemPicUrl) to learn which calls use itemPicUrl. itemPrice ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) Shows the price of the item. If currency conversion was needed, the original currency and the exchange rate used are also shown. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemPrice) to learn which calls use itemPrice. itemTitle ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The title of the eBay listing. If the item is on hold, the returned value will be masked. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemTitle) to learn which calls use itemTitle. listingSiteId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the eBay marketplace where the sale occurred. The site IDs used for each eBay marketplace can be found in the [eBay Site ID to Global ID Mapping](https://developer.ebay.com/devzone/post-order//devzone/merchandising/docs/concepts/siteidtoglobalid.html) page. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#listingSiteId) to learn which calls use listingSiteId. relistedItemId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is only returned if the returned item is relisted as a new eBay listing, and this value will be different than the value in the **itemId** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#relistedItemId) to learn which calls use relistedItemId. relistStatus ( _[RelistStatusEnum](https://developer.ebay.com/devzone/post-order/types/RelistStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value either indicates if the order line item is eligible to be relisted, or in a case where the seller wants to relist the item, the value returned here will indicate if relisting was successful or if it failed. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#relistStatus) to learn which calls use relistStatus. returnQuantity ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the quantity of the order line item being returned. This number is typically `1`, unless the buyer bought multiple quantity of the same line item in a multiple-quantity, fixed-price listing. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnQuantity) to learn which calls use returnQuantity. transactionDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This timestamp indicates when the sales transaction occurred. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionDate) to learn which calls use transactionDate. transactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the **itemId** field to identify a line item within an order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionId) to learn which calls use transactionId. --- # ClaimHistoryEventModel - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ClaimHistoryEventModel ====================== This type is used to provide information about each event or action that has occurred with a particular INR inquiry or case. Type that uses ClaimHistoryEventModel: [ClaimHistoryResponse](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryResponse.html) Calls that use ClaimHistoryEventModel: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [action](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html#action) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [actor](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html#actor) ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [date](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html#date) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [description](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html#description) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [moneyMovement](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html#moneyMovement) ( _[MoneyMovementEntries](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntries.html) _ ) action ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates the action initiated by one of the parties involved with the INR inquiry or case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#action) to learn which calls use action. actor ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the party that took this action. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actor) to learn which calls use actor. date ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date and time of this event or action. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#date) to learn which calls use date. description ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) A text-based description of this event or action. This field is returned if available. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#description) to learn which calls use description. moneyMovement ( _[MoneyMovementEntries](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntries.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides details on one or more monetary transactions that were involved with the event or action. This container is not returned if no monetary transaction was involved with the event or action. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#moneyMovement) to learn which calls use moneyMovement. --- # EscalateRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) EscalateRequest =============== The base request type of the **POST /post-order/v2/return/{returnId}/escalate** method, which is used to escalate a return request to a case. Call that uses EscalateRequest: [/post-order/v2/return/{returnId}/escalate POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_escalate__post.html) Fields ------ comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container is used if the buyer or seller wants to add a note or explanation about why the return request is being escalated to a case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. reason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is used to specify the reason why the buyer or seller is escalating the specified return request into a case. One of the enumeration values defined in the [EscalateReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/EscalateReasonEnum.html) type definition must be used here. Some values are only applicable to the buyer escalating the return request, some values are only applicable to the seller escalating the return request, and some values are relevant to either party. Although this field is not required, it is recommended that it is used by the buyer or seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#reason) to learn which calls use reason. --- # Close Case - eBay Post-Order API Reference eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) Close Case ========== POST /post-order/v2/casemanagement/{caseId}/close ------------------------------------------------- **Note:** This call has been deprecated and will be decommissioned on March 2, 2026. This method can be used on behalf of buyers to close an open case. Buyers can close an INR case after the item arrives, and they might close a Return case if they decide to keep the item, or have otherwise worked out an agreement with the seller. This method is not supported in the Sandbox environment. Input ----- See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Samples) . #### Resource URI (production) POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/close #### URI parameters | Parameter | Type | Required? | Meaning | | --- | --- | --- | --- | | **caseId** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The unique identifier of a case. This URI parameter is required in order to identify the case that is being closed. The case ID value is passed in as part of the call URI. | #### HTTP request headers All requests made to eBay REST operations require you to provide the `authorization` HTTP header for authentication. See [HTTP request headers](https://developer.ebay.com/ebay-rest/content/rest-request-components.html#HTTP) for details. #### Authorization This call uses standard authorization tokens. See [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) for details. #### Payload model The following lists _all fields that could be included_ in the request. { /\* _[BuyerCloseCaseRequest](https://developer.ebay.com/Devzone/post-order/types/BuyerCloseCaseRequest.html) _ \*/ "[closeReason](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Request.closeReason) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[comments](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Request.comments) ": { /\* [Text](https://developer.ebay.com/Devzone/post-order/types/Text.html) \*/ "[content](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Request.comments.content) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[language](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Request.comments.language) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[translatedFromContent](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Request.comments.translatedFromContent) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[translatedFromLanguage](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Request.comments.translatedFromLanguage) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) } } #### Request field descriptions | Input Container/Field | Type | Occurrence | Meaning | | --- | --- | --- | --- | | **closeReason** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | This field is used to provide a reason why the buyer is closing the case. One of the values in the **BuyerCloseReasonEnum** type (shown below) must be used. If the `OTHER` value is passed in, the buyer should use the **comments** container to provide some more details on why the case is being closed.

**Applicable values are from [BuyerCloseReasonEnum](https://developer.ebay.com/Devzone/post-order/types/BuyerCloseReasonEnum.html)
**:


ITEM\_ARRIVED

This enumeration value indicates that the buyer closed the INR inquiry or case because the item arrived.

OTHER

This enumeration value indicates that the buyer closed the INR inquiry or case for an undisclosed reason.

WORKED\_OUT\_WITH\_SELLER

This enumeration value indicates that the buyer closed the INR inquiry or case after working out a solution with the seller.

WOULD\_RATHER\_KEEP\_THE\_ITEM

This enumeration value indicates that the case is being closed because the buyer has decided to keep the item. This value cannot be used as a **closeReason** in a **POST /post-order/v2/inquiry/{inquiryId}/close** request. | | **comments** | [Text](https://developer.ebay.com/Devzone/post-order/types/Text.html) | Optional | This container can be used if the buyer wants to provide more details on why the case is being closed. | | comments.**content** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This field displays the actual textual content in the language specified in the **language** field. This field is always used for containers using the **Text** type. | | comments.**language** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This two-letter code indicates the language used to display the content in the **content** field. The language will default to the language used on the eBay site if a specific language is not specified through the **Accept-Language** HTTP header. This field is always used for containers using the **Text** type.

The full list of language enumeration values are defined in the [LanguageEnum](https://developer.ebay.com/devzone/post-order/types/LanguageEnum.html)
type definition.

**Applicable values**: See [LanguageEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageEnum.html) | | comments.**translatedFromContent** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | If language translation/localization is required, this field displays the actual textual content in the language specified in the **translatedFromLanguage** field. If language translation was not required, this field is not applicable. | | comments
  .**translatedFromLanguage** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | If language translation/localization is required, this two-letter code indicates the language used to display the content in the **translatedFromContent** field. If language translation was not required, this field is not applicable.

The full list of language enumeration values are defined in the [LanguageEnum](https://developer.ebay.com/devzone/post-order/types/LanguageEnum.html)
type definition.

**Applicable values**: See [LanguageEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageEnum.html) | Output ------ See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_close__post.html#Samples) . #### Payload model This call has no response payload. null Samples ------- New to making API calls? Please see [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) . 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. Sample: Basic Call Closing a case **Description** This call allows a buyer or seller to close a case before eBay customer support makes a decision on the case. In this particular sample, it is the buyer that is closing an INR case after finally receiving the item from the seller. **Input** The buyer passes in the case ID value as a path parameter to identify the case that is being closed. The **closeReason** field is required and the seller's reason for closing the case is `ITEM_ARRIVED`. The buyer also includes the optional **comments** container to provide a little more detail. **URL format**. See also the [non-wrapped](https://developer.ebay.com/Devzone/post-order/Samples/post-order_v2_casemanagement-caseid_close__post_basic_in_url_json.txt) version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/close { "closeReason": "ITEM\_ARRIVED", "comments": { "content": "I am closing the case because the item has arrived." } } **Output** There is no output payload with this response. A successful call contains an HTTP status code of 200. **JSON format**. Change History -------------- | Change Date | Description | | --- | --- | --- # Product Services APIs Product API * [Features Guide](https://developer.ebay.com/DevZone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/DevZone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product/ReleaseNotes.html) Product Services APIs ===================== **Note:** eBay Product Services is no longer just for retrieving product-related information for Parts Compatibility (aka vehicle fitment). The Product and Product Metadata APIs can now support Product Creation, the ability to submit products for inclusion in the eBay catalogs. The Prouct API and Product Metadata API support eBay's Parts Compatibility feature: | API | Description | | --- | --- | | [Product API](https://developer.ebay.com/DevZone/product/CallRef/index.html) | This API lets you retrieve product information for categories that are catalog enabled. It also allows you to add new products to an eBay catalog where needed. | | [Product Metadata API](https://developer.ebay.com/DevZone/product-metadata/CallRef/index.html) | This API retrieves metadata used to list items with Parts Compatibility or add products to an eBay catalog (Product Creation). | --- # ReturnHoldInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnHoldInfoType ================== This type is used by the **holdInfo** container, which provides information on a hold that has been initiated on a return request. The **holdInfo** container and its child elements are only returned if a hold has been placed on the return request. Type that uses ReturnHoldInfoType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ReturnHoldInfoType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [holdCreationDate](https://developer.ebay.com/devzone/post-order/types/ReturnHoldInfoType.html#holdCreationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [holdReferenceId](https://developer.ebay.com/devzone/post-order/types/ReturnHoldInfoType.html#holdReferenceId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [holdReleaseDate](https://developer.ebay.com/devzone/post-order/types/ReturnHoldInfoType.html#holdReleaseDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [holdStatus](https://developer.ebay.com/devzone/post-order/types/ReturnHoldInfoType.html#holdStatus) ( _[ReturnHoldStatusEnum](https://developer.ebay.com/devzone/post-order/types/ReturnHoldStatusEnum.html) _ ) [holdTransactionId](https://developer.ebay.com/devzone/post-order/types/ReturnHoldInfoType.html#holdTransactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) holdCreationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date/time when the hold on the return request was initiated. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#holdCreationDate) to learn which calls use holdCreationDate. holdReferenceId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the unique eBay-assigned ID of the hold on the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#holdReferenceId) to learn which calls use holdReferenceId. holdReleaseDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date/time when the hold on the return request is expected to get released. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#holdReleaseDate) to learn which calls use holdReleaseDate. holdStatus ( _[ReturnHoldStatusEnum](https://developer.ebay.com/devzone/post-order/types/ReturnHoldStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the current status of the hold on the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#holdStatus) to learn which calls use holdStatus. holdTransactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the unique eBay-assigned ID of the transaction that is a part of the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#holdTransactionId) to learn which calls use holdTransactionId. --- # ShippingMethodEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ShippingMethodEnum ================== This enumerated type lists the values that indicate whether the buyer/seller used an eBay shipping label or arranged for shipping on their own. Type that uses ShippingMethodEnum: [ShipmentTrackingType](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingType.html) Calls that use one or more values of ShippingMethodEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | SELF\_MAIL | This enumeration value indicates that the buyer or seller handled the shipping of an item on their own, and did not use an eBay shipping label. | | SHIPPING\_LABEL | This enumeration value indicates that the buyer or seller used an eBay shipping label to ship an item. | | UNKNOWN | This enumeration value indicates it is unknown whether the buyer or seller used an eBay shipping label to ship an item, or handled the shipping on their own. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # NoSellerUploadLabelReasonEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) NoSellerUploadLabelReasonEnum ============================= This enumerated type lists the possible values that a seller can provide in the **noLabelReason** field of the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** to indicate the reason why a shipping label is not being supplied to the buyer. Type that uses NoSellerUploadLabelReasonEnum: [ProvideLabelRequest](https://developer.ebay.com/Devzone/post-order/types/ProvideLabelRequest.html) Call that uses one or more values of NoSellerUploadLabelReasonEnum: [/post-order/v2/return/{returnId}/add\_shipping\_label POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ITEM\_TOO\_LARGE | This enumeration value is used in the **noLabelReason** field if the item is too large to be shipped using a return shipping label. Many shipping carriers have a weight limit. | | OTHER | This enumeration value is used in the **noLabelReason** field if there is another reason why the seller is not providing a return shipping label to the buyer. If this value is used, it is good idea if the seller includes the **comments** container of the request to provide more details on the reason why no shipping label is being provided. | | REIMBURSE | This enumeration value is used in the **noLabelReason** field if the seller will not provide a return shipping label to the buyer, but will reimburse the buyer for the return shipping cost. | | RETURN\_TO\_INTL\_LOCATION | This enumeration value is used in the **noLabelReason** field if a return shipping label is not being provided to the buyer because the return address is located in another country. | | RETURN\_TO\_STORE | This enumeration value is used in the **noLabelReason** field if the seller is asking the buyer to return the item to the store. This value is applicable for In-Store Pickup and Click and Collect orders. | | WORK\_WITH\_BUYER | This enumeration value is used in the **noLabelReason** field if the seller will work with the buyer to determine how return shipping costs will be handled. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # EligibilityResultType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) EligibilityResultType ===================== This type is used by the **eligibilityInfo** container, which includes the results of the return eligibility check, including any errors that may have occurred with the eligibility check. Type that uses EligibilityResultType: [ReturnEligibilityItemPerCheckTypeResult](https://developer.ebay.com/devzone/post-order/types/ReturnEligibilityItemPerCheckTypeResult.html) Call that uses EligibilityResultType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) Fields ------ [caseId](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#caseId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eligibilityErrorDetail](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#eligibilityErrorDetail) ( array of _[ReturnEligibilityErrorDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnEligibilityErrorDetailType.html) _ ) [eligibilityStatus](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#eligibilityStatus) ( _[StatusType](https://developer.ebay.com/devzone/post-order/types/StatusType.html) _ ) [eligibleStartDate](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#eligibleStartDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [returnCreationDate](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#returnCreationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [returnDeadline](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#returnDeadline) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [returnId](https://developer.ebay.com/devzone/post-order/types/EligibilityResultType.html#returnId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) caseId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This value is the unique eBay-assigned ID of an eBay case associated with the return request. This field is only returned if the return request was escalated into an eBay case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseId) to learn which calls use caseId. eligibilityErrorDetail ( array of _[ReturnEligibilityErrorDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnEligibilityErrorDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array may consist of one or more errors that may have occurred with the return eligibility check. This array is only returned if one or more return eligibility check errors occurred. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eligibilityErrorDetail) to learn which calls use eligibilityErrorDetail. eligibilityStatus ( _[StatusType](https://developer.ebay.com/devzone/post-order/types/StatusType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the success or failure of a return eligibility check. See **StatusType** for the description of the supported values. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eligibilityStatus) to learn which calls use eligibilityStatus. eligibleStartDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the buyer is first eligible to create a return request for a item. This field is not returned if the buyer is not eligible to return the item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eligibleStartDate) to learn which calls use eligibleStartDate. returnCreationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date/time when the return request was created. This field is only returned if a return request was successfully created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnCreationDate) to learn which calls use returnCreationDate. returnDeadline ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the deadline for which the buyer must file a return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnDeadline) to learn which calls use returnDeadline. returnId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of the newly-created return request. This field is only returned if a return request was successfully created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnId) to learn which calls use returnId. --- # LabelActionEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) LabelActionEnum =============== This enumerated type lists the actions that may be specified in the **labelAction** field in the request of the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** method. Type that uses LabelActionEnum: [ProvideLabelRequest](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html) Call that uses one or more values of LabelActionEnum: [/post-order/v2/return/{returnId}/add\_shipping\_label POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AU\_LABEL | This value is used if an Australian seller has created an eBay shipping label for the return shipment. Australian sellers are billed for eBay shipping labels on their monthly invoice. | | EBAY\_LABEL | This value is used if the seller has created an eBay shipping label for the return shipment. | | MARK\_AS\_SENT | This value is used if the seller is using the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** method to mark an eBay-generated label as being sent to the buyer. | | NO\_LABEL | This value is used if the seller is not providing an eBay shipping label to the buyer. If this value is used, the seller must also include the **noLabelReason** field and provide the reason why no label is being provided.

It could be the seller is providing their own shipping label to the buyer (and not an eBay shipping label). In the case where the seller provides their own label, they must populate the **labelId** field with the shipment tracking number of the shipping label they're supplying to the buyer. | | PURCHASE\_LABEL | This value is used if the seller has purchased their own (non-eBay) shipping label for the return shipment. | | UNKNOWN | Indicates the label action is not known. | | UPLOAD\_LABEL | This value is used if the seller is providing their own shipping label to the buyer (and not an eBay shipping label). |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ErrorParameter - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) ErrorParameter ( [string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) ) ======================================================================================================================= Contextual data associated with an error. Type that uses ErrorParameter: [ErrorData](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html) Calls that use ErrorParameter: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ This type has no fields. Attribute --------- name ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. --- # RefundType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RefundType ========== This enumeration type contains the possible types of refunds - partial or full. Type that uses RefundType: [CaseDetails](https://developer.ebay.com/Devzone/post-order/types/CaseDetails.html) Call that uses one or more values of RefundType: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FULL | This enumeration value indicates that the buyer is scheduled to, or has already received a full refund. | | OTHER | This enumeration value indicates that it is unknown whether the buyer is scheduled to, or has already received a full or a partial refund. | | PARTIAL | This enumeration value indicates that the buyer is scheduled to, or has already received a partial refund |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # PartyEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) PartyEnum ========= This enumeration type lists the eBay user types that can create or perform an action against an order cancellation request. Types that use PartyEnum: [CancelActivityHistory](https://developer.ebay.com/devzone/post-order/types/CancelActivityHistory.html) , [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/devzone/post-order/types/CancelSummary.html) Calls that use one or more values of PartyEnum: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This enumeration value is returned if the buyer created or performed an action on an order cancellation request. | | SELLER | This enumeration value is returned if the seller created or performed an action on an order cancellation request. | | UNKNOWN | This enumeration value is returned if eBay cannot determine which eBay party created or performed an action on an order cancellation request. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # SellerProfile - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) SellerProfile ============= This type defines the common elements used by all business policies. Types that use SellerProfile: [AddSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileRequest.html) , [AddSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileResponse.html) , [PaymentProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfileList.html) , [ReturnPolicyProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfileList.html) , [SetSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileRequest.html) , [SetSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileResponse.html) , [ShippingPolicyProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfileList.html) Calls that use SellerProfile: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [categoryGroups](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#categoryGroups) ( _[CategoryGroups](https://developer.ebay.com/Devzone/business-policies/CallRef/types/CategoryGroups.html) _ ) [deletedDate](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#deletedDate) ( _[dateTime](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#dateTime) _ ) [forceDuplicate](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#forceDuplicate) ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [profileDesc](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#profileDesc) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [profileId](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#profileId) ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [profileName](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#profileName) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [profileType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#profileType) ( _[ProfileType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ProfileType.html) _ ) [profileVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#profileVersion) ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [siteId](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html#siteId) ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) categoryGroups ( _[CategoryGroups](https://developer.ebay.com/Devzone/business-policies/CallRef/types/CategoryGroups.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This container consists of one or more **categoryGroup** containers. One or more category groups are linked to each business policy. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#categoryGroups) to learn which calls use categoryGroups. deletedDate ( _[dateTime](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#dateTime) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This timestamp indicates when a business policy was deleted. This field is only returned in **getSellerProfiles** for business policies that have been deleted. For business policies that have been deleted by the seller, **deletedDate** is the only field that will be returned for the matching policy (in addition to the identifying fields like **profileId** and **profileName**). See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#deletedDate) to learn which calls use deletedDate. forceDuplicate ( _[boolean](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This value is for future use. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#forceDuplicate) to learn which calls use forceDuplicate. profileDesc ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This field is used by the seller to provide a description of the business policy. The **profileDesc** field is optional in the **addSellerProfile** and **setSellerProfile** calls. This field is only returned for a business policy if a description exists for that policy. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#profileDesc) to learn which calls use profileDesc. profileId ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. The unique identifier of a business policy. This value is created by eBay when a business policy is created (on the site or through the API). A **profileId** value is required when using the **setSellerProfile** and **removeSellerProfile** calls. It can be used as a filter in a **getSellerProfiles** to identify a specific business policy to retrieve. This field is always returned with all Business Policies Management calls. A **profileId** value returned in the response of an **addSellerProfile** call indicates that the business policy was successfully created. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#profileId) to learn which calls use profileId. profileName ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A **profileName** value is required when using the **addSellerProfile** and **setSellerProfile** calls. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#profileName) to learn which calls use profileName. profileType ( _[ProfileType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ProfileType.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This field indicates the type of the business policy. A **profileType** value is required when using the **addSellerProfile** and **setSellerProfile** calls. It can be used as a filter in a **getSellerProfiles** call to identify and retrieve business policies of a specific type. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#profileType) to learn which calls use profileType. profileVersion ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. This field is for internal use only. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#profileVersion) to learn which calls use profileVersion. siteId ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Unique identifier of the eBay site. This value is always returned in the **getSellerProfiles** call. It is optional in the **addSellerProfile** and **setSellerProfile** calls. If it is not used in an **addSellerProfile** or **setSellerProfile** call, the **siteId** value defaults to the seller's eBay registration site. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#siteId) to learn which calls use siteId. --- # FundingSource - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FundingSource ============= This type shows the seller's funding source used for the buyer refund, or in the case where eBay issued the refund to the buyer, the seller's funding source used by eBay to recoup this refund money from the seller. Type that uses FundingSource: [MoneyMovementEntry](https://developer.ebay.com/Devzone/post-order/types/MoneyMovementEntry.html) Calls that use FundingSource: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ brand ( _[FundingMethodBrandEnum](https://developer.ebay.com/Devzone/post-order/types/FundingMethodBrandEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value here indicates the brand of credit card used to fund the refund. This will be the seller's credit card on file with eBay. This field is only returned if the funding source type is `CREDIT_CARD`. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#brand) to learn which calls use brand. memo ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This provides a note about the funding source. This field is only returned if available, or it might get returned as an empty string. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#memo) to learn which calls use memo. type ( _[FundingMethodTypeEnum](https://developer.ebay.com/Devzone/post-order/types/FundingMethodTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) he enumeration value here indicates the type of funding source, such as bank account, credit card, or available seller payout funds. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#type) to learn which calls use type. --- # Price | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/price.html#mainContent) Every new listing must have a starting price: * For an auction listing, the starting price is the price at which the progressive bidding starts. * For a fixed-price listing, the starting price is the static price at which a buyer can purchase the item. Sellers can also add a [Buy It Now](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/buy-it-now.html) option to an auction listing, or assign a reserve price to the listing. If a reserve price is set, the item will not sell unless the bid of the winning bidder is equal to or higher than this price. **Argument:** [Item.StartPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.StartPrice) Currency -------- This required three-digit enumeration value defines the currency associated with the listing marketplace. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will use this currency. For a list of which currencies can be specified as input to listing calls such as [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) for a given marketplace, call [GeteBayDetails](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html) , pass in the appropriate [siteID](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/site-id.html) in the header, and set the value of [DetailName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Request.DetailName) to `CurrencyDetails`. **Important!** Calling [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) will return the item's original currency regardless of the marketplace to which the [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) request is sent. **Argument:** [Item.Currency](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Currency) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ErrorCategory - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) ErrorCategory ( [token](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#token) ) ==================================================================================================================== There are three categories of error: request errors, application errors, and system errors. Request and application errors are often caused by passing invalid data in the request. System errors are primarily caused by application failures and cannot be corrected by changing request values. Type that uses ErrorCategory: [ErrorData](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html) Calls that use one or more values of ErrorCategory: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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 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. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product-metadata/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # BaseResponse - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) BaseResponse ============ This is the base class for the response container for all service operations. Returns error information associated with the request. Calls that use BaseResponse: [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) , [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) , [getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html) , [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) , [getVersion](https://developer.ebay.com/Devzone/return-management/CallRef/getVersion.html) , [issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) , [provideSellerInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideSellerInfo.html) , [provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html) , [setItemAsReceived](https://developer.ebay.com/Devzone/return-management/CallRef/setItemAsReceived.html) Fields ------ [ack](https://developer.ebay.com/Devzone/return-management/CallRef/types/BaseResponse.html#ack) ( _[AckValue](https://developer.ebay.com/Devzone/return-management/CallRef/types/AckValue.html) _ ) [errorMessage](https://developer.ebay.com/Devzone/return-management/CallRef/types/BaseResponse.html#errorMessage) ( _[ErrorMessage](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorMessage.html) _ ) [extension](https://developer.ebay.com/Devzone/return-management/CallRef/types/BaseResponse.html#extension) ( _ExtensionType_ ) [timestamp](https://developer.ebay.com/Devzone/return-management/CallRef/types/BaseResponse.html#timestamp) ( _[dateTime](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#dateTime) _ ) [version](https://developer.ebay.com/Devzone/return-management/CallRef/types/BaseResponse.html#version) ( _[string](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#string) _ ) ack ( _[AckValue](https://developer.ebay.com/Devzone/return-management/CallRef/types/AckValue.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#multiplicity) A token representing the application-level acknowledgement code that indicates the response status, such as "Success". The **AckValue** enumeration type specifies the possible values for **ack**. See the [Field Index](https://developer.ebay.com/Devzone/return-management/CallRef/fieldindex.html#ack) to learn which calls use ack. errorMessage ( _[ErrorMessage](https://developer.ebay.com/Devzone/return-management/CallRef/types/ErrorMessage.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#multiplicity) Information for an error or warning that occurred when eBay processed the request. This field is not returned if the **ack** value is **Success**. See the [Field Index](https://developer.ebay.com/Devzone/return-management/CallRef/fieldindex.html#errorMessage) to learn which calls use errorMessage. extension ( _ExtensionType_ ) [\[0..\*\]](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Reserved for future use. See the [Field Index](https://developer.ebay.com/Devzone/return-management/CallRef/fieldindex.html#extension) to learn which calls use extension. timestamp ( _[dateTime](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#dateTime) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#multiplicity) 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). See Time Values in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. See the [Field Index](https://developer.ebay.com/Devzone/return-management/CallRef/fieldindex.html#timestamp) to learn which calls use timestamp. version ( _[string](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#multiplicity) The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the [Field Index](https://developer.ebay.com/Devzone/return-management/CallRef/fieldindex.html#version) to learn which calls use version. --- # Unknown Product API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product/ReleaseNotes.html) Simple Schema Types =================== The eBay Schema makes use of many simple schema types. Further, some eBay-defined types are based on simple schema types. Except where specified, the data types in the table below follow the conventions for XML Schema simple types as described by the World Wide Web Consortium in [XML Schema Part 2: Datatypes](http://www.w3.org/TR/xmlschema-2/) . | Data Type | Description | | --- | --- | | anyURI | Specifies a Uniform Resource Identifier (URI), a compact sequence of characters that identifies an abstract or physical resource.

The anyURI type is used most often to specify Uniform Resource Locators (URLs), such as a web page URL (e.g., ViewItemURL) or a file location URL (e.g., PictureURL), but can also be used for email addresses and other valid URI schemes. | | boolean | Specifies binary-valued logic (true/false). Possible input values are true, false, 1, and 0. Possible output values are true and false only (not 1 or 0). | | dateTime | A specific instant of time.

Date-time values are in the ISO 8601 date and time format. Hours are in 24-hour format (e.g., 2:00:00pm is 14:00:00). Unless otherwise specified, all date-time values are recorded in Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT) or Zulu (because the time portion of the time stamp ends with a Z). That is, time values do not reflect the time zone shown on the eBay Web site. Here is an example of the date-time format:

YYYY-MM-DDTHH:MM:SS.SSSZ (e.g., 2004-08-04T19:09:02.768Z)

See [Time Values](https://developer.ebay.com/Devzone/guides/features-guide/default.html#basics/DataTypes.html#TimeValues)
for information about how to convert between local time zones and GMT.

We use the dateTime data type to convey start and end times, the official eBay time, and other time values. | | decimal | A decimal value of arbitrary precision.

In the API, most fields of type decimal can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Decimal values should never include a thousands separator.

A whole number (i.e., without a period) can be passed as a decimal value.

We typically use the decimal data type to convey values related to units of measure. See individual topics for specific restrictions beyond this for fields of type decimal. | | double | A double-precision 64-bit floating point type.

In the API, most fields of type double can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Double values should never include a thousands separator.

We typically use the double data type to convey values related to monetary amounts.

In some cases, a whole number (i.e., without a period) can be passed or returned as a double value. See individual topics for specific restrictions beyond this for fields of type double. | | duration | A length of time.

Duration values are in the ISO 8601 duration format, where P represents "Period", nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes, and nS the number of seconds. So P2DT23H32M51S means "A period of 2 days, 23 hours, 32 minutes, and 51 seconds".

PnYnMnDTnH nMnS (e.g., P2DT23H32M51S)

We use the duration data type to convey values like the time left until a listing ends. For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). | | float | A single-precision 32-bit floating point type.

In the API, most fields of type float can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Float values should never include a thousands separator.

We typically use the float data type to convey values related to percentages. See individual topics for specific restrictions beyond this for fields of type float. | | int | A 32-bit integer value between -2147483648 and 2147483647.

In the API, most fields of type int can contain digits 0-9, and hyphen to indicate negative numbers. Some input fields restrict the input to particular values or a range of values. These cases are noted in the associated topic for the specific input field.

We typically use the int data type for enumerations, counts (e.g., how many items are returned), quantities, certain kinds of IDs (other IDs are strings), and similar concepts. | | long | A value between -9223372036854775808 and 9223372036854775807. | | string | A string of characters. All characters in the Unicode character set are supported.

Character entity references are used for escaping markup-significant characters. For example, use & for the & (ampersand) character, < for the < (less-than sign) character, and > for the > (greater-than sign) character. It is a good idea to escape such characters in requests instead of using a CDATA construct. Responses from eBay do not include CDATA constructs.

Note that messages from eBay may contain HTML or XML markup within the message text. In this case, the markup elements within the text are escaped (e.g., <!\[CDATA\[ ... \]\]>).

Some string input fields do not have a known set of possible values. For these fields, the documentation specifies the maximum permitted length in characters. If you are using a URL for your request, and you need to use the & (ampersand) character as part of a string value, use &.

xs:string is part of the XML schema namespace defined as:

xmlns:xs="http://www.w3.org/2001/XMLSchema" | | token | A set of normalized strings.

In the API, this type of string contains no white space, by convention.

We typically use token to constrain a field to a specified set of normalized string values. For such a field, we define these values in an enumeration that uses token as its base type. | Repeatable (Unbounded) Fields ----------------------------- If the multiplicity of an element is defined as maxOccurs="unbounded" or a value greater than 1 in the schema, it means you can specify the field multiple times in a request (like you are specifying an array), or eBay can return the field multiple times in the response. In this case, the fields must be contiguous. That is, in a request, you cannot insert other fields between the repeating fields. Otherwise, some of the data will be dropped in an unpredictable manner. Multiplicity Notation --------------------- | Sample XML notation | Corresponding doc notation | Meaning § | | --- | --- | --- | | minOccurs="0" maxOccurs="unbounded" | \[0..\*\] | Zero or more | | minOccurs="0" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="1" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="6" | \[0..6\] | Zero to six | §  While this is the general meaning, be sure to read the description of the particular field: it may state an exception for a particular use. --- # PropertyValue - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) PropertyValue ============= A property name and corresponding value (a name/value pair). Types that use PropertyValue: [GetProductCompatibilitiesRequest](https://developer.ebay.com/devzone/product/CallRef/types/GetProductCompatibilitiesRequest.html) , [Notes](https://developer.ebay.com/devzone/product/CallRef/types/Notes.html) , [Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) , [ProductRequest](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html) Calls that use PropertyValue: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ propertyName ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#propertyName) to learn which calls use propertyName. value ( _[Value](https://developer.ebay.com/devzone/product/CallRef/types/Value.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) A value for the property. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#value) to learn which calls use value. --- # EscalateInquiryRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) EscalateInquiryRequest ====================== This is the base request type of the **POST /post-order/v2/inquiry/{inquiryId}/escalate** method, which is used to escalate an INR inquiry into a case. Call that uses EscalateInquiryRequest: [/post-order/v2/inquiry/{inquiryId}/escalate POST](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid_escalate__post.html) Fields ------ comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The buyer or seller escalating the INR inquiry is required to use this container to provide more details about why the INR inquiry is being escalated to a case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. escalateInquiryReason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is used to specify the reason why the buyer or seller is escalating the specified INR inquiry into a case. One of the enumeration values defined in the [InquiryEscalationReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/InquiryEscalationReasonEnum.html) type definition must be used here. Some values are only applicable to the buyer escalating the inquiry, some values are only applicable to the seller escalating the inquiry, and some values are relevant to either party. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalateInquiryReason) to learn which calls use escalateInquiryReason. --- # ConsolidationJobType - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ConsolidationJobType ( [string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) ) ============================================================================================================================== Enumerated type defining the possible shipping policies consolidation job types. Type that uses ConsolidationJobType: [ConsolidationJob](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ConsolidationJob.html) Calls that use one or more values of ConsolidationJobType: [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) Enumeration Value ----------------- | | | | --- | --- | | Value | Description | | ShippingProfilesConsolidation | This value indicates that the job type is a shipping policies consolidation job. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # TrackingStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) TrackingStatusEnum ================== This enumerated type lists the values that indicate whether the return item was delivered or still in-transit. Type that uses TrackingStatusEnum: [ShipmentTrackingType](https://developer.ebay.com/Devzone/post-order/types/ShipmentTrackingType.html) Calls that use one or more values of TrackingStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CANCELLED | This enumeration value indicates that the current shipment tracking information has been cancelled. | | CREATED | This enumeration value indicates that shipment tracking has been initiated. | | DELIVERED | This enumeration value indicates that the item was delivered according to the shipment tracking history. | | IN\_TRANSIT | This enumeration value indicates that the item is in-transit to the recipient according to the shipment tracking history. | | UNKNOWN | This enumeration value indicates that shipment tracking status of the item is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # PaginationInput - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) PaginationInput =============== Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls which listings are returned in the response, but does not control the details associated with the returned items. Types that use PaginationInput: [GetProductCompatibilitiesRequest](https://developer.ebay.com/devzone/product/CallRef/types/GetProductCompatibilitiesRequest.html) , [ProductRequest](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html) Calls that use PaginationInput: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) Fields ------ entriesPerPage ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set. If entriesPerPage is set to a number greater than 100, the default value, 100, will be used. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#entriesPerPage) to learn which calls use entriesPerPage. pageNumber ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#pageNumber) to learn which calls use pageNumber. --- # IssueRefundRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) IssueRefundRequest ================== The base request type for the **POST /post-order/v2/return/{returnId}/issue\_refund** method, which is used to issue a refund to the buyer for a returned item. Call that uses IssueRefundRequest: [/post-order/v2/return/{returnId}/issue\_refund POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_issue_refund__post.html) Fields ------ comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container is used if the seller wants to provide more information to the buyer about the refund that is being issued. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. refundDetail ( _[RefundDetailType](https://developer.ebay.com/devzone/post-order/types/RefundDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides details on one or more refunds received by the buyer. An **itemizedRefundDetail** container is returned for each refund type (refund on purchase price, refund on original shipping, or any other costs paid by the buyer). The amount(s) in the **itemizedRefundDetail.amount** field(s) should equal the amount in the **refundDetail.totalAmount** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundDetail) to learn which calls use refundDetail. relistItem ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field should be included and set to `true` if the seller wants to relist/restock the returned item automatically after the refund operation succeeds. Sellers can check the eligibility for an item to be relisted by calling [Get Return](https://developer.ebay.com/devzone/post-order//devzone/post-order/post-order_v2_return-returnId__get.html#Response.detail.itemDetail.relistStatus) . In the response, check the **itemDetail.relistStatus** field for eligibility. This field will also show the status of a relist request as either `SUCCESS` (the relist succeeded) or `FAILED` (the relist request did not succeed). If the relist request succeeds, call [Get Return](https://developer.ebay.com/devzone/post-order//devzone/post-order/post-order_v2_return-returnId__get.html#Response.detail.itemDetail.relistedItemId) and check the **itemDetail.relistedItemId** to get the listing ID of the newly relisted item (the ID should match the ID of the original item listing). See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#relistItem) to learn which calls use relistItem. --- # Product - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) Product ======= Container type for product data. Types that use Product: [GetProductCompatiblitiesResponse](https://developer.ebay.com/devzone/product/CallRef/types/GetProductCompatiblitiesResponse.html) , [GetProductDetailsResponse](https://developer.ebay.com/devzone/product/CallRef/types/GetProductDetailsResponse.html) , [ProductResponse](https://developer.ebay.com/devzone/product/CallRef/types/ProductResponse.html) Calls that use Product: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ [compatibilityCount](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#compatibilityCount) ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [notes](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#notes) ( _[Notes](https://developer.ebay.com/devzone/product/CallRef/types/Notes.html) _ ) [productDetails](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#productDetails) ( _[PropertyValue](https://developer.ebay.com/devzone/product/CallRef/types/PropertyValue.html) _ ) [productIdentifier](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#productIdentifier) ( _[ProductIdentifier](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html) _ ) [productStatus](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#productStatus) ( _[ProductStatus](https://developer.ebay.com/devzone/product/CallRef/types/ProductStatus.html) _ ) [stockPhotoURL](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#stockPhotoURL) ( _[StockPhotoURL](https://developer.ebay.com/devzone/product/CallRef/types/StockPhotoURL.html) _ ) [type](https://developer.ebay.com/devzone/product/CallRef/types/Product.html#type) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) compatibilityCount ( _[int](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#int) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#compatibilityCount) to learn which calls use compatibilityCount. notes ( _[Notes](https://developer.ebay.com/devzone/product/CallRef/types/Notes.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#notes) to learn which calls use notes. productDetails ( _[PropertyValue](https://developer.ebay.com/devzone/product/CallRef/types/PropertyValue.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Details about the product in the form of name-value pairs. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productDetails) to learn which calls use productDetails. productIdentifier ( _[ProductIdentifier](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productIdentifier) to learn which calls use productIdentifier. productStatus ( _[ProductStatus](https://developer.ebay.com/devzone/product/CallRef/types/ProductStatus.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productStatus) to learn which calls use productStatus. stockPhotoURL ( _[StockPhotoURL](https://developer.ebay.com/devzone/product/CallRef/types/StockPhotoURL.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Thumbnail and standard stockphoto URLs. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#stockPhotoURL) to learn which calls use stockPhotoURL. type ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head. Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products. **Allowed values:** Head The product is the the head of the product family. Member The product is a variant of the head product. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#type) to learn which calls use type. --- # RequestTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RequestTypeEnum =============== This enumerated type allows a user to differentiate between a return request and a return request draft. Type that uses RequestTypeEnum: [ReturnRequestType](https://developer.ebay.com/devzone/post-order/types/ReturnRequestType.html) Call that uses one or more values of RequestTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CREATE | Indicates the request is for a return request draft. | | REQUEST | Indicates the request is for a return request. | | UNKNOWN | Indicates that it's undetermined if the request is for a return request or a return request draft. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # RefundInfo - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) RefundInfo ========== This type is used to provide more information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order. Type that uses RefundInfo: [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) Call that uses RefundInfo: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Field ----- actualRefundDetail ( _[ActualRefundDetail](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides detailed information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actualRefundDetail) to learn which calls use actualRefundDetail. --- # ReturnSortOrderType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ReturnSortOrderType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) =========================================================================================================================== Enumerated type that determines whether returns in the **getUserReturns** response are displayed in ascending or descending order. Type that uses ReturnSortOrderType: [getUserReturnsRequest](https://developer.ebay.com/Devzone/return-management/CallRef/types/getUserReturnsRequest.html) Call that uses one or more values of ReturnSortOrderType: [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | Ascending | This value is passed into the **sortOrderType** field of the **getUserReturns** call to display all retrieved returns in ascending order. See the **ReturnSortType** documentation to get an idea about how **Ascending** affects the four different sort types. | | Descending | This value is passed into the **sortOrderType** field of the **getUserReturns** call to display all retrieved returns in descending order. See the **ReturnSortType** documentation to get an idea about how **Descending** affects the four different sort types. **Descending** is the default value and will be used if the **sortOrderType** field is not included in the **getUserReturns** request. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ProductStatus - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ProductStatus ============= This will indicate if the product is disabled for the specific application like selling flow, review flow or half sell flow. Types that use ProductStatus: [GetProductCompatibilitiesRequest](https://developer.ebay.com/devzone/product/CallRef/types/GetProductCompatibilitiesRequest.html) , [Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) , [ProductDetailsRequestType](https://developer.ebay.com/devzone/product/CallRef/types/ProductDetailsRequestType.html) , [ProductRequest](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html) Calls that use ProductStatus: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ excludeForeBayReviews ( _[boolean](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Product cannot be used in product review flows. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#excludeForeBayReviews) to learn which calls use excludeForeBayReviews. excludeForeBaySelling ( _[boolean](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Product cannot be used in selling flows on eBay. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#excludeForeBaySelling) to learn which calls use excludeForeBaySelling. excludeForHalfSelling ( _[boolean](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#boolean) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Product cannot be used in selling flows on half.com. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#excludeForHalfSelling) to learn which calls use excludeForHalfSelling. --- # ReturnEligibilityErrorDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnEligibilityErrorDetailType ================================ This type is used by the **eligibilityErrorDetail** container, which is returned if an error occurs in regards to an order line item being eligible for a return request. Type that uses ReturnEligibilityErrorDetailType: [EligibilityResultType](https://developer.ebay.com/Devzone/post-order/types/EligibilityResultType.html) Call that uses ReturnEligibilityErrorDetailType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) Field ----- eligibilityError ( _[EligibilityErrorType](https://developer.ebay.com/Devzone/post-order/types/EligibilityErrorType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container provides information on an error that occurred in regards to an order line item being eligible for a return request. This container is only returned if one or more errors occur with an item eligibility check. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#eligibilityError) to learn which calls use eligibilityError. --- # ReturnResponseHistoryType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnResponseHistoryType ========================= This type is used by the **responseHistory** array, which consists of detailed information of each activity that occurs with a return request. Type that uses ReturnResponseHistoryType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ReturnResponseHistoryType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [activity](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#activity) ( _[ActivityOptionEnum](https://developer.ebay.com/devzone/post-order/types/ActivityOptionEnum.html) _ ) [attributes](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#attributes) ( _[ResponseHistoryAttributesType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html) _ ) [author](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#author) ( _[ReturnUserRoleEnum](https://developer.ebay.com/devzone/post-order/types/ReturnUserRoleEnum.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [fromState](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#fromState) ( _[ReturnStateEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStateEnum.html) _ ) [notes](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#notes) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [toState](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html#toState) ( _[ReturnStateEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStateEnum.html) _ ) activity ( _[ActivityOptionEnum](https://developer.ebay.com/devzone/post-order/types/ActivityOptionEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the action performed by the buyer, seller, or eBay to move the return request to the next stage. This field is always returned with each action recorded under the **responseHistory** array. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#activity) to learn which calls use activity. attributes ( _[ResponseHistoryAttributesType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of various return shipping and buyer refund information, such as the shipping carrier, shipment tracking number, a partial refund amount (if applicable), and a monetary transaction identifier (if applicable). This container will be returned if the the buyer/seller/eBay action (specified in the **activity** field) requires the data in this container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#attributes) to learn which calls use attributes. author ( _[ReturnUserRoleEnum](https://developer.ebay.com/devzone/post-order/types/ReturnUserRoleEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the actor (such as buyer, seller, or eBay) that performed the action (specified in the **activity** field). This field is always with each action recorded under the **responseHistory** array. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#author) to learn which calls use author. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date/time when the action (specified in the **activity** field) was performed. This container is always with each action recorded under the **responseHistory** array. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. fromState ( _[ReturnStateEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStateEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the previous state of the return request before the action (specified in the **activity** field) was performed. This field is always with each action recorded under the **responseHistory** array. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fromState) to learn which calls use fromState. notes ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value contains a note about the buyer/seller/eBay action (specified in the **activity** field). This field is only returned if a note exists for the action. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#notes) to learn which calls use notes. toState ( _[ReturnStateEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStateEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the new state of the return after the action (specified in the **activity** field) was performed. This field is always with each action recorded under the **responseHistory** array. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#toState) to learn which calls use toState. --- # ProductIdentifier - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ProductIdentifier ================= Type could be ePID, MementoString as well as ISBN, UPC, EAN, Brand\_MPN. Types that use ProductIdentifier: [GetProductCompatibilitiesRequest](https://developer.ebay.com/devzone/product/CallRef/types/GetProductCompatibilitiesRequest.html) , [Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) , [ProductDetailsRequestType](https://developer.ebay.com/devzone/product/CallRef/types/ProductDetailsRequestType.html) Calls that use ProductIdentifier: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ [EAN](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html#EAN) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [ePID](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html#ePID) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [ISBN](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html#ISBN) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [productId](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html#productId) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [UPC](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html#UPC) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) EAN ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#EAN) to learn which calls use EAN. ePID ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#ePID) to learn which calls use ePID. ISBN ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#ISBN) to learn which calls use ISBN. productId ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productId) to learn which calls use productId. UPC ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) eBay Product ID. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#UPC) to learn which calls use UPC. --- # ReturnStatusType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ReturnStatusType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ======================================================================================================================== Enumerated type containing the possible states for a return. Type that uses ReturnStatusType: [ReturnSummaryType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSummaryType.html) Calls that use one or more values of ReturnStatusType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) , [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CLOSED | This value indicates that the return has been closed. | | ESCALATED | This value indicates that the buyer has escalated the return to an eBay Buyer Protection case. When a return is escalated to an eBay Buyer Protection case, the return is closed. | | ITEM\_DELIVERED | This value indicates that the returned item has been received by the seller. | | ITEM\_SHIPPED | This value indicates that the buyer has shipped the item back to the seller. | | READY\_FOR\_SHIPPING | This value indicates that the buyer is cleared to ship the item back to the seller. | | UNKNOWN | This value indicates that the status of the return is unknown. | | WAITING\_FOR\_SELLER\_INFO | This value indicates that the the buyer is expecting to receive an RMA (Return Merchandise Authorization) number and/or an alternative return shipping address from the seller before the item is shipped back to the seller. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # GetConsolidationJobStatusResponse - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) GetConsolidationJobStatusResponse ( [BaseResponse](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html) ) =========================================================================================================================================== The response container for the **getConsolidationJobStatus** call. Call that uses GetConsolidationJobStatusResponse: [getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) Field ----- Job ( _[ConsolidationJob](https://developer.ebay.com/devzone/business-policies/CallRef/types/ConsolidationJob.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of details related to the shipping policies consolidation job, including the status of the job and the eBay site ID. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#Job) to learn which calls use Job. --- # ReturnAddressRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnAddressRequest ==================== This type is used by the request payload of the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** method, and the payload is used to provide the seller's return address and Return Merchandise Authorization (RMA) number (if applicable) to the seller. Call that uses ReturnAddressRequest: [/post-order/v2/casemanagement/{caseId}/provide\_return\_address POST](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid_provide_return_address__post.html) Fields ------ firstName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The first name associated with the seller's return address, or if applicable, a business or store name. If a first name or business/store name is defined for the return address, this field should be included in the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#firstName) to learn which calls use firstName. lastName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The last name associated with the seller's return address. If a last name is defined for the return address, this field should be included in the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastName) to learn which calls use lastName. returnAddress ( _[Address](https://developer.ebay.com/devzone/post-order/types/Address.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The full return address is provided in this container. This container is required to be in the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnAddress) to learn which calls use returnAddress. RMA ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The Return Merchandise Authorization (RMA) number associated with the item to be returned. An RMA number is a unique identifier that is provided by a manufacturer and authorizes the return of an item. This field is conditionally required if there is an RMA number associated with the item, and if the buyer is requesting an RMA number. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#RMA) to learn which calls use RMA. --- # ConsolidationJobStatus - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ConsolidationJobStatus ( [string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) ) ================================================================================================================================ Enumerated type defining the possible status values for a shipping policies consolidation job. Type that uses ConsolidationJobStatus: [ConsolidationJob](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ConsolidationJob.html) Calls that use one or more values of ConsolidationJobStatus: [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # Provide Case Shipment Info - eBay Post-Order API Reference eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) Provide Case Shipment Info ========================== POST /post-order/v2/casemanagement/{caseId}/provide\_shipment\_info ------------------------------------------------------------------- **Note:** This call has been deprecated and will be decommissioned on March 2, 2026. This method is used to provide shipment tracking information for an item that is involved in case. This method is not supported in the Sandbox environment. Input ----- See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_shipment_info__post.html#Samples) . #### Resource URI (production) POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/provide\_shipment\_info #### URI parameters | Parameter | Type | Required? | Meaning | | --- | --- | --- | --- | | **caseId** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The unique identifier of a case. This URI parameter is required in order to identify the case for which shipment tracking information is being provided. The case ID value is passed in as part of the method URI. | #### HTTP request headers All requests made to eBay REST operations require you to provide the `authorization` HTTP header for authentication. See [HTTP request headers](https://developer.ebay.com/ebay-rest/content/rest-request-components.html#HTTP) for details. #### Authorization This call uses standard authorization tokens. See [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) for details. #### Payload model The following lists _all fields that could be included_ in the request. { /\* _[ProvideShipmentInfoRequest](https://developer.ebay.com/Devzone/post-order/types/ProvideShipmentInfoRequest.html) _ \*/ "[shippingCarrierName](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_shipment_info__post.html#Request.shippingCarrierName) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[trackingNumber](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_shipment_info__post.html#Request.trackingNumber) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) } #### Request field descriptions | Input Container/Field | Type | Occurrence | Meaning | | --- | --- | --- | --- | | **shippingCarrierName** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The shipping carrier enumeration value is passed into this field, and represents the shipping carrier being used to return the item.

A list of shipping carrier enumeration values can be found in the [ShippingCarrierEnum](https://developer.ebay.com/devzone/post-order/types/ShippingCarrierEnum.html)
type definition. | | **trackingNumber** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The shipment tracking number is passed into this field. This value should be passed in without hyphens or spaces. The seller is responsible for the accuracy of this value, as eBay can only validate that the format is consistent with the format that is used by the specified shipping carrier. | Output ------ See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_shipment_info__post.html#Samples) . #### Payload model This call has no response payload. null Samples ------- New to making API calls? Please see [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) . 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. Sample: Basic Call Buyer provides return shipment information to the seller. **Description** Now that the return request has been escalated to a case, the seller has finally agreed to issue a full refund upon receiving the returned item from the buyer. With this call, the buyer is providing the shipment tracking information to the seller. **Input** The buyer passes in the case ID value as a path parameter to identify the case for which shipment tracking details are being provided to the seller. The **shippingCarriername** field is used to provide the name of the shipping carrier and the **trackingNumber** field is used to provide the tracking number for the shipment. **URL format**. See also the [non-wrapped](https://developer.ebay.com/Devzone/post-order/Samples/post-order_v2_casemanagement-caseid_provide_shipment_info__post_basic_in_url_json.txt) version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/5\*\*\*\*\*\*\*\*3/provide\_shipment\_info { "shippingCarrierName": "FedEx", "trackingNumber": "1\*\*\*\*\*\*\*\*\*7" } **Output** There is no output payload with this response. A successful call contains an HTTP status code of 200. **JSON format**. Change History -------------- | Change Date | Description | | --- | --- | --- # BaseServiceRequest - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product/ReleaseNotes.html) BaseServiceRequest ================== This is the base class for request container for all service operations. Calls that use BaseServiceRequest: [findProducts](https://developer.ebay.com/Devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/Devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/Devzone/product/CallRef/getProductDetails.html) Fields ------ This type has no fields. --- # ReturnTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnTypeEnum ============== This enumerated type lists the possible values that the buyer can pass in the **type** field when the buyer is creating a return request or draft with the **POST /post-order/v2/return** or **POST /post-order/v2/return/draft** methods. **Note:** Currently, `MONEY_BACK` is the only supported value. Types that use ReturnTypeEnum: [ReturnCreationInfoType](https://developer.ebay.com/Devzone/post-order/types/ReturnCreationInfoType.html) , [ReturnRequestType](https://developer.ebay.com/Devzone/post-order/types/ReturnRequestType.html) , [ReturnSummaryType](https://developer.ebay.com/Devzone/post-order/types/ReturnSummaryType.html) Calls that use one or more values of ReturnTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | EXCHANGE | **Note:** This value is deprecated. | | MONEY\_BACK | This enumeration value indicates that the buyer is seeking a full refund after returning the item. | | REPLACEMENT | This enumeration value indicates that the buyer is seeking a replacement item after returning the item.

**Note:** This value is not currently supported. | | UNKNOWN | **Note:** This value is deprecated. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # PaymentProfile - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) PaymentProfile ( [SellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SellerProfile.html) ) ========================================================================================================================== Type defining the **paymentProfile** container, which is the container used to define one payment policy for a seller. Types that use PaymentProfile: [AddSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileRequest.html) , [AddSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/AddSellerProfileResponse.html) , [PaymentProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfileList.html) , [SetSellerProfileRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileRequest.html) , [SetSellerProfileResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/SetSellerProfileResponse.html) Calls that use PaymentProfile: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Field ----- paymentInfo ( _[PaymentInfo](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentInfo.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This container consists of detailed payment information for a seller's payment policy. This container is conditionally required if the caller is creating a new payment policy or modifying an existing payment policy. This container is returned by **getSellerProfiles** if one or more payment policies match the input criteria in the call request, and is returned in the response of **addSellerProfile** or **setSellerProfile** if a payment policy is being created or modified, respectively. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#paymentInfo) to learn which calls use paymentInfo. --- # PartialOrderTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) PartialOrderTypeEnum ==================== This enumeration type defines the values that can be used to describe the scope of an order cancellation. **Note:** At this time, only full order cancellations are supported. Neither a buyer or a seller may initiate the cancellation of just one line item within a multiple line item order. Types that use PartialOrderTypeEnum: [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/devzone/post-order/types/CancelSummary.html) Calls that use one or more values of PartialOrderTypeEnum: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FULL\_ORDER | This enumeration value indicates that the order cancellation request involves the entire order. | | PARTIAL\_ORDER | This enumeration value is not currently applicable, and is reserved for future use. | | UNKNOWN | This enumeration value may get returned if eBay cannot determine the scope of the order cancellation. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # PropertyValue - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) PropertyValue ============= Contains a property name and corresponding value or values. Types that use PropertyValue: [GetProductSearchValuesBaseRequest](https://developer.ebay.com/devzone/product-metadata/CallRef/types/GetProductSearchValuesBaseRequest.html) , [GetProductSearchValuesResponse](https://developer.ebay.com/devzone/product-metadata/CallRef/types/GetProductSearchValuesResponse.html) Calls that use PropertyValue: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ propertyName ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#propertyName) to learn which calls use propertyName. value ( _[Value](https://developer.ebay.com/devzone/product-metadata/CallRef/types/Value.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) A value for the property. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#value) to learn which calls use value. --- # PayoutRecoupInfo - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) PayoutRecoupInfo ================ This type defines the amount of the seller payout, which must be recouped from the seller by eBay in the case of a cancelled order. Types that use PayoutRecoupInfo: [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/devzone/post-order/types/CancelSummary.html) Calls that use PayoutRecoupInfo: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Fields ------ amountToRecoup ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount of the seller payout which must be recouped from the seller by eBay in the case of a cancelled order See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#amountToRecoup) to learn which calls use amountToRecoup. payoutId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the seller payout associated with the cancelled order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#payoutId) to learn which calls use payoutId. --- # PaymentStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) PaymentStatusEnum ================= This enumerated type defines the status values for a buyer's payment for an order. Types that use PaymentStatusEnum: [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/devzone/post-order/types/CancelSummary.html) Calls that use one or more values of PaymentStatusEnum: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | MARK\_AS\_PAID | This enumeration value indicates that the seller marked the payment status of the order as paid. | | NOT\_PAID | This enumeration value indicates that the payment status of the order is unpaid. | | ONLINE\_PAID | This enumeration value indicates that the payment status of the order is paid. | | PAYPAL\_PAID | **THIS ENUMERATION VALUE IS DEPRECATED.** | | UNKNOWN | This enumeration value indicates that the payment status of the order cannot be determined. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # GetProductDetailsRequest - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product/ReleaseNotes.html) GetProductDetailsRequest ( [BaseServiceRequest](https://developer.ebay.com/Devzone/product/CallRef/types/BaseServiceRequest.html) ) ==================================================================================================================================== Retrieve product details for the specified product ID, including whether the product has fitment information or not. Call that uses GetProductDetailsRequest: [getProductDetails](https://developer.ebay.com/Devzone/product/CallRef/getProductDetails.html) Field ----- productDetailsRequest ( _[ProductDetailsRequestType](https://developer.ebay.com/Devzone/product/CallRef/types/ProductDetailsRequestType.html) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/product/CallRef/types/simpletypes.html#multiplicity) Contains product details. See the [Field Index](https://developer.ebay.com/Devzone/product/CallRef/fieldindex.html#productDetailsRequest) to learn which calls use productDetailsRequest. --- # RequestTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RequestTypeEnum =============== This enumerated type allows a user to differentiate between a return request and a return request draft. Type that uses RequestTypeEnum: [ReturnRequestType](https://developer.ebay.com/Devzone/post-order/types/ReturnRequestType.html) Call that uses one or more values of RequestTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CREATE | Indicates the request is for a return request draft. | | REQUEST | Indicates the request is for a return request. | | UNKNOWN | Indicates that it's undetermined if the request is for a return request or a return request draft. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ItemDetails - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ItemDetails =========== This type provides information about the line item associated with the INR inquiry. Type that uses ItemDetails: [InquiryDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/InquiryDetailsResponse.html) Call that uses ItemDetails: [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [itemOnHold](https://developer.ebay.com/Devzone/post-order/types/ItemDetails.html#itemOnHold) ( _[boolean](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#boolean) _ ) [itemPictureUrl](https://developer.ebay.com/Devzone/post-order/types/ItemDetails.html#itemPictureUrl) ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [itemPrice](https://developer.ebay.com/Devzone/post-order/types/ItemDetails.html#itemPrice) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [itemTitle](https://developer.ebay.com/Devzone/post-order/types/ItemDetails.html#itemTitle) ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [viewPurchasedItemUrl](https://developer.ebay.com/Devzone/post-order/types/ItemDetails.html#viewPurchasedItemUrl) ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) itemOnHold ( _[boolean](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This field indicates the item related to the inquiry is hidden (the respective content is not returned). This field is returned as 'true' if the item is on hold due to eBay policy violation; false otherwise. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#itemOnHold) to learn which calls use itemOnHold. itemPictureUrl ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This field provides an URL where the gallery picture of the item may be viewed. This field is returned when available. If the item is on hold, this field may not be returned. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#itemPictureUrl) to learn which calls use itemPictureUrl. itemPrice ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the final price of the line item, or the amount of money that the buyer agreed to pay for the item. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#itemPrice) to learn which calls use itemPrice. itemTitle ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) The title of the eBay listing. If the item is on hold, the **itemID** of the listing is returned instead of the title. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#itemTitle) to learn which calls use itemTitle. viewPurchasedItemUrl ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) When available, this field provides the URL to the item purchase page. If the item is on hold, a placeholder may be returned instead of the gallery picture. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#viewPurchasedItemUrl) to learn which calls use viewPurchasedItemUrl. --- # ReturnRefundInitiatorEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnRefundInitiatorEnum ========================= This enumerated type lists the values that indicate the initiator of the refund. Type that uses ReturnRefundInitiatorEnum: [ActualRefundDetailType](https://developer.ebay.com/Devzone/post-order/types/ActualRefundDetailType.html) Calls that use one or more values of ReturnRefundInitiatorEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AUTO\_REFUND | This enumeration value indicates that eBay automatically refunded the buyer. | | OTHER | This enumeration value indicates that the initiator of the refund is unknown. | | SELLER\_INITIATED | This enumeration value indicates that the refund was initiated by the seller. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # FundingSourceType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FundingSourceType ================= This type provides details on the seller's funding source used for buyer refund. Type that uses FundingSourceType: [RefundFundingType](https://developer.ebay.com/Devzone/post-order/types/RefundFundingType.html) Calls that use FundingSourceType: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ brand ( _[FundingMethodBrandEnum](https://developer.ebay.com/Devzone/post-order/types/FundingMethodBrandEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value here indicates the brand of credit card used to fund the buyer's refund. This field is only returned if the funding source type is `CREDIT_CARD`. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#brand) to learn which calls use brand. memo ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This provides a note about the funding source. This field is only returned if available, or it might get returned as an empty string. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#memo) to learn which calls use memo. type ( _[FundingMethodTypeEnum](https://developer.ebay.com/Devzone/post-order/types/FundingMethodTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value here indicates the type of funding source, such as bank account, credit card, or available seller payout funds. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#type) to learn which calls use type. --- # Value - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) Value ===== Defines the different types of values that a property can have. Types that use Value: [PropertyNameValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/PropertyNameValue.html) , [PropertyValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/PropertyValue.html) Calls that use Value: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ number ( _[NumericValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/NumericValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) For numeric value type. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#number) to learn which calls use number. text ( _[StringValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/StringValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) For string value type. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#text) to learn which calls use text. URL ( _[URIValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/URIValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) For URL value type. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#URL) to learn which calls use URL. --- # ReturnTypeEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnTypeEnum ============== This enumerated type lists the possible values that the buyer can pass in the **type** field when the buyer is creating a return request or draft with the **POST /post-order/v2/return** or **POST /post-order/v2/return/draft** methods. **Note:** Currently, `MONEY_BACK` is the only supported value. Types that use ReturnTypeEnum: [ReturnCreationInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html) , [ReturnRequestType](https://developer.ebay.com/devzone/post-order/types/ReturnRequestType.html) , [ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) Calls that use one or more values of ReturnTypeEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | EXCHANGE | **Note:** This value is deprecated. | | MONEY\_BACK | This enumeration value indicates that the buyer is seeking a full refund after returning the item. | | REPLACEMENT | This enumeration value indicates that the buyer is seeking a replacement item after returning the item.

**Note:** This value is not currently supported. | | UNKNOWN | **Note:** This value is deprecated. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ErrorParameter - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ErrorParameter ( [string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) ) ======================================================================================================================== Contextual data associated with an error. Type that uses ErrorParameter: [ErrorData](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html) Calls that use ErrorParameter: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ This type has no fields. Attribute --------- name ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. --- # FundingStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FundingStatusEnum ================= This enumerated type is used to indicate if eBay was able to successfully 'fund' a refund to the buyer using the seller's preferred method of payment for refunds. Types that use FundingStatusEnum: [MoneyMovementEntry](https://developer.ebay.com/Devzone/post-order/types/MoneyMovementEntry.html) , [RefundFundingType](https://developer.ebay.com/Devzone/post-order/types/RefundFundingType.html) Calls that use one or more values of FundingStatusEnum: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | This enumeration value indicates that the refund was not successfully funded, which can mean there were insufficient funds in the account, or that the transaction failed for another reason. | | FUNDED | This enumeration value indicates that the buyer refund was successfully funded. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnCloseInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnCloseInfoType =================== This type is used by the **closeInfo** container, which provides information on a closed return request. Type that uses ReturnCloseInfoType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ReturnCloseInfoType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ buyerCloseComment ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string field will be returned if the buyer made a comment when closing the return request. This field is only returned if the return request was closed and the buyer made a comment upon closing the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerCloseComment) to learn which calls use buyerCloseComment. buyerCloseReason ( _[BuyerCloseReturnReasonEnum](https://developer.ebay.com/devzone/post-order/types/BuyerCloseReturnReasonEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the reason that the buyer is closing the return request. A buyer would typically close a return request after they receive a refund or if they initiated the return request by mistake. This field is only returned if the return request was closed and the buyer was the one (and not eBay) that initiated the closure of the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerCloseReason) to learn which calls use buyerCloseReason. returnCloseDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the return request was closed. This field is only returned if the return request was closed. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnCloseDate) to learn which calls use returnCloseDate. returnCloseReason ( _[CloseReturnReasonEnum](https://developer.ebay.com/devzone/post-order/types/CloseReturnReasonEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the reason why the return request was closed. The enumeration value returned here will be the reason why eBay closed the return request, and not why the buyer wanted to close the return request. This field is only returned if the return request was closed. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnCloseReason) to learn which calls use returnCloseReason. --- # CaseSummaryType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CaseSummaryType =============== This type is used to provide a summary of information on each case that is returned in the **GET /post-order/v2/casemanagement/search** response. Type that uses CaseSummaryType: [CaseSearchResponse](https://developer.ebay.com/devzone/post-order/types/CaseSearchResponse.html) Call that uses CaseSummaryType: [/post-order/v2/casemanagement/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement_search__get.html) Fields ------ [buyer](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#buyer) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [caseId](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#caseId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [caseStatusEnum](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#caseStatusEnum) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [claimAmount](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#claimAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [itemId](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#itemId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [lastModifiedDate](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#lastModifiedDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [respondByDate](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#respondByDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [seller](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#seller) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [transactionId](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html#transactionId) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) buyer ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The eBay user ID of the buyer involved in the case. **Note:** Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to [Data Handling Compliance](https://developer.ebay.com/devzone/post-order//api-docs/static/data-handling-update.html) . See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyer) to learn which calls use buyer. caseId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseId) to learn which calls use caseId. caseStatusEnum ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the case. The list of enumeration values that may be returned in this field are defined in the [CaseStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CaseStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseStatusEnum) to learn which calls use caseStatusEnum. claimAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container displays the dollar value of the order line item associated with the case, which is generally the amount of the refund that the buyer will receive if the buyer is looking for a refund, or if the seller voluntarily refunds the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#claimAmount) to learn which calls use claimAmount. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the case was created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. itemId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the **transactionId** field to identify a line item that is associated with the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemId) to learn which calls use itemId. lastModifiedDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the last action was performed on the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastModifiedDate) to learn which calls use lastModifiedDate. respondByDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the deadline for when a buyer or seller must perform the next action on the case. This field will only be returned if there is a deadline associated with the next action. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#respondByDate) to learn which calls use respondByDate. seller ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The eBay user ID of the seller involved in the case. **Note:** Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to [Data Handling Compliance](https://developer.ebay.com/devzone/post-order//api-docs/static/data-handling-update.html) . See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#seller) to learn which calls use seller. transactionId ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the purchase transaction. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the **itemId** field to identify the line item that is associated with the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionId) to learn which calls use transactionId. --- # EstimatedRefundType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) EstimatedRefundType =================== This type is used by the **estimatedRefundDetail.itemizedRefundDetail** container, which shows the estimated refund information before the seller issues a refund to the buyer. Once the refund is actually successfully processed, information on the refund may be seen in the **actualRefundDetail** container. Type that uses EstimatedRefundType: [EstimatedRefundDetailType](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundDetailType.html) Calls that use EstimatedRefundType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [estimatedAmount](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundType.html#estimatedAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [maxAmount](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundType.html#maxAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [minAmount](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundType.html#minAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [purchasePriceDeductedPercentageList](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundType.html#purchasePriceDeductedPercentageList) ( array of _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [refundFeeType](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundType.html#refundFeeType) ( _[RefundFeeTypeEnum](https://developer.ebay.com/Devzone/post-order/types/RefundFeeTypeEnum.html) _ ) [restockingFeePercentage](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundType.html#restockingFeePercentage) ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) estimatedAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the estimated amount of the refund. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#estimatedAmount) to learn which calls use estimatedAmount. maxAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the maximum amount that the refund could be based on the cost of the order. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#maxAmount) to learn which calls use maxAmount. minAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the minimum amount that the refund could be based on the cost of the order. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#minAmount) to learn which calls use minAmount. purchasePriceDeductedPercentageList ( array of _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This array shows one or more percentage values, and these values indicate the percentage value(s) deducted off of the purchase price. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#purchasePriceDeductedPercentageList) to learn which calls use purchasePriceDeductedPercentageList. refundFeeType ( _[RefundFeeTypeEnum](https://developer.ebay.com/Devzone/post-order/types/RefundFeeTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the type of refund. When issuing a refund through the **POST /post-order/v2/return/{returnId}/issue\_refund** method, the seller must use a separate **itemizedRefundDetail** container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#refundFeeType) to learn which calls use refundFeeType. restockingFeePercentage ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) **THIS FIELD IS DEPRECATED.** See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#restockingFeePercentage) to learn which calls use restockingFeePercentage. --- # ReturnSummaryType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnSummaryType ================= This type is used by the **summary** container in the **GET /post-order/v2/return/search**, **POST /post-order/v2/return/**, and **GET /post-order/v2/return/{returnId}** methods. This container provides a summary of information for the return request. This container is not returned in the 'Get' methods if the **fieldgroups** query parameter is omitted, or if it is used and its value is set to `FULL`. Types that use ReturnSummaryType: [CreateReturnResponse](https://developer.ebay.com/devzone/post-order/types/CreateReturnResponse.html) , [GetDetailResponse](https://developer.ebay.com/devzone/post-order/types/GetDetailResponse.html) , [GetSummaryResponse](https://developer.ebay.com/devzone/post-order/types/GetSummaryResponse.html) Calls that use ReturnSummaryType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [buyerAvailableOptions](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#buyerAvailableOptions) ( array of _[AvailableOptionType](https://developer.ebay.com/devzone/post-order/types/AvailableOptionType.html) _ ) [buyerLoginName](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#buyerLoginName) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [buyerResponseDue](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#buyerResponseDue) ( _[ReturnResponseDueType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseDueType.html) _ ) [buyerTotalRefund](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#buyerTotalRefund) ( _[TotalRefundAmountType](https://developer.ebay.com/devzone/post-order/types/TotalRefundAmountType.html) _ ) [creationInfo](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#creationInfo) ( _[ReturnCreationInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html) _ ) [currentType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#currentType) ( _[ReturnTypeEnum](https://developer.ebay.com/devzone/post-order/types/ReturnTypeEnum.html) _ ) [escalationInfo](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#escalationInfo) ( _[EscalationInfoType](https://developer.ebay.com/devzone/post-order/types/EscalationInfoType.html) _ ) [orderId](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#orderId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [returnId](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#returnId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [returnPolicy](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#returnPolicy) ( _[ReturnPolicyType](https://developer.ebay.com/devzone/post-order/types/ReturnPolicyType.html) _ ) [sellerAvailableOptions](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#sellerAvailableOptions) ( array of _[AvailableOptionType](https://developer.ebay.com/devzone/post-order/types/AvailableOptionType.html) _ ) [sellerLoginName](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#sellerLoginName) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [sellerResponseDue](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#sellerResponseDue) ( _[ReturnResponseDueType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseDueType.html) _ ) [sellerTotalRefund](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#sellerTotalRefund) ( _[TotalRefundAmountType](https://developer.ebay.com/devzone/post-order/types/TotalRefundAmountType.html) _ ) [state](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#state) ( _[ReturnStateEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStateEnum.html) _ ) [status](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#status) ( _[ReturnStatusEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStatusEnum.html) _ ) [timeoutDate](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html#timeoutDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) buyerAvailableOptions ( array of _[AvailableOptionType](https://developer.ebay.com/devzone/post-order/types/AvailableOptionType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array consists one or more options that are available to the buyer to move the return request to the next stage. If the return request is currently waiting for a response from the seller, this array may not appear at all. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerAvailableOptions) to learn which calls use buyerAvailableOptions. buyerLoginName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the eBay user name of the buyer. **Note:** Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to [Data Handling Compliance](https://developer.ebay.com/devzone/post-order//api-docs/static/data-handling-update.html) . See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerLoginName) to learn which calls use buyerLoginName. buyerResponseDue ( _[ReturnResponseDueType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseDueType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container indicates the next action the buyer is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerResponseDue) to learn which calls use buyerResponseDue. buyerTotalRefund ( _[TotalRefundAmountType](https://developer.ebay.com/devzone/post-order/types/TotalRefundAmountType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container returns the total refund amount for the buyer. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued. In some cases, the **buyerTotalRefund** differs from the **sellerTotalRefund** because the buyer may receive refunds from eBay instead of from the seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerTotalRefund) to learn which calls use buyerTotalRefund. creationInfo ( _[ReturnCreationInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnCreationInfoType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides details about the buyer's return request, including the order line item (and quantity) that is being returned and the reason for the return. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationInfo) to learn which calls use creationInfo. currentType ( _[ReturnTypeEnum](https://developer.ebay.com/devzone/post-order/types/ReturnTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the buyer's desired outcome. **Note:** Currently, the only supported value is `MONEY_BACK`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#currentType) to learn which calls use currentType. escalationInfo ( _[EscalationInfoType](https://developer.ebay.com/devzone/post-order/types/EscalationInfoType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides information on whether or not the buyer or seller is eligible to escalate a return request to a case, and if a return request was escalated, a **caseId** can be found in this container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalationInfo) to learn which calls use escalationInfo. orderId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of the order being returned. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#orderId) to learn which calls use orderId. returnId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnId) to learn which calls use returnId. returnPolicy ( _[ReturnPolicyType](https://developer.ebay.com/devzone/post-order/types/ReturnPolicyType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container indicates whether or not the seller is required to provide an RMA (return merchandise authorization) number to the buyer. The seller can use the **POST /post-order/v2/return/{returnId}/decide** method to provide the buyer with the RMA number. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnPolicy) to learn which calls use returnPolicy. sellerAvailableOptions ( array of _[AvailableOptionType](https://developer.ebay.com/devzone/post-order/types/AvailableOptionType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array consists one or more options that are available to the seller to move the return request to the next stage. If the return request is currently waiting for a response from the buyer, this array may not appear at all. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerAvailableOptions) to learn which calls use sellerAvailableOptions. sellerLoginName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the eBay user name of the seller. **Note:** Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to [Data Handling Compliance](https://developer.ebay.com/devzone/post-order//api-docs/static/data-handling-update.html) . See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerLoginName) to learn which calls use sellerLoginName. sellerResponseDue ( _[ReturnResponseDueType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseDueType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container indicates the next action the seller is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerResponseDue) to learn which calls use sellerResponseDue. sellerTotalRefund ( _[TotalRefundAmountType](https://developer.ebay.com/devzone/post-order/types/TotalRefundAmountType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container returns the total buyer refund amount due from the seller. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued. In some cases, the **buyerTotalRefund** differs from the **sellerTotalRefund** because the buyer may receive refunds from eBay instead of from the seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerTotalRefund) to learn which calls use sellerTotalRefund. state ( _[ReturnStateEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStateEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current state of the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#state) to learn which calls use state. status ( _[ReturnStatusEnum](https://developer.ebay.com/devzone/post-order/types/ReturnStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#status) to learn which calls use status. timeoutDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date and time when eBay may administratively close the return request is either a buyer's or seller's response is nor made by this deadline. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#timeoutDate) to learn which calls use timeoutDate. --- # Unknown Product API * [Features Guide](https://developer.ebay.com/DevZone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/DevZone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/Product/ReleaseNotes.html) Simple Schema Types =================== The eBay Schema makes use of many simple schema types. Further, some eBay-defined types are based on simple schema types. Except where specified, the data types in the table below follow the conventions for XML Schema simple types as described by the World Wide Web Consortium in [XML Schema Part 2: Datatypes](http://www.w3.org/TR/xmlschema-2/) . | Data Type | Description | | --- | --- | | anyURI | Specifies a Uniform Resource Identifier (URI), a compact sequence of characters that identifies an abstract or physical resource.

The anyURI type is used most often to specify Uniform Resource Locators (URLs), such as a web page URL (e.g., ViewItemURL) or a file location URL (e.g., PictureURL), but can also be used for email addresses and other valid URI schemes. | | boolean | Specifies binary-valued logic (true/false). Possible input values are true, false, 1, and 0. Possible output values are true and false only (not 1 or 0). | | dateTime | A specific instant of time.

Date-time values are in the ISO 8601 date and time format. Hours are in 24-hour format (e.g., 2:00:00pm is 14:00:00). Unless otherwise specified, all date-time values are recorded in Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT) or Zulu (because the time portion of the time stamp ends with a Z). That is, time values do not reflect the time zone shown on the eBay Web site. Here is an example of the date-time format:

YYYY-MM-DDTHH:MM:SS.SSSZ (e.g., 2004-08-04T19:09:02.768Z)

See [Time Values](https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/DataTypes.html#TimeValues)
for information about how to convert between local time zones and GMT.

We use the dateTime data type to convey start and end times, the official eBay time, and other time values. | | decimal | A decimal value of arbitrary precision.

In the API, most fields of type decimal can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Decimal values should never include a thousands separator.

A whole number (i.e., without a period) can be passed as a decimal value.

We typically use the decimal data type to convey values related to units of measure. See individual topics for specific restrictions beyond this for fields of type decimal. | | double | A double-precision 64-bit floating point type.

In the API, most fields of type double can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Double values should never include a thousands separator.

We typically use the double data type to convey values related to monetary amounts.

In some cases, a whole number (i.e., without a period) can be passed or returned as a double value. See individual topics for specific restrictions beyond this for fields of type double. | | duration | A length of time.

Duration values are in the ISO 8601 duration format, where P represents "Period", nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes, and nS the number of seconds. So P2DT23H32M51S means "A period of 2 days, 23 hours, 32 minutes, and 51 seconds".

PnYnMnDTnH nMnS (e.g., P2DT23H32M51S)

We use the duration data type to convey values like the time left until a listing ends. For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). | | float | A single-precision 32-bit floating point type.

In the API, most fields of type float can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Float values should never include a thousands separator.

We typically use the float data type to convey values related to percentages. See individual topics for specific restrictions beyond this for fields of type float. | | int | A 32-bit integer value between -2147483648 and 2147483647.

In the API, most fields of type int can contain digits 0-9, and hyphen to indicate negative numbers. Some input fields restrict the input to particular values or a range of values. These cases are noted in the associated topic for the specific input field.

We typically use the int data type for enumerations, counts (e.g., how many items are returned), quantities, certain kinds of IDs (other IDs are strings), and similar concepts. | | long | A value between -9223372036854775808 and 9223372036854775807. | | string | A string of characters. All characters in the Unicode character set are supported.

Character entity references are used for escaping markup-significant characters. For example, use & for the & (ampersand) character, < for the < (less-than sign) character, and > for the > (greater-than sign) character. It is a good idea to escape such characters in requests instead of using a CDATA construct. Responses from eBay do not include CDATA constructs.

Note that messages from eBay may contain HTML or XML markup within the message text. In this case, the markup elements within the text are escaped (e.g., <!\[CDATA\[ ... \]\]>).

Some string input fields do not have a known set of possible values. For these fields, the documentation specifies the maximum permitted length in characters. If you are using a URL for your request, and you need to use the & (ampersand) character as part of a string value, use &.

xs:string is part of the XML schema namespace defined as:

xmlns:xs="http://www.w3.org/2001/XMLSchema" | | token | A set of normalized strings.

In the API, this type of string contains no white space, by convention.

We typically use token to constrain a field to a specified set of normalized string values. For such a field, we define these values in an enumeration that uses token as its base type. | Repeatable (Unbounded) Fields ----------------------------- If the multiplicity of an element is defined as maxOccurs="unbounded" or a value greater than 1 in the schema, it means you can specify the field multiple times in a request (like you are specifying an array), or eBay can return the field multiple times in the response. In this case, the fields must be contiguous. That is, in a request, you cannot insert other fields between the repeating fields. Otherwise, some of the data will be dropped in an unpredictable manner. Multiplicity Notation --------------------- | Sample XML notation | Corresponding doc notation | Meaning § | | --- | --- | --- | | minOccurs="0" maxOccurs="unbounded" | \[0..\*\] | Zero or more | | minOccurs="0" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="1" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="6" | \[0..6\] | Zero to six | §  While this is the general meaning, be sure to read the description of the particular field: it may state an exception for a particular use. --- # Unknown Product API * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/Product/ReleaseNotes.html) Simple Schema Types =================== The eBay Schema makes use of many simple schema types. Further, some eBay-defined types are based on simple schema types. Except where specified, the data types in the table below follow the conventions for XML Schema simple types as described by the World Wide Web Consortium in [XML Schema Part 2: Datatypes](http://www.w3.org/TR/xmlschema-2/) . | Data Type | Description | | --- | --- | | anyURI | Specifies a Uniform Resource Identifier (URI), a compact sequence of characters that identifies an abstract or physical resource.

The anyURI type is used most often to specify Uniform Resource Locators (URLs), such as a web page URL (e.g., ViewItemURL) or a file location URL (e.g., PictureURL), but can also be used for email addresses and other valid URI schemes. | | boolean | Specifies binary-valued logic (true/false). Possible input values are true, false, 1, and 0. Possible output values are true and false only (not 1 or 0). | | dateTime | A specific instant of time.

Date-time values are in the ISO 8601 date and time format. Hours are in 24-hour format (e.g., 2:00:00pm is 14:00:00). Unless otherwise specified, all date-time values are recorded in Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT) or Zulu (because the time portion of the time stamp ends with a Z). That is, time values do not reflect the time zone shown on the eBay Web site. Here is an example of the date-time format:

YYYY-MM-DDTHH:MM:SS.SSSZ (e.g., 2004-08-04T19:09:02.768Z)

See [Time Values](https://developer.ebay.com/devzone/guides/features-guide/default.html#basics/DataTypes.html#TimeValues)
for information about how to convert between local time zones and GMT.

We use the dateTime data type to convey start and end times, the official eBay time, and other time values. | | decimal | A decimal value of arbitrary precision.

In the API, most fields of type decimal can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Decimal values should never include a thousands separator.

A whole number (i.e., without a period) can be passed as a decimal value.

We typically use the decimal data type to convey values related to units of measure. See individual topics for specific restrictions beyond this for fields of type decimal. | | double | A double-precision 64-bit floating point type.

In the API, most fields of type double can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Double values should never include a thousands separator.

We typically use the double data type to convey values related to monetary amounts.

In some cases, a whole number (i.e., without a period) can be passed or returned as a double value. See individual topics for specific restrictions beyond this for fields of type double. | | duration | A length of time.

Duration values are in the ISO 8601 duration format, where P represents "Period", nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes, and nS the number of seconds. So P2DT23H32M51S means "A period of 2 days, 23 hours, 32 minutes, and 51 seconds".

PnYnMnDTnH nMnS (e.g., P2DT23H32M51S)

We use the duration data type to convey values like the time left until a listing ends. For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). | | float | A single-precision 32-bit floating point type.

In the API, most fields of type float can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Float values should never include a thousands separator.

We typically use the float data type to convey values related to percentages. See individual topics for specific restrictions beyond this for fields of type float. | | int | A 32-bit integer value between -2147483648 and 2147483647.

In the API, most fields of type int can contain digits 0-9, and hyphen to indicate negative numbers. Some input fields restrict the input to particular values or a range of values. These cases are noted in the associated topic for the specific input field.

We typically use the int data type for enumerations, counts (e.g., how many items are returned), quantities, certain kinds of IDs (other IDs are strings), and similar concepts. | | long | A value between -9223372036854775808 and 9223372036854775807. | | string | A string of characters. All characters in the Unicode character set are supported.

Character entity references are used for escaping markup-significant characters. For example, use & for the & (ampersand) character, < for the < (less-than sign) character, and > for the > (greater-than sign) character. It is a good idea to escape such characters in requests instead of using a CDATA construct. Responses from eBay do not include CDATA constructs.

Note that messages from eBay may contain HTML or XML markup within the message text. In this case, the markup elements within the text are escaped (e.g., <!\[CDATA\[ ... \]\]>).

Some string input fields do not have a known set of possible values. For these fields, the documentation specifies the maximum permitted length in characters. If you are using a URL for your request, and you need to use the & (ampersand) character as part of a string value, use &.

xs:string is part of the XML schema namespace defined as:

xmlns:xs="http://www.w3.org/2001/XMLSchema" | | token | A set of normalized strings.

In the API, this type of string contains no white space, by convention.

We typically use token to constrain a field to a specified set of normalized string values. For such a field, we define these values in an enumeration that uses token as its base type. | Repeatable (Unbounded) Fields ----------------------------- If the multiplicity of an element is defined as maxOccurs="unbounded" or a value greater than 1 in the schema, it means you can specify the field multiple times in a request (like you are specifying an array), or eBay can return the field multiple times in the response. In this case, the fields must be contiguous. That is, in a request, you cannot insert other fields between the repeating fields. Otherwise, some of the data will be dropped in an unpredictable manner. Multiplicity Notation --------------------- | Sample XML notation | Corresponding doc notation | Meaning § | | --- | --- | --- | | minOccurs="0" maxOccurs="unbounded" | \[0..\*\] | Zero or more | | minOccurs="0" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="1" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="6" | \[0..6\] | Zero to six | §  While this is the general meaning, be sure to read the description of the particular field: it may state an exception for a particular use. --- # CreateReturnRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CreateReturnRequest =================== The base request type of the **POST /post-order/v2/return** method, which allows you to create a return request from scratch or to convert a return request draft into a return request. Call that uses CreateReturnRequest: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) Fields ------ draftId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of a return request draft. This field is only applicable (and required) if the buyer is converting a return request draft into an actual return request with the **POST /post-order/v2/return** method. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#draftId) to learn which calls use draftId. returnRequest ( _[ReturnRequestType](https://developer.ebay.com/devzone/post-order/types/ReturnRequestType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container is used to provide details about the buyer's return request, including the order line item (and quantity) that is being returned or the reason for the return. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnRequest) to learn which calls use returnRequest. --- # ConsolidateShippingProfilesResponse - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) ConsolidateShippingProfilesResponse ( [BaseResponse](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html) ) ============================================================================================================================================= The response container for the **consolidateShippingProfiles** call. Call that uses ConsolidateShippingProfilesResponse: [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html) Field ----- Job ( _[ConsolidationJob](https://developer.ebay.com/devzone/business-policies/CallRef/types/ConsolidationJob.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of details related to the shipping policies consolidation job, including a unique ID, the status of the job, and the eBay site ID. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#Job) to learn which calls use Job. --- # ActionDeadlines - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ActionDeadlines =============== This type is used by the **actionDeadlines** container, which provides the number of remaining days that a buyer or seller has before being required to take action on an INR or Return case. Type that uses ActionDeadlines: [CaseDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/CaseDetailsResponse.html) Call that uses ActionDeadlines: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Fields ------ [daysForBuyerToProvideProofOfShipment](https://developer.ebay.com/Devzone/post-order/types/ActionDeadlines.html#daysForBuyerToProvideProofOfShipment) ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [daysToExpireWithoutResponse](https://developer.ebay.com/Devzone/post-order/types/ActionDeadlines.html#daysToExpireWithoutResponse) ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [daysToExpireWithResponse](https://developer.ebay.com/Devzone/post-order/types/ActionDeadlines.html#daysToExpireWithResponse) ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [daysToReturnItem](https://developer.ebay.com/Devzone/post-order/types/ActionDeadlines.html#daysToReturnItem) ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [maxDaysToFileClaim](https://developer.ebay.com/Devzone/post-order/types/ActionDeadlines.html#maxDaysToFileClaim) ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) daysForBuyerToProvideProofOfShipment ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the number of days that the buyer has to provide proof of return shipment before the case expires. This field is only returned for a Return case. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#daysForBuyerToProvideProofOfShipment) to learn which calls use daysForBuyerToProvideProofOfShipment. daysToExpireWithoutResponse ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the number of days that a user (buyer or seller) has to make a required response on the case before the case expires. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#daysToExpireWithoutResponse) to learn which calls use daysToExpireWithoutResponse. daysToExpireWithResponse ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the number of days that remain before the case expires. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#daysToExpireWithResponse) to learn which calls use daysToExpireWithResponse. daysToReturnItem ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the number of remaining days that the buyer has to return an item and still expect a refund from the seller. This field is only returned for a Return case. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#daysToReturnItem) to learn which calls use daysToReturnItem. maxDaysToFileClaim ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the number of remaining days that the buyer has to file a claim. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#maxDaysToFileClaim) to learn which calls use maxDaysToFileClaim. --- # RelistStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RelistStatusEnum ================ This enumerated type defines the different possible response values that can be returned to indicate the relisting status of an item that was involved in an order cancellation or return request. Type that uses RelistStatusEnum: [ItemDetailType](https://developer.ebay.com/Devzone/post-order/types/ItemDetailType.html) Calls that use one or more values of RelistStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | This enumeration value indicates that the attempt to relist the item has failed. | | RELIST\_ELIGIBLE | This enumeration value indicates that the item is eligible to be relisted automatically by eBay upon the successful cancellation of an order or once a returned item is marked as received by the seller. | | SUCCESS | This enumeration value indicates that the item has been successfully relisted upon the successful cancellation of an order, or after a returned item has been marked as received by the seller. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # LabelActionEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) LabelActionEnum =============== This enumerated type lists the actions that may be specified in the **labelAction** field in the request of the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** method. Type that uses LabelActionEnum: [ProvideLabelRequest](https://developer.ebay.com/Devzone/post-order/types/ProvideLabelRequest.html) Call that uses one or more values of LabelActionEnum: [/post-order/v2/return/{returnId}/add\_shipping\_label POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AU\_LABEL | This value is used if an Australian seller has created an eBay shipping label for the return shipment. Australian sellers are billed for eBay shipping labels on their monthly invoice. | | EBAY\_LABEL | This value is used if the seller has created an eBay shipping label for the return shipment. | | MARK\_AS\_SENT | This value is used if the seller is using the **POST /post-order/v2/return/{returnId}/add\_shipping\_label** method to mark an eBay-generated label as being sent to the buyer. | | NO\_LABEL | This value is used if the seller is not providing an eBay shipping label to the buyer. If this value is used, the seller must also include the **noLabelReason** field and provide the reason why no label is being provided.

It could be the seller is providing their own shipping label to the buyer (and not an eBay shipping label). In the case where the seller provides their own label, they must populate the **labelId** field with the shipment tracking number of the shipping label they're supplying to the buyer. | | PURCHASE\_LABEL | This value is used if the seller has purchased their own (non-eBay) shipping label for the return shipment. | | UNKNOWN | Indicates the label action is not known. | | UPLOAD\_LABEL | This value is used if the seller is providing their own shipping label to the buyer (and not an eBay shipping label). |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Merchandising API | eBay Developers Program Merchandising API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/merchandising/docs/concepts/MerchandisingAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/merchandising/docs/concepts/MerchandisingAPI_FormatOverview.html) * [API Reference](https://developer.ebay.com/Devzone/merchandising/docs/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/merchandising/docs/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/merchandising/docs/ReleaseNotes.html) eBay Site ID to Global ID Mapping ================================= Each eBay site maps to a unique [eBay global ID](https://developer.ebay.com/Devzone/merchandising/docs/CallRef/Enums/GlobalIdList.html) . You must specify a global ID in the `X-EBAY-SOA-GLOBAL-ID` HTTP header for each API call. The global ID you use must correspond to one of the eBay site IDs in the following table: | eBay Site ID | Site Name | Global ID | | --- | --- | --- | | 0 | eBay United States | EBAY-US | | 2 | eBay Canada (English) | EBAY-ENCA | | 3 | eBay UK | EBAY-GB | | 15 | eBay Australia | EBAY-AU | | 16 | eBay Austria | EBAY-AT | | 23 | eBay Belgium (French) | EBAY-FRBE | | 71 | eBay France | EBAY-FR | | 77 | eBay Germany | EBAY-DE | | 100 | eBay Motors | EBAY-MOTOR | | 101 | eBay Italy | EBAY-IT | | 123 | eBay Belgium (Dutch) | EBAY-NLBE | | 146 | eBay Netherlands | EBAY-NL | | 186 | eBay Spain | EBAY-ES | | 193 | eBay Switzerland | EBAY-CH | | 201 | eBay Hong Kong | EBAY-HK | | 205 | eBay Ireland | EBAY-IE | | 207 | eBay Malaysia | EBAY-MY | | 210 | eBay Canada (French) | EBAY-FRCA | | 211 | eBay Philippines | EBAY-PH | | 212 | eBay Poland | EBAY-PL | | 216 | eBay Singapore | EBAY-SG | * * * --- # Unknown Product API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/Product/ReleaseNotes.html) Simple Schema Types =================== The eBay Schema makes use of many simple schema types. Further, some eBay-defined types are based on simple schema types. Except where specified, the data types in the table below follow the conventions for XML Schema simple types as described by the World Wide Web Consortium in [XML Schema Part 2: Datatypes](http://www.w3.org/TR/xmlschema-2/) . | Data Type | Description | | --- | --- | | anyURI | Specifies a Uniform Resource Identifier (URI), a compact sequence of characters that identifies an abstract or physical resource.

The anyURI type is used most often to specify Uniform Resource Locators (URLs), such as a web page URL (e.g., ViewItemURL) or a file location URL (e.g., PictureURL), but can also be used for email addresses and other valid URI schemes. | | boolean | Specifies binary-valued logic (true/false). Possible input values are true, false, 1, and 0. Possible output values are true and false only (not 1 or 0). | | dateTime | A specific instant of time.

Date-time values are in the ISO 8601 date and time format. Hours are in 24-hour format (e.g., 2:00:00pm is 14:00:00). Unless otherwise specified, all date-time values are recorded in Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT) or Zulu (because the time portion of the time stamp ends with a Z). That is, time values do not reflect the time zone shown on the eBay Web site. Here is an example of the date-time format:

YYYY-MM-DDTHH:MM:SS.SSSZ (e.g., 2004-08-04T19:09:02.768Z)

See [Time Values](https://developer.ebay.com/Devzone/guides/features-guide/default.html#basics/DataTypes.html#TimeValues)
for information about how to convert between local time zones and GMT.

We use the dateTime data type to convey start and end times, the official eBay time, and other time values. | | decimal | A decimal value of arbitrary precision.

In the API, most fields of type decimal can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Decimal values should never include a thousands separator.

A whole number (i.e., without a period) can be passed as a decimal value.

We typically use the decimal data type to convey values related to units of measure. See individual topics for specific restrictions beyond this for fields of type decimal. | | double | A double-precision 64-bit floating point type.

In the API, most fields of type double can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Double values should never include a thousands separator.

We typically use the double data type to convey values related to monetary amounts.

In some cases, a whole number (i.e., without a period) can be passed or returned as a double value. See individual topics for specific restrictions beyond this for fields of type double. | | duration | A length of time.

Duration values are in the ISO 8601 duration format, where P represents "Period", nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes, and nS the number of seconds. So P2DT23H32M51S means "A period of 2 days, 23 hours, 32 minutes, and 51 seconds".

PnYnMnDTnH nMnS (e.g., P2DT23H32M51S)

We use the duration data type to convey values like the time left until a listing ends. For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). | | float | A single-precision 32-bit floating point type.

In the API, most fields of type float can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Float values should never include a thousands separator.

We typically use the float data type to convey values related to percentages. See individual topics for specific restrictions beyond this for fields of type float. | | int | A 32-bit integer value between -2147483648 and 2147483647.

In the API, most fields of type int can contain digits 0-9, and hyphen to indicate negative numbers. Some input fields restrict the input to particular values or a range of values. These cases are noted in the associated topic for the specific input field.

We typically use the int data type for enumerations, counts (e.g., how many items are returned), quantities, certain kinds of IDs (other IDs are strings), and similar concepts. | | long | A value between -9223372036854775808 and 9223372036854775807. | | string | A string of characters. All characters in the Unicode character set are supported.

Character entity references are used for escaping markup-significant characters. For example, use & for the & (ampersand) character, < for the < (less-than sign) character, and > for the > (greater-than sign) character. It is a good idea to escape such characters in requests instead of using a CDATA construct. Responses from eBay do not include CDATA constructs.

Note that messages from eBay may contain HTML or XML markup within the message text. In this case, the markup elements within the text are escaped (e.g., <!\[CDATA\[ ... \]\]>).

Some string input fields do not have a known set of possible values. For these fields, the documentation specifies the maximum permitted length in characters. If you are using a URL for your request, and you need to use the & (ampersand) character as part of a string value, use &.

xs:string is part of the XML schema namespace defined as:

xmlns:xs="http://www.w3.org/2001/XMLSchema" | | token | A set of normalized strings.

In the API, this type of string contains no white space, by convention.

We typically use token to constrain a field to a specified set of normalized string values. For such a field, we define these values in an enumeration that uses token as its base type. | Repeatable (Unbounded) Fields ----------------------------- If the multiplicity of an element is defined as maxOccurs="unbounded" or a value greater than 1 in the schema, it means you can specify the field multiple times in a request (like you are specifying an array), or eBay can return the field multiple times in the response. In this case, the fields must be contiguous. That is, in a request, you cannot insert other fields between the repeating fields. Otherwise, some of the data will be dropped in an unpredictable manner. Multiplicity Notation --------------------- | Sample XML notation | Corresponding doc notation | Meaning § | | --- | --- | --- | | minOccurs="0" maxOccurs="unbounded" | \[0..\*\] | Zero or more | | minOccurs="0" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="1" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="6" | \[0..6\] | Zero to six | §  While this is the general meaning, be sure to read the description of the particular field: it may state an exception for a particular use. --- # ActualRefund - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ActualRefund ============ This type is used by the **actualRefund** container, which shows the total amount of the buyer refund that has been issued for the cancelled order. Type that uses ActualRefund: [ActualRefundDetail](https://developer.ebay.com/Devzone/post-order/types/ActualRefundDetail.html) Call that uses ActualRefund: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Fields ------ donationAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container defines the refund amount for listings that included a charitable donation. This data includes the amount of the charitable donation refund, as well as currency conversion information when necessary including the current currency code, the value in the original currency, and the original currency's code. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#donationAmount) to learn which calls use donationAmount. feeCreditAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount of fees credited towards this refund as per eBay policy. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#feeCreditAmount) to learn which calls use feeCreditAmount. totalAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount of the refund that has been issued. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#totalAmount) to learn which calls use totalAmount. --- # GetProductSearchDataVersionResponse - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product-metadata/ReleaseNotes.html) GetProductSearchDataVersionResponse ( [BaseServiceResponse](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/BaseServiceResponse.html) ) ========================================================================================================================================================== Response container for getCompatibilitySearchDataVersion and getProductSearchDataVersion calls. Call that uses GetProductSearchDataVersionResponse: [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) Fields ------ namesDetails ( _[VersionDetails](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/VersionDetails.html) _ ) [\[0..1\]](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Time and version for the most recent update of catalog property names for the specified category. See the [Field Index](https://developer.ebay.com/DevZone/product-metadata/CallRef/fieldindex.html#namesDetails) to learn which calls use namesDetails. valueDetails ( _[VersionDetails](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/VersionDetails.html) _ ) [\[0..1\]](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Time and version for the most recent update of catalog property values for the specified category. See the [Field Index](https://developer.ebay.com/DevZone/product-metadata/CallRef/fieldindex.html#valueDetails) to learn which calls use valueDetails. --- # CreateReturnRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) CreateReturnRequest =================== The base request type of the **POST /post-order/v2/return** method, which allows you to create a return request from scratch or to convert a return request draft into a return request. Call that uses CreateReturnRequest: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) Fields ------ draftId ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of a return request draft. This field is only applicable (and required) if the buyer is converting a return request draft into an actual return request with the **POST /post-order/v2/return** method. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#draftId) to learn which calls use draftId. returnRequest ( _[ReturnRequestType](https://developer.ebay.com/Devzone/post-order/types/ReturnRequestType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container is used to provide details about the buyer's return request, including the order line item (and quantity) that is being returned or the reason for the return. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#returnRequest) to learn which calls use returnRequest. --- # GetTrackingHistoryResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) GetTrackingHistoryResponse ========================== The base response for the **GET /post-order/v2/return/{returnId}/tracking** method. The information in this response should be available once the shipment information has been uploaded to the eBay system Call that uses GetTrackingHistoryResponse: [/post-order/v2/return/{returnId}/tracking GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid_tracking__get.html) Fields ------ carrierUsed ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates the shipping carrier used to ship the item. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#carrierUsed) to learn which calls use carrierUsed. scanHistory ( array of _[ScanDetailType](https://developer.ebay.com/Devzone/post-order/types/ScanDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container holds an array of one or more shipment events/scans that have occurred with the item being returned, and each node provides details on each time a shipment is scanned by the shipping carrier. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#scanHistory) to learn which calls use scanHistory. trackingNumber ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This value is the tracking number for the shipment. Shipment tracking is mandatory except in countries where shipment tracking is not available, so this number should generally always be returned. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#trackingNumber) to learn which calls use trackingNumber. trackingStatus ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates the delivery status of the shipment, such as in-transit or delivered. This field will be returned unless it is not known. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#trackingStatus) to learn which calls use trackingStatus. --- # CaseDetails - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CaseDetails =========== This type is used by the **caseDetails** container that is returned in the **GET /post-order/v2/casemanagement/{caseId}** method to provide detailed information about the case. Type that uses CaseDetails: [CaseDetailsResponse](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html) Call that uses CaseDetails: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Fields ------ [buyerFinalAcceptResolution](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#buyerFinalAcceptResolution) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [buyerInitExpectResolution](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#buyerInitExpectResolution) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [escalationDate](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#escalationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [expirationDate](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#expirationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [lastBuyerRespDate](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#lastBuyerRespDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [lastSellerRespDate](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#lastSellerRespDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [paypalPaid](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#paypalPaid) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [refundAmounts](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#refundAmounts) ( _[RefundAmounts](https://developer.ebay.com/devzone/post-order/types/RefundAmounts.html) _ ) [refundChargeAmount](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#refundChargeAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [refundDeadlineDate](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#refundDeadlineDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [refundType](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html#refundType) ( _[RefundType](https://developer.ebay.com/devzone/post-order/types/RefundType.html) _ ) buyerFinalAcceptResolution ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates what the buyer ultimately agreed to with the seller to resolve the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerFinalAcceptResolution) to learn which calls use buyerFinalAcceptResolution. buyerInitExpectResolution ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates what the buyer initially agreed to with the seller to resolve the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerInitExpectResolution) to learn which calls use buyerInitExpectResolution. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the case was created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. escalationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the associated INR inquiry or return request was escalated into a case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalationDate) to learn which calls use escalationDate. expirationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when a case will expire naturally if a required response from the buyer or seller is not made. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#expirationDate) to learn which calls use expirationDate. lastBuyerRespDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the buyer last responded to, or performed an action on the case. This field is only returned if the buyer has responded to and/or performed an action on the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastBuyerRespDate) to learn which calls use lastBuyerRespDate. lastSellerRespDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the seller last responded to, or performed an action on the case. This field is only returned if the seller has responded to and/or performed an action on the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastSellerRespDate) to learn which calls use lastSellerRespDate. paypalPaid ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) **THIS FIELD IS DEPRECATED**. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#paypalPaid) to learn which calls use paypalPaid. refundAmounts ( _[RefundAmounts](https://developer.ebay.com/devzone/post-order/types/RefundAmounts.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of details related to the expected and actual refund amounts. This container is only returned if a refund is scheduled to, or has been issued to the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundAmounts) to learn which calls use refundAmounts. refundChargeAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount charged to the seller for this refund. The value will be in the seller's default currency. This container is only applicable and returned if a refund has been issued to the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundChargeAmount) to learn which calls use refundChargeAmount. refundDeadlineDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the latest date/time when the buyer is eligible for a refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundDeadlineDate) to learn which calls use refundDeadlineDate. refundType ( _[RefundType](https://developer.ebay.com/devzone/post-order/types/RefundType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates whether the buyer is scheduled to, or has already received a a full or partial refund. This field is only returned if a refund is scheduled to, or has been issued to the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundType) to learn which calls use refundType. --- # FundingMethodBrandEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) FundingMethodBrandEnum ====================== This enumeration type lists the possible credit card brands that can be used by eBay to fund a seller's refund to a buyer. This type is only applicable if a buyer refund will be funded using a seller's credit card as the funding source. Types that use FundingMethodBrandEnum: [FundingSource](https://developer.ebay.com/Devzone/post-order/types/FundingSource.html) , [FundingSourceType](https://developer.ebay.com/Devzone/post-order/types/FundingSourceType.html) Calls that use one or more values of FundingMethodBrandEnum: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AMERICAN\_EXPRESS | This enumeration value indicates that a American Express credit card will be used to fund the refund to the buyer. | | DISCOVER | This enumeration value indicates that a Discover credit card will be used to fund the refund to the buyer. | | MASTERCARD | This enumeration value indicates that a Mastercard credit card will be used to fund the refund to the buyer. | | VISA | This enumeration value indicates that a Visa credit card will be used to fund the refund to the buyer. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ErrorData - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) ErrorData ========= A container for error details. Type that uses ErrorData: [ErrorMessage](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorMessage.html) Calls that use ErrorData: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ [category](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#category) ( _[ErrorCategory](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorCategory.html) _ ) [domain](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#domain) ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [errorId](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#errorId) ( _[long](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#long) _ ) [exceptionId](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#exceptionId) ( _[token](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#token) _ ) [message](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#message) ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [parameter](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#parameter) ( _[ErrorParameter](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) )_ ) [severity](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#severity) ( _[ErrorSeverity](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorSeverity.html) _ ) [subdomain](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html#subdomain) ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) category ( _[ErrorCategory](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorCategory.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) There are three categories of errors: request errors, application errors, and system errors. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#category) to learn which calls use category. domain ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Name of the domain in which the error occurred. **domain values:** Marketplace A business or validation error occurred in the service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#domain) to learn which calls use domain. errorId ( _[long](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#long) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#errorId) to learn which calls use errorId. exceptionId ( _[token](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Unique identifier for an exception associated with an error. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#exceptionId) to learn which calls use exceptionId. message ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) A detailed description of the condition that caused in the error. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#message) to learn which calls use message. parameter ( _[ErrorParameter](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) )_ ) [\[0..\*\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#parameter) to learn which calls use parameter. severity ( _[ErrorSeverity](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorSeverity.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) 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, re-send 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. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#severity) to learn which calls use severity. subdomain ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Name of the subdomain in which the error occurred. **subdomain values:** MarketplaceCatalog The error is specific to the Marketplace Catalog subdomain. MarketplaceCommon The error is common to all Marketplace services. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#subdomain) to learn which calls use subdomain. --- # ReturnUserRoleEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnUserRoleEnum ================== This enumerated type lists all possible roles for parties involved in a return request, such as buyer, seller, and eBay. Types that use ReturnUserRoleEnum: [ReturnFileType](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html) , [ReturnResponseHistoryType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html) , [ShipmentTrackingType](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingType.html) , [ShipmentType](https://developer.ebay.com/devzone/post-order/types/ShipmentType.html) Calls that use one or more values of ReturnUserRoleEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This enumeration value indicates that the buyer performed the action on the return request. | | EBAY | This enumeration value indicates that eBay customer support performed the action on the return request. | | OTHER | This enumeration value indicates that it is unknown who/what performed the action on the return request. | | SELLER | This enumeration value indicates that the seller performed the action on the return request. | | SYSTEM | This enumeration value indicates that the action on the return request was an automated action initiated by eBay's system. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # Global ID Values - Product API Product API * [Features Guide](https://developer.ebay.com/DevZone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/DevZone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product/ReleaseNotes.html) Global ID Values ([string](https://developer.ebay.com/DevZone/product/CallRef/types/simpleTypes.html) ) ======================================================================================================== The Global ID is a unique identifier for combinations of site, language, and territory. Global ID values are returned in **globalId** and are used as input for the X-EBAY-SOA-GLOBAL-ID header. The global ID you use must correspond to an eBay site with a valid site ID. See [eBay Site ID to Global ID Mapping](https://developer.ebay.com/DevZone/product/Concepts/SiteIDToGlobalID.html) for a list of global IDs you can use with the API calls. **Enumeration Values (active sites only)** | Global ID | Language | Territory | Site Name | eBay Site ID | | --- | --- | --- | --- | --- | | EBAY-AT | de-AT | AT | eBay Austria | 16 | | EBAY-AU | en-AU | AU | eBay Australia | 15 | | EBAY-CH | de-CH | CH | eBay Switzerland | 193 | | EBAY-DE | en-DE | DE | eBay Germany | 77 | | EBAY-ENCA | en-CA | CA | eBay Canada (English) | 2 | | EBAY-ES | es-ES | ES | eBay Spain | 186 | | EBAY-FR | fr-FR | FR | eBay France | 71 | | EBAY-FRBE | fr-BE | BE | eBay Belgium (French) | 23 | | EBAY-FRCA | fr-CA | CA | eBay Canada (French) | 210 | | EBAY-GB | en-GB | GB | eBay UK | 3 | | EBAY-HK | zh-Hant | HK | eBay Hong Kong | 201 | | EBAY-IE | en-IE | IE | eBay Ireland | 205 | | EBAY-IN | en-IN | IN | eBay India | 203 | | EBAY-IT | it-IT | IT | eBay Italy | 101 | | EBAY-MOTOR | en-US | US | eBay Motors | 100 | | EBAY-MY | en-MY | MY | eBay Malaysia | 207 | | EBAY-NL | nl-NL | NL | eBay Netherlands | 146 | | EBAY-NLBE | nl-BE | BE | eBay Belgium (Dutch) | 123 | | EBAY-NZ (reserved for future use) | en-NZ | NZ | eBay New Zealand | N/A | | EBAY-PH | en-PH | PH | eBay Philippines | 211 | | EBAY-PL | pl-PL | PL | eBay Poland | 212 | | EBAY-SG | en-SG | SG | eBay Singapore | 216 | | EBAY-US | en-US | US | eBay United States | 0 | --- # ReturnSortType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ReturnSortType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ====================================================================================================================== Enumerated type that contains the valid values to use in the **sortType** field. This field is used to sort returns in the response based on either return filing date, estimated refund amount, refund due date, or buyer login name. If this field is not used, returns are sorted by filing date. Type that uses ReturnSortType: [getUserReturnsRequest](https://developer.ebay.com/Devzone/return-management/CallRef/types/getUserReturnsRequest.html) Call that uses one or more values of ReturnSortType: [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BuyerLoginName | If this value is specified, returns are sorted alphabetically based on the buyer's eBay login name. If **sortOrder** is set to **Ascending**, returns are sorted in alphabetical order according to eBay login name. If **sortOrder** is set to **Descending**, returns are sorted in reverse alphabetical order according to eBay login name. **FilingDate** is the default value, so returns will be sorted by filing date if a **sortOrder** value is not specified in the **getUserReturns** request. | | EstimatedAmount | If this value is specified, returns are sorted based on the estimated amount of the return. If **sortOrder** is set to **Descending**, the highest value returns will appear first in the results set. If **sortOrder** is set to **Ascending**, the lowest value returns will appear first in the results set. **FilingDate** is the default value, so returns will be sorted by filing date if a **sortOrder** value is not specified in the **getUserReturns** request. | | FilingDate | If this value is specified, returns are sorted based on the filing date of the return. If **sortOrder** is set to **Descending**, the most recent returns will appear first in the results set. If **sortOrder** is set to **Ascending**, the oldest returns will appear first in the results set. **FilingDate** is the default value, so returns will be sorted by filing date if a **sortOrder** value is not specified in the **getUserReturns** request. | | RefundDueDate | If this value is specified, returns are sorted based on the refund due date. If **sortOrder** is set to **Descending**, returns with refund due dates the furthest in the future will appear first in the results set. If **sortOrder** is set to **Ascending**, returns with refund due dates the nearest in the future will appear first in the results set. **FilingDate** is the default value, so returns will be sorted by filing date if a **sortOrder** value is not specified in the **getUserReturns** request. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnStatusInputType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ReturnStatusInputType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ============================================================================================================================= Enumerated type that defines the return status values that can be passed into the **ReturnStatusFilter** container and used as filters for the **getUserReturns** call. Type that uses ReturnStatusInputType: [ReturnStatusFilterType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnStatusFilterType.html) Call that uses one or more values of ReturnStatusInputType: [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CLOSED | This value is passed into the **ReturnStatusFilter.ReturnStatus** field of the **getUserReturns** request to retrieve all closed returns. If **CLOSED** is used as a filter, returns in the following states (these values are indicated in the **Returns.ReturnSummary.status** field) are returned:

* CLOSED
* CS\_CLOSED
* EXPIRED
* YOU\_CONTACTED\_CS\_ABOUT\_CLOSED\_Return | | ITEM\_SHIPPED | This value is passed into the **ReturnStatusFilter.ReturnStatus** field of the **getUserReturns** request to retrieve all returns with the status of WAITING\_DELIVERY. Return status values are indicated in the **Returns.ReturnSummary.status** field. | | MY\_RESPONSE\_DUE | This value is passed into the **ReturnStatusFilter.ReturnStatus** field of the **getUserReturns** request to retrieve all returns in which the seller's response is due. The two applicable return status values returned in the **Returns.ReturnSummary.status** field are MY\_PAYMENT\_DUE and MY\_RESPONSE\_DUE. The MY\_PAYMENT\_DUE value indicates that the seller is expected to issue a refund to the buyer. The MY\_RESPONSE\_DUE value can indicate that the seller must provide an RMA number to the buyer, or the seller must contact eBay customer support. | | OTHER\_PARTY\_RESPONSE\_DUE | This value is passed into the **ReturnStatusFilter.ReturnStatus** field of the **getUserReturns** request to retrieve all returns in which the other party's response is due. The only applicable return status value returned in **Returns.ReturnSummary.status** field is OTHER\_PARTY\_RESPONSE\_DUE. | | RETURN\_STARTED | This value is passed into the **ReturnStatusFilter.ReturnStatus** field of the **getUserReturns** request to retrieve all open returns. If **RETURN\_STARTED** is used as a filter, returns in the following states (these values are indicated in the **Returns.ReturnSummary.status** field) are returned:

* MY\_PAYMENT\_DUE
* MY\_RESPONSE\_DUE
* OTHER\_PARTY\_CONTACTED\_CS\_AWAITING\_RESPONSE
* OTHER\_PARTY\_RESPONSE\_DUE
* PAID
* WAITING\_DELIVERY
* YOU\_CONTACTED\_CS\_AWAITING\_RESPONSE |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # TrackingStatusType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) TrackingStatusType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ========================================================================================================================== Enumerated type that contains the possible values that can be returned in the **deliveryStatus** field of the **provideTrackingInfo** response. This value will indicate the status of the package shipment. Type that uses TrackingStatusType: [ProvideTrackingInfoResponse](https://developer.ebay.com/Devzone/return-management/CallRef/types/ProvideTrackingInfoResponse.html) Call that uses one or more values of TrackingStatusType: [provideTrackingInfo](https://developer.ebay.com/Devzone/return-management/CallRef/provideTrackingInfo.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | DELIEVERED | This value indicates that the package has been delivered. | | IN\_TRANSIT | This value indicates that the package is in transit. | | UNKNOWN | This value indicates that the shipping status of the package is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # CaseType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) CaseType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ================================================================================================================ Enumerated type that defines the eBay Buyer Protection case types. Type that uses CaseType: [CaseIdType](https://developer.ebay.com/Devzone/return-management/CallRef/types/CaseIdType.html) Call that uses one or more values of CaseType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | EBP\_SNAD | This value indicates that the eBay Buyer Protection case involves a "significantly not as described" item. | | OTHER | This value is reserved for future use. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ActivityOptionType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ActivityOptionType ( [string](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#string) ) ============================================================================================================================ Enumerated type that defines a seller's next possible actions to take in a return. Type that uses ActivityOptionType: [GetActivityOptionsResponse](https://developer.ebay.com/Devzone/return-management/CallRef/types/GetActivityOptionsResponse.html) Call that uses one or more values of ActivityOptionType: [getActivityOptions](https://developer.ebay.com/Devzone/return-management/CallRef/getActivityOptions.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ISSUE\_REFUND | This value indicates that the seller's next action is to issue a refund to the buyer through the **issueRefund** call. | | OTHER | This value is reserved for future use. | | PROVIDE\_SELLER\_INFO | This value indicates that the seller's next action is to provide an RMA (Return Merchandise Authorization) number to the buyer through the **provideSellerInfo** call. | | SELLER\_MARK\_AS\_RECEIVED | This value indicates that the seller's next action is to mark the returned item as received through the **setItemAsReceived** call. | | SELLER\_PRINT\_SHIPPING\_LABEL | This value indicates that the seller's next action is to print a shipping label for the replacement item | | SELLER\_PROVIDE\_TRACKING\_INFO | This value indicates that the seller's next action is to upload a tracking number for the replacement item through the **provideTrackingInfo** call. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # MoneyMovementEntries - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) MoneyMovementEntries ==================== This type is used to provide details on any monetary transactions that occur in association with an INR inquiry or a case. Type that uses MoneyMovementEntries: [ClaimHistoryEventModel](https://developer.ebay.com/Devzone/post-order/types/ClaimHistoryEventModel.html) Calls that use MoneyMovementEntries: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Field ----- moneyMovementEntryList ( array of _[MoneyMovementEntry](https://developer.ebay.com/Devzone/post-order/types/MoneyMovementEntry.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This array contains details about one or more monetary transactions associated with an INR inquiry or a case. This array is only returned if monetary transactions have occurred with the INR inquiry or case. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#moneyMovementEntryList) to learn which calls use moneyMovementEntryList. --- # AppealGrantStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) AppealGrantStatusEnum ===================== This enumeration type contains the possible outcomes of a case decision that has been appealed by the buyer or seller. Type that uses AppealGrantStatusEnum: [AppealDetails](https://developer.ebay.com/Devzone/post-order/types/AppealDetails.html) Calls that use one or more values of AppealGrantStatusEnum: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | DENIED | This enumeration value indicates that the buyer's or seller's appeal was denied. | | GRANTED | This enumeration value indicates that the buyer's or seller's appeal was granted. | | OTHER | This enumeration value indicates that the outcome of the buyer's or seller's appeal is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # DecideReturnRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) DecideReturnRequest =================== The base request type of the **POST /post-order/v2/return/{returnId}/decide** method. Call that uses DecideReturnRequest: [/post-order/v2/return/{returnId}/decide POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_decide__post.html) Fields ------ [comments](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html#comments) ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [decision](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html#decision) ( _[DecisionEnum](https://developer.ebay.com/devzone/post-order/types/DecisionEnum.html) _ ) [keepOriginalItem](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html#keepOriginalItem) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [partialRefundAmount](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html#partialRefundAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [RMANumber](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html#RMANumber) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [rMAProvided](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html#rMAProvided) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container is used by the seller or buyer to provide more information about the action that is being performed with the **decide** method. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. decision ( _[DecisionEnum](https://developer.ebay.com/devzone/post-order/types/DecisionEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field must be included in each request, and the value that is supplied here will depend on whether the seller or the buyer is using this method, and it will also depend on the current state of the return request. The **POST /post-order/v2/return/{returnId}/decide** request will fail unless an appropriate value is specified in this field. Sellers can use this method to approve or decline a return request, offer a partial refund to the buyer, or provide a Return Merchandise Authorization (RMA) number to the buyer. Buyers can use this method to accept or decline a partial refund offer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#decision) to learn which calls use decision. keepOriginalItem ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The seller can include this field and set it to `true` if they are OK with the buyer keeping the original item they received, and not requiring them to return the item. A seller may choose to do this in the case of a SNAD item or if the buyer is claiming that the item arrived damaged or was missing parts. **Default:** `false` See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#keepOriginalItem) to learn which calls use keepOriginalItem. partialRefundAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container is conditionally required if the seller is using the **decide** method to offer a partial refund amount to the buyer in order to settle the return request. This amount is the amount the seller is willing to offer the buyer as a partial refund. This field has no relevance if anything other than `OFFER_PARTIAL_REFUND` is passed in the **decision** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#partialRefundAmount) to learn which calls use partialRefundAmount. RMANumber ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is conditionally required if the seller is using the **POST /post-order/v2/return/{returnId}/decide** method to provide a return merchandise authorization (RMA) to the buyer. The RMA value cannot be validated by eBay, so the seller should pay close attention to ensure that the RMA is accurate. If an RMA is provided in this field, the **decision** value should be `PROVIDE_RMA`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#RMANumber) to learn which calls use RMANumber. rMAProvided ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) If set to `true`, it indicates that the seller provided an RMA number to the buyer for processing of the return. **Default:** `false` See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#rMAProvided) to learn which calls use rMAProvided. --- # Issue Case Refund - eBay Post-Order API Reference eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) Issue Case Refund ================= POST /post-order/v2/casemanagement/{caseId}/issue\_refund --------------------------------------------------------- **Note:** This call has been deprecated and will be decommissioned on March 2, 2026. This method can be used on behalf of sellers to issue a full refund to the buyer to resolve an INR or Return case that was filed against the seller. The seller can voluntarily use this method before eBay customer support makes a decision on the case, or after, when and if eBay customer supports rules in favor of the buyer and forces the seller to issue a refund to the buyer.**Important!** Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including this method. Please refer to [Digital Signatures for APIs](https://developer.ebay.com/develop/guides/digital-signatures-for-apis) to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload. This method is not supported in the Sandbox environment. Input ----- See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Samples) . #### Resource URI (production) POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/issue\_refund #### URI parameters | Parameter | Type | Required? | Meaning | | --- | --- | --- | --- | | **caseId** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The unique identifier of a case. This URI parameter is required in order to identify the case for which a full refund will be issued to the buyer. The case ID value is passed in as part of the call URI. | #### HTTP request headers All requests made to eBay REST operations require you to provide the `authorization` HTTP header for authentication. See [HTTP request headers](https://developer.ebay.com/ebay-rest/content/rest-request-components.html#HTTP) for details. #### Authorization This call uses standard authorization tokens. See [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) for details. #### Payload model The following lists _all fields that could be included_ in the request. { /\* _[CaseVoluntaryRefundRequest](https://developer.ebay.com/Devzone/post-order/types/CaseVoluntaryRefundRequest.html) _ \*/ "[comments](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Request.comments) ": { /\* [Text](https://developer.ebay.com/Devzone/post-order/types/Text.html) \*/ "[content](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Request.comments.content) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[language](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Request.comments.language) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[translatedFromContent](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Request.comments.translatedFromContent) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[translatedFromLanguage](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Request.comments.translatedFromLanguage) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) } } #### Request field descriptions | Input Container/Field | Type | Occurrence | Meaning | | --- | --- | --- | --- | | **comments** | [Text](https://developer.ebay.com/Devzone/post-order/types/Text.html) | Optional | This container is used if the seller wants to add a note or explanation about the refund being issued. | | comments.**content** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This field displays the actual textual content in the language specified in the **language** field. This field is always used for containers using the **Text** type. | | comments.**language** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This two-letter code indicates the language used to display the content in the **content** field. The language will default to the language used on the eBay site if a specific language is not specified through the **Accept-Language** HTTP header. This field is always used for containers using the **Text** type.

The full list of language enumeration values are defined in the [LanguageEnum](https://developer.ebay.com/devzone/post-order/types/LanguageEnum.html)
type definition.

**Applicable values**: See [LanguageEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageEnum.html) | | comments.**translatedFromContent** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | If language translation/localization is required, this field displays the actual textual content in the language specified in the **translatedFromLanguage** field. If language translation was not required, this field is not applicable. | | comments
  .**translatedFromLanguage** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | If language translation/localization is required, this two-letter code indicates the language used to display the content in the **translatedFromContent** field. If language translation was not required, this field is not applicable.

The full list of language enumeration values are defined in the [LanguageEnum](https://developer.ebay.com/devzone/post-order/types/LanguageEnum.html)
type definition.

**Applicable values**: See [LanguageEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageEnum.html) | Output ------ See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Samples) . #### Payload model **Note:** For information about the error fields and how to work with them, see [Error Handling](https://developer.ebay.com/ebay-rest/content/handling-error-messages.html) . The following lists _all fields that could be included_ in the response. { /\* _[VoluntaryRefundResponse](https://developer.ebay.com/Devzone/post-order/types/VoluntaryRefundResponse.html) _ \*/ "[refundResult](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Response.refundResult) ": { /\* [VoluntaryRefundResult](https://developer.ebay.com/Devzone/post-order/types/VoluntaryRefundResult.html) \*/ "[refundSource](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Response.refundResult.refundSource) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[refundStatus](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_issue_refund__post.html#Response.refundResult.refundStatus) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) } } #### Response field descriptions | Output Container/Field | Type | Occurrence | Meaning | | --- | --- | --- | --- | | **refundResult** | [VoluntaryRefundResult](https://developer.ebay.com/Devzone/post-order/types/VoluntaryRefundResult.html) | Always | This container shows the result of the refund action and the source being used for the buyer refund. | | refundResult.**refundSource** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Always | This enumeration value indicates the payment source used to refund the buyer to resolve an inquiry or case.

**Applicable values are from [RefundPaymentTypeEnum](https://developer.ebay.com/Devzone/post-order/types/RefundPaymentTypeEnum.html)
**:


ECHECK

This enumeration value indicates that a refund to the buyer was supplemented by available seller payout funds, and one or more other funding sources such as the seller's bank account.

INSTANT\_REFUND

This enumeration value indicates that an instant refund was issued to the buyer.

INTERMEDIATED\_REFUND

This enumeration value indicates that a refund is being intermediated by eBay.

OTHER

This enumeration value indicates that the refund payment source cannot be determined.

PAYOUT

This enumeration value indicates that the buyer refund was taken from available funds from the seller payout.


Code so that your app gracefully handles any future changes to this list. | | refundResult.**refundStatus** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Always | This enumeration value indicates the success or failure of a full refund being issued by the seller through an **issue\_refund** method.

**Applicable values are from [RefundStatusEnum](https://developer.ebay.com/Devzone/post-order/types/RefundStatusEnum.html)
**:


FAILED

This enumeration value indicates that the refund to the buyer failed.

OTHER

This enumeration value indicates that the refund status cannot be determined by eBay.

PENDING

This enumeration value indicates that the buyer refund is in the pending state.

SUCCESS

This enumeration value indicates that the refund to the buyer was successful.


Code so that your app gracefully handles any future changes to this list. | null Samples ------- New to making API calls? Please see [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) . 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. Sample: Issue a Refund This operation issues a refund to the buyer. **Description** You can use this operation on behalf of the seller to issue a refund for an order line item after the buyer has filed an INR or Return case against the seller. **Input** The **caseId** path parameter identifies the INR or Return case asociated with the order line item being refunded. This call includes an optional comment from the seller to the buyer. **URL format**. See also the [non-wrapped](https://developer.ebay.com/Devzone/post-order/Samples/post-order_v2_casemanagement-caseid_issue_refund__post_basic_in_url_json.txt) version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/5\*\*\*\*\*\*\*\*7/issue\_refund { "comments": { "content": "Your refund is on its way." } } **Output** The reponse payload indicates that an instant refund was successfully issued to the buyer from the seller's PayPal account. **JSON format**. { "refundResult": { "refundSource": "INSTANT\_REFUND", "refundStatus": "SUCCESS" } } Change History -------------- | Change Date | Description | | --- | --- | --- # ErrorSeverity - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ErrorSeverity ( [token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) ) ===================================================================================================================== Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. Type that uses ErrorSeverity: [ErrorData](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html) Calls that use one or more values of ErrorSeverity: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ItemizedRefundDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ItemizedRefundDetailType ======================== This type is used by the **itemizedRefundDetail** container to provide details about a refund that was issued, or is in the process of being issued to the buyer. An **itemizedRefundDetail** container is required for each different refund type, such as purchase price and original shipping. Type that uses ItemizedRefundDetailType: [RefundDetailType](https://developer.ebay.com/devzone/post-order/types/RefundDetailType.html) Calls that use ItemizedRefundDetailType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/issue\_refund POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_issue_refund__post.html) Fields ------ refundAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount of the refund for the particular refund type (specified in the **refundFeeType** field). When issuing a refund through the **POST /post-order/v2/return/{returnId}/issue\_refund** method, or if marking a refund as sent with the **POST /post-order/v2/return/{returnId}/mark\_refund\_sent** method, the seller must use a separate **itemizedRefundDetail** container for each refund type, such as one for the purchase price, and one for original shipping. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundAmount) to learn which calls use refundAmount. refundFeeType ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the type of refund. When issuing a refund through the **POST /post-order/v2/return/{returnId}/issue\_refund** method, or if marking a refund as sent with the **POST /post-order/v2/return/{returnId}/mark\_refund\_sent** method, the seller must use a separate **itemizedRefundDetail** container for each refund type, such as one for the purchase price, and one for original shipping. The supported enumeration values representing refund fee types are defined in the [RefundFeeTypeEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/RefundFeeTypeEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundFeeType) to learn which calls use refundFeeType. restockingFeePercentage ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) **THIS FIELD IS DEPRECATED. DO NOT USE.** See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#restockingFeePercentage) to learn which calls use restockingFeePercentage. --- # ReturnUserRoleType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ReturnUserRoleType ( [string](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#string) ) ============================================================================================================================ Enumerated type that defines the user roles in a return. Type that uses ReturnUserRoleType: [ReturnUserType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnUserType.html) Calls that use one or more values of ReturnUserRoleType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) , [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This value indicates that the user's role in the return is buyer. | | EBAY | This value indicates that the user's role in the return is eBay. | | OTHER | This value is reserved for future use. | | SELLER | This value indicates that the user's role in the return is seller. | | SYSTEM | This value indicates that the user's role in the return is system. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ShipmentStatusType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ShipmentStatusType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ========================================================================================================================== Enumerated type that defines all possible shipment states relating to the buyer returning an item to the seller. The status of a buyer's return shipment is shown in the **ReturnDetail.buyerReturnShipment.shipmentStatus** field of the **getReturnDetail** response. Type that uses ShipmentStatusType: [ShipmentType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ShipmentType.html) Call that uses one or more values of ShipmentStatusType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ITEM\_DELIVERED | This value indicates that the returned item has been received by the seller. | | ITEM\_SHIPPED | This value indicates that the item has been shipped by the buyer. | | OTHER | This value is reserved for future use. | | READY\_FOR\_SHIPPING | This value indicates that the item is ready to be return shipped by the buyer. | | WAITING\_FOR\_SELLER\_INFO | This value indicates that the buyer is waiting for an Return Merchandise Authorization (RMA) number and/or an alternative return shipping address before returning the item to the seller. A seller can provide a buyer with this information by using the **provideSellerInfo** call. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # UserFilterRoleType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) UserFilterRoleType ( [string](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#string) ) ============================================================================================================================ Enumerated type that contains the valid values to use in the **otherUserFilter.role** field if a user filter is used in a **getUserReturns** request. Type that uses UserFilterRoleType: [UserFilterType](https://developer.ebay.com/Devzone/return-management/CallRef/types/UserFilterType.html) Call that uses one or more values of UserFilterRoleType: [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This value is specified in the **otherUserFilter.role** field to retrieve returns where the other user's role is buyer. | | BUYERORSELLER | This value is specified in the **otherUserFilter.role** field to retrieve returns where the other user's role is buyer or seller. | | SELLER | This value is specified in the **otherUserFilter.role** field to retrieve returns where the other user's role is seller. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ProfileType - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ProfileType ( [string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) ) ===================================================================================================================== Enumerated type that defines the business policy types. Types that use ProfileType: [GetSellerProfilesRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/GetSellerProfilesRequest.html) , [PaymentProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfile.html) , [ReturnPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfile.html) , [ShippingPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfile.html) Calls that use one or more values of ProfileType: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER\_REQUIREMENTS | This value is for future use. | | PAYMENT | This value indicates the business policy is a payment policy. | | RETURN\_POLICY | This value indicates the business policy is a return policy. | | SHIPPING | This value indicates the business policy is a shipping policy. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # RefundAmounts - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RefundAmounts ============= This type provided details related to the expected and actual buyer refund amounts associated with an INR inquiry or case. Types that use RefundAmounts: [CaseDetails](https://developer.ebay.com/Devzone/post-order/types/CaseDetails.html) , [InquiryDetails](https://developer.ebay.com/Devzone/post-order/types/InquiryDetails.html) Calls that use RefundAmounts: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [buyerFinalAcceptRefundAmt](https://developer.ebay.com/Devzone/post-order/types/RefundAmounts.html#buyerFinalAcceptRefundAmt) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [buyerInitExpectRefundAmt](https://developer.ebay.com/Devzone/post-order/types/RefundAmounts.html#buyerInitExpectRefundAmt) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [donationAmount](https://developer.ebay.com/Devzone/post-order/types/RefundAmounts.html#donationAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [feeCreditAmount](https://developer.ebay.com/Devzone/post-order/types/RefundAmounts.html#feeCreditAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [internationalRefundAmount](https://developer.ebay.com/Devzone/post-order/types/RefundAmounts.html#internationalRefundAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [refundAmount](https://developer.ebay.com/Devzone/post-order/types/RefundAmounts.html#refundAmount) ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) buyerFinalAcceptRefundAmt ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the refund amount finally accepted by the buyer. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#buyerFinalAcceptRefundAmt) to learn which calls use buyerFinalAcceptRefundAmt. buyerInitExpectRefundAmt ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the refund amount initially expected by the buyer. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#buyerInitExpectRefundAmt) to learn which calls use buyerInitExpectRefundAmt. donationAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container defines the refund amount for listings that included a charitable donation. This data includes the amount of the charitable donation refunded, as well as currency conversion information when necessary including the current currency code, the value in the original currency, and the original currency's code. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#donationAmount) to learn which calls use donationAmount. feeCreditAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount of fees credited towards this refund as per eBay policy. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#feeCreditAmount) to learn which calls use feeCreditAmount. internationalRefundAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the refund amount issued to the buyer for the international leg of a Global Shipping Program shipment. This container only applies for international orders where the seller used the Global Shipping Program to ship the order. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#internationalRefundAmount) to learn which calls use internationalRefundAmount. refundAmount ( _[Amount](https://developer.ebay.com/Devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the refund amount issued to the buyer. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#refundAmount) to learn which calls use refundAmount. --- # ReturnAddress - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnAddress ============= This type provides the seller's return address and the Return Merchandise Authorization (RMA) number associated with the item (if applicable). Types that use ReturnAddress: [CaseDetailsResponse](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html) , [InquiryDetailsResponse](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html) Calls that use ReturnAddress: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [address](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html#address) ( _[Address](https://developer.ebay.com/devzone/post-order/types/Address.html) _ ) [editable](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html#editable) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [firstName](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html#firstName) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [lastName](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html#lastName) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [RMA](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html#RMA) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) address ( _[Address](https://developer.ebay.com/devzone/post-order/types/Address.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the full return address of the seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#address) to learn which calls use address. editable ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This boolean field indicates whether or not the seller's return address (shown in the **address** container) can be modified. A value of `true` indicates that the return address can be modified, and a value of `false` indicates that the return address cannot be modified. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#editable) to learn which calls use editable. firstName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The first name associated with the return address, or if applicable, a business or store name. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#firstName) to learn which calls use firstName. lastName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The last name associated with the return address. This field will only be returned if applicable. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastName) to learn which calls use lastName. RMA ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The Return Merchandise Authorization (RMA) identifier authorizing this return. This field is only returned if an RMA number exists for the order line item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#RMA) to learn which calls use RMA. --- # CreateInquiryRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CreateInquiryRequest ==================== The base request type of the **POST /post-order/v2/inquiry** method, which is used to create an Item Not Received (INR) inquiry on behalf of the buyer. Call that uses CreateInquiryRequest: [/post-order/v2/inquiry POST](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry__post.html) Fields ------ [claimQuantity](https://developer.ebay.com/devzone/post-order/types/CreateInquiryRequest.html#claimQuantity) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [comments](https://developer.ebay.com/devzone/post-order/types/CreateInquiryRequest.html#comments) ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [desiredOutcome](https://developer.ebay.com/devzone/post-order/types/CreateInquiryRequest.html#desiredOutcome) ( _[DesiredOutcomeTypeEnum](https://developer.ebay.com/devzone/post-order/types/DesiredOutcomeTypeEnum.html) _ ) [itemId](https://developer.ebay.com/devzone/post-order/types/CreateInquiryRequest.html#itemId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [transactionId](https://developer.ebay.com/devzone/post-order/types/CreateInquiryRequest.html#transactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) claimQuantity ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This integer is the quantity of the line item purchased by the buyer. This value will usually be `1` unless the buyer purchased multiple quantity of a line item in a multiple-quantity, fixed-priced listing. If this field is omitted, its value defaults to `1`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#claimQuantity) to learn which calls use claimQuantity. comments ( _[Text](https://developer.ebay.com/devzone/post-order/types/Text.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container can be used if the buyer wants to provide more information about initiating the INR inquiry. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#comments) to learn which calls use comments. desiredOutcome ( _[DesiredOutcomeTypeEnum](https://developer.ebay.com/devzone/post-order/types/DesiredOutcomeTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is used to indicate whether the buyer still wants the item (`STILL_WANT_ITEM` is passed in), or whether the buyer is now looking to receive a full refund (`FULL_REFUND` is passed in) for the line item even if it received by the buyer. If this field is omitted, the **desiredOutcome** value defaults to `STILL_WANT_ITEM`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#desiredOutcome) to learn which calls use desiredOutcome. itemId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the eBay listing where the line item was purchased. This field and the **transactionId** field are required in order to identify the line item for which an INR inquiry will be created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemId) to learn which calls use itemId. transactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field and the **itemId** field are required in order to identify the line item for which an INR inquiry will be created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionId) to learn which calls use transactionId. --- # GetProductSearchDataVersionResponse - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product-metadata/ReleaseNotes.html) GetProductSearchDataVersionResponse ( [BaseServiceResponse](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/BaseServiceResponse.html) ) ========================================================================================================================================================== Response container for getCompatibilitySearchDataVersion and getProductSearchDataVersion calls. Call that uses GetProductSearchDataVersionResponse: [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) Fields ------ namesDetails ( _[VersionDetails](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/VersionDetails.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Time and version for the most recent update of catalog property names for the specified category. See the [Field Index](https://developer.ebay.com/Devzone/product-metadata/CallRef/fieldindex.html#namesDetails) to learn which calls use namesDetails. valueDetails ( _[VersionDetails](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/VersionDetails.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Time and version for the most recent update of catalog property values for the specified category. See the [Field Index](https://developer.ebay.com/Devzone/product-metadata/CallRef/fieldindex.html#valueDetails) to learn which calls use valueDetails. --- # ErrorCategory - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ErrorCategory ( [token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) ) ===================================================================================================================== Returned errors are categorized as either Application, Request, or System errors. Request and application errors are often caused by passing invalid data in the call request. System errors are primarily caused by application failures and cannot be corrected by changing request values. Type that uses ErrorCategory: [ErrorData](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html) Calls that use one or more values of ErrorCategory: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ProductDetailsRequestType - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ProductDetailsRequestType ========================= Container for request data for retrieving product details. Type that uses ProductDetailsRequestType: [GetProductDetailsRequest](https://developer.ebay.com/devzone/product/CallRef/types/GetProductDetailsRequest.html) Call that uses ProductDetailsRequestType: [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ dataset ( _[token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) This will define what are properties that will be returned for this catelog-enabled category. **Dataset values:** DisplayableProductDetails Properies for use in a user interface to describe products. DisplayableSearchResults Properties for use in results for product searches. Searchable Properties for use in searches. Sortable Properties that are suitable for sorting. User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#dataset) to learn which calls use dataset. datasetPropertyName ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#datasetPropertyName) to learn which calls use datasetPropertyName. productIdentifier ( _[ProductIdentifier](https://developer.ebay.com/devzone/product/CallRef/types/ProductIdentifier.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The product identifier type and value. Product identifiers, such as ePID values or ISBN values, are unique across all sites. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productIdentifier) to learn which calls use productIdentifier. productStatusFilter ( _[ProductStatus](https://developer.ebay.com/devzone/product/CallRef/types/ProductStatus.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productStatusFilter) to learn which calls use productStatusFilter. --- # RefundFeeType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) RefundFeeType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ===================================================================================================================== Enumerated type that defines the types of itemized refunds. Type that uses RefundFeeType: [ItemizedRefundDetailType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ItemizedRefundDetailType.html) Calls that use one or more values of RefundFeeType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) , [issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ORIGINAL\_SHIPPING | This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases). | | OTHER | This value is reserved for future use. | | PURCHASE\_PRICE | This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases). | | RESTOCKING\_FEE | This is the only **RefundFeeType** value that will be a negative dollar value, as a restocking fee is a charge against the buyer for returning the item. In order to enforce a restocking fee on an item, the seller must include a restocking fee value as part of the listing's return policy. In the listing APIs, this field is **Item.ReturnPolicy.RestockingFeeValue**. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) ReturnType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ================================================================================================================== Enumerated type that defines the return types that are possible. Through the Return Center, the buyer selects whether he/she wants to be refunded for the purchase or wants a replacement item. Type that uses ReturnType: [ReturnSummaryType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ReturnSummaryType.html) Calls that use one or more values of ReturnType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) , [getUserReturns](https://developer.ebay.com/Devzone/return-management/CallRef/getUserReturns.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | MONEY\_BACK | This value indicates that the buyer is returning/has returned the item for a refund. | | REPLACEMENT | This value indicates that the buyer is requesting/has received a replacement item for the original item. | | UNKNOWN | This value is only returned if client/user is running a version of the Return Management API that is out-of-date, and does not contain the latest values of **ReturnType**. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # CaseDetailsResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CaseDetailsResponse =================== The base response type for the **GET /post-order/v2/casemanagement/{caseId}** method. This type contains detailed information about an INR or Return case. Call that uses CaseDetailsResponse: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) Fields ------ [actionDeadlines](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#actionDeadlines) ( _[ActionDeadlines](https://developer.ebay.com/devzone/post-order/types/ActionDeadlines.html) _ ) [appealDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#appealDetails) ( _[AppealDetails](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html) _ ) [buyerClosureReason](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#buyerClosureReason) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [buyerProtectedProgramLink](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#buyerProtectedProgramLink) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [caseContentOnHold](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#caseContentOnHold) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [caseDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#caseDetails) ( _[CaseDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html) _ ) [caseHistoryDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#caseHistoryDetails) ( _[ClaimHistoryResponse](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryResponse.html) _ ) [caseId](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#caseId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [caseQuantity](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#caseQuantity) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [caseType](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#caseType) ( _[CaseTypeEnum](https://developer.ebay.com/devzone/post-order/types/CaseTypeEnum.html) _ ) [claimAmount](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#claimAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [escalatedBy](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#escalatedBy) ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [escalateReason](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#escalateReason) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eventTicketsLink](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#eventTicketsLink) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [extTransactionId](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#extTransactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [fsnadDaysToAddTrackingAfterShippingItem](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#fsnadDaysToAddTrackingAfterShippingItem) ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [fsnadShipToSellerByDate](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#fsnadShipToSellerByDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [initiator](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#initiator) ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [itemId](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#itemId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [itemOnHold](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#itemOnHold) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [lastModifiedDate](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#lastModifiedDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [payForItemLink](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#payForItemLink) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [priceSignatureConfirmationAmount](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#priceSignatureConfirmationAmount) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [recalledItemLink](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#recalledItemLink) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [returnDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#returnDetails) ( _[ReturnAddress](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html) _ ) [returnId](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#returnId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [sellerClosureReason](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#sellerClosureReason) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [shippingFee](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#shippingFee) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [status](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#status) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [transactionId](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html#transactionId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) actionDeadlines ( _[ActionDeadlines](https://developer.ebay.com/devzone/post-order/types/ActionDeadlines.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides the number of remaining days that a buyer or seller has before being required to take action on an INR or Return case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actionDeadlines) to learn which calls use actionDeadlines. appealDetails ( _[AppealDetails](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of information related to the appeal of a case decision. This container is only returned if the case decision was appealed by the buyer or seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealDetails) to learn which calls use appealDetails. buyerClosureReason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates why the buyer chose to close the case. This field is only returned if the buyer closed the case, or if the case was closed on behalf of the buyer. The list of enumeration values that may be returned in this field are defined in the [CaseCloseReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CaseCloseReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerClosureReason) to learn which calls use buyerClosureReason. buyerProtectedProgramLink ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the URL for the eBay Resolution Center. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#buyerProtectedProgramLink) to learn which calls use buyerProtectedProgramLink. caseContentOnHold ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field indicates the item content related to the case is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding case content is on hold due to eBay policy violation; false otherwise. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseContentOnHold) to learn which calls use caseContentOnHold. caseDetails ( _[CaseDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides detailed information about the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseDetails) to learn which calls use caseDetails. caseHistoryDetails ( _[ClaimHistoryResponse](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryResponse.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides detailed information about the history of the case, including each action that has been performed on the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseHistoryDetails) to learn which calls use caseHistoryDetails. caseId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of an INR or Return case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseId) to learn which calls use caseId. caseQuantity ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the quantity of the line item purchased by the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseQuantity) to learn which calls use caseQuantity. caseType ( _[CaseTypeEnum](https://developer.ebay.com/devzone/post-order/types/CaseTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration type indicates if the case involves an item that has not been received by the buyer within the expected delivery window, or if the case involves a return request that has been escalated into a case by the buyer or seller after they were unable to come up with a return solution that would work for both parties. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#caseType) to learn which calls use caseType. claimAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container displays the dollar value of the case, which is generally the amount of the refund that the buyer will receive if the buyer wins the case, or if the seller voluntarily refunds the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#claimAmount) to learn which calls use claimAmount. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the case was created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. escalatedBy ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the party that escalated the INR inquiry or return request into a case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalatedBy) to learn which calls use escalatedBy. escalateReason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) Indicates why the buyer or seller escalated an INR inquiry or a return request into a case. For an INR inquiry that was escalated, the applicable values are defined in the [InquiryEscalationReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/InquiryEscalationReasonEnum.html) type definition. type. For a return request that was escalated, the applicable values are defined in the [EscalateReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/EscalateReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalateReason) to learn which calls use escalateReason. eventTicketsLink ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the URL for the event tickets page, where electronic event tickets can be downloaded by the purchaser. This field is only returned if the case involves an event tickets order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eventTicketsLink) to learn which calls use eventTicketsLink. extTransactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the unique identifier of the payment transaction for the order. This field will only be returned if the payment transaction happened outside of eBay's system. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#extTransactionId) to learn which calls use extTransactionId. fsnadDaysToAddTrackingAfterShippingItem ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the number of days that the buyer has to provide shipment tracking information for an item that is being returned to the seller. This field is only returned for Return cases, and only if the buyer is being required to provide shipment tracking information for the item being returned. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fsnadDaysToAddTrackingAfterShippingItem) to learn which calls use fsnadDaysToAddTrackingAfterShippingItem. fsnadShipToSellerByDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the deadline when the buyer must ship the return item back to the seller. This container is only returned for Return cases, and only if the buyer has yet to ship the return item, or has not provided proof that the item has been shipped. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fsnadShipToSellerByDate) to learn which calls use fsnadShipToSellerByDate. initiator ( _[UserPartyEnum](https://developer.ebay.com/devzone/post-order/types/UserPartyEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates whether the buyer or the seller initiated the INR inquiry or Return request that has been escalated to a case. This value will usually be `BUYER`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#initiator) to learn which calls use initiator. itemId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the **transactionId** field to identify a line item that is associated with the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemId) to learn which calls use itemId. itemOnHold ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field indicates the item related to the case is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding item is on hold due to eBay policy violation; false otherwise. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#itemOnHold) to learn which calls use itemOnHold. lastModifiedDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the last action was performed on the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#lastModifiedDate) to learn which calls use lastModifiedDate. payForItemLink ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the URL for the purchase item page. This field will be returned if available/applicable. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#payForItemLink) to learn which calls use payForItemLink. priceSignatureConfirmationAmount ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value indicates the dollar value threshold for the signature confirmation add-on. The buyer must purchase the signature confirmation add-on for high-value items at or above this dollar value. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#priceSignatureConfirmationAmount) to learn which calls use priceSignatureConfirmationAmount. recalledItemLink ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string is the URL for the recalled item page. This field will be returned if available/applicable. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#recalledItemLink) to learn which calls use recalledItemLink. returnDetails ( _[ReturnAddress](https://developer.ebay.com/devzone/post-order/types/ReturnAddress.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of information related to a buyer returning a line item to the seller, and includes the seller's return address and the RMA number (if applicable). This container is only returned if the case type is a Return. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnDetails) to learn which calls use returnDetails. returnId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of a return. This field is only returned if the case type is a Return. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnId) to learn which calls use returnId. sellerClosureReason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates why the seller chose to close the case. This field is only returned if the seller closed the case, or if the case was closed on behalf of the seller. The list of enumeration values that may be returned in this field are defined in the [CaseCloseReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CaseCloseReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerClosureReason) to learn which calls use sellerClosureReason. shippingFee ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container displays the expected return shipping fees. Depending on the case type and the details of the case type, the return shipping fees may be paid by the buyer or the seller. amount that the buyer This container is only returned if the case is expected to involve the buyer returning the item to the seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#shippingFee) to learn which calls use shippingFee. status ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the case. The list of enumeration values that may be returned in this field are defined in the [CaseStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CaseStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#status) to learn which calls use status. transactionId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique identifier of the purchase transaction. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the **itemId** field to identify the line item that is associated with the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#transactionId) to learn which calls use transactionId. --- # GetCancelDetailResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) GetCancelDetailResponse ======================= This type defines the response payload for the **GET /post-order/v2/cancellation/{cancelId}** method. This method returns the details of the cancellation request specified by the _cancelId_ path parameter of the request. Call that uses GetCancelDetailResponse: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Field ----- cancelDetail ( _[CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) Contains information about a cancelled order. If the value of the **fieldgroups** query parameter is set to `FULL`, the response also contains a record of all activity performed on the cancellation request plus the identifiers for each line item in the order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#cancelDetail) to learn which calls use cancelDetail. --- # eBay Site ID to Global ID Mapping - Product API Product API * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) eBay Site ID to Global ID Mapping ================================= Each eBay site maps to a unique [eBay global ID](https://developer.ebay.com/devzone/product/CallRef/Enums/GlobalIdList.html) . You must specify a global ID in the `X-EBAY-SOA-GLOBAL-ID` HTTP header for each API call. The global ID you use must correspond to one of the eBay site IDs in the following table: | eBay Site ID | Site Name | Global ID | | --- | --- | --- | | 0 | eBay United States | EBAY-US | | 2 | eBay Canada (English) | EBAY-ENCA | | 3 | eBay UK | EBAY-GB | | 15 | eBay Australia | EBAY-AU | | 16 | eBay Austria | EBAY-AT | | 23 | eBay Belgium (French) | EBAY-FRBE | | 71 | eBay France | EBAY-FR | | 77 | eBay Germany | EBAY-DE | | 100 | eBay Motors | EBAY-MOTOR | | 101 | eBay Italy | EBAY-IT | | 123 | eBay Belgium (Dutch) | EBAY-NLBE | | 146 | eBay Netherlands | EBAY-NL | | 186 | eBay Spain | EBAY-ES | | 193 | eBay Switzerland | EBAY-CH | | 201 | eBay Hong Kong | EBAY-HK | | 203 | eBay India | EBAY-IN | | 205 | eBay Ireland | EBAY-IE | | 207 | eBay Malaysia | EBAY-MY | | 210 | eBay Canada (French) | EBAY-FRCA | | 211 | eBay Philippines | EBAY-PH | | 212 | eBay Poland | EBAY-PL | | 216 | eBay Singapore | EBAY-SG | --- # FindProductsRequest - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product/ReleaseNotes.html) FindProductsRequest ( [BaseServiceRequest](https://developer.ebay.com/Devzone/product/CallRef/types/BaseServiceRequest.html) ) =============================================================================================================================== This is a request object containing input for the find product operation Call that uses FindProductsRequest: [findProducts](https://developer.ebay.com/Devzone/product/CallRef/findProducts.html) Field ----- productSearch ( _[ProductRequest](https://developer.ebay.com/Devzone/product/CallRef/types/ProductRequest.html) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/product/CallRef/types/simpletypes.html#multiplicity) User can findproducts for one catalog at a time or batch up to 10 catalogs. See the [Field Index](https://developer.ebay.com/Devzone/product/CallRef/fieldindex.html#productSearch) to learn which calls use productSearch. --- # BaseServiceResponse - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product-metadata/ReleaseNotes.html) BaseServiceResponse =================== Base response container for all service operations. Contains error information associated with the request. Calls that use BaseServiceResponse: [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ ack ( _[AckValue](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/AckValue.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Indicates whether or not errors or warnings were generated during the processing of the request. See the [Field Index](https://developer.ebay.com/Devzone/product-metadata/CallRef/fieldindex.html#ack) to learn which calls use ack. errorMessage ( _[ErrorMessage](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/ErrorMessage.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. See the [Field Index](https://developer.ebay.com/Devzone/product-metadata/CallRef/fieldindex.html#errorMessage) to learn which calls use errorMessage. timestamp ( _[dateTime](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#dateTime) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. See the [Field Index](https://developer.ebay.com/Devzone/product-metadata/CallRef/fieldindex.html#timestamp) to learn which calls use timestamp. version ( _[string](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. **Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. See the [Field Index](https://developer.ebay.com/Devzone/product-metadata/CallRef/fieldindex.html#version) to learn which calls use version. --- # ClaimHistoryResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ClaimHistoryResponse ==================== This type is used to provide the history of events associated with an INR inquiry or a case. Types that use ClaimHistoryResponse: [CaseDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/CaseDetailsResponse.html) , [InquiryDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/InquiryDetailsResponse.html) Calls that use ClaimHistoryResponse: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ history ( array of _[ClaimHistoryEventModel](https://developer.ebay.com/Devzone/post-order/types/ClaimHistoryEventModel.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This array contains one or more events or actions associated with an INR inquiry or a case. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#history) to learn which calls use history. shipmentTrackingDetails ( _[ShipmentTrackingDetailType](https://developer.ebay.com/Devzone/post-order/types/ShipmentTrackingDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container will show detailed shipment tracking information if an INR item is being shipped to the buyer, or if the buyer is returning an item to the seller. This container is only returned if shipment tracking is currently relevant to the inquiry or case. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#shipmentTrackingDetails) to learn which calls use shipmentTrackingDetails. --- # PartyEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) PartyEnum ========= This enumeration type lists the eBay user types that can create or perform an action against an order cancellation request. Types that use PartyEnum: [CancelActivityHistory](https://developer.ebay.com/Devzone/post-order/types/CancelActivityHistory.html) , [CancelDetail](https://developer.ebay.com/Devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/Devzone/post-order/types/CancelSummary.html) Calls that use one or more values of PartyEnum: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This enumeration value is returned if the buyer created or performed an action on an order cancellation request. | | SELLER | This enumeration value is returned if the seller created or performed an action on an order cancellation request. | | UNKNOWN | This enumeration value is returned if eBay cannot determine which eBay party created or performed an action on an order cancellation request. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ReturnAddressType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnAddressType ================= This type is used to provide the address where a return item will be shipped. Types that use ReturnAddressType: [ResponseHistoryAttributesType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html) , [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) , [ShipmentTrackingType](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingType.html) Calls that use ReturnAddressType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ address ( _[Address](https://developer.ebay.com/devzone/post-order/types/Address.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container holds the address where a return item will be shipped. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#address) to learn which calls use address. name ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The name/business name associated with the address See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#name) to learn which calls use name. --- # CancelActivityHistory - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CancelActivityHistory ===================== This type is used to provide activity history on the order cancellation request returned in a **GET /post-order/v2/cancellation/{cancelId}** response. The activity history of an order cancellation request will be returned unless the **fieldgroups** query parameter is used and set to `SUMMARY` **activityHistories**. Type that uses CancelActivityHistory: [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) Call that uses CancelActivityHistory: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Fields ------ [actionDate](https://developer.ebay.com/devzone/post-order/types/CancelActivityHistory.html#actionDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [activityParty](https://developer.ebay.com/devzone/post-order/types/CancelActivityHistory.html#activityParty) ( _[PartyEnum](https://developer.ebay.com/devzone/post-order/types/PartyEnum.html) _ ) [activityType](https://developer.ebay.com/devzone/post-order/types/CancelActivityHistory.html#activityType) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [stateFrom](https://developer.ebay.com/devzone/post-order/types/CancelActivityHistory.html#stateFrom) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [stateTo](https://developer.ebay.com/devzone/post-order/types/CancelActivityHistory.html#stateTo) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) actionDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container provides the date and time when the order cancellation request activity occurred. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actionDate) to learn which calls use actionDate. activityParty ( _[PartyEnum](https://developer.ebay.com/devzone/post-order/types/PartyEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the party (buyer or seller) who performed the action on the order cancellation request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#activityParty) to learn which calls use activityParty. activityType ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the type of event or action that occurred with the order cancellation request. The list of enumeration values that may be returned in this field are defined in the [CancelActivityTypeEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CancelActivityTypeEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#activityType) to learn which calls use activityType. stateFrom ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the state of the order cancellation request prior to the performed action (defined in the **activityType** field). The list of enumeration values that may be returned in this field are defined in the [CancelStateEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CancelStateEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#stateFrom) to learn which calls use stateFrom. stateTo ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates state of the order cancellation request following the performed action (defined in the **activityType** field). Depending on the type of activity, the state of the order cancellation process might not change, so it is possible that the **stateTo** value may be the same as the **stateFrom** value. The list of enumeration values that may be returned in this field are defined in the [CancelStateEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CancelStateEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#stateTo) to learn which calls use stateTo. --- # ReturnHoldStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnHoldStatusEnum ==================== This enumerated type lists the possible states of a return request that has been put on hold. Type that uses ReturnHoldStatusEnum: [ReturnHoldInfoType](https://developer.ebay.com/Devzone/post-order/types/ReturnHoldInfoType.html) Calls that use one or more values of ReturnHoldStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | HOLD\_CREATION\_SUCCESS | This enumeration value indicates that the hold placed on the return request was created successfully. | | HOLD\_RELEASE\_FAILED | This enumeration value indicates that the attempt to release the hold on the return request failed. | | HOLD\_RELEASE\_SUCCESS | This enumeration value indicates that the hold on the return request was released successfully. | | INELIGIBLE\_TO\_RELEASE\_HOLD | This enumeration value indicates that the hold on the return request is not yet eligible to be released. | | OTHER | This enumeration value indicates that the status of the hold on the return request is not classified or is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # TrackingStatusEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) TrackingStatusEnum ================== This enumerated type lists the values that indicate whether the return item was delivered or still in-transit. Type that uses TrackingStatusEnum: [ShipmentTrackingType](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingType.html) Calls that use one or more values of TrackingStatusEnum: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | CANCELLED | This enumeration value indicates that the current shipment tracking information has been cancelled. | | CREATED | This enumeration value indicates that shipment tracking has been initiated. | | DELIVERED | This enumeration value indicates that the item was delivered according to the shipment tracking history. | | IN\_TRANSIT | This enumeration value indicates that the item is in-transit to the recipient according to the shipment tracking history. | | UNKNOWN | This enumeration value indicates that shipment tracking status of the item is unknown. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # RefundInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RefundInfoType ============== This type is used by the **refundInfo** container, which provides detailed information on the estimated and actual refund amounts. Type that uses RefundInfoType: [ReturnDetailType](https://developer.ebay.com/Devzone/post-order/types/ReturnDetailType.html) Calls that use RefundInfoType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ actualRefundDetail ( _[ActualRefundDetailType](https://developer.ebay.com/Devzone/post-order/types/ActualRefundDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows the itemized refund information after the seller issues a refund to the buyer. This container is only returned if the seller has issued a refund to the buyer. Until the refund is actually successfully processed, only information on the estimated refund may be seen in the **estimatedRefundDetail** container. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#actualRefundDetail) to learn which calls use actualRefundDetail. estimatedRefundDetail ( _[EstimatedRefundDetailType](https://developer.ebay.com/Devzone/post-order/types/EstimatedRefundDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container shows estimated refund information for the buyer. There will be one **itemizedRefundDetail** container returned under this container for each refund fee type (such as purchase price and original shipping). See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#estimatedRefundDetail) to learn which calls use estimatedRefundDetail. --- # ReturnUserRoleEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnUserRoleEnum ================== This enumerated type lists all possible roles for parties involved in a return request, such as buyer, seller, and eBay. Types that use ReturnUserRoleEnum: [ReturnFileType](https://developer.ebay.com/Devzone/post-order/types/ReturnFileType.html) , [ReturnResponseHistoryType](https://developer.ebay.com/Devzone/post-order/types/ReturnResponseHistoryType.html) , [ShipmentTrackingType](https://developer.ebay.com/Devzone/post-order/types/ShipmentTrackingType.html) , [ShipmentType](https://developer.ebay.com/Devzone/post-order/types/ShipmentType.html) Calls that use one or more values of ReturnUserRoleEnum: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid_files__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This enumeration value indicates that the buyer performed the action on the return request. | | EBAY | This enumeration value indicates that eBay customer support performed the action on the return request. | | OTHER | This enumeration value indicates that it is unknown who/what performed the action on the return request. | | SELLER | This enumeration value indicates that the seller performed the action on the return request. | | SYSTEM | This enumeration value indicates that the action on the return request was an automated action initiated by eBay's system. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # InquirySearchResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) InquirySearchResponse ===================== The base response type of the **GET /post-order/v2/inquiry/search** method, which is used to retrieve INR inquiries based on filter criteria in the request. Call that uses InquirySearchResponse: [/post-order/v2/inquiry/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry_search__get.html) Fields ------ members ( array of _[InquirySummaryType](https://developer.ebay.com/Devzone/post-order/types/InquirySummaryType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) An array of one or more INR inquiries that match the filter criteria in request. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#members) to learn which calls use members. paginationOutput ( _[PaginationOutput](https://developer.ebay.com/Devzone/post-order/types/PaginationOutput.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container consists of metadata related to the current page of results. It shows the total number of INR inquiries that match the filter criteria, the total number of INR inquiries to show per page of results, and the total number of pages in the results set. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#paginationOutput) to learn which calls use paginationOutput. totalNumberOfInquiries ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the total number of INR inquiries that were found based on the input filter(s) in the request. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#totalNumberOfInquiries) to learn which calls use totalNumberOfInquiries. --- # DecisionEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) DecisionEnum ============ This enumerated type lists all values that can be passed in the **decision** field of the **POST /post-order/v2/return/{returnId}/decide** request. With the values supported in the **decision** field, the seller can offer the return option to the buyer, approve or decline a return request, offer a partial refund to the buyer, or provide a Return Merchandise Authorization (RMA) number to the buyer. There are only a few supported values for a buyer, and these are discussed in the descriptions below. Type that uses DecisionEnum: [DecideReturnRequest](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html) Call that uses one or more values of DecisionEnum: [/post-order/v2/return/{returnId}/decide POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_decide__post.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ACCEPT\_PARTIAL\_REFUND | Pass this value in the **decision** field if the buyer wants to accept the seller's partial refund amount. This value is not applicable if the seller is making the call. | | ACCEPT\_REPLACEMENT\_OFFER | Pass this value in the **decision** field if the buyer wants to accept the seller's offer to replace the item. This value is not applicable if the seller is making the call.

**Note:** This value is not currently supported, and an error will occur if it is used. | | APPROVE | Pass this value in the **decision** field if the seller wants to approve the buyer's return request.

If the seller is opted-in to the RMA number program, they can populate the **RMANumber** field at the same time as they approve the return request, or they can provide the RMA number at a later time with a second call to **POST /return/{returnId}/decide** (where the **decision** field is set to `PROVIDE_RMA`). Note that you should not set **RMANumber** to null if you are using eBay shipping labels. | | APPROVE\_WITHOUT\_EBAY\_LABEL | **THIS VALUE IS DEPRECATED.** | | DECLINE | Pass this value in the **decision** field if the seller wants to decline the buyer's return request. | | DECLINE\_PARTIAL\_REFUND | Pass this value in the **decision** field if the buyer wants to decline the seller's partial refund amount. This value is not applicable if the seller is making the call. | | DECLINE\_REPLACEMENT\_OFFER | Pass this value in the **decision** field if the buyer wants to decline the seller's offer to replace the item. This value is not applicable if the seller is making the call.

**Note:** This value is not currently supported, and an error will occur if it is used. | | OFFER\_PARTIAL\_REFUND | Pass this value in the **decision** field if the seller wants to offer the buyer a partial refund. | | OFFER\_REPLACEMENT | Pass this value in the **decision** field if the seller wants to offer the buyer a replacement of the item instead of a refund.

**Note:** This value is not currently supported, and an error will occur if it is used. | | OFFER\_RETURN | Pass this value in the **decision** field if the seller wants to offer the buyer the opportunity to return the item. | | OFFER\_RETURN\_WITHOUT\_LABEL | **THIS VALUE IS DEPRECATED.** | | PROVIDE\_RMA | Pass this value in the **decision** field if the seller is providing a Return Merchandise Authorization (RMA) number to the buyer. When the **decision** field is set to this value, you must also provide the RMA number in the **RMANumber** field. | | UNKNOWN | **Note:** This value is deprecated. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # GetDetailResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) GetDetailResponse ================= This type provides details on a return request that is returned in the **POST /post-order/v2/return** and **GET /post-order/v2/return/{returnId}** responses. Type that uses GetDetailResponse: [CreateReturnResponse](https://developer.ebay.com/devzone/post-order/types/CreateReturnResponse.html) Calls that use GetDetailResponse: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ detail ( _[ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of detailed information on the return request. This container is not returned if the **fieldgroups** query parameter is omitted, or if it is used and its value is set to `SUMMARY` or `NONE`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#detail) to learn which calls use detail. summary ( _[ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of summarized information on the return request. This container is not returned if the **fieldgroups** query parameter is omitted, or if it is used and its value is set to `FULL` or `NONE`.' See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#summary) to learn which calls use summary. --- # EstimatedRefundType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) EstimatedRefundType =================== This type is used by the **estimatedRefundDetail.itemizedRefundDetail** container, which shows the estimated refund information before the seller issues a refund to the buyer. Once the refund is actually successfully processed, information on the refund may be seen in the **actualRefundDetail** container. Type that uses EstimatedRefundType: [EstimatedRefundDetailType](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundDetailType.html) Calls that use EstimatedRefundType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [estimatedAmount](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html#estimatedAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [maxAmount](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html#maxAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [minAmount](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html#minAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [purchasePriceDeductedPercentageList](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html#purchasePriceDeductedPercentageList) ( array of _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [refundFeeType](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html#refundFeeType) ( _[RefundFeeTypeEnum](https://developer.ebay.com/devzone/post-order/types/RefundFeeTypeEnum.html) _ ) [restockingFeePercentage](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html#restockingFeePercentage) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) estimatedAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the estimated amount of the refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#estimatedAmount) to learn which calls use estimatedAmount. maxAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the maximum amount that the refund could be based on the cost of the order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#maxAmount) to learn which calls use maxAmount. minAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the minimum amount that the refund could be based on the cost of the order. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#minAmount) to learn which calls use minAmount. purchasePriceDeductedPercentageList ( array of _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array shows one or more percentage values, and these values indicate the percentage value(s) deducted off of the purchase price. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#purchasePriceDeductedPercentageList) to learn which calls use purchasePriceDeductedPercentageList. refundFeeType ( _[RefundFeeTypeEnum](https://developer.ebay.com/devzone/post-order/types/RefundFeeTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the type of refund. When issuing a refund through the **POST /post-order/v2/return/{returnId}/issue\_refund** method, the seller must use a separate **itemizedRefundDetail** container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundFeeType) to learn which calls use refundFeeType. restockingFeePercentage ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) **THIS FIELD IS DEPRECATED.** See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#restockingFeePercentage) to learn which calls use restockingFeePercentage. --- # Global ID Values - Product API Product API * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) Global ID Values ([string](https://developer.ebay.com/devzone/product/CallRef/types/simpleTypes.html) ) ======================================================================================================== The Global ID is a unique identifier for combinations of site, language, and territory. Global ID values are returned in **globalId** and are used as input for the X-EBAY-SOA-GLOBAL-ID header. The global ID you use must correspond to an eBay site with a valid site ID. See [eBay Site ID to Global ID Mapping](https://developer.ebay.com/devzone/product/Concepts/SiteIDToGlobalID.html) for a list of global IDs you can use with the API calls. **Enumeration Values (active sites only)** | Global ID | Language | Territory | Site Name | eBay Site ID | | --- | --- | --- | --- | --- | | EBAY-AT | de-AT | AT | eBay Austria | 16 | | EBAY-AU | en-AU | AU | eBay Australia | 15 | | EBAY-CH | de-CH | CH | eBay Switzerland | 193 | | EBAY-DE | en-DE | DE | eBay Germany | 77 | | EBAY-ENCA | en-CA | CA | eBay Canada (English) | 2 | | EBAY-ES | es-ES | ES | eBay Spain | 186 | | EBAY-FR | fr-FR | FR | eBay France | 71 | | EBAY-FRBE | fr-BE | BE | eBay Belgium (French) | 23 | | EBAY-FRCA | fr-CA | CA | eBay Canada (French) | 210 | | EBAY-GB | en-GB | GB | eBay UK | 3 | | EBAY-HK | zh-Hant | HK | eBay Hong Kong | 201 | | EBAY-IE | en-IE | IE | eBay Ireland | 205 | | EBAY-IN | en-IN | IN | eBay India | 203 | | EBAY-IT | it-IT | IT | eBay Italy | 101 | | EBAY-MOTOR | en-US | US | eBay Motors | 100 | | EBAY-MY | en-MY | MY | eBay Malaysia | 207 | | EBAY-NL | nl-NL | NL | eBay Netherlands | 146 | | EBAY-NLBE | nl-BE | BE | eBay Belgium (Dutch) | 123 | | EBAY-NZ (reserved for future use) | en-NZ | NZ | eBay New Zealand | N/A | | EBAY-PH | en-PH | PH | eBay Philippines | 211 | | EBAY-PL | pl-PL | PL | eBay Poland | 212 | | EBAY-SG | en-SG | SG | eBay Singapore | 216 | | EBAY-US | en-US | US | eBay United States | 0 | --- # FundingMethodBrandEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FundingMethodBrandEnum ====================== This enumeration type lists the possible credit card brands that can be used by eBay to fund a seller's refund to a buyer. This type is only applicable if a buyer refund will be funded using a seller's credit card as the funding source. Types that use FundingMethodBrandEnum: [FundingSource](https://developer.ebay.com/devzone/post-order/types/FundingSource.html) , [FundingSourceType](https://developer.ebay.com/devzone/post-order/types/FundingSourceType.html) Calls that use one or more values of FundingMethodBrandEnum: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | AMERICAN\_EXPRESS | This enumeration value indicates that a American Express credit card will be used to fund the refund to the buyer. | | DISCOVER | This enumeration value indicates that a Discover credit card will be used to fund the refund to the buyer. | | MASTERCARD | This enumeration value indicates that a Mastercard credit card will be used to fund the refund to the buyer. | | VISA | This enumeration value indicates that a Visa credit card will be used to fund the refund to the buyer. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # AckValue - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) AckValue ( [string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) ) ================================================================================================================= 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. Type that uses AckValue: [BaseServiceResponse](https://developer.ebay.com/devzone/product-metadata/CallRef/types/BaseServiceResponse.html) Calls that use one or more values of AckValue: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | Failure | 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. | | PartialFailure | The request that triggered the error was processed successfully but with some warnings. | | Success | The request was processed successfully, but something occurred that may affect your application or the user. | | Warning | The request that triggered the error was processed successfully but with some warnings. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/product-metadata/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # AppealDetails - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) AppealDetails ============= This type provides information related to the appeal of a case decision. Types that use AppealDetails: [CaseDetailsResponse](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html) , [InquiryDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html) Calls that use AppealDetails: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Fields ------ [appealCloseReasonEnum](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#appealCloseReasonEnum) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [appealDate](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#appealDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [appealReasonCode](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#appealReasonCode) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [appealRefundAmount](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#appealRefundAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [appealStatus](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#appealStatus) ( _[AppealGrantStatusEnum](https://developer.ebay.com/devzone/post-order/types/AppealGrantStatusEnum.html) _ ) [appealStatusEnum](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#appealStatusEnum) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [eligibleForAppeal](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html#eligibleForAppeal) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) appealCloseReasonEnum ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates why the appeal on the case decision was closed. This field will only be returned if an appeal was made on a case decision and this appeal has been closed. The list of enumeration values that may be returned in this field are defined in the [AppealCloseReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/AppealCloseReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealCloseReasonEnum) to learn which calls use appealCloseReasonEnum. appealDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date and time when the appeal was initiated by buyer or seller. This field will only be returned if an appeal was made on the case decision. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealDate) to learn which calls use appealDate. appealReasonCode ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is a string representation of why the buyer or seller appealed the case decision. This field is only returned if the buyer or seller made an appeal on the case decision. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealReasonCode) to learn which calls use appealReasonCode. appealRefundAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount refunded to the seller if the seller wins an appeal on a case decision going against the seller. The value will be in the seller's default currency. This field is only returned if the seller made an appeal on the case decision. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealRefundAmount) to learn which calls use appealRefundAmount. appealStatus ( _[AppealGrantStatusEnum](https://developer.ebay.com/devzone/post-order/types/AppealGrantStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates whether or not eBay has accepted the buyer's or seller's appeal on the case decision. This field is only returned if the buyer or seller has attempted to make an appeal on the case decision. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealStatus) to learn which calls use appealStatus. appealStatusEnum ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the appeal against the case decision. The list of enumeration values that may be returned in this field are defined in the [AppealStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/AppealStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#appealStatusEnum) to learn which calls use appealStatusEnum. eligibleForAppeal ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This boolean field will be returned as `true` if the buyer or seller is eligible to appeal the decision on the case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eligibleForAppeal) to learn which calls use eligibleForAppeal. --- # Product search feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#mainContent) A product search feed response will include details on matching eBay catalog products if they were found using product identifiers or keywords. If a catalog product was not found, a warning message will be returned that indicates that no matching product was found. The following table explains the elements or fields in the product search feed response file. Sample response file: * [product-search-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/product-search-response.csv) * XML sample response file not available **Note:** The fields in the table below are ordered according to their order in the CSV response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML response file. | Field name | Description | | --- | --- | | CSV: `Reference ID`

XML:
`matchingProducts.referenceID` | The seller-provided reference ID from the request. This can be an eBay Product ID (`ePID`), or from a set of values to set the type of ID being passed in to the **Product Identifier** field (see [Available Reference ID values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-reference-id-values.html)
).

**Occurrence**: Always Returned | | CSV: `Channel ID`

XML:
`productDetails.channelID` | The eBay site on which the product search should be made.

The unique identifiers of the selling site, such as `EBAY_US`, `EBAY_GB`, or `EBAY_IT`. If not provided in the request feed, this field defaults to `EBAY_US`. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list.

**Occurrence**: Always Returned | | CSV: `ePID`

XML:`productDetails.channelID` | The eBay product identifier (ePID). Identifies a product in the eBay product catalog.

**Occurrence**: Always Returned | | CSV: Not returned in CSV response

XML:
`productDetails.productVersion` | For XML only, the version number of the catalog product definition. This version number is incremented each time catalog product is updated | | CSV: `GTIN`

XML: **type** attribute value of `GTIN` for `productDetails.productIdentifier` | Global Trade Item Number (GTIN). If a EAN, ISBN, or UPC exists for the catalog product, the values are returned (from EAN, ISBN, and UPC). For CSV, any GTIN and Brand/MPN associated with the catalog product is also returned in the applicable column.

For XML, any GTIN and Brand/MPN associated with the catalog product is returned with the type of identifier indicated through the type attribute value (see [Sample type attribute](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#Sample)
).

**Occurrence**: Conditionally Returned | | CSV: `UPC`

XML: **type** attribute value of `UPC` for `productDetails.productIdentifier` | If a Universal Product Codes (UPCs) exists for the catalog product, it will be returned

For an XML sample, see the [Sample type attribute.](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#Sample)

**Occurrence**: Conditionally Returned | | CSV: `ISBN`

XML: **type** attribute value of `ISBN` for `productDetails.productIdentifier` | If an International Standard Book Numbers (ISBNs) exists for the catalog product, it will be returned

For an XML sample, see the [Sample type attribute.](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#Sample)

**Occurrence**: Conditionally Returned | | CSV: `EAN`

XML: **type** attribute value of `EAN` for `productDetails.productIdentifier` | If a European Article Numbers (EANs) exists for the catalog product, it will be returned

For an XML sample, see the [Sample type attribute.](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#Sample)

**Occurrence**: Conditionally Returned | | CSV: `Brand`

XML: **type** attribute value of `BRAND` for `productDetails.productIdentifier` | The manufacturer's brand name of the product. It is always returned if an MPN exists for the product. The Brand/MPN combo unique identifies a product.

For an XML sample, see the [Sample type attribute.](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#Sample)

**Occurrence**: Conditionally Returned | | CSV: `MPN`

XML: **type** attribute value of `MPN` for `productDetails.productIdentifier` | If a Manufacturer Product Number (MPN) values that the manufacturer uses to identify this product exists for the catalog product. It is always returned if an MPN exists for the product. The Brand/MPN combo unique identifies a product.

For an XML sample, see the [Sample type attribute.](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-search-feed.html#Sample)

**Occurrence**: Conditionally Returned | | CSV: `primaryCategory`

XML: `productDetails.primaryCategory` | The main eBay leaf category for this product.

**Occurrence**: Always Returned | | CSV: `additionalCategory`

XML: `productDetails.additionalCategory` | This field is returned if the eBay catalog product can be listed in additional leaf categories besides the one indicated by **primaryCategory** field. One or more eBay categories associated with the product, not including the primary category, is returned.

**Occurrence**: Conditionally Returned | | CSV: `productURL`

XML: `productDetails.productURL` | The URL to the matching product’s product page on eBay.

**Occurrence**: Always Returned | | CSV: `title`

XML: `productDetails.title` | The title of the product.

**Max length:** 80 characters

**Occurrence**: Always Returned | | CSV: `Attributes`

XML: `productDetails.attribute` container | Name-value pairs of product attributes. An attribute is often referred to an Item Specific or a product aspect. Example values include Brand, Model, Type, Color, and Features. The number of defined attributes vary by category, and some categories have much more than others. Some item specifics can have multiple values.

**CSV**

CSV uses the following syntax for name/value pairs: `name1=value1\|name2=value2\|name3=value3`.

Brand=Apple\|MPN=MGAL2LLA\|Processor=Dual Core

**XML**

For XML, an attribute container is included for each item specific name/value pair.


Brand
Apple


**Occurrence**: Conditionally Returned | | CSV: `PictureURL`

XML: `productDetails.pictureURL` | A stock photo defined for the catalog product. Most catalog products have at least one stock photo.

**Occurrence**: Conditionally Returned | | CSV: `description`

XML: `productDetails.description` | The description of the product, as defined in the eBay catalog product definition. Most catalog products have a description defined.

**Occurrence**: Conditionally Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue with the product search.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue with the product search.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue with the product search. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Sample type attribute (XML) --------------------------- If an identifier exists for the catalog product, it will be returned as a **type** in the **productDetails.productIdentifier** container. EBAY\_US 27056252015 6 Apple MQ903LLA 0194253378877 0400064872665 0194253378877 0400064872665 0194253378877 0400064872665 #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Payment method | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/add-payment-method.html#mainContent) eBay automatically specifies the available electronic payment methods available for each marketplace. However, if a new listing supports (or requires) an offline payment, sellers must specify one or more offline payment methods for the listing. **Argument:** [Item.PaymentMethods](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PaymentMethods) Determine offline payment methods for a category ------------------------------------------------ Use [GetCategoryFeatures](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetCategoryFeatures.html) to determine the offline payment methods that are allowed for a category on a marketplace. Offline payment methods will vary slightly per marketplace, but common methods include: * `CashOnPickup` * `MOCC` (Money Order or Cashier's/Bank Check) * `PersonalCheck` For additional information about payment methods, refer to [Payment methods policy](https://www.ebay.com/help/policies/payment-policies/accepted-payments-policy?id=4269) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ProductRequest - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) ProductRequest ============== Container for request data used in product search calls. Type that uses ProductRequest: [FindProductsRequest](https://developer.ebay.com/devzone/product/CallRef/types/FindProductsRequest.html) Call that uses ProductRequest: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) Fields ------ [categoryId](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#categoryId) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [dataset](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#dataset) ( _[token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) _ ) [datasetPropertyName](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#datasetPropertyName) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [invocationId](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#invocationId) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [keywords](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#keywords) ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [paginationInput](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#paginationInput) ( _[PaginationInput](https://developer.ebay.com/devzone/product/CallRef/types/PaginationInput.html) _ ) [productStatusFilter](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#productStatusFilter) ( _[ProductStatus](https://developer.ebay.com/devzone/product/CallRef/types/ProductStatus.html) _ ) [propertyFilter](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#propertyFilter) ( _[PropertyValue](https://developer.ebay.com/devzone/product/CallRef/types/PropertyValue.html) _ ) [sortOrder](https://developer.ebay.com/devzone/product/CallRef/types/ProductRequest.html#sortOrder) ( _[SortOrder](https://developer.ebay.com/devzone/product/CallRef/types/SortOrder.html) _ ) categoryId ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled. Your request must contain categoryId and/or keywords. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#categoryId) to learn which calls use categoryId. dataset ( _[token](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#token) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) This will define what are properties that will be returned for this catelog-enabled category. **Dataset values:** DisplayableProductDetails Properies for use in a user interface to describe products. DisplayableSearchResults Properties for use in results for product searches. Searchable Properties for use in searches. Sortable Properties that are suitable for sorting. User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#dataset) to learn which calls use dataset. datasetPropertyName ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#datasetPropertyName) to learn which calls use datasetPropertyName. invocationId ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed. If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number . See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#invocationId) to learn which calls use invocationId. keywords ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint. Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported. Your request must contain categoryId and/or keywords. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#keywords) to learn which calls use keywords. paginationInput ( _[PaginationInput](https://developer.ebay.com/devzone/product/CallRef/types/PaginationInput.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product. **Note:** No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#paginationInput) to learn which calls use paginationInput. productStatusFilter ( _[ProductStatus](https://developer.ebay.com/devzone/product/CallRef/types/ProductStatus.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productStatusFilter) to learn which calls use productStatusFilter. propertyFilter ( _[PropertyValue](https://developer.ebay.com/devzone/product/CallRef/types/PropertyValue.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) One or more name-value pairs that describe the product. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#propertyFilter) to learn which calls use propertyFilter. sortOrder ( _[SortOrder](https://developer.ebay.com/devzone/product/CallRef/types/SortOrder.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#sortOrder) to learn which calls use sortOrder. --- # CaseSearchResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) CaseSearchResponse ================== The base response type of the **GET /post-order/v2/casemanagement/search** method, which is used to retrieve cases based on filter criteria in the request. Call that uses CaseSearchResponse: [/post-order/v2/casemanagement/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement_search__get.html) Fields ------ members ( array of _[CaseSummaryType](https://developer.ebay.com/Devzone/post-order/types/CaseSummaryType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) An array of one or more cases that match the filter criteria in request. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#members) to learn which calls use members. paginationOutput ( _[PaginationOutput](https://developer.ebay.com/Devzone/post-order/types/PaginationOutput.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container consists of metadata related to the current page of results. It shows the total number of cases that match the filter criteria, the total number of cases to show per page of results, and the total number of pages in the results set. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#paginationOutput) to learn which calls use paginationOutput. totalNumberOfCases ( _[integer](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This integer value indicates the total number of cases that were found based on the input filter(s) in the request. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#totalNumberOfCases) to learn which calls use totalNumberOfCases. --- # ReturnCountFilterEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnCountFilterEnum ===================== This enumerated type lists all values that can be passed in the **return\_state** query parameter of the **GET /post-order/v2/return/search** method. These values specify the state of the return requests returned by a **search** request. These return state classifications will also get returned in the **countSummary** array in the **GET /post-order/v2/return/search** response. Type that uses ReturnCountFilterEnum: [CountSummaryType](https://developer.ebay.com/devzone/post-order/types/CountSummaryType.html) Call that uses one or more values of ReturnCountFilterEnum: [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | ALL\_OPEN | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests. | | ALL\_OPEN\_REPLACEMENT | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests where the buyer has requested a replacement item.

**Note:** This value is not currently supported. | | ALL\_OPEN\_RETURN | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests where the buyer wants to return the item for a refund. | | CLOSED | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all return requests that have been closed. | | EBAY\_PLUS | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests where the line item is an eBay Plus item. | | ITEM\_DELIVERED | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve return requests where a return item has been delivered to their destination. | | ITEM\_SHIPPED | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve return requests where a return item has been shipped. | | RETURN\_STARTED | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve newly-opened return requests. | | SELLER\_ACTION\_DUE | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests that are currently awaiting a seller action. | | SELLER\_ACTION\_OVERDUE | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests where a seller action is overdue. | | SELLER\_NO\_ACTION | This enumeration value is set in the **return\_state** query parameter field if the user wishes to retrieve all open return requests where no seller action is currently due. | | UNKNOWN | This enumeration value should not be used in the **return\_state** query parameter field. |   \* See the [Enumeration Index](https://developer.ebay.com/devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # EscalationInfoType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) EscalationInfoType ================== This type is used by the **escalationInfo** container, which contains information related to the buyer's and seller's eligibility to escalate a return request to a case. Type that uses EscalationInfoType: [ReturnSummaryType](https://developer.ebay.com/Devzone/post-order/types/ReturnSummaryType.html) Calls that use EscalationInfoType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ buyerEscalationEligibilityInfo ( _[EscalationEligibilityInfo](https://developer.ebay.com/Devzone/post-order/types/EscalationEligibilityInfo.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container indicates if the buyer is eligible to escalate the return request into a return case. If the buyer is eligible to escalate the return request into a return case, the time window during which this buyer must perform this action is returned under this container. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#buyerEscalationEligibilityInfo) to learn which calls use buyerEscalationEligibilityInfo. caseId ( _[string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of an eBay case. This field will only be returned if the return request was successfully escalated to a return case. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#caseId) to learn which calls use caseId. sellerEscalationEligibilityInfo ( _[EscalationEligibilityInfo](https://developer.ebay.com/Devzone/post-order/types/EscalationEligibilityInfo.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container indicates if the seller is eligible to escalate the return request into a return case. If the seller is eligible to escalate the return request into a return case, the time window during which this seller must perform this action is returned under this container. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#sellerEscalationEligibilityInfo) to learn which calls use sellerEscalationEligibilityInfo. --- # BaseRequest - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) BaseRequest =========== This is the base class for the request container for all service operations. Calls that use BaseRequest: [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) Field ----- extension ( _[ExtensionType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ExtensionType.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Reserved for future use. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#extension) to learn which calls use extension. --- # ErrorData - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ErrorData ========= A container for error details. Type that uses ErrorData: [ErrorMessage](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorMessage.html) Calls that use ErrorData: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [category](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#category) ( _[ErrorCategory](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorCategory.html) _ ) [domain](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#domain) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [errorId](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#errorId) ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [exceptionId](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#exceptionId) ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [message](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#message) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [parameter](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#parameter) ( _[ErrorParameter](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) )_ ) [severity](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#severity) ( _[ErrorSeverity](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorSeverity.html) _ ) [subdomain](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html#subdomain) ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) category ( _[ErrorCategory](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorCategory.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) There are three categories of errors: request errors, application errors, and system errors. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#category) to learn which calls use category. domain ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Name of the domain in which the error occurred. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#domain) to learn which calls use domain. errorId ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#errorId) to learn which calls use errorId. exceptionId ( _[token](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#token) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Unique identifier for an exception associated with an error. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#exceptionId) to learn which calls use exceptionId. message ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) A detailed description of the condition that caused the error. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#message) to learn which calls use message. parameter ( _[ErrorParameter](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) )_ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#parameter) to learn which calls use parameter. severity ( _[ErrorSeverity](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorSeverity.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#severity) to learn which calls use severity. subdomain ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Name of the subdomain in which the error occurred. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#subdomain) to learn which calls use subdomain. --- # Quantity | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/quantity.html#mainContent) A fixed-price listing may offer one item or a multiple quantity of items. A fixed-price listing ends when the last item has been sold. An exception to this rule involves using the _Out-of-Stock_ feature. If this feature is enabled for the seller's account, fixed-price listings will remain active but hidden from search results even if the quantity has gone down to `0`. Refer to [Out-of-Stock Control](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/out-of-stock.html) for additional information. **Arguments:** * **Quantity for _single-variation_ listings:** [Item.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Quantity) * **Quantity for a specific variation in _multiple variation_ listings:** [Item.Variations.Variation.Quantity](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.Quantity) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ShipmentType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ShipmentType ============ This type is used to provide detailed information on shipment of a return item. Type that uses ShipmentType: [ReturnDetailType](https://developer.ebay.com/Devzone/post-order/types/ReturnDetailType.html) Calls that use ShipmentType: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ allShipmentTrackings ( array of _[ShipmentTrackingType](https://developer.ebay.com/Devzone/post-order/types/ShipmentTrackingType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container is an array of shipment tracking information for a return item. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#allShipmentTrackings) to learn which calls use allShipmentTrackings. payee ( _[ReturnUserRoleEnum](https://developer.ebay.com/Devzone/post-order/types/ReturnUserRoleEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates whether the buyer or seller will be paying for shipment of item. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#payee) to learn which calls use payee. shipmentTracking ( _[ShipmentTrackingType](https://developer.ebay.com/Devzone/post-order/types/ShipmentTrackingType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container provides detailed information on the whereabouts of a shipped item, including tracking number, origin and destination address, shipping status, estimated and actual shipping and delivery dates, and more. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#shipmentTracking) to learn which calls use shipmentTracking. shippingLabelCost ( _[ReturnShippingCostDetailType](https://developer.ebay.com/Devzone/post-order/types/ReturnShippingCostDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container provides the itemized list of costs associated with shipping the item. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#shippingLabelCost) to learn which calls use shippingLabelCost. --- # ReturnEligibilityItemPerCheckTypeResult - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) ReturnEligibilityItemPerCheckTypeResult ======================================= This type is used by the **eligibilityResultsPerCheckType** container, which contains the results for each eligibility check type that was run against the order line item. Type that uses ReturnEligibilityItemPerCheckTypeResult: [ReturnEligibilityPerItemType](https://developer.ebay.com/Devzone/post-order/types/ReturnEligibilityPerItemType.html) Call that uses ReturnEligibilityItemPerCheckTypeResult: [/post-order/v2/return POST](https://developer.ebay.com/Devzone/post-order/post-order_v2_return__post.html) Fields ------ checkType ( _[ret:EligibilityCheckTypeEnum](https://developer.ebay.com/Devzone/post-order/types/ret_EligibilityCheckTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the type of eligibility check that was run against the order line item. For the **POST /post-order/v2/return/check\_eligibility** method, multiple eligibility checks can be run against the order line item, but the **POST /post-order/v2/return** method only uses the `RETURN_CREATION` check. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#checkType) to learn which calls use checkType. eligibilityInfo ( _[EligibilityResultType](https://developer.ebay.com/Devzone/post-order/types/EligibilityResultType.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container includes the results of the return eligibility check, including any errors that may have occurred with the eligibility check, as well as detailed information on the return request. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#eligibilityInfo) to learn which calls use eligibilityInfo. --- # RefundInfo - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) RefundInfo ========== This type is used to provide more information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order. Type that uses RefundInfo: [CancelDetail](https://developer.ebay.com/Devzone/post-order/types/CancelDetail.html) Call that uses RefundInfo: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Field ----- actualRefundDetail ( _[ActualRefundDetail](https://developer.ebay.com/Devzone/post-order/types/ActualRefundDetail.html) _ ) [\[0..?\]](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#multiplicity) This container provides detailed information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order. See the [Field Index](https://developer.ebay.com/Devzone/post-order/fieldindex.html#actualRefundDetail) to learn which calls use actualRefundDetail. --- # UserPartyEnum - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) UserPartyEnum ============= This enumerated type lists the types of users who can possibly perform an action on an INR inquiry or a case. Types that use UserPartyEnum: [CaseDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/CaseDetailsResponse.html) , [ClaimHistoryEventModel](https://developer.ebay.com/Devzone/post-order/types/ClaimHistoryEventModel.html) , [InquiryDetailsResponse](https://developer.ebay.com/Devzone/post-order/types/InquiryDetailsResponse.html) Calls that use one or more values of UserPartyEnum: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | BUYER | This enumeration value indicates that the initiator of the action is the buyer. | | CSR | This enumeration value indicates that the initiator of the action is an eBay customer support representative. | | SELLER | This enumeration value indicates that the initiator of the action is the seller. | | SYSTEM | This enumeration value indicates that the initiator of the action is the eBay system. | | UNKNOWN | This enumeration value indicates that the initiator of the action cannot be determined. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/post-order/enumindex.html) to see exact use of each enumeration value in the API. --- # ActualRefundDetail - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ActualRefundDetail ================== This type is used to provide details about buyer refund information for an order cancellation request. Type that uses ActualRefundDetail: [RefundInfo](https://developer.ebay.com/devzone/post-order/types/RefundInfo.html) Call that uses ActualRefundDetail: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Fields ------ [actualRefund](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html#actualRefund) ( _[ActualRefund](https://developer.ebay.com/devzone/post-order/types/ActualRefund.html) _ ) [fundings](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html#fundings) ( array of _[RefundFundingType](https://developer.ebay.com/devzone/post-order/types/RefundFundingType.html) _ ) [netChargeAmount](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html#netChargeAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [outstandingAmount](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html#outstandingAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [refundIssuedDate](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html#refundIssuedDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [refundStatus](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html#refundStatus) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) actualRefund ( _[ActualRefund](https://developer.ebay.com/devzone/post-order/types/ActualRefund.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount of the buyer refund that has been issued for the cancelled order. If a refund has not occured yet, this container will not be returned. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actualRefund) to learn which calls use actualRefund. fundings ( array of _[RefundFundingType](https://developer.ebay.com/devzone/post-order/types/RefundFundingType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array shows one or more seller payment sources used for the buyer refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fundings) to learn which calls use fundings. netChargeAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount charged to the seller for this refund. The value will be in the seller's default currency. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#netChargeAmount) to learn which calls use netChargeAmount. outstandingAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows any outstanding dollar amount that is still due to the buyer for the refund. If a full refund has been successfully issued to the buyer, this value should be `0.0`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#outstandingAmount) to learn which calls use outstandingAmount. refundIssuedDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates the date and time when the refund was issued to the buyer. This field will not be returned if a buyer refund has not occurred yet. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundIssuedDate) to learn which calls use refundIssuedDate. refundStatus ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the refund for the cancelled order. The value in this field should be `SUCCESS` if the refund has been successfully issued to the buyer. The list of enumeration values that may be returned in this field are defined in the [MoneyMovementStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/can_MoneyMovementStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundStatus) to learn which calls use refundStatus. --- # ErrorMessage - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ErrorMessage ============ Information regarding an error or warning that occurred when eBay processed the request. Not returned when the **ack** value is **Success**. Type that uses ErrorMessage: [BaseResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/BaseResponse.html) Calls that use ErrorMessage: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Field ----- error ( _[ErrorData](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ErrorData.html) _ ) [\[0..\*\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Details about a single error. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#error) to learn which calls use error. --- # Add a picture | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/add-picture.html#mainContent) Pictures make an item more appealing and provide buyers a better idea of an item's appearance. At least one picture is required for each listing, however up to 24 pictures may be added to any listing in most categories at no cost. **Note:** When posting a motor vehicle listing, the number of pictures included depends on the selected vehicle package. For complete information, refer to [Package pricing for vehicle listings](https://www.ebay.com/help/selling/fees-credits-invoices/motors-fees?id=4127#section1) . For additional information and requirements about adding pictures to listings, refer to [Add pictures](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/pictures.html) . For information about adding other media types to listings, refer to [Add media](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/media.html) . **Arguments:** * [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PictureDetails.PictureURL) specifies the URL for a picture. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Item location | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/location.html#mainContent) When listing an item, sellers must specify the country in which the item is located by passing in a two-character code using the [Item.Country](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Country) field. To determine which country codes are currently supported, issue a [GeteBayDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) call. In addition to the supported codes, the English name associated with each code is also returned. For example: AU Australia 1 2009-07-01T23:51:09.000Z ... KY Cayman Islands 1 2009-07-01T23:51:09.000Z **Note:** Most country codes used by eBay conform to the ISO 3166 standard (e.g., `US` for the United States). However, some codes in the ISO 3166 standard are not used by eBay. Additionally, the eBay list includes some non-ISO codes as well. These additional codes appear at the end of the code list and are noted as being non-ISO. Specify the item location ------------------------- In addition to specifying the country code for an item (i.e., using the [Item.Country](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Country) field,) sellers must further specify the item's location. Not only will this improve search results for buyers looking for items within a specified area, but the information may required when calculating shipping costs (e.g., calculated shipping option). An item's location is specified using either of the following fields: * [Item.PostalCode](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PostalCode) * [Item.Location](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Location) **Item.Location** is a free-form text field with a maximum length of 45 characters. It is often used to indicate a City/State combination. For example: San Jose, CA #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # can:MoneyMovementDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) can:MoneyMovementDetailType =========================== This type is used to express details about all monetary transactions that may occur with an order cancellation request. Type that uses can:MoneyMovementDetailType: [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) Call that uses can:MoneyMovementDetailType: [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) Fields ------ [actualAmount](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementDetailType.html#actualAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [creationDate](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementDetailType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [moneyMovementType](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementDetailType.html#moneyMovementType) ( _[can:MoneyMovementTypeEnum](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementTypeEnum.html) _ ) [requestedAmount](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementDetailType.html#requestedAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [status](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementDetailType.html#status) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) actualAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the actual amount of the monetary transaction. The **actualAmount** field will only show up if the monetary transaction was confirmed to be successful (corresponding **status** value shows as `SUCCESS`. If the **status** value shows any value other than `SUCCESS`, the expected amount of the monetary transaction can be seen in the **requestedAmount** field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actualAmount) to learn which calls use actualAmount. creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This timestamp indicates the date and time when the monetary transaction occurred. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. moneyMovementType ( _[can:MoneyMovementTypeEnum](https://developer.ebay.com/devzone/post-order/types/can_MoneyMovementTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the type of monetary transaction that is either in the process of being executed or has already executed. Monetary transactions include a seller's partial or full refund to the buyer, eBay refunding the buyer, or eBay recouping money from the seller for a buyer refund issued by eBay. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#moneyMovementType) to learn which calls use moneyMovementType. requestedAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the expected amount of the transaction. This field is returned regardless of the value shown in the **corresponding **status** field. The **actualAmount** field displays only when the monetary transaction was confirmed to be successful (**status** value is `SUCCESS`.** See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#requestedAmount) to learn which calls use requestedAmount. status ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the success or failure of the monetary transaction type (noted in the **moneyMovementType** field) The list of enumeration values that may be returned in this field are defined in the [MoneyMovementStatusEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/can_MoneyMovementStatusEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#status) to learn which calls use status. --- # ActualRefundDetailType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ActualRefundDetailType ====================== This type is used by the **actualRefundDetail** container, which shows the itemized refund information after the seller issues a refund to the buyer. Until the refund is actually successfully processed, only information on the estimated refund may be seen in the **estimatedRefundDetail** container. Type that uses ActualRefundDetailType: [RefundInfoType](https://developer.ebay.com/devzone/post-order/types/RefundInfoType.html) Calls that use ActualRefundDetailType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [actualRefund](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#actualRefund) ( _[RefundDetailType](https://developer.ebay.com/devzone/post-order/types/RefundDetailType.html) _ ) [fundings](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#fundings) ( array of _[RefundFundingType](https://developer.ebay.com/devzone/post-order/types/RefundFundingType.html) _ ) [netChargeAmount](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#netChargeAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [outstandingAmount](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#outstandingAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [refundInitiationType](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#refundInitiationType) ( _[ReturnRefundInitiatorEnum](https://developer.ebay.com/devzone/post-order/types/ReturnRefundInitiatorEnum.html) _ ) [refundIssuedDate](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#refundIssuedDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [refundStatus](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html#refundStatus) ( _[Refund\_MoneyMovementStatusEnum](https://developer.ebay.com/devzone/post-order/types/Refund_MoneyMovementStatusEnum.html) _ ) actualRefund ( _[RefundDetailType](https://developer.ebay.com/devzone/post-order/types/RefundDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of one or more **itemizedRefundDetail** containers, as well as the total amount of the actual refund (which is the total of each **itemizedRefundDetail.amount** value). This container is only returned if a refund has been issued for the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#actualRefund) to learn which calls use actualRefund. fundings ( array of _[RefundFundingType](https://developer.ebay.com/devzone/post-order/types/RefundFundingType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array shows more information about how the buyer refund was funded. There are multiple seller payment sources where the money can come from, and it is possible that the money can come from multiple seller payment sources. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fundings) to learn which calls use fundings. netChargeAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the total amount charged to the seller for this refund. The value will be in the seller's default currency. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#netChargeAmount) to learn which calls use netChargeAmount. outstandingAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows any outstanding dollar amount that is still due to the buyer for the refund. If a full refund has been successfully issued to the buyer, this value should be `0.0`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#outstandingAmount) to learn which calls use outstandingAmount. refundInitiationType ( _[ReturnRefundInitiatorEnum](https://developer.ebay.com/devzone/post-order/types/ReturnRefundInitiatorEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumerated value indicates the initiator of the refund. `SELLER_INITIATED` indicates that the seller initiated the refund, and `AUTO_REFUND` indicates that the buyer's money was automatically refunded by eBay. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundInitiationType) to learn which calls use refundInitiationType. refundIssuedDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the seller issued the refund to the buyer. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundIssuedDate) to learn which calls use refundIssuedDate. refundStatus ( _[Refund\_MoneyMovementStatusEnum](https://developer.ebay.com/devzone/post-order/types/Refund_MoneyMovementStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value in this field indicates whether or not the refund operation was successful. If the `PENDING` value is returned, it indicates that the refund may be occurring outside of eBay's system and there is no way for eBay to check the status of the refund. In this scenario, the seller should call **POST /post-order/v2/return/{returnId}/mark\_refund\_sent** to mark the refund as sent and/or the buyer should call **POST /post-order/v2/return/{returnId}/mark\_refund\_received** to mark the refund as received. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundStatus) to learn which calls use refundStatus. --- # Delete inventory feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-delete-inventory-feed.html#mainContent) A delete inventory feed response file tells you if all the data in an inventory feed was processed successfully or not. The following table explains the elements or fields in the delete inventory feed response file. Sample response file: * [delete-inventory-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/delete-inventory-response.csv) * [delete-inventory-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/delete-inventory-response.xml) **Note:** The fields in the table below are ordered according to their order in the CSV response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML response file. | Field name | Description | | --- | --- | | CSV: `SKU`

XML: `productDetail.SKU` | The product's Stock Keeping Unit.

**Occurrence**: Always Returned | | CSV: `Action`

XML: `productDetail.action` | The action requested. Valid values:

* `DeleteListing`: Delete one or more listings from specified eBay sites, but the SKUs and associated information remain in MIP.
* `DeleteInventory`: Delete one or more listings from all eBay sites, as well as the SKUs and associated information in MIP.

**Occurrence**: Always Returned | | CSV: `Channel ID`

XML: `productDetail.channelID` | Included when the action is DeleteListing. The unique identifiers of the eBay sales channels, such as `EBAY_GB`. Blank if selling only on `EBAY_US`. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list..

ChannelID is used only for the deleteListing option. It is not applicable to the deleteInventory option and will be ignored.

**Occurrence**: Conditionally Returned | | CSV: `Format`

XML: `productDetail.format` | The listing format.

A string with this valid value:

* `FIXED_PRICE`

* `AUCTION`


**Occurrence**: Optional | | CSV: `Status`

XML: `productDetail.status` | Returned for each individual SKU. Status results include:

* `SUCCESS`: Indicates the specific SKUs that were deleted.
* `FAILED`: Indicates the specific SKUs that were not deleted.

**Occurrence**: Always Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue creating or updating the inventory.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue creating or updating the inventory.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue creating or updating the inventory. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Additional container in XML response ------------------------------------ In addition to the fields called out in the table above, the feed response file will also have a **feedSummary** container. See [XML feedSummary container](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#XML) for details. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ReturnFileType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ReturnFileType ============== This type is used by the **files** container, which contains detailed information about one or more files that are submitted and associated with a return request or return request draft. Types that use ReturnFileType: [GetFileResponse](https://developer.ebay.com/devzone/post-order/types/GetFileResponse.html) , [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ReturnFileType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/files GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_files__get.html) Fields ------ [creationDate](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#creationDate) ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [fileData](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#fileData) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [fileFormat](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#fileFormat) ( _[FileFormatEnum](https://developer.ebay.com/devzone/post-order/types/FileFormatEnum.html) _ ) [fileId](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#fileId) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [fileName](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#fileName) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [filePurpose](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#filePurpose) ( _[FilePurposeEnum](https://developer.ebay.com/devzone/post-order/types/FilePurposeEnum.html) _ ) [fileStatus](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#fileStatus) ( _[FileStatusEnum](https://developer.ebay.com/devzone/post-order/types/FileStatusEnum.html) _ ) [resizedFileData](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#resizedFileData) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [secureUrl](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#secureUrl) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [submitter](https://developer.ebay.com/devzone/post-order/types/ReturnFileType.html#submitter) ( _[ReturnUserRoleEnum](https://developer.ebay.com/devzone/post-order/types/ReturnUserRoleEnum.html) _ ) creationDate ( _[DateTime](https://developer.ebay.com/devzone/post-order/types/DateTime.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The timestamp in this container indicates when the file was attached to the return request or return request draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#creationDate) to learn which calls use creationDate. fileData ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is the base64-encoded binary representation of the file associated with the return request or return request draft. This field is always returned for each file that is attached to a return request or return request draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileData) to learn which calls use fileData. fileFormat ( _[FileFormatEnum](https://developer.ebay.com/devzone/post-order/types/FileFormatEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the file type (like .GIF or .JPG). This field is always returned for each file that is attached to a return request or return request draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileFormat) to learn which calls use fileFormat. fileId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This is the unique eBay-assigned ID of a file that is associated with the return request or return request draft. This field is always returned for each file that is attached to a return request or return request draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileId) to learn which calls use fileId. fileName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field contains the name of the uploaded file. This field will be returned if the user has specified a name for the file. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileName) to learn which calls use fileName. filePurpose ( _[FilePurposeEnum](https://developer.ebay.com/devzone/post-order/types/FilePurposeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the file's purpose. Files attached to return requests or return request drafts may provide more information about the condition of the item, about the buyer's refund, or about shipment tracking or shipping label. This field is always returned for each file that is attached to a return request or draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#filePurpose) to learn which calls use filePurpose. fileStatus ( _[FileStatusEnum](https://developer.ebay.com/devzone/post-order/types/FileStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates the current status of the file. This field is always returned for each file that is attached to a return request or return request draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileStatus) to learn which calls use fileStatus. resizedFileData ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is the base64-encoded binary representation of the file associated with the return request or return request draft. This field is returned for each file that is attached to a return request or return request draft that has been resized. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#resizedFileData) to learn which calls use resizedFileData. secureUrl ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field contains the URL where the uploaded file can be viewed. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#secureUrl) to learn which calls use secureUrl. submitter ( _[ReturnUserRoleEnum](https://developer.ebay.com/devzone/post-order/types/ReturnUserRoleEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates which party (buyer or seller) submitted the file. This field is always returned for each file that is attached to a return request or return request draft. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#submitter) to learn which calls use submitter. --- # VersionDetails - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) VersionDetails ============== Details about the current version of the metadata used for searching for compatibilities or products. Type that uses VersionDetails: [GetProductSearchDataVersionResponse](https://developer.ebay.com/devzone/product-metadata/CallRef/types/GetProductSearchDataVersionResponse.html) Call that uses VersionDetails: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) Fields ------ updateTime ( _[dateTime](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#dateTime) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Indicates the date and time the current search metadata was updated. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#updateTime) to learn which calls use updateTime. version ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Version number for the current search metadata (product or compatibility). If you are maintaining search metadata locally, compare this value to the version of the search metadata you last downloaded to determine whether the data may have changed. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#version) to learn which calls use version. --- # Locale enumerated values | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-locale.html#mainContent) This topic defines enumerated values that specify the language used for data in the listing. | Value | Description | | --- | --- | | `en_US` | The content is localized for US English. | | `en_CA` | The content is localized for Canadian English. | | `fr_CA` | The content is localized for Canadian French. | | `en_GB` | The content is localized for UK English. | | `en_AU` | The content is localized for Australian English. | | `en_IN` | The content is localized for English but on the India site.

**Note:** eBay India is no longer a functioning eBay marketplace | | `de_AT` | The content is localized for German speakers on the Austria site. | | `fr_BE` | The content is localized for French speakers on the Belgium site. | | `fr_FR` | The content is localized for French speakers on the France site. | | `de_DE` | The content is localized for German speakers on the Germany site. | | `it_IT` | The content is localized for Italian speakers on the Italy site. | | `nl_BE` | The content is localized for Dutch speakers on the Belgium site. | | `nl_NL` | The content is localized for Dutch speakers on the Netherlands site. | | `es_ES` | The content is localized for Spanish speakers on the Spain site. | | `de_CH` | The content is localized for Germany speakers on the Switzerland site. | | `fi_FI` | The content is localized for Finnish speakers. | | `zh_HK` | The content is localized for Chinese speakers on the Hong Kong site. | | `hu_HU` | The content is localized for Hungarian speakers. | | `en_PH` | The content is localized for English speakers on the Philippines site. | | `pl_PL` | The content is localized for Polish speakers on the Poland site. | | `pt_PT` | The content is localized for Portuguese speakers. | | `ru_RU` | The content is localized for Russian speakers. | | `en_SG` | The content is localized for English on the Singapore site. | | `en_IE` | The content is localized for English on the Ireland site. | | `en_MY` | The content is localized for English on the Malaysia site. | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ErrorMessage - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) ErrorMessage ============ Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault. Type that uses ErrorMessage: [BaseServiceResponse](https://developer.ebay.com/devzone/product-metadata/CallRef/types/BaseServiceResponse.html) Calls that use ErrorMessage: [getCompatibilitySearchDataVersion](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Field ----- error ( _[ErrorData](https://developer.ebay.com/devzone/product-metadata/CallRef/types/ErrorData.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Details about a single error. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#error) to learn which calls use error. --- # FindCancelResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) FindCancelResponse ================== The base response type of the **GET /post-order/v2/cancellation/search** method. This response returns information about an order cancellation request. The order cancellation request(s) returned are the ones that match the filter criteria passed in the query parameter(s) of the request. Call that uses FindCancelResponse: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation_search__get.html) Fields ------ cancellations ( array of _[CancelSummary](https://developer.ebay.com/devzone/post-order/types/CancelSummary.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) An array of one or more order cancellation requests that match the request criteria. This array is returned as empty if no order cancellation requests match the input criteria. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#cancellations) to learn which calls use cancellations. paginationOutput ( _[PaginationOutput](https://developer.ebay.com/devzone/post-order/types/PaginationOutput.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The result set from this method is paginated because the request can result in a large number of matches. This container consists of metadata related to the current response page. It contains the page number and the cancellation entries per page, as well as the total amount of response pages and cancellation entries. This container is not returned if no cancellation requests match the input criteria. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#paginationOutput) to learn which calls use paginationOutput. total ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The total number of cancellation requests that match the input criteria. A value of `0` is returned if no cancellation requests match the input criteria. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#total) to learn which calls use total. --- # Delete inventory feed definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-delete-inventory-feed.html#mainContent) The following table provides definitions for the fields in the delete inventory feed. Sample feed files: * [delete-inventory.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-csv/delete-inventory.csv) * [delete-inventory.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-xml/delete-inventory.xml) **Note:** The fields in the table below are ordered according to their order in the CSV feed file. The parent is provided for XML fields in order to make it easier to locate that field in the XML feed file. | Field name | Description | | --- | --- | | CSV: `SKU`

XML: `delete.SKU` | **Required.** The product's Stock Keeping Unit (SKU). The SKU must be unique across your entire inventory.

**Type:** string

**Maximum length:** 50 characters | | CSV: `Action`

XML: `delete.action` | **Required.** The specified delete action with one of the following valid values:

* `DeleteListing`: Deletes one or more listings from **the specified** eBay marketplace/sales channel. The SKUs and associated information remain in MIP.

* `DeleteInventory`: Deletes one or more listings from **all** eBay marketplaces/sales channels. SKUs and associated information are removed from MIP.


When the DeleteInventory action deletes a SKU, if the SKU is in an active single-variation listing, the delete action ends the listing.

If the SKU is in a multiple-variation listing, it won’t end that listing, but it will remove the variation represented by the SKU.

Therefore, DeleteListing should be used if the SKU is part of an active listing, and DeleteInventory should be used if the SKU is not part of an active listing.

**Type:** string | | CSV:` Channel ID`

XML:` delete.channelID` | **Conditionally required, when using the DeleteListing action to specify sales channels.** Because the DeleteInventory action deletes listings from all channels, specifying a channel with this option has no effect.

The unique identifier of the eBay marketplace/sales channel, such as `EBAY_US`, `EBAY_GB`, or `EBAY_DE`, and others. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list. This is where the seller is listing the item.

**Type:** string | | CSV: `Format`

XML: `delete.format` | **Optional.** The listing format.

A string with this valid value:

* `FIXED_PRICE`

* `AUCTION`


**Type:** string | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # RefundStatusType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) RefundStatusType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ======================================================================================================================== Enumerated type that indicates the current status of a seller's refund to a buyer. Types that use RefundStatusType: [ActualRefundDetailType](https://developer.ebay.com/Devzone/return-management/CallRef/types/ActualRefundDetailType.html) , [IssueRefundResponse](https://developer.ebay.com/Devzone/return-management/CallRef/types/IssueRefundResponse.html) Calls that use one or more values of RefundStatusType: [getReturnDetail](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnDetail.html) , [issueRefund](https://developer.ebay.com/Devzone/return-management/CallRef/issueRefund.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | FAILED | This value indicates that the seller's refund to the buyer failed. | | PENDING | This value indicates that the seller's refund to the buyer is pending. This value is commonly returned if the payment method was eCheck. | | SUCCESS | This value indicates that the seller's refund to the buyer was successful. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # BaseServiceResponse - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product-metadata/ReleaseNotes.html) BaseServiceResponse =================== Base response container for all service operations. Contains error information associated with the request. Calls that use BaseServiceResponse: [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) , [getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html) , [getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ ack ( _[AckValue](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/AckValue.html) _ ) [\[1\]](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Indicates whether or not errors or warnings were generated during the processing of the request. See the [Field Index](https://developer.ebay.com/DevZone/product-metadata/CallRef/fieldindex.html#ack) to learn which calls use ack. errorMessage ( _[ErrorMessage](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/ErrorMessage.html) _ ) [\[0..1\]](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. See the [Field Index](https://developer.ebay.com/DevZone/product-metadata/CallRef/fieldindex.html#errorMessage) to learn which calls use errorMessage. timestamp ( _[dateTime](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#dateTime) _ ) [\[0..1\]](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#multiplicity) This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. See the [Field Index](https://developer.ebay.com/DevZone/product-metadata/CallRef/fieldindex.html#timestamp) to learn which calls use timestamp. version ( _[string](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/simpletypes.html#multiplicity) The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. **Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. See the [Field Index](https://developer.ebay.com/DevZone/product-metadata/CallRef/fieldindex.html#version) to learn which calls use version. --- # Buy online and pick up in store | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-buy-online-pick-up-in-store.html#mainContent) The buy online, pick up in store (BOPIS) feature is generally used only by large merchants who have physical stores where products are stocked and buyers can pick them up at the store. When you are successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of your stores that has stock available will see the "Available for In-Store Pickup" option on the listing, along with information about the closest store that has the item. Requirements and restrictions ----------------------------- * At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings. * The 'In-Store Pickup' feature is only available on the eBay US site. An equivalent feature, 'Click and Collect' is available on the eBay-UK, eBay-AU, and eBay-DE sites. Before using this feature, you must: * In the US, be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup * In the UK, Australia, and Germany, be eligible for the Click and Collect feature to list an item that is eligible for Click and Collect * Have inventory for the product at one or more physical stores tied to your seller account * Include your seller-defined SKU for the product(s) in each listing. * In a single-variation listing, enter the SKU value in the Item.SKU field. * In a multiple-variation listing, enter the SKU value(s) in the Item.Variations.Variation.SKU field(s). * Set an immediate payment requirement on the item. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Relist using different API versions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-api-versions.html#mainContent) When relisting, you may get an error about certain elements not being specified. It is possible for this to occur when an item is initially listed with an older version and then relisted with a newer version. There may be little or no mapping from older tags to newer tags and thus the old listing does not contain enough information to be successfully relisted with the newer version (for example, details related to shipping or to item specifics). One solution would be to relist the item with the older version. However, that requires knowing what version is best, and you might not have been the one who originally listed the item. Troubleshooting tips: * Try relisting the item with a lower version. * View or even relist the item via the eBay marketplace; sometimes the marketplace provides information not available via API, information that might give insights into a possible solution. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Test/preview a relisting | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-preview.html#mainContent) An application can test/preview the relisting of an item by using [VerifyRelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) rather than [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) . [VerifyRelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) uses the same inputs, logic, and validation, and returns the same values as [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) without actually relisting the item. By using [VerifyRelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) , an application can test the item definition for validity as well as preview the estimated fees before the item is actually relisted. During testing, review the [Errors](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#Response.Errors) node returned in the [VerifyRelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) response for any indication that a [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) attempt will be unsuccessful. Specifically, review the following fields: * [Errors.ShortMessage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#Response.Errors.ShortMessage) * [Errors.LongMessage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html#Response.Errors.LongMessage) **Note:** Refer to [VerifyAddItem Returns Success with No Errors, but AddItem Returns Failure with Errors](https://developer.ebay.com/support/kb-article?KBid=912) , which is based on the [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) and [VerifyAddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyAddItem.html) calls, for more information. Once tested, an application can then use the [ItemType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ItemType.html) from testing as the input for the [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) call to actually relist the item. For complete information refer to: * [RelistItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/RelistItem.html) reference documentation * [VerifyRelistItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/VerifyRelistItem.html) reference documentation. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # AckValue - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) AckValue ( [string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) ) ================================================================================================================== 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. Type that uses AckValue: [BaseResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/BaseResponse.html) Calls that use one or more values of AckValue: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | 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. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/business-policies/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # Response files | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#mainContent) When you upload a feed to eBay, MIP processes the feed file and then generates a response file that confirms what you uploaded and reports whether MIP successfully processed the information. Commonly used response file types include: * Product * Availability * Distribution * Combined If an error occurs and the upload is not successful, MIP generates an error message that includes detailed information about the error and what caused it. This helps you identify the issue and correct the feed for subsequent upload attempts. Response files are in the same format as the feed you upload. If your feed is a CSV file, the response file will also be CSV; if your feed is XML, the response file will be XML. See examples in [eBay response file samples](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-sample-files.html#ebay-response-file-samples) . Obtaining a response file ------------------------- You can download response files either with the MIP user interface or with the SFTP file server (see [FTP setup](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-setup-ftp-setup.html) ). To download response files with the MIP user interface: 1. On the feed type page (such as Product), locate the table entry for the desired file upload. 2. In the **Results file** column, click the **Download** link. 3. If you are prompted to do so, choose whether to open the file in a browser or download and save the file to your computer. To download response files from the MIP file server: 1. In the feed type folder (for example, the Product folder), open the Output subfolder. 2. Locate and open the subfolder labeled with the time stamp that corresponds to the time when you uploaded the feed file. 3. Locate the response file for the upload. Use the FTP client to download the response file to your computer. When to use a response file --------------------------- eBay recommends that you download the response files after each upload to make sure that your listings are complete and displayed as intended. Contents of a response file --------------------------- Response files contain these elements: * RequestID (available only in XML files): The file identifier. If you encounter errors and need to contact technical support, this number will help them identify the feed file that didn't upload properly. * Status: Tells whether each item uploaded successfully or not. If an item has an error or warning, a message will describe the problem encountered. * Various elements that are unique to each feed type. ### XML feedSummary container All XML response files return a **feedSummary** container. See the following sample. SUCCESS 40777 AVAILABILITY availability.xml-Jul-20-2023-14-50-06-0700 2 2 0 The following table explains the elements in the container. | Element | Description | | --- | --- | | `status` | The value returned in this field indicates if the submitted feed request file was processed successfully. Value will either be `SUCCESS` or `FAILED`. | | `feedID` | The unique identifier of the feed request file. Also referred to as the Request ID. | | `feedType` | The type of feed files used to create or update the eBay listings. Different feed types are used that contain product details, price and quantity, and more. | | `inputFilename` | The name of the Product feed request file, with a timestamp appended to the end of seller-defined filename.
For example:` ProductFeed123.xml-Jul-31-2023-13-50-32-0700` | | `counts` | This container consists of the **counts.total**, **counts.success**, and the **counts.failed** fields. | | `counts.total` | The total number of SKUs in the feed. | | `counts.success` | The number of SKUs that were processed successfully. | | `counts.failed` | The number of SKUs that failed to be processed successfully. | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Product Services Tutorials - Product API Product API * [Features Guide](https://developer.ebay.com/DevZone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/DevZone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product/ReleaseNotes.html) Product Services Tutorials ========================== There are no tutorials available specifically for the Product API or Product Metadata API. If you are new to eBay APIs, you should try the ["Getting Started with the Finding API" tutorial for PHP (name-value pair request and XML response)](http://developer.ebay.com/DevZone/finding/HowTo/GettingStarted_PHP_NV_XML/GettingStarted_PHP_NV_XML.html) . If you want to adapt an existing tutorial for the Product API or Product Metadata API, consult [Making an API Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) for information about the endpoints, supported request and response formats, and HTTP headers used with the Product API and Product Metadata API. --- # Marketplace enumerated values | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html#mainContent) This topic defines enumerated values that indicate the different eBay marketplace sites. | Value | Description | | --- | --- | | `EBAY_US` | The eBay Marketplace is the US site (ebay.com). | | `EBAY_MOTORS` | The eBay Marketplace is the US eBay Motors site (ebay.com/motors). | | `EBAY_CA` | The eBay Marketplace is the Canada (English) site (ebay.ca). | | `EBAY_UK` | The eBay Marketplace is the UK site (ebay.co.uk). | | `EBAY_AU` | The eBay Marketplace is the Australia site (ebay.com.au). | | `EBAY_AT` | The eBay Marketplace is the Austria site (ebay.at). | | `EBAY_BE` | The eBay marketplace is the Belgium (Dutch) site (www.ebay.be). | | `EBAY_FR` | The eBay Marketplace is the France site (ebay.fr). | | `EBAY_DE` | The eBay Marketplace is the Germany site (ebay.de). | | `EBAY_IT` | The eBay Marketplace is the Italy site (ebay.it). | | `EBAY_NL` | The eBay Marketplace is the Netherlands site (ebay.nl). | | `EBAY_ES` | The eBay Marketplace is the Spain site (ebay.es). | | `EBAY_CH` | The eBay Marketplace is the Switzerland site (ebay.ch). | | `EBAY_TW` | The eBay Marketplace is the Taiwan site (ebay.com/tw). | | `EBAY_CZ` | The eBay Marketplace is the Czech Republic site (ebay.com/sch/Czech-Republic). | | `EBAY_DK` | The eBay Marketplace is the Denmark site (ebay.com/sch/Denmark). | | `EBAY_FI` | The eBay Marketplace is the Finland site (ebay.com/sch/Finland). | | `EBAY_GR` | The eBay Marketplace is the Greece site (ebay.com/sch/Greece). | | `EBAY_HK` | The eBay Marketplace is the Hong Kong site (ebay.com.hk). | | `EBAY_HU` | The eBay Marketplace is the Hungary site (ebay.com/sch/Hungary). | | `EBAY_IN` | The eBay Marketplace is the India site (ebay.in).

**Note:** eBay India is no longer a functioning eBay marketplace. | | `EBAY_ID` | The eBay Marketplace is the Indonesia site (id.ebay.com). | | `EBAY_IE` | The eBay Marketplace is the Ireland site (ebay.ie). | | `EBAY_IL` | The eBay Marketplace is the Israel site (ebay.com/sch/Israel). | | `EBAY_MY` | The eBay Marketplace is the Malaysia site (ebay.com/my). | | `EBAY_NZ` | The eBay Marketplace is the New Zealand site (ebay.com/sch/New-Zealand). | | `EBAY_NO` | The eBay Marketplace is the Norway site (ebay.com/sch/Norway). | | `EBAY_PH` | The eBay Marketplace is the Philippines site (ebay.ph). | | `EBAY_PL` | The eBay Marketplace is the Poland site (ebay.pl). | | `EBAY_PT` | The eBay Marketplace is the Portugal site (ebay.com/sch/Portugal). | | `EBAY_PR` | The eBay Marketplace is the Puerto Rico site (ebay.com/sch/Puerto-Rico). | | `EBAY_RU` | The eBay Marketplace is the Russia site (ebay.com/sch/Russia). | | `EBAY_SG` | The eBay Marketplace is the Singapore site (ebay.com/sg). | | `EBAY_ZA` | The eBay Marketplace is the South Africa site (ebay.com/sch/South-Africa). | | `EBAY_SE` | The eBay Marketplace is the Sweden site (ebay.com/sch/Sweden). | | `EBAY_TH` | The eBay Marketplace is the Thailand site (export.ebay.co.th). | | `EBAY_VN` | The eBay Marketplace is the Vietnam site (ebay.vn). | | `EBAY_CN` | The eBay Marketplace is the China site (ebay.com/sch/China). | | `EBAY_PE` | The eBay Marketplace is the Peru site (ebay.com/sch/Peru). | | `EBAY_JP` | The eBay Marketplace is the Japan site (ebay.co.jp). | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Simple Schema Types - Return Management API Return Management API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) Simple Schema Types =================== The eBay Schema makes use of many simple schema types. Further, some eBay-defined types (e.g., [Amount](https://developer.ebay.com/Devzone/return-management/CallRef/types/Amount.html) ) are based on simple schema types. Except where specified, the data types in the table below follow the conventions for XML Schema simple types as described by the World Wide Web Consortium in [XML Schema Part 2: Datatypes](http://www.w3.org/TR/xmlschema-2/) . | Data Type | Description | | --- | --- | | anyURI | Specifies a Uniform Resource Identifier (URI), a compact sequence of characters that identifies an abstract or physical resource.

The anyURI type is used most often to specify Uniform Resource Locators (URLs), such as a web page URL (e.g., ViewItemURL) or a file location URL (e.g., PictureURL), but can also be used for email addresses and other valid URI schemes. | | boolean | Specifies binary-valued logic (true/false). Possible input values are true, false, 1, and 0. Possible output values are true and false only (not 1 or 0). | | dateTime | A specific instant of time.

Date-time values are in the ISO 8601 date and time format. Hours are in 24-hour format (e.g., 2:00:00pm is 14:00:00). Unless otherwise specified, all date-time values are recorded in Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT) or Zulu (because the time portion of the time stamp ends with a Z). That is, time values do not reflect the time zone shown on the eBay Web site. Here is an example of the date-time format:

YYYY-MM-DDTHH:MM:SS.SSSZ (e.g., 2004-08-04T19:09:02.768Z)

See [Time Values](https://developer.ebay.com/Devzone/guides/features-guide/default.html#basics/DataTypes.html#TimeValues)
for information about how to convert between local time zones and GMT.

We use the dateTime data type to convey start and end times, the official eBay time, and other time values. | | decimal | A decimal value of arbitrary precision.

In the API, most fields of type decimal can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Decimal values should never include a thousands separator.

A whole number (i.e., without a period) can be passed as a decimal value.

We typically use the decimal data type to convey values related to units of measure. See individual topics for specific restrictions beyond this for fields of type decimal. | | double | A double-precision 64-bit floating point type.

In the API, most fields of type double can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Double values should never include a thousands separator.

We typically use the double data type to convey values related to monetary amounts. See AmountType, below.

In some cases, a whole number (i.e., without a period) can be passed or returned as a double value. See individual topics for specific restrictions beyond this for fields of type double. | | duration | A length of time.

Duration values are in the ISO 8601 duration format, where P represents "Period", nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes, and nS the number of seconds. So P2DT23H32M51S means "A period of 2 days, 23 hours, 32 minutes, and 51 seconds".

PnYnMnDTnH nMnS (e.g., P2DT23H32M51S)

We use the duration data type to convey values like the time left until a listing ends. For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). | | float | A single-precision 32-bit floating point type.

In the API, most fields of type float can contain the digits 0-9, a hyphen to designate negative numbers as needed, and a period (".") for the decimal separator. Float values should never include a thousands separator.

We typically use the float data type to convey values related to percentages. See individual topics for specific restrictions beyond this for fields of type float. | | int | A 32-bit integer value between -2147483648 and 2147483647.

In the API, most fields of type int can contain digits 0-9, and hyphen to indicate negative numbers. Some input fields restrict the input to particular values or a range of values. These cases are noted in the associated topic for the specific input field.

We typically use the int data type for enumerations, counts (e.g., how many items are returned), quantities, certain kinds of IDs (other IDs are strings), and similar concepts. | | long | A value between -9223372036854775808 and 9223372036854775807. | | positiveInteger | An integer value greater than or equal to 1. | | string | A string of characters. All characters in the Unicode character set are supported.

Character entity references are used for escaping markup-significant characters. For example, use & for the & (ampersand) character, < for the < (less-than sign) character, and > for the > (greater-than sign) character. It is a good idea to escape such characters in requests instead of using a CDATA construct. Responses from eBay do not include CDATA constructs.

Note that messages from eBay may contain HTML or XML markup within the message text. In this case, the markup elements within the text are escaped (e.g., <!\[CDATA\[ ... \]\]>).

Some string input fields (e.g., [keywords](https://developer.ebay.com/Devzone/return-management/CallRef/findItemsByKeywords.html#Request.keywords)
) do not have a known set of possible values. For these fields, the documentation specifies the maximum permitted length in characters. If you are using a URL for your request, and you need to use the & (ampersand) character as part of a string value (e.g. Bausch & Lomb in xxxkeywords), use &.

xs:string is part of the XML schema namespace defined as:

xmlns:xs="http://www.w3.org/2001/XMLSchema" | | token | A set of normalized strings.

In the API, this type of string contains no white space, by convention.

We typically use token to constrain a field to a specified set of normalized string values. For such a field, we define these values in an enumeration that uses token as its base type. | | [Amount](https://developer.ebay.com/Devzone/return-management/CallRef/types/Amount.html) | An eBay-defined complex type for specifying monetary amounts.

A double value (e.g., 1.00 or 1.0) is meaningful as an amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency.

In the API, an object of type Amount expresses both the value (a decimal) and the currency.

We typically use the Amount data type to specify details such as prices, fees, costs, and payments.

In some cases, a whole number (i.e., without a period) can be passed or returned as a monetary value. This is necessary to support certain currencies that are only expressed as whole numbers (like the Italian Lira and Spanish Peseta).

Because a double is used to represent the amount, this also means whole monetary amounts may be returned with only one 0 after the decimal. For example, a dollar value could be returned as 5.0 instead of 5.00 in calls like [findItemsByKeywords](https://developer.ebay.com/Devzone/return-management/CallRef/findItemsByKeywords.html)
. See individual topics for specific restrictions beyond this for fields of type Amount. | Repeatable (Unbounded) Fields ----------------------------- If the multiplicity of an element is defined as maxOccurs="unbounded" or a value greater than 1 in the schema, it means you can specify the field multiple times in a request (like you are specifying an array), or eBay can return the field multiple times in the response. In this case, the fields must be contiguous. That is, in a request, you cannot insert other fields between the repeating fields. Otherwise, some of the data will be dropped in an unpredictable manner. For example, **findItemsByKeywords** can return multiple items. Here is the definition of the **item** element in the **searchResult** schema (SearchResult complexType): In the response, the **item** fields are always contiguous, with no other fields between them: ... 170192529715 ... 330233123051 ... 320247274638 ... ... ... If you are using URL-style input or Name-Value Pair input, repeatable fields can be expressed with a comma-separated format **in most cases**. Multiplicity Notation --------------------- | Sample XML notation | Corresponding doc notation | Meaning § | | --- | --- | --- | | minOccurs="0" maxOccurs="unbounded" | \[0..\*\] | Zero or more | | minOccurs="0" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="1" | \[0..1\] | Zero or one | | minOccurs="0" maxOccurs="6" | \[0..6\] | Zero to six | §  While this is the general meaning, be sure to read the description of the particular field: it may state an exception for a particular use. --- # ShipmentType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ShipmentType ============ This type is used to provide detailed information on shipment of a return item. Type that uses ShipmentType: [ReturnDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnDetailType.html) Calls that use ShipmentType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ allShipmentTrackings ( array of _[ShipmentTrackingType](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container is an array of shipment tracking information for a return item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#allShipmentTrackings) to learn which calls use allShipmentTrackings. payee ( _[ReturnUserRoleEnum](https://developer.ebay.com/devzone/post-order/types/ReturnUserRoleEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This enumeration value indicates whether the buyer or seller will be paying for shipment of item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#payee) to learn which calls use payee. shipmentTracking ( _[ShipmentTrackingType](https://developer.ebay.com/devzone/post-order/types/ShipmentTrackingType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides detailed information on the whereabouts of a shipped item, including tracking number, origin and destination address, shipping status, estimated and actual shipping and delivery dates, and more. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#shipmentTracking) to learn which calls use shipmentTracking. shippingLabelCost ( _[ReturnShippingCostDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnShippingCostDetailType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides the itemized list of costs associated with shipping the item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#shippingLabelCost) to learn which calls use shippingLabelCost. --- # Provides Return Address - eBay Post-Order API Reference eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/Devzone/post-order/ReleaseNotes.html) Provides Return Address ======================= POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address -------------------------------------------------------------------- **Note:** This call has been deprecated and will be decommissioned on March 2, 2026. This method can be used on behalf of sellers to provide the correct return address to the buyer. If applicable, and requested by the buyer, the seller can also provide the Return Merchandise Authorization (RMA) number to the buyer through the request payload. This method is not supported in the Sandbox environment. Input ----- See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Samples) . #### Resource URI (production) POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/provide\_return\_address #### URI parameters | Parameter | Type | Required? | Meaning | | --- | --- | --- | --- | | **caseId** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Required | The unique identifier of a case. This URI parameter is required in order to identify the case for which the seller is providing a return address and or an RMA number. The case ID value is passed in as part of the call URI. | #### HTTP request headers All requests made to eBay REST operations require you to provide the `authorization` HTTP header for authentication. See [HTTP request headers](https://developer.ebay.com/ebay-rest/content/rest-request-components.html#HTTP) for details. #### Authorization This call uses standard authorization tokens. See [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) for details. #### Payload model The following lists _all fields that could be included_ in the request. { /\* _[ReturnAddressRequest](https://developer.ebay.com/Devzone/post-order/types/ReturnAddressRequest.html) _ \*/ "[firstName](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.firstName) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[lastName](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.lastName) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[returnAddress](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress) ": { /\* [Address](https://developer.ebay.com/Devzone/post-order/types/Address.html) \*/ "[addressLine1](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.addressLine1) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[addressLine2](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.addressLine2) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[addressType](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.addressType) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[city](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.city) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[country](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.country) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[county](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.county) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[isTransliterated](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.isTransliterated) ": [boolean](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#boolean) , "[nationalRegion](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.nationalRegion) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[postalCode](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.postalCode) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[script](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.script) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[stateOrProvince](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.stateOrProvince) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[transliteratedFromScript](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.transliteratedFromScript) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) , "[worldRegion](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.returnAddress.worldRegion) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) }, "[RMA](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Request.RMA) ": [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) } #### Request field descriptions | Input Container/Field | Type | Occurrence | Meaning | | --- | --- | --- | --- | | **firstName** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | The first name associated with the seller's return address, or if applicable, a business or store name.

If a first name or business/store name is defined for the return address, this field should be included in the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** request. | | **lastName** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | The last name associated with the seller's return address.

If a last name is defined for the return address, this field should be included in the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** request. | | **returnAddress** | [Address](https://developer.ebay.com/Devzone/post-order/types/Address.html) | Required | The full return address is provided in this container. This container is required to be in the **POST /post-order/v2/casemanagement/{caseId}/provide\_return\_address** request. | | returnAddress.**addressLine1** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | The first line of the street address. The first line of the street address is always used by containers using the **Address** type. | | returnAddress.**addressLine2** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | The second line of the street address. This field is not always used, but it should be provided if applicable. It might be used for something like 'Suite Number' or 'Apt Number'. | | returnAddress.**addressType** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | This enumeration value indicates whether the address is a business, a personal address, PO Box, or other type of address. This field is not always used by containers using the **Address** type.

The list of enumeration values that may be returned in this field are defined in the [AddressTypeEnum](https://developer.ebay.com/devzone/post-order/types/AddressTypeEnum.html)
type definition.

**Applicable values**: See [AddressTypeEnum](https://developer.ebay.com/Devzone/post-order/types/AddressTypeEnum.html) | | returnAddress.**city** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | The city of the address. This field is always used by containers using the **Address** type. | | returnAddress.**country** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the **Address** type.

The list of two-digit country codes that may be returned in this field are defined in the [CountryCodeEnum](https://developer.ebay.com/devzone/post-order/types/CountryCodeEnum.html)
type definition.

**Applicable values**: See [CountryCodeEnum](https://developer.ebay.com/Devzone/post-order/types/CountryCodeEnum.html) | | returnAddress.**county** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | The county of the address. This field is not always used, but it should be provided if applicable. | | returnAddress.**isTransliterated** | [boolean](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#boolean) | Optional | This Boolean field is returned as `true` if language transliteration was required. | | returnAddress.**nationalRegion** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | This string value indicates a specific region or metropolitan area within a country in which the address resides. Not all countries have defined national regions. | | returnAddress.**postalCode** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | The postal code of the address. This field is always used by containers using the **Address** type. | | returnAddress.**script** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the **isTransliterated** field is `true`. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

The list of language enumeration values that may be returned in this field are defined in the [LanguageScriptEnum](https://developer.ebay.com/devzone/post-order/types/LanguageScriptEnum.html)
type definition.

**Applicable values**: See [LanguageScriptEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageScriptEnum.html) | | returnAddress.**stateOrProvince** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | The state or province of the address. This field is always used by containers using the **Address** type. | | returnAddress
  .**transliteratedFromScript** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the **isTransliterated** field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

The list of language enumeration values that may be returned in this field are defined in the [LanguageScriptEnum](https://developer.ebay.com/devzone/post-order/types/LanguageScriptEnum.html)
type definition.

**Applicable values**: See [LanguageScriptEnum](https://developer.ebay.com/Devzone/post-order/types/LanguageScriptEnum.html) | | returnAddress.**worldRegion** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Optional | This string value indicates the region of the world in which the address resides. This field is not always used by containers using the **Address** type.

The list of world region enumeration values that may be returned in this field are defined in the [WorldRegionEnum](https://developer.ebay.com/devzone/post-order/types/WorldRegionEnum.html)
type definition.

**Applicable values**: See [WorldRegionEnum](https://developer.ebay.com/Devzone/post-order/types/WorldRegionEnum.html) | | **RMA** | [string](https://developer.ebay.com/Devzone/post-order/types/simpletypes.html#string) | Conditional | The Return Merchandise Authorization (RMA) number associated with the item to be returned. An RMA number is a unique identifier that is provided by a manufacturer and authorizes the return of an item. This field is conditionally required if there is an RMA number associated with the item, and if the buyer is requesting an RMA number. | Output ------ See also [Samples](https://developer.ebay.com/Devzone/post-order/post-order_v2_casemanagement-caseId_provide_return_address__post.html#Samples) . #### Payload model This call has no response payload. null Samples ------- New to making API calls? Please see [Making a Call](https://developer.ebay.com/Devzone/post-order/concepts/MakingACall.html) . 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. Sample: Basic Call Seller provides an alternate return address to the buyer. **Description** The buyer will be returning an item, but the seller does not want the buyer to return the item to the default return address listed for the seller. The seller uses this call to provide the return address where the buyer will ship the return item. **Input** The seller passes in the case ID value as a path parameter to identify the case for which an alternate return address is being provided to the buyer. The **firstName** field is used to provide the name that should appear on the return shipment. The **returnAddress** container displays the correct address that the buyer will use to return the item. **URL format**. See also the [non-wrapped](https://developer.ebay.com/Devzone/post-order/Samples/post-order_v2_casemanagement-caseid_provide_return_address__post_basic_in_url_json.txt) version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/5\*\*\*\*\*\*\*\*3/provide\_return\_address { "firstName": "e\*\*\*\*\*\*\*\*\*\*\*1", "returnAddress": { "addressLine1": "2\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*e", "addressType": "BUSINESS", "city": "San Jose", "country": "US", "postalCode": "9\*\*\*5", "stateOrProvince": "California" } } **Output** There is no output payload with this response. A successful call contains an HTTP status code of 200. **JSON format**. Change History -------------- | Change Date | Description | | --- | --- | --- # BaseResponse - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) BaseResponse ============ Base response container for all service operations. Contains error information associated with the request. Calls that use BaseResponse: [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ [ack](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html#ack) ( _[AckValue](https://developer.ebay.com/devzone/business-policies/CallRef/types/AckValue.html) _ ) [errorMessage](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html#errorMessage) ( _[ErrorMessage](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorMessage.html) _ ) [extension](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html#extension) ( _[ExtensionType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ExtensionType.html) _ ) [timestamp](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html#timestamp) ( _[dateTime](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#dateTime) _ ) [version](https://developer.ebay.com/devzone/business-policies/CallRef/types/BaseResponse.html#version) ( _[string](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) ack ( _[AckValue](https://developer.ebay.com/devzone/business-policies/CallRef/types/AckValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#ack) to learn which calls use ack. errorMessage ( _[ErrorMessage](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorMessage.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Information for an error or warning that occurred when eBay processed the request. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#errorMessage) to learn which calls use errorMessage. extension ( _[ExtensionType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ExtensionType.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Reserved for future use. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#extension) to learn which calls use extension. timestamp ( _[dateTime](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#dateTime) _ ) [\[0..1\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) 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). See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#timestamp) to learn which calls use timestamp. version ( _[string](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the [Field Index](https://developer.ebay.com/devzone/business-policies/CallRef/fieldindex.html#version) to learn which calls use version. --- # Order fulfillment response file definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-order-fulfillment-feed.html#mainContent) An order fulfillment response tells you if all the data in an order fulfillment feed was processed successfully or not. Sample response files: * [order-fulfillment-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/order-fulfillment-response.csv) * [order-fulfillment-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/order-fulfillment-response.xml) **Note:** The fields in the table below are ordered according to their order in the CSV response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML response file. | Field name | Description | | --- | --- | | CSV: `Order ID`

XML:

`orderFulfillmentDetail.OrderID` | The unique identifier of an order that was updated in an order fulfillment feed.

**Occurrence**: Always Returned | | CSV: `Line Item ID`

XML:

`orderFulfillmentDetail.lineItemID` | The unique identifier of an order line item. Included if a lineItemID was processed in an order fulfillment feed.

**Occurrence**: Conditionally Returned | | CSV: `Logistics Status`

XML:

`` orderFulfillmentDetail.`logisticsStatus` `` | This value indicates the logistics status updated applied to the order or line item.

**Occurrence**: Always Returned | | CSV: `Status`

XML:

`` orderFulfillmentDetail.`Status` `` | The result of the action requested in the uploaded feed:

* `SUCCESS`: The logistics action has been successfully applied to the order or line item.
* `FAILED`: The logistics action applied to the order or line item has failed. Check if there is an available error **message**.

**Occurrence**: Always Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue creating or updating the order fulfillment.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue creating or updating the order fulfillment.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue creating or updating the order fulfillment. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Additional container in XML response ------------------------------------ In addition to the fields called out in the table above, the feed response file will also have a **feedSummary** container. See [XML feedSummary container](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#XML) for details. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Specify a return policy | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/specify-return-policy.html#mainContent) A return policy is required for auction and fixed-price listings in most categories. Sellers can choose not to accept returns, but they must still specify this policy clearly. Sellers opted into and using [Business Policies](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/business-policies.html) _do not_ use the [Item.ReturnPolicy](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ReturnPolicy) container, but instead will specify the return business policy to use through the [Item.SellerProfiles.SellerReturnProfile](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.SellerProfiles.SellerReturnProfile) field. **Argument:** [Item.SellerProfiles.SellerReturnProfile](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.SellerProfiles.SellerReturnProfile) Add a return policy to a listing -------------------------------- To include your return policy in a listing: 1. To determine which categories require a return policy call [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) for the marketplace on which an item is to be listed. In most cases, when the value of [ReturnPolicyEnabled](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ReturnPolicyEnabled) is `true` a return policy is required. However, for the eBay Australia (AU) and US eBay Motors Parts and Accessories marketplaces, most categories support but _do not require_ a return policy. If either the primary or secondary category in the listing requires a return policy, then the listing must include a return policy. 2. For the marketplace on which the item will be listed, call [GeteBayDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) to determine which return policy fields are supported and which values are supported. Set the value of the [DetailName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Request.DetailName) argument to `ReturnPolicyDetails`. Review the [ReturnPolicyDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ReturnPolicyDetails) field in the response as this container will contain all of the supported values for return policies. 3. If your application includes a user interface, present the available return policy options. 4. When listing the item using [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) or related calls, specify the supported values returned in [GeteBayDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) into the corresponding return policy options in the [Item.ReturnPolicy](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ReturnPolicy) fields. * Set the value for the [Item.ReturnPolicy.ReturnsWithinOption](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ReturnPolicy.ReturnsWithinOption) argument to the number of days a buyer has to return or exchange the item. Refer to [ReturnsWithinOptionsCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ReturnsWithinOptionsCodeType.html) for the list of supported values. * Set the value for the [Item.ReturnPolicy.RefundOption](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ReturnPolicy.RefundOption) to the desired refund policy (e.g., Money Back). Refer to [RefundOptionsCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/RefundOptionsCodeType.html) for the list of supported values. To verify which [Item.ReturnPolicy.ReturnsWithinOption](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ReturnPolicy.ReturnsWithinOption) and [Item.ReturnPolicy.RefundOption](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ReturnPolicy.RefundOption) values are allowed for a specific marketplace, call [GeteBayDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) and set the value of the [DetailName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Request.DetailName) argument to `ReturnPolicyDetails`. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Specify shipping options | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/specify-shipping-options.html#mainContent) Shipping functionality is achieved through the use of various containers, fields, types, and values. At listing time, the seller selects between using flat-rate shipping or calculated shipping. For flat-rate shipping, the seller specifies all shipping costs upfront based on the buyer's location and the shipping service selected by the buyer. For calculated shipping, eBay calculates shipping based on the following information: * The specific shipping service option selected by buyer (e.g., **USPS Priority**,) * The buyer’s location, * The package weight and dimensions. Refer to [Shipping](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-info.html) for complete information about shipping options and services. Set shipping details -------------------- When adding or revising a listing via the Add Item family of calls, the [Item.ShippingDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ShippingDetails) container is used to specify shipping information. For domestic or international shipments, available service options and the associated cost when using flat-rate shipping are specified using: * **Domestic shipping:** [Item.ShippingDetails.ShippingServiceOptions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ShippingDetails.ShippingServiceOptions) * **International shipping:** [Item.ShippingDetails.InternationalShippingServiceOption](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ShippingDetails.InternationalShippingServiceOption) Ship-to locations ----------------- Sellers can indicate where, by geographical region, the item may be shipped. A separate [Item.ShipToLocations](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ShipToLocations) argument must be included for each location where an item may be shipped. A ship-to location can be a geographical region (e.g., North America, Europe,) or a country (e.g., the US, Canada). A seller can also use `Worldwide` as a ship-to location, but then use one or more [Item.ShippingDetails.ExcludeShipToLocation](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ShippingDetails.ExcludeShipToLocation) arguments to exclude some geographical regions and/or countries. **Important!** Any shipping exclusions specified through this field can be overridden by the eBay International Shipping exclusions toggle located under **Shipping Preferences** in **My eBay**. For more information on eBay International Shipping, see [eBay International Shipping program](https://www.ebay.com/help/selling/shipping-items/setting-shipping-options/ebay-international-shipping-program?id=5348) . To determine which shipping locations are valid for a marketplace, call [GeteBayDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) and set the value of [DetailName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Request.DetailName) to `ShippingLocationDetails`. **Argument:** [Item.ShipToLocations](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ShipToLocations) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Administratively ended listings | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-admin-ended.html#mainContent) Sellers can view a list of any administratively ended listings by calling [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) and configuring the request parameter [AdminEndedItemsOnly](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.AdminEndedItemsOnly) = `true`. All other specified filters are ignored. **Note:** Information about administratively ended listings is returned **only** to the seller of the item. For each listing that is returned, the following [ItemArray.Item.ItemPolicyViolation](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.ItemPolicyViolation) information is included: * [ItemArray.Item.ItemPolicyViolation.PolicyID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.ItemPolicyViolation.PolicyID) The Policy ID for the violated policy. * [ItemArray.Item.ItemPolicyViolation.PolicyText](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.ItemPolicyViolation.PolicyText) A brief description of the violated policy. Policy violation information (i.e., [Item.ItemPolicyViolation.PolicyID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ItemPolicyViolation.PolicyID) and [Item.ItemPolicyViolation.PolicyText](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ItemPolicyViolation.PolicyText) ,) may also be retrieved for a single listing by issuing [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) and specifying the [ItemID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Request.ItemID) for the specific listing. Relisting eligibility --------------------- [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) and [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) also indicate if items that have been administratively ended are eligible to be relisted by via the boolean response [Item.SellingStatus.AdminEnded](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.AdminEnded) field. When this field returns a value of `true`, the item is eligible to be relisted. [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) can be used to relist items that have been administratively ended due to a violation of an eBay listing policy. Refer to [Listing policies](https://pages.ebay.com/help/policies/listing-ov.html) for more information. Using [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) is a more efficient method than issuing an [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) call. In some cases, sellers may be able to relist partially sold multiple-quantity listings which have been prematurely removed from the marketplace depending upon the specific violation. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Business Policies Management API | Index eBay Business Policies Management API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) eBay Business Policies Management API Tutorials =============================================== No tutorials have been created specifically for the eBay Business Policies Management API. If you are new to eBay APIs, review the [Code Samples](https://go.developer.ebay.com/api-documentationcode-samples) page on the eBay Developers Program site. Click the PHP5 link to find examples of making authenticated calls, such as the **GetCategories** example. * * * --- # Business Policies Management API | Users Guide eBay Business Policies Management API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) eBay Business Policies Management API: Users Guide ================================================== **Important!** eBay recommends that you use the [Account API](https://developer.ebay.com/api-docs/sell/account/resources/methods) to set up all your fulfillment, payment, and return business policies. This guide remains active for archival purposes only. The [Business Policies Management API](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) allows sellers to create and manage business policies (payment, return, and shipping). Sellers can easily create these business policies and associate them to an eBay category group. Since every listing on eBay is linked to a category, this API will allow you to create a business policy and immediately apply it to all listings for a group of categories. By using the Business Policies Management API, sellers will no longer have to recreate, reassign, and update the same payment, return policy, and shipping settings/values for each individual listing. Managing business policies through this API will help sellers save significant time in creating and updating their listings. Business Policies are now available on all eBay sites. A seller can opt in to Business Policies through the **Sell** section in My eBay. A seller can verify whether or not their account is opted in to Business Policies by making a call to Trading API's [GetUserPreferences](http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetUserPreferences.html) , and including the **ShowSellerProfilePreferences** flag in the call request. In the **GetUserPreferences** response, the seller will look for a 'true' value in the **SellerProfilePreferences.SellerProfileOptedIn** field. Regardless of opt-in status, a seller can actually use the Business Policies Management API to create and manage business policies, but that same seller will not be able to access the Business Policies Management UI on the eBay site nor apply specific business policies to listings until the account has been opted-in to Business Policies. Once a seller is opted in to Business Policies, eBay will automatically extract and create all business policies for the seller's account based on listings created by that seller in the last 90 days. The seller then has the option to tweak (change name, change values, assign to new category groups, etc.) these existing policies or leave as is. A seller can create as many payment, return, and shipping policies as they wish. If the seller had a payment policy for Motor Vehicle listings and a payment policy for all other listings, you might see the following nodes in the **GetUserPreferences** response: ... `   5********4   PAYMENT   standardpaymentprofile   Payment policy for all non-vehicle listings        ALL    ` ... ... `   5********4   PAYMENT   vehiclepaymentprofile   Payment policy for vehicle listings        MOTORS_VEHICLE    ` ... Once a seller's account is opted into Business Policies, the payment, return, and shipping options/values set in the default business policies will automatically be set whenever the seller lists an item. It is then at the seller's discretion to modify, delete, or add new settings/values in Web flow or by using an **addSellerProfile** or **setSellerProfile** call. The seller also has the option of using/referencing another (non-default) business policy (in Web flow or through the **Item.SellerProfiles** container in an Add/Revise/RelistItem Trading API call). Overview of the Service ----------------------- The Business Policies Management API is a SOA service that is meant to be consumed by users who want to programmatically create and manage business policies. The API allows you to create payment, return, and shipping business policies. The settings/values captured in these business policies can then be automatically applied to eBay listings. When a seller lists an item, the Business Policies Management API verifies which Business Policies category group that the item belongs to (based on the eBay category the item is listed under), and then retrieves and applies the default business policies for that Business Policies category group. Previous to the concept of business policies, a seller had to specify and update payment, return, and shipping settings/values for each individual listing. This meant that the seller had to enter the same information repeatedly for each listing. With Business Policies, a seller can partially automate (through Web flow or through Trading API's Add/Revise/Relist calls) the process of listing, revising, or relisting an item. ### About Category Groups The **categoryGroup** container in Business Policies Management API calls defines a group of eBay categories and connects this category group to a business policy. This allows seller to create one business policy that can be applied to many categories. The relationship between a **categoryGroup** container and a business policy is: * One business policy can be associated with multiple category groups. * A category group can be associated with many business policies. Currently, the valid values for a category group names are 'ALL' (all non- motor vehicle categories) and 'MOTORS\_VEHICLE' (all motor vehicle categories). The 'MOTORS\_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. In the future, there may be other valid values for category group names. The first business policy (payment, return, or shipping) that the seller creates (or eBay creates for the seller) for a category group becomes the default policy for that category group and policy type combination. ### Creating a Business Policy When a seller creates a business policy, the seller provides a name for the policy and eBay assigns a unique ID number (**profileId**) to a successfully created policy. Other data that the seller provides for the business policy is the category group(s) to which the business policy will apply, the eBay site where the items will be sold, and all applicable settings/values for buyer payment (for payment policies), return policy details (for return policies), and the shipping details (for shipping policies). Here are the high-level steps for creating a business policy through an **addSellerProfile** call: 1. Assign a category group to which the business policy will apply by setting the **categoryGroup.name** value to 'ALL' or 'MOTORS\_VEHICLE'. The 'MOTORS\_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. 2. Define the policy type by including the **profileType** field and setting its value to 'PAYMENT', 'RETURN\_POLICY' or 'SHIPPING'. 3. Assign a name to the business policy through the **profileName** field. It is a good idea to give the business policy a descriptive name so you can easily identify it. All business policy names should be unique within each policy type (payment, return, shipping). 4. Optionally, provide a text description of the business policy through the **profileDesc** field. 5. Optionally, provide the **siteId** value of the listing site. If this field is not provided, the **siteId** value defaults to the seller's registration site. 6. Specify the details of each policy type that is being created through the **paymentProfile.paymentInfo**, **returnPolicyProfile.returnPolicyInfo**, and/or **shippingPolicyProfile.shippingPolicyInfo** containers. ### Modifying a Business Policy To modify an existing business policy, you use the **setSellerProfile** call. First, you want to identify the payment, return, or shipping business policy to modify by providing a valid value in the **profileName** and/or **profileId** field in the request. Then, you can modify any existing value defined for a business policy or add fields to a business policy. For example, you might want to add additional **acceptedPaymentMethod** values for a payment business policy, or add a text description of the return policy through the **returnPolicyInfo.description** field, or add an additional domestic shipping service through an additional **domesticShippingPolicyInfoService** container. **Note:** Modifying an existing business policy creates a 'clone' of that business policy, and all listings that referenced the previous business policy are reassigned to the new business policy. Active listings that are in restricted revise mode will be assigned to the new business policy, but values/settings will remain unchanged. Another use case for using the **setSellerProfile** call is to change the default business policy for a category group and policy type combination. It would actually require two **setSellerProfile** calls to perform this action. In the first call, you'd identify the current default business policy through the **profileId** field, identify the category group that the business policy belongs to in the **categoryGroup.name** field, and then pass in a value of 'false' in the **categoryGroup.default** field. In the second call, you'd identify the business policy that you want set as the new default business policy through the **profileId** field, identify the category group that the business policy belongs to in the **categoryGroup.name** field, and then pass in a value of 'true' in the **categoryGroup.default** field. ### Retrieving Business Policies To retrieve one or more business policies, you use the **getSellerProfiles** call. The seller has the option of retrieving all existing business policies (no input parameters), specific business policies identified by **profileId** and/or **profileName** value(s), or business policies matching the specified **profileType** value(s). ### Deleting a Business Policy To delete one business policy, you use the **removeProfile** call. To identify the business policy to delete, the seller passes in the **profileId** value. To delete multiple business policies, you use the **removeSellerProfiles** call. To identify the business policies to delete, the seller passes in multiple **profileIds** values. **Note:** A business policy that is associated to one or more active listings cannot be deleted. Instead, these listings have to be reassigned to other active business policies first using a **ReviseItem** call or the Business Policies Management UI. ### Consolidating Similar Shipping Policies Shipping business policies that have identical shipping services (with the exception of shipping costs) and identical settings (such as domestic and international shipping types, handling times, ship-to locations, rate tables, etc.) can be consolidated using the **consolidateShippingProfiles** call. When shipping business policies are consolidated, the shipping business policy that is used/referenced by the seller most frequently is kept, and the others are removed from the seller's account. Active or scheduled listings inherit the shipping business policy (and all its values/settings) that is kept after the consolidation, but the shipping costs that were specified for each shipping service in the newly deleted shipping policies are kept on the respective listings. The **consolidateShippingProfiles** call runs asynchronously. The status of a shipping policy consolidation job can be retrieved by using the **getConsolidationJobStatus** call. **Note:** As a seller continues to create numerouse listings, there's a good chance that permutations in shipping settings will continue to accumulate. Due to this reason, it is recommended that client applications are set up to execute regular **consolidateShippingProfiles** calls. ### Overriding Shipping Costs at the Listing Level The shipping costs for all domestic and international shipping services, that are defined in the **domesticShippingPolicyInfoService** and **intlShippingPolicyInfoService** containers of the shipping policy, can be overridden by supplying a **ShippingServiceCostOverrideList.ShippingServiceCostOverride** container for each domestic and international shipping service defined through the shipping policy. Shipping costs include the shipping cost to ship one item (**ShippingServiceCost** in Trading API), the shipping cost to ship each additional identical item for a multi-quantity listing (**ShippingServiceAdditionalCost** in Trading API), and a shipping surcharge if one is applicable for the shipping service (**ShippingSurcharge** in Trading API). For all domestic shipping services defined in the shipping business policy, the **ShippingServiceType** field in the **ShippingServiceCostOverrideList.ShippingServiceCostOverride** container should be set to 'Domestic', and for all international shipping services defined in the shipping business policy, the **ShippingServiceType** field should be set to 'International'. For both domestic and international shipping services, the **ShippingServicePriority** value in the **ShippingServiceCostOverrideList.ShippingServiceCostOverride** container should match the **sortOrderId** value for the matching shipping service in the shipping business policy. **Note:** Once a shipping cost value is overridden on an active listing, it remains overridden, even if its respective value is changed in the shipping business policy that is associated to that listing. ### Business Policies Eligible for eTRS If the seller meets all Top-Rated Seller requirements, and the business policy meets all Top-Rated Plus listing requirements for the listing category, an **ETRS** flag is returned in the output under the **categoryGroup** container. For more information on Top-Rated Seller and Top-Rated Plus listings, see the [Becoming a Top Rated Seller and qualifying for Top Rated Plus](http://pages.ebay.com/help/sell/top-rated.html) help topic. ### Mapping Business Policies Management API Fields to Trading API Fields In most cases, the names of data fields in the Business Policies Management API directly map to the names of data fields in the Trading API listing calls. The main difference is the initial character is lowercase in the Business Policies Management API, and the initial character is uppercase in the Trading API listing calls. The following table maps payment, return policy, and shipping-related fields in the Business Policies Management API to payment, return policy, and shipping-related fields in the Trading API listing calls. | Business Policies Management API Field | **Trading API Listing Field** | | --- | --- | | Payment Fields | | | paymentProfile.profileId | Item.SellerProfiles.SellerPaymentProfile.PaymentProfileID | | paymentProfile.profileName | Item.SellerProfiles.SellerPaymentProfile.PaymentProfileName | | paymentProfile.siteId | X-EBAY-API-SITEID HTTP header; and
siteid URL parameter | | paymentInfo.acceptedPaymentMethod (deprecated) | Item.PaymentMethods | | paymentInfo.depositDetails.daysToFullPayment | Item.PaymentDetails.DaysToFullPayment | | paymentInfo.depositDetails.depositAmount | Item.PaymentDetails.DepositAmount | | paymentInfo.depositDetails.hoursToDeposit | Item.PaymentDetails.HoursToDeposit | | paymentInfo.immediatePay | Item.AutoPay | | paymentInfo.paymentInstructions (deprecated) | Item.ShippingDetails.PaymentInstructions (deprecated) | | paymentInfo.paypalEmailAddress (deprecated) | Item.PayPalEmailAddress (deprecated) | | Return Policy Fields | | | returnPolicyProfile.profileId | Item.SellerProfiles.SellerPaymentProfile.PaymentProfileID | | returnPolicyProfile.profileName | Item.SellerProfiles.SellerReturnProfile.ReturnProfileName | | returnPolicyProfile.siteId | X-EBAY-API-SITEID HTTP header; and
siteid URL parameter | | returnPolicyInfo.description | Item.ReturnPolicy.Description | | returnPolicyInfo.refundOption | Item.ReturnPolicy.RefundOption | | returnPolicyInfo.restockingFeeValue (deprecated) | Item.ReturnPolicy.RestockingFeeValueOption (deprecated) | | returnPolicyInfo.returnsAcceptedOption | Item.ReturnPolicy.ReturnsAcceptedOption | | returnPolicyInfo.returnsWithinOption | Item.ReturnPolicy.ReturnsWithinOption | | returnPolicyInfo.shippingCostPaidByOption | Item.ReturnPolicy.ShippingCostPaidByOption | | returnPolicyInfo.warrantyDurationOption (deprecated) | Item.ReturnPolicy.WarrantyDurationOption (deprecated) | | returnPolicyInfo.warrantyOfferedOption (deprecated) | Item.ReturnPolicy.WarrantyOfferedOption (deprecated) | | returnPolicyInfo.warrantyTypeOption (deprecated) | Item.ReturnPolicy.WarrantyTypeOption (deprecated) | | Shipping Fields | | | shippingPolicyProfile.profileId | Item.SellerProfiles.SellerShippingProfile.ShippingProfileID | | shippingPolicyProfile.profileName | Item.SellerProfiles.SellerShippingProfile.ShippingProfileName | | shippingPolicyProfile.siteId | X-EBAY-API-SITEID HTTP header; and
siteid URL parameter | | shippingPolicyInfo.dispatchTimeMax | Item.DispatchTimeMax | | shippingPolicyInfo.dispatchTimeReason | No equivalent field in Trading API | | shippingPolicyInfo.domesticRateTable | Item.ShippingDetails.RateTableDetails.DomesticRateTable | | shippingPolicyInfo.domesticShippingType | No equivalent field in Trading API | | shippingPolicyInfo.excludeShipToLocation | Item.ShippingDetails.ExcludeShipToLocation | | shippingPolicyInfo.GlobalShipping | Item.ShippingDetails.GlobalShipping | | shippingPolicyInfo.internationalPackagingHandlingCosts | Item.ShippingDetails.CalculatedShippingRate.InternationalPackagingHandlingCosts | | shippingPolicyInfo.intlRateTable | Item.ShippingDetails.RateTableDetails.InternationalRateTable | | shippingPolicyInfo.intlShippingType | No equivalent field in Trading API | | shippingPolicyInfo.packagingHandlingCosts | Item.ShippingDetails.CalculatedShippingRate.PackagingHandlingCosts | | shippingPolicyInfo.shippingOption | No equivalent field in Trading API | | shippingPolicyInfo.shippingPolicyCurrency | currencyID attribute (in multiple shipping cost-related fields) | | shippingPolicyInfo.shippingPolicyName | No equivalent field in Trading API | | shippingPolicyInfo.shipToLocations | Item.ShipToLocations | | shippingPolicyInfo.domesticShippingPolicyInfoService.buyerResponsibleForPickup | No equivalent field in Trading API | | shippingPolicyInfo.domesticShippingPolicyInfoService.buyerResponsibleForShipping | Item.BuyerResponsibleForShipping | | shippingPolicyInfo.domesticShippingPolicyInfoService.fastShipping | Item.GetItFast | | shippingPolicyInfo.domesticShippingPolicyInfoService.freeShipping | Item.ShippingDetails.ShippingServiceOptions.FreeShipping | | shippingPolicyInfo.domesticShippingPolicyInfoService.shippingService | Item.ShippingDetails.ShippingServiceOptions.ShippingService | | shippingPolicyInfo.domesticShippingPolicyInfoService.shippingServiceAdditionalCost | Item.ShippingDetails.ShippingServiceOptions.ShippingServiceAdditionalCost | | shippingPolicyInfo.domesticShippingPolicyInfoService.shippingServiceCost | Item.ShippingDetails.ShippingServiceOptions.ShippingServiceCost | | shippingPolicyInfo.domesticShippingPolicyInfoService.shippingSurcharge (deprecated) | Item.ShippingDetails.ShippingServiceOptions.ShippingSurcharge (deprecated) | | shippingPolicyInfo.domesticShippingPolicyInfoService.shipToLocation | No equivalent field in Trading API | | shippingPolicyInfo.domesticShippingPolicyInfoService.sortOrderId | Item.ShippingDetails.ShippingServiceOptions.ShippingServicePriority | | shippingPolicyInfo.freightShipping.commodityType | No equivalent field in Trading API | | shippingPolicyInfo.freightShipping.destPickupInside | No equivalent field in Trading API | | shippingPolicyInfo.freightShipping.destPickupLocationType | No equivalent field in Trading API | | shippingPolicyInfo.freightShipping.freightShippingClass | No equivalent field in Trading API | | shippingPolicyInfo.freightShipping.originPickupInside | No equivalent field in Trading API | | shippingPolicyInfo.freightShipping.originPickupLocationType | No equivalent field in Trading API | | shippingPolicyInfo.freightShipping.packagingHelpRequired | No equivalent field in Trading API | | shippingPolicyInfo.insurance.domesticInsuranceFee (deprecated) | Item.ShippingDetails.InsuranceDetails.InsuranceFee (deprecated) | | shippingPolicyInfo.insurance.domesticInsuranceOption (deprecated) | Item.ShippingDetails.InsuranceDetails.InsuranceOption (deprecated) | | shippingPolicyInfo.insurance.intlInsuranceFee (deprecated) | Item.ShippingDetails.InternationalInsuranceDetails.InsuranceFee (deprecated) | | shippingPolicyInfo.insurance.intlInsuranceOption (deprecated) | Item.ShippingDetails.InternationalInsuranceDetails.InsuranceOption (deprecated) | | shippingPolicyInfo.intlShippingPolicyInfoService.buyerResponsibleForPickup | No equivalent field in Trading API | | shippingPolicyInfo.intlShippingPolicyInfoService.buyerResponsibleForShipping | Item.BuyerResponsibleForShipping | | shippingPolicyInfo.intlShippingPolicyInfoService.codFee | Item.ShippingDetails.CODCost | | shippingPolicyInfo.intlShippingPolicyInfoService.shippingService | Item.ShippingDetails.InternationalShippingServiceOption.ShippingService | | shippingPolicyInfo.intlShippingPolicyInfoService.shippingServiceAdditionalCost | Item.ShippingDetails.InternationalShippingServiceOption.ShippingServiceAdditionalCost | | shippingPolicyInfo.intlShippingPolicyInfoService.shippingServiceCost | Item.ShippingDetails.InternationalShippingServiceOption.ShippingServiceCost | | shippingPolicyInfo.intlShippingPolicyInfoService.shippingSurcharge (deprecated) | No equivalent field in Trading API | | shippingPolicyInfo.intlShippingPolicyInfoService.shipToLocation | Item.ShippingDetails.InternationalShippingServiceOption.ShipToLocation | | shippingPolicyInfo.intlShippingPolicyInfoService.sortOrderId | Item.ShippingDetails.InternationalShippingServiceOption.ShippingServicePriority | | shippingPolicyInfo.shippingProfileDiscountInfo.applyDomesticPromoShippingProfile | Item.ShippingDetails.PromotionalShippingDiscount | | shippingPolicyInfo.shippingProfileDiscountInfo.applyIntlPromoShippingProfile | Item.ShippingDetails.InternationalPromotionalShippingDiscount | | shippingPolicyInfo.shippingProfileDiscountInfo.domesticFlatCalcDiscountProfileId | Item.ShippingDetails.ShippingDiscountProfileID | | shippingPolicyInfo.shippingProfileDiscountInfo.intlFlatCalcDiscountProfileId | Item.ShippingDetails.InternationalShippingDiscountProfileID | Working with the Business Policies Management API ------------------------------------------------- ### API Call Limits Please refer to the [API Call Limits page](https://go.developer.ebay.com/api-call-limits) on the eBay Developers Program site for current default call limits and call limits for applications that have completed the [Compatible Application Check](http://developer.ebay.com/support/certification/) , which is a free service that the eBay Developers Program provides to its members. ### Sandbox Environment Customers can enable Business Policies in their Sandbox account by going to the [Business Policies Sandbox Opt-in](http://www.bizpolicy.sandbox.ebay.com/businesspolicy/policyoptin) page. For more information about testing Business Policies, refer to [Testing Overview](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#TestingOverview) in the Making a Business Policies Management API Call document. ### API Reference Refer to the [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) index for a list of calls in the Business Policies Management API. The API Reference includes the following information: * Prototypes of the request and response structure for each call * Comprehensive list of inputs and outputs supported by each call and descriptions of their meaning and behavior * Call samples (request and response) * Index of schema elements (types, fields, enumerations) * Change history information for each call [Back to top](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html#top) Additional Resources -------------------- You can get more information about the eBay Business Policies Management API at these locations: * [Making an API Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) * * * --- # ExtensionType - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ExtensionType ============= Reserved for future use. Type that uses ExtensionType: [BaseRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/BaseRequest.html) Calls that use ExtensionType: [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) , [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) , [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) , [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) , [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) , [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) , [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ contentType ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Reserved for future use. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#contentType) to learn which calls use contentType. id ( _[positiveInteger](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#positiveInteger) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Reserved for future use. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#id) to learn which calls use id. value ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Reserved for future use. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#value) to learn which calls use value. version ( _[string](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Not used by any call. Reserved for future use. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#version) to learn which calls use version. --- # MetadataCodeType - API Reference - Return Management API eBay Return Management APIVersion 1.1.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/return-management/Concepts/ReturnManagementAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/return-management/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/return-management/Concepts/index.html) * [Tutorials](https://developer.ebay.com/Devzone/return-management/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/return-management/ReleaseNotes.html) MetadataCodeType ( [token](https://developer.ebay.com/Devzone/return-management/CallRef/types/simpletypes.html#token) ) ======================================================================================================================== Enumerated type that defines the metadata values used by the **getReturnMetadata** call. In the **getReturnMetadata** request, these values are passed into the **metadataEntryCode** field, and in the **getReturnMetadata** response, these values are returned in the **metadataCodeValues.codeName** field. Types that use MetadataCodeType: [GetReturnMetadataRequest](https://developer.ebay.com/Devzone/return-management/CallRef/types/GetReturnMetadataRequest.html) , [MetaDataCodeResultType](https://developer.ebay.com/Devzone/return-management/CallRef/types/MetaDataCodeResultType.html) Call that uses one or more values of MetadataCodeType: [getReturnMetadata](https://developer.ebay.com/Devzone/return-management/CallRef/getReturnMetadata.html) Enumeration Values ------------------ | | | | --- | --- | | Value | Description | | REFUND\_DUE\_UPON\_ITEM\_ARRIVAL | This value is passed into the **metadataEntryCode** field of the **getReturnMetadata** request to retrieve the maximum number of business days a seller has to issue a refund to the buyer upon receiving the returned item. The number of days can be found in the **metadataCodeValues.value** field of the **getReturnMetadata** response. A refund can be issued to the buyer through the **issueRefund** call. | | RETURN\_REASONS | This value is passed into the **metadataEntryCode** field of the **getReturnMetadata** request to retrieve the reason the buyer is returning the item. The return reasons are found in the **metadataCodeValues.value** field of the **getReturnMetadata** response. | | RMA\_DUE\_UPON\_RETURN\_START | This value is passed into the **metadataEntryCode** field of the **getReturnMetadata** request to retrieve the maximum number of business days after the return filing date that a seller has to provide an Return Merchandise Authorization number (if requested) to the buyer. The number of days can be found in the **metadataCodeValues.value** field of the **getReturnMetadata** response. An RMA can be provided to the buyer through the **provideSellerInfo** call. |   \* See the [Enumeration Index](https://developer.ebay.com/Devzone/return-management/CallRef/enumindex.html) to see exact use of each enumeration value in the API. --- # Listing duration | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/duration.html#mainContent) A listing's duration is the time (expressed in days) that the listing will be active on the eBay markeplace. For auction listings, the listing ends and the winning bidder is determined when this time has passed (and the highest bid matches or exceeds reserve price, if set). The duration for all fixed-price listings is always _Good 'Til Cancelled_ which means the listing will live until quantity is 0. However, if the _Out-of-Stock_ feature is enabled, even fixed-price listings with 0 quantity will remain active but are hidden from search results. The seller would need to add quantity to the listing in order for the listing to again show up in search results and in the view item page. Refer to [Out-of-Stock Control](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/out-of-stock.html) for additional information. The allowed durations of listing types vary slightly per country and by category. For most marketplaces with support for eBay APIs, the standard listing duration values for an auction listing is 3, 5, 7, and 10 days, with some eBay marketplaces allowing 1-day auction listings for time-sensitive items like event tickets. **Note:** For more information about when 1-day listings are allowed for the eBay US marketplace, refer to [Creating 1-day listings](https://www.ebay.com/help/selling/listings/creating-managing-listings/one-day-listings?id=4666) . For fixed-price listings, the only supported listing duration for all marketplaces is _Good 'Til Cancelled_ (`GTC`) where the fixed-price listing stays alive as long as the listing still has inventory. The following categories are an exception to this GTC-only rule: * The following eBay Motors US categories: * _Cars & Trucks_ (6001) * _Motorcycles_ (6024) * _Other Vehicles & Trailers_ (6038) * _Boats_ (26429) * _Powersports_ (66466) * All child categories under _Cars, Motorcycles & Vehicles_ (9800) categories on the eBay UK and eBay Italy marketplaces. For marketplaces that support the classified ad format for some categories, including US, Germany, Philippines, and Singapore, the most common listing duration is 30 days, but allowed values can vary by marketplace and by category, especially for real estate and motor vehicle classified ads. To retrieve the allowed listing duration values for auction, fixed-price, and classified ad listings, call [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) with the value of [FeatureID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Request.FeatureID) set to `ListingDurations`. The [SiteID](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/site-id.html) value for the seller's country should be passed in as a header. For additional information about listing durations, refer to [How to find valid ListingDurations for the different types of items on each site](https://developer.ebay.com/support/kb-article?KBid=426) . **Argument:** [Item.ListingDuration](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ListingDuration) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Listing type | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/add-listing-type.html#mainContent) A listing type is required for a new item listing. If not specified in an API call, the listing type will default to an auction listing. Some listing types have other seller qualifications. Available listing types include: * **Auction** For the duration of the listing, the seller receives bids for the item. The highest bidder (who also meets the [Reserve Price](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/reserve-prices.html) if one has been specified,) at the end of the listing wins the item. The seller also has the option of implementing a [Buy It Now](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/buy-it-now.html) option for the item which allows buyers to buy the item at the _Buy It Now_ price. However, the [Buy It Now](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/buy-it-now.html) feature is disabled for the listing as soon as it receives the first bid that meets or exceeds the [Reserve Price](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/reserve-prices.html) (if one has been specified). The seller can offer a [Buy It Now](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/buy-it-now.html) **or** [Best Offer](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/best-offers.html) option for an auction listing, but not both. Once the first qualifying bid has been received for the auction listing, the enabled option is automatically disabled. * **Fixed-price** The seller lists an item at a fixed-price and buyers are able to purchase the item without bidding. The seller has the option of implementing the [Best Offer](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/best-offers.html) feature on a fixed-price listing, where the buyer can propose a _Best Offer_ that has a price which is lower than the fixed price for the item. It is up to the seller to accept or reject any [Best Offer](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/best-offers.html) or counteroffer that is received for the item. The duration of all fixed-price listings must be set to _Good 'Til Cancelled_. No other listing durations are supported. The only exceptions to this rule are motor-vehicle categories (i.e., 6001, 6024, 6038, 26429, and 66466,) on eBay Motors and on motor-vehicle categories (9800) on the eBay UK and eBay Italy marketplaces. _Good 'Til Cancelled_ listings automatically renew each month as long as there is inventory remaining for the listing. Generally, a fixed-price listing automatically ends when the available quantity of the item is at 0, but sellers can select the [Out-of-Stock Control](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/out-of-stock.html) option in My eBay Site Preferences, and listings with 0 quantity will be kept alive by eBay but will be hidden from search results. The seller can then add more inventory to the listing. * **Classified Ad** With this listing type, the seller is announcing the availability of the item on eBay, but if a transaction occurs (i.e., a buyer purchases the item from the seller,) it is done off of eBay's platform. This listing type is not available for all eBay categories. Call [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) to identify those categories support the Classified Ad format. **Note:** For a complete list of available listing types, refer to [ListingTypeCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ListingTypeCodeType.html) . **Argument:** [Item.ListingType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ListingType) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Order fulfillment feed definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-order-fulfillment-feed.html#mainContent) The table below describes the fields in an order fulfillment feed. Sample feed files: * [order-fulfillment.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-csv/order-fulfilment.csv) * [order-fulfillment.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-xml/order-fulfillment.xml) **Note:** The fields in the table below are ordered according to their order in the CSV feed file. The parent is provided for XML fields in order to make it easier to locate that field in the XML feed file. | Field name | Description | | --- | --- | | CSV: `Order ID`

XML:
`orderFulfillment.orderID` | **Required.** The ID of an eBay order.

**Type:** string | | CSV: `Line Item ID`

XML: `orderFulfillment.orderLineItem` | **Conditionally required, if an individual line item within a multiple line item order is updated.** The unique identifier of the eBay order line item.

**Note:** For updates to single line item orders, use **Order ID** (instead of **Line Item ID**).

**Type:** string | | CSV:
`Logistics Status`

XML:
`fulfillmentInfo.logisticsStatus` | **Required.** Use this field to update the status of orders.

Valid values:

* `READY_FOR_PICKUP`: The In-Store Pickup order is ready to be picked up by the buyer. Specified at the order level only.
* `PICKED_UP`: The buyer has picked up the In-Store Pickup order. Specified at the order level only.
* `SHIPPED`: Use this value to mark the order or order line item as shipped. Optionally, provide shipment tracking information as well if this information has not been provided to the buyer yet..
* `ACK`: Acknowledges the order or order line item. The order or order line item will be filtered out from subsequent order reports. Can be set at the order level or at the line Item level.

**Type:** string | | CSV:
`Shipment Carrier`

XML:
`shipmentTracking.shipmentCarrier` | **Conditionally required if shipment tracking information is supplied.** The name of the carrier used to deliver the package. If shipment tracking information is being provided, both **Shipment Carrier** and **Shipment Tracking** fields are needed. Multiple shipment carriers are supported for each item.

**Type:** string | | CSV:
`Shipment Tracking`

XML:
`shipmentTracking.trackingNumber` | **Conditionally required if shipment tracking information is supplied.** Carrier tracking number or numbers for the package. If shipment tracking information is being provided, both **Shipment Carrier** and **Shipment Tracking** fields are needed.

**Note:** Order fulfillment feeds support the use case where one order or one order line item will be shipped using multiple packages. In this scenario, a separate line would be used in CSV file to provide tracking information for each package, and in the XML file, a separate **shipping.shipmentTracking** container would be used for each package.

**Type:** string | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # FindProductsResponse - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) FindProductsResponse ( [BaseServiceResponse](https://developer.ebay.com/devzone/product/CallRef/types/BaseServiceResponse.html) ) ================================================================================================================================== Response container for the product search results. Call that uses FindProductsResponse: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) Field ----- productSearchResult ( _[ProductResponse](https://developer.ebay.com/devzone/product/CallRef/types/ProductResponse.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Container for the products that matched the search criteria. The data for each product is returned in individual containers, if any matches were found. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#productSearchResult) to learn which calls use productSearchResult. --- # Enumeration Index - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product-metadata/ReleaseNotes.html) Enumeration Index ================= This is a list of all enumeration values in the schema. The same enumeration value name may be used by several calls. A - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byApplication | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/ErrorCategory.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | Ascending | | | | --- | --- | | [OrderType](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/OrderType.html) | [getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | D - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byDescending | | | | --- | --- | | [OrderType](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/OrderType.html) | [getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | E - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byError | | | | --- | --- | | [ErrorSeverity](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/ErrorSeverity.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | F - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | P - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byPartialFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | R - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byRequest | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/ErrorCategory.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | S - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed bySuccess | | | | --- | --- | | [AckValue](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | System | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/ErrorCategory.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | W - [A](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/DevZone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byWarning | | | | --- | --- | | [AckValue](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | | [ErrorSeverity](https://developer.ebay.com/DevZone/product-metadata/CallRef/types/ErrorSeverity.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/DevZone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | --- # Enumeration Index - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/product-metadata/ReleaseNotes.html) Enumeration Index ================= This is a list of all enumeration values in the schema. The same enumeration value name may be used by several calls. A - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byApplication | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/ErrorCategory.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | Ascending | | | | --- | --- | | [OrderType](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/OrderType.html) | [getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | D - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byDescending | | | | --- | --- | | [OrderType](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/OrderType.html) | [getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | E - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byError | | | | --- | --- | | [ErrorSeverity](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/ErrorSeverity.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | F - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | P - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byPartialFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | R - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byRequest | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/ErrorCategory.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | S - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed bySuccess | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | System | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/ErrorCategory.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | W - [A](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/Devzone/product-metadata/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byWarning | | | | --- | --- | | [AckValue](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/AckValue.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | | [ErrorSeverity](https://developer.ebay.com/Devzone/product-metadata/CallRef/types/ErrorSeverity.html) | [getCompatibilitySearchDataVersion](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html)

[getCompatibilitySearchNames](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html)

[getCompatibilitySearchValues](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html)

[getCompatibilitySearchValuesBulk](https://developer.ebay.com/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) | --- # Product search feed definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-product-search-feed.html#mainContent) This topic provides definitions for the fields in a product search feed. Sample feed files: * [product-search.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-csv/product-search.csv) * [product-search.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-xml/product-search.xml) **Note:** The fields in the table below are ordered according to their order in the CSV feed file. The parent is provided for XML fields in order to make it easier to locate that field in the XML feed file. | Field name | Description | | --- | --- | | CSV: `Reference ID`

XML: `productSearch.referenceID` | **Required.** Reference ID to correlate request to responses. This can be an eBay Product ID (`ePID`), or from a set of values to set the type of ID being passed in to the **Product Identifier** field (see [Available Reference ID values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-reference-id-values.html)
).

**Type:** string | | CSV: `Channel ID`

XML: `productSearch.channelID` | **Required.** The eBay marketplace/channel on which to conduct the product search, such as `EBAY_US`, `EBAY_GB`, or `EBAY_IT`, and others. If not provided, this field defaults to `EBAY_US`. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list.

**Type:** string | | CSV: `Product Identifie`r

XML: `productSearch.productIdentifier` | **Required if you do not provide a keyword.** A standard product identifier, such as a BRAND, UPC , ISBN, EAN, or MPN value, in the eBay product catalog. The search will try to match the GTIN value to an eBay catalog product.

You must use either a product identifier or a keyword.

**Type:** string | | CSV: `Category`

XML: `productSearch.category` | **Optional.** The eBay category ID. This field can be used with keywords or attributes.

**Type:** string | | CSV: `Keywords`

XML: `productSearch.keywords` | **Required if you do not provide a product identifier.** Keywords used to search for matching products.

You must use either a product identifier or a keyword.

**Type:** string | | CSV: `Attributes`

XML: `productSearch.attributes` | **Optional.** A list of product attributes to match.

An attribute element contains a name key and value pair describing the product. Limit of 25.

**Note:** Attributes are also known as item specifics.

The format for the attribute values is `a\|b\|c` where a, b, and c are the name value pairs. The values are separated by the pipe ( \| ) symbol.

For example:

`Brand:Apple\|Model:iPhone 6\|Processor:Dual Core`

For XML input files, a separate `productSearch.attribute` container is needed for each attribute name/value pair.

**Type:** string | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Preview a revision | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-preview.html#mainContent) To preview a revised listing, set [VerifyOnly](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.VerifyOnly) set to `true` when issuing the [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) call to revise the listing. The response will include the calculated listing price change (if there is an increase in the BIN/Start price) but the values will not persist in the database. Including [VerifyOnly](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.VerifyOnly) in a [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) call is similar to using [VerifyAddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyAddItem.html) or [VerifyRelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) to test calls before you actually add or relist the item. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Availability feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-availability-feed.html#mainContent) An availability feed response tells you if all the data in the availability feed was processed successfully or not. The following table explains all the elements or fields in the availability response file. Sample response files: * [availability-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/availability-response.csv) * [availability-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/availability-response.xml) **Note:** The fields in the table below are ordered according to their order in the CSV response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML response file. | Field name | Description | | --- | --- | | CSV: `SKU`

XML: `productDetail.SKU` | The product's Stock Keeping Unit value, defined by the seller to identify the product. This value must be unique across the seller's inventory on each eBay marketplace.

**Occurrence**: Always Returned

**Max length**: 50 | | CSV: `Group ID`

XML:
`productDetail.groupID` | The unique identifier for a product group that is used for a multiple-variation listing. This field will only be returned for SKUs that are assigned to a product group.

**Occurrence**: Conditionally Returned

**Max length**: 50 | | CSV: `Locale`

Not returned in XML response | Specifies the language used for data in the listing. The default language of the eBay marketplace is used if this field is not supplied in the input file. Values include `en_US`, `en_GB`, `es_ES`, `fr_FR`, and others. See [Locale enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-locale.html)
for full list.

**Occurrence**: Always Returned (CSV only) | | CSV: `Channel ID`

XML: Not returned in XML response | The unique identifier of the eBay marketplace where the SKU is/will be listed. Values include `EBAY_US`, `EBAY_GB`, `EBAY_DE`, and others. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list.

Channel ID is an optional field in regular Product feeds (CSV ad XML), so it will only be returned if set in the input file.

**Occurrence**: Conditionally Returned (CSV only) | | CSV: `Item ID`

XML: Not returned in XML response | The unique identifier of the listing where the SKU is being offered. If a SKU was not created/updated successfully, and is not currently in an active listing, this field is not returned.

**Occurrence**: Conditionally Returned (CSV only) | | CSV: `Status`

XML:
`productDetail.status` | The value in this field indicates whether the SKU was successfully uploaded/updated in MIP. Valid values are `SUCCESS`: and `FAILED`. For SKUs with `FAILED`, there is generally an error message include in the response file.

**Occurrence**: Always Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue creating or updating the availability.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue creating or updating the availability.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue creating or updating the availability. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Additional container in XML response ------------------------------------ In addition to the fields called out in the table above, the feed response file will also have a **feedSummary** container. See [XML feedSummary container](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#XML) for details. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Product combined feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-combined-feed.html#mainContent) A combined feed response tells you if all the data in a combined feed was processed successfully or not. The definitions for available combined feed responses include the definitions from the product, availability, and distribution feeds: * [Product feed response definitions](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-feed.html) * [Availability feed response definitions](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-availability-feed.html) * [Distribution feed response definitions](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-distribution-feed.html) Sample response files: * [product-combined-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/product-combined-response.csv) * [product-combined-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/product-combined-response.xml) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Remove a field | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-remove-field.html#mainContent) When relisting an item, most fields can be removed from the listing using the [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) call. The process of removing a field depends upon the type of field that is being removed: * **Boolean field:** Set its value to `false`. * **String:** Use [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.DeletedField) . Refer to the [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) reference documentation for information about how to remove specific fields. The following sample illustrates how to remove the subtitle from a listing. **Sample XML to Remove the Subtitle** ... 4\*\*\*\*\*\*\*\*6 Item.SubTitle ... #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise a US eBay motors listing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/ebay-motors-revise-listing.html#mainContent) In addition to the [normal process for revising listings](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-listing.html) , the following additional rules apply for US eBay Motors listings: * **Site**: Set **Item.Site** to the `eBayMotors` site code and specify "0" as the site ID in the request URL. * **BuyItNowPrice**: The rules for revising the Buy It Now Price for eBay Motors listings are the same as for other listings, except as follows: A Buy It Now Price of a vehicle listing may be added/lowered if all of the following conditions are satisfied: * The new Buy It Now Price must be at least $1.00 less than the original Buy It Now Price. * The new Buy It Now Price must be at least $1.00 greater than the current high bid price. * The Buy It Now Price can be lowered regardless of the amount of time remaining in the listing. * **ReservePrice**: The reserve price for US eBay Motors vehicle listings can be lowered or removed regardless of the amount of time remaining in the listing. Refer to [Reduce a reserve price](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-prices.html#reserve) . **Important!** If you relist this item, the **ReservePrice** value must be equal to or less than the value of the **ReservePrice** in the _original_ listing. If the item has no bids, set **ReservePrice** to any value within the following range: * Lowest: $0.00 (to remove the reserve price) * Highest: **ReservePrice** - 1 ( $1.00 below the current reserve price) If the item has bids, set **ReservePrice** to a value within the following range: * Lowest: **CurrentPrice** + 1 ( $1.00 above the current high bid) * Highest: **ReservePrice** - 1 ($1.00 below the current reserve price) If the vehicle listing has bids, then users who view the listing will see a message indicating that the next bid will meet the reserve price. **Note:** Refer to [Selling fees](https://pages.ebay.com/help/sell/fees.html) for information about fee credits that may be available when removing a reserve price. When retrieving items from the US eBay Motors marketplace, **GetItem** returns information about changes to Buy It Now and reserve prices in the **ReviseStatus** property of the **Item** object. Revise a local market listing ----------------------------- In addition to the above guidelines for revising an eBay Motors listing, when revising a local market listing: * **ReviseItem** cannot be used to change a non-local listing to a local listing, and vice versa. * **ReviseItem** can be used to change the value for **Item.LocalListingDistance** to one of the valid values supported by the given category. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ConsolidationJob - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) ConsolidationJob ================ Type defining the **Job** container that is returned in the **consolidateShippingProfiles** and **GetConsolidationJobStatus** calls. The **Job** container consists of a unique ID for the job, the status of the job, and the eBay site ID. Types that use ConsolidationJob: [ConsolidateShippingProfilesResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ConsolidateShippingProfilesResponse.html) , [GetConsolidationJobStatusResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/GetConsolidationJobStatusResponse.html) Calls that use ConsolidationJob: [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) , [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) Fields ------ JobId ( _[long](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#long) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) 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. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#JobId) to learn which calls use JobId. JobStatus ( _[ConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ConsolidationJobStatus.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) This field indicates the status of the shipping policies consolidation job. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#JobStatus) to learn which calls use JobStatus. JobType ( _[ConsolidationJobType](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ConsolidationJobType.html) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) The type of shipping policies consolidation job. Currently, only one value is applicable. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#JobType) to learn which calls use JobType. SiteId ( _[int](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#int) _ ) [\[1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Unique identifier of the eBay listing site. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#SiteId) to learn which calls use SiteId. --- # Remove a field | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-remove-field.html#mainContent) Revising a listing to remove a field using [ReviseItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseItem.html) is subject to the rules described in [Qualifications](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-qualifications.html) as well as the [ReviseItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseItem.html) reference documentation. The process of removing a field depends upon the type of field that is being removed: * **Boolean field:** Set its value to `false`. * **String:** Use [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.DeletedField) . Refer to the [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) reference documentation for information about how to remove specific fields. The following sample illustrates how to remove the subtitle from a listing. **Sample XML tp Remove the Subtitle** ... 4\*\*\*\*\*\*\*\*6 Item.SubTitle ... #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # ResponseHistoryAttributesType - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) ResponseHistoryAttributesType ============================= This complex type is used by the **responseHistory.attributes** container, which consists of various return shipping and refund information. Type that uses ResponseHistoryAttributesType: [ReturnResponseHistoryType](https://developer.ebay.com/devzone/post-order/types/ReturnResponseHistoryType.html) Calls that use ResponseHistoryAttributesType: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) Fields ------ [escalateReason](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#escalateReason) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [keepOriginalItem](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#keepOriginalItem) ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [moneyMovementRef](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#moneyMovementRef) ( _[MoneyMovementRef](https://developer.ebay.com/devzone/post-order/types/MoneyMovementRef.html) _ ) [partialRefundAmount](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#partialRefundAmount) ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [refundDeductionType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#refundDeductionType) ( _[RefundDeductionType](https://developer.ebay.com/devzone/post-order/types/RefundDeductionType.html) _ ) [rlspType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#rlspType) ( _[RlspTypeEnum](https://developer.ebay.com/devzone/post-order/types/RlspTypeEnum.html) _ ) [RMA](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#RMA) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [sellerReturnAddress](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#sellerReturnAddress) ( _[ReturnAddressType](https://developer.ebay.com/devzone/post-order/types/ReturnAddressType.html) _ ) [toEmailAddress](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#toEmailAddress) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [updatedTrackingNumber](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html#updatedTrackingNumber) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) escalateReason ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) Indicates why the buyer or seller escalated the return request to a return case. This field is only returned if a return request was escalated to a return case. The applicable values are defined in the [EscalateReasonEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/EscalateReasonEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#escalateReason) to learn which calls use escalateReason. keepOriginalItem ( _[boolean](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#boolean) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) If set to `true`, the seller indicates that the buyer can keep the item they received instead of shipping it back to the seller when the refund request is accepted. **Default:** `false` See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#keepOriginalItem) to learn which calls use keepOriginalItem. moneyMovementRef ( _[MoneyMovementRef](https://developer.ebay.com/devzone/post-order/types/MoneyMovementRef.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container provides the unique eBay-assigned ID of a monetary transaction associated with a return. This container is not returned if no monetary transaction occurred for this particular return activity (identified in the **responseHistory.activity** field). See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#moneyMovementRef) to learn which calls use moneyMovementRef. partialRefundAmount ( _[Amount](https://developer.ebay.com/devzone/post-order/types/Amount.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the partial refund amount that the seller is offering to the buyer in order to settle the return request. This field is not applicable and not returned if the seller is not offering the buyer a partial refund. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#partialRefundAmount) to learn which calls use partialRefundAmount. refundDeductionType ( _[RefundDeductionType](https://developer.ebay.com/devzone/post-order/types/RefundDeductionType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container shows the amount/type of deduction that is taken off the refund amount, if any. The deduction amount can be either a percentage off the refund amount or a monetary amount that is deducted. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundDeductionType) to learn which calls use refundDeductionType. rlspType ( _[RlspTypeEnum](https://developer.ebay.com/devzone/post-order/types/RlspTypeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field indicates which AU carrier the seller has provided to the buyer for their use. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#rlspType) to learn which calls use rlspType. RMA ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field shows the return merchandise authorization (RMA) number for the return. This field is only returned if an RMA is associated with the return request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#RMA) to learn which calls use RMA. sellerReturnAddress ( _[ReturnAddressType](https://developer.ebay.com/devzone/post-order/types/ReturnAddressType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of the seller's return address. This container is generally returned if the buyer will be returning an item to the seller. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#sellerReturnAddress) to learn which calls use sellerReturnAddress. toEmailAddress ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This string value is the email address of the applicable eBay party (the **responseHistory.author** field identifies this party, such as buyer, seller, eBay). This field will only be returned if necessary/applicable. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#toEmailAddress) to learn which calls use toEmailAddress. updatedTrackingNumber ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This value is the tracking number of the return shipment. Providing a tracking number is mandatory except in countries where shipment tracking is not available. This field is not returned if this particular return activity (identified in the **responseHistory.activity** field) did not involve shipping. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#updatedTrackingNumber) to learn which calls use updatedTrackingNumber. --- # Release Notes Archive - Trading API eBay Trading API * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/api-docs/user-guides/static/make-a-call-landing.html) * [API Reference](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/index.html) * [Tutorials](https://developer.ebay.com/DevZone/XML/docs/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotes.html) Trading API Release Notes Archive ================================= This archive document contains information about older releases. For recent releases, see the current [Release Notes](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotes.html) . | Release Version | Release Date | Description of Release | | --- | --- | --- | | [1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331) | 2023-October-23 | New ListingOnHold field added to GetItem; New error codes for 1331; Logic and behavior changes to support on-hold listings; New enum values added to AccountDetailEntryCodeType | | [1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327) | 2023-September-18 | GetCharities Call Decommissioned | | [1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325) | 2023-August-29 | All DSA-related fields are available on all eBay marketplaces | | [1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323) | 2023-August-25 | New Fee and Credit added to GetAccount; Extended Producer Responsibility IDs set at account level; Several enumerated values deprecated in NotificationEventTypeCodeType; Four fields deprecated in GetMyeBaySelling call; TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls; Czechia and Cyprus added to SiteCodeType; UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call; OriginatingPostalCode field deprecated | | [1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321) | 2023-July-17 | GetMyeBayReminders Call Decommissioned; CODCost field removed | | [1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319) | 2023-Jun-26 | Added condition grading support for the United Kingdom (GB) | | [1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315) | 2023-Jun-16 | Deprecated CODCost fields and the enumerated value BuyerPaymentMethodCodeType.COD | | [1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313) | 2023-Jun-2 | AddTransactionConfirmationItem and GetContextualKeywords Decommissioned; Logic Change for RefundAmount Field in MonetaryDetails; Logic Change for Modified Line Items in GST and GIT | | [1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311) | 2023-May-19 | Regulatory changes; Numerous fields scheduled for decommission in order management calls; Logic change for Total and AmountPaid fields in GetOrders | | [1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305) | 2023-Apr-7 | Vault in-hand submission shipping address returned; New status for AuthenticityVerificationType | | [1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303) | 2023-Mar-24 | Added Support for Linking Separate Orders; SubscriptionLevel field removed from GetStore | | [1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301) | 2023-Mar-10 | Buyers in the EU must be allowed to return an item within 14 days or more; GetApiAccessRules Call Decommissioned | | [1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299) | 2023-Feb-24 | New Schema Added to Support VeRO Violation Reporting | | [1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295) | 2023-Jan-27 | Six Dispute Calls Decommissioned; GetOrderTransactions Call Deprecated | | [1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291) | 2022-Dec-30 | New Schema Added to Support Hazardous Material Label Related Information and Repair Score; New Error Codes for 1291 | | [1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285) | 2022-Nov-18 | Updated Picture Limit | | [1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281) | 2022-Oct-21 | EU and UK Payments regulations update: Digital Signatures; New item eligibility flag for shipping managed by eBay; Updates to GetAccount Call; Updates to CancelReasonCodeType type; Shipping service override changes to business policies; Australia sellers offering freight shipping changes | | [1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279) | 2022-Oct-07 | Added support for eBay shipping; New Error Codes for 1279 | | [1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275) | 2022-Sep-09 | A new intermediated international shipping program has been added | | [1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267) | 2022-Jul-15 | Four Store Calls Scheduled for Decommission on September 30 | | [1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257) | 2022-May-06 | HitCounter field removed from WSDL; HitCount field updates; Quantity and StartPrice no longer returned in ReviseInventoryStatus | | [1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255) | 2022-Apr-22 | GetCategorySpecifics Call Decommisioned | | [1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249) | 2022-Mar-11 | Extended producer responsibility related information returned | | [1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247) | 2022-Feb-25 | Winter 2022 Seller Updates Available; HitCounter and HitCount Fields Deprecated | | [1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235) | 2021-Dec-03 | New Schema added to support custom policies; New Schema added to support extended producer responsibility regulations; New Error Codes for 1235 | Version 1331 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CC) | | [Schema Changes - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-SC) | | [Announcements - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-AN) | | [New Features - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-NF) | | [Changed Functionality - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CF) | | [Document Changes and Errata - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1331 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1331 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**SellingStatusType**` | Type | Modified | | `Item.SellingStatus.**ListingOnHold**` | Field | Added | | `**AccountDetailEntryCodeType**` | Type | Modified | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFee**` | Enum | Added | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFeeCr**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFee**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFeeCredit**` | Enum | Added | ### Announcements - 1331 By January 22nd, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable **ConditionDescriptors** name-value pairs. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1331 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CF) . #### New ListingOnHold field added to GetItem The **ListingOnHold** field has been added to [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) and will be returned in GetItem as applicable. See [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) for details on this new field. ### Changed Functionality - 1331 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New error codes for 1331 Below is a list of the new error messages that rolled out with the 1331 release. All of these messages are related to on-hold listings. The long version of each message is used below: * (warning) **21920396**: This listing has a policy violation. * (error) **21920397**: This listing has been removed for a policy violation. * (error) **21920398**: This listing has a policy violation. `replaceable_value` is not possible. These error and warning messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. #### Logic and behavior changes to support on-hold listings Various logic/behavior changes have been made to several Trading calls that return listing data to indicate if a listing is currently on hold due to an eBay policy violation. These changes are covered in the list below: * **GetItemTransactions**: If the item ID passed into the [ItemID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetItemTransactions.html#Request.ItemID) field is for a listing that is on hold, existing error code **17** ("This item cannot be accessed because the listing has been deleted or you are not the seller.") will be triggered. * **GetOrders**: If the Order ID passed into the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item ordered spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetOrderTransactions**: If the Order ID passed in the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item order spawned from a listing that is on hold, or if the ItemID, SKU, or OrderLineItemID (or ItemID/TransactionID combo specified through the [TransactionID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.ItemTransactionIDArray.ItemTransactionID) container) involves an order line item spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetSellerList**: When making a [GetSellerList](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerList.html) call, items that are on-hold due to an eBay policy violation will not be returned in the response. * **GetSellerEvents**: When making a [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerEvents.html) call, the item.**Title** field will be returned masked as `*****************` for listings on hold due to a policy violation. * **GetSellerTransactions**: When making a [GetSellerTransactions](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerTransactions.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. * **GetMyeBaySelling**: When making a [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/reference/ebay/getmyebayselling.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. #### New enum values added to AccountDetailEntryCodeType `HermesReturnLblSellerPaidShpFee`, `HermesReturnLblSellerPaidShpFeeCr`, `DHLReturnLblShippingFee`, and `DHLReturnLblShippingFeeCredit` have been added to [AccountDetailEntryCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) as enum values and will be returned by **GetAccount** as applicable. ### Documentation Changes and Errata - 1331 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-NF) and [Changed Functionality - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CF) . None for this release. Version 1327 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CC) | | [Schema Changes - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-SC) | | [Announcements - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-AN) | | [New Features - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-NF) | | [Changed Functionality - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CF) | | [Document Changes and Errata - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1327 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1327 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**CharityInfoType**` | Type | Removed | | `**StringMatchCodeType**` | Type | Removed | | `**GetCharitiesRequestType**` | Type | Removed | | `**GetCharitiesResponseType**` | Type | Removed | | `**NonProfitAddressType**` | Type | Modified | ### Announcements - 1327 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1327 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. ### Changed Functionality - 1327 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetCharities Call Decommissioned The **GetCharities** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetCharities** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-SC) ### Documentation Changes and Errata - 1327 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-NF) and [Changed Functionality - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. Version 1325 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CC) | | [Schema Changes - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-SC) | | [Announcements - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-AN) | | [New Features - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-NF) | | [Changed Functionality - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CF) | | [Document Changes and Errata - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1325 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1325 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1325 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1325 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. ### Changed Functionality - 1325 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### All DSA-related fields are available on all eBay marketplaces All DSA-related fields are now available on all eBay marketplaces (no longer restricted to specific marketplaces). The Trading API now supports the following features: * Energy Efficiency Labels * Hazmat * Regional Product Compliance Policies * Regional Take-back Policies * Repair Score * Eco-Participation Fee ### Documentation Changes and Errata - 1325 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-NF) and [Changed Functionality - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. Version 1323 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CC) | | [Schema Changes - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-SC) | | [Announcements - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-AN) | | [New Features - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-NF) | | [Changed Functionality - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CF) | | [Document Changes and Errata - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1323 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetAllBidders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAllBidders.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GeteBayDetails](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GeteBayDetails.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetMyeBayBuying](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetMyeBayBuying.html#ChangeHistory) * [GetMyeBaySelling](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetMyeBaySelling.html#ChangeHistory) * [GetNotificationPreferences](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetNotificationPreferences.html#ChangeHistory) * [GetNotificationsUsage](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetNotificationsUsage.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerDashboard](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerDashboard.html#ChangeHistory) * [GetSellerEvents](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerEvents.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [GetUser](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetUser.html#ChangeHistory) * [GetVeROReasonCodeDetails](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetVeROReasonCodeDetails.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SetNotificationPreferences](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/SetNotificationPreferences.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1323 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**AccountDetailEntryCodeType**` | Type | Modified | | `**AccountDetailEntryCodeType.**ExpressPayoutFee****` | Enum | Added | | `AccountDetailEntryCodeType.**ExpressPayoutFeeCredit**` | Enum | Added | | `ExtendedProducerResponsibilityType.**ProducerProductID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ShipmentPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductDocumentationID**` | Field | Removed | | `NotificationEventTypeCodeType.**OrderInquiryClosed**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryOpened**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerOpenedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryProvideShipmentInformation**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryEscalatedToCase**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerClosedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRSellerRespondedToDispute**` | Enum | Deprecated | | `Summary.**AuctionBidCount**` | Field | Deprecated | | `Summary.**ClassifiedAdOfferCount**` | Field | Deprecated | | `Summary.**TotalLeadCount**` | Field | Deprecated | | `SellingSummary.**AuctionBidCount**` | Field | Deprecated | | `**TicketListingDetailsType**` | Type | Deprecated | | `TicketListingDetailsType.**EventTitle**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedDate**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedTime**` | Field | Deprecated | | `TicketListingDetailsType.**Venue**` | Field | Deprecated | | `**SiteCodeType**` | Type | Modified | | `SiteCodeType.**Czechia**` | Enum | Added | | `SiteCodeType.**Cyprus**` | Enum | Added | | `**UpdateReturnPolicy**` | Field | Deprecated | | `**UpdateSellerInfo**` | Field | Deprecated | | `**OriginatingPostalCode**` | Field | Deprecated | | `**QuantityInfo**` | Field | Deprecated | ### Announcements - 1323 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1323 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CF) . #### New Fee and Credit added to GetAccount The following new fee and credit fields were added to [AccountDetailEntryCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on this new fee and credit. * `ExpressPayoutFee` * `ExpressPayoutFeeCredit` ### Changed Functionality - 1323 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Extended Producer Responsibility IDs set at account level For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level and have been removed from the Trading WSDL. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings.\*/epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. The **ExtendedProducerResponsibilityType** fields removed were: `ProducerProductID`, `ProductPackageID`, `ShipmentPackageID`, and `ProductDocumentationID`. These fields are no longer usable; if used, the user will get a warning about the fields no longer being supported. #### Several enumerated values deprecated in NotificationEventTypeCodeType Because some of the order inquiry series events have been deprecated, the following enumerated values in [NotificationEventTypeCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) (used in the **GetNotificationPreferences**, **GetNotificationsUsage**, and **SetNotificationPreferences** methods) were also deprecated: * OrderInquiryClosed * OrderInquiryOpened * INRBuyerOpenedDispute * OrderInquiryProvideShipmentInformation * OrderInquiryEscalatedToCase * INRBuyerClosedDispute * INRSellerRespondedToDispute See [NotificationEventTypeCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) for additional information. #### Four fields deprecated in GetMyeBaySelling call Because the data is no longer being actively maintained by eBay, the following four fields in **GetMyeBaySelling** have been deprecated and scheduled for decommission on 02-06-2024: Summary.**AuctionBidCount**, Summary.**ClassifiedAdOfferCount**, Summary.**TotalLeadCount**, and SellingSummary.**AuctionBidCount**. #### TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls The **TicketListingDetails** and **QuantityInfo** container fields in Add/Revise/Relist/Verify and related calls have been deprecated and are not usable. They will be ignored if sent. #### Added Czechia and Cyprus to SiteCodeType `Czechia` and `Cyprus` have been added to **SiteCodeType** as enumeration values. #### UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call The **UpdateReturnPolicy** and **UpdateSellerInfofields** fields in the ReviseItem call have been deprecated and are not usable. They will be ignored if sent. #### OriginatingPostalCode field deprecated The **OriginatingPostalCode** was deprecated in Add/Revise/Relist/Verify family, GetItem family, GetSeller family, and GetOrders calls. To specify the postal code of the item's location, using the Item.PostalCode field in the request. For example, in the AddItem call specify the item's location using the [Item.PostalCode](https://developer.ebay.com/devzone/xml/docs/reference/ebay/additem.html#Request.Item.PostalCode) field. ### Documentation Changes and Errata - 1323 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-NF) and [Changed Functionality - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CF) . None for this release. Version 1321 ------------ [Index of Changed Calls - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CC) [Schema Changes - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-SC) [Announcements - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-AN) [New Features - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-NF) [Changed Functionality - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CF) [Documentation Changes and Errata - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1321 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1321 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ReminderCustomizationType**` | Type | Removed | | `**RemindersType**` | Type | Removed | | `ShippingDetailsType.**CODCost**` | Field | Removed | | `SendInvoiceRequest.**CODCost**` | Field | Removed | ### Announcements - 1321 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1321 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. ### Changed Functionality - 1321 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetMyeBayReminders Call Decommissioned The **GetMyeBayReminders** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetMyeBayReminders** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-SC) section. Instead of this API, buyers and sellers can go to **My eBay** to see all of their selling/buying reminders. #### CODCost field removed The deprecated **CODCost** fields in Add/Revise/Relist/Verify calls and related calls such as SendInvoice have been removed. This field is no longer returned in GetItem/GetOrder/GetSeller responses. ### Documentation Changes and Errata - 1321 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-NF) and [Changed Functionality - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. Version 1319 ------------ [Index of Changed Calls - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CC) [Schema Changes - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-SC) [Announcements - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-AN) [New Features - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-NF) [Changed Functionality - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CF) [Documentation Changes and Errata - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1319 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1319 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ConditionDescriptorsType**` | Type | New | | `Item.**ConditionDescriptors**` | Field | New | | `**ConditionDescriptorType**` | Type | New | | `ConditionDescriptors.**AdditionalInfo**` | Field | New | | `ConditionDescriptors.**Name**` | Field | New | | `ConditionDescriptors.**Value**` | Field | New | ### Announcements - 1319 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1319 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CF) . #### Condition grading **Note:** The **ConditionDescriptors** and the **ConditionDescriptor** containers are currently available only in the United Kingdom (GB), with rollout to other markets in early July 2023. To provide support for condition grading, the **ConditionDescriptors** container, and the **ConditionDescriptor** container and its child fields **AdditionalInfo**, **Name**, and **Value**, can be used by the seller to provide information about the specific condition of an item. This information is passed in using the **Add**/**Revise**/**Relist**/**Verify** calls and returned by calling **GetItem**. ### Changed Functionality - 1319 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1319 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-NF) and [Changed Functionality - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CF) . None for this release. Version 1315 ------------ [Index of Changed Calls - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CC) [Schema Changes - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-SC) [Announcements - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-AN) [New Features - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-NF) [Changed Functionality - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CF) [Documentation Changes and Errata - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1315 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1315 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ShippingDetailsType.**CODCost**` | Field | Deprecated | | `SendInvoiceRequest.**CODCost**` | Field | Deprecated | | `BuyerPaymentMethodCodeType.**COD**` | Enum | Deprecated | ### Announcements - 1315 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1315 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. ### Changed Functionality - 1315 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### ShippingDetailsType.CODCost and SendInvoiceRequest.CODCost fields were deprecated The ShippingDetailsType.**CODCost** and SendInvoiceRequest.**CODCost** fields, and the enumerated value BuyerPaymentMethodCodeType.**COD** was deprecated, as COD is no longer a supported payment method on any marketplace. See [Index of Changed Calls - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CC) for affected methods. ### Documentation Changes and Errata - 1315 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-NF) and [Changed Functionality - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. Version 1313 ------------ [Index of Changed Calls - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CC) [Schema Changes - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-SC) [Announcements - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-AN) [New Features - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-NF) [Changed Functionality - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CF) [Documentation Changes and Errata - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1313 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1313 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1313 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### AddTransactionConfirmationItem and GetContextualKeywords Decommissioned The AddTransactionConfirmationItem and GetContextualKeywords calls have been decommissioned and removed from the Trading WSDL and documentation. ### New Features - 1313 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CF) . #### New Fees and Credits Added to GetAccount The following new fees and credits were added to [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on these new fees and credits. * PromotedDisplayFee * PromotedDisplayFeeCredit * USWHTFederal * USWHTFederalCredit * USWHTState * USWHTStateCredit * EPRFee * EPRFeeCredit * CAPostReturnLabelFee * CAPostReturnLabelFeeCredit * HermesReturnLabelFee * HermesReturnLabelFeeCredit * BankPayoutFee * BankPayoutFeeCredit * CharityDonation * CharityDonationCredit ### Changed Functionality - 1313 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Logic Change for RefundAmount Field in MonetaryDetails For **GetOrders** call, there has been a logic change for the **RefundAmount** field under **MonetaryDetails** container. Previously, the final value fee amount deducted from the seller's payout funds for the sale was not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The **GetOrders** call will be updated to include the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in **GetOrders**responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the **X-EBAY-API-COMPATIBILITY-LEVEL** header value to 1311 or above. #### Logic Change for Modified Line Items in GST and GIT For **GetSellerTransactions** and **GetItemTransactions** calls, please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned. ### Documentation Changes and Errata - 1313 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-NF) and [Changed Functionality - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CF) . None for this release. Version 1311 ------------ [Index of Changed Calls - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CC) [Schema Changes - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-SC) [Announcements - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-AN) [New Features - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-NF) [Changed Functionality - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CF) [Documentation Changes and Errata - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1311 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1311 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**EnergyEfficiencyType**` | Type | New | | `Item.Regulatory.**EnergyEfficiencyLabel**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageDescription**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageURL**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ProductInformationsheet**` | Field | New | | `Item.Regulatory.**RepairScore**` | Field | Modified | | `CustomPolicies.**RegionalProductCompliancePolicies**` | Field | Added | | `CustomPolicies.RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**Country**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**PolicyID**` | Field | Added | | `Item.**CustomPolicies**` | Field | Modified | ### Announcements - 1311 None for this release. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1311 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Regulatory changes **Note:** The **EnergyEfficiencyLabel** and the **Hazmat** containers are initially available only on the German (DE) marketplace. The **RepairScore** field is provided for future use (not presently available). As a part of Digital Services Act (DSA) requirements, the **EnergyEfficiencyLabel** container and its child fields **ImageDescription**, **ImageURL**, and **ProductInformationsheet**, can be used by the seller to provide Energy Efficiency Label related information for the listing. This information is passed in using the **Add/Revise/Relist/Verify** calls and returned by calling **GetItem**. **RegionalProductCompliancePolicies** and **RegionalTakeBackPolicies** fields were added, providing compliance functionality specified by region, and **ProductCompliancePolicyID** now applies to Global product compliance policies. #### Numerous fields scheduled for decommission in order management calls Numerous fields in the response payloads of the **GetOrders**, **GetItemTransactions**, **GetSellerTransactions**, and **GetMyeBaySelling** calls are being deprecated. See the [Deprecated Trading Order Management Fields](https://developer.ebay.com/devzone/deprecated_trading_ordermgmt_fields.pdf) document for the complete list of deprecated fields and reasons for deprecation. ### Changed Functionality - 1311 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. ### Documentation Changes and Errata - 1311 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-NF) and [Changed Functionality - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Logic change for Total and AmountPaid fields in GetOrders The field descriptions for **Order.Total** and **Order.AmountPaid** fieldsin **GetOrders** incorrectly stated that sales tax was included in those two amounts, but that was not the case prior to Version 1307. Going foward, sales tax will be included in these amounts if using Trading WSDL Version 1307 or above. If using a Trading WSDL older than Version 1307, the amount in thes fields will not include sales tax. To incorporate the new logic (sales tax included) while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. Version 1331 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CC) | | [Schema Changes - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-SC) | | [Announcements - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-AN) | | [New Features - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-NF) | | [Changed Functionality - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CF) | | [Document Changes and Errata - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1331 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1331 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**SellingStatusType**` | Type | Modified | | `Item.SellingStatus.**ListingOnHold**` | Field | Added | | `**AccountDetailEntryCodeType**` | Type | Modified | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFee**` | Enum | Added | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFeeCr**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFee**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFeeCredit**` | Enum | Added | ### Announcements - 1331 By January 22nd, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable **ConditionDescriptors** name-value pairs. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1331 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CF) . #### New ListingOnHold field added to GetItem The **ListingOnHold** field has been added to [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) and will be returned in GetItem as applicable. See [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) for details on this new field. ### Changed Functionality - 1331 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New error codes for 1331 Below is a list of the new error messages that rolled out with the 1331 release. All of these messages are related to on-hold listings. The long version of each message is used below: * (warning) **21920396**: This listing has a policy violation. * (error) **21920397**: This listing has been removed for a policy violation. * (error) **21920398**: This listing has a policy violation. `replaceable_value` is not possible. These error and warning messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. #### Logic and behavior changes to support on-hold listings Various logic/behavior changes have been made to several Trading calls that return listing data to indicate if a listing is currently on hold due to an eBay policy violation. These changes are covered in the list below: * **GetItemTransactions**: If the item ID passed into the [ItemID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetItemTransactions.html#Request.ItemID) field is for a listing that is on hold, existing error code **17** ("This item cannot be accessed because the listing has been deleted or you are not the seller.") will be triggered. * **GetOrders**: If the Order ID passed into the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item ordered spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetOrderTransactions**: If the Order ID passed in the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item order spawned from a listing that is on hold, or if the ItemID, SKU, or OrderLineItemID (or ItemID/TransactionID combo specified through the [TransactionID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.ItemTransactionIDArray.ItemTransactionID) container) involves an order line item spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetSellerList**: When making a [GetSellerList](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerList.html) call, items that are on-hold due to an eBay policy violation will not be returned in the response. * **GetSellerEvents**: When making a [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerEvents.html) call, the item.**Title** field will be returned masked as `*****************` for listings on hold due to a policy violation. * **GetSellerTransactions**: When making a [GetSellerTransactions](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerTransactions.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. * **GetMyeBaySelling**: When making a [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/reference/ebay/getmyebayselling.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. #### New enum values added to AccountDetailEntryCodeType `HermesReturnLblSellerPaidShpFee`, `HermesReturnLblSellerPaidShpFeeCr`, `DHLReturnLblShippingFee`, and `DHLReturnLblShippingFeeCredit` have been added to [AccountDetailEntryCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) as enum values and will be returned by **GetAccount** as applicable. ### Documentation Changes and Errata - 1331 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-NF) and [Changed Functionality - 1331](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1331-CF) . None for this release. Version 1327 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CC) | | [Schema Changes - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-SC) | | [Announcements - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-AN) | | [New Features - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-NF) | | [Changed Functionality - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CF) | | [Document Changes and Errata - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1327 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1327 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**CharityInfoType**` | Type | Removed | | `**StringMatchCodeType**` | Type | Removed | | `**GetCharitiesRequestType**` | Type | Removed | | `**GetCharitiesResponseType**` | Type | Removed | | `**NonProfitAddressType**` | Type | Modified | ### Announcements - 1327 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1327 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. ### Changed Functionality - 1327 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetCharities Call Decommissioned The **GetCharities** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetCharities** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-SC) ### Documentation Changes and Errata - 1327 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-NF) and [Changed Functionality - 1327](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. Version 1325 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CC) | | [Schema Changes - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-SC) | | [Announcements - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-AN) | | [New Features - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-NF) | | [Changed Functionality - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CF) | | [Document Changes and Errata - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1325 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1325 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1325 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1325 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. ### Changed Functionality - 1325 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### All DSA-related fields are available on all eBay marketplaces All DSA-related fields are now available on all eBay marketplaces (no longer restricted to specific marketplaces). The Trading API now supports the following features: * Energy Efficiency Labels * Hazmat * Regional Product Compliance Policies * Regional Take-back Policies * Repair Score * Eco-Participation Fee ### Documentation Changes and Errata - 1325 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-NF) and [Changed Functionality - 1325](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. Version 1323 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CC) | | [Schema Changes - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-SC) | | [Announcements - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-AN) | | [New Features - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-NF) | | [Changed Functionality - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CF) | | [Document Changes and Errata - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1323 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetAllBidders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAllBidders.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GeteBayDetails](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GeteBayDetails.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetMyeBayBuying](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetMyeBayBuying.html#ChangeHistory) * [GetMyeBaySelling](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetMyeBaySelling.html#ChangeHistory) * [GetNotificationPreferences](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetNotificationPreferences.html#ChangeHistory) * [GetNotificationsUsage](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetNotificationsUsage.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerDashboard](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerDashboard.html#ChangeHistory) * [GetSellerEvents](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerEvents.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [GetUser](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetUser.html#ChangeHistory) * [GetVeROReasonCodeDetails](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetVeROReasonCodeDetails.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SetNotificationPreferences](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/SetNotificationPreferences.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1323 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**AccountDetailEntryCodeType**` | Type | Modified | | `**AccountDetailEntryCodeType.**ExpressPayoutFee****` | Enum | Added | | `AccountDetailEntryCodeType.**ExpressPayoutFeeCredit**` | Enum | Added | | `ExtendedProducerResponsibilityType.**ProducerProductID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ShipmentPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductDocumentationID**` | Field | Removed | | `NotificationEventTypeCodeType.**OrderInquiryClosed**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryOpened**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerOpenedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryProvideShipmentInformation**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryEscalatedToCase**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerClosedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRSellerRespondedToDispute**` | Enum | Deprecated | | `Summary.**AuctionBidCount**` | Field | Deprecated | | `Summary.**ClassifiedAdOfferCount**` | Field | Deprecated | | `Summary.**TotalLeadCount**` | Field | Deprecated | | `SellingSummary.**AuctionBidCount**` | Field | Deprecated | | `**TicketListingDetailsType**` | Type | Deprecated | | `TicketListingDetailsType.**EventTitle**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedDate**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedTime**` | Field | Deprecated | | `TicketListingDetailsType.**Venue**` | Field | Deprecated | | `**SiteCodeType**` | Type | Modified | | `SiteCodeType.**Czechia**` | Enum | Added | | `SiteCodeType.**Cyprus**` | Enum | Added | | `**UpdateReturnPolicy**` | Field | Deprecated | | `**UpdateSellerInfo**` | Field | Deprecated | | `**OriginatingPostalCode**` | Field | Deprecated | | `**QuantityInfo**` | Field | Deprecated | ### Announcements - 1323 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1323 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CF) . #### New Fee and Credit added to GetAccount The following new fee and credit fields were added to [AccountDetailEntryCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on this new fee and credit. * `ExpressPayoutFee` * `ExpressPayoutFeeCredit` ### Changed Functionality - 1323 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Extended Producer Responsibility IDs set at account level For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level and have been removed from the Trading WSDL. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings.\*/epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. The **ExtendedProducerResponsibilityType** fields removed were: `ProducerProductID`, `ProductPackageID`, `ShipmentPackageID`, and `ProductDocumentationID`. These fields are no longer usable; if used, the user will get a warning about the fields no longer being supported. #### Several enumerated values deprecated in NotificationEventTypeCodeType Because some of the order inquiry series events have been deprecated, the following enumerated values in [NotificationEventTypeCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) (used in the **GetNotificationPreferences**, **GetNotificationsUsage**, and **SetNotificationPreferences** methods) were also deprecated: * OrderInquiryClosed * OrderInquiryOpened * INRBuyerOpenedDispute * OrderInquiryProvideShipmentInformation * OrderInquiryEscalatedToCase * INRBuyerClosedDispute * INRSellerRespondedToDispute See [NotificationEventTypeCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) for additional information. #### Four fields deprecated in GetMyeBaySelling call Because the data is no longer being actively maintained by eBay, the following four fields in **GetMyeBaySelling** have been deprecated and scheduled for decommission on 02-06-2024: Summary.**AuctionBidCount**, Summary.**ClassifiedAdOfferCount**, Summary.**TotalLeadCount**, and SellingSummary.**AuctionBidCount**. #### TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls The **TicketListingDetails** and **QuantityInfo** container fields in Add/Revise/Relist/Verify and related calls have been deprecated and are not usable. They will be ignored if sent. #### Added Czechia and Cyprus to SiteCodeType `Czechia` and `Cyprus` have been added to **SiteCodeType** as enumeration values. #### UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call The **UpdateReturnPolicy** and **UpdateSellerInfofields** fields in the ReviseItem call have been deprecated and are not usable. They will be ignored if sent. #### OriginatingPostalCode field deprecated The **OriginatingPostalCode** was deprecated in Add/Revise/Relist/Verify family, GetItem family, GetSeller family, and GetOrders calls. To specify the postal code of the item's location, using the Item.PostalCode field in the request. For example, in the AddItem call specify the item's location using the [Item.PostalCode](https://developer.ebay.com/devzone/xml/docs/reference/ebay/additem.html#Request.Item.PostalCode) field. ### Documentation Changes and Errata - 1323 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-NF) and [Changed Functionality - 1323](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1323-CF) . None for this release. Version 1321 ------------ [Index of Changed Calls - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CC) [Schema Changes - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-SC) [Announcements - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-AN) [New Features - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-NF) [Changed Functionality - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CF) [Documentation Changes and Errata - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1321 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1321 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ReminderCustomizationType**` | Type | Removed | | `**RemindersType**` | Type | Removed | | `ShippingDetailsType.**CODCost**` | Field | Removed | | `SendInvoiceRequest.**CODCost**` | Field | Removed | ### Announcements - 1321 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1321 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. ### Changed Functionality - 1321 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetMyeBayReminders Call Decommissioned The **GetMyeBayReminders** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetMyeBayReminders** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-SC) section. Instead of this API, buyers and sellers can go to **My eBay** to see all of their selling/buying reminders. #### CODCost field removed The deprecated **CODCost** fields in Add/Revise/Relist/Verify calls and related calls such as SendInvoice have been removed. This field is no longer returned in GetItem/GetOrder/GetSeller responses. ### Documentation Changes and Errata - 1321 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-NF) and [Changed Functionality - 1321](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. Version 1319 ------------ [Index of Changed Calls - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CC) [Schema Changes - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-SC) [Announcements - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-AN) [New Features - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-NF) [Changed Functionality - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CF) [Documentation Changes and Errata - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1319 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1319 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ConditionDescriptorsType**` | Type | New | | `Item.**ConditionDescriptors**` | Field | New | | `**ConditionDescriptorType**` | Type | New | | `ConditionDescriptors.**AdditionalInfo**` | Field | New | | `ConditionDescriptors.**Name**` | Field | New | | `ConditionDescriptors.**Value**` | Field | New | ### Announcements - 1319 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1319 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CF) . #### Condition grading **Note:** The **ConditionDescriptors** and the **ConditionDescriptor** containers are currently available only in the United Kingdom (GB), with rollout to other markets in early July 2023. To provide support for condition grading, the **ConditionDescriptors** container, and the **ConditionDescriptor** container and its child fields **AdditionalInfo**, **Name**, and **Value**, can be used by the seller to provide information about the specific condition of an item. This information is passed in using the **Add**/**Revise**/**Relist**/**Verify** calls and returned by calling **GetItem**. ### Changed Functionality - 1319 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1319 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-NF) and [Changed Functionality - 1319](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1319-CF) . None for this release. Version 1315 ------------ [Index of Changed Calls - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CC) [Schema Changes - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-SC) [Announcements - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-AN) [New Features - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-NF) [Changed Functionality - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CF) [Documentation Changes and Errata - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1315 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1315 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ShippingDetailsType.**CODCost**` | Field | Deprecated | | `SendInvoiceRequest.**CODCost**` | Field | Deprecated | | `BuyerPaymentMethodCodeType.**COD**` | Enum | Deprecated | ### Announcements - 1315 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1315 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. ### Changed Functionality - 1315 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### ShippingDetailsType.CODCost and SendInvoiceRequest.CODCost fields were deprecated The ShippingDetailsType.**CODCost** and SendInvoiceRequest.**CODCost** fields, and the enumerated value BuyerPaymentMethodCodeType.**COD** was deprecated, as COD is no longer a supported payment method on any marketplace. See [Index of Changed Calls - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CC) for affected methods. ### Documentation Changes and Errata - 1315 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-NF) and [Changed Functionality - 1315](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. Version 1313 ------------ [Index of Changed Calls - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CC) [Schema Changes - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-SC) [Announcements - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-AN) [New Features - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-NF) [Changed Functionality - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CF) [Documentation Changes and Errata - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1313 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1313 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1313 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### AddTransactionConfirmationItem and GetContextualKeywords Decommissioned The AddTransactionConfirmationItem and GetContextualKeywords calls have been decommissioned and removed from the Trading WSDL and documentation. ### New Features - 1313 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CF) . #### New Fees and Credits Added to GetAccount The following new fees and credits were added to [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on these new fees and credits. * PromotedDisplayFee * PromotedDisplayFeeCredit * USWHTFederal * USWHTFederalCredit * USWHTState * USWHTStateCredit * EPRFee * EPRFeeCredit * CAPostReturnLabelFee * CAPostReturnLabelFeeCredit * HermesReturnLabelFee * HermesReturnLabelFeeCredit * BankPayoutFee * BankPayoutFeeCredit * CharityDonation * CharityDonationCredit ### Changed Functionality - 1313 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Logic Change for RefundAmount Field in MonetaryDetails For **GetOrders** call, there has been a logic change for the **RefundAmount** field under **MonetaryDetails** container. Previously, the final value fee amount deducted from the seller's payout funds for the sale was not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The **GetOrders** call will be updated to include the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in **GetOrders**responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the **X-EBAY-API-COMPATIBILITY-LEVEL** header value to 1311 or above. #### Logic Change for Modified Line Items in GST and GIT For **GetSellerTransactions** and **GetItemTransactions** calls, please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned. ### Documentation Changes and Errata - 1313 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-NF) and [Changed Functionality - 1313](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1313-CF) . None for this release. Version 1311 ------------ [Index of Changed Calls - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CC) [Schema Changes - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-SC) [Announcements - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-AN) [New Features - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-NF) [Changed Functionality - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CF) [Documentation Changes and Errata - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1311 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1311 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**EnergyEfficiencyType**` | Type | New | | `Item.Regulatory.**EnergyEfficiencyLabel**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageDescription**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageURL**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ProductInformationsheet**` | Field | New | | `Item.Regulatory.**RepairScore**` | Field | Modified | | `CustomPolicies.**RegionalProductCompliancePolicies**` | Field | Added | | `CustomPolicies.RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**Country**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**PolicyID**` | Field | Added | | `Item.**CustomPolicies**` | Field | Modified | ### Announcements - 1311 None for this release. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1311 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Regulatory changes **Note:** The **EnergyEfficiencyLabel** and the **Hazmat** containers are initially available only on the German (DE) marketplace. The **RepairScore** field is provided for future use (not presently available). As a part of Digital Services Act (DSA) requirements, the **EnergyEfficiencyLabel** container and its child fields **ImageDescription**, **ImageURL**, and **ProductInformationsheet**, can be used by the seller to provide Energy Efficiency Label related information for the listing. This information is passed in using the **Add/Revise/Relist/Verify** calls and returned by calling **GetItem**. **RegionalProductCompliancePolicies** and **RegionalTakeBackPolicies** fields were added, providing compliance functionality specified by region, and **ProductCompliancePolicyID** now applies to Global product compliance policies. #### Numerous fields scheduled for decommission in order management calls Numerous fields in the response payloads of the **GetOrders**, **GetItemTransactions**, **GetSellerTransactions**, and **GetMyeBaySelling** calls are being deprecated. See the [Deprecated Trading Order Management Fields](https://developer.ebay.com/devzone/deprecated_trading_ordermgmt_fields.pdf) document for the complete list of deprecated fields and reasons for deprecation. ### Changed Functionality - 1311 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. ### Documentation Changes and Errata - 1311 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-NF) and [Changed Functionality - 1311](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Logic change for Total and AmountPaid fields in GetOrders The field descriptions for **Order.Total** and **Order.AmountPaid** fieldsin **GetOrders** incorrectly stated that sales tax was included in those two amounts, but that was not the case prior to Version 1307. Going foward, sales tax will be included in these amounts if using Trading WSDL Version 1307 or above. If using a Trading WSDL older than Version 1307, the amount in thes fields will not include sales tax. To incorporate the new logic (sales tax included) while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. Version 1305 ------------ [Index of Changed Calls - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-CC) [Schema Changes - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-SC) [Announcements - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-AN) [New Features - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-NF) [Changed Functionality - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-CF) [Documentation Changes and Errata - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1305 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) #### Schema Changes - 1305 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | **AuthenticityVerification** | Type | Modified | | AuthenticityVerification.**Status** | Field | Modified | | Order.**ShippingAddress** | Field | Modified | ### Announcements - 1305 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1305 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-CF) . None for this release. ### Changed Functionality - 1305 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Vault in-hand submission shipping address returned For Vault in-hand submission orders, the warehouse address is now available for the buyer view. For these orders, the address returned for the Buyer View will be the authenticator's address. #### New status for AuthenticityVerificationType The status PASSED\_WITH\_PARTIAL\_FAILURE was added as a possible returned value for **AuthenticityVerification.Status** field of the following calls: * GetOrders * GetOrderTransactions * GetItemTransactions This indicates in multi-quantity use cases that part of the order is authentic, but the other part of the order FAILED. ### Documentation Changes and Errata - 1305 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-NF) and [Changed Functionality - 1305](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1305-CF) . None for this release. Version 1303 ------------ [Index of Changed Calls - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-CC) [Schema Changes - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-SC) [Announcements - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-AN) [New Features - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-NF) [Changed Functionality - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-CF) [Documentation Changes and Errata - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1303 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetStore](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetStore.html#ChangeHistory) #### Schema Changes - 1303 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | Transaction.**LinkedLineItemArray** | Container | New | | LinkedLineItemArray.**LinkedLineItem** | Container | New | | LinkedLineItemArray.LinkedLineItem.**EstimatedDeliveryTimeMax** | Field | New | | LinkedLineItemArray.LinkedLineItem.**EstimatedDeliveryTimeMin** | Field | New | | LinkedLineItemArray.LinkedLineItem.**Item** | Container | Added | | LinkedLineItemArray.LinkedLineItem.**OrderID** | Field | New | | LinkedLineItemArray.LinkedLineItem.**OrderLineItemID** | Field | New | | LinkedLineItemArray.LinkedLineItem.**SellerUserID** | Field | New | | **LinkedLineItemArrayType** | Type | New | | **LinkedLineItemType** | Type | New | | **StoreType** | Type | Modified | | StoreType.**StoreSubscriptionLevelCodeType** | Type | Removed | | StoreType.**StoreSubscriptionLevel** | Field | Removed | ### Announcements - 1303 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1303 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-CF) . #### Added Support for Linking Separate Orders Schema was added that links items from separate orders which may be from different sellers. This can be used to provide details about a component (purchased from one seller) needed for its installation (purchased from a different seller). Details can identify the linked seller and also include delivery times, item information, and order information. ### Changed Functionality - 1303 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### SubscriptionLevel field removed from GetStore The **SubscriptionLevel** field has been removed from the GetStore call. Use the [getSubscription](https://developer.ebay.com/api-docs/sell/account/resources/subscription/methods/getSubscription) method of the [Account API](https://developer.ebay.com/api-docs/sell/account/overview.html) to retrieve information on a seller's eBay store subscription. ### Documentation Changes and Errata - 1303 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-NF) and [Changed Functionality - 1303](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1303-CF) . None for this release. Version 1301 ------------ [Index of Changed Calls - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-CC) [Schema Changes - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-SC) [Announcements - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-AN) [New Features - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-NF) [Changed Functionality - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-CF) [Documentation Changes and Errata - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1301 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. #### Schema Changes - 1301 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `GetApiAccessRules` | Call | Removed | | `ApiAccessRuleType` | Type | Removed | | `AccessRuleCurrentStatusCodeType` | Type | Removed | | `AccessRuleStatusCodeType` | Type | Removed | | `GetApiAccessRulesRequestType` | Type | Removed | | `GetApiAccessRulesResponseType` | Type | Removed | ### Announcements - 1301 #### Buyers in the EU must be allowed to return an item within 14 days or more As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the **ReturnPolicy** container or through a return business policy that is referenced through the **SellerProfiles.SellerReturnProfile** container. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1301 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-CF) . None for this release. ### Changed Functionality - 1301 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetApiAccessRules Call Decommissioned The **GetApiAccessRules** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetApiAccessRules** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-SC) section. We recommend that you use the [Developer Analytics API](https://developer.ebay.com/api-docs/developer/analytics/static/overview.html) , an API that retrieves all usage data on all RESTful APIs and the Trading API. ### Documentation Changes and Errata - 1301 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-NF) and [Changed Functionality - 1301](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1301-CF) . None for this release. Version 1299 ------------ [Index of Changed Calls - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-CC) [Schema Changes - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-SC) [Announcements - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-AN) [New Features - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-NF) [Changed Functionality - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-CF) [Documentation Changes and Errata - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1299 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [VeROReportItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VeROReportItems.html#ChangeHistory) ### Schema Changes - 1299 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ReportItem.**Brand**` | Field | New | ### Announcements - 1299 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1299 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-CF) . None for this release. ### Changed Functionality - 1299 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Schema Added to Support VeRO Violation Reporting The field **Brand** was added to the **ReportItem** container to provide the brand name of the item being reported for VeRO violation. ### Documentation Changes and Errata - 1299 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-NF) and [Changed Functionality - 1299](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1299-CF) . None for this release. Version 1295 ------------ [Index of Changed Calls - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-CC) [Schema Changes - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-SC) [Announcements - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-AN) [New Features - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-NF) [Changed Functionality - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-CF) [Documentation Changes and Errata - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1295 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. #### Schema Changes - 1295 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `AddDispute` | Call | Removed | | `AddDisputeResponse` | Call | Removed | | `DisableUnpaidItemAssistance` | Call | Removed | | `GetDispute` | Call | Removed | | `GetUserDisputes` | Call | Removed | | `SellerReverseDispute` | Call | Removed | | `AddDisputeRequestType` | Type | Removed | | `AddDisputeResponseType` | Type | Removed | | `AddDisputeResponseRequestType` | Type | Removed | | `AddDisputeResponseResponseType` | Type | Removed | | `DisableUnpaidItemAssistanceRequestType` | Type | Removed | | `DisableUnpaidItemAssistanceResponseType` | Type | Removed | | `GetDisputeRequestType` | Type | Removed | | `GetDisputeResponseType` | Type | Removed | | `GetUserDisputesRequestType` | Type | Removed | | `GetUserDisputesResponseType` | Type | Removed | | `SellerReverseDisputeRequestType` | Type | Removed | | `SellerReverseDisputeResponseType` | Type | Removed | | `DisputeActivityCodeType` | Type | Removed | | `DisputeArrayType` | Type | Removed | | `DisputeCreditEligibilityCodeType` | Type | Removed | | `DisputeExplanationCodeType` | Type | Removed | | `DisputeFilterCountType` | Type | Removed | | `DisputeFilterTypeCodeType` | Type | Removed | | `DisputeIDType` | Type | Removed | | `DisputeMessageSourceCodeType` | Type | Removed | | `DisputeMessageType` | Type | Removed | | `DisputeReasonCodeType` | Type | Removed | | `DisputeRecordTypeCodeType` | Type | Removed | | `DisputeResolutionReasonCodeType` | Type | Removed | | `DisputeResolutionRecordTypeCodeType` | Type | Removed | | `DisputeResolutionType` | Type | Removed | | `DisputeSortTypeCodeType` | Type | Removed | | `DisputeStateCodeType` | Type | Removed | | `DisputeStatusCodeType` | Type | Removed | | `DisputeType` | Type | Removed | ### Announcements - 1295 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1295 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-CF) . None for this release. ### Changed Functionality - 1295 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Six Dispute Calls Decommissioned The following six Dispute calls have been decommissioned as of January 31, 2023. These calls and their exclusively used types have been removed from the Trading WSDL and from reference documentation: * **AddDispute** * **AddDisputeResponse** * **DisableUnpaidItemAssistance** * **GetDispute** * **GetUserDisputes** * **SellerReverseDispute** The **DisableUnpaidItemAssistance**, **AddDisputeResponse**, and **SellerReverseDispute** calls do not have alternative APIs to use since the Unpaid Item Assistant feature and Unpaid Item cases are deprecated. However, there is a page in Selling Preferences in My eBay that allows a seller to cancel and relist any items that have not been paid for after a specified amount of days. There are REST API equivalents for the other three calls as follows: * **AddDispute**: Use the [Create Cancellation Request](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation__post.html) method of the [Post-Order API](https://developer.ebay.com/devzone/post-order/index.html) to make an order cancellation request. * **GetDispute**: Use the [Get Cancellation](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) method of the [Post-Order API](https://developer.ebay.com/devzone/post-order/index.html) to retrieve details on a specific cancellation request. * **GetUserDisputes**: Use the [Search Cancellations](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement_search__get.html) method of the [Post-Order API](https://developer.ebay.com/devzone/post-order/index.html) to search for cancellation requests using a variety of search filters. #### GetOrderTransactions Call Deprecated The **GetOrderTransactions** call is deprecated and will be decommissioned on January 31, 2024. No further updates are planned for this API during the deprecation period. Developers have the option of migrating to the [GetOrders](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrders.html) call in the **Trading API**, or the [getOrders](https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders) method of the [Fulfillment API](https://developer.ebay.com/api-docs/sell/fulfillment/overview.html) . Please note that the [Fulfillment API](https://developer.ebay.com/api-docs/sell/fulfillment/overview.html) only returns paid orders, so if your use case calls for retrieving both paid and unpaid orders, we recommend migrating to the [GetOrders](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrders.html) call in the **Trading API**. ### Documentation Changes and Errata - 1295 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-NF) and [Changed Functionality - 1295](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1295-CF) . None for this release. Version 1291 ------------ [Index of Changed Calls - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-CC) [Schema Changes - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-SC) [Announcements - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-AN) [New Features - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-NF) [Changed Functionality - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-CF) [Documentation Changes and Errata - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1291 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) ### Schema Changes - 1291 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**Regulatory**` | Container | New | | `Regulatory.**Hazmat**` | Container | New | | `Regulatory.Hazmat.**Component**` | Field | New | | `Regulatory.Hazmat.**Pictograms**` | Container | New | | `Regulatory.Hazmat.Pictograms.**Pictogram**` | Field | New | | `Regulatory.Hazmat.**SignalWord**` | Field | New | | `Regulatory.Hazmat.**Statements**` | Container | New | | `Regulatory.Hazmat.Statements.**Statement**` | Field | New | | `Regulatory.**RepairScore**` | Field | New | | `**RegulatoryType**` | Type | New | | `**HazmatType**` | Type | New | | `**PictogramsType**` | Type | New | | `**StatementsType**` | Type | New | ### Announcements - 1291 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1291 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-CF) . #### New Schema Added to Support Hazardous Material Label Related Information and Repair Score Due to regulatory requirement changes, sellers now have the ability to provide hazardous material related information and the repair score for listings. ### Changed Functionality - 1291 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Codes for 1291 Below is the list of the new error messages that rolled out with the 1291 release. All of these messages are related to using hazardous material related information and repair score. The long version of each message is used below. * (Warning) `**21920371**`: `_replaceable_value_ ID(s) _replaceable_value_ not found. Please use valid ID(s).` * (Warning) `**21920372**`: `Duplicate Regulatory ID(s) _replaceable_value_ sent in the request. Duplicate ID(s) have been ignored.` * (Warning) `**21920373**`: `Hazmat structure incorrect for _replaceable_value_.` * (Error) `**21920374**`: `Repair score invalid. Repair score must be in the range from _replaceable_value_ to _replaceable_value_ with one decimal place.` * (Error) `**21920375**`: `The value of the _replaceable_value_ field is invalid. Field must not exceed _replaceable_value_ characters.` These error and warning messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1291 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-NF) and [Changed Functionality - 1291](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1291-CF) . None for this release. Version 1285 ------------ [Index of Changed Calls - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-CC) [Schema Changes - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-SC) [Announcements - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-AN) [New Features - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-NF) [Changed Functionality - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-CF) [Documentation Changes and Errata - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1285 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1285 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1285 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1285 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-CF) . None for this release. ### Changed Functionality - 1285 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Updated Picture Limit This release of the Trading API updates the picture limit. With the exception of motor vehicle listings on the US and Canada marketplaces, sellers can now include up to 24 pictures in a listing free of charge in all categories on all marketplaces. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see [Fees for selling vehicles on eBay Motors](https://www.ebay.com/help/selling/fees-credits-invoices/motors-fees?id=4127) ). ### Documentation Changes and Errata - 1285 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-NF) and [Changed Functionality - 1285](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1285-CF) . None for this release. Version 1281 ------------ [Index of Changed Calls - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-CC) [Schema Changes - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-SC) [Announcements - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-AN) [New Features - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-NF) [Changed Functionality - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-CF) [Documentation Changes and Errata - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1281 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1281 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `AccountDetailEntryCodeType.FedExReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.FedExReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.AUPostReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.AUPostReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.UpsCaLabelFee` | Enum | New | | `AccountDetailEntryCodeType.UpsCaLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.FedExCaLabelFee` | Enum | New | | `AccountDetailEntryCodeType.FedExCaLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.HubbedReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.HubbedReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.RoyalMailReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.RoyalMailReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.ParcelForcePostReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.ParcelForcePostReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.OffsiteAdsFee` | Enum | New | | `AccountDetailEntryCodeType.OffsiteAdsFeeCredit` | Enum | New | | `CancelReasonCodeType.AddressIssues` | Enum | New | | `CancelReasonCodeType.BuyerCancelOrAddressIssue` | Enum | Deprecated | | `Item.IsItemEMSEligible` | Field | New | ### Announcements - 1281 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### EU and UK Payments regulations update: Digital Signatures Due to EU and UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers, including **GetAccount**. Refer to [Digital Signatures for APIs](https://developer.ebay.com/develop/guides/digital-signatures-for-apis) for information about creating signatures to be included in the HTTP payload. ### New Features - 1281 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-CF) . #### New item eligibility flag for shipping managed by eBay The new boolean field **IsItemEMSEligible** was added to the **GetItem** call (in **ItemType**). If `true`, the item is eligible for shipping managed by eBay; `false`, the item is not eligible for shipping managed by eBay. ### Changed Functionality - 1281 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Updates to GetAccount Call Sixteen new enumeration values were added for **GetAccount** (in **AccountDetailEntryCodeType**) to account for new account fees/credits. The enumeration values include: * `FedExReturnLabelFee` * `FedExReturnLabelFeeCredit` * `AUPostReturnLabelFee` * `AUPostReturnLabelFeeCredit` * `UpsCaLabelFee` * `UpsCaLabelFeeCredit` * `FedExCaLabelFee` * `FedExCaLabelFeeCredit` * `HubbedReturnLabelFee` * `HubbedReturnLabelFeeCredit` * `RoyalMailReturnLabelFee` * `RoyalMailReturnLabelFeeCredit` * `ParcelForcePostReturnLabelFee` * `ParcelForcePostReturnLabelFeeCredit` * `OffsiteAdsFee` * `OffsiteAdsFeeCredit` See these new values in [AccountDetailEntryCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for more information. #### Updates to CancelReasonCodeType type A new enumerated value `AddressIssues` was added and the enumerated value `BuyerCancelOrAddressIssue` was Deprecated. See the new value in [CancelReasonCodeType](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/CancelReasonCodetype.html) for more information. #### Shipping service override changes to business policies When revising or relisting an item that is using business policies and has one or more shipping service cost overrides set up, the **Item.SellerProfiles.SellerShippingProfile** container and the **Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride** container(s) must be included even if no changes are being made. #### Australia sellers offering freight shipping changes Sellers offering freight shipping on the Australia (AU) marketplace must now use the `AU_Freight` enumeration value for **ShippingServiceCodeType**. For these sellers, the `Freight` value will no longer be accepted and may lead to a blocking error. ### Documentation Changes and Errata - 1281 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-NF) and [Changed Functionality - 1281](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1281-CF) . None for this release. Version 1279 ------------ [Index of Changed Calls - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-CC) [Schema Changes - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-SC) [Announcements - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-AN) [New Features - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-NF) [Changed Functionality - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-CF) [Documentation Changes and Errata - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1279 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItemTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1279 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ShippingDetails.eBayEstimatedLabelCost` | Field | New | ### Announcements - 1279 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1279 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-CF) . #### Added support for eBay shipping The return of the **eBayEstimatedLabelCost** field with a value of `0.0` indicates that a free shipping label by eBay is downloadable by the seller via the eBay website. See more details about [Authenticity Guarantee](https://pages.ebay.com/authenticity-guarantee-sneakers-seller/) and how eBay shipping applies to eligible sneaker listings. ### Changed Functionality - 1279 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Codes for 1279 Below is the list of the new error messages that rolled out with the 1279 release. All of these messages are related to using eBay Shipping. The long version of each message is used below. * (Warning) `**21920343**`: `_replaceable_value_. // Mapped to authenticity guarantee notification message` * (Warning) `**21920344**`: `_replaceable_value_. // Mapped to eBay shipping notification message` * (Warning) `**21920345**`: `This listing is not eligible for eBay shipping. Option ignored.` * (Error) `**21920346**`: `This listing qualifies for eBay shipping. Local pickup only is not a valid shipping option.` * (Error) `**21920347**`: `This listing qualifies for eBay shipping. Handling time must not exceed 3 days.` * (Warning) `**21920348**`: `_replaceable_value_ has been dropped as no domestic shipping service was provided.` These error and warning messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1279 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-NF) and [Changed Functionality - 1279](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1279-CF) . None for this release. Version 1275 ------------ [Index of Changed Calls - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-CC) [Schema Changes - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-SC) [Announcements - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-AN) [New Features - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-NF) [Changed Functionality - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-CF) [Documentation Changes and Errata - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1275 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1275 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1275 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1275 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-CF) . #### A new intermediated international shipping program has been added A new intermediated international shipping program called eBay International Shipping is available. On the US marketplace, the Global Shipping Program is scheduled to be replaced by this new intermediated shipping program (eBay International Shipping). US Sellers opted in to the Global Shipping Program will automatically get opted into eBay International Shipping once it becomes available to them. All US sellers will be migrated by March 31, 2023. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Support for eBay International Shipping has been added to **GetOrders**, **GetSellerTransactions**, **GetItemTransactions**, and **GetOrderTransactions** calls. The eBay International Shipping partner's address is shown in the **MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress** container. Additionally, similar to the **ReferenceID** field provided for the Global Shipping Program, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to the **Street2** field (not in the **ReferenceID** field). ### Changed Functionality - 1275 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1275 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-NF) and [Changed Functionality - 1275](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1275-CF) . None for this release. Version 1267 ------------ [Index of Changed Calls - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-CC) [Schema Changes - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-SC) [Announcements - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-AN) [New Features - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-NF) [Changed Functionality - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-CF) [Documentation Changes and Errata - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1267 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1267 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1267 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### Four Store Calls Scheduled for Decommission on September 30 The new Stores platform no longer supports custom store pages and other customization functionality, so the following four store calls are deprecated and scheduled for decommission on September 30, 2022: * [GetStoreCustomPage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStoreCustomPage.html) * [GetStoreOptions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStoreOptions.html) * [SetStore](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SetStore.html) * [SetStoreCustomPage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SetStoreCustomPage.html) Although these four calls still work and will continue to work up until the decommission date, it is recommended that they are no longer used since none of the customization features in these calls can be applied to stores in the Production environment Additionally, the following containers and fields related to store customization in the **GetStore** call are also deprecated and scheduled for decommission on September 30, 2022: * [CustomHeader](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.CustomHeader) (string) * [CustomHeaderLayout](https://developer.ebay.com/keystone/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.CustomHeaderLayout) (enum) * [CustomListingHeader](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.CustomListingHeader) (whole container) * [ExportListings](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.ExportListings) (boolean) * [HeaderStyle](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.HeaderStyle) (enum) * [HomePage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.HomePage) (long) * [ItemListLayout](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.ItemListLayout) (enum) * [ItemListSortOrder](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.ItemListSortOrder) (enum) * [Logo.LogoID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.Logo.LogoID) (int) * [Logo.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.Logo.Name) (string) * [Theme](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.Theme) (whole container) * [TitleWithCompatibility](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.TitleWithCompatibility) (boolean) ### New Features - 1267 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-CF) . None for this release. ### Changed Functionality - 1267 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1267 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-NF) and [Changed Functionality - 1267](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1267-CF) . None for this release. Version 1257 ------------ [Index of Changed Calls - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-CC) [Schema Changes - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-SC) [Announcements - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-AN) [New Features - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-NF) [Changed Functionality - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-CF) [Documentation Changes and Errata - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1257 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1257 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `HitCounterCodeType` | Type | Removed | | `Item.HitCounter` | Field | Removed | ### Announcements - 1257 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1257 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-CF) . None for this release. ### Changed Functionality - 1257 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### HitCounter field removed from WSDL The **HitCounter** field has been removed from the WSDL. It can no longer be used in Add/Revise calls, nor will it be returned in **GetItem**, **GetBidderList**, **GetSellerEvents**, or **GetSellerList**. #### HitCount field updates The **HitCount** field will no longer be returned in **GetItem** or **GetBidderList**, but it will continue to be returned in **GetSellerEvents** and **GetSellerList**, but with a logic change. Instead of the **HitCount** value representing the lifetime hit count for listings, the value will be the total number of page hits within the latest 30-day period. #### Quantity and StartPrice no longer returned in ReviseInventoryStatus The **Quantity** and **StartPrice** fields will no longer be returned in the **ReviseInventoryStatus** response. However, these fields will function the same as before in **ReviseInventoryStatus** request. If users would like to verify if their price and/or quanity changes were successfully pushed out to the listing (or variation within a listing), they can use the **GetItem** call to verify the changes. ### Documentation Changes and Errata - 1257 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-NF) and [Changed Functionality - 1257](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1257-CF) . None for this release. Version 1255 ------------ [Index of Changed Calls - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-CC) [Schema Changes - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-SC) [Announcements - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-AN) [New Features - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-NF) [Changed Functionality - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-CF) [Documentation Changes and Errata - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1255 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1255 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `GetCategorySpecificsRequest` | Type | Removed | | `GetCategorySpecificsResponse` | Type | Removed | | `AspectUsageCodeType` | Type | Removed | | `CategoryItemSpecificsType` | Type | Removed | | `NameRecommendationType` | Type | Removed | | `NameValueRelationshipType` | Type | Removed | | `ProductRequiredCodeType` | Type | Removed | | `RecommendationsType` | Type | Removed | | `RecommendationValidationRulesType` | Type | Removed | | `RelevanceIndicatorType` | Type | Removed | | `SelectionModeCodeType` | Type | Removed | | `UsageConstraintCodeType` | Type | Removed | | `ValueFormatCodeType` | Type | Removed | | `ValueRecommendationType` | Type | Removed | | `VariationPictureRuleCodeType` | Type | Removed | | `VariationSpecificsRuleCodeType` | Type | Removed | ### Announcements - 1255 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### GetCategorySpecifics Call Decommisioned The **GetCategorySpecifics** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetCategorySpecifics** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-SC) section. The alternative solution to **GetCategorySpecifics** is the [getItemAspectsForCategory](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/category_tree/methods/getItemAspectsForCategory) method of the [Taxonomy API](https://developer.ebay.com/api-docs/commerce/taxonomy/overview.html) . For more information about migrating to the [Taxonomy API](https://developer.ebay.com/api-docs/commerce/taxonomy/overview.html) and using the [Taxonomy SDK](https://github.com/eBay/taxonomy-sdk) , see the [Taxonomy API migration guide](https://developer.ebay.com/api-docs/commerce/static/migration-landing.html) . ### New Features - 1255 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-CF) . None for this release. ### Changed Functionality - 1255 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1255 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-NF) and [Changed Functionality - 1255](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1255-CF) . None for this release. Version 1249 ------------ [Index of Changed Calls - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-CC) [Schema Changes - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-SC) [Announcements - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-AN) [New Features - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-NF) [Changed Functionality - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-CF) [Documentation Changes and Errata - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1249 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1249 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1249 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1249 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-CF) . None for this release. ### Changed Functionality - 1249 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Extended producer responsibility related information returned Sellers can now return their listing's extended producer responsibility related information using the **GetItem** call. ### Documentation Changes and Errata - 1249 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-NF) and [Changed Functionality - 1249](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1249-CF) . None for this release. Version 1247 ------------ [Index of Changed Calls - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-CC) [Schema Changes - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-SC) [Announcements - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-AN) [New Features - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-NF) [Changed Functionality - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-CF) [Documentation Changes and Errata - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page and the [Knowledge Base](https://developer.ebay.com/support/knowledge-base) . ### Index of Changed Calls - 1247 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GetItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetSellerEvents](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerEvents.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1247 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1247 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### Winter 2022 Seller Updates Available The [Winter 2022 Seller Updates](https://pages.ebay.com/seller-center/seller-updates/2022-winter/index.html) have been released. Below is a high-level summary of the updates: * More robust sales data available under **Performance** tab in **Seller Hub** * Updates and expansion for all Promoted Listings products (Standard, Express, and Advanced) * More sellers will get the option of requiring all buyers to provide payment details before making a Best Offer on a listing, reducing the risk of Unpaid Items for Best Offer transactions * More sellers will get the option of requiring all buyers to provide payment details before making a Best Offer on a listing, reducing the risk of Unpaid Items for Best Offer transactions * Upcoming updates to order fees and credits * Sellers will now be refunded the $0.30 per-order fee for orders that are cancelled at the buyer's request * The additional final value fee charged to Below Standard sellers will increase from 5% to 6% (of sales price) * Final value fees will have a slight increase for most categories (0.3% for Store sellers and 0.35% for non-Store sellers). See the [Selling Fees Updates](https://pages.ebay.com/seller-center/seller-updates/2022-winter/fees-update.html) table for the full list of fee increases. * Listing Subtitle fee increases by $0.50 for both fixed-price and auction listings * Starting in May 2022, sellers will get partial final value fee credits for partial refunds * Starting in June 2022, the Promoted Listings Standard fee will be calculated based on the total order cost (including applicable taxes and shipping), and not just the sales price ### New Features - 1247 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-CF) . None for this release. ### Changed Functionality - 1247 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. #### HitCounter and HitCount Fields Deprecated Hit counters are no longer displayed in View Item pages, so the [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.HitCounter) and [HitCount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCount) fields are no longer applicable and are scheduled for decommission. For developers/sellers who are interested in seeing page views and listing performance, the [getTrafficReport](https://developer.ebay.com/api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport) method of the [Sell Analytics API](https://developer.ebay.com/api-docs/sell/analytics/overview.html) can be used. Currently, if the [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.HitCounter) field is used in the request payload of an add/revise/relist/verify call, the field will be ignored and a warning message will be returned. Until both fields are decommissioned, the [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCounter) and [HitCount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCount) fields will still be returned in [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCount) , [GetBidderList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetBidderList.html#Response.BidItemArray.Item.HitCount) , [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerEvents.html#Response.ItemArray.Item.HitCount) , and [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.HitCount) . For [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/HitCounterCodeType.html) , the default value for the marketplace will be returned, such as `NoHitCounter` or `HiddenStyle`. ### Documentation Changes and Errata - 1247 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-NF) and [Changed Functionality - 1247](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1247-CF) . None for this release. Version 1235 ------------ [Index of Changed Calls - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-CC) [Schema Changes - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-SC) [Announcements - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-AN) [New Features - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-NF) [Changed Functionality - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-CF) [Documentation Changes and Errata - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page and the [Knowledge Base](https://developer.ebay.com/support/knowledge-base) . ### Index of Changed Calls - 1235 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1235 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . **Note:** Support for extended producer responsibility regulations and custom policies will become active mid-December 2021. Additional resources such as the custom policies resource (for the **Account API**), the **getExtendedProducerResponsibilityPolicies** method (for the **Sell Metadata API**), and the [Custom Policies](https://www.ebay.com/help/selling/custom-policies/custom-policies?id=5311) help page will also become active. | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ExtendedProducerResponsibilityType` | Type | New | | `Item.ExtendedProducerResponsibility` | Field | New | | `Item.ExtendedProducerResponsibility.ProducerProductId` | Field | New | | `Item.ExtendedProducerResponsibility.ProductPackageId` | Field | New | | `Item.ExtendedProducerResponsibility.ShipmentPackageId` | Field | New | | `Item.ExtendedProducerResponsibility.ProductDocumentationId` | Field | New | | `Item.ExtendedProducerResponsibility.EcoParticipationFee` | Field | New | | `CustomPoliciesType` | Type | New | | `Item.CustomPolicies` | Field | New | | `Item.CustomPolicies.TakeBackPolicyId` | Field | New | | `Item.CustomPolicies.ProductCompliancePolicyId` | Field | New | | `Item.Variations.Variation.VariationExtendedProducerResponsibility` | Field | New | | `VariationExtendedProducerResponsibilityType` | Type | New | | `Item.Variations.Variation.VariationExtendedProducerResponsibility.Item.Variations.Variation.EcoParticipationFee` | Field | New | ### Announcements - 1235 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1235 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-CF) . **Note:** Support for extended producer responsibility regulations and custom policies will become active mid-December 2021. Additional resources such as the custom policies resource (for the **Account API**), the **getExtendedProducerResponsibilityPolicies** method (for the **Sell Metadata API**), and the [Custom Policies](https://www.ebay.fr/help/selling/custom-policies/custom-policies?id=5311) help page will also become active. #### New Schema added to support custom policies To support custom policies, policy IDs can be specified in add, revise, relist, or verify calls. This feature is supported by a limited number of sites and specific categories. Refer to the [Metadata API](https://developer.ebay.com/api-docs/sell/metadata/overview.html) to return the enabled sites and categories. To create and manage custom policies, see the [Account API](https://developer.ebay.com/api-docs/sell/account/overview.html) . * **CustomPolicies**: This container and its child fields are used to specify custom policy IDs. #### New Schema added to support extended producer responsibility regulations To support new extended producer responsibility regulations, information about the producer of a new item can be specified in add, revise, relist, or verify calls. This feature is supported by a limited number of sites and specific categories. Refer to the [Metadata API](https://developer.ebay.com/api-docs/sell/metadata/overview.html) to return the enabled sites and categories. * **ExtendedProducerResponsibility**: This container field provides information about the producer of the new item. This includes producer, packaging, shipment packaging, and added documentation IDs, and the **EcoParticipationFee**. * **VariationExtendedProducerResponsibility**: This container field defines variation-specific Extended Producer Responsibility information, specifically the **EcoParticipationFee** in add, revise, relist, or verify calls. ### Changed Functionality - 1235 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Codes for 1235 Below is the list of the new error messages that rolled out with the 1235 release. All of these messages are related to using Extended Producer Responsibility. The long version of each message is used below. * (Warning) `**21920322**`: `_replaceable_value_ is not applicable and has been dropped.` * (Error) `**21920323**`: `_replaceable_value_ is required for this category.` * (Warning) `**21920324**`: `Eco Participation Fee is not applicable for the condition and has been dropped.` * (Error) `**21920325**`: `Eco Participation Fee is not valid and needs to be a number between _replaceable_value_ and _replaceable_value_.` * (Error) `**21920326**`: `_replaceable_value_ is not valid.` * (Error) `**21920327**`: `_replaceable_value_ cannot be revised if the item has a bid or is ending within 12 hours._replaceable_value_ business day(s).` * (Warning) `**21920328**`: `Same policy ID(ies) _replaceable_value_ cannot be specified multiple times.` * (Error) `**21920329**`: `Only _replaceable_value_ policies can be specified, But given policies are _replaceable_value_.` * (Error) `**21920330**`: `The specified _replaceable_value_ policy(ies) _replaceable_value_ are not found.` * (Error) `**21920331**`: `The policy(ies) _replaceable_value_ is not of type _replaceable_value_.` * (Warning) `**21920332**`: `Item level Eco Participation Fee will be ignored for MSKU items.` These error and warning messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1235 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-NF) and [Changed Functionality - 1235](https://developer.ebay.com/DevZone/XML/docs/ReleaseNotesArchive.html#1235-CF) . None for this release. --- # Location feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-location-feed.html#mainContent) A location response tells you if all the data in the location feed was processed successfully or not. The following table explains the elements or fields in the location response file. Sample response files: * [location-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/location-response.csv) * [location-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/location-response.xml) **Note:** The fields in the table below are ordered according to their order in the CSV response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML response file. | Field name | Description | | --- | --- | | CSV: `location`

XML: `location.locationID` | The warehouse or store where the item will ship from.

**Occurrence**: Always Returned | | CSV: `status`

XML: `location.status` | The result of the action requested in the uploaded feed:

* `SUCCESS`: Indicates the location has been successfully added or updated.
* `FAILED`: Indicates the location has failed to be added or updated.

**Occurrence**: Always Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue creating or updating the location.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue creating or updating the location.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue creating or updating the location. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Additional container in XML response ------------------------------------ In addition to the fields called out in the table above, the Product feed response file will also have a **feedSummary** container. See [XML feedSummary container](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#XML) for details. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Availability feed definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-availability-feed.html#mainContent) An Availability feed is used to provide total "ship-to-home" quantity or quantity available at a specific seller location (warehouse or store). This feed type can also be used for large merchants enabled to sell through eBay's 'Buy online, pick up in store' (BOPIS) or 'Click and Collect' programs. Sample feed files: * [availability.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-csv/availability.csv) * [availability.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-xml/availability.xml) * [availability-bopis.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-csv/availability-bopis.csv) * [availability-bopis.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-xml/availability-bopis.xml) **Important!** When using product combined feeds, always include the product feed that contains the product information. Do not submit [product combined feeds](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-combined-feeds.html) with distribution and/or availability information only. This may erase all previously submitted product information. See [Using product combined feeds](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-combined-feeds.html) for more information. **Note:** If a seller only wants to provide "ship-to-home" quantity, the **availability.csv** or **availability.xml** files should be used (using the two fields **SKU** and **Total Ship to Home Quantity**). BOPIS and 'Click and Collect' sellers, or sellers who want to upload location-specific quantity, must use the **availability-bopis.csv** or **availability-bopis.xml** files. Availability feeds ------------------ The following table describes the fields available in the Availability feed request file, and how they are used. **Note:** The fields in the table below are ordered according to their order in the CSV feed file. The parent is provided for XML fields in order to make it easier to locate that field in the XML feed file. The **availability.csv** or **availability.xml** files only have **SKU** and **Total Ship to Home Quantity** fields; the **availability-bopis.csv** or **availability-bopis.xml** files have all fields shown in the table. | Field name | Description | Notes | | --- | --- | --- | | CSV:
`SKU`

XML:
`inventory.SKU` | **Required.** The product's Stock Keeping Unit value, defined by the seller to identify the product. This value must be unique across the seller's inventory on each eBay marketplace.

**Type:** string

**Max length**: 50 | | | CSV:
`Total Ship to Home Quantity`

XML:
`inventory.totalShipToHomeQuantity` | **Conditionally Required.** This integer value indicates the total quantity of items available to ship, and not tied to a specific location.

**Type:** integer | Either a total "ship-to-home" quantity value, a quantity value for one or more specific locations, or both types of quantity must be supplied in an Availability feed request file.

The total location-specific quantity for a SKU should not be greater than the total "ship-to-home" quantity value. | | CSV:` LocationID`

XML:
`location.locationID` | **Required for In-Store Pickup and Click and Collect; optional otherwise**. The seller-defined unique identifier for a warehouse or store location that has quantity available for the SKU. See [Location feed definitions](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-location-feed.html)
for more information about setting an inventory location.

**Type**: string

**Max length**: 32 | If a seller is only providing `Total Ship to Home Quantity` for the SKU, this field does not need to be in the CSV or XML file. | | CSV:` FulfillmentType`

XML:` fulfillmentMethod.fulfillmentType` | **Required for In-Store Pickup and Click and Collect; optional otherwise**. Sets the fulfillment type for the SKU. Suppoorted values are `SHIP_TO_HOME` and `PICKUP_IN_STORE` (this value only available to In-Store Pickup and Click and Collect sellers). If the `PICKUP_IN_STORE` value is used, the seller must also set the **Pickup In Store Eligible** field to "true' in field in the Distribution feed (see [Distribution feed definitions](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-distribution-feed.html)
).

**Type**: string | If a seller is only providing `Total Ship to Home Quantity` for the SKU, this field does not need to be in the CSV or XML file. | | CSV:
`Quantity`

XML:
`fulfillmentMethod.quantity` | **Conditionally Required.** The total quantity of items available from the location specified through the Location ID field. In accordance with the Fulfillment Type value, this quantity might be "ship-to-home" quantity, or quantity available at an In-Store Pickup or Click and Collect seller's store location.

**Type**: integer | Either a total "ship-to-home" quantity value, a quantity value for one or more specific locations, or both types of quantity must be supplied in an Availability feed request file.

The total location-specific quantity for a SKU should not be greater than the total "ship-to-home" quantity value.

If a seller is only providing `Total Ship to Home Quantity` for the SKU, this field does not need to be in the CSV or XML file. | | CSV:
`Available`

XML:` fulfillmentMethod.available` | **Required for In-Store Pickup and Click and Collect; not applicable otherwise**. This field is used to provide more information about the SKU's availability at the store location. Supported values include the following:

* `IN_STOCK`: this is the most common value, and should be the value is the corresponding Quantity field is greater than 0.
* `OUT_OF_STOCK`: this value is used if the store location is currently out-of-stock for the SKU.
* `SHIP_TO_STORE`: this value is used if the store location is currently out-of-stock for the SKU, but quantity is being shipped to that store location.

**Type**: string | If a seller is only providing `Total Ship to Home Quantity` for the SKU, this field does not need to be in the CSV or XML file. | | CSV:` FulfillmentTime`

XML:` fulfillmentMethod.fulfillmentTime` | **Optional**. This integer value indicates the number of hours after payment that the item will be available for pickup at the store location. This field is only applicable for `PICKUP_IN_STORE` fulfillment type. If this field is not included in the call payload, eBay will use the default fulfillment time contained in the merchant's profile.

**Type**: string | If a seller is only providing `Total Ship to Home Quantity` for the SKU, this field does not need to be in the CSV or XML file. | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Distribution feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-distribution-feed.html#mainContent) A distribution response tells you if all the data in a distribution feed was processed successfully or not. The following table explains all the elements or fields in the distribution response file. Sample response files: * [distribution-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/distribution-response.csv) * [distribution-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/distribution-response.xml) **Note:** The fields in the table below are ordered according to their order in the CSV response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML response file. | Field name | Description | | --- | --- | | CSV: `SKU`

XML: `productDetail.SKU` | The product's Stock Keeping Unit value, defined by the seller to identify the product. This value must be unique across the seller's inventory on each eBay marketplace.

**Occurrence**: Always Returned

**Max length**: 50 | | CSV: `Group ID`

XML:
`productDetail.groupID` | The unique identifier for a product group that is used for a multiple-variation listing. This field will only be returned for SKUs that are assigned to a product group.

**Occurrence**: Conditionally Returned

**Max length**: 50 | | CSV: `Locale`

XML: Not returned in XML response | Specifies the language used for data in the listing. The default language of the eBay marketplace is used if this field is not supplied in the input file. Values include `en_US`, `en_GB`, `es_ES`, `fr_FR`, and others. See [Locale enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-locale.html)
for full list.

**Occurrence**: Always Returned (CSV only) | | CSV:
`Channel ID`

XML: `productDetail.Channel ID` | The unique identifier of the eBay marketplace where the SKU is/will be listed. Values include `EBAY_US`, `EBAY_GB`, `EBAY_DE`, and others. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list.

Channel ID is an optional field in regular Product feeds (CSV ad XML), so it will only be returned if set in the input file.

**Occurrence**: Always Returned | | CSV: `Item ID`

XML: `productDetail.itemID` | The unique identifier of the listing where the SKU is being offered. If a SKU was not created/updated successfully, and is not currently in an active listing, this field is not returned.

**Occurrence**: Conditionally Returned (CSV only) | | CSV: `Status`

XML:
`productDetail.status` | The value in this field indicates whether the SKU was successfully uploaded/updated in MIP. This is an item-level field, and some items may succeed and others may fail. Valid values are `SUCCESS`: and `FAILED`. For SKUs with `FAILED`, there is generally an error message include in the response file.

**Occurrence**: Always Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue creating or updating the distribution.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue creating or updating the distribution.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue creating or updating the distribution. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Additional container in XML response ------------------------------------ In addition to the fields called out in the table above, the feed response file will also have a **feedSummary** container. See [XML feedSummary container](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#XML) for details. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # SiteID | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/site-id.html#mainContent) SiteID an enumerated value that specifies the name of the eBay listing marketplace. The listing marketplace affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay marketplace. For example, the listing marketplace can affect the validation of **Category** in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay marketplace, the visibility of the item in some types of searches (e.g., **GetCategoryListings**,) and other information. In some cases, the rules are determined by a combination of the marketplace, the user's registration address, and other information. When passing an [Item.Site](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Site) value in an [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) or [AddFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html) call, the value must be consistent with the numeric site ID that is specified in the request URL (for the SOAP API) or the `X-EBAY-API-SITEID` header (for the XML API). For a complete list of available values, refer to [SiteCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/SiteCodeType.html) . **Note:** When revising a listing, the value for [Item.Site](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Site) cannot be changed. **Argument:** [Item.Site](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Site) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise a charity listing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/charitable-listings-revise.html#mainContent) A revise call can be used to add a benefiting charity to an existing _auction_ or _fixed-price_ listing as long as more than 12 hours remain in the duration of the listing. However, a charity can **not** be added to an existing _classified ad_ listing using a revise call. Additionally, a charity cannot be removed or changed from a listing using a revise call once it has already been added at listing time. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Location feed definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-location-feed.html#mainContent) This topic provides definitions for the fields in the location feed. Sample feed files: * [location.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-csv/location.csv) * [location.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-feed-xml/location.xml) **Note:** The fields in the table below are ordered according to their order in the CSV feed file. The parent is provided for XML fields in order to make it easier to locate that field in the XML feed file. | Field name | Description | | --- | --- | | CSV: `Location ID`

XML: `location.locationID` | **Required.** The identifier for the store.

**Type:** string

**Max length:** 36 characters | | CSV: `Name`

XML: `location.name` | **Required.** The store's name.

**Type:** string

**Max length:** 128 characters | | CSV: `Address 1`

XML: `location.address1` | **Required for store locations; optional but recommended for other locations**: The street address of the location.

**Type:** string

**Max length:** 128 characters | | CSV: `Address 2`

XML: `location.address2` | **Optional.** The second line of the street address, if needed. This second line might include suite number.

**Type:** string

**Max length:** 128 characters | | CSV: `City`

XML: `location.city` | **Required for store locations.** The city where the store is located.

**Type:** string

**Max length:** 128 characters | | CSV: `Region`

XML: `location.region` | **Required for store locations.** The state or region where the store is located, typically a two-character abbreviation for a state or province.

**Type:** string

**Max length:** 128 characters | | CSV: `Postal Code`

XML: `location.postalCode` | **Required for store locations.** The postal code where the store is located.

**Type:** string

**Max length:** 16 characters | | CSV: `Country`

XML: `location.country` | **Required.** The country where the store is located.

The value must be ISO 3166 three-digit codes. See: [https://www.iso.org/iso-3166-country-codes.html](https://www.iso.org/iso-3166-country-codes.html)

**Type:** string

**Max length:** 3 characters | | CSV: `Latitude`

XML: `location.latitude` | **Optional.** The geographical latitude of the store. Always used together with longitude.

**Type:** decimal

**Max length:** 10 digits | | CSV: `Longitude`

XML: `location.longitude` | **Optional.** The geographical longitude of the store. Always used together with latitude.

**Type:** decimal

**Max length:** 10 digits | | CSV: `Hours`

XML:
`location.hours` and its child nodes | **Optional.** The store hours per day. "1" is Monday, "2" is Tuesday, and so on.

A 4096-character max string. The data must be in JSON format.

**CSV example**

Convert XML to CSV style JSON

{
"1" : \[{"Open":"09:00:00", "Close":"12:00:00"}, {"Open":"13:00:00", "Close":"22:30:00"}\],
"2" : \[{"Open":"09:00:00", "Close":"22:30:00"}\],
"3" : \[{"Open":"09:00:00", "Close":"22:30:00"}\],
"4" : \[{"Open":"09:00:00", "Close":"22:30:00"}\],
"5" : \[{"Open":"09:00:00", "Close":"22:30:00"}\],
"6" : \[{"Open":"09:00:00", "Close":"22:30:00"}\],
"7" : \[{"Open":"09:00:00", "Close":"22:30:00"}\]
}

**XML example**



1

08:00:00
23:00:00



2

08:00:00
23:00:00



•••


7

08:00:00
21:00:00




**Type:**

CSV: JSON

XML: integer, time | | CSV:
`Special Hours`

XML:
`location.specialHours` and its child nodes | **Optional.** Special hours in addition to regular hours noted above.

A 4000-character max string. The data must be in JSON format.

**CSV example**

Convert XML to CSV style JSON

{
"2014-11-24" : \[{"Open":"09:00:00", "Close":"11:30:00"}, {"Open":"13:30:00", "Close":"17:30:00"}\],
"2014-11-25" : \[{"Open":"09:00:00", "Close":"11:30:00"}, {"Open":"13:30:00", "Close":"17:30:00"}\]
}

**XML example**



2013-11-24

09:00:00
11:30:00


13:30:00
17:30:00



2013-12-25



**Type:**

CSV: JSON

XML: date, time | | CSV: `UTC Offset`

XML: `location.utcOffset` | **Conditionally required, if hours or special hours are set.** The time zone difference from GMT.

For example: `-05:00`

**Type:** string

**Max length:** 8 characters | | CSV: `Phone`

XML: `location.phone` | **Optional, but recommended.** The phone number of the store. Applies to store locations only.

**Type:** string

**Max length:** 32 characters | | CSV: `url`

XML: `location.url` | **Optional, but recommended.** The URL of the store's website. Applies to store locations only.

**Type:** string | | CSV:
`Pickup Instructions`

XML:
`location.pickupInstructions` | Special instructions for picking up the item.

For example: `Go to Customer Service desk, not the checkout register.`

**Type:** string

**Max length:** 2048 characters | | CSV: `Status`

XML: `location.status` | Enables or disables a store location.

A string with these valid values:

* `ENABLE` (default)

* `DISABLE`


If omitted, this field is set to its default value (`ENABLED`). To disable a location, the seller can set this value to `DISABLE`. This disables an active location. This can be useful when creating a new location but do not want it initially enabled.

**Type:** string | | CSV:` Fulfillment Capability`

XML:
`location.fulfillmentType` | The location where the product can be picked up or delivered. A string with these valid values:

* `PICKUP_IN_STORE`
* `SHIP_TO_HOME`

**Important!** If you use PICKUP\_IN\_STORE, you must also set **pickupInStoreEligible** in the distribution feed. See [Distribution feed definitions](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-distribution-feed.html)

The data must be in JSON format.

**CSV example**

Convert to CSV style JSON

{"fulfillmentCapability":\["PICKUP\_IN\_STORE","SHIP\_TO\_HOME"\]}

**XML example**

**Type:** string | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # CategoryID | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/category-id.html#mainContent) A primary category on the selected marketplace must be specified for all listings. Sellers have the option of specifying a secondary category for the same item on the same marketplace. If a secondary category is selected, the item is listed simultaneously in the two categories. Refer to [Retrieve Categories](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/retrieve-categories.html) for complete information about retrieving the category hierarchy for a specified marketplace. If you define an item and a problem occurs with the category ID specified, refer to [Category ID Mapping](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/map-category-ids.html) for information about how to keep category data for individual items synchronized with eBay's category data. **Arguments:** * [Item.PrimaryCategory.CategoryID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PrimaryCategory.CategoryID) * [Item.SecondaryCategory.CategoryID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.SecondaryCategory.CategoryID) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Category versioning | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/category-versioning.html#mainContent) The category hierarchy for a given marketplace has a version level. To determine the category hierarchy version: 1. The first time your application retrieves the categories for a particular marketplace, call [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) with the value of [DetailLevel](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html#Request.DetailLevel) set to `ReturnAll`. This returns the category data and the version for that marketplace's category hierarchy. Store this value for future use. 2. When the application next seeks to refresh the category data for that eBay marketplace, call [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) with no [DetailLevel](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html#Request.DetailLevel) value specified. This causes [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) to return only the category hierarchy version. 3. Compare this newly retrieved version number with the one retrieved in the last call: * If the newly retrieved version number is different, call [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) again but with the value of [DetailLevel](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html#Request.DetailLevel) set to `ReturnAll` to retrieve the category data. Store the new version number as the reference point for the next call. * If the new and stored version numbers are the same, then category data does not need to be retrieved for that marketplace at that time. **Note:** Changes to the category hierarchy of one marketplace are independent of changes made to another marketplace. The category hierarchy version must be independently checked for each eBay marketplace the application supports, using the procedure described above. The eBay category hierarchy is updated on a monthly basis, but may be updated more frequently. It is a good idea to call [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) to check the category tree version at least once on each day that the application is being used. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # SKU identifiers | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/skus.html#mainContent) Sellers may associate a SKU (Stock-Keeping Unit) value to an item when creating/revising/relisting that item. This SKU value is associated to the item through the [Item.SKU](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.SKU) field. SKUs are defined by sellers and often are used to track complex flows of products and inventory. It is logical that the seller use unique SKU values for each item/product, but this is not enforced by eBay, except in the case of multiple-variation listings, where each product variation within the listing should have its own SKU value. In the case of multiple-variation listings, the SKU values for each product variation are defined in the distinct [Item.Variations.Variation.SKU](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.SKU) fields, and **not** in the [Item.SKU](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.SKU) field, as each product variation _should_ have its own SKU value. In the case of multiple-variation listings, the _FixedPrice_ family of calls must be used since those are the only listing calls that support multiple variations. Once a SKU value is added to a listing (or multiple SKU values in a multiple-variation listing), this value is returned in [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) and other _Get_ calls that return the Item object. Item tracking by SKU -------------------- In an [AddFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html) or [RelistFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html) call the seller has the option of setting the [Item.InventoryTrackingMethod](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.InventoryTrackingMethod) to be `SKU` rather than the default method of `ItemID`. This will allow the seller to pass in SKU values in their requests to: * Retrieve an item or order line item using: * [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) * [GetOrderTransactions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetOrderTransactions.html) * [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) * [GetSellerTransactions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerTransactions.html) * Revise a listing using: * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) * [ReviseInventoryStatus](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html) * [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) * Relist an item using: * [RelistFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html) * [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) * Preview/verify a listing using: * [VerifyAddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyAddItem.html) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html) * [VerifyRelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) * Send an invoice using [SendInvoice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SendInvoice.html) * Manage pinned notes using [SetUserNotes](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SetUserNotes.html) **Argument:** [Item.SKU](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.SKU) **Maximum length:** 50 characters #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Minimum advertised price | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/discount-pricing-map.html#mainContent) **Important!** Minimum Advertised Price is restricted to a limited number of existing sellers. It is no longer available to new sellers. Minimum Advertised Price is supported only on the eBay US marketplace. **Important!** For listings with Minimum Advertised Price details and a seller-specified price below the minimum advertised price, you are legally required to follow the rules for displaying the price of the item to potential buyers. You are bound by the terms of the API License Agreement to follow these rules. Refer to the API License Agreement for consequences of non-compliance. Because of the legal implications of the Minimum Advertised Price treatment, applications that show item prices to buyers must first check items for discount price information (e.g., [Item.DiscountPriceInfo](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.DiscountPriceInfo) ) and the specific price treatment (i.e., [Item.DiscountPriceInfo.PricingTreatment](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.DiscountPriceInfo.PricingTreatment) ,) to determine whether a special display treatment is needed for the item price. Discount price information is returned by the Finding API search calls, **GetSingleItem** and **GetMultipleItems** in the Shopping API, and [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) in the Trading API. While sellers have the freedom to set item prices as they see fit, some manufacturers restrict how prices on certain items can be displayed or communicated to others. When a listing includes Minimum Advertised Price (MAP) discount pricing information, there are legal requirements for the display of the item price to buyers when it is below the minimum advertised price set by the manufacturer. If a seller prices an item below the minimum advertised price, applications cannot display the price on any page until the buyer takes further action (such as clicking a button or link). If the item's price is greater than or equal to the minimum advertised price, no special treatment is needed to display the price. Eligibity --------- The display rules for Minimum Advertised Price apply when an item is listed with discount pricing information that returns [Item.DiscountPriceInfo.PricingTreatment](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.DiscountPriceInfo.PricingTreatment) = `MAP`. To qualify for MAP display treatment, [Item.StartPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.StartPrice) must be below the [Item.DiscountPriceInfo.MinimumAdvertisedPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo.MinimumAdvertisedPrice) , as illustrated in the following snippet from an XML response from the Trading API. **API response sample for Minimum Advertised Price** ... 149.99 ... 159.99 154.99 DuringCheckout MAP ... The specific XML response for discount pricing information may vary slightly from API to API. Treatment rules --------------- When the display rules for Minimum Advertised Price apply, the application cannot display the seller's lower price until the buyer takes further action. * If [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) returns a value of [Item.DiscountPriceInfo.MinimumAdvertisedPriceExposure](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.DiscountPriceInfo.MinimumAdvertisedPriceExposure) = `PreCheckout`, the buyer can click a link or button to view the item's price in a pop-up window or subsequent page. * If [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) returns a value of [Item.DiscountPriceInfo.MinimumAdvertisedPriceExposure](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.DiscountPriceInfo.MinimumAdvertisedPriceExposure) = `DuringCheckout`, the price is displayed on eBay's Review and Confirm page in the checkout flow or a comparable page in a third-party application that supports checkout capabilities, such as **PlaceOffer**. **Note:** If an application sends buyers to eBay for checkout, the application should not display the item price to buyers when the exposure setting is `DuringCheckout`. Shown below is a permissible visual treatment when item price is below the specified minimum advertised price. Users must click the "See Price Details" link to view the item price. ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/map-in-srp.png) When applying a Minimum Advertised Price treatment for an eBay listing, your application must display or include a link to display the following explanatory text on pages upon which item price is hidden: Sellers have the right to set their own prices independently, but some manufacturers place restrictions on how those prices may be displayed or communicated to others. Because the seller's price on this item is below the manufacturer's "minimum advertised price" the manufacturer may not allow the seller to show you the seller's lower price until you take further action, such as clicking on a drop-down menu, placing the item in your cart, or proceeding to checkout. The steps required depend on the terms of the manufacturer's minimum advertised price policy. Taking these steps allows eBay to show you the seller's great price consistent with eBay's goal of always bringing consumers like you the lowest possible prices on the widest selection of products. You should know that by taking these steps, you won't be required to purchase the product. You can always simply remove the item from your cart or not proceed with checkout if you decide not to buy the item. These display rules for discount pricing apply to both active and completed items. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Business Policies Management API | Release Notes eBay Business Policies Management API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) Business Policies Management API Release Notes ============================================== You can find links to the eBay Business Policies Management API documentation in the top navigation bar. Information about the schema location is in the [Schema Location](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#SchemaLocation) section of the "Making an API Call" topic. The following list provides pointers on how to join the eBay Developers Program and other useful information for for those new to the eBay APIs: * [How to Join the eBay Developer's Program](https://developer.ebay.com/join/Default.aspx) * [eBay Developer Documentation Center](https://go.developer.ebay.com/api-documentationsupport%20/) * [eBay APIs - Quick Start](https://go.developer.ebay.com/quick-start-guide) * [eBay Trading API Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) For a current list of known issues, see [Site Status Updates](https://go.developer.ebay.com/developers/ebay/documentation-tools/site-status/) and the [Knowledge Base](http://developer.ebay.com/DevZone/support/Knowledgebase/) . | Version | Release Date | | | --- | --- | --- | | [1.1.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#v1.1.0) | 2018-05-31 | | | [1.0.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#v1.0.0) | 2012-05-02 | | Version 1.1.0 ------------- [Index of Changed Calls - v1.1.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#110-CC) [Schema Changes - v1.1.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#110-SC) [New Features - v1.1.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#110-NF) [Changed Functionality - v1.1.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#110-CF) For a current list of known issues, see [Site Status Updates](https://go.developer.ebay.com/api-status) and the [Knowledge Base](https://go.developer.ebay.com/knowledge-base) . ### Index of Changed Calls - v1.1.0 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### Changed Calls * addSellerProfile * setSellerProfile * getSellerProfile ### Schema Changes - v1.1.0 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](http://developer.ebay.com/DevZone/guides/ebayfeatures/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `InternationalReturnPolicyInfo.returnsAcceptedOption` | Field | New | | `InternationalReturnPolicyInfo.refundOption` | Field | New | | `InternationalReturnPolicyInfo.returnsWithinOption` | Field | New | | `InternationalReturnPolicyInfo.shippingCostPaidByOption` | Field | New | ### New Features - v1.1.0 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - v1.1.0](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html#110-CF) . #### International returns A new **internationalReturnPolicyInfo** complex type was added to the **returnPolicyProfile** container. **internationalReturnPolicyInfo** has several fields that let sellers specify international return policies that differ from their domestic return policies (international returns are those that are shipped using an international shipping service). Before this release, the single set of return policy fields represented the seller's return policies for both domestic and international returns. The preexisting return policy fields now define a seller's domestic return policy and the new international fields enable sellers to also define specific international return policies. (If a seller does not define specific international return policies, then any international returns will inherit the seller's domestic return policies). ### Changed Functionality - v1.1.0 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. This release launches a reorganization to eBay's return policies. To streamline the number of return variations, several fields were deprecated and others were added to make return policies simple to create and easy to maintain. For details on this roll out, see the Spring 2018 Seller Announcement, [Simplified Returns](https://pages.ebay.com/seller-center/seller-updates/2018-spring/simplified-returns.html) . #### Deprecated functionality Starting with this release, sellers can no longer specify warranty information, restocking fees, or hours for extended holiday returns with their return policies. With this, the following **returnPolicyProfile** fields are deprecated with this release; any values supplied to these fields will neither be read nor returned: * `returnPolicyProfile.holidayReturns` * `returnPolicyProfile.restockingFeeValue` * `returnPolicyProfile.warrantyDurationOption` * `returnPolicyProfile.warrantyOfferedOption` * `returnPolicyProfile.warrantyTypeOption` #### Simplified returns Simplified returns changes the functionality within the **returnPolicyInfo** container and adds a new container, **internationalReturnPolicyInfo**, with four new fields that mirror the fields in **returnPolicyInfo**. The following updates apply to the fields in both containers: * **description** – This field is now valid for only the `EBAY_DE`, `EBAY_ES`, `EBAY_FR`, and `EBAY_IT` marketplaces. * **refundOption** – You must set this value to `MoneyBack` for all eBay marketplaces except for the US marketplace (on `EBAY_US`, you can also set this to `MoneyBackOrReplacement`). The value `MoneyBackOrExchange` is retired. While currently accepted for existing policies, this value is now mapped to `MoneyBackOrReplacement` for domestic return policies, and the value is ignored in international return policies. * **returnsWithinOption** – This field becomes required if you set `ReturnsAccepted` in either the domestic or international return policy. The accepted values for this field have been streamlined in that most categories now support only 30-day and 60-day values. The 3-day and 7-day options have been removed from the AU marketplace and the 14-day option has been removed from most categories. While you can create a return policy to support 14-day returns (for use in the US categories that employ this override), your request will fail if you attempt to use a 14-day return policy when listing items in categories that do not support this option. Call **GetCategoryFeatures** with **DetailName** set to `ReturnPolicyDetails` to review which categories allow a 14-day return period. (**GetCategoryFeatures** will be updated in mid-August 2018 with the return period values supported by each category, including the categories that support a 14-day return period.) * **shippingCostPaidByOption** – This field becomes required if you set **returnsAcceptedOption** to `ReturnsAccepted` in either the domestic or international return policy. Valid values for this field are `Buyer` and `Seller`. **FAQ** * When will eBay begin enforcing the Simplified Returns policies? * Simplified Returns policy enforcement is currently scheduled to begin in late August. Check back here for the specific policy-enforcement date. * How will existing listings that use a return policy which does not specify an international return policy be treated? * Any return policy that does not specify an international return policy will be treated as though the existing domestic return policy values apply to both domestic and international sales, with the exception of the **shippingCostPaidByOption**. If a seller accepts domestic returns, eBay automatically sets the international **shippingCostPaidByOption** value to `Buyer` and the international return policy will use the domestic return policy for all other settings. To avoid any confusion, sellers should explicitly set the international return policy fields using either the API or the UI site flow. International policies are not mandatory; however, once specified, international policies cannot be deleted (but they can be revised). * What happens if I use a return policy with a 14-day return window (**returnsWithinOption** is set to 14-days) in an item that is listed in a category that no longer supports this option? * For API users, starting in late August, new listings and revisions to existing listings will be blocked if the target category doesn't support a 14-day return window. Also be aware that you cannot revise an item if it has a bid, a pending offer, or ends within 12 hours. * Changes to the eBay site are live and the site no longer offers non-valid return policy values for new item listings. However, you will be able to revise listings that specify a 14-day return window until the policy enforcement date. * The enforcement of the new return policy options will effect only new listings and listing revisions; existing listings will not be blocked when enforcement begins. When enforcement begins, however, GTC listings that reference a return policy that contains a non-valid **returnsWithinOption** (such as a 3, 7, or 14 day value) will be modified so it complies with the updated return policy options. To accomplish this, eBay will update any non-compliant return policies by changing the value of **returnsWithinOption** to the closest compliant value. In most cases, this means a 14-day return option will change to a 30-day return option. In this scenario, eBay will create a new policy (with a new policy ID) that contains the settings in the original policy. You can either delete this second policy or use it for items that you want to list in a category that supports a 14-day return option. * What happens if I set only the **returnsAcceptedOption** field to `ReturnsAccepted` for either a domestic or international return policy? * The **returnsWithinOption**, **shippingCostPaidByOption**, and **refundOption** fields are mandatory in all return policies. The **refundOption** must be set to `MoneyBack` for all policies except for those targeting the US marketplace. For the US marketplace, **refundOption** can also be set to `MoneyBackOrReplacement`. * What happens if I try to revise a listing that currently has a **description** field? * Only the DE, FR, IT, and ES marketplaces will continue to support this field. In the cases where this field is no longer supported but a value is present, the value is ignored. Note that where supported, you can populate this field even if you set **returnsAcceptedOption** to `ReturnsNotAccepted`. * What happens if I specify values in the **description** or **refundOption** fields, but the marketplace no longer supports these fields? * In the cases where these fields are no longer supported, the values are ignored (they are neither read nor returned). * What happens if I try to revise a listing that currently has a restocking fee (or other deprecated field) in its return policy? * Deprecated values are ignored and any present value is neither read nor returned. * On the DE marketplace, can I continue to use `Months_1` as a value for **returnsWithinOption** (will either `Days_30` or `Months_1` be accepted)? * For the DE marketplace, the value `Months_1` will continue to be accepted for the next 18 months. If this value is specified, it is stored as `Days_30`. After 18 months, a value of `Months_1` will throw a blocking error. Version 1.0.0 ------------- This is the first release of the Business Policies Management API. ### Index of Changed Calls - 1.0.0 This section lists calls that have changed or are new with this API release. #### New Calls The following calls are included in the initial v1.0.0 release of the Business Policies Management API: | Call | Summary | | --- | --- | | [addSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/addSellerProfile.html) | Creates one or more business policies. | | [consolidateShippingProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/consolidateShippingProfiles.html) | Consolidates shipping policies that have identical data with the exception of shipping costs. | | [getConsolidationJobStatus](https://developer.ebay.com/Devzone/business-policies/CallRef/getConsolidationJobStatus.html) | Retrieves the status of a shipping policies consolidation job. | | [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) | Retrieves one or more business policies for a seller. | | [getVersion](https://developer.ebay.com/Devzone/business-policies/CallRef/getVersion.html) | Gets the current version of the Business Policies Management API. | | [removeOverrides](https://developer.ebay.com/Devzone/business-policies/CallRef/removeOverrides.html) | Removes shipping cost overrides for a specific shipping policy. | | [removeProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/removeProfile.html) | Deletes an existing business policy for a seller. | | [removeSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/removeSellerProfiles.html) | Deletes one or more existing business policies. | | [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) | Modifies one or more business policies. | * * * --- # Fee discounts | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/fee-discounts.html#mainContent) _Listing features_ are enhancements that a seller can add to their item listings, such as (listing displayed in) Bold, setting a Reserve Price, and including a Subtitle. eBay charges a fee for each listing feature that the seller incorporates into their listing. At eBay's discretion, the seller might receive a discount on one or more of the listing features related to listing an item. If the seller receives a discount on a listing upgrade, the amount of money that the seller saved on the upgrade is returned in the [Fees.Fee.PromotionalDiscount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.PromotionalDiscount) field of the [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) response. Each [Fees.Fee.PromotionalDiscount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.PromotionalDiscount) under a [Fees.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee) node indicates the amount of the discount for that listing feature. This applies to the Add/Revise/Relist/Verify family of API calls. For example, if there is a discount of $1.50 for a $2.00 Bold feature, you will see the following [Fees.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee) container with the [Fees.Fee.PromotionalDiscount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.PromotionalDiscount) field: BoldFee 0.5 1.5 When a discount has been applied, the [Fees.Fee.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.Fee) value represents the post-discounted cost for the particular listing feature. To determine what the fee would have been _without_ the discount, add together the values of [Fees.Fee.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.Fee) and [Fees.Fee.PromotionalDiscount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.PromotionalDiscount) . The total cost of all listing features used is returned in the [Fees.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee) container whose [Fees.Fee.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.Name) value is `ListingFee`. If this container has a [Fees.Fee.PromotionalDiscount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.PromotionalDiscount) field, the value is the total of all the promotional discounts that were applied when the item was listed, and the [Fees.Fee.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.Fee) value is the total cost of all listing features minus the promotional discounts. In addition to the [Fees.Fee.PromotionalDiscount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee.PromotionalDiscount) field being returned in the `ListingFee` node, a [DiscountReason](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.DiscountReason) field is returned after all of the [Fees.Fee](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Response.Fees.Fee) nodes. The value returned in this field will indicate whether listing discounts were due to a special offer or promotion. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # View a Second Chance Offer listing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/second-chance-view.html#mainContent) Once a Second Chance Offer listing has been created, it can be viewed by the seller or the offer recipient on the eBay marketplace or through an API call that retrieves item data such as [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) or [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) . If the listing's data have been retrieved using one of these calls, all of the typical fields are included, as well as the `itemID` for the _original listing_ (e.g., for a [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) call, this will be the [Item.ListingDetails.SecondChanceOriginalItemID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ListingDetails.SecondChanceOriginalItemID) field.) In result sets for calls such as [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) and [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerEvents.html) where data for multiple items are returned, a Second Chance Offer listing can be differentiated from regular auctions by reviewing the listing type indicated by the [ItemArray.Item.ListingType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.ListingType) property. For Second Chance Offer listings, the type will be `PersonalOffer`. For more information about retrieving data for item listings, refer to [Retrieve Items](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/retrieve-items.html) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Manage store categories | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/store-categories.html#mainContent) A seller can use **SetStoreCategories** to modify the category structure of their eBay Store. Store categories can be added, deleted, moved, and renamed with **SetStoreCategories**. Changes can be made to a single store category or to a list of store categories. Using the API, you can add up to 300 store categories to an eBay Store. Stores support three levels of categories. Use **GetStore** to retrieve the category structure for your store. **Note:** Store categories will not appear in the marketplace user interface unless they contain items. Items can only be contained within the store's terminal (aka "leaf") categories. A parent category cannot contain items. If adding, moving, or deleting categories displaces items, you must use the **ItemDestinationCategoryID** input field to specify a destination child category under which the displaced items will be moved. The destination category must have no child categories. For more information about **SetStoreCategories**, including input/output fields and samples of the API call structures, refer to the [SetStoreCategories](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetStoreCategories.html) reference documentation. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Release Notes Archive - Trading API eBay Trading API * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/api-docs/user-guides/static/make-a-call-landing.html) * [API Reference](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/index.html) * [Tutorials](https://developer.ebay.com/devzone/XML/docs/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/XML/docs/ReleaseNotes.html) Trading API Release Notes Archive ================================= This archive document contains information about older releases. For recent releases, see the current [Release Notes](https://developer.ebay.com/devzone/XML/docs/ReleaseNotes.html) . | Release Version | Release Date | Description of Release | | --- | --- | --- | | [1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331) | 2023-October-23 | New ListingOnHold field added to GetItem; New error codes for 1331; Logic and behavior changes to support on-hold listings; New enum values added to AccountDetailEntryCodeType | | [1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327) | 2023-September-18 | GetCharities Call Decommissioned | | [1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325) | 2023-August-29 | All DSA-related fields are available on all eBay marketplaces | | [1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323) | 2023-August-25 | New Fee and Credit added to GetAccount; Extended Producer Responsibility IDs set at account level; Several enumerated values deprecated in NotificationEventTypeCodeType; Four fields deprecated in GetMyeBaySelling call; TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls; Czechia and Cyprus added to SiteCodeType; UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call; OriginatingPostalCode field deprecated | | [1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321) | 2023-July-17 | GetMyeBayReminders Call Decommissioned; CODCost field removed | | [1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319) | 2023-Jun-26 | Added condition grading support for the United Kingdom (GB) | | [1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315) | 2023-Jun-16 | Deprecated CODCost fields and the enumerated value BuyerPaymentMethodCodeType.COD | | [1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313) | 2023-Jun-2 | AddTransactionConfirmationItem and GetContextualKeywords Decommissioned; Logic Change for RefundAmount Field in MonetaryDetails; Logic Change for Modified Line Items in GST and GIT | | [1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311) | 2023-May-19 | Regulatory changes; Numerous fields scheduled for decommission in order management calls; Logic change for Total and AmountPaid fields in GetOrders | | [1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305) | 2023-Apr-7 | Vault in-hand submission shipping address returned; New status for AuthenticityVerificationType | | [1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303) | 2023-Mar-24 | Added Support for Linking Separate Orders; SubscriptionLevel field removed from GetStore | | [1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301) | 2023-Mar-10 | Buyers in the EU must be allowed to return an item within 14 days or more; GetApiAccessRules Call Decommissioned | | [1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299) | 2023-Feb-24 | New Schema Added to Support VeRO Violation Reporting | | [1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295) | 2023-Jan-27 | Six Dispute Calls Decommissioned; GetOrderTransactions Call Deprecated | | [1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291) | 2022-Dec-30 | New Schema Added to Support Hazardous Material Label Related Information and Repair Score; New Error Codes for 1291 | | [1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285) | 2022-Nov-18 | Updated Picture Limit | | [1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281) | 2022-Oct-21 | EU and UK Payments regulations update: Digital Signatures; New item eligibility flag for shipping managed by eBay; Updates to GetAccount Call; Updates to CancelReasonCodeType type; Shipping service override changes to business policies; Australia sellers offering freight shipping changes | | [1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279) | 2022-Oct-07 | Added support for eBay shipping; New Error Codes for 1279 | | [1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275) | 2022-Sep-09 | A new intermediated international shipping program has been added | | [1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267) | 2022-Jul-15 | Four Store Calls Scheduled for Decommission on September 30 | | [1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257) | 2022-May-06 | HitCounter field removed from WSDL; HitCount field updates; Quantity and StartPrice no longer returned in ReviseInventoryStatus | | [1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255) | 2022-Apr-22 | GetCategorySpecifics Call Decommisioned | | [1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249) | 2022-Mar-11 | Extended producer responsibility related information returned | | [1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247) | 2022-Feb-25 | Winter 2022 Seller Updates Available; HitCounter and HitCount Fields Deprecated | | [1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235) | 2021-Dec-03 | New Schema added to support custom policies; New Schema added to support extended producer responsibility regulations; New Error Codes for 1235 | Version 1331 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CC) | | [Schema Changes - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-SC) | | [Announcements - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-AN) | | [New Features - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-NF) | | [Changed Functionality - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CF) | | [Document Changes and Errata - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1331 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1331 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**SellingStatusType**` | Type | Modified | | `Item.SellingStatus.**ListingOnHold**` | Field | Added | | `**AccountDetailEntryCodeType**` | Type | Modified | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFee**` | Enum | Added | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFeeCr**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFee**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFeeCredit**` | Enum | Added | ### Announcements - 1331 By January 22nd, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable **ConditionDescriptors** name-value pairs. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1331 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CF) . #### New ListingOnHold field added to GetItem The **ListingOnHold** field has been added to [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) and will be returned in GetItem as applicable. See [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) for details on this new field. ### Changed Functionality - 1331 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New error codes for 1331 Below is a list of the new error messages that rolled out with the 1331 release. All of these messages are related to on-hold listings. The long version of each message is used below: * (warning) **21920396**: This listing has a policy violation. * (error) **21920397**: This listing has been removed for a policy violation. * (error) **21920398**: This listing has a policy violation. `replaceable_value` is not possible. These error and warning messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. #### Logic and behavior changes to support on-hold listings Various logic/behavior changes have been made to several Trading calls that return listing data to indicate if a listing is currently on hold due to an eBay policy violation. These changes are covered in the list below: * **GetItemTransactions**: If the item ID passed into the [ItemID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetItemTransactions.html#Request.ItemID) field is for a listing that is on hold, existing error code **17** ("This item cannot be accessed because the listing has been deleted or you are not the seller.") will be triggered. * **GetOrders**: If the Order ID passed into the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item ordered spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetOrderTransactions**: If the Order ID passed in the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item order spawned from a listing that is on hold, or if the ItemID, SKU, or OrderLineItemID (or ItemID/TransactionID combo specified through the [TransactionID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.ItemTransactionIDArray.ItemTransactionID) container) involves an order line item spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetSellerList**: When making a [GetSellerList](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerList.html) call, items that are on-hold due to an eBay policy violation will not be returned in the response. * **GetSellerEvents**: When making a [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerEvents.html) call, the item.**Title** field will be returned masked as `*****************` for listings on hold due to a policy violation. * **GetSellerTransactions**: When making a [GetSellerTransactions](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerTransactions.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. * **GetMyeBaySelling**: When making a [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/reference/ebay/getmyebayselling.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. #### New enum values added to AccountDetailEntryCodeType `HermesReturnLblSellerPaidShpFee`, `HermesReturnLblSellerPaidShpFeeCr`, `DHLReturnLblShippingFee`, and `DHLReturnLblShippingFeeCredit` have been added to [AccountDetailEntryCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) as enum values and will be returned by **GetAccount** as applicable. ### Documentation Changes and Errata - 1331 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-NF) and [Changed Functionality - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CF) . None for this release. Version 1327 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CC) | | [Schema Changes - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-SC) | | [Announcements - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-AN) | | [New Features - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-NF) | | [Changed Functionality - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CF) | | [Document Changes and Errata - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1327 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1327 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**CharityInfoType**` | Type | Removed | | `**StringMatchCodeType**` | Type | Removed | | `**GetCharitiesRequestType**` | Type | Removed | | `**GetCharitiesResponseType**` | Type | Removed | | `**NonProfitAddressType**` | Type | Modified | ### Announcements - 1327 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1327 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. ### Changed Functionality - 1327 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetCharities Call Decommissioned The **GetCharities** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetCharities** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-SC) ### Documentation Changes and Errata - 1327 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-NF) and [Changed Functionality - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. Version 1325 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CC) | | [Schema Changes - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-SC) | | [Announcements - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-AN) | | [New Features - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-NF) | | [Changed Functionality - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CF) | | [Document Changes and Errata - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1325 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1325 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1325 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1325 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. ### Changed Functionality - 1325 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### All DSA-related fields are available on all eBay marketplaces All DSA-related fields are now available on all eBay marketplaces (no longer restricted to specific marketplaces). The Trading API now supports the following features: * Energy Efficiency Labels * Hazmat * Regional Product Compliance Policies * Regional Take-back Policies * Repair Score * Eco-Participation Fee ### Documentation Changes and Errata - 1325 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-NF) and [Changed Functionality - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. Version 1323 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CC) | | [Schema Changes - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-SC) | | [Announcements - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-AN) | | [New Features - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-NF) | | [Changed Functionality - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CF) | | [Document Changes and Errata - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1323 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetAllBidders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAllBidders.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GeteBayDetails](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetMyeBayBuying](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetMyeBayBuying.html#ChangeHistory) * [GetMyeBaySelling](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetMyeBaySelling.html#ChangeHistory) * [GetNotificationPreferences](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetNotificationPreferences.html#ChangeHistory) * [GetNotificationsUsage](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetNotificationsUsage.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerDashboard](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerDashboard.html#ChangeHistory) * [GetSellerEvents](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerEvents.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [GetUser](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetUser.html#ChangeHistory) * [GetVeROReasonCodeDetails](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetVeROReasonCodeDetails.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SetNotificationPreferences](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/SetNotificationPreferences.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1323 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**AccountDetailEntryCodeType**` | Type | Modified | | `**AccountDetailEntryCodeType.**ExpressPayoutFee****` | Enum | Added | | `AccountDetailEntryCodeType.**ExpressPayoutFeeCredit**` | Enum | Added | | `ExtendedProducerResponsibilityType.**ProducerProductID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ShipmentPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductDocumentationID**` | Field | Removed | | `NotificationEventTypeCodeType.**OrderInquiryClosed**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryOpened**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerOpenedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryProvideShipmentInformation**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryEscalatedToCase**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerClosedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRSellerRespondedToDispute**` | Enum | Deprecated | | `Summary.**AuctionBidCount**` | Field | Deprecated | | `Summary.**ClassifiedAdOfferCount**` | Field | Deprecated | | `Summary.**TotalLeadCount**` | Field | Deprecated | | `SellingSummary.**AuctionBidCount**` | Field | Deprecated | | `**TicketListingDetailsType**` | Type | Deprecated | | `TicketListingDetailsType.**EventTitle**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedDate**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedTime**` | Field | Deprecated | | `TicketListingDetailsType.**Venue**` | Field | Deprecated | | `**SiteCodeType**` | Type | Modified | | `SiteCodeType.**Czechia**` | Enum | Added | | `SiteCodeType.**Cyprus**` | Enum | Added | | `**UpdateReturnPolicy**` | Field | Deprecated | | `**UpdateSellerInfo**` | Field | Deprecated | | `**OriginatingPostalCode**` | Field | Deprecated | | `**QuantityInfo**` | Field | Deprecated | ### Announcements - 1323 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1323 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CF) . #### New Fee and Credit added to GetAccount The following new fee and credit fields were added to [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on this new fee and credit. * `ExpressPayoutFee` * `ExpressPayoutFeeCredit` ### Changed Functionality - 1323 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Extended Producer Responsibility IDs set at account level For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level and have been removed from the Trading WSDL. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings.\*/epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. The **ExtendedProducerResponsibilityType** fields removed were: `ProducerProductID`, `ProductPackageID`, `ShipmentPackageID`, and `ProductDocumentationID`. These fields are no longer usable; if used, the user will get a warning about the fields no longer being supported. #### Several enumerated values deprecated in NotificationEventTypeCodeType Because some of the order inquiry series events have been deprecated, the following enumerated values in [NotificationEventTypeCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) (used in the **GetNotificationPreferences**, **GetNotificationsUsage**, and **SetNotificationPreferences** methods) were also deprecated: * OrderInquiryClosed * OrderInquiryOpened * INRBuyerOpenedDispute * OrderInquiryProvideShipmentInformation * OrderInquiryEscalatedToCase * INRBuyerClosedDispute * INRSellerRespondedToDispute See [NotificationEventTypeCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) for additional information. #### Four fields deprecated in GetMyeBaySelling call Because the data is no longer being actively maintained by eBay, the following four fields in **GetMyeBaySelling** have been deprecated and scheduled for decommission on 02-06-2024: Summary.**AuctionBidCount**, Summary.**ClassifiedAdOfferCount**, Summary.**TotalLeadCount**, and SellingSummary.**AuctionBidCount**. #### TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls The **TicketListingDetails** and **QuantityInfo** container fields in Add/Revise/Relist/Verify and related calls have been deprecated and are not usable. They will be ignored if sent. #### Added Czechia and Cyprus to SiteCodeType `Czechia` and `Cyprus` have been added to **SiteCodeType** as enumeration values. #### UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call The **UpdateReturnPolicy** and **UpdateSellerInfofields** fields in the ReviseItem call have been deprecated and are not usable. They will be ignored if sent. #### OriginatingPostalCode field deprecated The **OriginatingPostalCode** was deprecated in Add/Revise/Relist/Verify family, GetItem family, GetSeller family, and GetOrders calls. To specify the postal code of the item's location, using the Item.PostalCode field in the request. For example, in the AddItem call specify the item's location using the [Item.PostalCode](https://developer.ebay.com/devzone/xml/docs/reference/ebay/additem.html#Request.Item.PostalCode) field. ### Documentation Changes and Errata - 1323 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-NF) and [Changed Functionality - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CF) . None for this release. Version 1321 ------------ [Index of Changed Calls - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CC) [Schema Changes - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-SC) [Announcements - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-AN) [New Features - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-NF) [Changed Functionality - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CF) [Documentation Changes and Errata - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1321 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1321 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ReminderCustomizationType**` | Type | Removed | | `**RemindersType**` | Type | Removed | | `ShippingDetailsType.**CODCost**` | Field | Removed | | `SendInvoiceRequest.**CODCost**` | Field | Removed | ### Announcements - 1321 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1321 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. ### Changed Functionality - 1321 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetMyeBayReminders Call Decommissioned The **GetMyeBayReminders** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetMyeBayReminders** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-SC) section. Instead of this API, buyers and sellers can go to **My eBay** to see all of their selling/buying reminders. #### CODCost field removed The deprecated **CODCost** fields in Add/Revise/Relist/Verify calls and related calls such as SendInvoice have been removed. This field is no longer returned in GetItem/GetOrder/GetSeller responses. ### Documentation Changes and Errata - 1321 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-NF) and [Changed Functionality - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. Version 1319 ------------ [Index of Changed Calls - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CC) [Schema Changes - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-SC) [Announcements - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-AN) [New Features - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-NF) [Changed Functionality - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CF) [Documentation Changes and Errata - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1319 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1319 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ConditionDescriptorsType**` | Type | New | | `Item.**ConditionDescriptors**` | Field | New | | `**ConditionDescriptorType**` | Type | New | | `ConditionDescriptors.**AdditionalInfo**` | Field | New | | `ConditionDescriptors.**Name**` | Field | New | | `ConditionDescriptors.**Value**` | Field | New | ### Announcements - 1319 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1319 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CF) . #### Condition grading **Note:** The **ConditionDescriptors** and the **ConditionDescriptor** containers are currently available only in the United Kingdom (GB), with rollout to other markets in early July 2023. To provide support for condition grading, the **ConditionDescriptors** container, and the **ConditionDescriptor** container and its child fields **AdditionalInfo**, **Name**, and **Value**, can be used by the seller to provide information about the specific condition of an item. This information is passed in using the **Add**/**Revise**/**Relist**/**Verify** calls and returned by calling **GetItem**. ### Changed Functionality - 1319 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1319 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-NF) and [Changed Functionality - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CF) . None for this release. Version 1315 ------------ [Index of Changed Calls - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CC) [Schema Changes - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-SC) [Announcements - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-AN) [New Features - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-NF) [Changed Functionality - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CF) [Documentation Changes and Errata - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1315 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1315 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ShippingDetailsType.**CODCost**` | Field | Deprecated | | `SendInvoiceRequest.**CODCost**` | Field | Deprecated | | `BuyerPaymentMethodCodeType.**COD**` | Enum | Deprecated | ### Announcements - 1315 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1315 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. ### Changed Functionality - 1315 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### ShippingDetailsType.CODCost and SendInvoiceRequest.CODCost fields were deprecated The ShippingDetailsType.**CODCost** and SendInvoiceRequest.**CODCost** fields, and the enumerated value BuyerPaymentMethodCodeType.**COD** was deprecated, as COD is no longer a supported payment method on any marketplace. See [Index of Changed Calls - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CC) for affected methods. ### Documentation Changes and Errata - 1315 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-NF) and [Changed Functionality - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. Version 1313 ------------ [Index of Changed Calls - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CC) [Schema Changes - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-SC) [Announcements - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-AN) [New Features - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-NF) [Changed Functionality - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CF) [Documentation Changes and Errata - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1313 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1313 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1313 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### AddTransactionConfirmationItem and GetContextualKeywords Decommissioned The AddTransactionConfirmationItem and GetContextualKeywords calls have been decommissioned and removed from the Trading WSDL and documentation. ### New Features - 1313 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CF) . #### New Fees and Credits Added to GetAccount The following new fees and credits were added to [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on these new fees and credits. * PromotedDisplayFee * PromotedDisplayFeeCredit * USWHTFederal * USWHTFederalCredit * USWHTState * USWHTStateCredit * EPRFee * EPRFeeCredit * CAPostReturnLabelFee * CAPostReturnLabelFeeCredit * HermesReturnLabelFee * HermesReturnLabelFeeCredit * BankPayoutFee * BankPayoutFeeCredit * CharityDonation * CharityDonationCredit ### Changed Functionality - 1313 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Logic Change for RefundAmount Field in MonetaryDetails For **GetOrders** call, there has been a logic change for the **RefundAmount** field under **MonetaryDetails** container. Previously, the final value fee amount deducted from the seller's payout funds for the sale was not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The **GetOrders** call will be updated to include the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in **GetOrders**responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the **X-EBAY-API-COMPATIBILITY-LEVEL** header value to 1311 or above. #### Logic Change for Modified Line Items in GST and GIT For **GetSellerTransactions** and **GetItemTransactions** calls, please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned. ### Documentation Changes and Errata - 1313 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-NF) and [Changed Functionality - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CF) . None for this release. Version 1311 ------------ [Index of Changed Calls - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CC) [Schema Changes - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-SC) [Announcements - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-AN) [New Features - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-NF) [Changed Functionality - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CF) [Documentation Changes and Errata - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1311 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1311 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**EnergyEfficiencyType**` | Type | New | | `Item.Regulatory.**EnergyEfficiencyLabel**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageDescription**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageURL**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ProductInformationsheet**` | Field | New | | `Item.Regulatory.**RepairScore**` | Field | Modified | | `CustomPolicies.**RegionalProductCompliancePolicies**` | Field | Added | | `CustomPolicies.RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**Country**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**PolicyID**` | Field | Added | | `Item.**CustomPolicies**` | Field | Modified | ### Announcements - 1311 None for this release. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1311 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Regulatory changes **Note:** The **EnergyEfficiencyLabel** and the **Hazmat** containers are initially available only on the German (DE) marketplace. The **RepairScore** field is provided for future use (not presently available). As a part of Digital Services Act (DSA) requirements, the **EnergyEfficiencyLabel** container and its child fields **ImageDescription**, **ImageURL**, and **ProductInformationsheet**, can be used by the seller to provide Energy Efficiency Label related information for the listing. This information is passed in using the **Add/Revise/Relist/Verify** calls and returned by calling **GetItem**. **RegionalProductCompliancePolicies** and **RegionalTakeBackPolicies** fields were added, providing compliance functionality specified by region, and **ProductCompliancePolicyID** now applies to Global product compliance policies. #### Numerous fields scheduled for decommission in order management calls Numerous fields in the response payloads of the **GetOrders**, **GetItemTransactions**, **GetSellerTransactions**, and **GetMyeBaySelling** calls are being deprecated. See the [Deprecated Trading Order Management Fields](https://developer.ebay.com/devzone/deprecated_trading_ordermgmt_fields.pdf) document for the complete list of deprecated fields and reasons for deprecation. ### Changed Functionality - 1311 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. ### Documentation Changes and Errata - 1311 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-NF) and [Changed Functionality - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Logic change for Total and AmountPaid fields in GetOrders The field descriptions for **Order.Total** and **Order.AmountPaid** fieldsin **GetOrders** incorrectly stated that sales tax was included in those two amounts, but that was not the case prior to Version 1307. Going foward, sales tax will be included in these amounts if using Trading WSDL Version 1307 or above. If using a Trading WSDL older than Version 1307, the amount in thes fields will not include sales tax. To incorporate the new logic (sales tax included) while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. Version 1331 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CC) | | [Schema Changes - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-SC) | | [Announcements - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-AN) | | [New Features - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-NF) | | [Changed Functionality - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CF) | | [Document Changes and Errata - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1331 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1331 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**SellingStatusType**` | Type | Modified | | `Item.SellingStatus.**ListingOnHold**` | Field | Added | | `**AccountDetailEntryCodeType**` | Type | Modified | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFee**` | Enum | Added | | `AccountDetailEntryCodeType.**HermesReturnLblSellerPaidShpFeeCr**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFee**` | Enum | Added | | `AccountDetailEntryCodeType.**DHLReturnLblShippingFeeCredit**` | Enum | Added | ### Announcements - 1331 By January 22nd, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable **ConditionDescriptors** name-value pairs. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1331 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CF) . #### New ListingOnHold field added to GetItem The **ListingOnHold** field has been added to [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) and will be returned in GetItem as applicable. See [SellingStatusType](https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/SellingStatusType.html) for details on this new field. ### Changed Functionality - 1331 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New error codes for 1331 Below is a list of the new error messages that rolled out with the 1331 release. All of these messages are related to on-hold listings. The long version of each message is used below: * (warning) **21920396**: This listing has a policy violation. * (error) **21920397**: This listing has been removed for a policy violation. * (error) **21920398**: This listing has a policy violation. `replaceable_value` is not possible. These error and warning messages can be viewed in the [Errors by Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. #### Logic and behavior changes to support on-hold listings Various logic/behavior changes have been made to several Trading calls that return listing data to indicate if a listing is currently on hold due to an eBay policy violation. These changes are covered in the list below: * **GetItemTransactions**: If the item ID passed into the [ItemID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetItemTransactions.html#Request.ItemID) field is for a listing that is on hold, existing error code **17** ("This item cannot be accessed because the listing has been deleted or you are not the seller.") will be triggered. * **GetOrders**: If the Order ID passed into the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item ordered spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetOrderTransactions**: If the Order ID passed in the [OrderID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.OrderIDArray.OrderID) field is for a single line item order spawned from a listing that is on hold, or if the ItemID, SKU, or OrderLineItemID (or ItemID/TransactionID combo specified through the [TransactionID](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#Request.ItemTransactionIDArray.ItemTransactionID) container) involves an order line item spawned from a listing that is on hold, existing error code **21917182** ("OrderLineItemIDs replaceable\_value could not be found. Associated Items may have been deleted or removed.") will be triggered. * **GetSellerList**: When making a [GetSellerList](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerList.html) call, items that are on-hold due to an eBay policy violation will not be returned in the response. * **GetSellerEvents**: When making a [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerEvents.html) call, the item.**Title** field will be returned masked as `*****************` for listings on hold due to a policy violation. * **GetSellerTransactions**: When making a [GetSellerTransactions](https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetSellerTransactions.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. * **GetMyeBaySelling**: When making a [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/reference/ebay/getmyebayselling.html) call, the **ItemId** value of the listing will be returned in the item.**Title** field, in place of the item title, to indicate that the listing is on hold due to a policy violation. #### New enum values added to AccountDetailEntryCodeType `HermesReturnLblSellerPaidShpFee`, `HermesReturnLblSellerPaidShpFeeCr`, `DHLReturnLblShippingFee`, and `DHLReturnLblShippingFeeCredit` have been added to [AccountDetailEntryCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) as enum values and will be returned by **GetAccount** as applicable. ### Documentation Changes and Errata - 1331 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-NF) and [Changed Functionality - 1331](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1331-CF) . None for this release. Version 1327 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CC) | | [Schema Changes - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-SC) | | [Announcements - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-AN) | | [New Features - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-NF) | | [Changed Functionality - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CF) | | [Document Changes and Errata - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1327 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1327 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**CharityInfoType**` | Type | Removed | | `**StringMatchCodeType**` | Type | Removed | | `**GetCharitiesRequestType**` | Type | Removed | | `**GetCharitiesResponseType**` | Type | Removed | | `**NonProfitAddressType**` | Type | Modified | ### Announcements - 1327 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1327 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. ### Changed Functionality - 1327 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetCharities Call Decommissioned The **GetCharities** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetCharities** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-SC) ### Documentation Changes and Errata - 1327 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-NF) and [Changed Functionality - 1327](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1327-CF) . None for this release. Version 1325 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CC) | | [Schema Changes - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-SC) | | [Announcements - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-AN) | | [New Features - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-NF) | | [Changed Functionality - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CF) | | [Document Changes and Errata - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1325 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1325 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1325 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1325 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. ### Changed Functionality - 1325 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### All DSA-related fields are available on all eBay marketplaces All DSA-related fields are now available on all eBay marketplaces (no longer restricted to specific marketplaces). The Trading API now supports the following features: * Energy Efficiency Labels * Hazmat * Regional Product Compliance Policies * Regional Take-back Policies * Repair Score * Eco-Participation Fee ### Documentation Changes and Errata - 1325 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-NF) and [Changed Functionality - 1325](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1325-CF) . None for this release. Version 1323 ------------ | | | | | | | --- | --- | --- | --- | --- | | [Changed Calls - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CC) | | [Schema Changes - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-SC) | | [Announcements - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-AN) | | [New Features - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-NF) | | [Changed Functionality - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CF) | | [Document Changes and Errata - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-DC) | For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1323 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetAllBidders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAllBidders.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GeteBayDetails](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetMyeBayBuying](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetMyeBayBuying.html#ChangeHistory) * [GetMyeBaySelling](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetMyeBaySelling.html#ChangeHistory) * [GetNotificationPreferences](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetNotificationPreferences.html#ChangeHistory) * [GetNotificationsUsage](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetNotificationsUsage.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerDashboard](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerDashboard.html#ChangeHistory) * [GetSellerEvents](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerEvents.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [GetUser](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetUser.html#ChangeHistory) * [GetVeROReasonCodeDetails](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetVeROReasonCodeDetails.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SetNotificationPreferences](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/SetNotificationPreferences.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1323 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**AccountDetailEntryCodeType**` | Type | Modified | | `**AccountDetailEntryCodeType.**ExpressPayoutFee****` | Enum | Added | | `AccountDetailEntryCodeType.**ExpressPayoutFeeCredit**` | Enum | Added | | `ExtendedProducerResponsibilityType.**ProducerProductID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ShipmentPackageID**` | Field | Removed | | `ExtendedProducerResponsibilityType.**ProductDocumentationID**` | Field | Removed | | `NotificationEventTypeCodeType.**OrderInquiryClosed**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryOpened**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerOpenedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryProvideShipmentInformation**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**OrderInquiryEscalatedToCase**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRBuyerClosedDispute**` | Enum | Deprecated | | `NotificationEventTypeCodeType.**INRSellerRespondedToDispute**` | Enum | Deprecated | | `Summary.**AuctionBidCount**` | Field | Deprecated | | `Summary.**ClassifiedAdOfferCount**` | Field | Deprecated | | `Summary.**TotalLeadCount**` | Field | Deprecated | | `SellingSummary.**AuctionBidCount**` | Field | Deprecated | | `**TicketListingDetailsType**` | Type | Deprecated | | `TicketListingDetailsType.**EventTitle**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedDate**` | Field | Deprecated | | `TicketListingDetailsType.**PrintedTime**` | Field | Deprecated | | `TicketListingDetailsType.**Venue**` | Field | Deprecated | | `**SiteCodeType**` | Type | Modified | | `SiteCodeType.**Czechia**` | Enum | Added | | `SiteCodeType.**Cyprus**` | Enum | Added | | `**UpdateReturnPolicy**` | Field | Deprecated | | `**UpdateSellerInfo**` | Field | Deprecated | | `**OriginatingPostalCode**` | Field | Deprecated | | `**QuantityInfo**` | Field | Deprecated | ### Announcements - 1323 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1323 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CF) . #### New Fee and Credit added to GetAccount The following new fee and credit fields were added to [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on this new fee and credit. * `ExpressPayoutFee` * `ExpressPayoutFeeCredit` ### Changed Functionality - 1323 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Extended Producer Responsibility IDs set at account level For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level and have been removed from the Trading WSDL. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings.\*/epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. The **ExtendedProducerResponsibilityType** fields removed were: `ProducerProductID`, `ProductPackageID`, `ShipmentPackageID`, and `ProductDocumentationID`. These fields are no longer usable; if used, the user will get a warning about the fields no longer being supported. #### Several enumerated values deprecated in NotificationEventTypeCodeType Because some of the order inquiry series events have been deprecated, the following enumerated values in [NotificationEventTypeCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) (used in the **GetNotificationPreferences**, **GetNotificationsUsage**, and **SetNotificationPreferences** methods) were also deprecated: * OrderInquiryClosed * OrderInquiryOpened * INRBuyerOpenedDispute * OrderInquiryProvideShipmentInformation * OrderInquiryEscalatedToCase * INRBuyerClosedDispute * INRSellerRespondedToDispute See [NotificationEventTypeCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/NotificationEventTypeCodeType.html) for additional information. #### Four fields deprecated in GetMyeBaySelling call Because the data is no longer being actively maintained by eBay, the following four fields in **GetMyeBaySelling** have been deprecated and scheduled for decommission on 02-06-2024: Summary.**AuctionBidCount**, Summary.**ClassifiedAdOfferCount**, Summary.**TotalLeadCount**, and SellingSummary.**AuctionBidCount**. #### TicketListingDetails and QuantityInfo containers deprecated in Add/Revise/Relist/Verify calls The **TicketListingDetails** and **QuantityInfo** container fields in Add/Revise/Relist/Verify and related calls have been deprecated and are not usable. They will be ignored if sent. #### Added Czechia and Cyprus to SiteCodeType `Czechia` and `Cyprus` have been added to **SiteCodeType** as enumeration values. #### UpdateReturnPolicy and UpdateSellerInfo deprecated in ReviseItem call The **UpdateReturnPolicy** and **UpdateSellerInfofields** fields in the ReviseItem call have been deprecated and are not usable. They will be ignored if sent. #### OriginatingPostalCode field deprecated The **OriginatingPostalCode** was deprecated in Add/Revise/Relist/Verify family, GetItem family, GetSeller family, and GetOrders calls. To specify the postal code of the item's location, using the Item.PostalCode field in the request. For example, in the AddItem call specify the item's location using the [Item.PostalCode](https://developer.ebay.com/devzone/xml/docs/reference/ebay/additem.html#Request.Item.PostalCode) field. ### Documentation Changes and Errata - 1323 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-NF) and [Changed Functionality - 1323](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1323-CF) . None for this release. Version 1321 ------------ [Index of Changed Calls - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CC) [Schema Changes - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-SC) [Announcements - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-AN) [New Features - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-NF) [Changed Functionality - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CF) [Documentation Changes and Errata - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1321 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1321 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ReminderCustomizationType**` | Type | Removed | | `**RemindersType**` | Type | Removed | | `ShippingDetailsType.**CODCost**` | Field | Removed | | `SendInvoiceRequest.**CODCost**` | Field | Removed | ### Announcements - 1321 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1321 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. ### Changed Functionality - 1321 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetMyeBayReminders Call Decommissioned The **GetMyeBayReminders** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetMyeBayReminders** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-SC) section. Instead of this API, buyers and sellers can go to **My eBay** to see all of their selling/buying reminders. #### CODCost field removed The deprecated **CODCost** fields in Add/Revise/Relist/Verify calls and related calls such as SendInvoice have been removed. This field is no longer returned in GetItem/GetOrder/GetSeller responses. ### Documentation Changes and Errata - 1321 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-NF) and [Changed Functionality - 1321](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1321-CF) . None for this release. Version 1319 ------------ [Index of Changed Calls - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CC) [Schema Changes - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-SC) [Announcements - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-AN) [New Features - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-NF) [Changed Functionality - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CF) [Documentation Changes and Errata - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1319 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1319 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**ConditionDescriptorsType**` | Type | New | | `Item.**ConditionDescriptors**` | Field | New | | `**ConditionDescriptorType**` | Type | New | | `ConditionDescriptors.**AdditionalInfo**` | Field | New | | `ConditionDescriptors.**Name**` | Field | New | | `ConditionDescriptors.**Value**` | Field | New | ### Announcements - 1319 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1319 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CF) . #### Condition grading **Note:** The **ConditionDescriptors** and the **ConditionDescriptor** containers are currently available only in the United Kingdom (GB), with rollout to other markets in early July 2023. To provide support for condition grading, the **ConditionDescriptors** container, and the **ConditionDescriptor** container and its child fields **AdditionalInfo**, **Name**, and **Value**, can be used by the seller to provide information about the specific condition of an item. This information is passed in using the **Add**/**Revise**/**Relist**/**Verify** calls and returned by calling **GetItem**. ### Changed Functionality - 1319 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1319 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-NF) and [Changed Functionality - 1319](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1319-CF) . None for this release. Version 1315 ------------ [Index of Changed Calls - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CC) [Schema Changes - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-SC) [Announcements - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-AN) [New Features - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-NF) [Changed Functionality - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CF) [Documentation Changes and Errata - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1315 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [AddOrder](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddOrder.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetItemShipping](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemShipping.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [SendInvoice](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/SendInvoice.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1315 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ShippingDetailsType.**CODCost**` | Field | Deprecated | | `SendInvoiceRequest.**CODCost**` | Field | Deprecated | | `BuyerPaymentMethodCodeType.**COD**` | Enum | Deprecated | ### Announcements - 1315 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1315 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. ### Changed Functionality - 1315 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### ShippingDetailsType.CODCost and SendInvoiceRequest.CODCost fields were deprecated The ShippingDetailsType.**CODCost** and SendInvoiceRequest.**CODCost** fields, and the enumerated value BuyerPaymentMethodCodeType.**COD** was deprecated, as COD is no longer a supported payment method on any marketplace. See [Index of Changed Calls - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CC) for affected methods. ### Documentation Changes and Errata - 1315 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-NF) and [Changed Functionality - 1315](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1315-CF) . None for this release. Version 1313 ------------ [Index of Changed Calls - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CC) [Schema Changes - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-SC) [Announcements - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-AN) [New Features - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-NF) [Changed Functionality - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CF) [Documentation Changes and Errata - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1313 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1313 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . No schema changes in this release. ### Announcements - 1313 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### AddTransactionConfirmationItem and GetContextualKeywords Decommissioned The AddTransactionConfirmationItem and GetContextualKeywords calls have been decommissioned and removed from the Trading WSDL and documentation. ### New Features - 1313 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CF) . #### New Fees and Credits Added to GetAccount The following new fees and credits were added to [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) , and will be returned in **GetAccount** as applicable. See [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for details on these new fees and credits. * PromotedDisplayFee * PromotedDisplayFeeCredit * USWHTFederal * USWHTFederalCredit * USWHTState * USWHTStateCredit * EPRFee * EPRFeeCredit * CAPostReturnLabelFee * CAPostReturnLabelFeeCredit * HermesReturnLabelFee * HermesReturnLabelFeeCredit * BankPayoutFee * BankPayoutFeeCredit * CharityDonation * CharityDonationCredit ### Changed Functionality - 1313 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Logic Change for RefundAmount Field in MonetaryDetails For **GetOrders** call, there has been a logic change for the **RefundAmount** field under **MonetaryDetails** container. Previously, the final value fee amount deducted from the seller's payout funds for the sale was not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The **GetOrders** call will be updated to include the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in **GetOrders**responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the **X-EBAY-API-COMPATIBILITY-LEVEL** header value to 1311 or above. #### Logic Change for Modified Line Items in GST and GIT For **GetSellerTransactions** and **GetItemTransactions** calls, please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned. ### Documentation Changes and Errata - 1313 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-NF) and [Changed Functionality - 1313](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1313-CF) . None for this release. Version 1311 ------------ [Index of Changed Calls - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CC) [Schema Changes - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-SC) [Announcements - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-AN) [New Features - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-NF) [Changed Functionality - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CF) [Documentation Changes and Errata - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1311 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1311 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . #### Changed Schema | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**EnergyEfficiencyType**` | Type | New | | `Item.Regulatory.**EnergyEfficiencyLabel**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageDescription**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ImageURL**` | Field | New | | `Item.Regulatory.EnergyEfficiencyLabel.**ProductInformationsheet**` | Field | New | | `Item.Regulatory.**RepairScore**` | Field | Modified | | `CustomPolicies.**RegionalProductCompliancePolicies**` | Field | Added | | `CustomPolicies.RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.**CountryPolicies**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**Country**` | Field | Added | | `RegionalProductCompliancePolicies.CountryPolicies.**PolicyID**` | Field | Added | | `Item.**CustomPolicies**` | Field | Modified | ### Announcements - 1311 None for this release. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1311 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Regulatory changes **Note:** The **EnergyEfficiencyLabel** and the **Hazmat** containers are initially available only on the German (DE) marketplace. The **RepairScore** field is provided for future use (not presently available). As a part of Digital Services Act (DSA) requirements, the **EnergyEfficiencyLabel** container and its child fields **ImageDescription**, **ImageURL**, and **ProductInformationsheet**, can be used by the seller to provide Energy Efficiency Label related information for the listing. This information is passed in using the **Add/Revise/Relist/Verify** calls and returned by calling **GetItem**. **RegionalProductCompliancePolicies** and **RegionalTakeBackPolicies** fields were added, providing compliance functionality specified by region, and **ProductCompliancePolicyID** now applies to Global product compliance policies. #### Numerous fields scheduled for decommission in order management calls Numerous fields in the response payloads of the **GetOrders**, **GetItemTransactions**, **GetSellerTransactions**, and **GetMyeBaySelling** calls are being deprecated. See the [Deprecated Trading Order Management Fields](https://developer.ebay.com/devzone/deprecated_trading_ordermgmt_fields.pdf) document for the complete list of deprecated fields and reasons for deprecation. ### Changed Functionality - 1311 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. ### Documentation Changes and Errata - 1311 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-NF) and [Changed Functionality - 1311](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1311-CF) . #### Logic change for Total and AmountPaid fields in GetOrders The field descriptions for **Order.Total** and **Order.AmountPaid** fieldsin **GetOrders** incorrectly stated that sales tax was included in those two amounts, but that was not the case prior to Version 1307. Going foward, sales tax will be included in these amounts if using Trading WSDL Version 1307 or above. If using a Trading WSDL older than Version 1307, the amount in thes fields will not include sales tax. To incorporate the new logic (sales tax included) while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. Version 1305 ------------ [Index of Changed Calls - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-CC) [Schema Changes - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-SC) [Announcements - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-AN) [New Features - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-NF) [Changed Functionality - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-CF) [Documentation Changes and Errata - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1305 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) #### Schema Changes - 1305 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | **AuthenticityVerification** | Type | Modified | | AuthenticityVerification.**Status** | Field | Modified | | Order.**ShippingAddress** | Field | Modified | ### Announcements - 1305 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1305 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-CF) . None for this release. ### Changed Functionality - 1305 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Vault in-hand submission shipping address returned For Vault in-hand submission orders, the warehouse address is now available for the buyer view. For these orders, the address returned for the Buyer View will be the authenticator's address. #### New status for AuthenticityVerificationType The status PASSED\_WITH\_PARTIAL\_FAILURE was added as a possible returned value for **AuthenticityVerification.Status** field of the following calls: * GetOrders * GetOrderTransactions * GetItemTransactions This indicates in multi-quantity use cases that part of the order is authentic, but the other part of the order FAILED. ### Documentation Changes and Errata - 1305 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-NF) and [Changed Functionality - 1305](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1305-CF) . None for this release. Version 1303 ------------ [Index of Changed Calls - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-CC) [Schema Changes - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-SC) [Announcements - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-AN) [New Features - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-NF) [Changed Functionality - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-CF) [Documentation Changes and Errata - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1303 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetStore](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetStore.html#ChangeHistory) #### Schema Changes - 1303 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | Transaction.**LinkedLineItemArray** | Container | New | | LinkedLineItemArray.**LinkedLineItem** | Container | New | | LinkedLineItemArray.LinkedLineItem.**EstimatedDeliveryTimeMax** | Field | New | | LinkedLineItemArray.LinkedLineItem.**EstimatedDeliveryTimeMin** | Field | New | | LinkedLineItemArray.LinkedLineItem.**Item** | Container | Added | | LinkedLineItemArray.LinkedLineItem.**OrderID** | Field | New | | LinkedLineItemArray.LinkedLineItem.**OrderLineItemID** | Field | New | | LinkedLineItemArray.LinkedLineItem.**SellerUserID** | Field | New | | **LinkedLineItemArrayType** | Type | New | | **LinkedLineItemType** | Type | New | | **StoreType** | Type | Modified | | StoreType.**StoreSubscriptionLevelCodeType** | Type | Removed | | StoreType.**StoreSubscriptionLevel** | Field | Removed | ### Announcements - 1303 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1303 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-CF) . #### Added Support for Linking Separate Orders Schema was added that links items from separate orders which may be from different sellers. This can be used to provide details about a component (purchased from one seller) needed for its installation (purchased from a different seller). Details can identify the linked seller and also include delivery times, item information, and order information. ### Changed Functionality - 1303 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### SubscriptionLevel field removed from GetStore The **SubscriptionLevel** field has been removed from the GetStore call. Use the [getSubscription](https://developer.ebay.com/api-docs/sell/account/resources/subscription/methods/getSubscription) method of the [Account API](https://developer.ebay.com/api-docs/sell/account/overview.html) to retrieve information on a seller's eBay store subscription. ### Documentation Changes and Errata - 1303 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-NF) and [Changed Functionality - 1303](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1303-CF) . None for this release. Version 1301 ------------ [Index of Changed Calls - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-CC) [Schema Changes - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-SC) [Announcements - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-AN) [New Features - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-NF) [Changed Functionality - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-CF) [Documentation Changes and Errata - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1301 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. #### Schema Changes - 1301 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `GetApiAccessRules` | Call | Removed | | `ApiAccessRuleType` | Type | Removed | | `AccessRuleCurrentStatusCodeType` | Type | Removed | | `AccessRuleStatusCodeType` | Type | Removed | | `GetApiAccessRulesRequestType` | Type | Removed | | `GetApiAccessRulesResponseType` | Type | Removed | ### Announcements - 1301 #### Buyers in the EU must be allowed to return an item within 14 days or more As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the **ReturnPolicy** container or through a return business policy that is referenced through the **SellerProfiles.SellerReturnProfile** container. #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1301 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-CF) . None for this release. ### Changed Functionality - 1301 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### GetApiAccessRules Call Decommissioned The **GetApiAccessRules** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetApiAccessRules** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-SC) section. We recommend that you use the [Developer Analytics API](https://developer.ebay.com/api-docs/developer/analytics/static/overview.html) , an API that retrieves all usage data on all RESTful APIs and the Trading API. ### Documentation Changes and Errata - 1301 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-NF) and [Changed Functionality - 1301](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1301-CF) . None for this release. Version 1299 ------------ [Index of Changed Calls - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-CC) [Schema Changes - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-SC) [Announcements - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-AN) [New Features - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-NF) [Changed Functionality - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-CF) [Documentation Changes and Errata - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1299 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [VeROReportItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VeROReportItems.html#ChangeHistory) ### Schema Changes - 1299 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ReportItem.**Brand**` | Field | New | ### Announcements - 1299 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1299 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-CF) . None for this release. ### Changed Functionality - 1299 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Schema Added to Support VeRO Violation Reporting The field **Brand** was added to the **ReportItem** container to provide the brand name of the item being reported for VeRO violation. ### Documentation Changes and Errata - 1299 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-NF) and [Changed Functionality - 1299](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1299-CF) . None for this release. Version 1295 ------------ [Index of Changed Calls - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-CC) [Schema Changes - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-SC) [Announcements - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-AN) [New Features - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-NF) [Changed Functionality - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-CF) [Documentation Changes and Errata - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1295 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. #### Schema Changes - 1295 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `AddDispute` | Call | Removed | | `AddDisputeResponse` | Call | Removed | | `DisableUnpaidItemAssistance` | Call | Removed | | `GetDispute` | Call | Removed | | `GetUserDisputes` | Call | Removed | | `SellerReverseDispute` | Call | Removed | | `AddDisputeRequestType` | Type | Removed | | `AddDisputeResponseType` | Type | Removed | | `AddDisputeResponseRequestType` | Type | Removed | | `AddDisputeResponseResponseType` | Type | Removed | | `DisableUnpaidItemAssistanceRequestType` | Type | Removed | | `DisableUnpaidItemAssistanceResponseType` | Type | Removed | | `GetDisputeRequestType` | Type | Removed | | `GetDisputeResponseType` | Type | Removed | | `GetUserDisputesRequestType` | Type | Removed | | `GetUserDisputesResponseType` | Type | Removed | | `SellerReverseDisputeRequestType` | Type | Removed | | `SellerReverseDisputeResponseType` | Type | Removed | | `DisputeActivityCodeType` | Type | Removed | | `DisputeArrayType` | Type | Removed | | `DisputeCreditEligibilityCodeType` | Type | Removed | | `DisputeExplanationCodeType` | Type | Removed | | `DisputeFilterCountType` | Type | Removed | | `DisputeFilterTypeCodeType` | Type | Removed | | `DisputeIDType` | Type | Removed | | `DisputeMessageSourceCodeType` | Type | Removed | | `DisputeMessageType` | Type | Removed | | `DisputeReasonCodeType` | Type | Removed | | `DisputeRecordTypeCodeType` | Type | Removed | | `DisputeResolutionReasonCodeType` | Type | Removed | | `DisputeResolutionRecordTypeCodeType` | Type | Removed | | `DisputeResolutionType` | Type | Removed | | `DisputeSortTypeCodeType` | Type | Removed | | `DisputeStateCodeType` | Type | Removed | | `DisputeStatusCodeType` | Type | Removed | | `DisputeType` | Type | Removed | ### Announcements - 1295 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1295 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-CF) . None for this release. ### Changed Functionality - 1295 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Six Dispute Calls Decommissioned The following six Dispute calls have been decommissioned as of January 31, 2023. These calls and their exclusively used types have been removed from the Trading WSDL and from reference documentation: * **AddDispute** * **AddDisputeResponse** * **DisableUnpaidItemAssistance** * **GetDispute** * **GetUserDisputes** * **SellerReverseDispute** The **DisableUnpaidItemAssistance**, **AddDisputeResponse**, and **SellerReverseDispute** calls do not have alternative APIs to use since the Unpaid Item Assistant feature and Unpaid Item cases are deprecated. However, there is a page in Selling Preferences in My eBay that allows a seller to cancel and relist any items that have not been paid for after a specified amount of days. There are REST API equivalents for the other three calls as follows: * **AddDispute**: Use the [Create Cancellation Request](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation__post.html) method of the [Post-Order API](https://developer.ebay.com/devzone/post-order/index.html) to make an order cancellation request. * **GetDispute**: Use the [Get Cancellation](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) method of the [Post-Order API](https://developer.ebay.com/devzone/post-order/index.html) to retrieve details on a specific cancellation request. * **GetUserDisputes**: Use the [Search Cancellations](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement_search__get.html) method of the [Post-Order API](https://developer.ebay.com/devzone/post-order/index.html) to search for cancellation requests using a variety of search filters. #### GetOrderTransactions Call Deprecated The **GetOrderTransactions** call is deprecated and will be decommissioned on January 31, 2024. No further updates are planned for this API during the deprecation period. Developers have the option of migrating to the [GetOrders](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrders.html) call in the **Trading API**, or the [getOrders](https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders) method of the [Fulfillment API](https://developer.ebay.com/api-docs/sell/fulfillment/overview.html) . Please note that the [Fulfillment API](https://developer.ebay.com/api-docs/sell/fulfillment/overview.html) only returns paid orders, so if your use case calls for retrieving both paid and unpaid orders, we recommend migrating to the [GetOrders](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetOrders.html) call in the **Trading API**. ### Documentation Changes and Errata - 1295 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-NF) and [Changed Functionality - 1295](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1295-CF) . None for this release. Version 1291 ------------ [Index of Changed Calls - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-CC) [Schema Changes - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-SC) [Announcements - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-AN) [New Features - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-NF) [Changed Functionality - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-CF) [Documentation Changes and Errata - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1291 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) ### Schema Changes - 1291 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/api-docs/user-guides/static/make-a-call/tapi-code-lists.html) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `**Regulatory**` | Container | New | | `Regulatory.**Hazmat**` | Container | New | | `Regulatory.Hazmat.**Component**` | Field | New | | `Regulatory.Hazmat.**Pictograms**` | Container | New | | `Regulatory.Hazmat.Pictograms.**Pictogram**` | Field | New | | `Regulatory.Hazmat.**SignalWord**` | Field | New | | `Regulatory.Hazmat.**Statements**` | Container | New | | `Regulatory.Hazmat.Statements.**Statement**` | Field | New | | `Regulatory.**RepairScore**` | Field | New | | `**RegulatoryType**` | Type | New | | `**HazmatType**` | Type | New | | `**PictogramsType**` | Type | New | | `**StatementsType**` | Type | New | ### Announcements - 1291 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1291 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-CF) . #### New Schema Added to Support Hazardous Material Label Related Information and Repair Score Due to regulatory requirement changes, sellers now have the ability to provide hazardous material related information and the repair score for listings. ### Changed Functionality - 1291 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Codes for 1291 Below is the list of the new error messages that rolled out with the 1291 release. All of these messages are related to using hazardous material related information and repair score. The long version of each message is used below. * (Warning) `**21920371**`: `_replaceable_value_ ID(s) _replaceable_value_ not found. Please use valid ID(s).` * (Warning) `**21920372**`: `Duplicate Regulatory ID(s) _replaceable_value_ sent in the request. Duplicate ID(s) have been ignored.` * (Warning) `**21920373**`: `Hazmat structure incorrect for _replaceable_value_.` * (Error) `**21920374**`: `Repair score invalid. Repair score must be in the range from _replaceable_value_ to _replaceable_value_ with one decimal place.` * (Error) `**21920375**`: `The value of the _replaceable_value_ field is invalid. Field must not exceed _replaceable_value_ characters.` These error and warning messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1291 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-NF) and [Changed Functionality - 1291](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1291-CF) . None for this release. Version 1285 ------------ [Index of Changed Calls - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-CC) [Schema Changes - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-SC) [Announcements - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-AN) [New Features - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-NF) [Changed Functionality - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-CF) [Documentation Changes and Errata - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1285 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1285 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1285 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1285 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-CF) . None for this release. ### Changed Functionality - 1285 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Updated Picture Limit This release of the Trading API updates the picture limit. With the exception of motor vehicle listings on the US and Canada marketplaces, sellers can now include up to 24 pictures in a listing free of charge in all categories on all marketplaces. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see [Fees for selling vehicles on eBay Motors](https://www.ebay.com/help/selling/fees-credits-invoices/motors-fees?id=4127) ). ### Documentation Changes and Errata - 1285 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-NF) and [Changed Functionality - 1285](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1285-CF) . None for this release. Version 1281 ------------ [Index of Changed Calls - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-CC) [Schema Changes - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-SC) [Announcements - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-AN) [New Features - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-NF) [Changed Functionality - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-CF) [Documentation Changes and Errata - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1281 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetAccount](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetAccount.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1281 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `AccountDetailEntryCodeType.FedExReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.FedExReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.AUPostReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.AUPostReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.UpsCaLabelFee` | Enum | New | | `AccountDetailEntryCodeType.UpsCaLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.FedExCaLabelFee` | Enum | New | | `AccountDetailEntryCodeType.FedExCaLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.HubbedReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.HubbedReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.RoyalMailReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.RoyalMailReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.ParcelForcePostReturnLabelFee` | Enum | New | | `AccountDetailEntryCodeType.ParcelForcePostReturnLabelFeeCredit` | Enum | New | | `AccountDetailEntryCodeType.OffsiteAdsFee` | Enum | New | | `AccountDetailEntryCodeType.OffsiteAdsFeeCredit` | Enum | New | | `CancelReasonCodeType.AddressIssues` | Enum | New | | `CancelReasonCodeType.BuyerCancelOrAddressIssue` | Enum | Deprecated | | `Item.IsItemEMSEligible` | Field | New | ### Announcements - 1281 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### EU and UK Payments regulations update: Digital Signatures Due to EU and UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers, including **GetAccount**. Refer to [Digital Signatures for APIs](https://developer.ebay.com/develop/guides/digital-signatures-for-apis) for information about creating signatures to be included in the HTTP payload. ### New Features - 1281 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-CF) . #### New item eligibility flag for shipping managed by eBay The new boolean field **IsItemEMSEligible** was added to the **GetItem** call (in **ItemType**). If `true`, the item is eligible for shipping managed by eBay; `false`, the item is not eligible for shipping managed by eBay. ### Changed Functionality - 1281 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Updates to GetAccount Call Sixteen new enumeration values were added for **GetAccount** (in **AccountDetailEntryCodeType**) to account for new account fees/credits. The enumeration values include: * `FedExReturnLabelFee` * `FedExReturnLabelFeeCredit` * `AUPostReturnLabelFee` * `AUPostReturnLabelFeeCredit` * `UpsCaLabelFee` * `UpsCaLabelFeeCredit` * `FedExCaLabelFee` * `FedExCaLabelFeeCredit` * `HubbedReturnLabelFee` * `HubbedReturnLabelFeeCredit` * `RoyalMailReturnLabelFee` * `RoyalMailReturnLabelFeeCredit` * `ParcelForcePostReturnLabelFee` * `ParcelForcePostReturnLabelFeeCredit` * `OffsiteAdsFee` * `OffsiteAdsFeeCredit` See these new values in [AccountDetailEntryCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/AccountDetailEntryCodeType.html) for more information. #### Updates to CancelReasonCodeType type A new enumerated value `AddressIssues` was added and the enumerated value `BuyerCancelOrAddressIssue` was Deprecated. See the new value in [CancelReasonCodeType](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/types/CancelReasonCodetype.html) for more information. #### Shipping service override changes to business policies When revising or relisting an item that is using business policies and has one or more shipping service cost overrides set up, the **Item.SellerProfiles.SellerShippingProfile** container and the **Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride** container(s) must be included even if no changes are being made. #### Australia sellers offering freight shipping changes Sellers offering freight shipping on the Australia (AU) marketplace must now use the `AU_Freight` enumeration value for **ShippingServiceCodeType**. For these sellers, the `Freight` value will no longer be accepted and may lead to a blocking error. ### Documentation Changes and Errata - 1281 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-NF) and [Changed Functionality - 1281](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1281-CF) . None for this release. Version 1279 ------------ [Index of Changed Calls - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-CC) [Schema Changes - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-SC) [Announcements - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-AN) [New Features - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-NF) [Changed Functionality - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-CF) [Documentation Changes and Errata - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1279 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItemTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItemTransactions.html#ChangeHistory) * [GetOrders](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrders.html#ChangeHistory) * [GetOrderTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetOrderTransactions.html#ChangeHistory) * [GetSellerTransactions](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerTransactions.html#ChangeHistory) ### Schema Changes - 1279 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ShippingDetails.eBayEstimatedLabelCost` | Field | New | ### Announcements - 1279 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1279 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-CF) . #### Added support for eBay shipping The return of the **eBayEstimatedLabelCost** field with a value of `0.0` indicates that a free shipping label by eBay is downloadable by the seller via the eBay website. See more details about [Authenticity Guarantee](https://pages.ebay.com/authenticity-guarantee-sneakers-seller/) and how eBay shipping applies to eligible sneaker listings. ### Changed Functionality - 1279 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Codes for 1279 Below is the list of the new error messages that rolled out with the 1279 release. All of these messages are related to using eBay Shipping. The long version of each message is used below. * (Warning) `**21920343**`: `_replaceable_value_. // Mapped to authenticity guarantee notification message` * (Warning) `**21920344**`: `_replaceable_value_. // Mapped to eBay shipping notification message` * (Warning) `**21920345**`: `This listing is not eligible for eBay shipping. Option ignored.` * (Error) `**21920346**`: `This listing qualifies for eBay shipping. Local pickup only is not a valid shipping option.` * (Error) `**21920347**`: `This listing qualifies for eBay shipping. Handling time must not exceed 3 days.` * (Warning) `**21920348**`: `_replaceable_value_ has been dropped as no domestic shipping service was provided.` These error and warning messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1279 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-NF) and [Changed Functionality - 1279](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1279-CF) . None for this release. Version 1275 ------------ [Index of Changed Calls - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-CC) [Schema Changes - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-SC) [Announcements - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-AN) [New Features - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-NF) [Changed Functionality - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-CF) [Documentation Changes and Errata - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1275 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1275 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1275 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1275 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-CF) . #### A new intermediated international shipping program has been added A new intermediated international shipping program called eBay International Shipping is available. On the US marketplace, the Global Shipping Program is scheduled to be replaced by this new intermediated shipping program (eBay International Shipping). US Sellers opted in to the Global Shipping Program will automatically get opted into eBay International Shipping once it becomes available to them. All US sellers will be migrated by March 31, 2023. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Support for eBay International Shipping has been added to **GetOrders**, **GetSellerTransactions**, **GetItemTransactions**, and **GetOrderTransactions** calls. The eBay International Shipping partner's address is shown in the **MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress** container. Additionally, similar to the **ReferenceID** field provided for the Global Shipping Program, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to the **Street2** field (not in the **ReferenceID** field). ### Changed Functionality - 1275 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1275 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-NF) and [Changed Functionality - 1275](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1275-CF) . None for this release. Version 1267 ------------ [Index of Changed Calls - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-CC) [Schema Changes - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-SC) [Announcements - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-AN) [New Features - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-NF) [Changed Functionality - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-CF) [Documentation Changes and Errata - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1267 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1267 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1267 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### Four Store Calls Scheduled for Decommission on September 30 The new Stores platform no longer supports custom store pages and other customization functionality, so the following four store calls are deprecated and scheduled for decommission on September 30, 2022: * [GetStoreCustomPage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStoreCustomPage.html) * [GetStoreOptions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStoreOptions.html) * [SetStore](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SetStore.html) * [SetStoreCustomPage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/SetStoreCustomPage.html) Although these four calls still work and will continue to work up until the decommission date, it is recommended that they are no longer used since none of the customization features in these calls can be applied to stores in the Production environment Additionally, the following containers and fields related to store customization in the **GetStore** call are also deprecated and scheduled for decommission on September 30, 2022: * [CustomHeader](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.CustomHeader) (string) * [CustomHeaderLayout](https://developer.ebay.com/keystone/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.CustomHeaderLayout) (enum) * [CustomListingHeader](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.CustomListingHeader) (whole container) * [ExportListings](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.ExportListings) (boolean) * [HeaderStyle](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.HeaderStyle) (enum) * [HomePage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.HomePage) (long) * [ItemListLayout](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.ItemListLayout) (enum) * [ItemListSortOrder](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.ItemListSortOrder) (enum) * [Logo.LogoID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.Logo.LogoID) (int) * [Logo.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.Logo.Name) (string) * [Theme](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.Theme) (whole container) * [TitleWithCompatibility](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetStore.html#Response.Store.TitleWithCompatibility) (boolean) ### New Features - 1267 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-CF) . None for this release. ### Changed Functionality - 1267 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1267 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-NF) and [Changed Functionality - 1267](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1267-CF) . None for this release. Version 1257 ------------ [Index of Changed Calls - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-CC) [Schema Changes - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-SC) [Announcements - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-AN) [New Features - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-NF) [Changed Functionality - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-CF) [Documentation Changes and Errata - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1257 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1257 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `HitCounterCodeType` | Type | Removed | | `Item.HitCounter` | Field | Removed | ### Announcements - 1257 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1257 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-CF) . None for this release. ### Changed Functionality - 1257 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### HitCounter field removed from WSDL The **HitCounter** field has been removed from the WSDL. It can no longer be used in Add/Revise calls, nor will it be returned in **GetItem**, **GetBidderList**, **GetSellerEvents**, or **GetSellerList**. #### HitCount field updates The **HitCount** field will no longer be returned in **GetItem** or **GetBidderList**, but it will continue to be returned in **GetSellerEvents** and **GetSellerList**, but with a logic change. Instead of the **HitCount** value representing the lifetime hit count for listings, the value will be the total number of page hits within the latest 30-day period. #### Quantity and StartPrice no longer returned in ReviseInventoryStatus The **Quantity** and **StartPrice** fields will no longer be returned in the **ReviseInventoryStatus** response. However, these fields will function the same as before in **ReviseInventoryStatus** request. If users would like to verify if their price and/or quanity changes were successfully pushed out to the listing (or variation within a listing), they can use the **GetItem** call to verify the changes. ### Documentation Changes and Errata - 1257 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-NF) and [Changed Functionality - 1257](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1257-CF) . None for this release. Version 1255 ------------ [Index of Changed Calls - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-CC) [Schema Changes - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-SC) [Announcements - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-AN) [New Features - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-NF) [Changed Functionality - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-CF) [Documentation Changes and Errata - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. . ### Index of Changed Calls - 1255 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1255 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `GetCategorySpecificsRequest` | Type | Removed | | `GetCategorySpecificsResponse` | Type | Removed | | `AspectUsageCodeType` | Type | Removed | | `CategoryItemSpecificsType` | Type | Removed | | `NameRecommendationType` | Type | Removed | | `NameValueRelationshipType` | Type | Removed | | `ProductRequiredCodeType` | Type | Removed | | `RecommendationsType` | Type | Removed | | `RecommendationValidationRulesType` | Type | Removed | | `RelevanceIndicatorType` | Type | Removed | | `SelectionModeCodeType` | Type | Removed | | `UsageConstraintCodeType` | Type | Removed | | `ValueFormatCodeType` | Type | Removed | | `ValueRecommendationType` | Type | Removed | | `VariationPictureRuleCodeType` | Type | Removed | | `VariationSpecificsRuleCodeType` | Type | Removed | ### Announcements - 1255 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### GetCategorySpecifics Call Decommisioned The **GetCategorySpecifics** call has been decommissioned, and the call reference documentation has been removed. Additionally, all types exclusively used by **GetCategorySpecifics** have been removed from the Trading WSDL. You can see the full list of removed types in the [Schema Changes](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-SC) section. The alternative solution to **GetCategorySpecifics** is the [getItemAspectsForCategory](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/category_tree/methods/getItemAspectsForCategory) method of the [Taxonomy API](https://developer.ebay.com/api-docs/commerce/taxonomy/overview.html) . For more information about migrating to the [Taxonomy API](https://developer.ebay.com/api-docs/commerce/taxonomy/overview.html) and using the [Taxonomy SDK](https://github.com/eBay/taxonomy-sdk) , see the [Taxonomy API migration guide](https://developer.ebay.com/api-docs/commerce/static/migration-landing.html) . ### New Features - 1255 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-CF) . None for this release. ### Changed Functionality - 1255 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1255 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-NF) and [Changed Functionality - 1255](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1255-CF) . None for this release. Version 1249 ------------ [Index of Changed Calls - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-CC) [Schema Changes - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-SC) [Announcements - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-AN) [New Features - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-NF) [Changed Functionality - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-CF) [Documentation Changes and Errata - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page, or visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### Index of Changed Calls - 1249 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) ### Schema Changes - 1249 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1249 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1249 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-CF) . None for this release. ### Changed Functionality - 1249 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Extended producer responsibility related information returned Sellers can now return their listing's extended producer responsibility related information using the **GetItem** call. ### Documentation Changes and Errata - 1249 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-NF) and [Changed Functionality - 1249](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1249-CF) . None for this release. Version 1247 ------------ [Index of Changed Calls - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-CC) [Schema Changes - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-SC) [Announcements - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-AN) [New Features - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-NF) [Changed Functionality - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-CF) [Documentation Changes and Errata - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page and the [Knowledge Base](https://developer.ebay.com/support/knowledge-base) . ### Index of Changed Calls - 1247 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [GetBidderList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetBidderList.html#ChangeHistory) * [GetItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetItem.html#ChangeHistory) * [GetSellerEvents](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerEvents.html#ChangeHistory) * [GetSellerList](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GetSellerList.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1247 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . No schema changes in this release. ### Announcements - 1247 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. #### Winter 2022 Seller Updates Available The [Winter 2022 Seller Updates](https://pages.ebay.com/seller-center/seller-updates/2022-winter/index.html) have been released. Below is a high-level summary of the updates: * More robust sales data available under **Performance** tab in **Seller Hub** * Updates and expansion for all Promoted Listings products (Standard, Express, and Advanced) * More sellers will get the option of requiring all buyers to provide payment details before making a Best Offer on a listing, reducing the risk of Unpaid Items for Best Offer transactions * More sellers will get the option of requiring all buyers to provide payment details before making a Best Offer on a listing, reducing the risk of Unpaid Items for Best Offer transactions * Upcoming updates to order fees and credits * Sellers will now be refunded the $0.30 per-order fee for orders that are cancelled at the buyer's request * The additional final value fee charged to Below Standard sellers will increase from 5% to 6% (of sales price) * Final value fees will have a slight increase for most categories (0.3% for Store sellers and 0.35% for non-Store sellers). See the [Selling Fees Updates](https://pages.ebay.com/seller-center/seller-updates/2022-winter/fees-update.html) table for the full list of fee increases. * Listing Subtitle fee increases by $0.50 for both fixed-price and auction listings * Starting in May 2022, sellers will get partial final value fee credits for partial refunds * Starting in June 2022, the Promoted Listings Standard fee will be calculated based on the total order cost (including applicable taxes and shipping), and not just the sales price ### New Features - 1247 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-CF) . None for this release. ### Changed Functionality - 1247 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. #### HitCounter and HitCount Fields Deprecated Hit counters are no longer displayed in View Item pages, so the [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.HitCounter) and [HitCount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCount) fields are no longer applicable and are scheduled for decommission. For developers/sellers who are interested in seeing page views and listing performance, the [getTrafficReport](https://developer.ebay.com/api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport) method of the [Sell Analytics API](https://developer.ebay.com/api-docs/sell/analytics/overview.html) can be used. Currently, if the [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.HitCounter) field is used in the request payload of an add/revise/relist/verify call, the field will be ignored and a warning message will be returned. Until both fields are decommissioned, the [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCounter) and [HitCount](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCount) fields will still be returned in [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.HitCount) , [GetBidderList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetBidderList.html#Response.BidItemArray.Item.HitCount) , [GetSellerEvents](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerEvents.html#Response.ItemArray.Item.HitCount) , and [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.HitCount) . For [HitCounter](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/HitCounterCodeType.html) , the default value for the marketplace will be returned, such as `NoHitCounter` or `HiddenStyle`. ### Documentation Changes and Errata - 1247 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-NF) and [Changed Functionality - 1247](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1247-CF) . None for this release. Version 1235 ------------ [Index of Changed Calls - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-CC) [Schema Changes - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-SC) [Announcements - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-AN) [New Features - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-NF) [Changed Functionality - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-CF) [Documentation Changes and Errata - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-DC) For a current list of known issues, see the [API Status](https://developer.ebay.com/support/api-status) page and the [Knowledge Base](https://developer.ebay.com/support/knowledge-base) . ### Index of Changed Calls - 1235 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls * [AddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddFixedPriceItem.html#ChangeHistory) * [AddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItem.html#ChangeHistory) * [AddItems](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/AddItems.html#ChangeHistory) * [RelistFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistFixedPriceItem.html#ChangeHistory) * [RelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/RelistItem.html#ChangeHistory) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#ChangeHistory) * [ReviseItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/ReviseItem.html#ChangeHistory) * [VerifyAddFixedPriceItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddFixedPriceItem.html#ChangeHistory) * [VerifyAddItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyAddItem.html#ChangeHistory) * [VerifyRelistItem](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/VerifyRelistItem.html#ChangeHistory) ### Schema Changes - 1235 **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/devzone/guides/features-guide/default.html#Basics/Call-APISchema.html#CodeLists) . **Note:** Support for extended producer responsibility regulations and custom policies will become active mid-December 2021. Additional resources such as the custom policies resource (for the **Account API**), the **getExtendedProducerResponsibilityPolicies** method (for the **Sell Metadata API**), and the [Custom Policies](https://www.ebay.com/help/selling/custom-policies/custom-policies?id=5311) help page will also become active. | Name | Part of Schema | Type of Change | | --- | --- | --- | | `ExtendedProducerResponsibilityType` | Type | New | | `Item.ExtendedProducerResponsibility` | Field | New | | `Item.ExtendedProducerResponsibility.ProducerProductId` | Field | New | | `Item.ExtendedProducerResponsibility.ProductPackageId` | Field | New | | `Item.ExtendedProducerResponsibility.ShipmentPackageId` | Field | New | | `Item.ExtendedProducerResponsibility.ProductDocumentationId` | Field | New | | `Item.ExtendedProducerResponsibility.EcoParticipationFee` | Field | New | | `CustomPoliciesType` | Type | New | | `Item.CustomPolicies` | Field | New | | `Item.CustomPolicies.TakeBackPolicyId` | Field | New | | `Item.CustomPolicies.ProductCompliancePolicyId` | Field | New | | `Item.Variations.Variation.VariationExtendedProducerResponsibility` | Field | New | | `VariationExtendedProducerResponsibilityType` | Type | New | | `Item.Variations.Variation.VariationExtendedProducerResponsibility.Item.Variations.Variation.EcoParticipationFee` | Field | New | ### Announcements - 1235 #### Change Requests See the [API Status](https://developer.ebay.com/support/api-status) page for announcements regarding recently resolved or current system wide issues. Visit the [Support](https://developer.ebay.com/support) page for account support, technical support, and other support resources. ### New Features - 1235 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-CF) . **Note:** Support for extended producer responsibility regulations and custom policies will become active mid-December 2021. Additional resources such as the custom policies resource (for the **Account API**), the **getExtendedProducerResponsibilityPolicies** method (for the **Sell Metadata API**), and the [Custom Policies](https://www.ebay.fr/help/selling/custom-policies/custom-policies?id=5311) help page will also become active. #### New Schema added to support custom policies To support custom policies, policy IDs can be specified in add, revise, relist, or verify calls. This feature is supported by a limited number of sites and specific categories. Refer to the [Metadata API](https://developer.ebay.com/api-docs/sell/metadata/overview.html) to return the enabled sites and categories. To create and manage custom policies, see the [Account API](https://developer.ebay.com/api-docs/sell/account/overview.html) . * **CustomPolicies**: This container and its child fields are used to specify custom policy IDs. #### New Schema added to support extended producer responsibility regulations To support new extended producer responsibility regulations, information about the producer of a new item can be specified in add, revise, relist, or verify calls. This feature is supported by a limited number of sites and specific categories. Refer to the [Metadata API](https://developer.ebay.com/api-docs/sell/metadata/overview.html) to return the enabled sites and categories. * **ExtendedProducerResponsibility**: This container field provides information about the producer of the new item. This includes producer, packaging, shipment packaging, and added documentation IDs, and the **EcoParticipationFee**. * **VariationExtendedProducerResponsibility**: This container field defines variation-specific Extended Producer Responsibility information, specifically the **EcoParticipationFee** in add, revise, relist, or verify calls. ### Changed Functionality - 1235 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### New Error Codes for 1235 Below is the list of the new error messages that rolled out with the 1235 release. All of these messages are related to using Extended Producer Responsibility. The long version of each message is used below. * (Warning) `**21920322**`: `_replaceable_value_ is not applicable and has been dropped.` * (Error) `**21920323**`: `_replaceable_value_ is required for this category.` * (Warning) `**21920324**`: `Eco Participation Fee is not applicable for the condition and has been dropped.` * (Error) `**21920325**`: `Eco Participation Fee is not valid and needs to be a number between _replaceable_value_ and _replaceable_value_.` * (Error) `**21920326**`: `_replaceable_value_ is not valid.` * (Error) `**21920327**`: `_replaceable_value_ cannot be revised if the item has a bid or is ending within 12 hours._replaceable_value_ business day(s).` * (Warning) `**21920328**`: `Same policy ID(ies) _replaceable_value_ cannot be specified multiple times.` * (Error) `**21920329**`: `Only _replaceable_value_ policies can be specified, But given policies are _replaceable_value_.` * (Error) `**21920330**`: `The specified _replaceable_value_ policy(ies) _replaceable_value_ are not found.` * (Error) `**21920331**`: `The policy(ies) _replaceable_value_ is not of type _replaceable_value_.` * (Warning) `**21920332**`: `Item level Eco Participation Fee will be ignored for MSKU items.` These error and warning messages can be viewed in the [Errors By Number](https://developer.ebay.com/devzone/XML/docs/Reference/eBay/Errors/ErrorMessages.htm#ErrorsByNumber) page. ### Documentation Changes and Errata - 1235 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-NF) and [Changed Functionality - 1235](https://developer.ebay.com/devzone/XML/docs/ReleaseNotesArchive.html#1235-CF) . None for this release. --- # Product feed response definitions | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-response-product-feed.html#mainContent) A product feed response tells you if all the data in a product feed was processed successfully or not. The following table explains the elements or fields in the product feed response file. Sample response files: * [product-response.csv](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-csv/product-response.csv) * [product-response.xml](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-samples/ebay-response-xml/product-response.xml) **Note:** The fields in the table below are ordered according to their order in the CSV file. The parent is provided for XML fields in order to make it easier to locate that field in the XML file. | Field name | Description | | --- | --- | | CSV: `SKU`

XML: `productDetail.SKU` | The product's Stock Keeping Unit value, defined by the seller to identify the product. This value must be unique across the seller's inventory on each eBay marketplace.

**Occurrence**: Always Returned

**Max length**: 50 | | CSV: `Group ID`

XML: `productDetail.groupID` | The unique identifier for a product group that is used for a multiple-variation listing. This field will only be returned for SKUs that are assigned to a product group.

**Occurrence**: Conditionally Returned

**Max length**: 50 | | CSV: `Locale`

XML: `productDetail.locale` | Specifies the language used for data in the listing. The default language of the eBay marketplace is used if this field is not supplied in the input file. Values include `en_US`, `en_GB`, `es_ES`, `fr_FR`, and others. See [Locale enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-locale.html)
for full list.

**Occurrence**: Always Returned | | CSV: `ePID`

XML: `productDetail.ePID` | eBay-generated product identifier (ePID) for the seller's product. | | CSV: `listable`

XML: `productDetail.Listable` | Indicates if the product has all the product attributes required for creating an eBay listing.

**Type:** boolean value (`true` or `false`) | | CSV: `categoryAssigned`

XML: `productDetail.CategoryAssigned` | Indicates if the product has a category assigned..

**Type:** boolean value (`true` or `false`) | | CSV: `categoriesAssigned`

XML: Not returned in XML response | Indicates the product categories assigned, such as `109684`. | | CSV: `missingProperties`

XML: Not returned in XML response | An identifier of missing property, such as a missing `MPN`. | | CSV: `invalidProperties`

XML: Not returned in XML response | An identifier of invalid properties. | | CSV: `invalidFields`

XML: `productDetail.InvalidFields` | An identifier of fields that have invalid information, such as `TITLE`. | | CSV: `Channel ID`

XML: `productDetail.channelID` | The unique identifier of the eBay marketplace where the SKU is/will be listed. Values include `EBAY_US`, `EBAY_GB`, `EBAY_DE`, and others. See [Marketplace enumerated values](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-enum-marketplace.html)
for full list.

Channel ID is an optional field in regular Product feeds (CSV ad XML), so it will only be returned if set in the input file.

**Occurrence**: Conditionally Returned | | CSV: `Item ID`

XML: `productDetail.itemID` | The unique identifier of the listing where the SKU is being offered. If a SKU was not created/updated successfully, and is not currently in an active listing, this field is not returned.

**Occurrence**: Conditionally Returned | | CSV: `Status`

XML: `productDetail.status` | The value in this field indicates whether the SKU was successfully uploaded/updated in MIP. Valid values are `SUCCESS`: and `FAILED`. For SKUs with `FAILED`, there is generally an error message include in the response file.

**Occurrence**: Always Returned | | CSV: `Message Type`

XML: `messageInfo.messageType` | The type of error or warning. This field is only returned if there was an issue creating or updating the SKU.

**Occurrence**: Conditionally Returned | | CSV: `Message ID`

XML: `messageInfo.messageID` | The unique identifier of the error or warning. This field is only returned if there was an issue creating or updating the SKU.

**Occurrence**: Conditionally Returned | | CSV: `Message`

XML: `messageInfo.message` | The actual text of the error or warning. This field is only returned if there was an issue creating or updating the SKU. This field can include information about errors and how to correct them.

**Occurrence**: Conditionally Returned | Additional container in XML response ------------------------------------ In addition to the fields called out in the table above, the feed response file will also have a **feedSummary** container. See [XML feedSummary container](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-response-files.html#XML) for details. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Associate pictures with a listing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/associate-pictures.html#mainContent) Listing calls (e.g., [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) and [AddItems](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItems.html) ,) associate pictures with a listing. When creating a new listing, the following [Item.PictureDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PictureDetails) fields are used to add one or more pictures to a listing: * [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PictureDetails.PictureURL) specifies the URL for a picture. * [Item.PictureDetails.GalleryType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PictureDetails.GalleryType) specifies the type of gallery. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Terminate a second chance offer | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/second-chance-terminate.html#mainContent) A seller may terminate/cancel a Second Chance Offer at any time prior to: * The expiration of the Second Chance Offer's listing duration, or * The offer's recipient's electing to purchase the item through the Second Chance Offer listing. To terminate a Second Chance Offer, use **EndItem** and pass in the item ID for the Second Chance Offer listing (**NOTE:** this ID is **not** the item ID for the original listing). For more information about using **EndItem** to end item listings, refer to [End a Listing Early](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/end-early.html) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Relist with revised product details | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-product-details.html#mainContent) When calling [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) to relist an item with product details, a seller may want to: * Add product details to the listing. To add product details: * Configure [Item.ProductListingDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.ProductListingDetails) to specify all product information that you want to include in the listing. * Specify the ID of the product that should be used to pre-fill the listing. * Use optional child elements to specify whether you want the listing to include a stock photo, whether you want to use the stock photo as the item's gallery image, and whether to include a stock summary in addition to your own item description. * Include a stock photo in the listing. To do so, either use the stock photo as the Gallery image by setting [Item.ProductListingDetails.UseStockPhotoURLAsGallery](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.ProductListingDetails.UseStockPhotoURLAsGallery) to `true` or use the first image passed in [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.PictureDetails.PictureURL) as the Gallery image. For more information, refer to [Use an eBay stock photo as a gallery picture](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/catalog-products.html#stock) . * Remove all existing product data, including Item Specifics. To remove all existing product data from the listing, specify the following arguments in [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.DeletedField) : * [Item.ProductListingDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.ProductListingDetails) * [Item.ItemSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.ItemSpecifics) Removing product data without removing Item Specifics has the following effects: * Pre-filled item specifics are removed from the listing. * Item specifics that are not pre-filled are maintained unless you remove them or change the category to one that does not support the previously specified item specifics. * The stock photo (if any) is removed from the listing and Gallery (if applicable). * The link to additional summary information is removed from the listing. * Replace previous product data including pre-filled Item Specifics. To replace the previous product data with data for a different product: * Configure [Item.ProductListingDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.ProductListingDetails) with the new product data. * Add, modify, or change item specifics that have not been pre-filled. To add, modify, or change only the item specifics that were not pre-filled, refer to [Update Item Specifics](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/item-specifics-update.html) for information about revising Item Specifics. After calling [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) with product details, compare the response with the request to verify that the data actually listed match the data that had been sent. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Include item specifics | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/include-item-specifics.html#mainContent) Item Specifics help buyers to find and compare particular types of items more easily when searching and browsing eBay. By using Item Specifics in listings, sellers can also benefit in these ways: * Increased exposure of their listings in eBay's search and browse pages * Recommendations for more effective names and values (so the seller doesn't have to guess) * Faster listing times (because you can pre-fill recommended names and values for the seller) * More structured data to help buyers grasp the details of the seller's listing more easily In the API, Item Specifics are name/value pairs (simple strings). A seller chooses from a list of the most popular field names and values defined by other users, and/or defines their own field names and values. In the API, you use the names and values the seller specified (as-is) when you list or display an item. **Note:** Item Specifics are not supported in all categories. Item specifics can be included in a listing as follows: * You can pre-fill Item Specifics based on stock information from an eBay catalog product. For example, if you are listing a camera, you just specify the UPC in [Item.ProductListingDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ProductListingDetails) , and if eBay is able to match the UPC value to a product in the eBay product catalog, eBay will be able to automatically fill out some of the product details, including the pertinent Item Specifics for that product. For additional information, refer to [eBay catalog products](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/catalog-products.html) . * You can define the Item Specifics yourself in the [Item.ItemSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ItemSpecifics) container of an add/revise/relist call. This might be necessary if you are listing an item that does not have a UPC, ISBN, EAN, or other industry-standard identifier, or if the product has an identifier but eBay is unable to match the identifier to a product in the eBay product catalog. For additional information, refer to [Required Item Specifics](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/item-specifics-requirements.html) . * You can list a collection of similar items as a _multiple-variation listing_. For example, if you are listing T-shirts that are all the same brand and style, but they come in different colors and sizes, call [AddFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html) , use the [Item.ItemSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ItemSpecifics) container to define the common information (e.g., "Brand" and "Sleeve Length",) and then use the [Item.Variations.Variation.VariationSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.VariationSpecifics) container to specify the Item Specifics for each variation of the product. Generally, t-shirts and other pieces of clothing would vary by "Color" and "Size". For additional information, refer to [Multiple-variation listings](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/variations.html) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Strikethrough pricing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/discount-pricing-strikethru.html#mainContent) **Important!** Strikethrough Pricing is restricted to a limited number of existing sellers. It is no longer available to new sellers. Strikethrough Pricing is available on the following marketplaces: * eBay US * eBay Great Britain * eBay Germany * eBay Canada (English and French) * eBay France * eBay Italy * eBay Spain Each of these marketplaces have different display treatments for items that are listed with [Item.DiscountPriceInfo](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo) elements. Strikethrough Pricing is a visual treatment consisting of an "original" price in a strikethrough font, as well as the current discounted item price in a non-strikethrough font. The original price is the price (excluding shipping and handling fees) at which the same item, or one that is virtually identical to it, is being offered for sale. On the Great Britain (GB) and Germany (DE) marketplaces, the seller can also specify that they have offered a similar item for sale on or off of eBay. **Note:** The marketplaces that support this feature all use different notations and phrasing for their strike-through pricing display treatments. For example, the US marketplace makes use of the phrase "Compare at", while the GB marketplace uses "RRP", and the DE marketplace uses "UVP". Eligibility ----------- The display rules for Strikethrough Pricing apply when an item is listed with discount pricing information that returns [Item.DiscountPriceInfo.PricingTreatment](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.DiscountPriceInfo.PricingTreatment) = `STP`. To qualify for an STP display treatment, [Item.StartPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.StartPrice) must be below the [Item.DiscountPriceInfo.OriginalRetailPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo.OriginalRetailPrice) as illustrated in the following snippet from an XML response from the Trading API. **API response sample for Strikethrough Pricing** ... 149.99 ... 159.99 STP true ... The specific XML response for discount pricing information may vary slightly from API to API. Treatment rules --------------- You are not required to use the Strikethrough Pricing treatment for listings that have strikethrough pricing information. You can simply display the item price without any special treatment. If you choose to provide a Strikethrough Pricing treatment, the application should display the [Item.DiscountPriceInfo.OriginalRetailPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo.OriginalRetailPrice) in a strikethrough price along with the BIN item price (i.e., [Item.StartPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.StartPrice) ,) in a non-strikethrough font, and text to indicate there is a discount (e.g., "Compare at"). The eBay UK and eBay Germany (DE) marketplaces have slightly different discount display treatments as described below. If the item is listed on the UK (GB) or German (DE) marketplaces, item can also include an [Item.DiscountPriceInfo.SoldOneBay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo.SoldOneBay) or [Item.DiscountPriceInfo.SoldOffeBay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo.SoldOffeBay) field that, if used, indicates that the same seller offered a similar item for sale within the last 60 days at a price indicated by the [Item.DiscountPriceInfo.OriginalRetailPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.DiscountPriceInfo.OriginalRetailPrice) value. The following image illustrates the Strikethrough Pricing visual treatment on the US marketplace. eBay includes a footnote, indicated by the asterisk, to explain that the "Compare at" price comes from another online retailer, not eBay. ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-in-srp.png) When applying a Strikethrough Pricing treatment for an eBay listing, your application should display or include a link that displays explanatory text on pages upon which item price is hidden. The explanatory text in the US should read as follows: A "Compare at" price is the price (excluding shipping and handling fees) this seller has provided at which the same item, or one that is virtually identical to it, is being offered for sale or has been offered for sale within the last 90 days. Modify this text, as needed, for discounted items listed in the UK/Great Britain (GB) or Germany (DE). ### UK/Great Britain (GB) marketplace The eBay UK/Great Britain (GB) marketplace employs the following strikethrough treatment styles: * If an item qualifies for Strikethrough pricing, the item display shows `RRP` followed by a strikethrough price. Below this, `You save` displays with the amount saved in British pounds: ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-uk-default.jpg) * If the item has been sold by the same seller on eBay during the past 30 days, the item display shows `Was` followed by a strikethrough price. Below this, `You save` displays with the amount saved in British pounds: ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-uk-on-ebay.jpg) * If the item has previously been sold by the same seller off of eBay during the past 30 days (either on another web site or offline store), the item display shows `Was*` followed a strikethrough price. Below this, `You save` displays with the amount saved in British pounds: ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-uk-off-ebay.jpg) ### Germany (DE) marketplace The eBay Germany (DE) marketplace employs the following strikethrough treatment styles: * If an item qualifies for Strikethrough pricing, the item display shows `UVP` followed by a strikethrough price. Below this, `Sie sparen` displays with the amount saved in euros: ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-de-default.jpg) * If the item has been sold by the same seller on eBay during the past 60 days, the item display shows `Urspünglich` followed by a strikethrough price. Below this, `Sie sparen` displays with the amount saved in euros: ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-de-on-ebay.jpg) * If the item has previously been sold by the same seller off of eBay during the past 30 days (either on another web site or offline store), the item display shows `Was*` followed a strikethrough price. Below this, `Sie sparen` displays with the amount saved in euros: ![](https://developer.ebay.com/api-docs/res/Resources/images/tug/stp-de-off-ebay.jpg) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Business Policies Management API | Making a Call eBay Business Policies Management API * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) Making a Call ============= This document explains how to make Business Policies Management API calls. It provides an overview of the formats and parameters you can use with the Business Policies Management API. **Important!** eBay recommends that you use the [Account API](https://developer.ebay.com/api-docs/sell/account/resources/methods) to set up all your fulfillment, payment, and return business policies. This API Reference remains active for archival purposes only. * [Introduction to Service](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#intro) * [Supported Request and Response Formats](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#formats) * [XML](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#xmlformat) * [SOAP](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#soapformat) * [Call Structure](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#callstruct) * [Service Endpoints](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#endpt) * [Standard URL Parameter or HTTP Header Values](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#StandardURLParameters) * [URL Parameter Examples](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#URLExamples) * [HTTP Header Examples](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#HTTPHeaderExamples) * [Call-Specific Values](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#Call-SpecificValues) * [Syntax](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#syntax) * [UTF-8 Encoding for Special Characters](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#utf8encoding) * [URL Encoding for String Values](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#urlencoding) * [XML Syntax](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#xmlsyntax) * [SOAP Syntax](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#soapsyntax) * [Testing Overview](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#TestingOverview) * [Schema Location](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#SchemaLocation) Introduction to Service ----------------------- The Business Policies Management API is a SOA service that is intended to be consumed by sellers who are interested in creating and managing payment, return, and shipping business policies to use with their eBay listings. High-level information for the service are covered below, including service endpoints, HTTP headers and URL parameters, naming conventions, and versioning scheme. * **Service Endpoints**—The Business Policies Management API has unique gateway URLs (service endpoints) for the Production environment and the Sandbox environment. The service endpoint includes the service version (e.g., `v1`). When updating to a new major version of the service, you must update to a new service endpoint as well. * **The Business Policies Management API** uses eBay's Service Oriented Architecture (SOA) framework and requires that an eBay authorization token is passed in through either a header or a URL parameter. * **Schema and data type notes**—The Business Policies Management API does not share schema or data types with other eBay APIs. In the API, you will find the following difference from other eBay APIs: * XML namespace is versioned. To prevent type collisions associated with backward incompatible service changes, the XML namespace is versioned. As with the service endpoint, when updating to a new major version of the service, note that the XML namespace will change as well. * **Naming conventions**—The naming conventions for the Business Policies Management API are slightly different than the Trading API. Most notably, call names and fields in the Business Policies Management API begin with lowercase letters. * **Versioning scheme**—The version numbering scheme for the Business Policies Management API is different from the scheme used by the eBay Shopping and Trading APIs. The Business Policies Management API version consists of three digits (e.g., 1.2.3): * The first digit indicates the **major release version**. Major releases are not backward compatible. eBay supports the two most recent major versions of the service. The service endpoints and target namespace include the major version of the service. * The second digit indicates the **minor release version**. Minor releases consist of feature additions or behavior changes that are backward compatible. * The third digit indicates the **maintenance**, or **micro release version**. Maintenance releases are used to correct minor problems. Maintenance releases have minimal impact on the features or functionality of the API. These changes may or may not have associated schema changes. Supported Request and Response Formats -------------------------------------- The Business Policies Management API supports XML and SOAP request and response formats. The call response for SOAP requests is in SOAP format only. Call Structure -------------- Each Business Policies Management API call consists of the following elements: * **Service Endpoint**—Business Policies API requests are sent to the Sandbox endpoint for the Business Policies Management API. * **HTTP Headers or URL Parameters**—Each Business Policies Management API call requires an `X-EBAY-SOA-SECURITY-TOKEN` or `X-EBAY-SOA-SECURITY-IFATOKEN` header, or a `SECURITY-APPNAME` URL parameter. Similarly, you must always specify the call name in the `X-EBAY-SOA-OPERATION-NAME` header or `OPERATION-NAME` URL parameter. Other headers are optional or conditionally required. * **Standard Input Fields**—The **ExtensionType** field and its four child elements are the only standard input fields for calls in the Business Policies Management API. These fields are optional. * **Call-specific Fields**—The input fields that are specific to a particular API call. ### Service Endpoints **Production Endpoint:** `https://svcs.ebay.com/services/selling/v1/SellerProfilesManagementService` **Sandbox Endpoint:** `https://svcs.sandbox.ebay.com/services/selling/v1/SellerProfilesManagementService` **Note:** The service endpoint contains the major version for the service (e.g., `v1`). When updating to subsequent major releases, you must update the version in the service endpoint, as well. ### Standard URL Parameter or HTTP Header Values When you make a Business Policies Management API call, you choose whether to specify the standard values in URL parameters or in the HTTP header. URL parameters are provided as name-value pairs in the query part of the URI. **Note:** If you specify both a URL parameter and an HTTP header for the same value in the same call, the URL parameter takes precedence. The values you provide in your call are case-sensitive. The following table contains descriptions of the standard Business Policies Management API parameters and the corresponding header values: URL ParameterHeader ValueRequired?DescriptionN/AX-EBAY-SOA-CONTENT-TYPENoIf you use this header, you must specify the content format exactly as shown, or your call may fail. The allowable values are: | | | | --- | --- | | XML | text/xml | | SOAP12 | application/soap+xml | | SOAP11 | text/xml (together with SOAPAction header being sent - value can be anything) | X-EBAY-SOA-GLOBAL-IDX-EBAY-SOA-GLOBAL-IDYesThe unique identifier for a combination of site, language, and territory. For example, EBAY-US (the default) is the global ID that corresponds to the eBay US site. The global ID you specify must correspond to an eBay site with a valid site ID. Refer to [eBay Site ID to Global ID Mapping](https://developer.ebay.com/Devzone/business-policies/Concepts/SiteIDToGlobalID.html) . In addition, [Global ID Values](https://developer.ebay.com/Devzone/business-policies/CallRef/Enums/GlobalIdList.html) contains a complete list of the eBay global IDs.X-EBAY-SOA-MESSAGE-ENCODINGX-EBAY-SOA-MESSAGE-ENCODINGConditionallySpecifies the message encoding (e.g., ISO-8859-1). The default encoding is UTF-8. When submitting requests in any format other than UTF-8, you must specify the message encoding.N/AX-EBAY-SOA-MESSAGE-PROTOCOLConditionallyIf you make a SOAP request, you must use this header to specify the protocol you are using. Allowable values are "SOAP11" for SOAP Version 1.1 and "SOAP12" for SOAP Version 1.2.X-EBAY-SOA-SERVICE-NAMEX-EBAY-SOA-SERVICE-NAMENoThe name of the service you are using. Specify "SellerProfilesManagementService" for all Business Policies Management API calls.X-EBAY-SOA-OPERATION-NAMEX-EBAY-SOA-OPERATION-NAMEYesThe name of the call you are using (for example, **addSellerProfile** or **getSellerProfiles**).X-EBAY-SOA-REQUEST-DATA-FORMATX-EBAY-SOA-REQUEST-DATA-FORMATNoThe Business Policies Management API supports XML and SOAP request formats with the HTTP POST method. Input can be in XML or SOAP formats. The default value for HTTP POST requests is XML. For SOAP requests, you must specify the protocol version in the `X-EBAY-SOA-MESSAGE-PROTOCOL` header. If you use a URL for an HTTP GET request, REQUEST-DATA-FORMAT is unnecessary because the only valid value is NV (Name-Value Pair).X-EBAY-SOA-RESPONSE-DATA-FORMATX-EBAY-SOA-RESPONSE-DATA-FORMATNoIf you use a URL (HTTP GET) request, use this parameter to specify the output format as XML. URL requests do not support SOAP responses. If you use a URL, and you do not specify RESPONSE- DATA-FORMAT, the output format will be XML. If you use the HTTP POST method, the output data (response data) will be in the same format as the input data.REST-PAYLOADN/ANoIf you use a URL, use this parameter to separate the payload part of the URL from the standard headers. Requires no value; anything appearing after this header will be considered part of the call payload. This parameter is ignored in HTTP POST requests. X-EBAY-SOA-SECURITY-IAFTOKENX-EBAY-SOA-SECURITY-IAFTOKENConditionally_Required if_ you do not supply an **X-EBAY-SOA-SECURITY-TOKEN** header and value. This header supports the use of OAuth tokens for user authorization. To authorize the request, supply a valid User access token for the value to this header. For details on User access tokens, see [OAuth access tokens](https://developer.ebay.com/api-docs/static/oauth-tokens.html) X-EBAY-SOA-SECURITY-TOKENX-EBAY-SOA-SECURITY-TOKENConditionally_Required if_ you do not supply an **X-EBAY-SOA-SECURITY-IAFTOKEN** header and value. This header supports eBay Auth'n'Auth for user authorization. To authorize a request, pass a valid eBay Authorization token as the value to this header. For more on Authorization tokens, see [Getting Tokens](https://developer.ebay.com/devzone/guides/ebayfeatures/Basics/Tokens.html) .X-EBAY-SOA-SERVICE-VERSIONX-EBAY-SOA-SERVICE-VERSIONNoThe API version your application supports (e.g., 1.1.0). #### URL Parameter Examples If you are using a URL (and the HTTP GET method), input must be in the NV (Name-Value Pair) format. Use the `RESPONSE-DATA-FORMAT` header to specify that data is returned in one of the following formats: NV or XML. The following example (wrapped for readability) shows standard Business Policies Management API parameters. `RESPONSE-DATA-FORMAT` specifies XML for XML output. https://svcs.ebay.com/services/selling/v1/SellerProfilesManagementService   ?X-EBAY-SOA-OPERATION-NAME=getSellerProfiles   &X-EBAY-SOA-SERVICE-NAME=SellerProfilesManagementService   &X-EBAY-SOA-SERVICE-VERSION=1.0.0   &X-EBAY-SOA-SECURITY-TOKEN=__   **&X-EBAY-SOA-RESPONSE-DATA-FORMAT=XML**   &REST-PAYLOAD   &_Standard input fields_   &_Call-specific input fields_ #### HTTP Header Examples The following example shows standard Business Policies Management API headers for an HTTP POST call using XML: X-EBAY-SOA-SERVICE-NAME: SellerProfilesManagementService X-EBAY-SOA-OPERATION-NAME: getSellerProfiles X-EBAY-SOA-SERVICE-VERSION: 1.0.0 X-EBAY-SOA-SECURITY-TOKEN: __ **X-EBAY-SOA-REQUEST-DATA-FORMAT: XML** The following example shows standard Business Policies Management API headers for an HTTP POST call. In the example, the **`X-EBAY-SOA-REQUEST-DATA-FORMAT`** header specifies XML. The example also includes **`X-EBAY-SOA-MESSAGE-PROTOCOL: SOAP12`**, specifying that you are using SOAP Version 1.2. Without the **`X-EBAY-SOA-MESSAGE-PROTOCOL`** header, the service would expect XML input. X-EBAY-SOA-SERVICE-NAME: SellerProfilesManagementService X-EBAY-SOA-OPERATION-NAME: getSellerProfiles X-EBAY-SOA-SERVICE-VERSION: 1.0.0 X-EBAY-SOA-GLOBAL-ID: EBAY-US X-EBAY-SOA-SECURITY-TOKEN: __ X-EBAY-SOA-REQUEST-DATA-FORMAT: XML **X-EBAY-SOA-MESSAGE-PROTOCOL: SOAP12** ### Call-Specific Values Refer to the [Business Policies Management API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) for the input and output fields supported by the Business Policies Management API calls. Syntax ------ This section spells out the syntax requirements for the supported request and response formats. In most cases, the syntax for the various formats is standard and only the rules that aren't standard or are potentially tricky are explained. * [XML Syntax](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#xmlsyntax) * [SOAP Syntax](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#soapsyntax) ### UTF-8 Encoding for Special Characters All parameter values should be encoded in UTF-8 format. UTF-8 is the default encoding for API requests. Once the parameter value is UTF-8 encoded, it should be URL-encoded to take care of spaces and quotation marks (" ") and other characters in the string that are pertinent to the URL request. When submitting requests in any format other than UTF-8, you must specify the message encoding with the `MESSAGE-ENCODING` URL parameter or the `X-EBAY-SOA-MESSAGE-ENCODING HTTP` header. ### URL Encoding for String Values Name-value requests must be constructed using the ASCII character-set only. Most ASCII characters (e.g., the numbers from 0-9 and the uppercase and lowercase English letters from A to Z) can be used as is. Some special characters, however, such as spaces, ampersands ("`&`") and quotation marks, must be encoded in URL requests when used in string values for fields. Special characters that must be URL-encoded include (but are not limited to) characters used in URL request syntax, such as ampersands ("`&`"), the equals sign ("`=`"), the pound sign ("`#`"), the "at" symbol ("`@`"), or the percent sign ("`%`"). URL-encoded characters are in the form %HH, where HH is a hexadecimal number. For example, the URL-encoded value for an ampersand is `%26` and the URL-encoded value for a space is `%20`. The plus sign ("+") can also be used in place of spaces. Many languages provide functions or methods to do the URL encoding for you. For example, PHP provides the `rawurlencode` function and Java provides `URLEncoder` class. For more information about URL encoding, see [RFC 1738](http://www.rfc-editor.org/rfc/rfc1738.txt) . ### XML Syntax The XML request/response format follows standard XML syntax conventions. Please see [XML Syntax Rules on w3schools.com](https://www.w3schools.com/xmL/xml_syntax.asp) for more information. ### SOAP Syntax The SOAP request/response format follows standard SOAP syntax conventions. Please see [SOAP Syntax on w3schools.com](https://www.w3schools.com/SOAP/soap_syntax.asp) for more information. Schema Location --------------- You can download the latest version of the WSDL for the Business Policies Management API with the following link:     `[https://developer.ebay.com/webservices/business-policies/latest/SellerProfilesManagementService.wsdl](https://developer.ebay.com/webservices/business-policies/latest/SellerProfilesManagementService.wsdl)` Alternatively, you can access a particular version of the Business Policies Management schema using a URL with the following format (where VERSION is the version identifier of the release):    `https://developer.ebay.com/webservices/business-policies/VERSION/SellerProfilesManagementService.wsdl` The version identifier is the version number of a particular schema (a release number). For example, you can access version 1.0.0 of the WSDL version of the schema at the following URL:     `[https://developer.ebay.com/webservices/business-policies/1.0.0/SellerProfilesManagementService.wsdl](https://developer.ebay.com/webservices/business-policies/1.0.0/SellerProfilesManagementService.wsdl)` [Back to top](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html#top) * * * --- # Revise immediate payment requirement | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-pay-requirement.html#mainContent) When using [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) or [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) , the default value of the [Item.AutoPay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.AutoPay) flag is the value the seller used for the original listing. To determine whether or not a seller requested immediate payment for a particular listing, use [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) . The call returns the [Item.AutoPay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.AutoPay) flag with a value of `true` if immediate payment was specified. **Note:** The value of the [Item.AutoPay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.AutoPay) flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the [Item.AutoPay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.AutoPay) flag does not change. If immediate payment is specified and the seller attempts to list the item in a category that does not support this feature, eBay will return an error. The seller should choose an appropriate category or remove the immediate payment requirement. (Items in certain categories may be subject to additional standard rules with respect to category changes.) **Note:** If a listing does not specify immediate payment, a seller can add a requirement for immediate payment when revising the listing as long as all the conditions specified in [Require Immediate Payment](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/payment-immediate.html) are met. The usual rules for revising a listing must also be met (that is, the listing has no bids or purchases, and the listing does not end within 12 hours). Similarly, a seller can remove a request for immediate payment from an existing listing if the usual rules for revising an item are met. In this case, set [Item.AutoPay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.AutoPay) to false. However, the seller cannot modify the item's shipping costs. If immediate payment was originally specified for a Buy It Now listing and the Buy It Now option no longer applies (e.g., a bid was placed), eBay automatically removes the immediate payment requirement on behalf of the seller. However, eBay does not change the value of [Item.AutoPay](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.AutoPay) , so it will still be returned as `true` by a [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Condition differences across categories | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/condition-cross-category.html#mainContent) In general, each eBay top-level (L1) category defines its own default set of conditions (rather than inheriting from a marketplace default). Most L1 categories on a given marketplace will actually define the same default set of conditions, but some L1 categories define different default sets to meet buyer and seller expectations. Furthermore, within each L1 category, a significant number of child categories may use different sets of conditions than their parent categories. Call [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) to determine which conditions each category supports. For example, while the _Sporting Goods_ category on the eBay US marketplace might define a default set of conditions that most of its child categories will inherit, a child category such as _Running_ > _Shoes_ would use the same set of conditions as the _Clothing_, _Shoes & Accessories_ > _Shoes_ category instead. Similarly, the Books L1 category and child categories where items are typically CDs or DVDs (i.e., the _DVD & Movies_, _Music_, and _Video Games_ categories,) are considered "media categories" and they typically all define the same default set of conditions. But a child category like _Video Games_ > _Systems_ has items that are electronic devices, so it defines a different set of conditions (the same set as the Computers & Networking meta-category). Refer to [Condition Definitions](https://developer.ebay.com/api-docs/sell/static/metadata/condition-id-values.html) for complete information about supported Item Conditions. **Note:** Condition descriptions are not defined for categories that do not support item conditions. To see which eBay categories do not support item conditions, issue a [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) call with [FeatureID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Request.FeatureID) set to the string `ConditionEnabled`. For categories that do not support item conditions, the [Category.ConditionEnabled](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ConditionEnabled) value returned for those categories will be returned as `Disabled`. eBay defines 10-15 overall sets of conditions. Each marketplace may have a few hundred categories that use one of these sets instead of a meta-category's default set. The condition sets are determined based on testing with sellers and category experts, as well as research into what buyers expect. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Change the reserve price | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-reserve-price.html#mainContent) When relisting an item that includes a Reserve Price, the new [Item.ReservePrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.ReservePrice) value must be equal to or lower than the Reserve Price from the _original_ listing. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise and relist with variations | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/update-variations.html#mainContent) **Note:** If any variation within a listing has at least one purchase, the listing's _item_\-level data is subject to the usual revision restrictions for listings with purchases. Change the category ------------------- If you change the primary category of a listing with variations using [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) , the listing must adhere to all the rules (including item specifics rules) that apply to the new category. Otherwise, the listing request will fail. When the primary category changes, you may need to specify the [Item.Variations](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations) node again. As eBay's recommendations are different for each leaf category, we suggest that you give the seller the option to review and choose from recommended variation specifics for the new category. When you change the category, the relisted item does not retain the popularity of the original listing. Add variations -------------- To add new variations when you revise or relist, pass in the new [Item.Variations](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations) nodes. (You do not need to pass in all the original variations.) For example, if the listing already has variations for small-size blue, medium-size black, and large-size pink, you could add new variations for medium-size blue and large-size black. As a general rule, when you add a new variation, it appears at the _end_ of the list of variations in [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) . If you add new variation names or values in the new variations, be sure to also update existing variations as well as [Item.Variations.VariationSpecificsSet](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.VariationSpecificsSet) . Refer to [Modify existing variations](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/update-variations.html#mod-vars) . Adding a variation when relisting does not affect the sales rank or popularity of the other variations in the listing. Delete individual variations ---------------------------- If you want to delete a variation that has purchases, set the [Item.Variations.Variation.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.Variation.Quantity) to 0. You cannot fully delete a variation with purchases, because the order line item data needs to remain available to the buyer(s) and the seller. If a variation has no purchases, delete it by set the [Item.Variations.Variation.Delete](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.Variation.Delete) field to `true`. (**Do not** use [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.DeletedField) .) **Note:** [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.DeletedField) can only be used to delete a parent node or all instances of a child node (e.g., all instances of [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.PictureDetails.PictureURL) ). [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.DeletedField) cannot be used to delete a single variation. The listing must retain at least one variation with a non-zero quantity to remain active. Deleting a variation when relisting does not affect the sales rank or popularity of the other variations in the listing. Modify existing variations -------------------------- When you modify variations, they are subject to the same rules as any new listing with variations (i.e., every variation in the relisted item must have the same set of names and a unique combination of values). If [Item.InventoryTrackingMethod](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.InventoryTrackingMethod) is set to `SKU`, you cannot modify a variation's SKU when you revise or relist. ### Add variation-specific names To add new variation specifics to active listings, pass in the entire set of variation specifics in a single request, and include the new detail for all of them. For example, you could add Strap Length to a handbag listing, with varying values like Shoulder, Wrist, etc. ### Delete variation-specific names You can delete an existing variation specific name (e.g., _Material_,) from a variation by using [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) . The following example code deletes the variation specifics Size and Color from an item and adds variations with only Color. 1189 en\_US High 1\*\*\*\*\*\*\*\*\*\*7 true t\*\*\*\*\*\*\*\*\*\*\*\*\*2 5.68 10 Size L Color Black 00885631496220 true t\*\*\*\*\*\*\*\*\*\*\*\*\*2 3.39 12 Size S Color White 00885631496220 t\*\*\*\*\*\*\*\*\*\*\*\*\*2 5.68 7 Color Black 00885631496220 t\*\*\*\*\*\*\*\*\*\*\*\*\*2 3.39 12 Color White 00885631496220 Color Black https://i\*\*\*\*\*\*\*.com/\*\*\*/\*\*\*\*\*\*\*\*\*\*\*\*.JPG?set\_id=5\*\*\*\*F https://i\*\*\*\*\*\*\*.com/\*\*\*/\*\*\*\*\*\*\*\*\*\*.JPG?set\_id=C\*\*\*\*B https://i\*\*\*\*\*\*\*.com/\*\*\*/\*\*\*\*\*\*\*\*\*\*\*\*\*.JPG?set\_id=3\*\*\*\*\*\*0 Color Black Blue Violet Ceramic Grey Heather White ### Modify variation-specific names When you are revising a listing, you can change the name (e.g., from _Material_ to _Fabric_,) by using [Item.Variations.ModifyNameList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.ModifyNameList) . To change the name, specify the current name (e.g., _Material_,) in [Item.Variations.ModifyNameList.ModifyName.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.ModifyNameList.ModifyName.Name) , and the new name (e.g., _Fabric_,) in [Item.Variations.ModifyNameList.ModifyName.NewName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.ModifyNameList.ModifyName.NewName) . If you are modifying the values, also be sure to specify the new name and its modified values in [Item.Variations.VariationSpecificsSet](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.VariationSpecificsSet) , along with the names you are not changing. To ensure consistent results, also update [Items.Variations.Pictures.VariationSpecificName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.Pictures.VariationSpecificName) if any pictures are associated with the old name. **Note:** You cannot change the name of a required item specific. ### Modify variation values When you revise a listing, if you need to correct the spelling of a variation value, you first delete the variation, and then you add a new variation instead. For example, suppose you realize that a set of T-shirts that you listed with `Color=Blue` should use `Color=Periwinkle`. In this case, you would delete the variations with `Color=Blue` (or set their quantity to zero if they are not eligible for deletion,) and add new variations with `Color=Periwinkle` instead. When you relist, you are creating a new listing, so you can change the text of the names and values. Use the same process that you use when revising listings. The relisted item is subject to the same rules as any new listing with variations (i.e., every variation in the relisted item must have the same set of names and a unique combination of values). ### Modify a variation's price You can revise the price of a variation as long as the quantity is greater than zero (or if you increase the quantity to a non-zero value at the same time,) even after it has purchases. This enables you to adjust the price competitively and to offer discounts or sales as needed. To revise a variation's price, specify the variation to be changed in [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) , and include the revised price in [Item.Variations.Variation.StartPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.Variation.StartPrice) along with the other details of the variation. It is only necessary to specify the variation to be changed. Alternatively, if you use SKUs to track your listings, use [ReviseInventoryStatus](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseInventoryStatus.html) to quickly change the prices of variations across multiple listings. Specify the variation's SKU in [InventoryStatus.SKU](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html#Request.InventoryStatus.SKU) , and the variation's price in [InventoryStatus.StartPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html#Request.InventoryStatus.StartPrice) . ### Modify a variation's quantity when revising You can revise the quantity of a variation, even after it has purchases (order line items). To revise a variation's price, specify the variation to be changed in [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) , and include the revised quantity in [Item.Variations.Variation.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html#Request.Item.Variations.Variation.Quantity) along with the other details of the variation. It is only necessary to specify the variation to be changed. Alternatively, if you use SKUs to track your listings, use [ReviseInventoryStatus](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseInventoryStatus.html) to quickly change the quantities for variations across multiple listings. Specify the variation's SKU in [InventoryStatus.SKU](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html#Request.InventoryStatus.SKU) , and the variation's quantity in [InventoryStatus.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html#Request.InventoryStatus.Quantity) . If you change a variation's quantity but items from it have already sold, eBay adds the quantity sold to the new quantity you specify. In other words, suppose you list with [AddFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html) and set a variation's quantity to 10. A few days later, the quantity sold is 6. Now you increase your inventory and you use [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) to set the variation's available quantity to 20. In [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) , the variation's quantity is returned as 26 ([Item.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.Quantity) + [Item.SellingStatus.QuantitySold](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.QuantitySold) ). (This means the quantity available can still be calculated as [Item.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.Quantity) - [Item.SellingStatus.QuantitySold](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.QuantitySold) .) You can revise the quantity of any variation to zero (0), as long as at least one variation in the listing has a non-zero value. If you revise a variation's quantity to zero and the variation has never had purchases, eBay deletes the variation. If quantities of the variation have been sold, it cannot be deleted (but the quantity can be zero). Refer to [Delete individual variations](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/update-variations.html#delete-one-var) for other ways to delete a variation. If the variation sells out, and then you restock your inventory, you can revise the same variation to add more quantity, as long as the listing is still active. For example, suppose you list 50 medium blue Polo shirts in one variation and 50 medium red shirts in another. You sell all 50 medium blue shirts (so the quantity available is now zero), but the red shirts are still available. A week later, you get 20 more blue shirts in stock. You can revise the medium blue shirt variation and specify a new [Item.Variations.Variation.Quantity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.Variations.Variation.Quantity) of 20 as long as the listing is still active. ### Modify a variation's quantity when relisting When you use [RelistFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html) , each variation's quantity retains its original number (not the quantity available) unless you specifically change it. For example, suppose your listing includes a variation with 20 blue shirts. You sell 15, leaving 5 available. Then you end and relist the listing. By default, eBay assumes the quantity of the blue shirt variation should be set to 20 (the original quantity). Therefore, it's a good idea to set the correct quantity for each variation when you relist. Use the same process that you use for revising a variation's quantity (refer to [Modify a variation's quantity when revising](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/update-variations.html#mod-qty-revise) ). #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Create a second chance offer | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/second-chance-create.html#mainContent) Trading API calls can be used to: * Determine if an item is eligible to be offered as a Second Chance Offer, * Create the Second Chance Offer. The first step in extending a Second Chance Offer is to retrieve a list of all users who bid on the original listing by calling **GetAllBidders**. One of the call modes for **GetAllBidders** returns a list of all of the original listing's bidders along with the ID of the winning bidder (if there was one) and the amount of the winning bid. From this list, the seller can select a single user to whom the seller will extend the Second Chance Offer. Once a list of the original listing's bidders has been retrieved, the seller can extend a Second Chance Offer to one or more of those non-winning bidders. To do this, an application must use the **AddSecondChanceItem**. Execute **AddSecondChanceItem** once for each target recipient non-winning bidder to which the seller wishes to extend the Second Chance Offer. Identify the recipient user by specifying the eBay user ID in the **RecipientBidderUserID** property of the **AddSecondChanceItem** request. A call to **AddSecondChanceItem** fails with an error if the user specified in **RecipientBidderUserID** has already received a Second Chance Offer for the same item. Specify the item ID for the item's original listing in the **OriginalItemId** property. The application also passes a value in the **Duration** property that indicates how long (in days) the Second Chance Offer is to be available to the specified recipient user. If the user does not elect to purchase the item in that time, the Second Chance Offer expires. **Note:** The seller may also end the Second Chance Offer before this duration has expired. Refer to [Terminate an Offer](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/second-chance-terminate.html) for more information. The price in the Second Chance Offer can vary. If the original listing was an eBay Motors item and the auction ended without the reserve price met, the seller specifies the price in the **BuyItNowPrice** property of **AddSecondChanceItem**. The price that the seller specifies must be less than or equal to the reserve price used for the original listing. The same is true in some categories on U.S. and international marketplaces for high-priced items (such as items in many U.S. and Canada Business and Industrial categories). For all other items, the price is determined automatically by eBay and the application does not supply this value as input. It is the value of the highest bid that the specified offer recipient made on the item in the original listing. If that offer recipient declines to purchase the item and the seller makes another Second Chance Offer to a different non-winning bidder, then the price is based on that bidder's highest bid. A successful call creates a new Second Chance Offer listing for the item (which includes assigning a new item ID to the item) and sends an email to the non-winning bidder from the original listing to whom the seller wishes to extend the Second Chance Offer. The recipient user may then go to the Second Chance Offer listing on the eBay marketplace to purchase the item. The new Second Chance Offer listing is only available to the specified user. It does not appear in any search or listing page on the eBay marketplace where someone who did not participate in the original listing could view or bid on the item. **AddSecondChanceItem** returns data similar to that returned by **AddItem**, including fees for the new listing. In addition, **AddSecondChanceItem** returns values that are specific to Second Chance Offer items: * The item ID for the new offer listing (**ItemID**) * The user ID for the bidder to whom the Second Chance Offer was extended (**RecipientBidderUserID**) * The start and end times of the Second Chance Offer (**StartTime** and **EndTime**, respectively) * The fees for the new offer listing (**Fees**) Prior to using **AddSecondChanceItem** (which results in a new Second Chance Offer listing,) an application can test the input values and give the seller an idea of what the listing fees would be by using **VerifyAddSecondChanceItem**. The **VerifyAddSecondChanceItem** call acts in every way like **AddSecondChanceItem**, except that it does not actually create a new Second Chance Offer listing or incur any actual listing fees. **VerifyAddSecondChanceItem** is to **AddSecondChanceItem** what **VerifyAddItem** is to **AddItem**. Second Chance Offers may only be made to users who have enabled the preference indicating they will accept such offers (refer to the "Preferences" tab on the My eBay page). If the input for **AddSecondChanceItem** specifies a user who has this preference set to not receive offers, the call fails with error 974, "Bidder not eligible to receive a Second Chance Offer." (Verbose error string: "Unfortunately, the bidder has chosen not to receive Second Chance Offer emails.") #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Retrieve an eBay for Charity listing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/charitable-listings-retrieve.html#mainContent) Trading API calls that retrieve information about active and completed eBay for Charity listings include: * [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) * [GetItemTransactions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItemTransactions.html) * [GetOrderTransactions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetOrderTransactions.html) * [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) * [GetSellerTransactions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerTransactions.html) Nonprofit organization information returned by these calls includes: * [CharityName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/CharityType.html#CharityName) * [CharityID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/CharityType.html#CharityID) * [DonationPercent](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/CharityType.html#DonationPercent) For information about additional fields returned by these calls, refer to the reference documentation for [CharityType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/CharityType.html) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Product identifiers | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/item-specifics-product-ids.html#mainContent) Sellers are encouraged to supply product identifiers as item specifics whenever these identifiers are available for their products. Refer to [Structured Data - Product Identifiers](https://pages.ebay.com/sell/item_specifics/product_identifiers.html) for additional information. Valid types of product identifiers in the [Item.ItemSpecifics.NameValueList.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ItemSpecifics.NameValueList.Name) field are: * A _Global Trade Item Number_ (GTIN). GTINs are a set of globally recognized identifiers, including: * [EAN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.EAN) (European Article Number) * [ISBN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.ISBN) (International Standard Book Number) * `JAN` (Japanese Article Number — used only in Japan) * [UPC](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.UPC) (Universal Product Code) * [BrandMPN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN) which comprises the following fields: * [Item.ProductListingDetails.BrandMPN.Brand](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN.Brand) * [Item.ProductListingDetails.BrandMPN.MPN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN.MPN) For any [Item.ItemSpecifics.NameValueList.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ItemSpecifics.NameValueList.Name) , the [Item.ItemSpecifics.NameValueList.Value](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ItemSpecifics.NameValueList.Value) field must comply with the following guidelines to avoid an error condition: * The EAN must comply with the GTIN-13 standard. * The ISBN must comply with the ISBN-10 or ISBN-13 standard. * The JAN must comply with the GTIN-13 standard. * The UPC must comply with the GTIN-12 or UPC-A standard. * When identifying a product with [BrandMPN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN) : * [Item.ProductListingDetails.BrandMPN.Brand](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN.Brand) must be the actual name of the product's brand and cannot be any of the following: * Strings with only special characters (e.g., "`&*#@`") * Strings such as: * "`Brand new,`" * "`Made in China`" * "`See the description below`" * "`100% compatible with listed model`" One exception is when the product is not branded — its [Item.ItemSpecifics.NameValueList.Value](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ItemSpecifics.NameValueList.Value) can be `Unbranded`. * [Item.ProductListingDetails.BrandMPN.MPN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN.MPN) cannot contain only special characters (e.g. "`$amp;%^&`"). Multiple-variation listings --------------------------- For listings that have multiple variations: * Specify `GTIN` values in [Item.Variations.Variation.VariationSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.VariationSpecifics) * When identifying a variation with [BrandMPN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN) : * Set [Item.ItemSpecifics.NameValueList.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ItemSpecifics.NameValueList.Name) to `Brand` * Specify the actual brand name/value (e.g., Apple, Nike,) using [Item.ItemSpecifics.NameValueList.Value](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ItemSpecifics.NameValueList.Value) * Specify [MPN](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.ProductListingDetails.BrandMPN.MPN) values in the [Item.Variations.Variation.VariationSpecifics.NameValueList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.VariationSpecifics.NameValueList) container where: * [Item.Variations.Variation.VariationSpecifics.NameValueList.Name](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.VariationSpecifics.NameValueList.Name) is set to `MPN`. * [Item.Variations.Variation.VariationSpecifics.NameValueList.Value](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html#Request.Item.Variations.Variation.VariationSpecifics.NameValueList.Value) is the specific MPN for the specific item. For example, `DSC-RX100/B`, `ILCZVE10L/B`, `fcb-ex980sp`, etc. Refer to [Product identifiers](https://pages.ebay.com/seller-center/listing/listing-advanced-sellers.html) for additional information. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Release Notes - Product API Product API * [Features Guide](https://developer.ebay.com/DevZone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/product/CallRef/index.html) * [Tutorials](https://developer.ebay.com/DevZone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product/ReleaseNotes.html) Product API Release Notes ========================= You can find links to the Product API documentation in the top navigation bar. Information about the schema location is in the [Schema Location](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html#SchemaLocation) section of the "Making an API Call" topic. Are you just getting started with the [Product Services](http://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) ? The following describes how to join the eBay Developers Program: * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) -- an introduction to the eBay Product API * [eBay Developer Documentation Center](https://go.developer.ebay.com/api-documentation) * [eBay APIs - Quick Start](https://go.developer.ebay.com/quick-start-guide) | Version | Release Date | | | --- | --- | --- | | [1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0) | 2025-08-11 | | | [1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0) | 2025-03-31 | | | [1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0) | 2011-04-15 | | | [1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1) | 2010-04-14 | | | [1.3.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.0)
(initial release) | 2010-02-24 | | Version 1.6.0 ------------- [Index of Changed Calls - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-CC) [Schema Changes - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-SC) [Announcements - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-AN) [New Features - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-NF) [Changed Functionality - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-CF) [Documentation Changes and Errata - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-DC) For a current list of known issues, see [Site Status Updates](https://go.developer.ebay.com/api-status) and the [Knowledge Base](https://go.developer.ebay.com/knowledge-base) . ### Index of Changed Calls - 1.6.0 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1.6.0 Types that were only associated with the decommissioned calls were removed. See [Changed Functionality - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-CF) for list of decommissioned calls. ### Announcements - 1.6.0 #### Change Requests See the [Site Status Updates](https://go.developer.ebay.com/api-status) for bug fixes related to this release. ### New Features - 1.6.0 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-CF) . None for this release. ### Changed Functionality - 1.6.0 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### findCompatibilitiesBySpecification decommissioned The **findCompatibilitiesBySpecification** call has been decommissioned. Users are recommended to migrate to the [getCompatibilitiesBySpecification](https://developer.ebay.com/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilitiesBySpecification) method of the [Metadata API](https://developer.ebay.com/api-docs/sell/metadata/static/overview.html) as a replacement. ### Documentation Changes and Errata - 1.6.0 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-NF) and [Changed Functionality - 1.6.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.6.0-CF) . None for this release. [Back to top](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#top) Version 1.5.0 ------------- [Index of Changed Calls - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-CC) [Schema Changes - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-SC) [Announcements - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-AN) [New Features - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-NF) [Changed Functionality - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-CF) [Documentation Changes and Errata - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-DC) For a current list of known issues, see [API Call Limits page](https://go.developer.ebay.com/api-status) and the [Knowledge Base](https://go.developer.ebay.com/knowledge-base) . ### Index of Changed Calls - 1.5.0 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1.5.0 Types that were only associated with the decommissioned calls were removed. See [Changed Functionality - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-CF) for list of decommissioned calls. ### Announcements - 1.5.0 #### Change Requests See the [Site Status Updates](https://go.developer.ebay.com/api-status) for any site issues that may impact this API. ### New Features - 1.5.0 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-CF) . None for this release. ### Changed Functionality - 1.5.0 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. #### Calls Decommissioned The following calles were decommissioned: * addProducts * findProductsByCompatibility * getProductSubmissions ### Documentation Changes and Errata - 1.5.0 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-NF) and [Changed Functionality - 1.5.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.5.0-CF) . None for this release. Version 1.4.0 ------------- [Index of Changed Calls - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-CC) [Schema Changes - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-SC) [Announcements - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-AN) [New Features - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-NF) [Changed Functionality - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-CF) [Documentation Changes and Errata - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-DC) For a current list of known issues, see [API Call Limits page](https://go.developer.ebay.com/api-status) and the [Knowledge Base](https://go.developer.ebay.com/knowledge-base) . ### Index of Changed Calls - 1.4.0 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls * [addProducts](https://developer.ebay.com/DevZone/product/CallRef/addProducts.html) * [getProductSubmissions](https://developer.ebay.com/DevZone/product/CallRef/getProductSubmissions.html) #### Changed Calls No changed calls in this release. ### Schema Changes - 1.4.0 Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use. **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Call-APISchema.html#CodeLists) . | Name | Part of Schema | Type of Change | | --- | --- | --- | | `AddProductResponse` | Complex type | New | | `AddProductsRequest` | Complex type | New | | `AddProductsResponse` | Complex type | New | | `GetProductSubmissionsRequest` | Complex type | New | | `GetProductSubmissionsResponse` | Complex type | New | | `Media` | Complex type | New | | `MediaIdentifier` | Complex type | New | | `ProductSubmission` | Complex type | New | | `ProductSubmissionFilter` | Complex type | New | | `ProductSubmissionResult` | Complex type | New | | `ProductSubmissionStatus` | Complex type | New | | `SortOption` | Complex type | New | | `MediaType` | Enumerated type | New | | `OutputSelector` | Enumerated type | New | | `ProductSubmissionStatusCode` | Enumerated type | New | | `SortType` | Enumerated type | New | | | | | ### Announcements - 1.4.0 #### Change Requests See the [Site Status Updates](https://go.developer.ebay.com/api-status) for any site issues that may impact this API. ### New Features - 1.4.0 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-CF) . #### Product Creation **Note:** The ability for external users to add products to eBay catalogs has been disabled for many months. The related API calls, **addProducts** and **getProductSubmissions**, no longer provide value, so they have been removed from the documentation as of Wednesday, May 14, 2014. Two new operations, **addProducts** and **getProductSubmissions**, have been added to the Product API to enable the addition of new products to eBay catalogs for specific categories on the eBay US (global ID EBAY-US) and eBay UK (global ID EBAY-GB) sites. These added calls work in production and will also be supported in the Sandbox environment starting in September 2011. Use **[GetCategoryFeatures](http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html) ** in the Trading API to determine which categories support product creation. Use the [**getProductMetadataBulk**](https://developer.ebay.com/DevZone/product-metadata/CallRef/getProductMetadataBulk.html) call in the Product Metatadata API to determine which properties can be used to describe a product and which of those properties are required to add a product to the eBay catalog for the given category. The **getProductMetadataBulk** also provides constraints for the values associated with each property. ### Changed Functionality - 1.4.0 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1.4.0 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-NF) and [Changed Functionality - 1.4.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.4.0-CF) . None for this release. Version 1.3.1 ------------- [Index of Changed Calls - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-CC) [Schema Changes - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-SC) [Announcements - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-AN) [New Features - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-NF) [Changed Functionality - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-CF) [Documentation Changes and Errata - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-DC) For a current list of known issues, see [API Call Limits page](https://go.developer.ebay.com/api-status) and the [Knowledge Base](https://go.developer.ebay.com/knowledge-base) . ### Index of Changed Calls - 1.3.1 These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History. #### New Calls No new calls in this release. #### Changed Calls No changed calls in this release. ### Schema Changes - 1.3.1 Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use. **Enumeration note:** You need to use this release version or higher to retrieve new code list values that were added in this release. See [Code Lists](https://developer.ebay.com/DevZone/guides/features-guide/default.html#basics/Call-APISchema.html#CodeLists) . None for this release. ### Announcements - 1.3.1 #### Changes to Message Part Names Message part names in the WSDL have been renamed from "parameters" to "params" to correct a problem for .NET developers. This fix allows .NET users to add web references in Visual Studio without errors. #### Change Requests See the [Site Status Updates](https://go.developer.ebay.com/api-status) for any site issues that may impact this API. ### New Features - 1.3.1 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-CF) . None for this release. ### Changed Functionality - 1.3.1 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1.3.1 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-NF) and [Changed Functionality - 1.3.1](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.1-CF) . None for this release. Version 1.3.0 ------------- This is the first release of the eBay Product API. **Note:** Watch these release notes for changes. For a current list of known issues, see [API Call Limits page](https://go.developer.ebay.com/api-status) and the [Knowledge Base](https://go.developer.ebay.com/knowledge-base) . ### Index of Changed Calls - 1.3.0 These calls are included in the initial release of the eBay Product API. #### New Calls No new calls in this release. ### Schema Changes - 1.3.0 Monitor upcoming release notes for descriptions of purpose and use for new or modified schema. ### Announcements - 1.3.0 #### Change Requests See the [API Call Limits page](https://go.developer.ebay.com/api-status) for bug fixes related to this release. ### New Features - 1.3.0 This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls. For logical or functional changes to existing features and calls, including code list changes, see [Changed Functionality - 1.3.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.0-CF) . None for this release. ### Changed Functionality - 1.3.0 This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules. None for this release. ### Documentation Changes and Errata - 1.3.0 This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in [New Features - 1.3.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.0-NF) and [Changed Functionality - 1.3.0](https://developer.ebay.com/DevZone/product/ReleaseNotes.html#1.3.0-CF) . None for this release. --- # Edit a ConditionID | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/condition-ids-edit.html#mainContent) In most situations [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ConditionID) can be added to or modified for an existing listing by including it in a [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) call, a [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) call, or related calls If the return payload for a [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) call indicates that [Category.ConditionEnabled](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ConditionEnabled) is set to `Required` for a category, you can change the ID to more accurately describe the item, but you cannot remove [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ConditionID) from the listing when it is revised/relisted. Restricted-state listings ------------------------- If a listing is in a restricted state, the condition is subject to eBay's usual revision restrictions. If you attempt to add or change [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ConditionID) when a listing is in a restricted state, your request may fail. For example, if an auction has bids or ends within 12 hours, you cannot remove or change its condition. In this case, if there are fields that are still editable on the auction, you will be able to edit them even though [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ConditionID) is not present. Refer to [Item changes allowed during revisions](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-qualifications.html#permitted-changes) for typical rules about fields that can not be modified when an item is in a restricted state. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Picture hosting | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/picture-hosting.html#mainContent) Pictures that are to be included in a listing may be hosted in one of two ways: * **eBay Picture Service (EPS):** Stores uploaded image files on an eBay server. * **Self-hosting:** Image files are stored on a server outside of eBay. The following sections provide information about each of these hosting options. eBay Picture Services (EPS) --------------------------- When using image processing editors or utilities to prepare pictures to be uploaded (e.g., to crop, rotate, or color correct your images,) avoid using the **Save for the Web** command or other picture-saving options in the program. These commands often result in reduced image quality after the uploaded pictures are processed by EPS. Instead, use the standard **Save** command with your image-processing tools. Images that are uploaded to EPS must be in one of the following supported graphic formats: * AVIF * BMP * GIF * HEIC * JPG * PNG * TIF * WEBP **Note:** All non-JPG format files are converted to JPG format at the time they are uploaded. Depending on the [PictureSet](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/UploadSiteHostedPictures.html#Request.PictureSet) value supplied, the largest size picture that is stored is 1600 x 1600 pixels. The image may be scaled down to that maximum size if it is larger. Otherwise EPS will store a copy that is the same size as the original image. Additionally, for each picture uploaded to EPS, a copy of the picture is created, appropriately resized, and stored for use on the View Item page, Search Results page, and other locations (e.g., My eBay.) ### Upload files to EPS The [UploadSiteHostedPictures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/UploadSiteHostedPictures.html) call enables sellers to upload image files one-at-a-time to EPS by including a binary attachment or a reference to a picture on a web server. You do not need to use this call to upload self-hosted images before creating the listing. Up to 24 self-hosted URLs can be specified at once in [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PictureDetails.PictureURL) for [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) or [AddFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html) calls. However, you must call [UploadSiteHostedPictures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/UploadSiteHostedPictures.html) to upload binary attachments. The call returns the URL of the stored image in [SiteHostedPictureDetails.FullURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/UploadSiteHostedPictures.html#Response.SiteHostedPictureDetails.FullURL) . You then provide this URL as the value for the [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.PictureDetails.PictureURL) field in a listing call. Refer to [Associate pictures with a listing](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/associate-pictures.html) for more information. [UploadSiteHostedPictures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/UploadSiteHostedPictures.html) includes support for watermarks and returns specific error messages for problems with uploading photos. For additional information, refer to: * [UploadSiteHostedPictures](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/UploadSiteHostedPictures.html) reference documentation * [FAQs on eBayPictureServices (EPS) and the UploadSiteHostedPictures API call](https://developer.ebay.com/support/kb-article?KBid=1063) * [JAVA UploadSiteHostedPictures sample in Apache HttpClient library](https://developer.ebay.com/support/kb-article?KBid=1050) Self-hosted pictures -------------------- When a listing includes self-hosted pictures (except for a multiple-variation listing,) the pictures are automatically copied to the eBay Picture Services (EPS) for use on the **Search Results** page and the **View Item** page. **Important!** eBay requires that all platforms used for the self-hosting of pictures be **HTTPS compliant**. Failure to be compliant will cause Add/Revise/Relist calls to fail. For additional information, refer to [Making your listings more secure](https://www.ebay.com/help/selling/listings/making-listings-secure?id=4363) . The URLs for both the self-hosted and EPS pictures are returned by the [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Output) call in the following fields: * Self-hosted URL: [Item.PictureDetails.ExtendedPictureDetails.PictureURLs.ExternalPictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.PictureDetails.ExtendedPictureDetails.PictureURLs.ExternalPictureURL) * EPS URL: [Item.PictureDetails.ExtendedPictureDetails.PictureURLs.eBayPictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.PictureDetails.ExtendedPictureDetails.PictureURLs.eBayPictureURL) When calling [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) or [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) , new self-hosted URLs may be provided in the **Item.PictureDetails.PictureURL** field. **Note:** Pictures in an active listing can be changed using the [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) call only if _at least 12 hours remain_ in the listing AND _there have been no bids_. ### CMYK images Images using the CMYK color space are **not** allowed. When creating a listing that includes self-hosted CMYK pictures, no error message will be generated, however those images will not be shown in the listing. One way to identify images using the CMYK model is by using the `identify` command of the [Image Magick](http://www.imagemagick.org/) Package. For example: $ identify -format '%\[colorspace\]' image.jpg Images can easily be converted from CMYK to RGB using tools such as PhotoShop or the [cmyk2rgb.com](http://www.cmyk2rgb.com/) online conversion tool. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # GetMyeBaySelling | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/my-ebay-selling.html#mainContent) The [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBaySelling.html) request is similar to the **GetMyeBayBuying** request: values in the request can be provided to customize the return list. A sample [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBaySelling.html) request to return active listings is illustrated below: ABC...123 TimeLeft 10 1 The following example shows how `Item` nodes appear under the `ActiveList` container of the [GetMyeBaySelling](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBaySelling.html) response. 9\*\*\*\*\*\*\*\*3 2.89 0.0 2023-07-21T18:41:04.000Z Chinese 1 0.0 2.89 11.0 true 11.0 PT28M17S Test Auction Title 1 ... more Item nodes ... 1147 3440 #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Promoted Listings priority strategy campaign flow | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#mainContent) There are two primary ways to create priority strategy campaigns, each of which provide different flows and methods for configuring the campaign. * **Manual targeting campaigns** offer sellers complete control over campaign setup and ongoing optimization. * **Smart targeting campaigns** offer easy setup and automatically update to optimize campaign settings. The following diagram illustrates the creation flow for priority campaigns using the Cost Per Click (CPC) funding model: ![](https://developer.ebay.com/api-docs/res/Resources/images/marketing/pla-creation-flow.png) **Note:** Once your campaign has launched, you cannot switch the targeting type from smart targeting to manual targeting, or vice versa. **Important!** The priority strategy program is only available to a select group of authorized eBay developers. Use the [getAdvertisingEligibility](https://developer.ebay.com/api-docs/sell/account/resources/advertising_eligibility/methods/getAdvertisingEligibility) method of the [Account API v1](https://developer.ebay.com/api-docs/sell/account/overview.html) to check eligibility for this program. Manual targeting campaigns -------------------------- Manual targeting campaigns give sellers control over campaign setup for ads that appear across eBay, allowing them to manually create and manage all aspects of their campaign. With manual targeting, sellers sort listings into ad groups, allowing them to target buyers with focused keywords and improve the visibility of their listings. Manual targeting campaigns use key-based campaign criterion. **Key-based campaigns** use ID values and ad groups to select the listings to include in a campaign. You can add listings to a campaign one at a time or in bulk using: * **Listing ID** values, which are created by the Trading API or Inventory API when you list an item. Use the [createAdByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId) and/or [bulkCreateAdsByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByInventoryReference) methods to add listings to a campaign using these values. * **Ad groups**, which are created to gather listings and specify keywords that are used to search for and view the listings that you want to promote. Ad groups can be created using the [createAdGroup](https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/createAdGroup) method. **Tip:** See the [Campaign recommendations and suggestions](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#recommendations) section for details about how to retrieve recommendations on listings, keyword bids, keywords, and other useful data that can be helpful when configuring your Promoted Listings campaign. ### Campaign setup Manual targeting PLA campaigns offer two types campaign setup: * [Manual setup](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#manual-setup) allows sellers to fully create and control their campaign. Sellers are able to add listings to ad groups, add keywords, and set keyword bids. * [Quick setup](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#quick-setup) allows sellers to expedite the creation of a manual targeting campaign. Sellers only need to provide basic campaign information, such as the name, start and end dates, budget, and associated listings, and eBay will create ad groups, keywords, and keyword bids for the campaign. #### Manual setup Manual setup gives sellers complete control over the creation of their campaign through the [createCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign) method. Sellers are able to manually add listings to ad groups, create keywords, and set keyword bids to help their listings reach their intended audience. The following diagram illustrates the creation flow for manual targeting campaigns using manual setup: ![](https://developer.ebay.com/api-docs/res/Resources/images/marketing/create-campaign-using-ids-cpc.png) When creating a manual targeting campaign using manual setup, you will complete the following steps to create and configure the campaign: 1. [Create the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#pla-create-campaign) 2. [Create an ad group for the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#pla-adgroup) 3. [Create ads for the camping using listing IDs](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#pla-listing-ids) 4. [Create keywords for the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#pla-create-keywords) 5. [Create negative keywords for the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#pla-create-negative-keywords) ##### Create the campaign Submit a call to the [createCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign) method and configure the following required fields: * **marketplaceId** – The eBay marketplace for which the campaign will run. * **campaignName** – The seller-defined name given to the campaign. * **fundingStrategy** – The funding strategies used for the campaign. The **fundingStrategy** defines the mechanism used to calculate the Promoted Listing fee (see the [Promoted Listings overview](https://developer.ebay.com/api-docs/sell/static/marketing/pl-overview.html) for details). * **fundingModel** - The funding model for the campaign. For a manual targeting campaign, this enum must be set to `COST_PER_CLICK`. * **biddingStrategy** - \[optional\] Determines how keyword bids are managed for the duration of the campaign. A `DYNAMIC` bidding strategy automatically updates keyword bids, and a `FIXED` bidding strategy means keyword bids will be managed manually. * **budget** – The allocated daily budget amount for a campaign. * **startDate** – The day on which the campaign will begin. Here is the example request payload that shows how to create a manual targeting campaign:  { "**marketplaceId**": "EBAY\_US", "**campaignName**": "W\*\*\*\*\*\*\*\*\*\*\*n", "**fundingStrategy**": { "fundingModel": "COST\_PER\_CLICK", "biddingStrategy": "DYNAMIC" }, "**budget**": { "daily": { "amount": { "currency": "USD", "value": "100.00" } } }, "**startDate**": "2019-06-30T19:00:00Z", "endDate": "2019-07-30T19:00:00Z" } When you create a campaign, the URI to the newly created campaign is returned in the **Location** response header. This response includes the campaign ID value that is used to create ads and add them to the Promoted Listings campaign (see the sections below for details). ##### Create an ad group for the campaign After creating a manual targeting campaign using manual setup, you must create an ad group for listings that you want included in the campaign. Ad groups are used to gather listings and keywords. To create an ad group for a campaign, specify the **defaultBid** for the ad group in the payload of the [createAdGroup](https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/createAdGroup) request, and specify the campaign to which the ad group should be associated using the **campaign\_id** path parameter. The default bid amount applies to all of the keywords in an ad group that do not have individual bids specified (see the [Create keywords](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#create-keywords) section for details). **Tip:** You can retrieve the campaign IDs for a specified seller using the [getCampaigns](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns) method. **POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_id}/ad\_group** { /\* CreateAdGroupRequest \*/ "defaultBid" : { /\*Amount\*/ "currency" : "CurrencyCodeEnum : \[AED,AFN,ALL...\]", "value" : "string" }, "name" : "string" } When you create an ad group, the URI to the newly created ad group is returned in the **Location** response header. This response includes the ad group ID value that is used to create ads and add them to the Promoted Listings campaign (see the sections below for details). Each ad group can be associated with only one Promoted Listings campaign. Listings can be included across ad groups and can be in multiple active campaigns. ##### Create ads for the campaign using listing IDs After creating a campaign, you can create ads for the listings you want included in the campaign by calling either the [createAdByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId) method (to add individual listing IDs) or the [bulkCreateAdsByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByListingId) method (to specify up to 500 listings per call). Specify the campaign to which the listings should be added using the **campaign\_id** path parameter. You must also specify the **adGroupId** at this time. **Tip:** You can retrieve the campaign IDs for a specified seller using the [getCampaigns](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns) method. **POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_Id}/bulk\_create\_ads\_by\_listing\_id** { "requests": \[\ {\ "**adGroupId**": "{adGroupId}",\ "**listingId**": "{listingId}"\ },\ {\ "**adGroupId**": "{adGroupId}",\ "**listingId**": "{listingId}"\ }\ \] } ##### Create keywords for the campaign After creating an ad group for the campaign, you can create keywords that you want included in the ad group by calling the [createKeyword](https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/createKeyword) method (to create one keyword) or the [bulkCreateKeyword](https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/bulkCreateKeyword) method (to create multiple keywords) to add the keyword(s) to the ad group. Specify the campaign and ad group to which the keyword(s) should be added using the **campaign\_id** path parameter and the **adGroupId** field. Optionally, sellers can specify the _bid amount_ for each keyword at this time (the maximum amount they are willing to pay per click), as well as whether to employ a `FIXED` or `DYNAMIC` bidding strategy when specifying bid amounts. * When using a `FIXED` bidding strategy, sellers manually assign and adjust keyword bids for the campaign. * When using a `DYNAMIC` bidding strategy, eBay manages the campaign's keyword bids and automatically updates them daily to the suggested bid. The amount you will be charged for each click is based on a _second price auction._ If you win the auction, your ad may appear in an eligible ad slot, and you will be charged an amount between the next highest bid and your bid amount. You will not be charged more than your bid amount. If no bid amount is specified, the **defaultBid** amount defined for the ad group will apply. Consider the keyword text carefully. When users search for items using the keywords that you have created, your Promoted Listings campaign ads will be considered for display. Keywords are currently targeted using either _exact match_ (with variants), _phrase match_, or _broad match_. **POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_id}/keyword** { /\* CreateKeywordRequest "adGroupId" : "string", "bid" : { /\*Amount\*/ "currency" : "CurrencyCodeEnum : \[AED,AFN,ALL...\]", "value" : "string" }, "keywordText" : "string", "matchType" : "MatchTypeEnum : \[EXACT, PHRASE, BROAD\]" } ###### matchType targets As mentioned above for keywords, **matchType** will support exact, phrase, and broad matching: * `EXACT`: Exact match definition and examples can be found [here](https://www.ebay.com/help/selling/listings/listing-tips/promoted-listings-advanced?id=5299#Match:~:text=Exact%20match%20allows%20your%20listing%20to%20appear%20for%20search%20terms%20that%20match%20your%20keywords%20character%2Dfor%2Dcharacter%20with%20slight%20variations%20like%20misspellings%2C%20capitalization%2C%20and%20abbreviations.) . * `PHRASE`: Phrase match definition and examples can be found [here](https://www.ebay.com/help/selling/listings/listing-tips/promoted-listings-advanced?id=5299#Match:~:text=Phrase%20match%20allows%20your%20listings%20to%20appear%20for%20search%20terms%20that%20include%20your%20exact%20keyword%20and%20may%20include%20other%20words%20before%20and/or%20after%20your%20keyword.) . * `BROAD`: Broad match definition and examples can be found [here](https://www.ebay.com/help/selling/listings/listing-tips/promoted-listings-advanced?id=5299#Match:~:text=Broad%20match%20allows%20your%20listings%20to%20appear%20for%20search%20terms%20that%20include%20your%20exact%20keyword%20terms%2C%20even%20if%20there%20are%20other%20words%20before%2C%20between%2C%20and/or%20after%20your%20keyword.) . **_Request example_** { "keywordText": "Sony F1.8 85mm", "matchType": "BROAD", "adGroupId": "5000395516", "bid": { "value": "0.66", "currency": "USD" } } ##### Create negative keywords for the campaign After creating an ad group for the campaign, you can create negative keywords that you want included in the ad group by calling the [createNegativeKeyword](https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/createNegativeKeyword) method (to create one negative keyword) or the [bulkCreateNegativeKeyword](https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/bulkCreateNegativeKeyword) method (to create multiple negative keywords) to add the negative keyword(s) to the ad group. Negative keywords are used to specify the search criterion that should not trigger listings in an ad group, which helps prevent your campaigns from surfacing unnecessarily when buyers run keyword searches that do not apply to your listings. Specify the campaign and ad group to which the negative keyword(s) should be added using the **campaignId** and the **adGroupId** request fields, and input the text for the negative keyword using the **negativeKeywordText** field. **Note:** Broad and phrase matching of negative keywords is not currently supported. Negative keywords are currently only supported for _exact match_. **POST https://api.ebay.com/sell/marketing/v1/negative\_keyword** { /\* CreateNegativeKeywordRequest \*/ "adGroupId": "string", "campaignId": "string", "negativeKeywordMatchType": "NegativeKeywordMatchTypeEnum: \[EXACT\]", "negativeKeywordText": "string" } #### Quick Setup **Note:** The [setupQuickCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/setupQuickCampaign) and [launchCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/launchCampaign) methods have been deprecated and will be decommissioned on March 31st, 2026. Quick setup is a way to easily create a priority strategy campaign. With quick setup, a seller sets their daily budget, chooses start and end dates, selects listings, and then eBay handles the rest of the campaign setup. Once listings are sorted into ad groups, eBay selects keywords, keyword match types, and initial competitive keyword bids that we calculate will perform well. When using quick setup, a seller can review and edit campaign details before launch. The following diagram illustrates the creation flow for manual targeting campaigns using quick setup: ![](https://developer.ebay.com/api-docs/res/Resources/images/marketing/quick-setup-campaign-flow.png) When creating a manual targeting campaign using quick setup, you will complete the following steps to create and configure the campaign: 1. [Create a quick setup campaign draft](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#quick-create) 2. [Launch quick setup campaign draft](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#quick-launch) ##### Create a quick setup campaign draft With a successful [setupQuickCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/setupQuickCampaign) Marketing API method call, the **campaignId** as well as the [getCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaign) URI used to retrieve the newly-created campaign draft are returned in the response header. Sellers can optionally use this **campaignId** to call the [getAdGroups](https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/getAdGroups) , [getAds](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAds) , and [getKeywords](https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/getKeywords) endpoints, and review the campaign structure before launching the campaign. These endpoints can be found in the [Marketing API resources](https://developer.ebay.com/api-docs/sell/marketing/resources/methods) . The **listingIds** are sent in the initial request payload to [setupQuickCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/setupQuickCampaign) as part of the campaign creation step. This is different from the **createCampaign** method, where sellers create an empty structure and then add **listingIds** to the ad groups after setup. **Note:** The maximum number of listings that can be added to a campaign is 1,000 **listingIds**. Request Payload code example **POST: https://api.ebay.com/sell/marketing/v1/ad\_campaign/setup\_quick\_campaign** { "campaignName": "Spring Sale", "startDate": "2023-07-14T19:46:01.000Z", "endDate": "2023-09-07T01:02:35.000Z", "marketplaceId": "EBAY\_US", "budget": { "daily": { "amount": { "value": "5.0", "currency": "USD" } } }, "listingIDs": \[\ "2\*\*\*\*\*\*\*\*1"\ \] } ##### Launch quick setup campaign draft To launch the draft campaign, call the above [launchCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/launchCampaign) endpoint, using the **campaignID** returned in the response header. No additional payload parameters are required. POST: https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_id}/launch ### Campaign recommendations and suggestions The eBay APIs allow you to retrieve recommendations and suggestions that you can use to configure your campaigns, such as listings, ad rates, ad groups, and keywords, and it outlines the system limitations for creating campaigns:  * The [suggestItems](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/suggestItems) method allows sellers to retrieve ideas for listings that can be targeted for Promoted Listings campaigns. The recommendations provided by this method indicate listings that have a high chance of favorable performance based on historical data. * The [suggestKeywords](https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestKeywords) method allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns. * The [suggestBids](https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestBids) method allows sellers to retrieve the suggested bids for input keywords and match type. Smart targeting campaigns ------------------------- Smart targeting campaigns simplify the campaign creation process for sellers, making it easier for them to get their products in front of interested buyers without needing to fully manage and optimize the details of their advertising campaign. Sellers simply specify the listings they would like to promote, and eBay automatically optimizes their ad campaign settings and handles the bidding and targeting process for them. **Note:** Smart targeting campaigns are only available for onsite CPC campaigns and are limited to 3,000 listings per campaign Smart targeting campaigns use key-based campaign criterion. **Key-based campaigns** use ID values to select the listings to include in a campaign. You can add listings to a campaign one at a time or in bulk using **Listing ID** values, which are created by the Trading API or Inventory API when you list an item. Use the [createAdByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId) and/or [bulkCreateAdsByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByInventoryReference) methods to add listings to a campaign using these values. The following diagram illustrates the creation flow for smart targeting campaigns using the Cost Per Click (CPC) funding model: ![](https://developer.ebay.com/api-docs/res/Resources/images/marketing/smart-targeting-campaign-creation.png) When creating a smart targeting campaign, you will complete the following steps to create and configure the campaign:  1. [Create the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#create-smart-campaign) 2. [Add listings to the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pla.html#smart-add-listings) ### Create the campaign To create a smart targeting campaign, submit a call to the [createCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign) method and configure the following required fields: * **marketplaceId** – The eBay marketplace for which the campaign will run. * **campaignName** – The seller-defined name given to the campaign. * **campaignTargetingType** - The targeting type for the campaign. For Smart targeting campaigns, this field **must** be set to `SMART`. * **fundingStrategy** – The funding strategies used for the campaign. The **fundingStrategy** defines the mechanism used to calculate the Promoted Listing fee (see the [Promoted Listings overview](https://developer.ebay.com/api-docs/sell/static/marketing/pl-overview.html) for details). * **bidPreferences** - The bidding preferences of the campaign, such as the maximum cost-per-click amount. * **maxCpc** - The maximum amount for which the eBay suggested bid can be adjusted. * **budget** – The allocated daily budget amount for priority campaigns. * **startDate** – The day on which the campaign will begin. Here is an example request payload that shows how to create a smart targeting campaign: { "**campaignName**": "Fall Sale", "**startDate**": "2023-10-05T13:42:18.094Z", "endDate": "2023-10-07T13:42:18.094Z", "**fundingStrategy**": { "fundingModel": "COST\_PER\_CLICK", "bidPreferences": \[{\ "maxCpc": {\ "amount": {\ "value": 0.5,\ "currency": "USD"\ }\ }\ }\] }, "**campaignTargetingType**": "SMART", "**marketplaceId**": "EBAY-US", "**budget**": { "daily": { "amount": { "value": 10, "currency": "USD" } } } } #### Maximum cost-per-click In smart targeting campaigns, sellers have the option to set a maximum cost-per-click through the **maxCpc** field, which limits the bids eBay places on their behalf. The **maxCpc** is the maximum the seller would be willing to pay for each click on their ad; the cost-per-click will never exceed this amount. Before creating a smart targeting campaign, sellers can use the [suggestMaxCpc](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/suggestMaxCpc) method of the [Marketing API](https://developer.ebay.com/api-docs/sell/marketing/overview.html) to retrieve the suggested **maxCpc** value for the campaign based on the listings they plan to include. This value can be updated for an existing smart targeting campaign using the [updateBiddingStrategy](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/updateBiddingStrategy) method. ### Add listings to the campaign Smart targeting allows for sellers to add listings to their campaign using key-based listing selection. Key-based listing selection allows sellers to select individual listings and adjust them manually as needed. After creating a campaign, you can create ads for the listings you want included in the campaign by calling either the [createAdByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId) method (to add individual listing IDs) or the [bulkCreateAdsByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByListingId) method (to specify up to 500 listings per call). Specify the campaign to which the listings should be added using the **campaign\_id** path parameter. **Note:** The **adGroupId** field is not required for smart targeting campaigns. **Tip:** You can retreive the campaign IDs for a specified seller using the [getCampaigns](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns) method. Below is a sample request payload for adding listing IDs to a smart targeting campaign in bulk:  POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_Id}/bulk\_create\_ads\_by\_listing\_id { "requests": \[\ {\ "**listingId**": "{listingId}"\ },\ {\ "**listingId**": "{listingId}"\ }\ \] } #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Enumeration Index - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) Enumeration Index ================= This is a list of all enumeration values in the schema. The same enumeration value name may be used by several calls. A - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byApplication | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorCategory.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | AUD | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | B - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byBUYER\_REQUIREMENTS | | | | --- | --- | | [ProfileType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ProfileType.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | C - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byCAD | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | CHF | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | CNY | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | Complete | | | | --- | --- | | [ConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/types/ConsolidationJobStatus.html) | [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) | D - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   | Enum name | Code list(s) with this enum value | Used by | | --- | --- | --- | E - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byError | | | | --- | --- | | [ErrorSeverity](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorSeverity.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | EUR | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | F - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byFailed | | | | --- | --- | | [ConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/types/ConsolidationJobStatus.html) | [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) | Failure | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/business-policies/CallRef/types/AckValue.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | G - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byGBP | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | H - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byHKD | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | I - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byINR | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | M - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byMYR | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | O - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   | Enum name | Code list(s) with this enum value | Used by | | --- | --- | --- | P - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byPartialFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/business-policies/CallRef/types/AckValue.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | PAYMENT | | | | --- | --- | | [ProfileType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ProfileType.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | PHP | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | PLN | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | R - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byRequest | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorCategory.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | RETURN\_POLICY | | | | --- | --- | | [ProfileType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ProfileType.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | Running | | | | --- | --- | | [ConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/types/ConsolidationJobStatus.html) | [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) | S - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed bySEK | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | SGD | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | SHIPPING | | | | --- | --- | | [ProfileType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ProfileType.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | ShippingProfilesConsolidation | | | | --- | --- | | [ConsolidationJobType](https://developer.ebay.com/devzone/business-policies/CallRef/types/ConsolidationJobType.html) | [consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html) | Success | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/business-policies/CallRef/types/AckValue.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | System | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorCategory.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | T - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byTWD | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | U - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byUSD | | | | --- | --- | | [IsoCurrencyCode](https://developer.ebay.com/devzone/business-policies/CallRef/types/IsoCurrencyCode.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | W - [A](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#A)   [B](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#B)   [C](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#C)   [D](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#F)   [G](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#G)   [H](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#H)   [I](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#I)   [M](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#M)   [O](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#O)   [P](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#S)   [T](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#T)   [U](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#U)   [W](https://developer.ebay.com/devzone/business-policies/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byWarning | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/business-policies/CallRef/types/AckValue.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | | [ErrorSeverity](https://developer.ebay.com/devzone/business-policies/CallRef/types/ErrorSeverity.html) | [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html)

[consolidateShippingProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/consolidateShippingProfiles.html)

[getConsolidationJobStatus](https://developer.ebay.com/devzone/business-policies/CallRef/getConsolidationJobStatus.html)

[getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html)

[getVersion](https://developer.ebay.com/devzone/business-policies/CallRef/getVersion.html)

[removeOverrides](https://developer.ebay.com/devzone/business-policies/CallRef/removeOverrides.html)

[removeProfile](https://developer.ebay.com/devzone/business-policies/CallRef/removeProfile.html)

[removeSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/removeSellerProfiles.html)

[setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) | --- # Fees for listing with zero quantity | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/out-of-stock-fees.html#mainContent) When a listing using the Out-of-Stock feature has zero quantity, listing fees are refunded if the listing remains in the Out-of-Stock state for an entire billing month. If a listing remains out of stock for _three consecutive billing months_, the listing is ended by eBay. **Note:** For multiple-variation listings, when each individual item in a multiple-variation listing has zero quantity, the entire listing is considered to be in the _Out-of-Stock_ state. Refer to the following table for additional information about how fees are applied or refunded. **Listing Fees for Out-Of-Stock Applications** | Billing Period

(Consecutive Periods) | Is Item Out-of-Stock for the Entire Billing Month? | Fee and Refunds | | --- | --- | --- | | 1 | Yes | **Fees:** Charged at the beginning of the period

**Refunds:** Listing fees refunded at the end of the period. | | 2 | Yes | **Fees:** Charged at the beginning of the period

**Refunds:** Listing fees refunded at the end of the period. | | 3 | Yes | **Fees:** Charged at the beginning of the period

**Refunds:** Listing fees refunded at the end of the period.

**eBay ends the listing** | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Fees by marketplace | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/fees-by-marketplace.html#mainContent) The following table provides links to the Selling Fees overview page for all eBay marketplacess that support eBay APIs. Generally, the Selling Fees overview page discusses insertion fees, final value fees, listing upgrade fees, and supplemental service fees, but this may vary by marketplace. | eBay Marketplace (SiteID value) | Fee Information | | --- | --- | | Austria (14) | [Gebühren für private Verkäufer](https://www.ebay.at/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Australia (15) | [Selling fees without an eBay Store](https://www.ebay.com.au/help/selling/fees-credits-invoices/selling-fees?id=4822) | | Belgium (French language) (23) | [Frais pour les vendeurs particuliers](https://www.befr.ebay.be/help/selling/fees-credits-invoices/frais-pour-les-vendeurs-particuliers?id=4822) | | Belgium (Dutch language) (123) | [Kosten voor particuliere verkopers](https://www.benl.ebay.be/help/selling/fees-credits-invoices/kosten-voor-particuliere-verkopers?id=4822) | | Canada (English language) (2) | [Selling fees](https://www.ebay.ca/help/selling/fees-credits-invoices/selling-fees?id=4822) | | Canada (French language) (210) | [Frais de mise en vente](https://www.cafr.ebay.ca/help/selling/fees-credits-invoices/selling-fees?id=4822) | | Switzerland (193) | [Gebühren für private Verkäufer](https://www.ebay.ch/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Germany (77) | [Gebühren für private Verkäufer](https://www.ebay.de/verkaeuferportal/verkaufen-bei-ebay/gebuehren-privat) | | Spain (186) | [Comisiones y tarifas para vendedores particulares](https://www.ebay.es/help/selling/fees-credits-invoices/selling-fees?id=4822) | | France (71) | [Frais pour les vendeurs particuliers](https://www.ebay.fr/help/selling/fees-credits-invoices/selling-fees?id=4822) | | Hong Kong (201) | [出售費用](https://www.ebay.com.hk/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Ireland (205) | [Fees for private sellers](https://www.ebay.ie/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Italy (101) | [Tariffe per venditori privati](https://www.ebay.it/help/selling/fees-credits-invoices/selling-fees?id=4822) | | Malaysia (207) | [Selling fees](https://www.ebay.com.my/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Netherlands (146) | [Kosten voor particuliere verkopers](https://www.ebay.nl/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Philippines (211) | [Selling fees](https://www.ebay.ph/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Poland (212) | [Opłaty dla prywatnych sprzedawców](https://www.ebay.pl/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | Singapore (216) | [Selling fees](https://www.ebay.com.sg/help/selling/fees-credits-invoices/fees-private-sellers?id=4822) | | United Kingdom (3) | [Fees for private sellers](https://www.ebay.co.uk/help/selling/fees-credits-invoices/selling-fees?id=4822) | | United States (0) | [Selling fees](https://www.ebay.com/help/selling/fees-credits-invoices/selling-fees?id=4822) | | eBay Motors | [Fees for selling vehicles on eBay Motors](https://www.ebay.com/help/selling/fees-credits-invoices/motors-fees?id=4127) | | eBay Stores | [Store selling fees](https://www.ebay.com/help/selling/fees-credits-invoices/store-fees?id=4809) | | Real Estate Listing Fees (US) | [Fees for Real Estate listings](https://www.ebay.com/help/selling/fees-credits-invoices/selling-fees?id=4822#section4) | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Create an eBay for Charity listing | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/charitable-listings-create.html#mainContent) Whether a seller is only going to contribute a percentage of the proceeds to another registered nonprofit organization, or if the seller is a nonprofit direct seller, the [Item.Charity](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Charity) container must be included in an add/revise/relist call to indicate the nonprofit organization that will be receiving some or all of the proceeds. The [Item.Charity.CharityID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Charity.CharityID) field will identify the target nonprofit organization. For all sellers who are not nonprofit direct sellers, the [Item.Charity.DonationPercent](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Charity.DonationPercent) field must also be passed in through an add/revise/relist call to indicate the percentage of the sale proceeds that will go toward that nonprofit organization for each sale. The supported values for this float field range from `10.0` to `100.0`, and any percentage value in between these two must be in increments of 5.0, so `15.0`, `20.0`, `25.0`, and all the way up to `95.0` and `100.0`. Interested nonprofit organizations should visit the [PayPal Giving Fund](https://www.paypal.com/us/webapps/mpp/givingfund/home) website to register. To search for registered nonprofit organizations to support: * Visit the _eBay for Charity_ [Charity Search page](https://charity.ebay.com/search) , or * Call the [getCharityOrgs](https://developer.ebay.com/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs) REST-based method. The [eBay for Charity](https://charity.ebay.com/charity-auctions/my-causes) site allows eBay users to save registered organizations to a list of their favorite charities. These charities will then be linked to the eBay user's account. Refer to [Charity listings policy](https://www.ebay.com/help/policies/prohibited-restricted-items/charity-fundraising-policy?id=4286) for additional information. Retrieve the CharityID ---------------------- Calling [getCharityOrgs](https://developer.ebay.com/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs) returns a list of [charityOrgs.charityOrgId](https://developer.ebay.com/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs#response.charityOrgs.charityOrgId) values in the [charityOrgs](https://developer.ebay.com/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs#response.charityOrgs) array. These are the values that can then be passed in via the [Item.Charity.CharityID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Charity.CharityID) field to support the specified charity. **Note:** The _GetCharities_ call in the Trading API should no longer be used as it has been decommissioned effective September 18, 2023. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise multiple-choice fields | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-multi-choice.html#mainContent) Because [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) replaces only item properties that are included in the input [ItemType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ItemType.html) object and list of properties changed, be careful when updating properties that are made up of multiple choice options, such as shipping option. In these cases, specify all intended options. For instance, if the listing already has options #1 and #2 and the revision change is to add option #3, include all three in the property of the input [ItemType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ItemType.html) object. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Item eligibility | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/second-chance-eligibility.html#mainContent) For a seller to use the Second Chance Offer feature for an item, that item must meet certain eligibility requirements. Refer to [Making Second Chance Offers](https://www.ebay.com/help/selling/listings/selling-auctions/making-second-chance-offers?id=4142) for current eligibility requirements. An application can make a call to [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) , [GetBidderList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetBidderList.html) , or [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) to determine if an ended auction item is eligible to be offered through a Second Chance Offer. A value of `true` in the [ItemArray.Item.SellingStatus.SecondChanceEligible](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.SellingStatus.SecondChanceEligible) response field of these calls will indicate that the item is eligible for Second Chance Offers. It is highly recommended that this be verified before actually attempting to make a Second Chance Offer. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Change a listing`s category | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-change-category.html#mainContent) When relisting an item, if the seller changes the listing category, category-dependent data is still required to be consistent with the new category the seller has selected. This means the seller may need to change the listing details when they change the category. For example, the seller may need to change the listing's _Item Specifics_ or product details to be consistent with the requirements of the new category. To change an item's property when using [RelistItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html) , the application simply specifies the new value of the property in the [Item](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item) object used as input as illustrated in the following example. **Sample XML to Modify Item Properties** ... 4\*\*\*\*\*\*\*\*6 200.0 ... #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Identify and select the right category | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/select-appropriate-category.html#mainContent) Sellers can determine which categories contain the most matching items by using the **getCategorySuggestions** method of the Taxonomy API and comparing the values returned in the **categorySuggestions** array. The suggested categories returned in this array are sorted in order of eBay's confidence of the relevance of each category. For complete information about the **getCategorySuggestions** method, refer to the [getCategorySuggestions](https://developer.ebay.com/api-docs/sell/taxonomy/resources/category_tree/methods/getCategorySuggestions) reference documentation. Specify a query for suggested categories ---------------------------------------- The query, defined by the **q** parameter, is a search string that describes the item being offered for sale. The string format is free form, and can contain any combination of phrases or keywords. eBay will parse the string and return suggested categories for the item. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise product details | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-product-details.html#mainContent) Items in certain categories can have details whose values are well known and do not vary from listing to listing. Instead of filling in this standard information for every listing, a seller can create a listing based on an eBay catalog product, and the product details defined in this catalog product "pre-fills" the listing. When an auction item has bids or the listing ends in fewer than 12 hours, you cannot change the product ID and you cannot remove the product from the listing. However, you can change the values of the [Item.ProductListingDetails.IncludeStockPhotoURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ProductListingDetails.IncludeStockPhotoURL) , [Item.ProductListingDetails.UseStockPhotoURLAsGallery](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ProductListingDetails.UseStockPhotoURLAsGallery) , and [Item.ProductListingDetails.IncludeeBayProductDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ProductListingDetails.IncludeeBayProductDetails) flags. When an auction item has no bids and does not end within 12 hours, you can use [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) to add, modify, or remove product details. If an item is listed with product details and you change the relevant category, you need to make sure the new category is mapped to the characteristics set associated with the product. The product data must always be consistent with at least one of the listing's categories. If the item already includes product details, but that information is inconsistent with the new category, you must remove the product information or replace it with new product information that is consistent. Common scenarios when revising an item with product details include: * Add product details to the listing. To add product details: * Set [Item.ProductListingDetails](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ProductListingDetails) to include all product information that you want to provide in the listing. * Specify the ID of the product that should be used to pre-fill the listing. * Use optional child elements to specify whether you want the listing to include a stock photo, whether you want to use the stock photo as the item's gallery image, and whether to include a stock summary in addition to your own item description. * To include a stock photo in the listing, you can either use the stock photo as the Gallery image by setting [Item.ProductListingDetails.UseStockPhotoURLAsGallery](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ProductListingDetails.UseStockPhotoURLAsGallery) to `TRUE` or use the first image passed in [Item.PictureDetails.PictureURL](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.Item.PictureDetails.PictureURL) as the Gallery image. For more information, refer to [Use an eBay stock photo as a gallery picture](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/catalog-products.html#stock) . * Remove all existing product data, including Item Specifics. To remove all existing product data from the listing set: * One instance of [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.DeletedField) to `Item.ProductListingDetails`, and * A second instance of [DeletedField](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/RelistItem.html#Request.DeletedField) to `Item.ItemSpecifics`. Removing product data without removing Item Specifics has the following effects: * Pre-filled item specifics are removed from the listing. * Item specifics that are not pre-filled are maintained unless you remove them or change the category to one that does not support the previously specified item specifics. * The stock photo (if any) is removed from the listing and Gallery (if applicable). * The link to additional summary information is removed from the listing. * Replace previous product data including pre-filled Item Specifics. To replace the previous product data with data for a different product: * Configure [Item.ProductListingDetails.UseStockPhotoURLAsGallery](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ProductListingDetails.UseStockPhotoURLAsGallery) to include the new product data. * Add, modify, or change item specifics that have not been pre-filled. To add, modify, or change only the item specifics that were not pre-filled, refer to [Update Item Specifics](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/item-specifics-update.html) for information about revising Item Specifics. Changes to product data in the system do not affect an existing listing. Therefore, the product ID and any pre-filled data that was present at the time of the [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) request remains constant at the time of the [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) request. After calling [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) with updated product details, you should compare the response to the request to make sure that the data that was actually listed matches the data that was passed in. For example, if you changed the value of an item specific but the value is now pre-filled in the catalog, the pre-filled value overrides the value that had been passed in. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Amount - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/business-policies/ReleaseNotes.html) Amount ( [double](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#double) ) ================================================================================================================ Monetary amount. This type is used in several locations in payment policies and return policies. Types that use Amount: [DepositDetails](https://developer.ebay.com/devzone/business-policies/CallRef/types/DepositDetails.html) , [Insurance](https://developer.ebay.com/devzone/business-policies/CallRef/types/Insurance.html) , [ShippingPolicyInfo](https://developer.ebay.com/devzone/business-policies/CallRef/types/ShippingPolicyInfo.html) , [ShippingPolicyInfoService](https://developer.ebay.com/devzone/business-policies/CallRef/types/ShippingPolicyInfoService.html) Calls that use Amount: [addSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/addSellerProfile.html) , [getSellerProfiles](https://developer.ebay.com/devzone/business-policies/CallRef/getSellerProfiles.html) , [setSellerProfile](https://developer.ebay.com/devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ This type has no fields. Attribute --------- currencyId ( _[string](https://developer.ebay.com/devzone/business-policies/CallRef/types/simpletypes.html#string) _ ) This attribute identifies the currency in which the monetary amount is specified. For a full list of 3-digit ISO 4217 currency codes, see the Trading API's [CurrencyCodeType](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/CurrencyCodeType.html) . --- # API versus UI feature comparison | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/sell/static/marketing/pl-api-vs-ui-feature-comparison.html#mainContent) eBay Promoted Listings will have differences for some API and UI product features. This page serves as a comparison for Promoted Listings by highlighting the ways in which certain features are uniquely available in the API versus in the UI. **Note:** Bold text in the table indicates a difference between features of the **API** and **UI** interfaces. Please find the **comparison** between API and UI in **general** campaign strategy features below: | | | | | --- | --- | --- | | **Area** | **API** | **UI** | | Campaign Management | Campaign Set Up

* Auto select for RBC (Rules based campaign) can be **True or False**


Campaign Limits:

* **Maximum of 10** selection rules for RBC; rule can be created with multiple filters

* Maximum 50,000 listings per campaign (including RBC) | Automated Campaign Set Up

* Auto select for Automated campaigns is **always True**


Campaign Limits:

* **Maximum of One** rule per automated campaign

* Maximum 50,000 listings per campaign (applies to all general campaigns) | | Reporting | Reporting Cannot schedule report via API

Reports Available:

* Account Performance

* Campaign Performance Summary

* Campaign Performance

* Listing Performance

* Inventory Performance (on pause)

* **Enhanced Transaction Report** (separate metrics for PLG & PLP)


Report Functionality

* Day level reporting | Ability to schedule report in UI

Reports Available:

* Listing Report

* Campaign performance is viewable in the Marketing tab and CDP page, but it is not downloadable


Transaction report unavailable in UI

Report functionality

* Day level report \*this is only available for some reports | | Guidance | **Find method using [Recommendations API](https://developer.ebay.com/api-docs/sell/recommendation/overview.html)
**

[findListingRecommendations](https://developer.ebay.com/api-docs/sell/recommendation/resources/listing_recommendation/methods/findListingRecommendations)
to retrieve both item (listing) and ad rate (bid) recommendations | Campaign Type: Simple

* One Time Static for Suggested or Fixed Ad Rates


Recommended listings and suggested ad rate are available in the UI | Please find the **comparison** between API and UI in **priority** campaign strategy features below: | | | | | --- | --- | --- | | **Area** | **API** | **UI** | | Reporting | Cannot schedule report via API

Reports Available: Account Performance report

* Campaign Performance report

* Listing Performance report

* Keyword Performance report

* Search Query report

* **Enhanced Transaction report** (separate metrics for PLG & PLP)


Report Functionality

* Bulk Request capability

* Day level report

* Custom report defaults to seller site timezone | Ability to schedule report

Reports Available:

* Campaign Performance report

* Listing Performance report

* Keyword Performance report

* Search Query Report


Transaction report unavailable in UI

Report functionality

* Day level report | | Guidance | Insights:

Suggested Keywords

* Search volume on PLP API

* **Active Seller count**


* **Competition metric**


Suggested Items

Suggested bids for any keyword | Insights:

Suggested Keywords

* Search volume on PLP API


Suggested Items

Suggested bids for any keyword | #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Call Index - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/product/ReleaseNotes.html) Call Index ========== This API Reference describes the elements and attributes for each call in the Product API. Additional resources are available for this API. Please see the [eBay Developer Documentation Center](https://developer.ebay.com/api-documentation) . See also the calls in the [eBay Product Metadata API](https://developer.ebay.com/DevZone/product-metadata/CallRef/index.html) . | Call | Summary | Samples | | --- | --- | --- | | [findProducts](https://developer.ebay.com/DevZone/product/CallRef/findProducts.html) | Finds products for a given category and search criteria. | n/a | | [getProductCompatibilities](https://developer.ebay.com/DevZone/product/CallRef/getProductCompatibilities.html) | Returns all available compatibility details for the specified product. | n/a | | [getProductDetails](https://developer.ebay.com/DevZone/product/CallRef/getProductDetails.html) | Retrieve product details for the specified product ID, including whether the product has fitment information or not. | n/a | --- # Browse a seller`s items | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/browse-seller.html#mainContent) [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) is called to retrieve a group of items listed by a specified seller. * Items for the eBay seller tied to the user token are returned. * All calls require at least one date-range filter be specified. * Specify a [GranularityLevel](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.GranularityLevel) to control the response data. If omitted, the default value `fine` is applied. * Pagination values must be included. Refer to [Paginate results](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/browse-seller.html#paginate) for additional information. [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) returns a list of items in the [ItemArray](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray) . The array comprises one [ItemArray.Item](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item) object for each item listed by the specified seller that also satisfies any input filtering criteria. The application parses the [ItemArray](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray) and examines each [ItemArray.Item](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item) to inspects its properties. The response includes indicators of how many items are returned and whether there are additional items that could be returned (i.e., additional items that satisfy the criteria but require additional calls to be retrieved). The result set also contains the page number for the data returned, the number of items being returned per page, and the total number of pages of items meeting the selection criteria. Filter results by date ---------------------- The number of items that could be returned for a given seller is potentially large. To reduce the number of items returned, date-based filter inputs can be used to filter results based on: * When the items started * When the items ended * When the items were last modified Applications use this type of filtering to limit the items to just those of interest in the context of a given operation. For example, if the context calls for retrieving only those items that end on a particular day, the application should not filter for all the items ending within a given month. Date-based filters work in pairs, delineating a date range described by the earliest date of interest (i.e., oldest,) and a the latest date of interest (i.e., most recent). For example, to retrieve the items that end on a particular day: * The earliest date in the range might be one second after midnight on the morning of interest; items that ended prior to that time would not be of interest. * The latest date in the range might be midnight on that day; items that ended after that time would not be of interest. When one filter input is used, the other matching filter element must also be used (the application must always specify _both_ the oldest date and the most recent date for a filtering date range). For example, if [EndTimeFrom](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.EndTimeFrom) is specified (because the filtering date range is based on the end date) then [EndTimeTo](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.EndTimeTo) must also be specified. At least one date-range filter must be specified. Multiple date-range filters may be used per call. For instance, a single call can return the items ending within a date range (one filter) plus those that started in a specified date range (a second filter). Paginate results ---------------- One way to reduce the number of items returned in any single call is by configuring [Pagination](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.Pagination) . Pagination breaks the total data set down into smaller chunks that might be easier for the application to use. **Note:** If zero items would be returned, an _Invalid page number_ error will **NOT** be returned. For example, if 100 items for a seller satisfy the selection criteria for a call, the application could issue: * One single call to retrieve all 100 items, or * Ten calls that each retrieves 10 items (i.e.,ten pages of ten items each). [Pagination](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.Pagination) is configured by: * [Pagination.EntriesPerPage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.Pagination.EntriesPerPage) Specifies the number of [ItemArray.Item](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item) objects to return for the current call. * [Pagination.PageNumber](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.Pagination.PageNumber) The page number to return in the current call. The first call returns page 1 of a seller's items. Data in the call's result set indicate if there are additional [ItemArray.Item](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item) objects to retrieve and, if so, how many remain. The application uses this information to determine whether additional calls are required and, based on the [Pagination.EntriesPerPage](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Request.Pagination.EntriesPerPage) value, how many additional calls are required to retrieve all items. If additional calls are needed, each subsequent call specifies an incrementally larger page number to retrieve each succeeding page of items. Sort results ------------ Items returned by [GetSellerList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html) can be sorted by their [ItemArray.Item.ListingDetails.EndTime](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetSellerList.html#Response.ItemArray.Item.ListingDetails.EndTime) values. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Retrieve data for one item | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/retrieve-one-item.html#mainContent) [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) is called to retrieve data for a single item by specifying an [ItemID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Request.ItemID) . For additional information, refer to the [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Output) output reference documentation. Retrieve an item's condition ---------------------------- [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) returns an item's condition in the field in which seller originally specified it. An item's condition may be returned in the following fields: * [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ConditionID) Items listed with an [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ConditionID) also return the human-readable [Item.ConditionDisplayName](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ConditionDisplayName) in the language of the marketplace on which the item was originally listed. For example, a seller lists a brand new item on the eBay Germany marketplace. A [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) call for this item is subsequently sent to the eBay US marketplace. [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ConditionID) returns `Neu` in German and does not convert it to `New` in English. Retrieve ItemSpecifics ---------------------- For listings that include [Item.ItemSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.ItemSpecifics) information, it is returned when a [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) call is issued with [DetailLevel](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Request.DetailLevel) set to: * `ReturnAll` or * `ItemReturnAttributes`. Information for multiple-variation listings is returned in [Item.Variations.Variation.VariationSpecifics](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.Variations.Variation.VariationSpecifics) . Information included in the response includes item specific name-value pairs with some item specific names supporting multiple values. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # How to upload and manage feeds | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-how-to-upload-feeds.html#mainContent) After you set up your eBay seller account to use the **Merchant Integration Platform** (MIP), you can upload/manage feeds through the MIP UI or through the SFTP server. **Note:** See [Getting started](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-overview-getting-started.html) for information on setting up your eBay seller account to use the Merchant Integration Platform (MIP). MIP user interface ------------------ Through the production or sandbox MIP interface, you can select each feed type and then upload a feed file. **Note:** You have to create a feed file before you can upload it (see [Feed requirements](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-feed-requirements.html) ). Also, you need to perform other setup and configuration tasks such as **Select the feed format for the product data you'll upload** (see [settings/feedschema](https://www.ebay.com/mip/settings/feedschema) ) and **Channel management** (see [Manage your channels](https://www.ebay.com/mip/settings/channelmanagement) ). To upload a feed file, select the feed (see [Available feeds](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-how-to-upload-feeds.html#Availabl) ) and then: 1. Select **Upload**. ![](https://developer.ebay.com/api-docs/res/Resources/images/mip-user/mip-upload-button.png) 2. Navigate to the feed file for upload, and then select it. 3. Select **Open** to upload the file. Once the feed file starts to be processed, information is displayed in the feed window. This may include information such as the **Request Id**, **Uploaded file**, **Upload Time**, **SKUs updated**, **SKUs failed**, **Results file**, and **Status**. Use this information to retrieve the results file, check status, determine any failed SKUs, and other similar tasks. SFTP interface -------------- To use the SFTP interface, set up and open a secure FTP client. Use the steps in the MIP GUI [FTP set up](https://www.ebay.com/mip/settings/ftpsetup) (under Settings). Additional guidance is contained in [FTP setup](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-setup-ftp-setup.html) . Also refer to the specific secure FTP client that you set up for information on file uploads and downloads. Then, connect to the MIP file server through the SFTP client and expand the directory tree so the feed folders show. Upload the file to the appropriate feed folder. Generate and download reports ----------------------------- You can generate Order Reports and Active Inventory Reports through MIP. See [Report](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-reports.html) for additional information. Available feeds --------------- Feeds for the following tasks are available. **Inventory Management** * [Product](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-product-feeds.html) * [Availability](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-availability-feeds.html) * [Distribution](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-distribution-feeds.html) * [Inventory](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-inventory-feeds.html) * [Location](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-location-feeds.html) * [Order fulfillment](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-order-fulfillment-feeds.html) * [Delete inventory](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-delete-inventory-feeds.html) * [](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-product-search-feed.html) [Search product catalog](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-product-search-feed.html) **Marketing Management** * [Promoted Listings eligibility](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-pl-eligibility-feeds.html) * [Promoted listings](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-pl-feeds.html) **Report** * [Pending orders](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-order-report.html) * [Active inventory](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-definitions-active-inventory-report.html) **Metadata** * [Classification](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-classification-feeds.html) * [Category metadata](https://developer.ebay.com/api-docs/user-guides/static/mip-user-guide/mip-about-category-metadata-feeds.html) #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # GetMyeBayBuying | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/my-ebay-buying.html#mainContent) In the schema, a request to [GetMyeBayBuying](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) allows you to specify which nodes you want returned in the response and customize the response list. The specific elements you can customize in the list vary by the node you want returned. Refer to the [GetMyeBayBuying](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) reference documentation for complete information. For example, to return a [WatchList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.WatchList) node to display the items a user is watching, issue the following [GetMyeBayBuying](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) request: ABC...123 425 ReturnAll TimeLeft true 10 1 In the [GetMyeBayBuying](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) response, the [WatchList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.WatchList) , [BidList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.BidList) , [WonList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.WonList) , and [LostList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.LostList) nodes are each based on the complex type [ItemListCustomizationType](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ItemListCustomizationType.html) , which provides pagination via its [Pagination](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/types/ItemListCustomizationType.html#Pagination) element. It is recommended that you use pagination, as the result list can be quite long. The [WatchList](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.WatchList) node returned by [GetMyeBayBuying](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) is an array similar to that shown below: 4.0 7\*\*\*\*\*\*\*9 2023-08-08T17:29:07.000Z 2023-08-09T04:29:07.000Z a\*\*\*\*\*7 4.0 PT0S Test Domains 4 ... more Item nodes ... 1 5 Most of the other nodes returned by [GetMyeBayBuying](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) work in a similar way, allowing you to customize the node on the request and returning an array. However, [FavoriteSearches](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.FavoriteSearches) and [FavoriteSellers](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Request.FavoriteSellers) simply return a group of nodes without structuring them into an array, as shown in the following example: 3 Database systems https://search-desc.qa.ebay.com/ws/search/SaleSearch?basicsearch=&from=R10&ht=1&sacategory=267&saregion=0&satitle=Database+systems&sorecordsperpage=50&sosortorder=1&sosortproperty=1&sotextsearched=2 oreilly https://search-desc.qa.ebay.com/ws/search/SaleSearch?basicsearch=&from=R10&ht=1&saregion=0&satitle=oreilly&sorecordsperpage=50&sosortorder=1&sosortproperty=1&sotextsearched=2 Unnamed Search https://motors.search.qa.ebay.com/ws/search/SaleSearch?catref=C6&fisc=c6024&from=R9&sacategory=6024&samet=2&socolumnlayout=3&sofindtype=22&sorecordsperpage=50&sosortorder=1&sosortproperty=1&sotrtype=1&sotrvalue=1 2 sampleuser p\*\*\*\*\*\*\*\*\*e sampleuser e\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*e The `text` strings shown above are HTML-encoded URL strings that many applications can use directly. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Enable Out-of-Stock | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/out-of-stock-enable.html#mainContent) Out-of-Stock is enabled as a user preference using the [SetUserPreferences](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetUserPreferences.html) call to set the value for [OutOfStockControlPreference](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetUserPreferences.html#Request.OutOfStockControlPreference) to `true`. Sellers may also opt in to Out-of-Stock control through Selling Preferences of My eBay. Refer to the following sample code: **Sample code to enable Out-of-Stock** ... true ... When the feature is enabled, it is automatically applied to all of the user's existing listings as well as to any new listings that are created. When the quantity of an item goes to zero for a listing using this feature, the item remains "alive," but while it remains in the out-of-stock state (i.e., `Item.Quantity` = 0,) the item will not be included in the search results until it is back in stock (i.e., `Item.Quantity` > 0). `Item.Quantity` for an item can be updated using one of the following calls: * [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) * [ReviseFixedPriceItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) * [ReviseInventoryStatus](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html) Refer to the following sample code. **Sample code to update Item.Quantity using ReviseInventoryStatus** 1\*\*\*\*\*\*\*\*\*\*7 14 To retrieve the current Out-of-Stock preferences, issue a [GetUserPreferences](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetUserPreferences.html) call with [ShowOutOfStockControlPreference](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShowOutOfStockControlPreference) set to `true`, as illustrated in the following code sample: **Sample code to retrieve Out-of-Stock preferences** ... true ... #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # How Out-of-Stock works | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/out-of-stock-operation.html#mainContent) When Out-of-Stock has been enabled, a listing's behavior depends on whether it has been applied to a single-SKU or a multiple-SKU listing. Single-SKU listings ------------------- When `Item.Quantity` reaches zero for a single-SKU listing, the listing no longer appears in the _Search Results_ page. If a user already has the Item ID for the item, they can still access the _View Item_ page directly, but its _Buy It Now_ and _Add to cart_ buttons are disabled and a label is displayed indicating that the item is **Out of Stock**. Multiple-SKU listings --------------------- When `Item.Quantity` reaches zero for one or more variations of a multiple-SKU listing, but _at least one variation_ in the listing still has stock, the listing will continue to be displayed on the _Search Results_ page. However, those variations with zero stock quantity will be shown as **Out of Stock** on the _View Item_ page. If/when all variations for the item have zero quantity, the item will _not_ be displayed on the _Search Results_ page. However, if a user alread has the Item ID for one (or more) of the variations, they can still access the _View Item_ page(s) directly, and those variations with zero inventory will be grayed out, their respective _Buy It Now_ and _Add to cart_ buttons will be disabled, and a label indicating that the item is **Out of Stock** is displayed. Reducing the stock quantity for a variation to zero for multiple-SKU listings yields varying results depending on whether Out-of-Stock is enabled or disabled. For example, consider an item with the following three variations and stock quantities: * Variation A | `Item.Quantity` = 5 * Variation B | `Item.Quantity` = 3 * Variation C | `Item.Quantity` = 1 Because there have been no sales for any of these variations, the seller has decided to remove them by reducing each of their stock quantities to zero. However, depending on whether Out-of-Stock is enabled or disabled, the variations may or may not be deleted. Refer to the following table for a comparison of what happens when each of the variations' stock quantities are systematically reduced to 0. | Variation | `Item.Quantity` = 0

Out-of-Stock Disabled | `Item.Quantity` = 0

Out-of-Stock Enabled | | --- | --- | --- | | A | Variation A is deleted. | Variation A is retained.

Because both Variation B and Variation C each continue to have stock, Variation A will be included on the _Search Results_ page, but on the _View Item_ page, it will be shown as being **Out of Stock**. | | B | Variation B is deleted. | Variation B is retained.

Because Variation C continues to have stock, both Variation A and Variation B will be included on the _Search Results_ page, but on the _View Item_ page, both will be shown as being **Out of Stock**. | | C | An error is displayed. Since Variation C is the last variation with any stock, it cannot have its `Item.Quantity` reduced to 0. | Variation C is retained

Since there are no variations that currently have stock, the item will not be included on the _Search Results_ page. However, if a buyer already has the Item ID for the item, they can still access the _View Item_ page directly, and all three variations will be shown as being **Out of Stock**. | In order to delete a variation for a multiple-SKU item for which the Out-of-Stock feature is enabled, set **Item.Variations.Variation.Delete** to `true`. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Condition | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/condition.html#mainContent) An item's condition is one of the top factors buyers consider when deciding whether to purchase an item. When you create your listing, help your buyers understand exactly what they will be receiving by specifying its condition. Listings that specify the item's condition provide useful information and as a result, may be more likely to sell. An item's condition appears just below the listing title in the View Item page. When buyers search for items, they often use eBay's Advanced Search options to narrow their search based on the item's condition. In these cases, your listing will appear in search results only if you specified the condition by using one of eBay's structured methods (not in the text of your listing description). For additional information about item conditions, refer to: * the [Item Conditions](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/item-conditions.html) topic, and * the [Item condition](https://www.ebay.com/help/listings/creating-managing-listings/creating-managing-listings?id=4105#section2) help page. ConditionId ----------- When listing an item, most categories require that a [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionID) be included. eBay defines a list of well-understood conditions, such as "_New_", "_Used_", and other values. Each condition corresponds to a numeric ID (e.g., 1000 for "_New_,") so that even if the display name varies across categories or marketplaces, you can use the same IDs in [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) and related calls. To determine the appropriate condition ID to use in a listing: 1. Use [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) to determine whether item conditions are required or enabled for the category and what item condition values are supported for the category. To retrieve this information, include one [FeatureID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Request.FeatureID) field that is set to a value of `ConditionEnabled` and a second [FeatureID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Request.FeatureID) field set to a value of `ConditionValues`. 2. In the [FeatureID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Request.FeatureID) response, locate the [Category.ConditionEnabled](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ConditionEnabled) field to determine if an item condition is enabled (or required) for the category. 3. Review the list of valid condition IDs in the [Category.ConditionValues](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ConditionValues) array. Each item condition has a numeric ID and also a human-readable display name, such as "_New_" or "_Seller refurbished_". 4. After choosing the most accurate condition ID from [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) , specify the numeric ID value for the condition in the [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionID) field of the [AddItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html) (or related) call. 5. If the item is not new, consider also adding the [Item.ConditionDescription](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionDescription) field to describe any wear and tear and/or defects with the item. Please note the following if a [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionID) value is passed in that is not valid for a category: * If [Category.ConditionEnabled](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ConditionEnabled) is set to `Disabled` or not applicable for the category, the item is listed with no condition. * If [Category.ConditionEnabled](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.ConditionEnabled) is set to `Enabled` or `Required` for the category, the request fails. For additional information about ConditionIds, refer to the [ConditionIds](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/condition-ids.html) topic. **Argument:** [Item.ConditionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionID) ConditionDescription -------------------- The [Item.ConditionDescription](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionDescription) field is optional and available for use within all categories, including those categories where the condition type is not applicable (e.g., Antiques). This field is applicable for all item conditions except _New_, _Brand New_, _New with tags_, and _New in box_. **Argument:** [Item.ConditionDescription](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionDescription) **Note:** Although [Item.ConditionDescription](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.ConditionDescription) is optional, it is strongly recommended that it be used when describing _used items_ rather than describing the item's condition in [Item.Description](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Description) . **Maximum Length:** 1000 characters #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Automatically accept or decline offers | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/best-offers-auto.html#mainContent) When an item is listed with the Best Offer feature, the seller can specify a Best Offer **auto-accept** and/or **auto-decline** price. Use **GetCategoryFeatures** to determine if these features for Best Offer are supported for the category you want to use. You'll want to include `BestOfferAutoAcceptEnabled` and `BestOfferAutoDeclineEnabled` as **FeatureID** values in the **GetCategoryFeatures** call request. If you set a minimum Best Offer price and a Best offer does not meet it, the Best Offer is automatically declined. If subscribed to the corresponding platform notification, the buyer will receive a `BestOfferDeclined` notification. The minimum Best Offer price is specified through the **Item.ListingDetails.MinimumBestOfferPrice** field of an Add/Revise/Relist/Verify call. A minimum Best Offer price can only be specified for items listed in categories that support auto-decline for Best Offers. If a minimum Best Offer price have been specified for a listing in a category that supports auto-decline for Best Offers, **GetItem** and **GetSellerList** will return the **Item.ListingDetails.MinimumBestOfferPrice** field. The auto-accept price is the price at which Best Offers are automatically accepted. Specify an auto-accept price through the **Item.ListingDetails.BestOfferAutoAcceptPrice** field of an Add/Revise/Relist/Verify call. The first Best Offer that meets or exceeds this value will automatically be accepted. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise fixed-price items after purchases are made | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-fixed-price.html#mainContent) You can revise a multi-quantity fixed-price listing after buyers have purchased items from it. In these cases, [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) normally returns the latest (revised) details of the listing. If a buyer purchases items from a multi-quantity fixed-price listing, eBay saves a snapshot of the listing as it was at the time of the purchase. The [TransactionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Request.TransactionID) of the order is associated with that snapshot. Sellers and buyers can retrieve the snapshot of the listing by calling [GetItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html) and passing [TransactionID](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Request.TransactionID) in the request. (The snapshot is also available in [GetItemTransactions](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItemTransactions.html) and related calls.) Sellers of an item are allowed to view any purchase snapshots of the listing (any transaction or order), whereas buyers can only view the purchase snapshots for which they are the successful buyer. Order line items (purchases) can be viewed for up to 90 days from the creation date. If you are using Notifications, you can set the order line item event to trigger your notifications or use an event related to the entire listing. Refer to the [Notification API](https://developer.ebay.com/api-docs/commerce/notification/overview.html) for additional information. Be aware that if using item purchase snapshot data, fields such as [ListingStatus](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.ListingStatus) may report an `Active` status since the listing was `Active` on the order line item (transaction) date even though the listing may actually have ended. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Best Offer flow | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/best-offers-flow.html#mainContent) To enable the Best Offer feature for a listing: 1. Use the [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) or [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) call to determine if the desired category supports Best Offer. **Note:** Best Offer is not available for multi-variation listings. 2. If supported, enable Best Offer for the listing. To opt an item into Best Offer, set **Item.BestOfferDetails.BestOfferEnabled** to `true` when listing, revising, or relisting the item. 3. \[_Optional_\] Set the minimum Best Offer price and auto-accept price for Best Offers for the listing. To set these values, include the **ListingDetails** container in the Add call and set these prices through the **MinimumBestOfferPrice** and **BestOfferAutoAcceptPrice** fields. 4. Verify the Best Offer settings for the item. To determine whether Best Offer is enabled for an item and how many Best Offers exist for it, check **BestOfferEnabled** and **BestOfferCount** in **Item.BestOfferDetails** in the response of **GetItem**. 5. Retrieve information about any Best offers made for the item. Use **GetBestOffers** to get more detailed information about Best Offers made for an item. 6. Respond to a Best Offer by accepting, declining, or making a counteroffer. Use **RespondToBestOffer** to accept or decline a Best Offer or to make a counteroffer. Depending upon the marketplace and category limitations on the number of offers a buyer can make, the buyer can accept the counteroffer, decline the counteroffer, or submit a counteroffer to the seller's offer. Eventually, the buyer must accept, decline, or allow the seller's last offer to expire. 7. When a Best Offer has been accepted, check on the status of the order line item. To determine if an order line item was completed with the seller selecting a Best Offer, check **Transaction.BestOfferSale** in **GetItemTransactions**. **Note:** **GetSellerList** returns **ItemArray.Item.BestOfferDetails.BestOfferEnabled**. **GetBidderList** has no Best Offer component. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Promoted Listings general strategy campaign flow | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#mainContent) There are two primary ways to create general strategy campaigns, each of which provide different flows and methods for the configuration of campaign criterion to add listings: * **Rules-based campaigns** select listings to include in a campaign using a set of criteria, or _rules_, that you specify using the **createCampaign** method. The rules that you create are used to select listings based on a combination of brands, category IDs, item conditions, and the minimum and maximum prices of the listings you want to promote. * **Key-based campaigns** use ID values to select the listings to include in a campaign. You can add listings to a campaign one at a time or in bulk using: * _Listing ID_ values, which are created by the [Trading API](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/index.html) or [Inventory API](https://developer.ebay.com/api-docs/sell/inventory/static/overview.html) when you list an item. * _Inventory reference ID_ and _inventory reference type_ pairs, which together identify an item that is managed by the Inventory API. ![](https://developer.ebay.com/api-docs/res/Resources/images/marketing/create-campaign-overview.png) Rules-based general campaigns ----------------------------- The quickest way to create a campaign and add listings is to create a rules-based campaign using the [createCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign "createCampaign API Ref") method, where you will:  1. [Configure the campaign structure](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#configure-rb-pls) 2. [Add items to the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#add-by-rule) **Important!** Rules-based campaigns are only supported for general strategy campaigns that utilize the Cost Per Sale (CPS) funding model. ### Configure the campaign structure In your call to the [createCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign "createCampaign API Ref") method, set up the structure of the campaign by configuring the following fields: * **marketplaceId** – The _eBay marketplace_ for which the campaign will run. * **campaignName** – The seller-defined name given to the campaign. * **fundingStrategy** – A combination of the **bidPercentage** and the **fundingModel** used for the campaign. The **bidPercentage** (also known as the _ad rate_) defines the level at which you want to promote the items in your campaign (see the [Promoted Listings overview](https://developer.ebay.com/api-docs/sell/static/marketing/pl-overview.html) for details). For rules-based campaigns, set the **fundingModel** to `COST_PER_SALE`. * **startDate** – The day on which the campaign will begin. * **endDate** – The day on which the campaign will end (this is an optional field). **Tip:** See the [Campaign recommendations and suggestions](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#recommendations) section for details about how to retrieve recommendations on listings, ad rates, and other useful data that can be helpful when configuring your Promoted Listings campaign. Here is an example request payload that shows how to configure the structure of a CPS Promoted Listings campaign: { "**marketplaceId**": "EBAY\_US", "**campaignName**": "W\*\*\*\*\*\*\*\*\*\*n", "**fundingStrategy**": { "bidPercentage": "3.5", "fundingModel": "COST\_PER\_SALE" }, "**startDate**": "2019-06-30T19:00:00Z", "**endDate**": "2019-07-30T19:00:00Z" } **Important!** Ad rates cannot be updated after the campaign has been created. The **bidPercentage** is always set at the ad level, and ads that are created by a rules-based campaign inherit their **bidPercentage** settings from the value configured in the call to the **createCampaign** method. ### Add items to the campaign After configuring the structure of the campaign (and before submitting your **createCampaign** call), identify the listings that you want to include in the campaign by configuring the **campaignCriterion** data, including the **selectionRules** fields. Up to ten distinct **selectionRules** elements can be configured, where each identifies a set of criteria for the listings to include in the campaign. When a listing matches all the rules you define, the Promoted Listings service creates an ad for that listing and includes the ad in the campaign. In each **selectionRules** element, configure the following fields to set up the criteria by which the ads are created: * **brands** – A list of brands to include in the campaign. An ad is created for a listing if its brand matches one of the names identified in this rule. * **categoryIds** – A list of category IDs, which can contain either category IDs from the associated marketplace or category IDs from the seller's store. * **categoryScope** – A value that identifies the type of category IDs used in this set of rules, either `MARKETPLACE` or `STORE`. * **listingConditionIds** – A list of numeric values that indicates the condition of the items to include in the campaign. The following values are currently supported: * `1000` – This value indicates that the listing condition is _New_. This includes listings that are: * New * New other (see details) * New - open box * New with defects * New with tags * New without tags * New with box * New without box * Brand new * New/Factory sealed * `2000` – This value indicates that the listing condition is _Certified Refurbished_. * `2500` – This value indicates that the listing condition is _Seller Refurbished_. This includes listings that are: * Seller refurbished * Remanufactured * Excellent - Refurbished * Very good - Refurbished * Good - Refurbished * `3000` – This value indicates that the listing condition is _Used_. This includes listings that are: * Used * Used - like new * Used - very good * Used - good * Used - acceptable * Used - fair * Pre-owned * For parts or not working * **maxPrice** – The maximum price of listings that shall be included in the campaign. * **minPrice** – The minimum price of listings that shall be included in the campaign. You can set the **autoSelectFutureInventory** request field to `true` so that after your campaign launches, eBay will regularly assess your new, revised, or newly-eligible listings to determine whether any should be added or removed from your campaign according to the rules you set. If there are, eBay will add or remove them automatically on a daily basis when the following scenarios occur:  * A new listing is created. * An existing listing is revised. * Another campaign ends, and the listings are released from the campaign. Here is an example request payload that shows how to configure rules and add items to a CPS Promoted Listings campaign: { "**autoSelectFutureInventory**": "true", "**selectionRules**": \[\ {\ "**brands**": \[ \ "list", \ "of", \ "brands"\ \],\ "**categoryIds**": \[ \ "list", \ "of", \ "category IDs"\ \],\ "**categoryScope**": "STORE",\ "**listingConditionIds**": \[ \ "list", \ "of", \ "listing condition IDs"\ \],\ "**minPrice**": {\ "currency": "USD",\ "value": "95.95"\ }\ }\ \] } **Important!** You can specify listing-selection rules only when you first create a campaign with a call to the **createCampaign** method; you cannot update the selection rules in an existing campaign. If you must change the rules that you have specified for a campaign, delete the existing campaign before creating a new campaign with the new selection rules. This is required because items can be included in only one campaign at a time. When you submit the call containing selection rules to the **createCampaign** method, the service checks the number of listings that comply with the rules, and ads are created as follows:  * If the number of listings is less than or equal to 50,000, the request is successful and ads are created for all of the items that match the selection rules (keep in mind that an ad is created for each item in a multiple-variation listing). * If your rules result in the selection of more than 50,000 items, ads are created for only the first 50,000 items found, in order of recency. * If a seller adds inventory after the initial call to the **createCampaign** method, either before the campaign start date or while the service is creating ads, and it results in greater-than 50,000 items matching the ad criteria, the service creates ads for only the first 50,000 items that match the specified selection rules. * If you submit the call with the **autoSelectFutureInventory** request field to `true`, and no listings match your rules, the campaign can still be launched, and eBay will regularly check for listings that match your rules. **Note:** When you create a campaign, the URI to the newly created campaign is returned in the **Location** response header. This value includes the campaign ID value. Key-based general campaigns --------------------------- This section describes how to create a key-based campaign using listing IDs and reference IDs to identify the listings for which you want to create ads. You add listings to a key-based campaign _after_ you create and configure the campaign with a call to the **createCampaign** method. You then use the campaign ID that is returned in the **Location** response header to create the ads for the campaign. The following diagram illustrates the creation flow for general strategy campaigns using the Cost Per Sale (CPS) funding model: ![](https://developer.ebay.com/api-docs/res/Resources/images/marketing/create-campaign-using-ids.png) As shown in the above chart, in order to create a key-based campaign, you will:  1. [Create the campaign](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#pls-create-campaign) 2. Create ads for the campaign using: * [Listing IDs](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#pls-listing-ids) * [Reference IDs](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#pls-ref-ids) **Tip:** See the [Campaign recommendations and suggestions](https://developer.ebay.com/api-docs/sell/static/marketing/pl-campaign-flow-pls.html#recommendations) section for details about how to retrieve recommendations on listings, bid percentages, and other useful data that can be helpful when configuring your campaign. ### Create the campaign Submit a call to the [createCampaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign "createCampaign API Ref") method and configure the following fields: * **marketplaceId** – The _eBay marketplace_ for which the campaign will run. * **campaignName** – The seller-defined name given to the campaign. * **fundingStrategy** – A combination of the **bidPercentage** and the **fundingModel** used for the campaign. The **bidPercentage** defines the level at which you want to promote the items in your campaign, and the **fundingModel** defines the mechanism used to calculate the Promoted Listing fee (see the [Promoted Listings overview](https://developer.ebay.com/api-docs/sell/static/marketing/pl-overview.html) for details). * **startDate** – The day on which the campaign will begin. * **endDate** – The day on which the campaign will end (this is an optional field). Here is an example request payload that shows how to create a general strategy campaign: { "**marketplaceId**": "EBAY\_US", "**campaignName**": "W\*\*\*\*\*\*\*\*\*\*n", "**fundingStrategy**": { "bidPercentage": "3.5", "fundingModel": "COST\_PER\_SALE" }, "**startDate**": "2019-06-30T19:00:00Z", "**endDate**": "2019-07-30T19:00:00Z" } **Important!** The **bidPercentage** is always set at the ad level, and ads that are created by a rules-based campaign inherit their **bidPercentage** settings from the value configured in the call to the **createCampaign** method. To modify the **bidPercentage** of an ad, use the **updateBid** method. When you create a campaign, the URI to the newly created campaign is returned in the **Location** response header. This response includes the campaign ID value that is used to create ads and add them to the Promoted Listings campaign (see the sections below for details). ### Create ads for the campaign using listing IDs After creating a campaign, you can create ads for the listings you want included in the campaign by calling either the [createAdByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId) method (to add individual listing IDs) or the [bulkCreateAdsByListingId](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByListingId) method (to specify up to 50,000 listings per call). Specify the campaign to which the listings should be added using the **campaign\_id** path parameter. You can specify the **bidPercentage** (optional) at this time also. **Tip:** You can retrieve the campaign IDs for a specified seller using the [getCampaigns](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns) method. **POST https://api.ebay.com/sell/marketing/v1/ad\_campaign/{campaign\_Id}/bulk\_create\_ads\_by\_listing\_id** { "requests": \[\ {\ "**bidPercentage**": "{bidPercentage}",\ "**listingId**": "{listingId}"\ },\ { \ "**bidPercentage**": "{bidPercentage}",\ "**listingId**": "{listingId}"\ }\ \] } Each campaign can have ads for a maximum of 50,000 items, and multiple-variation listing IDs create an ad for each variation in the listing. If a call to the **bulkCreateAdsByListingId** method would generate more than 50,000 ads for a campaign, ads are created for only the first 50,000 items. Be aware that each listing can be associated with just one ad and that each ad can be associated with only a single campaign. Listings cannot be associated with more than a single active general strategy campaign at a time. ### Create ads for the campaign using reference IDs If you manage your inventory with the [Inventory API](https://developer.ebay.com/api-docs/sell/inventory/resources/methods) , you can use inventory reference IDs to create the ads for your campaign. An _inventory reference ID_ denotes a value that's used in the Inventory API. It can be either a seller-defined SKU value or an **inventoryItemGroupKey** (a seller-defined ID for a multiple-variation listing). You must pair each inventory reference ID with its associated _inventory reference type_ (either `INVENTORY_ITEM` or `INVENTORY_ITEM_GROUP`) to indicate whether the listing is for a single item or it is for a multiple-variation listing. The process for creating campaigns and including ads in the campaign using reference IDs is essentially the same as the process defined above for creating campaigns and using listing IDs to create ads. The main difference is that you use the [createAdsByInventoryReference](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdsByInventoryReference) method to create individual ads for the campaign, or the [bulkCreateAdsByInventoryReference](https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByInventoryReference) method to create ads in bulk. Campaign recommendations and suggestions ---------------------------------------- The eBay APIs allow you to retrieve recommendations and suggestions that you can use to configure your campaigns, such as listings, ad rates, and bid percentages, and it outlines the system limitations for creating campaigns:  The [Recommendation API](https://developer.ebay.com/api-docs/sell/recommendation/static/overview.html) offers recommendations on which listings will perform the best in a Promoted Listings campaign, as well as returning the trending bid percentage for the listings you want to promote. Note that you cannot use the Recommendation API with inventory reference IDs (the API currently works with only listing IDs). **Note:** The **Recommendation API** methods only apply to the general strategy campaigns that use the Cost Per Sale (CPS) funding model; they do not apply to priority strategy campaigns that use the Cost Per Click (CPC) funding model. ### Using the recommendation API to help configure campaigns The [findListingRecommendations](https://developer.ebay.com/api-docs/sell/recommendation/resources/listing_recommendation/methods/findListingRecommendations "findListingRecommendations API Reference") method returns the following response body for each returned **listingId**: "listingRecommendations": \[{\ "**listingId**": "{listingId}",\ "marketing": {\ "ad": {\ "**bidPercentages**": \[{\ "basis": "TRENDING",\ "value": "{trendingAdRate}"\ }\],\ "**promoteWithAd**": "\[RECOMMENDED || UNDETERMINED\]"\ },\ "message": "string"\ }\ }\] The above response body shows that **findListingRecommendations** returns two different recommendations for currently listed items: * **promoteWithAd** – This response field indicates whether or not eBay recommends you place the associated listing in a Promoted Listings ad campaign. * **bidPercentages** – Also known as the "ad rate," the bid percentage field provides the current trending bid percentage of similarly promoted items in the marketplace. #### The promoteWithAd indicator When and how **promoteWithAd** is returned depends on how you structure your **findListingRecommendations** request. If returned, **promoteWithAd** returns either `RECOMMENDED` or `UNDETERMINED` for any specific listing. `RECOMMENDED` means that by eBay's calculations, the listing has highest potential of benefiting from being included in a Promoted Listings ad campaign. This recommendation is determined by reviewing current marketplace trends, such as buyer demand and the competition in the item’s category, and eBay suggests you promote the `RECOMMENDED` listings first, although you can promote any of your eligible listings for greater visibility. `UNDETERMINED` means eBay cannot determine the level of advantage gained by including the associated listing in an ad campaign. **Tip:** eBay cannot determine the **promoteWithAd** value for listings that are currently being promoted. To see the **promoteWithAd** value for a specific listing, first remove the listing from all ad campaigns. #### The bidPercentage value The **bidPercentages** field returns the current `TRENDING` "ad rate," which is calculated by averaging the ad rates of the listings that recently sold within the same category as the associated listing. While eBay does not recommend the returned trending bid percentage as the optimum ad rate for your listing, you should consider this trending rate as a guide for how you set your own **bidPercentage** values. #### Structuring a findListingRecommendations request You can structure your **findListingRecommendations** requests to return recommendations for all of a seller's listings, or just the recommendations for a specific subset of the seller's listings. In either case, the response is _paginated_ to account for multiple returned listing IDs. ##### Getting recommendations for all of a seller's listings If you do not include a request payload when you call **findListingRecommendations**, _all_ of a seller's currently listed items are evaluated for recommendations. However, when all of a seller's listed items are considered, the request returns only those listings where **promoteWithAd** is set to `RECOMMENDED`. If the **promoteWithAd** value is returned, the currently trending ad rate for each listing ID is also returned in the **bidPercentages** container. **Note:** **promoteWithAd** values are not calculated for listing IDs that are part of an existing ad campaign. Because calling **findListingRecommendations** in this manner (without a payload) returns only those listings whose **promoteWithAd** value is set to `RECOMMENDED`, the response does not include recommendations for listings already in a campaign. To see the trending ad rates for listings currently in a campaign, specify the listing IDs in the body of your call to **findListingRecommendations**. For this request, set up the request headers then call the endpoint. All the query parameters are optional. If set, **filter** must be set to `filter=recommendationTypes:{AD}`, and you can use the **limit** and **offest** parameters to control the pagination of the response: **POST https://api.ebay.com/sell/recommendation/v1/find**? filter=string& limit=integer& offset=integer **Tip:** This is the best way to see which of your current listings are prime for being included in a Promoted Listings campaign. ##### Getting recommendations for a select set of listings You can call **findListingRecommendations** with a set of up to 500 specific listing IDs. Structure your request with a payload similar to the following example, where you separate each **listingId** value you specify with a comma: { "listingIds": \[\ "260011362444", "260011362546", "260011362826"\ \] } With a few exceptions (such as the listing is already in a Promoted Listings campaign or the listing is not eligible to be in a campaign), eBay returns recommendations for all supplied **listingId** values. And again, the trending bid percentage is included with each returned ID. **Tip:** This is the best way to see the trending ad rate for listings you are considering to promote. The **promoteWithAd** value of either `RECOMMENDED` or `UNDETERMINED` is also returned for all listings, except for those listings that are currently being promoted. In cases where a listing ID is already being promoted, the **bidPercentages** container is returned, but the **promoteWithAd** field is not returned. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # AdRateStrategyEnum: eBay Marketing API | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/sell/marketing/types/pls:AdRateStrategyEnum#mainContent) An enumerated type that indicates the ad rate strategy for an existing Promoted Listings Standard (PLS) ad campaign. Types that use AdRateStrategyEnum --------------------------------- [FundingStrategy](https://developer.ebay.com/api-docs/sell/marketing/types/pls:FundingStrategy) [UpdateAdrateStrategyRequest](https://developer.ebay.com/api-docs/sell/marketing/types/pls:UpdateAdrateStrategyRequest) Calls that use AdRateStrategyEnum --------------------------------- POST [/ad\_campaign/{campaign\_id}/clone](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/cloneCampaign) POST [/ad\_campaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign) GET [/ad\_campaign/find\_campaign\_by\_ad\_reference](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/findCampaignByAdReference) GET [/ad\_campaign/{campaign\_id}](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaign) GET [/ad\_campaign/get\_campaign\_by\_name](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaignByName) GET [/ad\_campaign](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns) POST [/ad\_campaign/{campaign\_id}/update\_ad\_rate\_strategy](https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/updateAdRateStrategy) Enumerations ------------ Value Description DYNAMIC This enum value indicates that the ad rate is dynamically chosen for campaigns that use this ad rate strategy. FIXED This enum value indicates that the ad rate is fixed for campaigns that use this ad rate strategy. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Category ID mapping | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/map-category-ids.html#mainContent) The ID for a category in which you list an item can change. eBay might split categories to help users distinguish between items more easily or combine multiple categories to make very similar items easier to find. (In some cases, eBay may allow a category that is rarely used to expire without being combined with other categories.) The figure below shows an example of three leaf categories (i.e., _Frames_, _Cannondale_, and _Specialized_,) that were combined into a single leaf category (_Complete Bikes & Frames_). ![Old categories combined into active categories](https://developer.ebay.com/api-docs/res/Resources/images/tug/category-mappings.png) _Old categories combined into an active category_ A common way to determine whether a category ID is current is to make sure your locally stored category metadata is current and then verify that the ID exists in the current metadata. Refer to [Category Versioning](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/category-versioning.html) for complete information. To be valid in listing requests, the category ID also must be a leaf category. In certain cases, even a recently-created listing can have a deprecated category ID. Refer to [Category Requirements](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/category-requirements.html) for some typical examples. If a seller wants to list an item that was defined with an old category ID, you can handle the situation in different ways: * Allow eBay to attempt to update the category for you. This approach may be more convenient for sellers who are listing hundreds of items at once. In some cases, invalid data may be dropped from the listing, but the listing will still be submitted successfully. Refer to [Automatic Remapping](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/map-auto-remap.html) for additional information about this approach. * Update the category information on the client side. This approach may be more convenient for sellers who use listing features that are highly dependent on the category (e.g., reserve prices,) or who prefer not to allow eBay to drop invalid data. Refer to [Client-Side Mapping](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/map-client-side.html) for additional information. Mapping item specifics ---------------------- If older categories have been combined into a more general category, the original differentiation that the old categories provided may be lost. For example, the difference between "Cannondale" and "Specialized" would no longer be evident from the new "Complete Bikes & Frames" category. eBay may offer **Item Specifics** that convey the same details as the original categories. In such cases, eBay may provide the ability to pre-fill these Item Specifics based on the old category. The figure below illustrates an example of how eBay uses old leaf categories (e.g., Cannondale and Specialized,) to pre-fill corresponding Item Specifics (`Brand=Cannondale` and `Brand=Specialized`). ![Item specifics pre-filled based on old categories](https://developer.ebay.com/api-docs/res/Resources/images/tug/category-based-attributes.png) _Figure: Item specifics pre-filled based on old categories_ If a seller wants to include Item Specifics that correspond to old category IDs, the situation may be handled in different ways: * Allow eBay to attempt to pre-fill the Item Specifics based on the category (or categories). This approach may be more convenient for sellers who are listing hundreds of items at once. Refer to [Automatic Remapping](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/map-auto-remap.html) for additional information about this approach. * Update the Item Specifics information on the client side. This approach may be more convenient for sellers who want more control over the Item Specifics that are selected. Refer to [Client-side Mapping](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/map-client-side.html) for additional information. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Qualifications to revise an item | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-qualifications.html#mainContent) To revise an item, the following conditions must be satisfied: * The requester is the seller. * The item listing must still be active. It is not possible to revise an ended item listing. However, it might be eligible to be relisted with property changes. Refer to [Relist items](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/relist-item.html) for complete information. Item changes allowed during revisions ------------------------------------- Making changes to a listing using [ReviseItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseItem.html) or [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html) is subject to a few restrictions, including whether or not the listing has any bids or Best Offers, and whether the change is being attempted on an auction listing within twelve hours of end time. In general, you cannot change the listing format (e.g., auction vs. fixed-price,) of any listing. For a complete list of what can be changed for auction, fixed-price, and classified ad listings, refer to [What changes can I make?](https://www.ebay.com/help/selling/listings/revising-listing?id=4356#section1) For a list of the fields that can be modified in the API, refer to the [ReviseItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseItem.html#Input) and [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html#Input) reference documentation. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Revise prices | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/revise-prices.html#mainContent) When changing a, item's price, consider using [ReviseInventoryStatus](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html) rather than [ReviseItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseItem.html) or [ReviseFixedPriceItem](https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/ReviseFixedPriceItem.html) . Reduce a reserve price ---------------------- Sellers can lower Reserve Prices for listings on the US eBay marketplace, eBay UK marketplace, or eBay Motors marketplace even after bids have been placed to increase the likeliness of their items selling. To determine whether a marketplace or category supports this capability, call [GetCategories](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html) and check the values for both the [ReduceReserveAllowed](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html#Response.ReduceReserveAllowed) and [Override Reduce Reserve Allowed (ORRA)](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategories.html#Response.CategoryArray.Category.ORRA) fields. Refer to [Reserve Prices](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/reserve-prices.html) for additional information. Depending on the marketplace and category, you may also need to call [GetCategoryFeatures](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html) and review the value for [MinimumReservePrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetCategoryFeatures.html#Response.Category.MinimumReservePrice) . When a category supports lowering the reserve, a seller can adjust the reserve price through the Revise Your Item process or by using [ReviseItem](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html) , as long as no bids have exceeded the original reserve price. For most categories, this is only allowed when 12 or more hours remain for the listing. The reserve price can be reduced downwards to a minimum of one bid increment above the listing's current price. Once the reserve has been lowered, bidders are notified of the change via email, My eBay, and the listing itself. If the item _has no bids_, set the value for [Item.ReservePrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ReservePrice) to any value within the following range: * Lowest: 0.0 (if the category supports removing the reserve) * Highest: [Item.ReservePrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ReservePrice) - [Item.SellingStatus.BidIncrement](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.BidIncrement) If the item _has bids_, set [Item.ReservePrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ReservePrice) to a value within the following range: * Lowest: [Item.SellingStatus.CurrentPrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.CurrentPrice) + [Item.SellingStatus.BidIncrement](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.BidIncrement) * Highest: [Item.ReservePrice](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/ReviseItem.html#Request.Item.ReservePrice) - [Item.SellingStatus.BidIncrement](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/GetItem.html#Response.Item.SellingStatus.BidIncrement) If the new reserve price is lower than the high bidder's proxy bid, the proxy bid is also reduced to one increment below the new bid price, to prevent bidders from unexpectedly becoming winning bidders when their prior bid had not yet met the Reserve price. For example, imagine a US listing starts at $1 with a reserve of $100, and the first bidder bids $75. The current price stays at $1 since the bid didn't meet the reserve. Then, if the seller then reduces reserve to $50, the bidder's proxy bid is reduced to one bid increment below $50. For a chance at becoming a winning bidder, the bidder would need to place another bid. No credit is given for Reserve Price Fee if the listing is revised to reduce the Reserve Price. For additional information about lowering the Reserve Price on Motors, refer to [Revise a Listing](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/ebay-motors-revise-listing.html) . #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Listing title | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/listing-title.html#mainContent) A title is required for all listings. A listing's title summarizes what the item is and is displayed on all pages (e.g., View Item page, search results, etc.) A listing title should have the intent of drawing the attention of potential buyers interested in that type of item. **Argument:** [Item.Title](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Title) **Maximum length:** 80 characters Subtitle -------- For an additional fee, sellers can include a subtitle which is also displayed on the View Item page and in search results. Refer to [Selling fees: Fees for optional listing upgrades](https://www.ebay.com/help/selling/fees-credits-invoices/selling-fees?id=4822#section5) for additional information. **Argument:** [Item.SubTitle](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.SubTitle) **Maximum length:** 55 characters #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # CustomerServiceMetricsFilterCriteria: eBay Feed API | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/sell/feed/types/api:CustomerServiceMetricsFilterCriteria#mainContent) A complex data type that filters data for report creation. See **CustomerServiceMetricsFilterCriteria** for fields and descriptions. Types that use CustomerServiceMetricsFilterCriteria --------------------------------------------------- [CreateServiceMetricsTaskRequest](https://developer.ebay.com/api-docs/sell/feed/types/api:CreateServiceMetricsTaskRequest) [ServiceMetricsTask](https://developer.ebay.com/api-docs/sell/feed/types/api:ServiceMetricsTask) Calls that use CustomerServiceMetricsFilterCriteria --------------------------------------------------- POST [/customer\_service\_metric\_task](https://developer.ebay.com/api-docs/sell/feed/resources/customer_service_metric_task/methods/createCustomerServiceMetricTask) GET [/customer\_service\_metric\_task/{task\_id}](https://developer.ebay.com/api-docs/sell/feed/resources/customer_service_metric_task/methods/getCustomerServiceMetricTask) GET [/customer\_service\_metric\_task](https://developer.ebay.com/api-docs/sell/feed/resources/customer_service_metric_task/methods/getCustomerServiceMetricTasks) Fields ------ Field Type Description customerServiceMetricType [CustomerServiceMetricTypeEnum](https://developer.ebay.com/api-docs/sell/feed/types/api:CustomerServiceMetricTypeEnum) An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance. See [CustomerServiceMetricTypeEnum](https://developer.ebay.com/api-docs/sell/feed/types/api:CustomerServiceMetricTypeEnum) for values. evaluationMarketplaceId [MarketplaceIdEnum](https://developer.ebay.com/api-docs/sell/feed/types/bas:MarketplaceIdEnum) An enumeration value that specifies the eBay marketplace where the evaluation occurs. See [MarketplaceIdEnum](https://developer.ebay.com/api-docs/sell/feed/types/bas:MarketplaceIdEnum) for values. listingCategories array of [string](https://developer.ebay.com/api-docs/static/simple-types.html) A list of listing category IDs on which the service metric is measured. A seller can use one or more L1 (top-level) eBay categories to get metrics specific to those L1 categories. The Category IDs for each L1 category are required. Category ID values for L1 categories can be retrieved using the Taxonomy API. **Note:** Pass this attribute to narrow down your filter results for the `ITEM_NOT_AS_DESCRIBED` customerServiceMetricType. Supported categories include: `primary(L1) category Id` shippingRegions array of [ShippingRegionTypeEnum](https://developer.ebay.com/api-docs/sell/feed/types/api:ShippingRegionTypeEnum) A list of shipping region enumeration values on which the service metric is measured. This comma delimited array allows the seller to customize the report to focus on domestic or international shipping. **Note:** Pass this attribute to narrow down your filter results for the `ITEM_NOT_RECEIVED` customerServiceMetricType. Supported categories include: `primary(L1) category Id` See **ShippingRegionTypeEnum** for values #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Amount - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) Amount ====== This type is used to expressed dollar amounts and the currency used. Types that use Amount: [ActualRefund](https://developer.ebay.com/devzone/post-order/types/ActualRefund.html) , [ActualRefundDetail](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetail.html) , [ActualRefundDetailType](https://developer.ebay.com/devzone/post-order/types/ActualRefundDetailType.html) , [AppealDetails](https://developer.ebay.com/devzone/post-order/types/AppealDetails.html) , [CancelDetail](https://developer.ebay.com/devzone/post-order/types/CancelDetail.html) , [CancelSummary](https://developer.ebay.com/devzone/post-order/types/CancelSummary.html) , [CaseDetails](https://developer.ebay.com/devzone/post-order/types/CaseDetails.html) , [CaseDetailsResponse](https://developer.ebay.com/devzone/post-order/types/CaseDetailsResponse.html) , [CaseSummaryType](https://developer.ebay.com/devzone/post-order/types/CaseSummaryType.html) , [DecideReturnRequest](https://developer.ebay.com/devzone/post-order/types/DecideReturnRequest.html) , [EstimatedRefundType](https://developer.ebay.com/devzone/post-order/types/EstimatedRefundType.html) , [InquiryDetails](https://developer.ebay.com/devzone/post-order/types/InquiryDetails.html) , [InquiryDetailsResponse](https://developer.ebay.com/devzone/post-order/types/InquiryDetailsResponse.html) , [InquirySummaryType](https://developer.ebay.com/devzone/post-order/types/InquirySummaryType.html) , [ItemDetails](https://developer.ebay.com/devzone/post-order/types/ItemDetails.html) , [ItemDetailType](https://developer.ebay.com/devzone/post-order/types/ItemDetailType.html) , [ItemizedRefundDetailType](https://developer.ebay.com/devzone/post-order/types/ItemizedRefundDetailType.html) , [ItemizedReturnShippingCostType](https://developer.ebay.com/devzone/post-order/types/ItemizedReturnShippingCostType.html) , [MoneyMovementDetailType](https://developer.ebay.com/devzone/post-order/types/MoneyMovementDetailType.html) , [MoneyMovementEntry](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html) , [PayoutRecoupInfo](https://developer.ebay.com/devzone/post-order/types/PayoutRecoupInfo.html) , [ProvideLabelRequest](https://developer.ebay.com/devzone/post-order/types/ProvideLabelRequest.html) , [RefundAmounts](https://developer.ebay.com/devzone/post-order/types/RefundAmounts.html) , [RefundDeductionType](https://developer.ebay.com/devzone/post-order/types/RefundDeductionType.html) , [RefundDetailType](https://developer.ebay.com/devzone/post-order/types/RefundDetailType.html) , [RefundFundingType](https://developer.ebay.com/devzone/post-order/types/RefundFundingType.html) , [ResponseHistoryAttributesType](https://developer.ebay.com/devzone/post-order/types/ResponseHistoryAttributesType.html) , [ReturnPayoutRecoupInfoType](https://developer.ebay.com/devzone/post-order/types/ReturnPayoutRecoupInfoType.html) , [ReturnShippingCostDetailType](https://developer.ebay.com/devzone/post-order/types/ReturnShippingCostDetailType.html) , [TotalRefundAmountType](https://developer.ebay.com/devzone/post-order/types/TotalRefundAmountType.html) Calls that use Amount: [/post-order/v2/cancellation/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation_search__get.html) , [/post-order/v2/cancellation/{cancelId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_cancellation-cancelid__get.html) , [/post-order/v2/casemanagement/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement_search__get.html) , [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry_search__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) , [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) , [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) , [/post-order/v2/return/{returnId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid__get.html) , [/post-order/v2/return/{returnId}/add\_shipping\_label POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) , [/post-order/v2/return/{returnId}/decide POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_decide__post.html) , [/post-order/v2/return/{returnId}/issue\_refund POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_issue_refund__post.html) Fields ------ [convertedFromCurrency](https://developer.ebay.com/devzone/post-order/types/Amount.html#convertedFromCurrency) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [convertedFromValue](https://developer.ebay.com/devzone/post-order/types/Amount.html#convertedFromValue) ( _[number](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#number) _ ) [currency](https://developer.ebay.com/devzone/post-order/types/Amount.html#currency) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [exchangeRate](https://developer.ebay.com/devzone/post-order/types/Amount.html#exchangeRate) ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [value](https://developer.ebay.com/devzone/post-order/types/Amount.html#value) ( _[number](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#number) _ ) convertedFromCurrency ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The three-letter [ISO 4217](https://developer.ebay.com/devzone/post-order/https://www.iso.org/iso-4217-currency-codes.html) code representing the currency of the amount in the **convertedFromValue** field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the [CurrencyCodeEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CurrencyCodeEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#convertedFromCurrency) to learn which calls use convertedFromCurrency. convertedFromValue ( _[number](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#number) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The monetary amount before any conversion is performed, in the currency specified by the **convertedFromCurrency** field. This value is the pre-conversion amount. The **value** field contains the converted amount of this value, in the currency specified by the **currency** field. If no conversion occurs, this should not be populated. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#convertedFromValue) to learn which calls use convertedFromValue. currency ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) A three-letter [ISO 4217](https://developer.ebay.com/devzone/post-order/https://www.iso.org/iso-4217-currency-codes.html) code that indicates the currency of the amount in the **value** field. This field is always returned with any container using **Amount** type. The list of three-digit currency codes that may be returned in this field are defined in the [CurrencyCodeEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/CurrencyCodeEnum.html) type definition. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#currency) to learn which calls use currency. exchangeRate ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field shows the exchange rate used to convert the amount in the **convertedFromValue** field to amount in the **value** field. This field is only returned when eBay does a currency version. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#exchangeRate) to learn which calls use exchangeRate. value ( _[number](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#number) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The monetary amount, in the currency specified by the **currency** field. This field is always returned with any container using **Amount** type. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#value) to learn which calls use value. --- # Item description | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/item-description.html#mainContent) The item description, which must be provided by the seller using the [Item.Description](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Description) field, informs prospective buyers what the item is, and what makes it unique and appealing. The listing description should highlight/cover the most essential product aspects, but does not need to cover all aspects, since this detailed information can be seen in the **Item specifics** section of the View Item page. For example, a listing description for an iPhone might touch on the model number, color, storage capacity, and network, but all other product aspects can be isolated and viewed in the **Item specifics** section. **Argument:** [Item.Description](https://developer.ebay.com/devzone/xml/docs/Reference/eBay/AddItem.html#Request.Item.Description) **Maximum length:** * Most marketplaces: 500,000 characters * Mobile devices: 800 characters Refer to [Mobile Devices](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/mobile.html) for additional information. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # Counteroffers | eBay Developers Program [Skip to main content](https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/best-offers-counter.html#mainContent) If a seller makes a counteroffer, the buyer can accept or reject the counteroffer, or propose a counteroffer to the seller's counteroffer (if eligible). A counteroffer will expire if the other party does not act on that counteroffer within 48 hours. The following are the rules and restrictions for counteroffers: * For buyers, counteroffers count against the maximum number of Best Offers allowed per item, per buyer, based on the category configuration. If the marketplace and category allow multiple Best Offers per item, the buyer can make a counteroffer to the seller's counteroffer. This can continue until the buyer makes the maximum allowed number of Best Offers. * When a buyer declines a counteroffer, it does not count against the buyer's maximum number of Best Offers. * Sellers can make counteroffers only to buyers who have active offers or counteroffers. * If the seller has an active counteroffer out to the buyer, the seller cannot send another counteroffer to the buyer until the buyer counters back to the seller. * Sellers cannot make counteroffers above the fixed-price for the item. * If the buyer declines a seller's counteroffer, the seller cannot initiate a new counteroffer to the buyer unless and until the buyer counters back. * When a counteroffer is submitted, all previous offers are declined. That is, after extending a counteroffer to a buyer, the seller will not be able to accept a previous Best Offer from that buyer for that item. Similarly, after sending a counteroffer back to the seller, the buyer cannot accept a previous counteroffer from the seller. * Counteroffers, like Best Offers, expire in 48 hours for both buyers and sellers. When the seller sends a buyer a counteroffer, the buyer's original Best Offer time is cleared. The buyer now has 48 hours to accept the new offer from the seller. * Sellers are able to counteroffer with multiple buyers simultaneously. #### Thank you for helping us to improve the eBay developer program. While we are not able to respond directly to your comments, we will carefully review them to improve your experience with eBay developer program! If you need help, contact [Developer Technical Support](https://developer.ebay.com/my/support/tickets) . --- # findProducts - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/Product/ReleaseNotes.html) findProducts ============ Use this call to find the products in a specific category. You can refine search results using optional catalog property name-value pairs and/or a keyword query. If you specify keywords without specifying a category, you can search for products across all catalog-enabled categories on a site. Property Filters ---------------- You must specify a category to use property filters. Use **getProductSearchNames** and **getProductSearchValues** to retrieve searchable property names and values for the given category. For example, to retrieve all products in a parts category that are front brake discs manufactured by Brembo, you would call **getProductSearchNames** to identify searchable properties for the category, such as "Supplier Name" and "Type." Next, you would call **getProductSearchValues** to get the values associated with a property. **Note:** We recommend you retrieve and maintain the product search metadata locally. Use **getProductSearchValuesBulk** to retrieve all applicable property values for up to 10 property names. You can use **getProductSearchDataVersion** to check for updates to the metadata. The following filter will limit the search results to Brembo brake parts for the front of a vehicle: Supplier Name Brembo Type Front Brake Pads/Shoes, Rotors, Drums Input ----- See also [Samples](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#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). <[productSearch](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch) \> [ProductRequest](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductRequest.html) <[categoryId](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.categoryId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[dataset](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.dataset) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[datasetPropertyName](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.datasetPropertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[invocationId](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.invocationId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[keywords](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.keywords) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[paginationInput](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.paginationInput) \> [PaginationInput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationInput.html) <[entriesPerPage](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.paginationInput.entriesPerPage) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.paginationInput.pageNumber) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[productStatusFilter](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter) \> [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[propertyFilter](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[sortOrder](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.sortOrder) \> [SortOrder](https://developer.ebay.com/Devzone/Product/CallRef/types/SortOrder.html) <[order](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.sortOrder.order) \> [OrderType](https://developer.ebay.com/Devzone/Product/CallRef/types/OrderType.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Request.productSearch.sortOrder.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Argument | Type | Occurrence | Meaning | | --- | --- | --- | --- | | | | | | | --- | --- | --- | --- | | **productSearch** | [ProductRequest](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductRequest.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..10\] | User can findproducts for one catalog at a time or batch up to 10 catalogs. | | productSearch.**categoryId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled.

Your request must contain categoryId and/or keywords.
**Max length:** 10.

See:
    [GetCategoryFeatures](http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html)
for information to identify compatibility-enabled categories. | | productSearch.**dataset** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will define what are properties that will be returned for this catelog-enabled category.

**Dataset values:**

DisplayableProductDetails

Properies for use in a user interface to describe products.

DisplayableSearchResults

Properties for use in results for product searches.

Searchable

Properties for use in searches.

Sortable

Properties that are suitable for sorting.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time.
**Default:** Searchable. | | productSearch
  .**datasetPropertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. | | productSearch.**invocationId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Required | A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed.

If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number . | | productSearch.**keywords** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint.

Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported.

Your request must contain categoryId and/or keywords.
**Max length:** 350. The maximum length for a single word is 98. | | productSearch.**paginationInput** | [PaginationInput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationInput.html) | Optional | Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

**Note:** No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). | | productSearch.paginationInput
  .**entriesPerPage** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used.
**Max:** 100. **Default:** 100. | | productSearch.paginationInput
  .**pageNumber** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return.
**Max:** 100. **Default:** 1. | | productSearch
  .**productStatusFilter** | [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) | Optional | Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com. | | productSearch
  .productStatusFilter
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in product review flows.
**Default:** false. | | productSearch
  .productStatusFilter
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on eBay.
**Default:** false. | | productSearch
  .productStatusFilter
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on half.com.
**Default:** false. | | productSearch.**propertyFilter** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | One or more name-value pairs that describe the product. | | productSearch.propertyFilter
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | productSearch.propertyFilter
  .**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | productSearch.propertyFilter
  .value.**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Optional | For numeric value type. | | productSearch.propertyFilter
  .value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Optional | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | productSearch.propertyFilter
  .value.number.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | productSearch.propertyFilter
  .value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Optional | For string value type. | | productSearch.propertyFilter
  .value.text.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | A string value. | | productSearch.propertyFilter
  .value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Optional | For URL value type. | | productSearch.propertyFilter
  .value.URL.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Optional | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearch.**sortOrder** | [SortOrder](https://developer.ebay.com/Devzone/Product/CallRef/types/SortOrder.html) | Optional | Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. | | productSearch.sortOrder.**order** | [OrderType](https://developer.ebay.com/Devzone/Product/CallRef/types/OrderType.html) | Optional | Order of the sort, either Ascending or Descending.
**Default:** Descending.

**Applicable values**:


Ascending

The results will be sorted by the specified attribute in ascending (low to high) order.

Descending

The results will be sorted by the specified attribute in descending (high to low) order. | | productSearch.sortOrder
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | Output can be sorted by one or more property names. You can look these values up using the **getProductSearchNames** call in the Product Metadata API.
**Max length:** 100. | Output ------ See also [Samples](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#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). <[productSearchResult](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult) \> [ProductResponse](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductResponse.html) <[invocationId](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.invocationId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[paginationOutput](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput) \> [PaginationOutput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationOutput.html) <[entriesPerPage](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.entriesPerPage) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.pageNumber) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[totalEntries](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.totalEntries) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[totalPages](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.totalPages) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[products](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products) \> [Product](https://developer.ebay.com/Devzone/Product/CallRef/types/Product.html) <[compatibilityCount](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.compatibilityCount) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[notes](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes) \> [Notes](https://developer.ebay.com/Devzone/Product/CallRef/types/Notes.html) <[noteDetails](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[productDetails](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[productIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.EAN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.ePID) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.ISBN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.productId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.UPC) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productStatus](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus) \> [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[stockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL) \> [StockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/types/StockPhotoURL.html) <[standard](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.standard) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.standard.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[thumbnail](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.thumbnail) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.thumbnail.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[type](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.productSearchResult.products.type) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ack](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.ack) \> [AckValue](https://developer.ebay.com/Devzone/Product/CallRef/types/AckValue.html) <[errorMessage](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage) \> [ErrorMessage](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorMessage.html) <[error](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error) \> [ErrorData](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorData.html) <[category](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.category) \> [ErrorCategory](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorCategory.html) <[domain](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.domain) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[errorId](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.errorId) \> [long](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#long) <[exceptionId](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.exceptionId) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[message](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.message) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[parameter](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.parameter) name\="[string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) "> [ErrorParameter](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) ) <[severity](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.severity) \> [ErrorSeverity](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorSeverity.html) <[subdomain](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.errorMessage.error.subdomain) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[timestamp](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.timestamp) \> [dateTime](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#dateTime) <[version](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#Response.version) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Return Value | Type | Occurrence | Meaning | | --- | --- | --- | --- | **Call-specific Output Fields** [\[Jump to standard fields\]](https://developer.ebay.com/Devzone/Product/CallRef/findProducts.html#stdOutputFields) | | | | | | --- | --- | --- | --- | | **productSearchResult** | [ProductResponse](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductResponse.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Container for the products that matched the search criteria. The data for each product is returned in individual containers, if any matches were found. | | productSearchResult
  .**invocationId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A unique identifer for a given product response, corresponding to a specific product request. | | productSearchResult
  .**paginationOutput** | [PaginationOutput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationOutput.html) | Conditionally | Indicates the pagination of the result set. Child elements indicate the maximum number of productSearchResult nodes returned per response and which page of data has been returned. | | productSearchResult
  .paginationOutput
  .**entriesPerPage** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. | | productSearchResult
  .paginationOutput.**pageNumber** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data.

This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. | | productSearchResult
  .paginationOutput.**totalEntries** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of entries found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any entries that match the search criteria. | | productSearchResult
  .paginationOutput.**totalPages** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any entries that match the search criteria. | | productSearchResult.**products** | [Product](https://developer.ebay.com/Devzone/Product/CallRef/types/Product.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Container for multiple products. | | productSearchResult.products
  .**compatibilityCount** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | **Coming soon.** The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. | | productSearchResult.products
  .**notes** | [Notes](https://developer.ebay.com/Devzone/Product/CallRef/types/Notes.html) | Conditionally | Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. | | productSearchResult.products
  .notes.**noteDetails** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Additional comments about the product in the form of name-value pairs. | | productSearchResult.products
  .notes.noteDetails
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | productSearchResult.products
  .notes.noteDetails.**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | productSearchResult.products
  .notes.noteDetails.value
  .**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | productSearchResult.products
  .notes.noteDetails.value
  .number.**unitOfMeasurement** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | productSearchResult.products
  .notes.noteDetails.value
  .number.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | productSearchResult.products
  .notes.noteDetails.value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | productSearchResult.products
  .notes.noteDetails.value.text
  .**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | productSearchResult.products
  .notes.noteDetails.value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | productSearchResult.products
  .notes.noteDetails.value.URL
  .**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .**productDetails** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about the product in the form of name-value pairs. | | productSearchResult.products
  .productDetails.**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | productSearchResult.products
  .productDetails.**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | productSearchResult.products
  .productDetails.value.**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | productSearchResult.products
  .productDetails.value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | productSearchResult.products
  .productDetails.value.number
  .**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | productSearchResult.products
  .productDetails.value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | productSearchResult.products
  .productDetails.value.text
  .**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | productSearchResult.products
  .productDetails.value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | productSearchResult.products
  .productDetails.value.URL
  .**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) | Conditionally | The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. | | productSearchResult.products
  .productIdentifier.**EAN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productSearchResult.products
  .productIdentifier.**ePID** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | productSearchResult.products
  .productIdentifier.**ISBN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productSearchResult.products
  .productIdentifier.**productId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | productSearchResult.products
  .productIdentifier.**UPC** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID.
**Max length:** 12. | | productSearchResult.products
  .**productStatus** | [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) | Conditionally | Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. | | productSearchResult.products
  .productStatus
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in product review flows. | | productSearchResult.products
  .productStatus
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on eBay. | | productSearchResult.products
  .productStatus
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on half.com. | | productSearchResult.products
  .**stockPhotoURL** | [StockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/types/StockPhotoURL.html) | Conditionally | Thumbnail and standard stockphoto URLs. | | productSearchResult.products
  .stockPhotoURL.**standard** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | productSearchResult.products
  .stockPhotoURL.standard.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .stockPhotoURL.**thumbnail** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | productSearchResult.products
  .stockPhotoURL.thumbnail.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .**type** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.

**Allowed values:**

Head

The product is the the head of the product family.

Member

The product is a variant of the head product. | **Standard Output Fields**   | | | | | | --- | --- | --- | --- | | **ack** | [AckValue](https://developer.ebay.com/Devzone/Product/CallRef/types/AckValue.html) | Always | Indicates whether or not errors or warnings were generated during the processing of the request.

**Applicable values**:


Failure

The request was processed successfully, but something occurred that may affect your application or the user.

PartialFailure

The request that triggered the error was processed successfully but with some warnings.

Success

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.

Warning

The request that triggered the error was processed successfully but with some warnings.


Code so that your app gracefully handles any future changes to this list. | | **errorMessage** | [ErrorMessage](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorMessage.html) | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. | | errorMessage.**error** | [ErrorData](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorData.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about a single error. | | errorMessage.error.**category** | [ErrorCategory](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorCategory.html) | 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 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.


Code so that your app gracefully handles any future changes to this list. | | errorMessage.error.**domain** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the domain in which the error occurred.

**domain values:**

Marketplace

A business or validation error occurred in the service.

SOA

An exception occurred in the Service Oriented Architecture (SOA) framework. | | errorMessage.error.**errorId** | [long](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unique identifier for an exception associated with an error. | | errorMessage.error.**message** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A detailed description of the condition that caused in the error. | | errorMessage.error.**parameter** | [ErrorParameter](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorParameter.html)
([string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string)
) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorSeverity.html) | 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, re-send 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 case, 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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the subdomain in which the error occurred.

**subdomain values:**

MarketplaceCatalog

The error is specific to the Marketplace Catalog subdomain.

MarketplaceCommon

The error is common to all Marketplace services. | | **timestamp** | [dateTime](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#dateTime) | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. | | **version** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Always | The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

**Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. | Samples ------- Code samples not yet added for this call's documentation. Change History -------------- | Change Date | Description | | --- | --- | | **1.1.0**
11/3/2009 | * (added) New call. | --- # getProductCompatibilities - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/Product/ReleaseNotes.html) getProductCompatibilities ========================= **Note:** This call has been deprecated and will be decommissioned on April 27th, 2026. Users are recommended to migrate to the [getProductCompatibilities](https://developer.ebay.com/api-docs/sell/metadata/resources/compatibilities/methods/getProductCompatibilities) method of the **Metadata API**. This call retrieves all available item compatibility details for the specified product. Item compatibility properties are returned as name-value pairs. The request requires a product identifier, either an eBay-specific identifier (e.g., ePID) or an external identifier, such as a Universal Part Code (UPC). Use this call to get complete compatibility details for products you find using **findProductsByCompatibility**. For example, if you searched for parts that fit a Honda Accord, you can use this call to see the years, engine, and trim for which the part is compatible, as well as any other compatibilities for the product. Use either **dataset** or **datasetPropertyName** to restrict the name-value pairs returned in the response. The **dataset** value specifies the type of compatibility properties you want back. For example, if you specify Searchable, your compatibility details will be contain properties that can be used to search for products, such as Make and Model. Some compatibility properties, such as FitmentComments, are not intended for product searches. **Note:** Parts Compatibility is supported in limited Parts & Accessories categories, for the eBay US Motors (100), UK (3), AU (15) and DE (77) sites only. Input ----- See also [Samples](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#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). <[applicationPropertyFilter](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[dataset](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.dataset) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[datasetPropertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.datasetPropertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[disabledProductFilter](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter) \> [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[paginationInput](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.paginationInput) \> [PaginationInput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationInput.html) <[entriesPerPage](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.paginationInput.entriesPerPage) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.paginationInput.pageNumber) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[productIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.EAN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.ePID) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.ISBN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.productId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.UPC) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[sortOrder](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder) \> [CompatibilitySort](https://developer.ebay.com/Devzone/Product/CallRef/types/CompatibilitySort.html) <[sortOrder](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortOrder) \> [SortOrder](https://developer.ebay.com/Devzone/Product/CallRef/types/SortOrder.html) <[order](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortOrder.order) \> [OrderType](https://developer.ebay.com/Devzone/Product/CallRef/types/OrderType.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortOrder.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[sortPriority](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortPriority) \> [SortPriority](https://developer.ebay.com/Devzone/Product/CallRef/types/SortPriority.html) | Argument | Type | Occurrence | Meaning | | --- | --- | --- | --- | | | | | | | --- | --- | --- | --- | | **applicationPropertyFilter** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will contain the property name value pairs of the application, such as a particular vehicle make and model. Application property filters are specified as name-value pairs. | | applicationPropertyFilter
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | applicationPropertyFilter
  .**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | applicationPropertyFilter
  .value.**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Optional | For numeric value type. | | applicationPropertyFilter
  .value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Optional | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | applicationPropertyFilter
  .value.number.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | applicationPropertyFilter
  .value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Optional | For string value type. | | applicationPropertyFilter
  .value.text.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | A string value. | | applicationPropertyFilter
  .value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Optional | For URL value type. | | applicationPropertyFilter
  .value.URL.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Optional | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | **dataset** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will define what are properties that will be returned for this catelog-enabled category.

**Dataset values:**

DisplayableProductDetails

Properies for use in a user interface to describe products.

DisplayableSearchResults

Properties for use in results for product searches.

Searchable

Properties for use in searches.

Sortable

Properties that are suitable for sorting.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. | | **datasetPropertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Required,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[1..\*\] | Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. | | **disabledProductFilter** | [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) | Optional | Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. | | disabledProductFilter
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in product review flows.
**Default:** false. | | disabledProductFilter
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on eBay.
**Default:** false. | | disabledProductFilter
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on half.com.
**Default:** false. | | **paginationInput** | [PaginationInput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationInput.html) | Optional | Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

**Note:** No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). | | paginationInput.**entriesPerPage** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used.
**Max:** 100. **Default:** 100. | | paginationInput.**pageNumber** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return.
**Max:** 100. **Default:** 1. | | **productIdentifier** | [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) | Required | The ProductIdentifierType and a value for one of the supported ProductIdentifierTypes which are unique across all sites (ePID, MementoString) | | productIdentifier.**EAN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productIdentifier.**ePID** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | productIdentifier.**ISBN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productIdentifier.**productId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | productIdentifier.**UPC** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID.
**Max length:** 12. | | **sortOrder** | [CompatibilitySort](https://developer.ebay.com/Devzone/Product/CallRef/types/CompatibilitySort.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | We need to allow multiple sort orders. This is very specific to fitment. We allow the caller sorty by Make + Model + year. To start with we will only allow 5 sorts. | | sortOrder.**sortOrder** | [SortOrder](https://developer.ebay.com/Devzone/Product/CallRef/types/SortOrder.html) | Optional | The property with its associated sort order, ascending or descending. | | sortOrder.sortOrder.**order** | [OrderType](https://developer.ebay.com/Devzone/Product/CallRef/types/OrderType.html) | Optional | Order of the sort, either Ascending or Descending.
**Default:** Descending.

**Applicable values**:


Ascending

The results will be sorted by the specified attribute in ascending (low to high) order.

Descending

The results will be sorted by the specified attribute in descending (high to low) order. | | sortOrder.sortOrder
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional | Output can be sorted by one or more property names. You can look these values up using the **getProductSearchNames** call in the Product Metadata API.
**Max length:** 100. | | sortOrder.**sortPriority** | [SortPriority](https://developer.ebay.com/Devzone/Product/CallRef/types/SortPriority.html) | Optional | Indicates where in the sequence of ordering the property should ordered. There are five sorting steps, Sort1 through Sort5. When a property is assigned Sort1 as its sort priority, its values are sorted first. Values for the property assigned Sort2, are sorted second, and so on.

**Applicable values**:


Sort1

Specifies that the associated property should be sorted first.

Sort2

Specifies that the associated property should be sorted second.

Sort3

Specifies that the associated property should be sorted third.

Sort4

Specifies that the associated property should be sorted fourth.

Sort5

Specifies that the associated property should be sorted fifth. | Output ------ See also [Samples](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#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). <[compatibilityDetails](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails) \> [Product](https://developer.ebay.com/Devzone/Product/CallRef/types/Product.html) <[compatibilityCount](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.compatibilityCount) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[notes](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes) \> [Notes](https://developer.ebay.com/Devzone/Product/CallRef/types/Notes.html) <[noteDetails](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[productDetails](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[productIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.EAN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.ePID) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.ISBN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.productId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.UPC) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productStatus](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus) \> [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[stockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL) \> [StockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/types/StockPhotoURL.html) <[standard](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.standard) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.standard.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[thumbnail](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.thumbnail) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.thumbnail.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[type](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.type) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[paginationOutput](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput) \> [PaginationOutput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationOutput.html) <[entriesPerPage](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.entriesPerPage) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.pageNumber) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[totalEntries](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.totalEntries) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[totalPages](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.totalPages) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[ack](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.ack) \> [AckValue](https://developer.ebay.com/Devzone/Product/CallRef/types/AckValue.html) <[errorMessage](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage) \> [ErrorMessage](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorMessage.html) <[error](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error) \> [ErrorData](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorData.html) <[category](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.category) \> [ErrorCategory](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorCategory.html) <[domain](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.domain) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[errorId](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.errorId) \> [long](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#long) <[exceptionId](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.exceptionId) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[message](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.message) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[parameter](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.parameter) name\="[string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) "> [ErrorParameter](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) ) <[severity](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.severity) \> [ErrorSeverity](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorSeverity.html) <[subdomain](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.subdomain) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[timestamp](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.timestamp) \> [dateTime](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#dateTime) <[version](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#Response.version) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Return Value | Type | Occurrence | Meaning | | --- | --- | --- | --- | **Call-specific Output Fields** [\[Jump to standard fields\]](https://developer.ebay.com/Devzone/Product/CallRef/getProductCompatibilities.html#stdOutputFields) | | | | | | --- | --- | --- | --- | | **compatibilityDetails** | [Product](https://developer.ebay.com/Devzone/Product/CallRef/types/Product.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Compatibility details for a single product. | | compatibilityDetails
  .**compatibilityCount** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | **Coming soon.** The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. | | compatibilityDetails.**notes** | [Notes](https://developer.ebay.com/Devzone/Product/CallRef/types/Notes.html) | Conditionally | Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. | | compatibilityDetails.notes
  .**noteDetails** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Additional comments about the product in the form of name-value pairs. | | compatibilityDetails.notes
  .noteDetails.**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | compatibilityDetails.notes
  .noteDetails.**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | compatibilityDetails.notes
  .noteDetails.value.**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | compatibilityDetails.notes
  .noteDetails.value.number
  .**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | compatibilityDetails.notes
  .noteDetails.value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | compatibilityDetails.notes
  .noteDetails.value.text.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | compatibilityDetails.notes
  .noteDetails.value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | compatibilityDetails.notes
  .noteDetails.value.URL.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails
  .**productDetails** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about the product in the form of name-value pairs. | | compatibilityDetails
  .productDetails.**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | compatibilityDetails
  .productDetails.**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | compatibilityDetails
  .productDetails.value.**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | compatibilityDetails
  .productDetails.value.number
  .**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | compatibilityDetails
  .productDetails.value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | compatibilityDetails
  .productDetails.value.text
  .**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | compatibilityDetails
  .productDetails.value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | compatibilityDetails
  .productDetails.value.URL
  .**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails
  .**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) | Conditionally | The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. | | compatibilityDetails
  .productIdentifier.**EAN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | compatibilityDetails
  .productIdentifier.**ePID** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | compatibilityDetails
  .productIdentifier.**ISBN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | compatibilityDetails
  .productIdentifier.**productId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | compatibilityDetails
  .productIdentifier.**UPC** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID.
**Max length:** 12. | | compatibilityDetails
  .**productStatus** | [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) | Conditionally | Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. | | compatibilityDetails
  .productStatus
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in product review flows. | | compatibilityDetails
  .productStatus
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on eBay. | | compatibilityDetails
  .productStatus
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on half.com. | | compatibilityDetails
  .**stockPhotoURL** | [StockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/types/StockPhotoURL.html) | Conditionally | Thumbnail and standard stockphoto URLs. | | compatibilityDetails
  .stockPhotoURL.**standard** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | compatibilityDetails
  .stockPhotoURL.standard.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails
  .stockPhotoURL.**thumbnail** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | compatibilityDetails
  .stockPhotoURL.thumbnail.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails.**type** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.

**Allowed values:**

Head

The product is the the head of the product family.

Member

The product is a variant of the head product. | | **paginationOutput** | [PaginationOutput](https://developer.ebay.com/Devzone/Product/CallRef/types/PaginationOutput.html) | Always | Indicates the pagination of the result set. Child elements indicate the maximum number of compatibilityDetails nodes returned per response and which page of data has been returned. | | paginationOutput
  .**entriesPerPage** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. | | paginationOutput.**pageNumber** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data.

This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. | | paginationOutput.**totalEntries** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of entries found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any entries that match the search criteria. | | paginationOutput.**totalPages** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any entries that match the search criteria. | **Standard Output Fields**   | | | | | | --- | --- | --- | --- | | **ack** | [AckValue](https://developer.ebay.com/Devzone/Product/CallRef/types/AckValue.html) | Always | Indicates whether or not errors or warnings were generated during the processing of the request.

**Applicable values**:


Failure

The request was processed successfully, but something occurred that may affect your application or the user.

PartialFailure

The request that triggered the error was processed successfully but with some warnings.

Success

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.

Warning

The request that triggered the error was processed successfully but with some warnings.


Code so that your app gracefully handles any future changes to this list. | | **errorMessage** | [ErrorMessage](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorMessage.html) | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. | | errorMessage.**error** | [ErrorData](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorData.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about a single error. | | errorMessage.error.**category** | [ErrorCategory](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorCategory.html) | 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 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.


Code so that your app gracefully handles any future changes to this list. | | errorMessage.error.**domain** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the domain in which the error occurred.

**domain values:**

Marketplace

A business or validation error occurred in the service.

SOA

An exception occurred in the Service Oriented Architecture (SOA) framework. | | errorMessage.error.**errorId** | [long](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unique identifier for an exception associated with an error. | | errorMessage.error.**message** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A detailed description of the condition that caused in the error. | | errorMessage.error.**parameter** | [ErrorParameter](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorParameter.html)
([string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string)
) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorSeverity.html) | 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, re-send 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 case, 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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the subdomain in which the error occurred.

**subdomain values:**

MarketplaceCatalog

The error is specific to the Marketplace Catalog subdomain.

MarketplaceCommon

The error is common to all Marketplace services. | | **timestamp** | [dateTime](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#dateTime) | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. | | **version** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Always | The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

**Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. | Samples ------- Code samples not yet added for this call's documentation. Change History -------------- | Change Date | Description | | --- | --- | | **1.1.0**
11/3/2009 | * (added) New call. | --- # getProductDetails - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/Devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/Devzone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/Product/ReleaseNotes.html) getProductDetails ================= Use this call to retrieve details for a specific product. The request requires a product identifier, either an eBay-specific identifier (e.g., ePID) or an external identifier, such as a Universal Part Code (UPC). The product details consist of name-value pairs that describe the product, such the supplier, display name, or part number. This call also returns URLs for stock photos, thumbnail and standard, when available. Use either **dataset** or **datasetPropertyName** to restrict the name-value pairs returned in the response. The **dataset** value specifies the type of product details you want back. For example, if you specify Searchable, your product details will be contain properties that can be used to search for products, such as Supplier Name and Type. Some properties, such as Part number, are not intended for product searches. Input ----- See also [Samples](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#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). <[productDetailsRequest](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest) \> [ProductDetailsRequestType](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductDetailsRequestType.html) <[dataset](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.dataset) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[datasetPropertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.datasetPropertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.EAN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.ePID) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.ISBN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.productId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.UPC) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productStatusFilter](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter) \> [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Argument | Type | Occurrence | Meaning | | --- | --- | --- | --- | | | | | | | --- | --- | --- | --- | | **productDetailsRequest** | [ProductDetailsRequestType](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductDetailsRequestType.html) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Contains product details. | | productDetailsRequest.**dataset** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will define what are properties that will be returned for this catelog-enabled category.

**Dataset values:**

DisplayableProductDetails

Properies for use in a user interface to describe products.

DisplayableSearchResults

Properties for use in results for product searches.

Searchable

Properties for use in searches.

Sortable

Properties that are suitable for sorting.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. | | productDetailsRequest
  .**datasetPropertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Optional,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. | | productDetailsRequest
  .**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) | Required | The product identifier type and value. Product identifiers, such as ePID values or ISBN values, are unique across all sites. | | productDetailsRequest
  .productIdentifier.**EAN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productDetailsRequest
  .productIdentifier.**ePID** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | productDetailsRequest
  .productIdentifier.**ISBN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productDetailsRequest
  .productIdentifier.**productId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | productDetailsRequest
  .productIdentifier.**UPC** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID.
**Max length:** 12. | | productDetailsRequest
  .**productStatusFilter** | [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) | Optional | Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. | | productDetailsRequest
  .productStatusFilter
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in product review flows.
**Default:** false. | | productDetailsRequest
  .productStatusFilter
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on eBay.
**Default:** false. | | productDetailsRequest
  .productStatusFilter
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on half.com.
**Default:** false. | Output ------ See also [Samples](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#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). <[product](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product) \> [Product](https://developer.ebay.com/Devzone/Product/CallRef/types/Product.html) <[compatibilityCount](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.compatibilityCount) \> [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) <[notes](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes) \> [Notes](https://developer.ebay.com/Devzone/Product/CallRef/types/Notes.html) <[noteDetails](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[productDetails](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails) \> [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.propertyName) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value) \> [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.number) \> [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.number.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.text) \> [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.text.value) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.URL) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[productIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.EAN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.ePID) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.ISBN) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.productId) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.UPC) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[productStatus](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productStatus) \> [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productStatus.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productStatus.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.productStatus.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) <[stockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL) \> [StockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/types/StockPhotoURL.html) <[standard](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.standard) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.standard.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[thumbnail](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.thumbnail) \> [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.thumbnail.value) \> [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) <[type](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.product.type) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[ack](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.ack) \> [AckValue](https://developer.ebay.com/Devzone/Product/CallRef/types/AckValue.html) <[errorMessage](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage) \> [ErrorMessage](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorMessage.html) <[error](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error) \> [ErrorData](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorData.html) <[category](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.category) \> [ErrorCategory](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorCategory.html) <[domain](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.domain) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[errorId](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.errorId) \> [long](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#long) <[exceptionId](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.exceptionId) \> [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) <[message](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.message) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[parameter](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.parameter) name\="[string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) "> [ErrorParameter](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) ) <[severity](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.severity) \> [ErrorSeverity](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorSeverity.html) <[subdomain](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.subdomain) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) <[timestamp](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.timestamp) \> [dateTime](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#dateTime) <[version](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#Response.version) \> [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Return Value | Type | Occurrence | Meaning | | --- | --- | --- | --- | **Call-specific Output Fields** [\[Jump to standard fields\]](https://developer.ebay.com/Devzone/Product/CallRef/getProductDetails.html#stdOutputFields) | | | | | | --- | --- | --- | --- | | **product** | [Product](https://developer.ebay.com/Devzone/Product/CallRef/types/Product.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details for a single product. | | product.**compatibilityCount** | [int](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#int) | Conditionally | **Coming soon.** The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. | | product.**notes** | [Notes](https://developer.ebay.com/Devzone/Product/CallRef/types/Notes.html) | Conditionally | Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. | | product.notes.**noteDetails** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Additional comments about the product in the form of name-value pairs. | | product.notes.noteDetails
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | product.notes.noteDetails
  .**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | product.notes.noteDetails
  .value.**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | product.notes.noteDetails
  .value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | product.notes.noteDetails
  .value.number.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | product.notes.noteDetails
  .value.**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | product.notes.noteDetails
  .value.text.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | product.notes.noteDetails
  .value.**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | product.notes.noteDetails
  .value.URL.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.**productDetails** | [PropertyValue](https://developer.ebay.com/Devzone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about the product in the form of name-value pairs. | | product.productDetails
  .**propertyName** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | product.productDetails.**value** | [Value](https://developer.ebay.com/Devzone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | product.productDetails.value
  .**number** | [NumericValue](https://developer.ebay.com/Devzone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | product.productDetails.value
  .number.**unitOfMeasurement** | [token](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | product.productDetails.value
  .number.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | product.productDetails.value
  .**text** | [StringValue](https://developer.ebay.com/Devzone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | product.productDetails.value
  .text.**value** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | product.productDetails.value
  .**URL** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | product.productDetails.value
  .URL.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductIdentifier.html) | Conditionally | The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. | | product.productIdentifier.**EAN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | product.productIdentifier.**ePID** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | product.productIdentifier.**ISBN** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | product.productIdentifier
  .**productId** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | product.productIdentifier.**UPC** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID.
**Max length:** 12. | | product.**productStatus** | [ProductStatus](https://developer.ebay.com/Devzone/Product/CallRef/types/ProductStatus.html) | Conditionally | Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. | | product.productStatus
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in product review flows. | | product.productStatus
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on eBay. | | product.productStatus
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on half.com. | | product.**stockPhotoURL** | [StockPhotoURL](https://developer.ebay.com/Devzone/Product/CallRef/types/StockPhotoURL.html) | Conditionally | Thumbnail and standard stockphoto URLs. | | product.stockPhotoURL.**standard** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | product.stockPhotoURL.standard
  .**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.stockPhotoURL
  .**thumbnail** | [URIValue](https://developer.ebay.com/Devzone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | product.stockPhotoURL
  .thumbnail.**value** | [anyURI](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.**type** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.

**Allowed values:**

Head

The product is the the head of the product family.

Member

The product is a variant of the head product. | **Standard Output Fields**   | | | | | | --- | --- | --- | --- | | **ack** | [AckValue](https://developer.ebay.com/Devzone/Product/CallRef/types/AckValue.html) | Always | Indicates whether or not errors or warnings were generated during the processing of the request.

**Applicable values**:


Failure

The request was processed successfully, but something occurred that may affect your application or the user.

PartialFailure

The request that triggered the error was processed successfully but with some warnings.

Success

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.

Warning

The request that triggered the error was processed successfully but with some warnings.


Code so that your app gracefully handles any future changes to this list. | | **errorMessage** | [ErrorMessage](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorMessage.html) | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. | | errorMessage.**error** | [ErrorData](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorData.html) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about a single error. | | errorMessage.error.**category** | [ErrorCategory](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorCategory.html) | 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 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.


Code so that your app gracefully handles any future changes to this list. | | errorMessage.error.**domain** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the domain in which the error occurred.

**domain values:**

Marketplace

A business or validation error occurred in the service.

SOA

An exception occurred in the Service Oriented Architecture (SOA) framework. | | errorMessage.error.**errorId** | [long](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unique identifier for an exception associated with an error. | | errorMessage.error.**message** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A detailed description of the condition that caused in the error. | | errorMessage.error.**parameter** | [ErrorParameter](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorParameter.html)
([string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string)
) | Conditionally,
[repeatable](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/Devzone/Product/CallRef/types/ErrorSeverity.html) | 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, re-send 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 case, 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](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the subdomain in which the error occurred.

**subdomain values:**

MarketplaceCatalog

The error is specific to the Marketplace Catalog subdomain.

MarketplaceCommon

The error is common to all Marketplace services. | | **timestamp** | [dateTime](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#dateTime) | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. | | **version** | [string](https://developer.ebay.com/Devzone/Product/CallRef/types/simpletypes.html#string) | Always | The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

**Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. | Samples ------- Code samples not yet added for this call's documentation. Change History -------------- | Change Date | Description | | --- | --- | | **1.1.0**
11/3/2009 | * (added) New call. | --- # getProductDetails - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/Product/ReleaseNotes.html) getProductDetails ================= Use this call to retrieve details for a specific product. The request requires a product identifier, either an eBay-specific identifier (e.g., ePID) or an external identifier, such as a Universal Part Code (UPC). The product details consist of name-value pairs that describe the product, such the supplier, display name, or part number. This call also returns URLs for stock photos, thumbnail and standard, when available. Use either **dataset** or **datasetPropertyName** to restrict the name-value pairs returned in the response. The **dataset** value specifies the type of product details you want back. For example, if you specify Searchable, your product details will be contain properties that can be used to search for products, such as Supplier Name and Type. Some properties, such as Part number, are not intended for product searches. Input ----- See also [Samples](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#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). <[productDetailsRequest](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest) \> [ProductDetailsRequestType](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductDetailsRequestType.html) <[dataset](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.dataset) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[datasetPropertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.datasetPropertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.EAN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.ePID) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.ISBN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.productId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productIdentifier.UPC) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productStatusFilter](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter) \> [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Request.productDetailsRequest.productStatusFilter.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Argument | Type | Occurrence | Meaning | | --- | --- | --- | --- | | | | | | | --- | --- | --- | --- | | **productDetailsRequest** | [ProductDetailsRequestType](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductDetailsRequestType.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Contains product details. | | productDetailsRequest.**dataset** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will define what are properties that will be returned for this catelog-enabled category.

**Dataset values:**

DisplayableProductDetails

Properies for use in a user interface to describe products.

DisplayableSearchResults

Properties for use in results for product searches.

Searchable

Properties for use in searches.

Sortable

Properties that are suitable for sorting.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. | | productDetailsRequest
  .**datasetPropertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. | | productDetailsRequest
  .**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) | Required | The product identifier type and value. Product identifiers, such as ePID values or ISBN values, are unique across all sites. | | productDetailsRequest
  .productIdentifier.**EAN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productDetailsRequest
  .productIdentifier.**ePID** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | productDetailsRequest
  .productIdentifier.**ISBN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productDetailsRequest
  .productIdentifier.**productId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | productDetailsRequest
  .productIdentifier.**UPC** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID.
**Max length:** 12. | | productDetailsRequest
  .**productStatusFilter** | [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) | Optional | Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. | | productDetailsRequest
  .productStatusFilter
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in product review flows.
**Default:** false. | | productDetailsRequest
  .productStatusFilter
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on eBay.
**Default:** false. | | productDetailsRequest
  .productStatusFilter
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on half.com.
**Default:** false. | Output ------ See also [Samples](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#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). <[product](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product) \> [Product](https://developer.ebay.com/DevZone/Product/CallRef/types/Product.html) <[compatibilityCount](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.compatibilityCount) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[notes](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes) \> [Notes](https://developer.ebay.com/DevZone/Product/CallRef/types/Notes.html) <[noteDetails](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.notes.noteDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[productDetails](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[productIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.EAN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.ePID) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.ISBN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.productId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productIdentifier.UPC) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productStatus](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productStatus) \> [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productStatus.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productStatus.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.productStatus.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[stockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL) \> [StockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/types/StockPhotoURL.html) <[standard](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.standard) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.standard.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[thumbnail](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.thumbnail) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.stockPhotoURL.thumbnail.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[type](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.product.type) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ack](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.ack) \> [AckValue](https://developer.ebay.com/DevZone/Product/CallRef/types/AckValue.html) <[errorMessage](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage) \> [ErrorMessage](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorMessage.html) <[error](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error) \> [ErrorData](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorData.html) <[category](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.category) \> [ErrorCategory](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorCategory.html) <[domain](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.domain) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[errorId](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.errorId) \> [long](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#long) <[exceptionId](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.exceptionId) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[message](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.message) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[parameter](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.parameter) name\="[string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) "> [ErrorParameter](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) ) <[severity](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.severity) \> [ErrorSeverity](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorSeverity.html) <[subdomain](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.errorMessage.error.subdomain) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[timestamp](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.timestamp) \> [dateTime](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#dateTime) <[version](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#Response.version) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Return Value | Type | Occurrence | Meaning | | --- | --- | --- | --- | **Call-specific Output Fields** [\[Jump to standard fields\]](https://developer.ebay.com/DevZone/Product/CallRef/getProductDetails.html#stdOutputFields) | | | | | | --- | --- | --- | --- | | **product** | [Product](https://developer.ebay.com/DevZone/Product/CallRef/types/Product.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details for a single product. | | product.**compatibilityCount** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | **Coming soon.** The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. | | product.**notes** | [Notes](https://developer.ebay.com/DevZone/Product/CallRef/types/Notes.html) | Conditionally | Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. | | product.notes.**noteDetails** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Additional comments about the product in the form of name-value pairs. | | product.notes.noteDetails
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | product.notes.noteDetails
  .**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | product.notes.noteDetails
  .value.**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | product.notes.noteDetails
  .value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | product.notes.noteDetails
  .value.number.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | product.notes.noteDetails
  .value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | product.notes.noteDetails
  .value.text.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | product.notes.noteDetails
  .value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | product.notes.noteDetails
  .value.URL.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.**productDetails** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about the product in the form of name-value pairs. | | product.productDetails
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | product.productDetails.**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | product.productDetails.value
  .**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | product.productDetails.value
  .number.**unitOfMeasurement** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | product.productDetails.value
  .number.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | product.productDetails.value
  .**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | product.productDetails.value
  .text.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | product.productDetails.value
  .**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | product.productDetails.value
  .URL.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) | Conditionally | The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. | | product.productIdentifier.**EAN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | product.productIdentifier.**ePID** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | product.productIdentifier.**ISBN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | product.productIdentifier
  .**productId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | product.productIdentifier.**UPC** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID.
**Max length:** 12. | | product.**productStatus** | [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) | Conditionally | Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. | | product.productStatus
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in product review flows. | | product.productStatus
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on eBay. | | product.productStatus
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on half.com. | | product.**stockPhotoURL** | [StockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/types/StockPhotoURL.html) | Conditionally | Thumbnail and standard stockphoto URLs. | | product.stockPhotoURL.**standard** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | product.stockPhotoURL.standard
  .**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.stockPhotoURL
  .**thumbnail** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | product.stockPhotoURL
  .thumbnail.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | product.**type** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.

**Allowed values:**

Head

The product is the the head of the product family.

Member

The product is a variant of the head product. | **Standard Output Fields**   | | | | | | --- | --- | --- | --- | | **ack** | [AckValue](https://developer.ebay.com/DevZone/Product/CallRef/types/AckValue.html) | Always | Indicates whether or not errors or warnings were generated during the processing of the request.

**Applicable values**:


Failure

The request was processed successfully, but something occurred that may affect your application or the user.

PartialFailure

The request that triggered the error was processed successfully but with some warnings.

Success

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.

Warning

The request that triggered the error was processed successfully but with some warnings.


Code so that your app gracefully handles any future changes to this list. | | **errorMessage** | [ErrorMessage](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorMessage.html) | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. | | errorMessage.**error** | [ErrorData](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorData.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about a single error. | | errorMessage.error.**category** | [ErrorCategory](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorCategory.html) | 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 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.


Code so that your app gracefully handles any future changes to this list. | | errorMessage.error.**domain** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the domain in which the error occurred.

**domain values:**

Marketplace

A business or validation error occurred in the service.

SOA

An exception occurred in the Service Oriented Architecture (SOA) framework. | | errorMessage.error.**errorId** | [long](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unique identifier for an exception associated with an error. | | errorMessage.error.**message** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A detailed description of the condition that caused in the error. | | errorMessage.error.**parameter** | [ErrorParameter](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorParameter.html)
([string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string)
) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorSeverity.html) | 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, re-send 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 case, 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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the subdomain in which the error occurred.

**subdomain values:**

MarketplaceCatalog

The error is specific to the Marketplace Catalog subdomain.

MarketplaceCommon

The error is common to all Marketplace services. | | **timestamp** | [dateTime](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#dateTime) | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. | | **version** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Always | The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

**Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. | Samples ------- Code samples not yet added for this call's documentation. Change History -------------- | Change Date | Description | | --- | --- | | **1.1.0**
11/3/2009 | * (added) New call. | --- # findProducts - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/Product/ReleaseNotes.html) findProducts ============ Use this call to find the products in a specific category. You can refine search results using optional catalog property name-value pairs and/or a keyword query. If you specify keywords without specifying a category, you can search for products across all catalog-enabled categories on a site. Property Filters ---------------- You must specify a category to use property filters. Use **getProductSearchNames** and **getProductSearchValues** to retrieve searchable property names and values for the given category. For example, to retrieve all products in a parts category that are front brake discs manufactured by Brembo, you would call **getProductSearchNames** to identify searchable properties for the category, such as "Supplier Name" and "Type." Next, you would call **getProductSearchValues** to get the values associated with a property. **Note:** We recommend you retrieve and maintain the product search metadata locally. Use **getProductSearchValuesBulk** to retrieve all applicable property values for up to 10 property names. You can use **getProductSearchDataVersion** to check for updates to the metadata. The following filter will limit the search results to Brembo brake parts for the front of a vehicle: Supplier Name Brembo Type Front Brake Pads/Shoes, Rotors, Drums Input ----- See also [Samples](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#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). <[productSearch](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch) \> [ProductRequest](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductRequest.html) <[categoryId](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.categoryId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[dataset](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.dataset) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[datasetPropertyName](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.datasetPropertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[invocationId](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.invocationId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[keywords](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.keywords) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[paginationInput](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.paginationInput) \> [PaginationInput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationInput.html) <[entriesPerPage](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.paginationInput.entriesPerPage) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.paginationInput.pageNumber) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[productStatusFilter](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter) \> [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.productStatusFilter.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[propertyFilter](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.propertyFilter.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[sortOrder](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.sortOrder) \> [SortOrder](https://developer.ebay.com/DevZone/Product/CallRef/types/SortOrder.html) <[order](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.sortOrder.order) \> [OrderType](https://developer.ebay.com/DevZone/Product/CallRef/types/OrderType.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Request.productSearch.sortOrder.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Argument | Type | Occurrence | Meaning | | --- | --- | --- | --- | | | | | | | --- | --- | --- | --- | | **productSearch** | [ProductRequest](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductRequest.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..10\] | User can findproducts for one catalog at a time or batch up to 10 catalogs. | | productSearch.**categoryId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled.

Your request must contain categoryId and/or keywords.
**Max length:** 10.

See:
    [GetCategoryFeatures](http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html)
for information to identify compatibility-enabled categories. | | productSearch.**dataset** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will define what are properties that will be returned for this catelog-enabled category.

**Dataset values:**

DisplayableProductDetails

Properies for use in a user interface to describe products.

DisplayableSearchResults

Properties for use in results for product searches.

Searchable

Properties for use in searches.

Sortable

Properties that are suitable for sorting.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time.
**Default:** Searchable. | | productSearch
  .**datasetPropertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. | | productSearch.**invocationId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Required | A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed.

If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number . | | productSearch.**keywords** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint.

Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported.

Your request must contain categoryId and/or keywords.
**Max length:** 350. The maximum length for a single word is 98. | | productSearch.**paginationInput** | [PaginationInput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationInput.html) | Optional | Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

**Note:** No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). | | productSearch.paginationInput
  .**entriesPerPage** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used.
**Max:** 100. **Default:** 100. | | productSearch.paginationInput
  .**pageNumber** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return.
**Max:** 100. **Default:** 1. | | productSearch
  .**productStatusFilter** | [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) | Optional | Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com. | | productSearch
  .productStatusFilter
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in product review flows.
**Default:** false. | | productSearch
  .productStatusFilter
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on eBay.
**Default:** false. | | productSearch
  .productStatusFilter
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on half.com.
**Default:** false. | | productSearch.**propertyFilter** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | One or more name-value pairs that describe the product. | | productSearch.propertyFilter
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | productSearch.propertyFilter
  .**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | productSearch.propertyFilter
  .value.**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Optional | For numeric value type. | | productSearch.propertyFilter
  .value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Optional | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | productSearch.propertyFilter
  .value.number.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | productSearch.propertyFilter
  .value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Optional | For string value type. | | productSearch.propertyFilter
  .value.text.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | A string value. | | productSearch.propertyFilter
  .value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Optional | For URL value type. | | productSearch.propertyFilter
  .value.URL.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Optional | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearch.**sortOrder** | [SortOrder](https://developer.ebay.com/DevZone/Product/CallRef/types/SortOrder.html) | Optional | Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied. | | productSearch.sortOrder.**order** | [OrderType](https://developer.ebay.com/DevZone/Product/CallRef/types/OrderType.html) | Optional | Order of the sort, either Ascending or Descending.
**Default:** Descending.

**Applicable values**:


Ascending

The results will be sorted by the specified attribute in ascending (low to high) order.

Descending

The results will be sorted by the specified attribute in descending (high to low) order. | | productSearch.sortOrder
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | Output can be sorted by one or more property names. You can look these values up using the **getProductSearchNames** call in the Product Metadata API.
**Max length:** 100. | Output ------ See also [Samples](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#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). <[productSearchResult](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult) \> [ProductResponse](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductResponse.html) <[invocationId](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.invocationId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[paginationOutput](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput) \> [PaginationOutput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationOutput.html) <[entriesPerPage](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.entriesPerPage) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.pageNumber) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[totalEntries](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.totalEntries) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[totalPages](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.paginationOutput.totalPages) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[products](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products) \> [Product](https://developer.ebay.com/DevZone/Product/CallRef/types/Product.html) <[compatibilityCount](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.compatibilityCount) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[notes](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes) \> [Notes](https://developer.ebay.com/DevZone/Product/CallRef/types/Notes.html) <[noteDetails](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.notes.noteDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[productDetails](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[productIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.EAN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.ePID) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.ISBN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.productId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productIdentifier.UPC) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productStatus](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus) \> [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.productStatus.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[stockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL) \> [StockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/types/StockPhotoURL.html) <[standard](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.standard) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.standard.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[thumbnail](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.thumbnail) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.stockPhotoURL.thumbnail.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[type](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.productSearchResult.products.type) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ack](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.ack) \> [AckValue](https://developer.ebay.com/DevZone/Product/CallRef/types/AckValue.html) <[errorMessage](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage) \> [ErrorMessage](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorMessage.html) <[error](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error) \> [ErrorData](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorData.html) <[category](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.category) \> [ErrorCategory](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorCategory.html) <[domain](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.domain) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[errorId](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.errorId) \> [long](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#long) <[exceptionId](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.exceptionId) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[message](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.message) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[parameter](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.parameter) name\="[string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) "> [ErrorParameter](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) ) <[severity](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.severity) \> [ErrorSeverity](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorSeverity.html) <[subdomain](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.errorMessage.error.subdomain) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[timestamp](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.timestamp) \> [dateTime](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#dateTime) <[version](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#Response.version) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Return Value | Type | Occurrence | Meaning | | --- | --- | --- | --- | **Call-specific Output Fields** [\[Jump to standard fields\]](https://developer.ebay.com/DevZone/Product/CallRef/findProducts.html#stdOutputFields) | | | | | | --- | --- | --- | --- | | **productSearchResult** | [ProductResponse](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductResponse.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Container for the products that matched the search criteria. The data for each product is returned in individual containers, if any matches were found. | | productSearchResult
  .**invocationId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A unique identifer for a given product response, corresponding to a specific product request. | | productSearchResult
  .**paginationOutput** | [PaginationOutput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationOutput.html) | Conditionally | Indicates the pagination of the result set. Child elements indicate the maximum number of productSearchResult nodes returned per response and which page of data has been returned. | | productSearchResult
  .paginationOutput
  .**entriesPerPage** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. | | productSearchResult
  .paginationOutput.**pageNumber** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data.

This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. | | productSearchResult
  .paginationOutput.**totalEntries** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of entries found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any entries that match the search criteria. | | productSearchResult
  .paginationOutput.**totalPages** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any entries that match the search criteria. | | productSearchResult.**products** | [Product](https://developer.ebay.com/DevZone/Product/CallRef/types/Product.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Container for multiple products. | | productSearchResult.products
  .**compatibilityCount** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | **Coming soon.** The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. | | productSearchResult.products
  .**notes** | [Notes](https://developer.ebay.com/DevZone/Product/CallRef/types/Notes.html) | Conditionally | Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. | | productSearchResult.products
  .notes.**noteDetails** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Additional comments about the product in the form of name-value pairs. | | productSearchResult.products
  .notes.noteDetails
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | productSearchResult.products
  .notes.noteDetails.**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | productSearchResult.products
  .notes.noteDetails.value
  .**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | productSearchResult.products
  .notes.noteDetails.value
  .number.**unitOfMeasurement** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | productSearchResult.products
  .notes.noteDetails.value
  .number.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | productSearchResult.products
  .notes.noteDetails.value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | productSearchResult.products
  .notes.noteDetails.value.text
  .**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | productSearchResult.products
  .notes.noteDetails.value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | productSearchResult.products
  .notes.noteDetails.value.URL
  .**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .**productDetails** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about the product in the form of name-value pairs. | | productSearchResult.products
  .productDetails.**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | productSearchResult.products
  .productDetails.**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | productSearchResult.products
  .productDetails.value.**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | productSearchResult.products
  .productDetails.value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | productSearchResult.products
  .productDetails.value.number
  .**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | productSearchResult.products
  .productDetails.value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | productSearchResult.products
  .productDetails.value.text
  .**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | productSearchResult.products
  .productDetails.value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | productSearchResult.products
  .productDetails.value.URL
  .**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) | Conditionally | The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. | | productSearchResult.products
  .productIdentifier.**EAN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productSearchResult.products
  .productIdentifier.**ePID** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | productSearchResult.products
  .productIdentifier.**ISBN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productSearchResult.products
  .productIdentifier.**productId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | productSearchResult.products
  .productIdentifier.**UPC** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID.
**Max length:** 12. | | productSearchResult.products
  .**productStatus** | [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) | Conditionally | Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. | | productSearchResult.products
  .productStatus
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in product review flows. | | productSearchResult.products
  .productStatus
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on eBay. | | productSearchResult.products
  .productStatus
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on half.com. | | productSearchResult.products
  .**stockPhotoURL** | [StockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/types/StockPhotoURL.html) | Conditionally | Thumbnail and standard stockphoto URLs. | | productSearchResult.products
  .stockPhotoURL.**standard** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | productSearchResult.products
  .stockPhotoURL.standard.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .stockPhotoURL.**thumbnail** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | productSearchResult.products
  .stockPhotoURL.thumbnail.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | productSearchResult.products
  .**type** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.

**Allowed values:**

Head

The product is the the head of the product family.

Member

The product is a variant of the head product. | **Standard Output Fields**   | | | | | | --- | --- | --- | --- | | **ack** | [AckValue](https://developer.ebay.com/DevZone/Product/CallRef/types/AckValue.html) | Always | Indicates whether or not errors or warnings were generated during the processing of the request.

**Applicable values**:


Failure

The request was processed successfully, but something occurred that may affect your application or the user.

PartialFailure

The request that triggered the error was processed successfully but with some warnings.

Success

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.

Warning

The request that triggered the error was processed successfully but with some warnings.


Code so that your app gracefully handles any future changes to this list. | | **errorMessage** | [ErrorMessage](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorMessage.html) | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. | | errorMessage.**error** | [ErrorData](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorData.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about a single error. | | errorMessage.error.**category** | [ErrorCategory](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorCategory.html) | 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 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.


Code so that your app gracefully handles any future changes to this list. | | errorMessage.error.**domain** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the domain in which the error occurred.

**domain values:**

Marketplace

A business or validation error occurred in the service.

SOA

An exception occurred in the Service Oriented Architecture (SOA) framework. | | errorMessage.error.**errorId** | [long](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unique identifier for an exception associated with an error. | | errorMessage.error.**message** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A detailed description of the condition that caused in the error. | | errorMessage.error.**parameter** | [ErrorParameter](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorParameter.html)
([string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string)
) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorSeverity.html) | 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, re-send 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 case, 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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the subdomain in which the error occurred.

**subdomain values:**

MarketplaceCatalog

The error is specific to the Marketplace Catalog subdomain.

MarketplaceCommon

The error is common to all Marketplace services. | | **timestamp** | [dateTime](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#dateTime) | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. | | **version** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Always | The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

**Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. | Samples ------- Code samples not yet added for this call's documentation. Change History -------------- | Change Date | Description | | --- | --- | | **1.1.0**
11/3/2009 | * (added) New call. | --- # getProductCompatibilities - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/DevZone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/DevZone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/DevZone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/DevZone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/DevZone/Product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/DevZone/Product/ReleaseNotes.html) getProductCompatibilities ========================= **Note:** This call has been deprecated and will be decommissioned on April 27th, 2026. Users are recommended to migrate to the [getProductCompatibilities](https://developer.ebay.com/api-docs/sell/metadata/resources/compatibilities/methods/getProductCompatibilities) method of the **Metadata API**. This call retrieves all available item compatibility details for the specified product. Item compatibility properties are returned as name-value pairs. The request requires a product identifier, either an eBay-specific identifier (e.g., ePID) or an external identifier, such as a Universal Part Code (UPC). Use this call to get complete compatibility details for products you find using **findProductsByCompatibility**. For example, if you searched for parts that fit a Honda Accord, you can use this call to see the years, engine, and trim for which the part is compatible, as well as any other compatibilities for the product. Use either **dataset** or **datasetPropertyName** to restrict the name-value pairs returned in the response. The **dataset** value specifies the type of compatibility properties you want back. For example, if you specify Searchable, your compatibility details will be contain properties that can be used to search for products, such as Make and Model. Some compatibility properties, such as FitmentComments, are not intended for product searches. **Note:** Parts Compatibility is supported in limited Parts & Accessories categories, for the eBay US Motors (100), UK (3), AU (15) and DE (77) sites only. Input ----- See also [Samples](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#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). <[applicationPropertyFilter](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[unitOfMeasurement](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.number.unitOfMeasurement) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.applicationPropertyFilter.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[dataset](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.dataset) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[datasetPropertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.datasetPropertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[disabledProductFilter](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter) \> [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.disabledProductFilter.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[paginationInput](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.paginationInput) \> [PaginationInput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationInput.html) <[entriesPerPage](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.paginationInput.entriesPerPage) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.paginationInput.pageNumber) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[productIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.EAN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.ePID) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.ISBN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.productId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.productIdentifier.UPC) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[sortOrder](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder) \> [CompatibilitySort](https://developer.ebay.com/DevZone/Product/CallRef/types/CompatibilitySort.html) <[sortOrder](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortOrder) \> [SortOrder](https://developer.ebay.com/DevZone/Product/CallRef/types/SortOrder.html) <[order](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortOrder.order) \> [OrderType](https://developer.ebay.com/DevZone/Product/CallRef/types/OrderType.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortOrder.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[sortPriority](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Request.sortOrder.sortPriority) \> [SortPriority](https://developer.ebay.com/DevZone/Product/CallRef/types/SortPriority.html) | Argument | Type | Occurrence | Meaning | | --- | --- | --- | --- | | | | | | | --- | --- | --- | --- | | **applicationPropertyFilter** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will contain the property name value pairs of the application, such as a particular vehicle make and model. Application property filters are specified as name-value pairs. | | applicationPropertyFilter
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | applicationPropertyFilter
  .**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | applicationPropertyFilter
  .value.**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Optional | For numeric value type. | | applicationPropertyFilter
  .value.number
  .**unitOfMeasurement** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Optional | Unit of measure for a numeric value.

**Allowed values:**

bps

Bits per second. A unit of data transmission.

kbps

Kilobits per second. A unit of data transmission.

bit

Binary digit. A unit of information storage.

byte

An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts.

kb

Kilobit. A unit of information storage equal to 1024 bits.

MB

Megabyte. A unit of information storage equal to one million bytes.

mW

Megawatt. A unit of power equal to one million watts.

W

Watt. The base SI unit of power.

Hz

Hertz. A unit of frequency equal to one cycle per second.

kHz

Kilohertz. A unit of frequency equal to 1,000 cycles per second.

m

Meter. The base unit of distance.

mm

Megameter. A unit of distance equal to one million meters.

rph

Revolutions per hour. A unit of frequency.

hr

Hour. A unit of time equal to 3,600 seconds.

min

Minute. A unit of time equal to 60 seconds.

ms

Microsecond. A unit of time equal to one millionth of a second.

ns

Nanosecond. A unit of time equal to 10\-9 seconds.

sec

Seconds. The base unit of time.

g

Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram.

lbs

Pounds. The base Imperial unit of mass.

The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed. | | applicationPropertyFilter
  .value.number.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | applicationPropertyFilter
  .value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Optional | For string value type. | | applicationPropertyFilter
  .value.text.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | A string value. | | applicationPropertyFilter
  .value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Optional | For URL value type. | | applicationPropertyFilter
  .value.URL.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Optional | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | **dataset** | [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | This will define what are properties that will be returned for this catelog-enabled category.

**Dataset values:**

DisplayableProductDetails

Properies for use in a user interface to describe products.

DisplayableSearchResults

Properties for use in results for product searches.

Searchable

Properties for use in searches.

Sortable

Properties that are suitable for sorting.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. | | **datasetPropertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Required,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[1..\*\] | Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time. | | **disabledProductFilter** | [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) | Optional | Specifies whether or not to filter out the products which are disabled for selling on eBay, disabled for product reviews, or disabled for selling on half.com. | | disabledProductFilter
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in product review flows.
**Default:** false. | | disabledProductFilter
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on eBay.
**Default:** false. | | disabledProductFilter
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Optional | Product cannot be used in selling flows on half.com.
**Default:** false. | | **paginationInput** | [PaginationInput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationInput.html) | Optional | Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

**Note:** No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20). | | paginationInput.**entriesPerPage** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used.
**Max:** 100. **Default:** 100. | | paginationInput.**pageNumber** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Optional | Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return.
**Max:** 100. **Default:** 1. | | **productIdentifier** | [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) | Required | The ProductIdentifierType and a value for one of the supported ProductIdentifierTypes which are unique across all sites (ePID, MementoString) | | productIdentifier.**EAN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productIdentifier.**ePID** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | productIdentifier.**ISBN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | productIdentifier.**productId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | productIdentifier.**UPC** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditional | eBay Product ID.
**Max length:** 12. | | **sortOrder** | [CompatibilitySort](https://developer.ebay.com/DevZone/Product/CallRef/types/CompatibilitySort.html) | Optional,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | We need to allow multiple sort orders. This is very specific to fitment. We allow the caller sorty by Make + Model + year. To start with we will only allow 5 sorts. | | sortOrder.**sortOrder** | [SortOrder](https://developer.ebay.com/DevZone/Product/CallRef/types/SortOrder.html) | Optional | The property with its associated sort order, ascending or descending. | | sortOrder.sortOrder.**order** | [OrderType](https://developer.ebay.com/DevZone/Product/CallRef/types/OrderType.html) | Optional | Order of the sort, either Ascending or Descending.
**Default:** Descending.

**Applicable values**:


Ascending

The results will be sorted by the specified attribute in ascending (low to high) order.

Descending

The results will be sorted by the specified attribute in descending (high to low) order. | | sortOrder.sortOrder
  .**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Optional | Output can be sorted by one or more property names. You can look these values up using the **getProductSearchNames** call in the Product Metadata API.
**Max length:** 100. | | sortOrder.**sortPriority** | [SortPriority](https://developer.ebay.com/DevZone/Product/CallRef/types/SortPriority.html) | Optional | Indicates where in the sequence of ordering the property should ordered. There are five sorting steps, Sort1 through Sort5. When a property is assigned Sort1 as its sort priority, its values are sorted first. Values for the property assigned Sort2, are sorted second, and so on.

**Applicable values**:


Sort1

Specifies that the associated property should be sorted first.

Sort2

Specifies that the associated property should be sorted second.

Sort3

Specifies that the associated property should be sorted third.

Sort4

Specifies that the associated property should be sorted fourth.

Sort5

Specifies that the associated property should be sorted fifth. | Output ------ See also [Samples](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#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). <[compatibilityDetails](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails) \> [Product](https://developer.ebay.com/DevZone/Product/CallRef/types/Product.html) <[compatibilityCount](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.compatibilityCount) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[notes](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes) \> [Notes](https://developer.ebay.com/DevZone/Product/CallRef/types/Notes.html) <[noteDetails](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.notes.noteDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[productDetails](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails) \> [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) <[propertyName](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.propertyName) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value) \> [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) <[number](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.number) \> [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.number.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[text](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.text) \> [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.text.value) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[URL](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.URL) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productDetails.value.URL.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[productIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier) \> [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) <[EAN](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.EAN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ePID](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.ePID) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[ISBN](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.ISBN) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productId](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.productId) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[UPC](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productIdentifier.UPC) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[productStatus](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus) \> [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) <[excludeForeBayReviews](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus.excludeForeBayReviews) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForeBaySelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus.excludeForeBaySelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[excludeForHalfSelling](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.productStatus.excludeForHalfSelling) \> [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) <[stockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL) \> [StockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/types/StockPhotoURL.html) <[standard](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.standard) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.standard.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[thumbnail](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.thumbnail) \> [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) <[value](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.stockPhotoURL.thumbnail.value) \> [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) <[type](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.compatibilityDetails.type) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[paginationOutput](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput) \> [PaginationOutput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationOutput.html) <[entriesPerPage](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.entriesPerPage) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[pageNumber](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.pageNumber) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[totalEntries](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.totalEntries) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[totalPages](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.paginationOutput.totalPages) \> [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) <[ack](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.ack) \> [AckValue](https://developer.ebay.com/DevZone/Product/CallRef/types/AckValue.html) <[errorMessage](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage) \> [ErrorMessage](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorMessage.html) <[error](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error) \> [ErrorData](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorData.html) <[category](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.category) \> [ErrorCategory](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorCategory.html) <[domain](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.domain) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[errorId](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.errorId) \> [long](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#long) <[exceptionId](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.exceptionId) \> [token](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) <[message](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.message) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[parameter](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.parameter) name\="[string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) "> [ErrorParameter](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorParameter.html) ([string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) ) <[severity](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.severity) \> [ErrorSeverity](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorSeverity.html) <[subdomain](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.errorMessage.error.subdomain) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) <[timestamp](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.timestamp) \> [dateTime](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#dateTime) <[version](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#Response.version) \> [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Return Value | Type | Occurrence | Meaning | | --- | --- | --- | --- | **Call-specific Output Fields** [\[Jump to standard fields\]](https://developer.ebay.com/DevZone/Product/CallRef/getProductCompatibilities.html#stdOutputFields) | | | | | | --- | --- | --- | --- | | **compatibilityDetails** | [Product](https://developer.ebay.com/DevZone/Product/CallRef/types/Product.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Compatibility details for a single product. | | compatibilityDetails
  .**compatibilityCount** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | **Coming soon.** The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled. | | compatibilityDetails.**notes** | [Notes](https://developer.ebay.com/DevZone/Product/CallRef/types/Notes.html) | Conditionally | Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits. | | compatibilityDetails.notes
  .**noteDetails** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Additional comments about the product in the form of name-value pairs. | | compatibilityDetails.notes
  .noteDetails.**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | compatibilityDetails.notes
  .noteDetails.**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | compatibilityDetails.notes
  .noteDetails.value.**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | compatibilityDetails.notes
  .noteDetails.value.number
  .**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | compatibilityDetails.notes
  .noteDetails.value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | compatibilityDetails.notes
  .noteDetails.value.text.**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | compatibilityDetails.notes
  .noteDetails.value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | compatibilityDetails.notes
  .noteDetails.value.URL.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails
  .**productDetails** | [PropertyValue](https://developer.ebay.com/DevZone/Product/CallRef/types/PropertyValue.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about the product in the form of name-value pairs. | | compatibilityDetails
  .productDetails.**propertyName** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. | | compatibilityDetails
  .productDetails.**value** | [Value](https://developer.ebay.com/DevZone/Product/CallRef/types/Value.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | A value for the property. | | compatibilityDetails
  .productDetails.value.**number** | [NumericValue](https://developer.ebay.com/DevZone/Product/CallRef/types/NumericValue.html) | Conditionally | For numeric value type. | | compatibilityDetails
  .productDetails.value.number
  .**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values. | | compatibilityDetails
  .productDetails.value.**text** | [StringValue](https://developer.ebay.com/DevZone/Product/CallRef/types/StringValue.html) | Conditionally | For string value type. | | compatibilityDetails
  .productDetails.value.text
  .**value** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A string value. | | compatibilityDetails
  .productDetails.value.**URL** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | For URL value type. | | compatibilityDetails
  .productDetails.value.URL
  .**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails
  .**productIdentifier** | [ProductIdentifier](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductIdentifier.html) | Conditionally | The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. | | compatibilityDetails
  .productIdentifier.**EAN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | compatibilityDetails
  .productIdentifier.**ePID** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
**Max length:** 38. | | compatibilityDetails
  .productIdentifier.**ISBN** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book.
**Max length:** 13. | | compatibilityDetails
  .productIdentifier.**productId** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.)
**Max length:** 4000. | | compatibilityDetails
  .productIdentifier.**UPC** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | eBay Product ID.
**Max length:** 12. | | compatibilityDetails
  .**productStatus** | [ProductStatus](https://developer.ebay.com/DevZone/Product/CallRef/types/ProductStatus.html) | Conditionally | Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com. | | compatibilityDetails
  .productStatus
  .**excludeForeBayReviews** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in product review flows. | | compatibilityDetails
  .productStatus
  .**excludeForeBaySelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on eBay. | | compatibilityDetails
  .productStatus
  .**excludeForHalfSelling** | [boolean](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#boolean) | Conditionally | Product cannot be used in selling flows on half.com. | | compatibilityDetails
  .**stockPhotoURL** | [StockPhotoURL](https://developer.ebay.com/DevZone/Product/CallRef/types/StockPhotoURL.html) | Conditionally | Thumbnail and standard stockphoto URLs. | | compatibilityDetails
  .stockPhotoURL.**standard** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | compatibilityDetails
  .stockPhotoURL.standard.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails
  .stockPhotoURL.**thumbnail** | [URIValue](https://developer.ebay.com/DevZone/Product/CallRef/types/URIValue.html) | Conditionally | Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. | | compatibilityDetails
  .stockPhotoURL.thumbnail.**value** | [anyURI](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#anyURI) | Conditionally | As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS).
**Max length:** 400. | | compatibilityDetails.**type** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head.

Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products.

**Allowed values:**

Head

The product is the the head of the product family.

Member

The product is a variant of the head product. | | **paginationOutput** | [PaginationOutput](https://developer.ebay.com/DevZone/Product/CallRef/types/PaginationOutput.html) | Always | Indicates the pagination of the result set. Child elements indicate the maximum number of compatibilityDetails nodes returned per response and which page of data has been returned. | | paginationOutput
  .**entriesPerPage** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. | | paginationOutput.**pageNumber** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data.

This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. | | paginationOutput.**totalEntries** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of entries found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any entries that match the search criteria. | | paginationOutput.**totalPages** | [int](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#int) | Conditionally | The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any entries that match the search criteria. | **Standard Output Fields**   | | | | | | --- | --- | --- | --- | | **ack** | [AckValue](https://developer.ebay.com/DevZone/Product/CallRef/types/AckValue.html) | Always | Indicates whether or not errors or warnings were generated during the processing of the request.

**Applicable values**:


Failure

The request was processed successfully, but something occurred that may affect your application or the user.

PartialFailure

The request that triggered the error was processed successfully but with some warnings.

Success

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.

Warning

The request that triggered the error was processed successfully but with some warnings.


Code so that your app gracefully handles any future changes to this list. | | **errorMessage** | [ErrorMessage](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorMessage.html) | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. | | errorMessage.**error** | [ErrorData](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorData.html) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#repeatable)
: \[0..\*\] | Details about a single error. | | errorMessage.error.**category** | [ErrorCategory](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorCategory.html) | 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 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.


Code so that your app gracefully handles any future changes to this list. | | errorMessage.error.**domain** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the domain in which the error occurred.

**domain values:**

Marketplace

A business or validation error occurred in the service.

SOA

An exception occurred in the Service Oriented Architecture (SOA) framework. | | errorMessage.error.**errorId** | [long](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#token) | Conditionally | Unique identifier for an exception associated with an error. | | errorMessage.error.**message** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | A detailed description of the condition that caused in the error. | | errorMessage.error.**parameter** | [ErrorParameter](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorParameter.html)
([string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string)
) | Conditionally,
[repeatable](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#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](https://developer.ebay.com/DevZone/Product/CallRef/types/ErrorSeverity.html) | 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, re-send 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 case, 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](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Conditionally | Name of the subdomain in which the error occurred.

**subdomain values:**

MarketplaceCatalog

The error is specific to the Marketplace Catalog subdomain.

MarketplaceCommon

The error is common to all Marketplace services. | | **timestamp** | [dateTime](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#dateTime) | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. | | **version** | [string](https://developer.ebay.com/DevZone/Product/CallRef/types/simpletypes.html#string) | Always | The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

**Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. | Samples ------- Code samples not yet added for this call's documentation. Change History -------------- | Change Date | Description | | --- | --- | | **1.1.0**
11/3/2009 | * (added) New call. | --- # GetProductSearchValuesResponse - API Reference - Product Metadata API eBay Product Metadata APIVersion 1.7.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/Product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/Product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/Product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product-metadata/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product-metadata/ReleaseNotes.html) GetProductSearchValuesResponse ( [BaseServiceResponse](https://developer.ebay.com/devzone/product-metadata/CallRef/types/BaseServiceResponse.html) ) ===================================================================================================================================================== Calls that use GetProductSearchValuesResponse: [getCompatibilitySearchValues](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) , [getCompatibilitySearchValuesBulk](https://developer.ebay.com/devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) Fields ------ metadataVersion ( _[string](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Version information reflects the last update of the values within the dependency graph. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#metadataVersion) to learn which calls use metadataVersion. propertyValues ( _[PropertyValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/PropertyValue.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) This will be populated for the non-fitment enabled category See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#propertyValues) to learn which calls use propertyValues. propertyValuesTree ( _[PropertyNameValue](https://developer.ebay.com/devzone/product-metadata/CallRef/types/PropertyNameValue.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) This will be populated for non-fitment enabled category See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#propertyValuesTree) to learn which calls use propertyValuesTree. treeFormat ( _[boolean](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#boolean) _ ) [\[1\]](https://developer.ebay.com/devzone/product-metadata/CallRef/types/simpletypes.html#multiplicity) Indicates whether the response is flat or in a hierarchical tree format. See the [Field Index](https://developer.ebay.com/devzone/product-metadata/CallRef/fieldindex.html#treeFormat) to learn which calls use treeFormat. --- # MoneyMovementEntries - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) MoneyMovementEntries ==================== This type is used to provide details on any monetary transactions that occur in association with an INR inquiry or a case. Type that uses MoneyMovementEntries: [ClaimHistoryEventModel](https://developer.ebay.com/devzone/post-order/types/ClaimHistoryEventModel.html) Calls that use MoneyMovementEntries: [/post-order/v2/casemanagement/{caseId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_casemanagement-caseid__get.html) , [/post-order/v2/inquiry/{inquiryId} GET](https://developer.ebay.com/devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) Field ----- moneyMovementEntryList ( array of _[MoneyMovementEntry](https://developer.ebay.com/devzone/post-order/types/MoneyMovementEntry.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array contains details about one or more monetary transactions associated with an INR inquiry or a case. This array is only returned if monetary transactions have occurred with the INR inquiry or case. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#moneyMovementEntryList) to learn which calls use moneyMovementEntryList. --- # Enumeration Index - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) Enumeration Index ================= This is a list of all enumeration values in the schema. The same enumeration value name may be used by several calls. A - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byApplication | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/devzone/product/CallRef/types/ErrorCategory.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | Ascending | | | | --- | --- | | [OrderType](https://developer.ebay.com/devzone/product/CallRef/types/OrderType.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | D - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byDescending | | | | --- | --- | | [OrderType](https://developer.ebay.com/devzone/product/CallRef/types/OrderType.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | E - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byError | | | | --- | --- | | [ErrorSeverity](https://developer.ebay.com/devzone/product/CallRef/types/ErrorSeverity.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | F - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/product/CallRef/types/AckValue.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | P - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byPartialFailure | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/product/CallRef/types/AckValue.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | R - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byRequest | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/devzone/product/CallRef/types/ErrorCategory.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | S - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed bySort1 | | | | --- | --- | | [SortPriority](https://developer.ebay.com/devzone/product/CallRef/types/SortPriority.html) | [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | Sort2 | | | | --- | --- | | [SortPriority](https://developer.ebay.com/devzone/product/CallRef/types/SortPriority.html) | [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | Sort3 | | | | --- | --- | | [SortPriority](https://developer.ebay.com/devzone/product/CallRef/types/SortPriority.html) | [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | Sort4 | | | | --- | --- | | [SortPriority](https://developer.ebay.com/devzone/product/CallRef/types/SortPriority.html) | [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | Sort5 | | | | --- | --- | | [SortPriority](https://developer.ebay.com/devzone/product/CallRef/types/SortPriority.html) | [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) | Success | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/product/CallRef/types/AckValue.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | System | | | | --- | --- | | [ErrorCategory](https://developer.ebay.com/devzone/product/CallRef/types/ErrorCategory.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | W - [A](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#A)   [D](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#D)   [E](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#E)   [F](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#F)   [P](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#P)   [R](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#R)   [S](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#S)   [W](https://developer.ebay.com/devzone/product/CallRef/enumindex.html#W)   Enum nameCode list(s) with this enum valueUsed byWarning | | | | --- | --- | | [AckValue](https://developer.ebay.com/devzone/product/CallRef/types/AckValue.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | | [ErrorSeverity](https://developer.ebay.com/devzone/product/CallRef/types/ErrorSeverity.html) | [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html)

[getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html)

[getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) | --- # SetSellerProfileRequest - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) SetSellerProfileRequest ( [BaseRequest](https://developer.ebay.com/Devzone/business-policies/CallRef/types/BaseRequest.html) ) =============================================================================================================================== Sellers use this call to modify one or more business policies. With one call instance, the seller can modify a payment policy, a return policy, a shipping policy, or any combination of the three policy types. Call that uses SetSellerProfileRequest: [setSellerProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/setSellerProfile.html) Fields ------ paymentProfile ( _[PaymentProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfile.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Root container for a seller's payment policy. The **paymentProfile** container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied. The **paymentProfile** container is conditionally required if the seller wants to modify an existing payment policy. Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#paymentProfile) to learn which calls use paymentProfile. returnPolicyProfile ( _[ReturnPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfile.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Root container for a seller's return policy. The **returnPolicyProfile** container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied. The **returnPolicyProfile** container is conditionally required if the seller wants to modify an existing return policy. Sellers only pass in values for the fields that they want to change. To delete an optional field, sellers can pass an empty value into the field. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnPolicyProfile) to learn which calls use returnPolicyProfile. shippingPolicyProfile ( _[ShippingPolicyProfile](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfile.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Root container for a seller's shipping policy. The **shippingPolicyProfile** container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied. The **shippingPolicyProfile** container is conditionally required if the seller wants to modify an existing shipping policy. Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingPolicyProfile) to learn which calls use shippingPolicyProfile. --- # GetSummaryResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) GetSummaryResponse ================== The base response type for the **GET /post-order/v2/return/search** method, which is used to search for return requests. Call that uses GetSummaryResponse: [/post-order/v2/return/search GET](https://developer.ebay.com/devzone/post-order/post-order_v2_return_search__get.html) Fields ------ countSummary ( array of _[CountSummaryType](https://developer.ebay.com/devzone/post-order/types/CountSummaryType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array holds a count of return requests in different states. A separate **count** and **type** pair is returned for each return request state, such as `ALL_OPEN`, `RETURN_STARTED`, or `ITEM_DELIVERED`. The return request states that are returned depend on the use of the **return\_state** query parameter in the request. If this query parameter is omitted in the request, the count for every return request state is returned. However, if this query parameter is used, only the count for the specified return request state will be returned. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#countSummary) to learn which calls use countSummary. members ( array of _[ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This array provides information on one or more return requests that match the filter criteria in the request. This array is returned as empty if no return requests match the filter criteria in the request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#members) to learn which calls use members. paginationOutput ( _[PaginationOutput](https://developer.ebay.com/devzone/post-order/types/PaginationOutput.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of metadata related to the current page of results. It shows the total number of return requests that match the filter criteria, the total number of return requests to show per page of results, and the total number of pages in the results set. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#paginationOutput) to learn which calls use paginationOutput. total ( _[integer](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#integer) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is not currently used. The total number of return requests and the number of return requests on the current page are shown in the **paginationOutput** container. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#total) to learn which calls use total. --- # BaseServiceResponse - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) BaseServiceResponse =================== Base response container for all service operations. Contains error information associated with the request. Calls that use BaseServiceResponse: [findProducts](https://developer.ebay.com/devzone/product/CallRef/findProducts.html) , [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) , [getProductDetails](https://developer.ebay.com/devzone/product/CallRef/getProductDetails.html) Fields ------ ack ( _[AckValue](https://developer.ebay.com/devzone/product/CallRef/types/AckValue.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Indicates whether or not errors or warnings were generated during the processing of the request. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#ack) to learn which calls use ack. errorMessage ( _[ErrorMessage](https://developer.ebay.com/devzone/product/CallRef/types/ErrorMessage.html) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#errorMessage) to learn which calls use errorMessage. timestamp ( _[dateTime](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#dateTime) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#timestamp) to learn which calls use timestamp. version ( _[string](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#string) _ ) [\[0..1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. **Note:** The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#version) to learn which calls use version. --- # GetSellerProfilesResponse - API Reference - Business Policies Management API eBay Business Policies Management APIVersion 1.0.0 * [Features Guide](https://developer.ebay.com/Devzone/guides/features-guide/default.html#features-guide-landing.html) * [Users Guide](https://developer.ebay.com/Devzone/business-policies/Concepts/BusinessPoliciesAPIGuide.html) * [Making a Call](https://developer.ebay.com/Devzone/business-policies/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/Devzone/business-policies/CallRef/index.html) * [Tutorials](https://developer.ebay.com/Devzone/business-policies/HowTo/index.html) * [Release Notes](https://developer.ebay.com/Devzone/business-policies/ReleaseNotes.html) GetSellerProfilesResponse ( [BaseResponse](https://developer.ebay.com/Devzone/business-policies/CallRef/types/BaseResponse.html) ) =================================================================================================================================== Response container for the **getSellerProfiles** call. Call that uses GetSellerProfilesResponse: [getSellerProfiles](https://developer.ebay.com/Devzone/business-policies/CallRef/getSellerProfiles.html) Fields ------ paymentProfileList ( _[PaymentProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/PaymentProfileList.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of one or more payment policies that match the input criteria in the **getSellerProfiles** request. This container is not returned if no payment policies match the input criteria. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#paymentProfileList) to learn which calls use paymentProfileList. returnPolicyProfileList ( _[ReturnPolicyProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ReturnPolicyProfileList.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of one or more return policies that match the input criteria in the **getSellerProfiles** request. This container is not returned if no return policies match the input criteria. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#returnPolicyProfileList) to learn which calls use returnPolicyProfileList. shippingPolicyProfile ( _[ShippingPolicyProfileList](https://developer.ebay.com/Devzone/business-policies/CallRef/types/ShippingPolicyProfileList.html) _ ) [\[0..1\]](https://developer.ebay.com/Devzone/business-policies/CallRef/types/simpletypes.html#multiplicity) Container consisting of one or more shipping policies that match the input criteria in the **getSellerProfiles** request. This container is not returned if no shipping policies match the input criteria. See the [Field Index](https://developer.ebay.com/Devzone/business-policies/CallRef/fieldindex.html#shippingPolicyProfile) to learn which calls use shippingPolicyProfile. --- # GetProductCompatiblitiesResponse - API Reference - Product API eBay Product APIVersion 1.6.0 * [Features Guide](https://developer.ebay.com/devzone/guides/ebayfeatures/index.html) * [Users Guide](https://developer.ebay.com/devzone/product/Concepts/ProductAPIGuide.html) * [Making a Call](https://developer.ebay.com/devzone/product/Concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/product/Concepts/LandAPIRef.html) * [Tutorials](https://developer.ebay.com/devzone/product/HowTo/index.html) * [Release Notes](https://developer.ebay.com/devzone/product/ReleaseNotes.html) GetProductCompatiblitiesResponse ( [BaseServiceResponse](https://developer.ebay.com/devzone/product/CallRef/types/BaseServiceResponse.html) ) ============================================================================================================================================== Response object for getProductFitmentDetails operation. Call that uses GetProductCompatiblitiesResponse: [getProductCompatibilities](https://developer.ebay.com/devzone/product/CallRef/getProductCompatibilities.html) Fields ------ compatibilityDetails ( _[Product](https://developer.ebay.com/devzone/product/CallRef/types/Product.html) _ ) [\[0..\*\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Compatibility details for a single product. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#compatibilityDetails) to learn which calls use compatibilityDetails. paginationOutput ( _[PaginationOutput](https://developer.ebay.com/devzone/product/CallRef/types/PaginationOutput.html) _ ) [\[1\]](https://developer.ebay.com/devzone/product/CallRef/types/simpletypes.html#multiplicity) Indicates the pagination of the result set. Child elements indicate the maximum number of compatibilityDetails nodes returned per response and which page of data has been returned. See the [Field Index](https://developer.ebay.com/devzone/product/CallRef/fieldindex.html#paginationOutput) to learn which calls use paginationOutput. --- # CreateReturnResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) CreateReturnResponse ==================== The base response type of the **POST /post-order/v2/return/create** method, which is used to create a return request. Call that uses CreateReturnResponse: [/post-order/v2/return POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return__post.html) Fields ------ detail ( _[GetDetailResponse](https://developer.ebay.com/devzone/post-order/types/GetDetailResponse.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of detailed information on the return request. This container will not be returned if the **fieldGroups** query parameter is used and its value is set to `SUMMARY` or `NONE`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#detail) to learn which calls use detail. eligibilityResult ( _[ReturnEligibilityPerItemType](https://developer.ebay.com/devzone/post-order/types/ReturnEligibilityPerItemType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of information on the return item and the results for each eligibility check type that was run against the order line item. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#eligibilityResult) to learn which calls use eligibilityResult. returnId ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The unique eBay-assigned ID of the newly created return request. This field is only returned if the return request was successfully created. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#returnId) to learn which calls use returnId. summary ( _[ReturnSummaryType](https://developer.ebay.com/devzone/post-order/types/ReturnSummaryType.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This container consists of summarized information on the return item. This container will not be returned if the **fieldGroups** query parameter is used and its value is set to `FULL` or `NONE`. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#summary) to learn which calls use summary. --- # UploadFileRequest - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) UploadFileRequest ================= The base request type for the **POST /post-order/v2/return/{returnId}/file/upload** and **POST /post-order/v2/return/draft/{draftId}/file/upload** methods. Call that uses UploadFileRequest: [/post-order/v2/return/{returnId}/file/upload POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_file_upload__post.html) Fields ------ data ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The input for this field is a base64-encoded binary representation of the file you are uploading. For images, the system accepts BMP, GIF, JPEG, and PNG files. For shipping labels, the system accepts either an image (BMP, GIF, JPEG, and PNG files) or a PDF file. **Note:** The **data** field supports single-time base64 encoding. For backward compatibility, the data field also presently supports double base64 encoding. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#data) to learn which calls use data. fileName ( _[string](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#string) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is used to name the file that is being uploaded. Naming a file may make it easier for the buyer or seller to keep track of their files, instead of having to remember the **fileId** value (which is returned in the response) of each file. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#fileName) to learn which calls use fileName. filePurpose ( _[FilePurposeEnum](https://developer.ebay.com/devzone/post-order/types/FilePurposeEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) The enumeration value supplied in this required field indicates the purpose of the file that you're uploading. One of the values defined in the [FilePurposeEnum](https://developer.ebay.com/devzone/post-order//devzone/post-order/types/FilePurposeEnum.html) type definition must be used in this field. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#filePurpose) to learn which calls use filePurpose. --- # DecideReturnResponse - API Reference - Post-Order API eBay Post-Order APIVersion 2.8.0 * [User Guide](https://developer.ebay.com/api-docs/user-guides/static/post-order-user-guide-landing.html) * [Making a Call](https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html) * [API Reference](https://developer.ebay.com/devzone/post-order/index.html) * [Release Notes](https://developer.ebay.com/devzone/post-order/ReleaseNotes.html) DecideReturnResponse ==================== The base response type of the **POST /post-order/v2/return/{returnId}/decide** method. Call that uses DecideReturnResponse: [/post-order/v2/return/{returnId}/decide POST](https://developer.ebay.com/devzone/post-order/post-order_v2_return-returnid_decide__post.html) Field ----- refundStatus ( _[Refund\_MoneyMovementStatusEnum](https://developer.ebay.com/devzone/post-order/types/Refund_MoneyMovementStatusEnum.html) _ ) [\[0..?\]](https://developer.ebay.com/devzone/post-order/types/simpletypes.html#multiplicity) This field is only returned in the response if a refund has been requested or initiated. The value in this field indicates the status of any refund action initiated through the **POST /post-order/v2/return/{returnId}/decide** request. See the [Field Index](https://developer.ebay.com/devzone/post-order/fieldindex.html#refundStatus) to learn which calls use refundStatus. ---