This is a list of all fields in the schema. Select a method to learn more about how a call uses a field.
Field
Parent field
Applicable resources and methods
A
additionalInfo
conditionDescriptors
inventoryItems.conditionDescriptors
requests.conditionDescriptors
additionalShippingCost
listingPolicies.shippingCostOverrides
offers.listingPolicies.shippingCostOverrides
address
location
addressLine1
location.address
locations.location.address
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
addressLine2
location.address
locations.location.address
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
allocationByFormat
availability.shipToLocationAvailability
inventoryItems.availability.shipToLocationAvailability
responses.inventoryItem.availability.shipToLocationAvailability
amount
applyTax
offers.tax
requests.tax
tax
aspects
(method-level)
inventoryItems.product
product
aspectsImageVariesBy
variesBy
auction
availability.shipToLocationAvailability.allocationByFormat
inventoryItems.availability.shipToLocationAvailability.allocationByFormat
responses.inventoryItem.availability.shipToLocationAvailability.allocationByFormat
auctionReservePrice
offers.pricingSummary
pricingSummary
auctionStartPrice
offers.pricingSummary
pricingSummary
autoAcceptPrice
listingPolicies.bestOfferTerms
offers.listingPolicies.bestOfferTerms
autoDeclinePrice
listingPolicies.bestOfferTerms
offers.listingPolicies.bestOfferTerms
availability
(method-level)
availabilityDistributions
availability.shipToLocationAvailability
inventoryItems.availability.shipToLocationAvailability
requests.availability.shipToLocationAvailability
requests.shipToLocationAvailability
responses.inventoryItem.availability.shipToLocationAvailability
availabilityType
availability.pickupAtLocationAvailability
inventoryItems.availability.pickupAtLocationAvailability
requests.availability.pickupAtLocationAvailability
responses.inventoryItem.availability.pickupAtLocationAvailability
availableQuantity
(method-level)
B
bestOfferEnabled
listingPolicies.bestOfferTerms
offers.listingPolicies.bestOfferTerms
bestOfferTerms
listingPolicies
offers.listingPolicies
brand
inventoryItems.product
product
C
category
feeSummaries.warnings
responses.errors
responses.warnings
warnings
categoryId
(method-level)
POST
charity
(method-level)
charityId
charity
offers.charity
city
location.address
locations.location.address
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
close
locations.operatingHours.intervals
locations.specialHours.intervals
operatingHours.intervals
specialHours.intervals
companyName
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
compatibilityProperties
compatibleProducts
compatibleProducts
(method-level)
component
offers.regulatory.hazmat
offers.regulatory.productSafety
regulatory.hazmat
regulatory.productSafety
requests.regulatory.hazmat
condition
(method-level)
inventoryItems
conditionDescription
(method-level)
conditionDescriptors
(method-level)
country
listingPolicies.regionalProductCompliancePolicies.countryPolicies
listingPolicies.regionalTakeBackPolicies.countryPolicies
location.address
locations.location.address
offers.listingPolicies.regionalProductCompliancePolicies.countryPolicies
offers.listingPolicies.regionalTakeBackPolicies.countryPolicies
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.listingPolicies.regionalProductCompliancePolicies.countryPolicies
requests.listingPolicies.regionalTakeBackPolicies.countryPolicies
requests.regulatory.economicOperator
requests.regulatory.manufacturer
countryPolicies
listingPolicies.regionalProductCompliancePolicies
listingPolicies.regionalTakeBackPolicies
offers.listingPolicies.regionalProductCompliancePolicies
offers.listingPolicies.regionalTakeBackPolicies
requests.listingPolicies.regionalProductCompliancePolicies
county
location.address
currency
extendedProducerResponsibility.ecoParticipationFee
feeSummaries.fees.amount
feeSummaries.fees.promotionalDiscount
listingPolicies.bestOfferTerms.autoAcceptPrice
listingPolicies.bestOfferTerms.autoDeclinePrice
listingPolicies.shippingCostOverrides.additionalShippingCost
listingPolicies.shippingCostOverrides.shippingCost
listingPolicies.shippingCostOverrides.surcharge
offers.extendedProducerResponsibility.ecoParticipationFee
offers.listingPolicies.bestOfferTerms.autoAcceptPrice
offers.listingPolicies.bestOfferTerms.autoDeclinePrice
offers.listingPolicies.shippingCostOverrides.additionalShippingCost
offers.listingPolicies.shippingCostOverrides.shippingCost
offers.listingPolicies.shippingCostOverrides.surcharge
offers.pricingSummary.auctionReservePrice
offers.pricingSummary.auctionStartPrice
offers.pricingSummary.minimumAdvertisedPrice
offers.pricingSummary.originalRetailPrice
offers.pricingSummary.price
pricingSummary.auctionReservePrice
pricingSummary.auctionStartPrice
pricingSummary.minimumAdvertisedPrice
pricingSummary.originalRetailPrice
pricingSummary.price
requests.extendedProducerResponsibility.ecoParticipationFee
requests.listingPolicies.bestOfferTerms.autoAcceptPrice
requests.listingPolicies.bestOfferTerms.autoDeclinePrice
requests.listingPolicies.shippingCostOverrides.additionalShippingCost
requests.listingPolicies.shippingCostOverrides.shippingCost
requests.listingPolicies.shippingCostOverrides.surcharge
requests.offers.price
requests.pricingSummary.auctionReservePrice
requests.pricingSummary.auctionStartPrice
requests.pricingSummary.minimumAdvertisedPrice
requests.pricingSummary.originalRetailPrice
D
date
locations.specialHours
specialHours
dayOfWeekEnum
locations.operatingHours
operatingHours
description
(method-level)
inventoryItems.product
product
dimensions
inventoryItems.packageWeightAndSize
packageWeightAndSize
requests.packageWeightAndSize
documentId
offers.regulatory.documents
regulatory.documents
documents
offers.regulatory
regulatory
domain
feeSummaries.warnings
responses.errors
responses.warnings
warnings
donationPercentage
charity
offers.charity
E
eBayPlusIfEligible
listingPolicies
offers.listingPolicies
ean
inventoryItems.product
product
ecoParticipationFee
extendedProducerResponsibility
offers.extendedProducerResponsibility
economicOperator
offers.regulatory
regulatory
email
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
energyEfficiencyLabel
offers.regulatory
regulatory
engine
compatibleProducts.productFamilyProperties
epid
compatibleProducts.productIdentifier
inventoryItems.product
product
errorId
feeSummaries.warnings
responses.errors
responses.warnings
warnings
errors
responses
extendedProducerResponsibility
(method-level)
F
feeSummaries
feeType
fees
fixedPrice
availability.shipToLocationAvailability.allocationByFormat
inventoryItems.availability.shipToLocationAvailability.allocationByFormat
responses.inventoryItem.availability.shipToLocationAvailability.allocationByFormat
format
(method-level)
fulfillmentPolicyId
listingPolicies
offers.listingPolicies
fulfillmentTime
availability.pickupAtLocationAvailability
availability.shipToLocationAvailability.availabilityDistributions
inventoryItems.availability.pickupAtLocationAvailability
inventoryItems.availability.shipToLocationAvailability.availabilityDistributions
requests.availability.pickupAtLocationAvailability
requests.availability.shipToLocationAvailability.availabilityDistributions
requests.shipToLocationAvailability.availabilityDistributions
responses.inventoryItem.availability.pickupAtLocationAvailability
responses.inventoryItem.availability.shipToLocationAvailability.availabilityDistributions
G
geoCoordinates
location
groupIds
(method-level)
gtin
compatibleProducts.productIdentifier
H
hazmat
offers.regulatory
regulatory
height
inventoryItems.packageWeightAndSize.dimensions
packageWeightAndSize.dimensions
requests.packageWeightAndSize.dimensions
responses.inventoryItem.packageWeightAndSize.dimensions
hideBuyerDetails
(method-level)
href
(method-level)
I
imageDescription
offers.regulatory.energyEfficiencyLabel
regulatory.energyEfficiencyLabel
imageURL
offers.regulatory.energyEfficiencyLabel
regulatory.energyEfficiencyLabel
imageUrls
(method-level)
inventoryItems.product
product
includeCatalogProductDetails
(method-level)
inputRefIds
feeSummaries.warnings
responses.errors
responses.warnings
warnings
intervals
locations.operatingHours
locations.specialHours
operatingHours
specialHours
inventoryItem
inventoryItemGroupKey
(method-level)
inventoryItemGroupKeys
inventoryItems
(method-level)
isbn
inventoryItems.product
product
K
ktype
compatibleProducts.productIdentifier
L
latitude
location.geoCoordinates
length
inventoryItems.packageWeightAndSize.dimensions
packageWeightAndSize.dimensions
requests.packageWeightAndSize.dimensions
responses.inventoryItem.packageWeightAndSize.dimensions
limit
(method-level)
listing
listingDescription
(method-level)
listingDuration
(method-level)
listingId
(method-level)
offers.listing
listingOnHold
listingPolicies
(method-level)
listingStartDate
(method-level)
listingStatus
locale
(method-level)
inventoryItems
location
(method-level)
locationAdditionalInformation
(method-level)
locationId
locationInstructions
(method-level)
locationTypes
(method-level)
locationWebUrl
(method-level)
locations
longMessage
feeSummaries.warnings
responses.errors
responses.warnings
warnings
longitude
location.geoCoordinates
lotSize
(method-level)
M
make
compatibleProducts.productFamilyProperties
manufacturer
offers.regulatory
regulatory
marketplaceId
(method-level)
responses
merchantLocationKey
(method-level)
availability.pickupAtLocationAvailability
availability.shipToLocationAvailability.availabilityDistributions
inventoryItems.availability.pickupAtLocationAvailability
inventoryItems.availability.shipToLocationAvailability.availabilityDistributions
requests.availability.pickupAtLocationAvailability
requests.availability.shipToLocationAvailability.availabilityDistributions
requests.shipToLocationAvailability.availabilityDistributions
responses.inventoryItem.availability.pickupAtLocationAvailability
responses.inventoryItem.availability.shipToLocationAvailability.availabilityDistributions
merchantLocationStatus
(method-level)
message
feeSummaries.warnings
responses.errors
responses.warnings
warnings
minimumAdvertisedPrice
offers.pricingSummary
pricingSummary
model
compatibleProducts.productFamilyProperties
mpn
inventoryItems.product
product
N
name
(method-level)
compatibleProducts.compatibilityProperties
conditionDescriptors
feeSummaries.warnings.parameters
inventoryItems.conditionDescriptors
requests.conditionDescriptors
responses.errors.parameters
responses.inventoryItem.conditionDescriptors
responses.warnings.parameters
variesBy.specifications
warnings.parameters
next
(method-level)
notes
compatibleProducts
O
offerId
(method-level)
offers
requests.offers
responses
offers
(method-level)
offset
open
locations.operatingHours.intervals
locations.specialHours.intervals
operatingHours.intervals
specialHours.intervals
operatingHours
(method-level)
originalRetailPrice
offers.pricingSummary
pricingSummary
originallySoldForRetailPriceOn
offers.pricingSummary
pricingSummary
outputRefIds
feeSummaries.warnings
responses.errors
responses.warnings
warnings
P
packageType
inventoryItems.packageWeightAndSize
packageWeightAndSize
requests.packageWeightAndSize
packageWeightAndSize
(method-level)
parameters
feeSummaries.warnings
responses.errors
responses.warnings
warnings
paymentPolicyId
listingPolicies
offers.listingPolicies
phone
(method-level)
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
pickupAtLocationAvailability
availability
inventoryItems.availability
pictograms
offers.regulatory.hazmat
offers.regulatory.productSafety
regulatory.hazmat
regulatory.productSafety
requests.regulatory.hazmat
policyIds
listingPolicies.regionalProductCompliancePolicies.countryPolicies
listingPolicies.regionalTakeBackPolicies.countryPolicies
offers.listingPolicies.regionalProductCompliancePolicies.countryPolicies
offers.listingPolicies.regionalTakeBackPolicies.countryPolicies
requests.listingPolicies.regionalProductCompliancePolicies.countryPolicies
requests.listingPolicies.regionalTakeBackPolicies.countryPolicies
postalCode
location.address
locations.location.address
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
prev
(method-level)
price
offers.pricingSummary
pricingSummary
requests.offers
pricingSummary
(method-level)
pricingVisibility
offers.pricingSummary
pricingSummary
priority
listingPolicies.shippingCostOverrides
offers.listingPolicies.shippingCostOverrides
producerProductId
extendedProducerResponsibility
offers.extendedProducerResponsibility
product
(method-level)
inventoryItems
productCompliancePolicyIds
listingPolicies
offers.listingPolicies
productDocumentationId
extendedProducerResponsibility
offers.extendedProducerResponsibility
productFamilyProperties
compatibleProducts
productIdentifier
compatibleProducts
productInformationSheet
offers.regulatory.energyEfficiencyLabel
regulatory.energyEfficiencyLabel
productPackageId
extendedProducerResponsibility
offers.extendedProducerResponsibility
productSafety
offers.regulatory
regulatory
Q
quantity
availability.pickupAtLocationAvailability
availability.shipToLocationAvailability
availability.shipToLocationAvailability.availabilityDistributions
inventoryItems.availability.pickupAtLocationAvailability
inventoryItems.availability.shipToLocationAvailability
inventoryItems.availability.shipToLocationAvailability.availabilityDistributions
requests.availability.pickupAtLocationAvailability
requests.availability.shipToLocationAvailability
requests.availability.shipToLocationAvailability.availabilityDistributions
requests.shipToLocationAvailability
requests.shipToLocationAvailability.availabilityDistributions
responses.inventoryItem.availability.pickupAtLocationAvailability
responses.inventoryItem.availability.shipToLocationAvailability
responses.inventoryItem.availability.shipToLocationAvailability.availabilityDistributions
quantityLimitPerBuyer
(method-level)
R
regionalProductCompliancePolicies
listingPolicies
offers.listingPolicies
regionalTakeBackPolicies
listingPolicies
offers.listingPolicies
regulatory
(method-level)
POST
repairScore
offers.regulatory
regulatory
requests
(method-level)
responses
(method-level)
responsiblePersons
offers.regulatory
regulatory
returnPolicyId
listingPolicies
offers.listingPolicies
S
secondaryCategoryId
(method-level)
shipToLocationAvailability
availability
inventoryItems.availability
shipmentPackageId
extendedProducerResponsibility
offers.extendedProducerResponsibility
shippingCost
listingPolicies.shippingCostOverrides
offers.listingPolicies.shippingCostOverrides
shippingCostOverrides
listingPolicies
offers.listingPolicies
shippingIrregular
inventoryItems.packageWeightAndSize
packageWeightAndSize
requests.packageWeightAndSize
shippingServiceType
listingPolicies.shippingCostOverrides
offers.listingPolicies.shippingCostOverrides
signalWord
offers.regulatory.hazmat
regulatory.hazmat
size
sku
(method-level)
inventoryItems
offers
requests
responses
responses.inventoryItem
soldQuantity
specialHours
(method-level)
specifications
variesBy
stateOrProvince
location.address
locations.location.address
offers.regulatory.economicOperator
offers.regulatory.manufacturer
offers.regulatory.responsiblePersons
regulatory.economicOperator
regulatory.manufacturer
regulatory.responsiblePersons
requests.regulatory.economicOperator
requests.regulatory.manufacturer
statements
offers.regulatory.hazmat
offers.regulatory.productSafety
regulatory.hazmat
regulatory.productSafety
requests.regulatory.hazmat
status
statusCode
responses
storeCategoryNames
(method-level)
subdomain
feeSummaries.warnings
responses.errors
responses.warnings
warnings
subtitle
(method-level)
inventoryItems.product
product
surcharge
listingPolicies.shippingCostOverrides
offers.listingPolicies.shippingCostOverrides
T
takeBackPolicyId
listingPolicies
offers.listingPolicies
tax
(method-level)
offers
thirdPartyTaxCategory
tax
title
(method-level)
inventoryItems.product
product
total
(method-level)
trim
compatibleProducts.productFamilyProperties
types
offers.regulatory.responsiblePersons
regulatory.responsiblePersons
U
unit
availability.pickupAtLocationAvailability.fulfillmentTime
availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
inventoryItems.availability.pickupAtLocationAvailability.fulfillmentTime
inventoryItems.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
inventoryItems.packageWeightAndSize.dimensions
inventoryItems.packageWeightAndSize.weight
packageWeightAndSize.dimensions
packageWeightAndSize.weight
requests.availability.pickupAtLocationAvailability.fulfillmentTime
requests.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
requests.packageWeightAndSize.dimensions
requests.packageWeightAndSize.weight
requests.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
responses.inventoryItem.availability.pickupAtLocationAvailability.fulfillmentTime
responses.inventoryItem.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
responses.inventoryItem.packageWeightAndSize.dimensions
upc
inventoryItems.product
product
V
value
availability.pickupAtLocationAvailability.fulfillmentTime
availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
compatibleProducts.compatibilityProperties
extendedProducerResponsibility.ecoParticipationFee
feeSummaries.fees.amount
feeSummaries.fees.promotionalDiscount
feeSummaries.warnings.parameters
inventoryItems.availability.pickupAtLocationAvailability.fulfillmentTime
inventoryItems.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
inventoryItems.packageWeightAndSize.weight
listingPolicies.bestOfferTerms.autoAcceptPrice
listingPolicies.bestOfferTerms.autoDeclinePrice
listingPolicies.shippingCostOverrides.additionalShippingCost
listingPolicies.shippingCostOverrides.shippingCost
listingPolicies.shippingCostOverrides.surcharge
offers.extendedProducerResponsibility.ecoParticipationFee
offers.listingPolicies.bestOfferTerms.autoAcceptPrice
offers.listingPolicies.bestOfferTerms.autoDeclinePrice
offers.listingPolicies.shippingCostOverrides.additionalShippingCost
offers.listingPolicies.shippingCostOverrides.shippingCost
offers.listingPolicies.shippingCostOverrides.surcharge
offers.pricingSummary.auctionReservePrice
offers.pricingSummary.auctionStartPrice
offers.pricingSummary.minimumAdvertisedPrice
offers.pricingSummary.originalRetailPrice
offers.pricingSummary.price
packageWeightAndSize.weight
pricingSummary.auctionReservePrice
pricingSummary.auctionStartPrice
pricingSummary.minimumAdvertisedPrice
pricingSummary.originalRetailPrice
pricingSummary.price
requests.availability.pickupAtLocationAvailability.fulfillmentTime
requests.availability.shipToLocationAvailability.availabilityDistributions.fulfillmentTime
requests.extendedProducerResponsibility.ecoParticipationFee
requests.listingPolicies.bestOfferTerms.autoAcceptPrice
requests.listingPolicies.bestOfferTerms.autoDeclinePrice
requests.listingPolicies.shippingCostOverrides.additionalShippingCost
requests.listingPolicies.shippingCostOverrides.shippingCost
POST