eBay (Independent Publisher) (Preview)

eBay is an American multinational e-commerce company that facilitates consumer-to-consumer and business-to-consumer sales through its website.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Artesian Software Technologies LLP
URL	https://artesian.io
Email	amit.sharma@artesian.io

Connector Metadata
Publisher	Artesian Software Technologies LLP
Website	https://www.ebay.com/
Privacy Policy	https://www.ebay.com/help/policies/member-behaviour-policies/user-privacy-notice-privacy-policy?id=4260
Categories	Commerce; Sales and CRM

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Client Id - Your eBay clientId	string	Please enter the client Id.	True
Client Secret	securestring	Please enter the client secret.	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create Inventory Location	Use this call to create a new inventory location. In order to create and publish an offer a seller must have atleast one inventory location, as every offer must be associated with a location.
Create Offer	This call creates an offer for a specific inventory item on a specific eBay marketplace.
Create Or Replace Inventory Item	This call creates a new inventory item record or replaces an existing inventory item record.
Delete Offer	This call will permanently delete the offer
Get Category Suggestions	This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay to most closely correspond to the query.
Get Default Category TreeId	A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the default for that marketplace. This call retrieves a reference to the default category tree associated with the specified eBay marketplace ID.
Get Fulfillment Policies	This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter.
Get Fulfillment Policy	This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.
GET Inventory Item	This call retrieves the inventory item record for a given SKU.
Get Inventory Items	This call retrieves all inventory item records defined for the seller's account.
Get Inventory Location	This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter.
Get Inventory Locations	This call retrieves all defined details for every inventory location associated with the seller's account.
Get Item Aspects for Category	This call returns a list of aspects that are appropriate or necessary for accurately describing items in the specified leaf category. Each aspect identifies an item attribute (for example, color) for which the seller will be required or encouraged to provide a value (or variation values) when offering an item in that category on eBay.
Get Item Condition Policies	This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace.
GET Offer	This call retrieves a specific published or unpublished offer.
GET Offers	This call retrieves all existing offers for the specified SKU value. The seller has the option of limiting the offers that are retrieved to a specific eBay marketplace, or to a listing format.
Get Payment Policies	This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter.
Get Payment Policy	This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.
Get Return Policies	This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.
Get Return Policy	This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.
Publish Offer	This call is used to convert an unpublished offer into a published offer, or live eBay listing. The unique identifier of the offer (offerId) is passed in at the end of the call URI.
Update Offer	This call updates an existing offer that may be in published or in an unpublished state.
Withdraw Offer	This call is used to end a single-variation listing that is associated with the specified offer.

Create Inventory Location

Operation ID:

CreateInventoryLocation

Use this call to create a new inventory location. In order to create and publish an offer a seller must have atleast one inventory location, as every offer must be associated with a location.

Parameters

Name	Key	Required	Type	Description
Merchant Location Key	merchantLocationKey	True	string	Unique merchant-defined key for an inventory location.
Address Line 1	addressLine1		string	First line of a street address.
Address Line 2	addressLine2		string	Second line of a street address.
City	city		string	City in which inventory location resides.
Country	country		string	Country code in which address resides.
County	county		string	County in which address resides.
Postal Code	postalCode		string	Postal/zip code of the address.
State Or Province	stateOrProvince		string	State/province in which inventory location resides.
Latitude	latitude		string	Latitude component of the geographic coordinate.
Longitude	longitude		string	Longitude component of the geographic coordinate.
Location Additional Information	locationAdditionalInformation		string	Additional information about an inventory location.
Location Instructions	locationInstructions		string	Special pickup instructions for a store inventory location.
locationTypes	locationTypes		array of string	Types of location
Location Web Url	locationWebUrl		string	Website address associated with the inventory location.
Merchant Location Status	merchantLocationStatus		string	Inventory location status could be enabled or disabled.
Name	name		string	Name of inventory location.
Day of Week	dayOfWeekEnum		string	Day the store location has regular operating hours.
close	close		string	Store closing time.
open	open		string	Store opening time.
Phone	phone		string	Phone number for a store inventory location.
Date	date		string	Specific date value that the store location has special operating hours.
close	close		string	Store closing time.
open	open		string	Store opening time.

Returns

response

string

Create Offer

Operation ID:

CreateOffer

This call creates an offer for a specific inventory item on a specific eBay marketplace.

Parameters

Name	Key	Required	Type	Description
Available Quantity	availableQuantity		integer	Available quantity of inventory for purchase.
Category Id	categoryId		string	eBay Unique category ID that the product will be listed under.
Charity Id	charityId		string	eBay-assigned unique ID of charitable organization that'll receive a percentage of sales proceeds.
Donation Percentage	donationPercentage		string	Purchase price percentage that charitable organization will receive for each sale that listing generates.
Producer Product Id	producerProductId		string	Unique Identifier of producer related to the item.
Product Package Id	productPackageId		string	Unique ID of the producer of product packaging added by the seller.
Shipment Package Id	shipmentPackageId		string	Unique ID of producer of any packaging used by the seller to ship item.
Product Documentation Id	productDocumentationId		string	Unique Identifier of producer of any paper added to the parcel of the item by the seller.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Format	format		string	Listing format of the offer.
Hide Buyer Details	hideBuyerDetails		boolean	This field is included if the seller wishes to create a private listing.
Include Catalog Product Details	includeCatalogProductDetails		boolean	Indicates whether or not eBay product catalog details are applied to a listing.
Listing Description	listingDescription		string	Description of the eBay listing.
Listing Duration	listingDuration		string	Number of days that the listing will be active.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Best Offer Enabled	bestOfferEnabled		boolean	Indicates whether or not the Best Offer feature is enabled for the listing.
eBay Plus If Eligible	eBayPlusIfEligible		boolean	This field is included in an offer if a Top-Rated seller is opted into the eBay Plus program.
Fulfillment Policy Id	fulfillmentPolicyId		string	Unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing.
Payment Policy Id	paymentPolicyId		string	Unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing.
Product Compliance Policy Ids	productCompliancePolicyIds		array of string	This field contains an array of up to five IDs specifying the seller created compliance policies for the listing.
Return Policy Id	returnPolicyId		string	Return business policy unique ID that will be used once an offer is published and converted to an eBay listing.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Priority	priority		integer	The integer value input into this field, along with the shippingServiceType value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Service Type	shippingServiceType		string	This value indicates whether the shipping service specified in the priority field is a domestic or an international shipping service option.
Take Back Policy Id	takeBackPolicyId		string	Seller ID who created take-back policy.
Listing Start Date	listingStartDate		string	This field can be used if the seller wants to specify a time in the future that the listing will become active on eBay.
Lot Size	lotSize		integer	This field is only applicable if the listing is a lot listing. The integer value passed into this field is the total number of items in the lot.
Marketplace Id	marketplaceId		string	eBay site unique ID for which the offer will be made available.
Merchant Location Key	merchantLocationKey		string	Unique identifier of a merchant's inventory location
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Originally Sold for Retail Price On	originallySoldForRetailPriceOn		string	This field is needed if the Strikethrough Pricing feature will be used in the offer. This field indicates that the product was sold for the price in the original RetailPrice field on an eBay site, or sold for that price by a third-party retailer
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Pricing Visibility	pricingVisibility		string	This field is needed if the Minimum Advertised Price feature will be used in the offer.
Quantity Limit Per Buyer	quantityLimitPerBuyer		integer	This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller.
Secondary Category Id	secondaryCategoryId		string	Unique secondary category ID and applicable if the seller decides to list item under two categories.
SKU	sku		string	Seller-defined SKU value of product that will be listed on the eBay site.
Store Category Names	storeCategoryNames		array of string	Store Category Name
Apply Tax	applyTax		boolean	This container is only applicable and used if a sales tax table, a Value-Added Tax rate, or a tax exception category code will be applied to the offer.
Third Party Tax Category	thirdPartyTaxCategory		string	The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price.
VAT Percentage	vatPercentage		number	This value is VAT rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page.

Returns

Name	Path	Type	Description
Offer Id	offerId	string	Unique identifier of the offer
warnings	warnings	array of object	This container will return when a call is made, and errors and/or warnings occur.
Category	warnings.category	string	This string value indicates the error category
Domain	warnings.domain	string	Domain name in which the error or warning occurred.
Error Id	warnings.errorId	integer	Unique code that identifies the particular error or warning that occurred.
inputRefIds	warnings.inputRefIds	array of string	An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
Long Message	warnings.longMessage	string	A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
Message	warnings.message	string	A description of condition that caused the error or warning.
outputRefIds	warnings.outputRefIds	array of string	An array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.
parameters	warnings.parameters	array of object	Various warning and error messages return one or more variables that contain contextual information about the error or warning.
name	warnings.parameters.name	string	name
value	warnings.parameters.value	string	value
Subdomain	warnings.subdomain	string	Subdomain name in which the error or warning occurred.

Create Or Replace Inventory Item

Operation ID:

CreateOrReplaceInventoryItem

This call creates a new inventory item record or replaces an existing inventory item record.

Parameters

Name	Key	Required	Type	Description
SKU	sku	True	string	Seller-defined value for the inventory item.
Content-Language	Content-Language	True	string	The header sets the natural language that will be used in the field values of the request payload.
Type	availabilityType		string	Availability status of inventory item at merchant's physical store.
Unit	unit		string	Time unit used to specify the fulfillment time.
Value	value		integer	Fulfillment time value.
Merchant Location Key	merchantLocationKey		string	Merchant's store Unique ID where In-Store Pickup inventory item is currently located or will sent to.
Quantity	quantity		integer	Quantity of inventory item available for In-Store Pickup.
Unit	unit		string	Time unit used to specify the fulfillment time.
Value	value		integer	Fulfillment time value.
Merchant Location Key	merchantLocationKey		string	Merchant's store unique ID where In-Store Pickup inventory item is currently located, or will be sent to.
Quantity	quantity		integer	Quantity of the inventory item that is available at this inventory location.
Quantity	quantity		integer	Total 'ship-to-home' quantity of inventory item that will be available for purchase through one or more published offers.
Condition	condition		string	Condition of the item.
Condition Description	conditionDescription		string	Condition description of an inventory item.
Height	height		number	Actual height of shipping package.
Length	length		number	Actual length of shipping package.
Unit	unit		string	The unit of measurement used to specify the dimensions of a shipping package.
Width	width		number	The actual width of the shipping package.
Package Type	packageType		string	Shipping package value used to ship the inventory item.
Unit	unit		string	The unit of measurement used to specify the weight of a shipping package.
Value	value		number	The actual weight of the shipping package.
Aspects	aspects		object	This is a collection of item specifics name-value pairs that provide more information about the product and might make it easier for buyers to find.
Brand	brand		string	Brand of the product.
Description	description		string	Description of the product.
EAN items	ean		array of string	EAN
ePID	epid		string	eBay Product Identifier for the product.
Image Urls	imageUrls		array of string	Image Urls
ISBN items	isbn		array of string	ISBN
MPN	mpn		string	Manufacturer Part Number of a product.
Subtitle	subtitle		string	Optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results.
Title	title		string	Title of an inventory item can be added or modified.
UPC items	upc		array of string	upc
Video Ids	videoIds		array of string	videoIds

Returns

Name	Path	Type	Description
warnings	warnings	array of object	This container will be returned in a call response payload if one or more warnings or errors are triggered.
Category	warnings.category	string	This string value indicates the error category.
Domain	warnings.domain	string	The name of the domain in which the error or warning occurred.
Error Id	warnings.errorId	integer	A unique code that identifies the particular error or warning that occurred.
inputRefIds	warnings.inputRefIds	array of string	An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
Long Message	warnings.longMessage	string	A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
Message	warnings.message	string	A description of the condition that caused the error or warning.
outputRefIds	warnings.outputRefIds	array of string	An array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.
parameters	warnings.parameters	array of object	Various warning and error messages return one or more variables that contain contextual information about the error or warning.
name	warnings.parameters.name	string	name
value	warnings.parameters.value	string	value
Subdomain	warnings.subdomain	object	A description of the condition that caused the error or warning.

Delete Offer

Operation ID:

DeleteOffer

This call will permanently delete the offer

Parameters

Name	Key	Required	Type	Description
Offer Id	offerId	True	string	Unique identifier of the offer to delete.

Returns

response

string

Get Category Suggestions

Operation ID:

GetCategorySuggestions

This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay to most closely correspond to the query.

Parameters

Name	Key	Required	Type	Description
Category Tree Id	category_tree_id	True	string	eBay category tree unique identifier for which suggested nodes are being requested.
Search Term	q	True	string	A search term that describes the item being offered for sale.

Returns

Name	Path	Type	Description
categorySuggestions	categorySuggestions	array of object	Contains details about one or more suggested categories that correspond to the provided keywords.
Category Id	categorySuggestions.category.categoryId	string	Unique identifier of the eBay category within its category tree.
Category Name	categorySuggestions.category.categoryName	string	Name of category identified by categoryId.
Category Tree Node Ancestors	categorySuggestions.categoryTreeNodeAncestors	array of object	An array of ordered list of category references that describes the location of the suggested category in the specified category tree.
categoryId	categorySuggestions.categoryTreeNodeAncestors.categoryId	string	Unique identifier of the eBay ancestor category.
categoryName	categorySuggestions.categoryTreeNodeAncestors.categoryName	string	Name of the ancestor category identified by categoryId.
categorySubtreeNodeHref	categorySuggestions.categoryTreeNodeAncestors.categorySubtreeNodeHref	string	The href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node.
categoryTreeNodeLevel	categorySuggestions.categoryTreeNodeAncestors.categoryTreeNodeLevel	integer	Absolute level of the ancestor category node in the hierarchy of its category tree.
Category Tree Node Level	categorySuggestions.categoryTreeNodeLevel	integer	Absolute level of the ancestor category node in the hierarchy of its category tree.
Relevancy	categorySuggestions.relevancy	string	This field is reserved for internal or future use.
Category Tree Id	categoryTreeId	string	Unique identifier of the eBay category tree from which suggestions are returned.
Category Tree Version	categoryTreeVersion	string	The version of the category tree identified by categoryTreeId.

Get Default Category TreeId

Operation ID:

GetDefaultCategoryTreeId

A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the default for that marketplace. This call retrieves a reference to the default category tree associated with the specified eBay marketplace ID.

Parameters

Name	Key	Required	Type	Description
Marketplace ID	marketplace_id	True	string	eBay marketplace ID for which the category tree ID is being requested.
Accept-Language	Accept-Language	True	string	A header used to indicate the natural language the seller prefers for the response.

Returns

Name	Path	Type	Description
Category Tree ID	categoryTreeId	string	eBay unique category tree ID for the specified marketplace.
Category Tree Version	categoryTreeVersion	string	The version of the category tree identified by categoryTreeId.

Get Fulfillment Policies

Operation ID:

GetFulfillmentPolicies

This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter.

Parameters

Name	Key	Required	Type	Description
Marketplace Id	marketplace_id	True	string	eBay marketplace ID of the policies you want to retrieve.

Returns

Name	Path	Type	Description
fulfillmentPolicies	fulfillmentPolicies	array of object	List of seller's fulfillment policies defined for the specified marketplace.
Category Types	fulfillmentPolicies.categoryTypes	array of object	This container indicates whether the fulfillment policy applies to motor or non-motor vehicle listings.
name	fulfillmentPolicies.categoryTypes.name	string	The category type to which the policy applies
Description	fulfillmentPolicies.description	string	A seller-defined description of the fulfillment policy.
Freight Shipping	fulfillmentPolicies.freightShipping	boolean	If returned as true, the seller offers freight shipping for large items over 150 lbs.
Fulfillment Policy Id	fulfillmentPolicies.fulfillmentPolicyId	string	Unique eBay-assigned ID for the fulfillment policy.
Global Shipping	fulfillmentPolicies.globalShipping	boolean	If returned as true, eBay's Global Shipping Program will be used by the seller to ship items to international locations.
Unit	fulfillmentPolicies.handlingTime.unit	string	Time measurement unit, such as DAY.
Value	fulfillmentPolicies.handlingTime.value	integer	Time-measurement unit value specified in the unit field.
Local Pickup	fulfillmentPolicies.localPickup	boolean	If returned as true, local pickup is available for this policy.
Marketplace Id	fulfillmentPolicies.marketplaceId	string	ID of the eBay marketplace to which this fulfillment policy applies.
Name	fulfillmentPolicies.name	string	A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.
Pickup Drop Off	fulfillmentPolicies.pickupDropOff	boolean	If returned as true, the seller offers the "Click and Collect" option.
shippingOptions	fulfillmentPolicies.shippingOptions	array of object	The array provide detailed information on the domestic and international shipping options available for the policy.
Cost Type	fulfillmentPolicies.shippingOptions.costType	string	This field defines whether shipping cost model is FLAT_RATE or CALCULATED
Currency	fulfillmentPolicies.shippingOptions.insuranceFee.currency	string	Base currency applied to the value field to establish a monetary amount.
Value	fulfillmentPolicies.shippingOptions.insuranceFee.value	string	The monetary amount in the specified currency.
optionType	fulfillmentPolicies.shippingOptions.optionType	string	optionType
currency	fulfillmentPolicies.shippingOptions.packageHandlingCost.currency	string	currency
value	fulfillmentPolicies.shippingOptions.packageHandlingCost.value	string	value
rateTableId	fulfillmentPolicies.shippingOptions.rateTableId	string	rateTableId
shippingServices	fulfillmentPolicies.shippingOptions.shippingServices	array of object	shippingServices
currency	fulfillmentPolicies.shippingOptions.shippingServices.additionalShippingCost.currency	string	currency
value	fulfillmentPolicies.shippingOptions.shippingServices.additionalShippingCost.value	string	value
buyerResponsibleForPickup	fulfillmentPolicies.shippingOptions.shippingServices.buyerResponsibleForPickup	boolean	buyerResponsibleForPickup
buyerResponsibleForShipping	fulfillmentPolicies.shippingOptions.shippingServices.buyerResponsibleForShipping	boolean	buyerResponsibleForShipping
currency	fulfillmentPolicies.shippingOptions.shippingServices.cashOnDeliveryFee.currency	string	currency
value	fulfillmentPolicies.shippingOptions.shippingServices.cashOnDeliveryFee.value	string	value
freeShipping	fulfillmentPolicies.shippingOptions.shippingServices.freeShipping	boolean	freeShipping
shippingCarrierCode	fulfillmentPolicies.shippingOptions.shippingServices.shippingCarrierCode	string	shippingCarrierCode
currency	fulfillmentPolicies.shippingOptions.shippingServices.shippingCost.currency	string	currency
value	fulfillmentPolicies.shippingOptions.shippingServices.shippingCost.value	string	value
shippingServiceCode	fulfillmentPolicies.shippingOptions.shippingServices.shippingServiceCode	string	shippingServiceCode
regionExcluded	fulfillmentPolicies.shippingOptions.shippingServices.shipToLocations.regionExcluded	array of object	regionExcluded
regionName	fulfillmentPolicies.shippingOptions.shippingServices.shipToLocations.regionExcluded.regionName	string	regionName
regionType	fulfillmentPolicies.shippingOptions.shippingServices.shipToLocations.regionExcluded.regionType	string	regionType
regionIncluded	fulfillmentPolicies.shippingOptions.shippingServices.shipToLocations.regionIncluded	array of object	regionIncluded
regionName	fulfillmentPolicies.shippingOptions.shippingServices.shipToLocations.regionIncluded.regionName	string	regionName
regionType	fulfillmentPolicies.shippingOptions.shippingServices.shipToLocations.regionIncluded.regionType	string	regionType
sortOrder	fulfillmentPolicies.shippingOptions.shippingServices.sortOrder	integer	sortOrder
currency	fulfillmentPolicies.shippingOptions.shippingServices.surcharge.currency	string	currency
value	fulfillmentPolicies.shippingOptions.shippingServices.surcharge.value	string	value
Region Excluded	fulfillmentPolicies.shipToLocations.regionExcluded	array of object	An array of regionName values that specify the areas to where a seller does not ship.
regionName	fulfillmentPolicies.shipToLocations.regionExcluded.regionName	string	regionName
regionType	fulfillmentPolicies.shipToLocations.regionExcluded.regionType	string	regionType
Region Included	fulfillmentPolicies.shipToLocations.regionIncluded	array of object	An array of regionName fields that specify the areas to where a seller ships.
regionName	fulfillmentPolicies.shipToLocations.regionIncluded.regionName	string	regionName
regionType	fulfillmentPolicies.shipToLocations.regionIncluded.regionType	string	regionType
Href	href	string	This field is for future use.
Limit	limit	integer	This field is for future use.
Next	next	string	This field is for future use.
Offset	offset	integer	This field is for future use.
Prev	prev	string	This field is for future use.
Total	total	integer	Total number of fulfillment policies retrieved in the result set.

Get Fulfillment Policy

Operation ID:

GetFulfillmentPolicy

This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.

Parameters

Name	Key	Required	Type	Description
Fulfillment Policy Id	fulfillmentPolicyId	True	string	Fulfillment Policy Id you want to retrieve

Returns

Name	Path	Type	Description
categoryTypes	categoryTypes	array of object	This container indicates whether the fulfillment policy applies to motor vehicle listings or non-motor vehicle listings.
Name	categoryTypes.name	string	Category type name to which the policy applies.
Description	description	string	A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.
Freight Shipping	freightShipping	boolean	If returned as true, the seller offers freight shipping.
Fulfillment PolicyId	fulfillmentPolicyId	string	Unique eBay-assigned ID for the fulfillment policy.
Global Shipping	globalShipping	boolean	If returned as true, eBay's Global Shipping Program will be used by the seller to ship items to international locations.
Unit	handlingTime.unit	string	A span of time is defined when you apply the value specified in the value field to the value specified for unit.
Value	handlingTime.value	integer	Time-measurement unit value specified in the unit field.
Local Pickup	localPickup	boolean	If returned as true, local pickup is available for this policy.
Marketplace Id	marketplaceId	string	eBay marketplace ID to which this fulfillment policy applies.
Name	name	string	Unique seller-defined name for this fulfillment policy.
Pickup Drop Off	pickupDropOff	boolean	If returned as true, the seller offers the "Click and Collect" option.
shippingOptions	shippingOptions	array of object	This array is used to provide detailed information on the domestic and international shipping options available for the policy.
Cost Type	shippingOptions.costType	string	This field defines whether the shipping cost model is FLAT_RATE or CALCULATED
Option Type	shippingOptions.optionType	string	This field is used to indicate if the corresponding shipping service options are either domestic or international.
Currency	shippingOptions.packageHandlingCost.currency	string	The base currency applied to the value field to establish a monetary amount.
Value	shippingOptions.packageHandlingCost.value	string	The monetary amount in the specified currency.
Rate Table Id	shippingOptions.rateTableId	string	This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy.
shippingServices	shippingOptions.shippingServices	array of object	This array consists of the domestic or international shipping services options that are defined for the policy.
currency	shippingOptions.shippingServices.additionalShippingCost.currency	string	currency
value	shippingOptions.shippingServices.additionalShippingCost.value	string	value
buyerResponsibleForPickup	shippingOptions.shippingServices.buyerResponsibleForPickup	boolean	This field should be included for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made.
buyerResponsibleForShipping	shippingOptions.shippingServices.buyerResponsibleForShipping	boolean	This field should be included for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a purchased motor vehicle after full payment is made
currency	shippingOptions.shippingServices.cashOnDeliveryFee.currency	string	currency
value	shippingOptions.shippingServices.cashOnDeliveryFee.value	string	value
freeShipping	shippingOptions.shippingServices.freeShipping	boolean	This field is included if the seller offers a free shipping option to the buyer.
shippingCarrierCode	shippingOptions.shippingServices.shippingCarrierCode	string	This field sets/indicates the shipping carrier.
currency	shippingOptions.shippingServices.shippingCost.currency	string	currency
value	shippingOptions.shippingServices.shippingCost.value	string	value
shippingServiceCode	shippingOptions.shippingServices.shippingServiceCode	string	This field sets/indicates the domestic or international shipping service option.
regionExcluded	shippingOptions.shippingServices.shipToLocations.regionExcluded	array of object	regionExcluded
regionName	shippingOptions.shippingServices.shipToLocations.regionExcluded.regionName	string	regionName
regionType	shippingOptions.shippingServices.shipToLocations.regionExcluded.regionType	string	regionType
regionIncluded	shippingOptions.shippingServices.shipToLocations.regionIncluded	array of object	regionIncluded
regionName	shippingOptions.shippingServices.shipToLocations.regionIncluded.regionName	string	regionName
regionType	shippingOptions.shippingServices.shipToLocations.regionIncluded.regionType	string	regionType
sortOrder	shippingOptions.shippingServices.sortOrder	integer	The integer value set in this field controls the order of shipping service.
regionExcluded	shipToLocations.regionExcluded	array of object	An array of regionName values that specify the areas to where a seller does not ship.
Region Name	shipToLocations.regionExcluded.regionName	string	A string that indicates the name of a region, as defined by eBay.
Region Type	shipToLocations.regionExcluded.regionType	string	Reserved for future use.
regionIncluded	shipToLocations.regionIncluded	array of object	An array of regionName fields that specify the areas to where a seller ships.
Region Name	shipToLocations.regionIncluded.regionName	string	A string that indicates the name of a region, as defined by eBay.
Region Type	shipToLocations.regionIncluded.regionType	string	Reserved for future use.

GET Inventory Item

Operation ID:

GetInventoryItem

This call retrieves the inventory item record for a given SKU.

Parameters

Name	Key	Required	Type	Description
SKU	sku	True	string	Seller-defined value of the product whose inventory item record you wish to retrieve.

Returns

Name	Path	Type	Description
PickupAtLocationAvailability	availability.pickupAtLocationAvailability	array of object	This container consists of an array of merchant's physical stores where the inventory item is available for in-store pickup.
Availability Type	availability.pickupAtLocationAvailability.availabilityType	string	This field indicates the availability status of the inventory item at the merchant's physical store.
Unit	availability.pickupAtLocationAvailability.fulfillmentTime.unit	string	The value indicates the time unit used to specify the fulfillment time
Value	availability.pickupAtLocationAvailability.fulfillmentTime.value	integer	The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time.
Merchant Location Key	availability.pickupAtLocationAvailability.merchantLocationKey	string	Merchant's store unique identifier where the In-Store Pickup inventory item is currently located, or will be sent to.
Quantity	availability.pickupAtLocationAvailability.quantity	integer	This integer value indicates the quantity of the inventory item that is available for In-Store Pickup
Auction	availability.shipToLocationAvailability.allocationByFormat.auction	integer	This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU.
Fixed Price	availability.shipToLocationAvailability.allocationByFormat.fixedPrice	integer	This integer value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU.
AvailabilityDistributions	availability.shipToLocationAvailability.availabilityDistributions	array of object	This container is used to set the available quantity of the inventory item at one or more warehouse locations.
Unit	availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime.unit	string	The value indicates the time unit used to specify the fulfillment time
Value	availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime.value	integer	The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time.
Merchant Location Key	availability.shipToLocationAvailability.availabilityDistributions.merchantLocationKey	string	Unique identifier of an inventory location where quantity is available for the inventory item.
Quantity	availability.shipToLocationAvailability.availabilityDistributions.quantity	integer	Quantity of the inventory item that is available at this inventory location.
Quantity	availability.shipToLocationAvailability.quantity	integer	This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers.
Condition	condition	string	This value indicates the condition of the item
Condition Description	conditionDescription	string	This string field is used by the seller to more clearly describe the condition of used items, or items that are not 'Brand New', 'New with tags', or 'New in box'.
groupIds	groupIds	array of string
inventoryItemGroupKeys	inventoryItemGroupKeys	array of string	This array is returned if the inventory item is associated with any inventory item group(s).
Locale	locale	string	This field returns the natural language that was provided in the field values of the request payload
Height	packageWeightAndSize.dimensions.height	number	The actual height of the shipping package.
Length	packageWeightAndSize.dimensions.length	number	The actual length of the shipping package.
Unit	packageWeightAndSize.dimensions.unit	string	Unit of measurement used to specify the dimensions of a shipping package.
Width	packageWeightAndSize.dimensions.width	number	The actual width of the shipping package.
Package Type	packageWeightAndSize.packageType	string	This value indicates the type of shipping package used to ship the inventory item.
Unit	packageWeightAndSize.weight.unit	string	The unit of measurement used to specify the weight of a shipping package.
Value	packageWeightAndSize.weight.value	number	The actual weight of the shipping package.
Aspects	product.aspects	object	This is a collection of item specifics name-value pairs that provide more information about the product and might make it easier for buyers to find.
Brand	product.brand	string	The brand of the product.
Description	product.description	string	The description of the product.
ean	product.ean	array of string	European Article Number/International Article Number (EAN) for the product.
ePID	product.epid	string	The eBay Product Identifier (ePID) for the product.
imageUrls	product.imageUrls	array of string	An array of one or more links to images for the product.
isbn	product.isbn	array of string	International Standard Book Number value for the product.
MPN	product.mpn	string	The Manufacturer Part Number (MPN) of a product.
Subtitle	product.subtitle	string	A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results.
Title	product.title	string	The title of an inventory item can be added or modified with a createOrReplaceInventoryItem call.
upc	product.upc	array of string	International Standard Book Number value for the product.
videoIds	product.videoIds	array of string	An array of one or more VideoId values for the product.
SKU	sku	string	The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The seller should have a unique SKU value for every product that they sell.

Get Inventory Items

Operation ID:

GetInventoryItems

This call retrieves all inventory item records defined for the seller's account.

Parameters

Name	Key	Required	Type	Description
Limit	limit		string	Maximum number of records to return per page of data.
Offset	offset		string	The page number to retrieve.

Returns

Name	Path	Type	Description
Href	href	string	This is the URL to the current page of inventory items.
inventoryItems	inventoryItems	array of object	This container is an array of one or more inventory items.
pickupAtLocationAvailability	inventoryItems.availability.pickupAtLocationAvailability	array of object	This container consists of an array of merchant's physical stores where the inventory item is available for in-store pickup.
availabilityType	inventoryItems.availability.pickupAtLocationAvailability.availabilityType	string	Availability status of the inventory item
unit	inventoryItems.availability.pickupAtLocationAvailability.fulfillmentTime.unit	string	Time unit used to specify the fulfillment time
value	inventoryItems.availability.pickupAtLocationAvailability.fulfillmentTime.value	integer	The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time.
merchantLocationKey	inventoryItems.availability.pickupAtLocationAvailability.merchantLocationKey	string	Merchant's store Unique identifier where the In-Store Pickup inventory item is currently located, or will sent to.
quantity	inventoryItems.availability.pickupAtLocationAvailability.quantity	integer	quantity
Auction	inventoryItems.availability.shipToLocationAvailability.allocationByFormat.auction	integer	This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU.
Fixed Price	inventoryItems.availability.shipToLocationAvailability.allocationByFormat.fixedPrice	integer	This value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU.
availabilityDistributions	inventoryItems.availability.shipToLocationAvailability.availabilityDistributions	array of object	This container is used to set the available quantity of the inventory item at one or more warehouse locations.
unit	inventoryItems.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime.unit	string	unit
value	inventoryItems.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime.value	integer	value
merchantLocationKey	inventoryItems.availability.shipToLocationAvailability.availabilityDistributions.merchantLocationKey	string	merchantLocationKey
quantity	inventoryItems.availability.shipToLocationAvailability.availabilityDistributions.quantity	integer	quantity
Quantity	inventoryItems.availability.shipToLocationAvailability.quantity	integer	This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offer
Condition	inventoryItems.condition	string	This value indicates the condition of the item.
Condition Description	inventoryItems.conditionDescription	string	This string field is used by the seller to more clearly describe the condition of items
groupIds	inventoryItems.groupIds	array of string	This array is returned if the inventory item is associated with any inventory item group(s).
inventoryItemGroupKeys	inventoryItems.inventoryItemGroupKeys	array of string	This array is returned if the inventory item is associated with any inventory item group(s).
Locale	inventoryItems.locale	string	This field returns the natural language that was provided in the field values of the request payload.
Height	inventoryItems.packageWeightAndSize.dimensions.height	number	Actual height of the shipping package.
Length	inventoryItems.packageWeightAndSize.dimensions.length	number	Actual length of the shipping package.
Unit	inventoryItems.packageWeightAndSize.dimensions.unit	string	Unit of measurement used to specify the dimensions of a shipping package.
Width	inventoryItems.packageWeightAndSize.dimensions.width	number	Actual width of the shipping package.
Width	inventoryItems.packageWeightAndSize.packageType	string	Type of shipping package used to ship the inventory item.
Unit	inventoryItems.packageWeightAndSize.weight.unit	string	Unit of measurement used to specify the weight of a shipping package.
Value	inventoryItems.packageWeightAndSize.weight.value	number	The actual weight of the shipping package.
Aspects	inventoryItems.product.aspects	object	This is a collection of item specifics name-value pairs that provide more information about the product and might make it easier for buyers to find.
Brand	inventoryItems.product.brand	string	The brand of the product. This field is often paired with the mpn field to identify a specific product by Manufacture Part Number.
Description	inventoryItems.product.description	string	The description of the product.
ean	inventoryItems.product.ean	array of string	European Article Number/International Article Number for the product.
ePID	inventoryItems.product.epid	string	The eBay Product Identifier (ePID) for the product.
imageUrls	inventoryItems.product.imageUrls	array of string	An array of one or more links to images for the product.
isbn	inventoryItems.product.isbn	array of string	International Standard Book Number value for the product.
MPN	inventoryItems.product.mpn	string	Manufacturer Part Number of a product.
Subtitle	inventoryItems.product.subtitle	string	A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results.
Title	inventoryItems.product.title	string	Title of an inventory item can be added or modified
upc	inventoryItems.product.upc	array of string	Universal Product Code value for the product.
videoIds	inventoryItems.product.videoIds	array of string	An array of one or more VideoId values for the product.
SKU	inventoryItems.sku	string	Seller-defined Stock-Keeping Unit of the inventory item.
Limit	limit	integer	The number of inventory items that will be displayed on each results page.
Next	next	string	URL to the next page of inventory items.
Prev	prev	string	URL to the previous page of inventory items.
Size	size	integer	Total number of pages of results that are available.
Total	total	integer	Ttotal number of inventory items that exist for the seller's account.

Get Inventory Location

Operation ID:

GetInventoryLocation

This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter.

Parameters

Name	Key	Required	Type	Description
Merchant Location Key	merchantLocationKey	True	string	A unique merchant-defined key (ID) for an inventory location.

Returns

Name	Path	Type	Description
Address Line 1	location.address.addressLine1	string	First line of a street address.
Address Line 2	location.address.addressLine2	string	Second line of a street address.
CIty	location.address.city	string	City in which the inventory location resides.
Country	location.address.country	string	Country code in which the address resides
County	location.address.county	string	County in which the address resides.
Postal Code	location.address.postalCode	string	Postal/zip code of the address.
State Or Province	location.address.stateOrProvince	string	State/province in which the inventory location resides.
Latitude	location.geoCoordinates.latitude	string	Latitude component of the geographic coordinate.
Longitude	location.geoCoordinates.longitude	string	Longitude component of the geographic coordinate.
Location Id	location.locationId	string	Unique eBay-assigned ID for the location.
Location Additional Information	locationAdditionalInformation	string	This text field provides additional information about an inventory location.
Location Instructions	locationInstructions	string	The field is used by the merchant to provide special pickup instructions for the store location.
locationTypes	locationTypes	array of string	This container defines the function of the inventory location.
Location Web Url	locationWebUrl	string	The field shows the Website address associated with the inventory location.
Merchant Location Key	merchantLocationKey	string	Unique identifier of the inventory location.
Merchant Location Status	merchantLocationStatus	string	The field indicates whether the inventory location is enabled or disabled
Name	name	string	Name of the inventory location.
operatingHours	operatingHours	array of object	This container shows the regular operating hours for a store location during the days of the week.
Week Enum	operatingHours.dayOfWeekEnum	string	A value is required for each day of the week that the store location has regular operating hours.
intervals	operatingHours.intervals	array of object	This container is used to define the opening/closing times of a store's working day.
close	operatingHours.intervals.close	string	close
open	operatingHours.intervals.open	string	open
Phone	phone	string	Phone number for an inventory location.
SpecialHours	specialHours	array of object	This container shows the special operating hours for a store location on a specific date or dates.
Date	specialHours.date	string	A date value is required for each specific date that the store location has special operating hours.
intervals	specialHours.intervals	array of object	This container is used to define the opening/closing times of a store on a specific date.
close	specialHours.intervals.close	string	close
open	specialHours.intervals.open	string	open

Get Inventory Locations

Operation ID:

GetInventoryLocations

This call retrieves all defined details for every inventory location associated with the seller's account.

Parameters

Name	Key	Required	Type	Description
Offset	offset		string	Specifies the number of locations to skip in the result set before returning the first location.
Limit	limit		string	Maximum number of records to return per page of data.

Returns

Name	Path	Type	Description
Href	href	string	URI of the current page of results from the result set.
Limit	limit	integer	Number of items returned on a single page from the result set.
Next	next	string	URI for the following page of results.
Offset	offset	string	Number of results skipped in the result set before listing the first returned result.
Prev	prev	string	URI for the preceding page of results.
Total	total	integer	Total number of items retrieved in the result set.
locations	locations	array of object	An array of one or more of the merchant's inventory locations.
Address Line 1	locations.location.address.addressLine1	string	First line of a street address.
Address Line 2	locations.location.address.addressLine2	string	Second line of a street address.
City	locations.location.address.city	string	City in which the inventory location resides.
Country	locations.location.address.country	string	Country code in which the address resides.
County	locations.location.address.county	string	County in which the address resides.
Postal Code	locations.location.address.postalCode	string	Postal/zip code of the address.
State Or Province	locations.location.address.stateOrProvince	string	State/province in which the inventory location resides.
Latitude	locations.location.geoCoordinates.latitude	string	Latitude component of the geographic coordinate.
Longitude	locations.location.geoCoordinates.longitude	string	Longitude component of the geographic coordinate.
Location Id	locations.location.locationId	string	Unique eBay-assigned ID for the location.
Location Additional Information	locations.locationAdditionalInformation	string	This field provides additional information about an inventory location.
Location Instructions	locations.locationInstructions	string	This field is used by the merchant to provide special pickup instructions for the store location.
locationTypes	locations.locationTypes	array of string	This container defines the function of the inventory location.
Location Web Url	locations.locationWebUrl	string	This field shows the Website address associated with the inventory location.
Merchant Location Key	locations.merchantLocationKey	string	Unique identifier of the inventory location.
Merchant Location Status	locations.merchantLocationStatus	string	This field indicates whether the inventory location is enabled or disabled.
Name	locations.name	string	Name of the inventory location.
operatingHours	locations.operatingHours	array of object	This container shows the regular operating hours for a store location during the days of the week.
dayOfWeekEnum	locations.operatingHours.dayOfWeekEnum	string	dayOfWeekEnum
intervals	locations.operatingHours.intervals	array of object	This container is used to define the opening/closing times of a store's working day.
close	locations.operatingHours.intervals.close	string	close
open	locations.operatingHours.intervals.open	string	open
Phone	locations.phone	string	The phone number for an inventory location.
specialHours	locations.specialHours	array of object	This container shows the special operating hours for a store location on a specific date or dates.
date	locations.specialHours.date	string	date
intervals	locations.specialHours.intervals	array of object	This container is used to define the opening and closing times of a store on a specific date.
close	locations.specialHours.intervals.close	string	close
open	locations.specialHours.intervals.open	string	open

Get Item Aspects for Category

Operation ID:

GetItemAspects

This call returns a list of aspects that are appropriate or necessary for accurately describing items in the specified leaf category. Each aspect identifies an item attribute (for example, color) for which the seller will be required or encouraged to provide a value (or variation values) when offering an item in that category on eBay.

Parameters

Name	Key	Required	Type	Description
Category Tree Id	category_tree_id	True	string	eBay category tree Unique ID from which the specified category's aspects are being requested.
Category Id	category_id	True	string	Leaf category unique identifier for which aspects are being requested.

Returns

Name	Path	Type	Description
aspects	aspects	array of object	List of item aspects that are appropriate for describing items in a particular leaf category
Aspect Applicable To	aspects.aspectConstraint.aspectApplicableTo	array of string	This value indicate if the aspect identified by the aspects.localizedAspectName field is a product aspect or an item/instance aspect, which is an aspect whose value will vary based on a particular instance of the product.
Aspect Data Type	aspects.aspectConstraint.aspectDataType	string	Aspect data type.
Aspect Enabled For Variations	aspects.aspectConstraint.aspectEnabledForVariations	boolean	A value of true indicates that this aspect can be used to help identify item variations.
Aspect Format	aspects.aspectConstraint.aspectFormat	string	Returned only if the value of aspectDataType identifies a data type that requires specific formatting.
Aspect Max Length	aspects.aspectConstraint.aspectMaxLength	integer	Maximum length of the item aspect's value.
Aspect Mode	aspects.aspectConstraint.aspectMode	string	Manner in which values of this aspect must be specified by the seller.
Aspect Required	aspects.aspectConstraint.aspectRequired	boolean	A value of true indicates that this aspect is required when offering items in the specified category.
Aspect Usage	aspects.aspectConstraint.aspectUsage	string	The value indicates if the corresponding aspect is recommended or optional.
Expected Required By Date	aspects.aspectConstraint.expectedRequiredByDate	string	Expected date after which the aspect will be required.
Item To Aspect Cardinality	aspects.aspectConstraint.itemToAspectCardinality	string	Indicates whether this aspect can accept single or multiple values for items in the specified category.
aspectValues	aspects.aspectValues	array of object	A list of valid values along with any constraints for this aspect.
localizedValue	aspects.aspectValues.localizedValue	string	The localized value of this aspect.
valueConstraints	aspects.aspectValues.valueConstraints	array of object	Contains a list of the dependencies that identify when the value of the localizedValue field is available for the current aspect.
applicableForLocalizedAspectName	aspects.aspectValues.valueConstraints.applicableForLocalizedAspectName	string	The name of the control aspect on which the current aspect value depends.
applicableForLocalizedAspectValues	aspects.aspectValues.valueConstraints.applicableForLocalizedAspectValues	array of string	Contains a list of the values of the control aspect on which this aspect's value depends.
Localized Aspect Name	aspects.localizedAspectName	string	Localized name of this aspect.
Search Count	aspects.relevanceIndicator.searchCount	integer	Number of recent searches for the aspect.

Get Item Condition Policies

Operation ID:

GetItemConditionPolicies

This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace.

Parameters

Name	Key	Required	Type	Description
Marketplace Id	marketplace_id	True	string	eBay marketplace ID for which policy information is retrieved.
Filter	filter		string	Limits the response by returning policy information for only the selected sections of the category tree.

Returns

Name	Path	Type	Description
itemConditionPolicies	itemConditionPolicies	array of object	A list of category IDs and the policies for how to indicate an item's condition in each of the listed categories.
Category Id	itemConditionPolicies.categoryId	string	Category ID to which the item-condition policy applies.
Category Tree Id	itemConditionPolicies.categoryTreeId	string	A value that indicates the root node of the category tree used for the response set.
Item Condition Required	itemConditionPolicies.itemConditionRequired	boolean	This flag denotes whether or not you must list the item condition in a listing for the specified category.
itemConditions	itemConditionPolicies.itemConditions	array of object	The item-condition values allowed in the category.
conditionDescription	itemConditionPolicies.itemConditions.conditionDescription	string	The human-readable label for the condition.
conditionId	itemConditionPolicies.itemConditions.conditionId	string	ID value of the selected item condition.
usage	itemConditionPolicies.itemConditions.usage	string	usage
warnings	warnings	array of object	Warnings list that were generated as a result of the request.
Category	warnings.category	string	Category type for this error or warning.
Domain	warnings.domain	string	Domain name containing the service or application.
Error Id	warnings.errorId	integer	A positive integer that uniquely identifies the specific error condition that occurred.
inputRefIds	warnings.inputRefIds	array of string	Identifies specific request elements associated with the error, if any. inputRefId's response is format specific.
Long Message	warnings.longMessage	string	An expanded version of message that should be around 100-200 characters long, but is not required to be such.
Message	warnings.message	string	An end user and app developer friendly device agnostic message.
outputRefIds	warnings.outputRefIds	array of string	Identifies specific response elements associated with the error, if any.
parameters	warnings.parameters	array of object	Various warning and error messages return one or more variables that contain contextual information about the error or warning.
name	warnings.parameters.name	string	name
value	warnings.parameters.value	string	value
Subdomain	warnings.subdomain	string	Name of the domain's subsystem or subdivision.

GET Offer

Operation ID:

GetOffer

This call retrieves a specific published or unpublished offer.

Parameters

Name	Key	Required	Type	Description
Offer Id	offerId	True	string	Unique identifier of the offer that is to be retrieved.

Returns

Name	Path	Type	Description
Available Quantity	availableQuantity	integer	Quantity of the inventory item that will be available for purchase by buyers.
Category Id	categoryId	string	Unique identifier of the primary eBay category that the inventory item is listed under.
Charity Id	charity.charityId	string	eBay-assigned Unique identifier of the charitable organization that will receive a percentage of the sales proceeds.
Donation Percentage	charity.donationPercentage	string	Purchase price percentage that charitable organization will receive for each sale that the listing generates.
Producer Product Id	extendedProducerResponsibility.producerProductId	string	Unique Identifier of the producer related to the item.
Product Package Id	extendedProducerResponsibility.productPackageId	string	Unique ID of the producer of any packaging related to the product added by the seller.
Shipment Package Id	extendedProducerResponsibility.shipmentPackageId	string	Unique Identifier of the producer of any packaging used by the seller to ship the item.
Product Documentation Id	extendedProducerResponsibility.productDocumentationId	string	Unique Identifier of the producer of any paper added to the parcel of the item by the seller.
Currency	extendedProducerResponsibility.ecoParticipationFee.currency	string	A three-digit string value representing the currency type.
Value	extendedProducerResponsibility.ecoParticipationFee.value	string	A string representation of a dollar value expressed in the currency field.
Format	format	string	Listing format of the offer
Hide Buyer Details	hideBuyerDetails	boolean	This field is returned as true if the private listing feature has been enabled for the offer.
Include Catalog Product Details	includeCatalogProductDetails	boolean	This field indicates whether or not eBay product catalog details are applied to a listing.
Listing Id	listing.listingId	string	Unique identifier of eBay listing that is associated with the published offer.
Listing Status	listing.listingStatus	string	Listing status that is associated with the published offer.
Sold Quantity	listing.soldQuantity	integer	Quantity of product that has been sold for the published offer.
Listing Description	listingDescription	string	Description of eBay listing
Listing Duration	listingDuration	string	This field indicates the number of days that the listing will be active.
Currency	listingPolicies.bestOfferTerms.autoAcceptPrice.currency	string	A three-digit string value representing the currency type.
Value	listingPolicies.bestOfferTerms.autoAcceptPrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	listingPolicies.bestOfferTerms.autoDeclinePrice.currency	string	A three-digit string value representing the currency type.
Value	listingPolicies.bestOfferTerms.autoDeclinePrice.value	string	A string representation of a dollar value expressed in the currency field.
Best Offer Enabled	listingPolicies.bestOfferTerms.bestOfferEnabled	boolean	This container is used if the seller would like to support the Best Offer feature on their listing.
eBay Plus If Eligible	listingPolicies.eBayPlusIfEligible	boolean	This field is included in an offer if a Top-Rated seller is opted into the eBay Plus program.
Fulfillment Policy Id	listingPolicies.fulfillmentPolicyId	string	Unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing.
Payment Policy Id	listingPolicies.paymentPolicyId	string	Unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing.
productCompliancePolicyIds	listingPolicies.productCompliancePolicyIds	array of string	This field contains an array of up to five IDs specifying the seller created compliance policies for the listing.
Return Policy Id	listingPolicies.returnPolicyId	string	Unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing.
shippingCostOverrides	listingPolicies.shippingCostOverrides	array of object	This container is used if the seller wishes to override the shipping costs for one or more domestic or international shipping service options defined in the fulfillment listing policy.
Currency	listingPolicies.shippingCostOverrides.additionalShippingCost.currency	string	A three-digit string value representing the currency type.
Value	listingPolicies.shippingCostOverrides.additionalShippingCost.value	string	A string representation of a dollar value expressed in the currency field.
Priority	listingPolicies.shippingCostOverrides.priority	integer	The integer value input into this field, along with the shippingServiceType value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs.
Currency	listingPolicies.shippingCostOverrides.shippingCost.currency	string	A three-digit string value representing the currency type.
Value	listingPolicies.shippingCostOverrides.shippingCost.value	string	A string representation of a dollar value expressed in the currency field.
Shipping Service Type	listingPolicies.shippingCostOverrides.shippingServiceType	string	This value indicates whether the shipping service is a domestic or an international shipping service option.
Take Back Policy Id	listingPolicies.takeBackPolicyId	string	Seller ID created take-back policy.
Listing Start Date	listingStartDate	string	This timestamp is the date/time that the seller set for the scheduled listing.
Lot Size	lotSize	integer	This field is only applicable if listing is a lot listing. A lot listing is a listing that has multiple quantity of the same product.
Marketplace Id	marketplaceId	string	Unique identifier of the eBay site on which the offer is available or will be made available.
Merchant Location Key	merchantLocationKey	string	Unique identifier of the inventory location.
Offer Id	offerId	string	Unique identifier of the offer.
Currency	pricingSummary.auctionReservePrice.currency	string	A three-digit string value representing the currency type.
Value	pricingSummary.auctionReservePrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	pricingSummary.auctionStartPrice.currency	string	A three-digit string value representing the currency type.
Value	pricingSummary.auctionStartPrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	pricingSummary.minimumAdvertisedPrice.currency	string	A three-digit string value representing the currency type.
Value	pricingSummary.minimumAdvertisedPrice.value	string	A string representation of a dollar value expressed in the currency field.
Originally Sold for Retail Price On	pricingSummary.originallySoldForRetailPriceOn	string	This field is needed if the Strikethrough Pricing feature will be used in the offer. This field indicates that the product was sold for the price in the original RetailPrice field on an eBay site, or sold for that price by a third-party retailer.
Currency	pricingSummary.originalRetailPrice.currency	string	A three-digit string value representing the currency type.
Value	pricingSummary.originalRetailPrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	pricingSummary.price.currency	string	A three-digit string value representing the currency type.
Value	pricingSummary.price.value	string	A string representation of a dollar value expressed in the currency field.
Pricing Visibility	pricingSummary.pricingVisibility	string	This field is needed if Minimum Advertised Price feature will be used in the offer.
Quantity Limit Per Buyer	quantityLimitPerBuyer	integer	This field is only applicable if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller.
Secondary Category Id	secondaryCategoryId	string	Unique identifier for a secondary category and applicable if seller decides to list the item under two categories.
SKU	sku	string	Seller-defined SKU value of the product in the offer.
Status	status	string	The value specifies the status of the offer.
Store Category Names	storeCategoryNames	array of string	Store Category Name
Apply Tax	tax.applyTax	boolean	This field will be included if seller would like to reference their account-level Sales Tax
Third Party Tax Category	tax.thirdPartyTaxCategory	string	The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price.
VAT Percentage	tax.vatPercentage	number	This value is VAT rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page.

GET Offers

Operation ID:

GetOffers

This call retrieves all existing offers for the specified SKU value. The seller has the option of limiting the offers that are retrieved to a specific eBay marketplace, or to a listing format.

Parameters

Name	Key	Required	Type	Description
SKU	sku	True	string	Seller-defined SKU value
Marketplace Id	marketplace_id		string	Unique identifier of the eBay marketplace.
Format	format		string	Listing format for the offer.
Limit	limit		string	Maximum number of records to return per page of data.
Offset	offset		string	Page number to retrieve.

Returns

Name	Path	Type	Description
Href	href	string	URL to the current page of offers.
Limit	limit	integer	Number of offers that will be displayed on each results page.
Next	next	string	URL to the next page of offers.
offers	offers	array of object	This container is an array of one or more seller's offers for the SKU value.
Available Quantity	offers.availableQuantity	integer	Inventory item quantity that will be available for purchase.
Category Id	offers.categoryId	string	eBay category unique ID that the inventory item is listed under.
Charity Id	offers.charity.charityId	string	eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds.
Donation Percentage	offers.charity.donationPercentage	string	Purchase price percentage that charitable organization will receive for each sale.
Producer Product Id	offers.extendedProducerResponsibility.producerProductId	string	Unique Identifier of the producer related to the item.
Product Package Id	offers.extendedProducerResponsibility.productPackageId	string	Unique ID of the packaged product added by the seller.
Shipment Package Id	offers.extendedProducerResponsibility.shipmentPackageId	string	Unique Identifier of the producer of any packaging used by the seller to ship the item.
Product Documentation Id	offers.extendedProducerResponsibility.productDocumentationId	string	Unique Identifier of the producer of any paper added to the parcel of the item by the seller.
Currency	offers.extendedProducerResponsibility.ecoParticipationFee.currency	string	A three-digit string value representing the currency type.
Value	offers.extendedProducerResponsibility.ecoParticipationFee.value	string	A string representation of a dollar value expressed in the currency field.
Format	offers.format	string	This value sets the listing format for the offer
Hide Buyer Details	offers.hideBuyerDetails	boolean	This field is returned as true if the private listing feature has been enabled for the offer.
Include Catalog Product Details	offers.includeCatalogProductDetails	boolean	This field indicates whether or not eBay product catalog details are applied to a listing.
Listing Id	offers.listing.listingId	string	Unique identifier of the eBay listing that is associated with the published offer.
Listing Status	offers.listing.listingStatus	string	Listing status that is associated with the published offer.
Sold Quantity	offers.listing.soldQuantity	integer	Product Quantity that has been sold for the published offer.
Listing Description	offers.listingDescription	string	eBay listing description.
Listing Duration	offers.listingDuration	string	Indicates the number of days that the listing will be active.
Currency	offers.listingPolicies.bestOfferTerms.autoAcceptPrice.currency	string	A three-digit string value representing the currency type.
Value	offers.listingPolicies.bestOfferTerms.autoAcceptPrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	offers.listingPolicies.bestOfferTerms.autoDeclinePrice.currency	string	A three-digit string value representing the currency type.
Value	offers.listingPolicies.bestOfferTerms.autoDeclinePrice.value	string	A string representation of a dollar value expressed in the currency field.
Best Offer Enabled	offers.listingPolicies.bestOfferTerms.bestOfferEnabled	boolean	This field indicates whether or not the Best Offer feature is enabled for the listing.
eBay Plus If Eligible	offers.listingPolicies.eBayPlusIfEligible	boolean	This field is included in an offer and set to true if a Top-Rated seller is opted into the eBay Plus program
Fulfillment Policy Id	offers.listingPolicies.fulfillmentPolicyId	string	Unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing.
Payment Policy Id	offers.listingPolicies.paymentPolicyId	string	Unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing.
productCompliancePolicyIds	offers.listingPolicies.productCompliancePolicyIds	array of string	This field contains an array of up to five IDs specifying the seller created compliance policies for the listing.
Return Policy Id	offers.listingPolicies.returnPolicyId	string	Unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing.
shippingCostOverrides	offers.listingPolicies.shippingCostOverrides	array of object	This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy.
currency	offers.listingPolicies.shippingCostOverrides.additionalShippingCost.currency	string	currency
value	offers.listingPolicies.shippingCostOverrides.additionalShippingCost.value	string	value
priority	offers.listingPolicies.shippingCostOverrides.priority	integer	priority
currency	offers.listingPolicies.shippingCostOverrides.shippingCost.currency	string	currency
value	offers.listingPolicies.shippingCostOverrides.shippingCost.value	string	value
shippingServiceType	offers.listingPolicies.shippingCostOverrides.shippingServiceType	string	shippingServiceType
Take Back Policy Id	offers.listingPolicies.takeBackPolicyId	string	Seller ID who created take-back policy.
Listing Start Date	offers.listingStartDate	string	Date/time that seller set for the scheduled listing.
Lot Size	offers.lotSize	integer	This field is only applicable and returned if the listing is a lot listing.
Marketplace Id	offers.marketplaceId	string	Unique identifier of the eBay site on which the offer is available or will be made available.
Merchant Location Key	offers.merchantLocationKey	string	Unique identifier of the inventory location.
Offer Id	offers.offerId	string	Unique identifier of the offer.
Currency	offers.pricingSummary.auctionReservePrice.currency	string	A three-digit string value representing the currency type.
Value	offers.pricingSummary.auctionReservePrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	offers.pricingSummary.auctionStartPrice.currency	string	A three-digit string value representing the currency type.
Value	offers.pricingSummary.auctionStartPrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	offers.pricingSummary.minimumAdvertisedPrice.currency	string	A three-digit string value representing the currency type.
Value	offers.pricingSummary.minimumAdvertisedPrice.value	string	A string representation of a dollar value expressed in the currency field.
Originally Sold for Retail Price On	offers.pricingSummary.originallySoldForRetailPriceOn	string	This field is needed if the Strikethrough Pricing feature will be used in the offer. This field indicates that the product was sold for the price in the original RetailPrice field on an eBay site, or sold for that price by a third-party retailer.
Currency	offers.pricingSummary.originalRetailPrice.currency	string	A three-digit string value representing the currency type.
Value	offers.pricingSummary.originalRetailPrice.value	string	A string representation of a dollar value expressed in the currency field.
Currency	offers.pricingSummary.price.currency	string	A three-digit string value representing the currency type.
Value	offers.pricingSummary.price.value	string	A string representation of a dollar value expressed in the currency field.
Pricing Visibility	offers.pricingSummary.pricingVisibility	string	This field is needed if the Minimum Advertised Price feature will be used in the offer.
Quantity Limit Per Buyer	offers.quantityLimitPerBuyer	integer	This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller.
Secondary Category Id	offers.secondaryCategoryId	string	Unique identifier for a secondary category.
SKU	offers.sku	string	Seller-defined SKU value of the product in the offer.
Status	offers.status	string	The value specifies the status of the offer.
storeCategoryNames	offers.storeCategoryNames	array of string	This container is returned if the seller chose to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store
Apply Tax	offers.tax.applyTax	boolean	This field will be included if the seller would like to reference their account-level Sales Tax Table to calculate sales tax for an order.
Third Party Tax Category	offers.tax.thirdPartyTaxCategory	string	Tax exception category code.
VAT Percentage	offers.tax.vatPercentage	number	Value Add Tax (VAT) rate value for the item, if any.
Prev	prev	string	URL to the previous page of offers.
Size	size	integer	Number of offers being displayed on the current page of results.
Total	total	integer	Total number of offers that exist for the specified SKU value.

Get Payment Policies

Operation ID:

GetPaymentPolicies

This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter.

Parameters

Name	Key	Required	Type	Description
Marketplace Id	marketplace_id		string	eBay marketplace ID of the policies you want to retrieve.

Returns

Name	Path	Type	Description
Href	href	string	This field is for future use.
Limit	limit	integer	This field is for future use.
Next	next	string	This field is for future use.
Offset	offset	integer	This field is for future use.
paymentPolicies	paymentPolicies	array of object	List of seller's payment business policies defined for the specified marketplace.
categoryTypes	paymentPolicies.categoryTypes	array of object	This container indicates whether the fulfillment policy applies to motor vehicle or non-motor vehicle listings.
default	paymentPolicies.categoryTypes.default	boolean	default
name	paymentPolicies.categoryTypes.name	string	name
Currency	paymentPolicies.deposit.amount.currency	string	The base currency applied to the value field to establish a monetary amount.
Value	paymentPolicies.deposit.amount.value	string	The monetary amount in the specified currency.
Unit	paymentPolicies.deposit.dueIn.unit	string	These values represent the time measurement unit, such as DAY.
Value	paymentPolicies.deposit.dueIn.value	integer	Time-measurement unit value specified in the unit field.
Description	paymentPolicies.description	string	A seller-defined description of the payment policy.
Unit	paymentPolicies.fullPaymentDueIn.unit	string	Time measurement unit, such as DAY.
Value	paymentPolicies.fullPaymentDueIn.value	integer	Time-measurement unit value specified in the unit field.
Immediate Pay	paymentPolicies.immediatePay	boolean	If this field is returned as true, immediate payment is required from the buyer
Marketplace Id	paymentPolicies.marketplaceId	string	eBay marketplace ID to which the payment business policy applies.
Name	paymentPolicies.name	string	A seller-defined name for this fulfillment policy.
Payment Instructions	paymentPolicies.paymentInstructions	string	Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.
paymentMethods	paymentPolicies.paymentMethods	array of object	This container is returned to show the payment methods that are accepted for the payment business policy.
paymentMethodType	paymentPolicies.paymentMethods.paymentMethodType	string	Type of Payment Method
Payment Policy Id	paymentPolicies.paymentPolicyId	string	Unique eBay-assigned ID for a payment business policy.
Prev	prev	string	This field is for future use.
Total	total	integer	Total number of payment business policies retrieved in the result set.

Get Payment Policy

Operation ID:

GetPaymentPolicy

This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.

Parameters

Name	Key	Required	Type	Description
Payment Policy Id	payment_policy_id	True	string	Payment policy ID you want to retrieve.

Returns

Name	Path	Type	Description
categoryTypes	categoryTypes	array of object	This container indicates whether the fulfillment policy applies to motor vehicle or non-motor vehicle listings.
Name	categoryTypes.name	string	The category type to which the policy applies.
Currency	deposit.amount.currency	string	The base currency applied to the value field to establish a monetary amount.
Value	deposit.amount.value	string	The monetary amount in the specified currency.
Unit	deposit.dueIn.unit	string	Time measurement unit, such as DAY.
Value	deposit.dueIn.value	integer	Time-measurement unit value specified in the unit field.
Description	description	string	A seller-defined description of the payment policy.
Unit	fullPaymentDueIn.unit	string	Time measurement unit, such as DAY.
Value	fullPaymentDueIn.value	integer	Time-measurement unit value specified in the unit field.
Immediate Pay	immediatePay	boolean	If this field is returned as true, immediate payment is required from the buyer
Marketplace Id	marketplaceId	string	ID of the eBay marketplace to which the payment business policy applies.
Name	name	string	ID of the eBay marketplace to which the payment business policy applies.
Payment Instructions	paymentInstructions	string	Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies
paymentMethods	paymentMethods	array of object	This container is returned to show the payment methods that are accepted for the payment business policy.
Payment Method Type	paymentMethods.paymentMethodType	string	Payment method type for offline support
Payment Policy Id	paymentPolicyId	string	A unique eBay-assigned ID for a payment business policy.

Get Return Policies

Operation ID:

GetReturnPolicies

This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.

Parameters

Name	Key	Required	Type	Description
Marketplace ID	marketplace_id	True	string	eBay marketplace ID of the policy you want to retrieve.

Returns

Name	Path	Type	Description
Href	href	string	This field is for future use.
Limit	limit	integer	This field is for future use.
Next	next	string	This field is for future use.
Offset	offset	integer	This field is for future use.
Prev	prev	string	This field is for future use.
returnPolicies	returnPolicies	array of object	List of the seller's return business policies defined for the specified marketplace.
categoryTypes	returnPolicies.categoryTypes	array of object	This container indicates which category group that the return policy applies to.
name	returnPolicies.categoryTypes.name	string	name
Description	returnPolicies.description	string	A seller-defined description of the return business policy.
Return Method	returnPolicies.internationalOverride.returnMethod	string	This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return.
Unit	returnPolicies.internationalOverride.returnPeriod.unit	string	These enum values represent the time measurement unit, such as DAY.
Value	returnPolicies.internationalOverride.returnPeriod.value	integer	Time measurement unit, such as DAY.
Returns Accepted	returnPolicies.internationalOverride.returnsAccepted	boolean	If set to true, the seller accepts international returns.
Return Shipping Cost Payer	returnPolicies.internationalOverride.returnShippingCostPayer	string	This field indicates who is responsible for paying for the shipping charges for returned items.
Marketplace Id	returnPolicies.marketplaceId	string	eBay marketplace ID to which this return business policy applies.
Name	returnPolicies.name	string	A seller-defined name for this payment business policy.
Refund Method	returnPolicies.refundMethod	string	If a seller indicates that they will accept buyer returns, this value will be set to MONEY_BACK.
Return Instructions	returnPolicies.returnInstructions	string	This text-based field provides more details on seller-specified return instructions.
Return Method	returnPolicies.returnMethod	string	This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'.
Unit	returnPolicies.returnPeriod.unit	string	Time measurement unit, such as DAY.
Value	returnPolicies.returnPeriod.value	integer	Time-measurement unit value specified in the unit field.
Return Policy Id	returnPolicies.returnPolicyId	string	A unique eBay-assigned ID for a return business policy.
Return Accepted	returnPolicies.returnsAccepted	boolean	If this field is returned as true, the seller accepts returns.
Return Shipping Cost Payer	returnPolicies.returnShippingCostPayer	string	This field indicates who is responsible for paying for the shipping charges for returned items.
Total	total	integer	Total number of return business policies retrieved in the result set.

Get Return Policy

Operation ID:

GetReturnPolicy

This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.

Parameters

Name	Key	Required	Type	Description
Return Policy Id	return_policy_id	True	string	Return policy ID you want to retrieve.

Returns

Name	Path	Type	Description
categoryTypes	categoryTypes	array of object	This container indicates which category group that the return policy applies to.
Name	categoryTypes.name	string	The category type to which the policy applies
Description	description	string	A seller-defined description of the return business policy.
Return Method	internationalOverride.returnMethod	string	This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return.
Unit	internationalOverride.returnPeriod.unit	string	Time measurement unit, such as DAY.
Value	internationalOverride.returnPeriod.value	integer	Time-measurement unit value specified in the unit field.
Returns Accepted	internationalOverride.returnsAccepted	boolean	Time-measurement unit value specified in the unit field.
Return Shipping Cost Payer	internationalOverride.returnShippingCostPayer	string	This field indicates who is responsible for paying for the shipping charges for returned items.
Marketplace Id	marketplaceId	string	ID of the eBay marketplace to which this return business policy applies.
Name	name	string	A seller-defined name for this payment business policy.
Refund Method	refundMethod	string	If a seller indicates that they will accept buyer returns, this value will be set to MONEY_BACK.
Return Instructions	returnInstructions	string	This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.
Return Method	returnMethod	string	This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'
Unit	returnPeriod.unit	string	Time measurement unit, such as DAY.
Value	returnPeriod.value	integer	Time-measurement unit value specified in the unit field.
Return Policy Id	returnPolicyId	string	Unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created.
Returns Accepted	returnsAccepted	boolean	If this field is returned as true, the seller accepts returns.
Return Shipping Cost Payer	returnShippingCostPayer	string	This field indicates who is responsible for paying for the shipping charges for returned items.

Publish Offer

Operation ID:

PublishOffer

This call is used to convert an unpublished offer into a published offer, or live eBay listing. The unique identifier of the offer (offerId) is passed in at the end of the call URI.

Parameters

Name	Key	Required	Type	Description
Offer Id	offerId	True	string	Unique identifier of the offer that is to be published.

Returns

Name	Path	Type	Description
Listing Id	listingId	string	Unique identifier of the newly created eBay listing.
warnings	warnings	array of object	This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer.
Category	warnings.category	string	This string value indicates the error category.
Domain	warnings.domain	string	The name of the domain in which the error or warning occurred.
Error Id	warnings.errorId	integer	A unique code that identifies the particular error or warning that occurred.
inputRefIds	warnings.inputRefIds	array of string	An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
Long Message	warnings.longMessage	string	A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
Message	warnings.message	string	A description of the condition that caused the error or warning.
outputRefIds	warnings.outputRefIds	array of string	An array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.
parameters	warnings.parameters	array of object	Various warning and error messages return one or more variables that contain contextual information about the error or warning.
name	warnings.parameters.name	string	name
value	warnings.parameters.value	string	value
Subdomain	warnings.subdomain	string	The name of the subdomain in which the error or warning occurred.

Update Offer

Operation ID:

UpdateOffer

This call updates an existing offer that may be in published or in an unpublished state.

Parameters

Name	Key	Required	Type	Description
Offer Id	offerId	True	string	Unique identifier of the offer that you want to update.
Available Quantity	availableQuantity		integer	Available quantity of inventory for purchase.
Category Id	categoryId		string	eBay Unique category ID that the product will be listed under.
Charity Id	charityId		string	eBay-assigned unique ID of charitable organization that'll receive a percentage of sales proceeds.
Donation Percentage	donationPercentage		string	Purchase price percentage that charitable organization will receive for each sale that listing generates.
Producer Product Id	producerProductId		string	Unique Identifier of producer related to the item.
Product Package Id	productPackageId		string	Unique ID of the producer of product packaging added by the seller.
Shipment Package Id	shipmentPackageId		string	Unique ID of producer of any packaging used by the seller to ship item.
Product Documentation Id	productDocumentationId		string	Unique Identifier of producer of any paper added to the parcel of the item by the seller.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Hide Buyer Details	hideBuyerDetails		boolean	This field is included if the seller wishes to create a private listing.
Include Catalog Product Details	includeCatalogProductDetails		boolean	Indicates whether or not eBay product catalog details are applied to a listing.
Listing Description	listingDescription		string	Description of the eBay listing.
Listing Duration	listingDuration		string	Number of days that the listing will be active.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Best Offer Enabled	bestOfferEnabled		boolean	Indicates whether or not the Best Offer feature is enabled for the listing.
eBay Plus If Eligible	eBayPlusIfEligible		boolean	This field is included in an offer if a Top-Rated seller is opted into the eBay Plus program.
Fulfillment Policy Id	fulfillmentPolicyId		string	Unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing.
Payment Policy Id	paymentPolicyId		string	Unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing.
Product Compliance Policy Ids	productCompliancePolicyIds		array of string	This field contains an array of up to five IDs specifying the seller created compliance policies for the listing.
Return Policy Id	returnPolicyId		string	Return business policy unique ID that will be used once an offer is published and converted to an eBay listing.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Priority	priority		integer	The integer value input into this field, along with the shippingServiceType value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Service Type	shippingServiceType		string	This value indicates whether the shipping service specified in the priority field is a domestic or an international shipping service option.
Take Back Policy Id	takeBackPolicyId		string	Seller ID who created take-back policy.
Listing Start Date	listingStartDate		string	This field can be used if the seller wants to specify a time in the future that the listing will become active on eBay.
Lot Size	lotSize		integer	This field is only applicable if the listing is a lot listing. The integer value passed into this field is the total number of items in the lot.
Merchant Location Key	merchantLocationKey		string	Unique identifier of a merchant's inventory location
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Originally Sold for Retail Price On	originallySoldForRetailPriceOn		string	This field is needed if the Strikethrough Pricing feature will be used in the offer. This field indicates that the product was sold for the price in the original RetailPrice field on an eBay site, or sold for that price by a third-party retailer
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Currency	currency		string	A three-digit string value representing currency type.
Value	value		string	A string representation of a dollar value expressed in the currency field.
Pricing Visibility	pricingVisibility		string	This field is needed if the Minimum Advertised Price feature will be used in the offer.
Quantity Limit Per Buyer	quantityLimitPerBuyer		integer	This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller.
Secondary Category Id	secondaryCategoryId		string	Unique secondary category ID and applicable if the seller decides to list item under two categories.
Store Category Names	storeCategoryNames		array of string	Store category names
Apply Tax	applyTax		boolean	This container is only applicable and used if a sales tax table, a Value-Added Tax rate, or a tax exception category code will be applied to the offer.
Third Party Tax Category	thirdPartyTaxCategory		string	The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price.
VAT Percentage	vatPercentage		number	This value is VAT rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page.

Returns

Name	Path	Type	Description
Offer Id	offerId	string	Unique identifier of the offer
warnings	warnings	array of object	This container will return when a call is made, and errors and/or warnings occur.
Category	warnings.category	string	This string value indicates the error category
Domain	warnings.domain	string	Domain name in which the error or warning occurred.
Error Id	warnings.errorId	integer	Unique code that identifies the particular error or warning that occurred.
inputRefIds	warnings.inputRefIds	array of string	An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
Long Message	warnings.longMessage	string	A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
Message	warnings.message	string	A description of condition that caused the error or warning.
outputRefIds	warnings.outputRefIds	array of string	An array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.
parameters	warnings.parameters	array of object	Various warning and error messages return one or more variables that contain contextual information about the error or warning.
name	warnings.parameters.name	string	name
value	warnings.parameters.value	string	value
Subdomain	warnings.subdomain	string	Subdomain name in which the error or warning occurred.

Withdraw Offer

Operation ID:

WithdrawOffer

This call is used to end a single-variation listing that is associated with the specified offer.

Parameters

Name	Key	Required	Type	Description
Offer Id	offerId	True	string	Unique identifier of the offer that is to be withdrawn.

Returns

Name	Path	Type	Description
Listing Id	listingId	string	Unique identifier of the eBay listing associated with the offer that was withdrawn.
warnings	warnings	array of object	This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer.
Category	warnings.category	string	This string value indicates the error category
Domain	warnings.domain	string	This string value indicates the error category
Error Id	warnings.errorId	integer	A unique code that identifies the particular error or warning that occurred.
inputRefIds	warnings.inputRefIds	array of string	An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
Long Message	warnings.longMessage	string	A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
Message	warnings.message	string	A description of the condition that caused the error or warning.
outputRefIds	warnings.outputRefIds	array of string	This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer.
parameters	warnings.parameters	array of object	Various warning and error messages return one or more variables that contain contextual information about the error or waring.
name	warnings.parameters.name	string	name
value	warnings.parameters.value	string	value
Subdomain	warnings.subdomain	string	The name of the subdomain in which the error or warning occurred.

Definitions

string

This is the basic data type 'string'.