ebay.inventory
Module ebay.inventory
API
Definitions
ballerinax/ebay.inventory Ballerina library
Overview
The eBay Inventory connector provides programmatic access to the eBay Sell Inventory API, which lets sellers create and manage inventory items, product compatibility, inventory item groups, offers and inventory locations. This connector supports version 1.18.8 of the Inventory API and lets Ballerina integrations create listings, update stock and prices in bulk, and publish or withdraw offers on eBay marketplaces.
Key features
- Create, replace, retrieve and delete inventory items, including bulk operations of up to 25 SKUs per call
- Manage multi-variation listings through inventory item groups and product compatibility lists
- Create, update, publish and withdraw offers, individually or by inventory item group, and preview listing fees
- Maintain inventory locations and map them to listings and SKUs
Setup guide
-
Sign in to the eBay Developers Program and create an application keyset in the Application Keys page.
-
Configure the OAuth redirect URL (RuName) of the application and grant it the
https://api.ebay.com/oauth/api_scope/sell.inventoryscope, orhttps://api.ebay.com/oauth/api_scope/sell.inventory.readonlyfor read-only access. -
Complete the authorization code grant flow with the seller account to obtain a user access token and a refresh token.
-
Keep the access token at hand. The connector sends it as a bearer token, or you can configure a refresh token with the client ID and client secret so that the connector renews the access token automatically.
Quickstart
To use the eBay Inventory connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module and declare the configuration.
import ballerinax/ebay.inventory; configurable string accessToken = ?;
Step 2: Create a Config.toml file with your credentials.
accessToken = "<your-ebay-user-access-token>"
Step 3: Create a client.
inventory:Client inventoryClient = check new ({auth: {token: accessToken}});
Step 4: Call an operation, for example list the inventory items of the seller.
public function main() returns error? { inventory:InventoryItems _ = check inventoryClient->getInventoryItems('limit = "10"); }
Examples
The eBay Inventory connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Listing publish workflow - Create an inventory item, draft an offer, preview the listing fees and optionally publish the offer.
- Stock offer audit - Page through all inventory items and report the SKUs that have no published offer.
Clients
ebay.inventory: Client
The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay marketplace. There are also methods in this API that will convert eligible, active eBay listings into the Inventory API model.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ebay.com/sell/inventory/v1" - URL of the target service
bulkCreateOrReplaceInventoryItem
function bulkCreateOrReplaceInventoryItem(BulkCreateOrReplaceInventoryItemHeaders headers, BulkInventoryItem payload) returns BulkInventoryItemResponse|errorBulk create or replace inventory items
Parameters
- headers BulkCreateOrReplaceInventoryItemHeaders - Headers to be sent with the request
- payload BulkInventoryItem - Details of the inventories with sku and locale
Return Type
- BulkInventoryItemResponse|error - Per-item results of the bulk create or replace request
bulkGetInventoryItem
function bulkGetInventoryItem(BulkGetInventoryItemHeaders headers, BulkGetInventoryItem payload) returns BulkGetInventoryItemResponse|errorBulk get inventory items
Parameters
- headers BulkGetInventoryItemHeaders - Headers to be sent with the request
- payload BulkGetInventoryItem - Details of the inventories with sku and locale
Return Type
- BulkGetInventoryItemResponse|error - Inventory items and per-item results for the requested SKUs
bulkUpdatePriceQuantity
function bulkUpdatePriceQuantity(BulkUpdatePriceQuantityHeaders headers, BulkPriceQuantity payload) returns BulkPriceQuantityResponse|errorBulk update price and quantity
Parameters
- headers BulkUpdatePriceQuantityHeaders - Headers to be sent with the request
- payload BulkPriceQuantity - Price and allocation details for the given SKU and Marketplace
Return Type
- BulkPriceQuantityResponse|error - Per-offer and per-SKU results of the price and quantity update
getInventoryItem
function getInventoryItem(string sku, map<string|string[]> headers) returns InventoryItemWithSkuLocaleGroupid|errorGet an inventory item
Parameters
- sku string - Seller-defined SKU of the inventory item record to retrieve. Maximum length: 50.
Return Type
- InventoryItemWithSkuLocaleGroupid|error - The requested inventory item
createOrReplaceInventoryItem
function createOrReplaceInventoryItem(string sku, CreateOrReplaceInventoryItemHeaders headers, InventoryItem payload) returns BaseResponse|error?Create or replace an inventory item
Parameters
- sku string - This path parameter specifies the seller-defined SKU value for the inventory item being created or updated. SKU values must be unique across the seller's inventory. Maximum length: 50
- headers CreateOrReplaceInventoryItemHeaders - Headers to be sent with the request
- payload InventoryItem - Details of the inventory item record
Return Type
- BaseResponse|error? - Warnings returned after the inventory item was updated
deleteInventoryItem
Delete an inventory item
Parameters
- sku string - This path parameter specifies the seller-defined SKU value of the product whose inventory item record you wish to delete. Use the getInventoryItems method to retrieve SKU values. Maximum length: 50
Return Type
- error? - No Content
getInventoryItems
function getInventoryItems(map<string|string[]> headers, *GetInventoryItemsQueries queries) returns InventoryItems|errorList inventory items
Parameters
- queries *GetInventoryItemsQueries - Queries to be sent with the request
Return Type
- InventoryItems|error - A paginated list of inventory items
getProductCompatibility
function getProductCompatibility(string sku, map<string|string[]> headers) returns Compatibility|errorGet product compatibility
Parameters
- sku string - SKU of the inventory item whose product compatibility list is retrieved.
Return Type
- Compatibility|error - The product compatibility list of the inventory item
createOrReplaceProductCompatibility
function createOrReplaceProductCompatibility(string sku, CreateOrReplaceProductCompatibilityHeaders headers, Compatibility payload) returns BaseResponse|error?Create or replace product compatibility
Parameters
- sku string - This path parameter specifies the SKU (stock keeping unit) of the inventory item associated with the compatibility list being created. Use the getInventoryItems method to retrieve SKU values
- headers CreateOrReplaceProductCompatibilityHeaders - Headers to be sent with the request
- payload Compatibility - Details of the compatibility
Return Type
- BaseResponse|error? - Warnings returned after the product compatibility was updated
deleteProductCompatibility
Delete product compatibility
Parameters
- sku string - SKU of the inventory item whose product compatibility list is deleted.
Return Type
- error? - No Content
getInventoryItemGroup
function getInventoryItemGroup(string inventoryItemGroupKey, map<string|string[]> headers) returns InventoryItemGroup|errorGet an inventory item group
Parameters
- inventoryItemGroupKey string - This path parameter specifies the unique identifier of the inventory item group being retrieved. This value is assigned by the seller when an inventory item group is created
Return Type
- InventoryItemGroup|error - The requested inventory item group
createOrReplaceInventoryItemGroup
function createOrReplaceInventoryItemGroup(string inventoryItemGroupKey, CreateOrReplaceInventoryItemGroupHeaders headers, InventoryItemGroup payload) returns BaseResponse|error?Create or replace an inventory item group
Parameters
- inventoryItemGroupKey string - Seller-defined unique identifier of the inventory item group to create or update. Cannot be changed once set. Maximum length: 50.
- headers CreateOrReplaceInventoryItemGroupHeaders - Headers to be sent with the request
- payload InventoryItemGroup - Details of the inventory Item Group
Return Type
- BaseResponse|error? - Warnings returned after the inventory item group was updated
deleteInventoryItemGroup
function deleteInventoryItemGroup(string inventoryItemGroupKey, map<string|string[]> headers) returns error?Delete an inventory item group
Parameters
- inventoryItemGroupKey string - This path parameter specifies the unique identifier of the inventory item group being deleted. This value is assigned by the seller when an inventory item group is created
Return Type
- error? - No Content
bulkMigrateListing
function bulkMigrateListing(BulkMigrateListingHeaders headers, BulkMigrateListing payload) returns BulkMigrateListingResponse|errorBulk migrate listings
Parameters
- headers BulkMigrateListingHeaders - Headers to be sent with the request
- payload BulkMigrateListing - Details of the listings that needs to be migrated into Inventory
Return Type
- BulkMigrateListingResponse|error - Per-listing results of the migration request
getSkuLocationMapping
function getSkuLocationMapping(string listingId, string sku, map<string|string[]> headers) returns LocationMapping|errorGet a SKU location mapping
Parameters
- listingId string - Unique identifier of the listing that contains the SKU whose mapped locations are retrieved.
- sku string - Seller-defined SKU of the item or variation whose location mappings are retrieved. Must be defined in the listing given by listingId.
Return Type
- LocationMapping|error - The fulfillment locations mapped to the listing and SKU
createOrReplaceSkuLocationMapping
function createOrReplaceSkuLocationMapping(string listingId, string sku, CreateOrReplaceSkuLocationMappingHeaders headers, LocationMapping payload) returns error?Create or replace a SKU location mapping
Parameters
- listingId string - Unique identifier of the listing in which fulfillment center locations are mapped to a SKU.
- sku string - Seller-defined SKU of the item or variation to map fulfillment center locations to. Must be defined in the listing given by listingId.
- headers CreateOrReplaceSkuLocationMappingHeaders - Headers to be sent with the request
- payload LocationMapping - Fulfillment locations to map to the listing and SKU combination
Return Type
- error? - No Content
deleteSkuLocationMapping
function deleteSkuLocationMapping(string listingId, string sku, map<string|string[]> headers) returns error?Delete a SKU location mapping
Parameters
- listingId string - Unique identifier of the listing that contains the SKU whose mapped locations are removed.
- sku string - Seller-defined SKU of the item or variation whose location mappings are removed. Must be defined in the listing given by listingId.
Return Type
- error? - No Content
bulkCreateOffer
function bulkCreateOffer(BulkCreateOfferHeaders headers, BulkEbayOfferDetailsWithKeys payload) returns BulkOfferResponse|errorBulk create offers
Parameters
- headers BulkCreateOfferHeaders - Headers to be sent with the request
- payload BulkEbayOfferDetailsWithKeys - Details of the offer for the channel
Return Type
- BulkOfferResponse|error - Per-offer results of the bulk create request
bulkPublishOffer
function bulkPublishOffer(BulkPublishOfferHeaders headers, BulkOffer payload) returns BulkPublishResponse|errorBulk publish offers
Parameters
- headers BulkPublishOfferHeaders - Headers to be sent with the request
- payload BulkOffer - The base request of the bulkPublishOffer method
Return Type
- BulkPublishResponse|error - Per-offer results of the bulk publish request
getOffers
List offers
Parameters
- queries *GetOffersQueries - Queries to be sent with the request
createOffer
function createOffer(CreateOfferHeaders headers, EbayOfferDetailsWithKeys payload) returns OfferResponse|errorCreate an offer
Parameters
- headers CreateOfferHeaders - Headers to be sent with the request
- payload EbayOfferDetailsWithKeys - Details of the offer for the channel
Return Type
- OfferResponse|error - The identifier of the newly created offer
getOffer
function getOffer(string offerId, map<string|string[]> headers) returns EbayOfferDetailsWithAll|errorGet an offer
Parameters
- offerId string - This path parameter specifies the unique identifier of the offer that is to be retrieved. Use the getOffers method to retrieve offer IDs
Return Type
- EbayOfferDetailsWithAll|error - The requested offer
updateOffer
function updateOffer(string offerId, UpdateOfferHeaders headers, EbayOfferDetailsWithId payload) returns OfferResponse|error?Update an offer
Parameters
- offerId string - This path parameter specifies the unique identifier of the offer being updated. Use the getOffers method to retrieve offer IDs
- headers UpdateOfferHeaders - Headers to be sent with the request
- payload EbayOfferDetailsWithId - Details of the offer for the channel
Return Type
- OfferResponse|error? - Warnings returned after the offer was updated
deleteOffer
Delete an offer
Parameters
- offerId string - This path parameter specifies the unique identifier of the offer being deleted. Use the getOffers method to retrieve offer IDs
Return Type
- error? - No Content
getListingFees
function getListingFees(GetListingFeesHeaders headers, OfferKeysWithId payload) returns FeesSummaryResponse|errorGet listing fees for offers
Parameters
- headers GetListingFeesHeaders - Headers to be sent with the request
- payload OfferKeysWithId - List of offers that needs fee information
Return Type
- FeesSummaryResponse|error - Listing fees for each of the requested offers
publishOffer
Publish an offer
Parameters
- offerId string - This path parameter specifies the unique identifier of the offer that is to be published. Use the getOffers method to retrieve offer IDs
Return Type
- PublishResponse|error - The listing identifier and any warnings for the published offer
publishOfferByInventoryItemGroup
function publishOfferByInventoryItemGroup(PublishOfferByInventoryItemGroupHeaders headers, PublishByInventoryItemGroupRequest payload) returns PublishResponse|errorPublish offers by inventory item group
Parameters
- headers PublishOfferByInventoryItemGroupHeaders - Headers to be sent with the request
- payload PublishByInventoryItemGroupRequest - The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload
Return Type
- PublishResponse|error - The listing identifier and any warnings for the published group
withdrawOffer
Withdraw an offer
Parameters
- offerId string - This path parameter specifies the unique identifier of the offer that is to be withdrawn. Use the getOffers method to retrieve offer IDs
Return Type
- WithdrawResponse|error - The listing identifier of the withdrawn offer and any warnings
withdrawOfferByInventoryItemGroup
function withdrawOfferByInventoryItemGroup(WithdrawOfferByInventoryItemGroupHeaders headers, WithdrawByInventoryItemGroupRequest payload) returns error?Withdraw offers by inventory item group
Parameters
- headers WithdrawOfferByInventoryItemGroupHeaders - Headers to be sent with the request
- payload WithdrawByInventoryItemGroupRequest - The base request of the withdrawOfferByInventoryItemGroup call
Return Type
- error? - No Content
getInventoryLocation
function getInventoryLocation(string merchantLocationKey, map<string|string[]> headers) returns InventoryLocationResponse|errorGet an inventory location
Parameters
- merchantLocationKey string - Unique merchant-defined key (ID) of the inventory location to retrieve. Maximum length: 36.
Return Type
- InventoryLocationResponse|error - The requested inventory location
createInventoryLocation
function createInventoryLocation(string merchantLocationKey, CreateInventoryLocationHeaders headers, InventoryLocationFull payload) returns error?Create an inventory location
Parameters
- merchantLocationKey string - Unique merchant-defined key (ID) of the inventory location. Maximum length: 36.
- headers CreateInventoryLocationHeaders - Headers to be sent with the request
- payload InventoryLocationFull - Inventory Location details
Return Type
- error? - No Content
deleteInventoryLocation
function deleteInventoryLocation(string merchantLocationKey, map<string|string[]> headers) returns error?Delete an inventory location
Parameters
- merchantLocationKey string - Unique merchant-defined key (ID) of the inventory location to delete. Maximum length: 36.
Return Type
- error? - Success
disableInventoryLocation
function disableInventoryLocation(string merchantLocationKey, map<string|string[]> headers) returns record {}|errorDisable an inventory location
Parameters
- merchantLocationKey string - Unique merchant-defined key (ID) of the inventory location to disable. Maximum length: 36.
Return Type
- record {}|error - The inventory location was disabled
enableInventoryLocation
function enableInventoryLocation(string merchantLocationKey, map<string|string[]> headers) returns record {}|errorEnable an inventory location
Parameters
- merchantLocationKey string - Unique merchant-defined key (ID) of the disabled inventory location to enable. Maximum length: 36.
Return Type
- record {}|error - The inventory location was enabled
getInventoryLocations
function getInventoryLocations(map<string|string[]> headers, *GetInventoryLocationsQueries queries) returns LocationResponse|errorList inventory locations
Parameters
- queries *GetInventoryLocationsQueries - Queries to be sent with the request
Return Type
- LocationResponse|error - A paginated list of inventory locations
updateInventoryLocation
function updateInventoryLocation(string merchantLocationKey, UpdateInventoryLocationHeaders headers, InventoryLocation payload) returns error?Update inventory location details
Parameters
- merchantLocationKey string - Unique merchant-defined key (ID) of the inventory location to update. Maximum length: 36.
- headers UpdateInventoryLocationHeaders - Headers to be sent with the request
- payload InventoryLocation - The inventory location details to be updated
Return Type
- error? - Success
Records
ebay.inventory: Address
This type is used to define the physical address of an inventory location
Fields
- country CountryCodeEnum - Two-letter ISO 3166-1 Alpha-2 country codes.
- stateOrProvince string - The state or province of the inventory location. Required for fulfillment centers; for warehouses, required with city if postalCode is not provided. Maximum length: 128.
- city? string - The city of the inventory location. Required for fulfillment centers; for warehouses, required with stateOrProvince if postalCode is not provided. Returned if defined. Maximum length: 128.
- postalCode? string - The postal or zip code of the address. Required for fulfillment centers; for warehouses, required if a city and stateOrProvince pair is not provided. Returned if defined. Maximum length: 16.
- county? string - The county in which the address resides. This field is returned if defined for an inventory location
- addressLine1? string - The first line of the street address. Required for fulfillment center locations, optional for warehouse locations. Returned if defined. Maximum length: 128.
- addressLine2? string - The second line of the street address, such as a suite or apartment number. Returned if defined. Maximum length: 128.
ebay.inventory: Amount
This type is used to express a dollar value and the applicable currency
Fields
- currency? string - The three-letter ISO 4217 currency code. Both value and currency are required and always returned when expressing prices.
- value? string - A string representation of a dollar value expressed in the currency specified in the currency field. Both the value and currency fields are required/always returned when expressing prices
ebay.inventory: Availability
This type is used to specify the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer
Fields
- shipToLocationAvailability? ShipToLocationAvailability - This type is used to specify the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers
ebay.inventory: AvailabilityDistribution
This type is used to set the available quantity of the inventory item at one or more warehouse locations
Fields
- quantity? Signed32 - The integer value passed into this field indicates the quantity of the inventory item that is available at this inventory location. This field is conditionally required
- merchantLocationKey? string - The unique identifier of the inventory location that holds quantity of the inventory item. Conditionally required to identify that location.
- fulfillmentTime? TimeDuration - This type is used to indicate the fulfillment time for an order that will be shipped to the buyer
ebay.inventory: AvailabilityWithAll
This type is used to specify the quantity of the inventory items that are available for purchase if the items will be shipped to the buyer
Fields
- shipToLocationAvailability? ShipToLocationAvailabilityWithAll - This type is used to specify the total 'ship-to-home' quantity of the inventory items that will be available for purchase through one or more published offers
ebay.inventory: BaseResponse
Base response of the createOrReplaceInventoryItem, createOrReplaceInventoryItemGroup and createOrReplaceProductCompatibility calls, returned only when errors or warnings occur.
Fields
- warnings? ErrorDetailV3[] - The errors or warnings triggered by the call, returned only if any occur.
ebay.inventory: BestOffer
This type is used by the bestOfferTerms container, which is used if the seller would like to support the Best Offer feature on their listing
Fields
- bestOfferEnabled? boolean - Whether the Best Offer feature is enabled for the listing; set to true to enable it. Not available for multi-variation listings.
- autoAcceptPrice? Amount - This type is used to express a dollar value and the applicable currency
- autoDeclinePrice? Amount - This type is used to express a dollar value and the applicable currency
ebay.inventory: BulkCreateOfferHeaders
Represents the Headers record for the operation: bulkCreateOffer
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: BulkCreateOrReplaceInventoryItemHeaders
Represents the Headers record for the operation: bulkCreateOrReplaceInventoryItem
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: BulkEbayOfferDetailsWithKeys
This type is used by the base request of the bulkCreateOffer method, which is used to create up to 25 new offers
Fields
- requests EbayOfferDetailsWithKeys[] - The details of each offer that is being created is passed in under this container. Up to 25 offers can be created with one bulkCreateOffer call
ebay.inventory: BulkGetInventoryItem
This type is used by the base request of the bulkGetInventoryItem method
Fields
- requests GetInventoryItem[] - The seller passes in multiple SKU values under this container to retrieve multiple inventory item records. Up to 25 inventory item records can be retrieved at one time
ebay.inventory: BulkGetInventoryItemHeaders
Represents the Headers record for the operation: bulkGetInventoryItem
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: BulkGetInventoryItemResponse
This type is used by the base response of the bulkGetInventoryItem method
Fields
- responses GetInventoryItemResponse[] - This is the base container of the bulkGetInventoryItem response. The results of each attempted inventory item retrieval is captured under this container
ebay.inventory: BulkInventoryItem
The base request of the bulkCreateOrReplaceInventoryItem method
Fields
- requests InventoryItemWithSkuLocale[] - The inventory items to create or update. Up to 25 inventory items per call.
ebay.inventory: BulkInventoryItemResponse
This type is used by the base response of the bulkCreateOrReplaceInventoryItem method
Fields
- responses InventoryItemResponse[] - This is the base container of the bulkCreateOrReplaceInventoryItem response. The results of each attempted inventory item creation/update is captured under this container
ebay.inventory: BulkMigrateListing
This type is used by the base container of the bulkMigrateListings request payload
Fields
- requests MigrateListing[] - This is the base container of the bulkMigrateListings request payload. One to five eBay listings will be included under this container
ebay.inventory: BulkMigrateListingHeaders
Represents the Headers record for the operation: bulkMigrateListing
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: BulkMigrateListingResponse
This type is used by the response payload of the bulkMigrateListings call
Fields
- responses MigrateListingResponse[] - This is the base container of the response payload of the bulkMigrateListings call. The results of each attempted listing migration is captured under this container
ebay.inventory: BulkOffer
This type is used by the base request of the bulkPublishOffer method, which is used to publish up to 25 different offers
Fields
- requests OfferKeyWithId[] - This container is used to pass in an array of offers to publish. Up to 25 offers can be published with one bulkPublishOffer method
ebay.inventory: BulkOfferResponse
This type is used by the base response of the bulkCreateOffer method
Fields
- responses OfferSkuResponse[] - This object contains the responses that show the status of each offer that the seller attempted to create with the method call
ebay.inventory: BulkPriceQuantity
Request payload of bulkUpdatePriceQuantity, which updates the total ship-to-home quantity of up to 25 inventory items and/or the price and quantity of specific published offers.
Fields
- requests PriceQuantity[] - The inventory items (up to 25) whose ship-to-home quantity to update, and/or the published offers whose price or quantity to update.
ebay.inventory: BulkPriceQuantityResponse
Response of bulkUpdatePriceQuantity, with an HTTP status code, offer ID and SKU for each offer or inventory item updated, plus any errors or warnings.
Fields
- responses PriceQuantityResponse[] - The result for each offer or inventory item updated, with the HTTP status code, offer ID, SKU and any errors or warnings.
ebay.inventory: BulkPublishOfferHeaders
Represents the Headers record for the operation: bulkPublishOffer
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: BulkPublishResponse
This type is used by the base response of the bulkPublishOffer method
Fields
- responses OfferResponseWithListingId[] - A node is returned under the responses container to indicate the success or failure of each offer that the seller was attempting to publish
ebay.inventory: BulkUpdatePriceQuantityHeaders
Represents the Headers record for the operation: bulkUpdatePriceQuantity
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: Charity
Charitable organization associated with the listing and the percentage of sale proceeds it receives. The organization must be registered with the PayPal Giving Fund to receive proceeds.
Fields
- donationPercentage? string - The percentage of the purchase price donated to the charity, from 10 to 100 in increments of 5. Required when donating to a charity.
- charityId? string - The eBay-assigned unique identifier of the charitable organization that receives a percentage of sales proceeds. Required when donating to a charity.
ebay.inventory: Compatibility
This type is used by the createOrReplaceProductCompatibility call to associate compatible vehicles to an inventory item. This type is also the base response of the getProductCompatibility call
Fields
- compatibleProducts CompatibleProduct[] - This container consists of an array of motor vehicles (make, model, year, trim, engine) that are compatible with the motor vehicle part or accessory specified by the sku value
- sku string - The seller-defined SKU of the inventory item associated with the compatible vehicles. Always returned by getProductCompatibility.
ebay.inventory: CompatibleProduct
This type is used to specify/indicate the motor vehicles that are compatible with the corresponding inventory item.
Fields
- notes? string - Seller notes about the compatible vehicle, such as the part's placement on the vehicle. Returned only if set. Maximum length: 500.
- productIdentifier? ProductIdentifier - Identifies a motor vehicle compatible with the inventory item, by eBay Product ID or K-Type value. The gtin field is for future use only.
- compatibilityProperties? NameValueList[] - The vehicle aspect name-value pairs (such as make, model, year, trim and engine) that identify a compatible motor vehicle. Make, model and year are typically required.
- productFamilyProperties? ProductFamilyProperties - This type is used to specify the details of a motor vehicle that is compatible with the inventory item specified through the SKU value in the call URI
ebay.inventory: ConditionDescriptor
This type is used by the seller to provide additional information about the condition of an item in a structured format
Fields
- values? string[] - The numeric IDs of the values for the condition descriptor, such as a grader, grade or card condition.
- additionalInfo? string - Open-text additional information for a condition descriptor, such as a certification number or damage code for graded items. Maximum length: 30.
- name? string - The numeric ID of the condition descriptor name. Condition descriptor name-value pairs describe an item's condition in a structured way.
ebay.inventory: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
ebay.inventory: CountryPolicy
This type specifies custom product compliance and/or take-back policies that apply to a specified country
Fields
- country? CountryCodeEnum - Two-letter ISO 3166-1 Alpha-2 country codes.
- policyIds? string[] - The custom policy identifiers, such as product compliance or take-back policies, that apply to the specified country.
ebay.inventory: CreateInventoryLocationHeaders
Represents the Headers record for the operation: createInventoryLocation
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: CreateOfferHeaders
Represents the Headers record for the operation: createOffer
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: CreateOrReplaceInventoryItemGroupHeaders
Represents the Headers record for the operation: createOrReplaceInventoryItemGroup
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: CreateOrReplaceInventoryItemHeaders
Represents the Headers record for the operation: createOrReplaceInventoryItem
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: CreateOrReplaceProductCompatibilityHeaders
Represents the Headers record for the operation: createOrReplaceProductCompatibility
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: CreateOrReplaceSkuLocationMappingHeaders
Represents the Headers record for the operation: createOrReplaceSkuLocationMapping
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: Dimension
Dimensions of a shipping package and their unit of measure. Conditionally required when the seller offers calculated shipping rates.
Fields
- unit? LengthUnitOfMeasureEnum - Unit of measure for the dimensions of a shipping package.
- length? decimal - The length of the shipping package, in the unit given in the unit field. All dimension fields are required if package dimensions are specified.
- width? decimal - The width of the shipping package, in the unit given in the unit field. All dimension fields are required if package dimensions are specified.
- height? decimal - The height of the shipping package, in the unit given in the unit field. All dimension fields are required if package dimensions are specified.
ebay.inventory: Document
This type provides an array of one or more regulatory documents associated with a listing for Regulatory Compliance
Fields
- documentId? string - The unique identifier of a regulatory document associated with the listing. This value can be found in the response of the createDocument method of the Media API
ebay.inventory: EbayOfferDetailsWithAll
This type provides details of an offer, and is used by the response payloads of the getOffer and the getOffers calls
Fields
- availableQuantity? Signed32 - The quantity of the inventory item available for purchase on the marketplace given in marketplaceId.
- hideBuyerDetails boolean - Whether the private listing feature is enabled, hiding buyer IDs from other users. Always returned; defaults to false.
- includeCatalogProductDetails boolean - Whether eBay product catalog details are applied to the listing, based on the product identifier. Defaults to true.
- lotSize? Signed32 - The number of identical items sold in a lot listing. Returned only for lot listings.
- quantityLimitPerBuyer? Signed32 - The maximum quantity of the inventory item that each buyer may purchase, across one or more transactions. Set only if the seller restricts purchase quantity.
- regulatory? Regulatory - Type defining regulatory information that the seller is required to disclose
- format FormatTypeEnum - Listing format of the offer. Creating an auction offer reserves one unit of the item's available quantity until the auction ends.
- secondaryCategoryId? string - The unique identifier of a secondary category, used when listing the item in two categories. A fee may apply.
- tax? Tax - Enables a sales-tax table, sets a tax exception category code, or specifies a VAT percentage. Sales-tax tables are available only for the US and Canada marketplaces.
- pricingSummary PricingSummary - Listing price and Minimum Advertised Price and Strikethrough Pricing settings. Price is required before an offer is published, but can be omitted when the offer is created.
- listingPolicies ListingPolicies - Business policies (payment, return and fulfillment) and custom policies for the listing. Every published offer needs payment, return and fulfillment policies; also holds shipping cost overrides, eBay Plus and Best Offer settings.
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- charity? Charity - Charitable organization associated with the listing and the percentage of sale proceeds it receives. The organization must be registered with the PayPal Giving Fund to receive proceeds.
- merchantLocationKey? string - The unique identifier of the inventory location; it cannot be modified once set. Always returned for published offers, and only if set for unpublished offers. Maximum length: 36.
- offerId string - The unique identifier of the offer. This identifier is used in many offer-related calls, and it is also used in the bulkUpdatePriceQuantity call
- storeCategoryNames? string[] - The full paths of up to two eBay store categories the item is placed in, such as /Fashion/Men/Shirts. Returned if set.
- listingStartDate? string - The UTC date and time the seller set for a scheduled listing to become active, for example 2023-05-30T19:08:00Z. Returned if set.
- extendedProducerResponsibility? ExtendedProducerResponsibility - IDs of the producer or importer related to the new item, packaging, added documentation or an eco-participation fee.
- listing? ListingDetails - eBay listing ID, listing status and quantity sold for an offer. Returned only for published offers.
- sku string - This is the seller-defined SKU value of the product in the offer. Maximum length: 50
- categoryId? string - The unique identifier of the primary eBay category that the inventory item is listed under. This field is always returned for published offers, but is only returned if set for unpublished offers
- listingDuration ListingDurationEnum - Listing duration periods. GTC applies to fixed-price listings and is their only supported duration; the DAYS_n values apply to auction listings.
- listingDescription? string - The listing description of the offer. Always returned for published offers, and only if set for unpublished offers. Maximum length: 500,000, including HTML markup.
- status OfferStatusEnum - Current status of the offer, published or unpublished.
ebay.inventory: EbayOfferDetailsWithId
Offer details passed to the updateOffer call. Every field currently set on the offer must be passed, even unchanged ones; updating a published offer also updates the live listing.
Fields
- availableQuantity? Signed32 - The quantity of the inventory item available through the offer; must be 1 or more to be purchasable. Omit for auction listings, and resend in updateOffer if already set.
- hideBuyerDetails? boolean - Set to true to enable, or false to remove, the private listing feature, which hides buyer IDs from other users.
- includeCatalogProductDetails boolean - Whether eBay product catalog details are applied to the listing, based on the product identifier. Defaults to true.
- lotSize? Signed32 - The total number of items in a lot listing, whether identical or a mixed lot. Applies only to lot listings.
- quantityLimitPerBuyer? Signed32 - The maximum quantity that each buyer may purchase, across one or more transactions. Must be resent in updateOffer if already set.
- regulatory? Regulatory - Type defining regulatory information that the seller is required to disclose
- secondaryCategoryId? string - The unique identifier of a secondary category, used when listing the item in two categories. A fee may apply.
- tax? Tax - Enables a sales-tax table, sets a tax exception category code, or specifies a VAT percentage. Sales-tax tables are available only for the US and Canada marketplaces.
- pricingSummary? PricingSummary - Listing price and Minimum Advertised Price and Strikethrough Pricing settings. Price is required before an offer is published, but can be omitted when the offer is created.
- listingPolicies? ListingPolicies - Business policies (payment, return and fulfillment) and custom policies for the listing. Every published offer needs payment, return and fulfillment policies; also holds shipping cost overrides, eBay Plus and Best Offer settings.
- charity? Charity - Charitable organization associated with the listing and the percentage of sale proceeds it receives. The organization must be registered with the PayPal Giving Fund to receive proceeds.
- merchantLocationKey? string - The unique identifier of the inventory location where the item is located. Required before the offer is published. Maximum length: 36.
- storeCategoryNames? string[] - The full paths of up to two eBay store categories to place the item in, such as /Fashion/Men/Shirts. Must be resent in updateOffer if already set.
- listingStartDate? string - The future UTC date and time an unpublished offer's listing becomes active, for example 2023-05-30T19:08:00Z. Optional; if omitted, the listing starts once published.
- extendedProducerResponsibility? ExtendedProducerResponsibility - IDs of the producer or importer related to the new item, packaging, added documentation or an eco-participation fee.
- categoryId? string - The unique identifier of the eBay category the item is listed under. Required before the offer is published, and must be resent in updateOffer if already set.
- listingDuration? ListingDurationEnum - Listing duration periods. GTC applies to fixed-price listings and is their only supported duration; the DAYS_n values apply to auction listings.
- listingDescription? string - The listing description; HTML is allowed. Required before the offer is published, and must be resent in updateOffer if already set. Maximum length: 500,000, including HTML markup.
ebay.inventory: EbayOfferDetailsWithKeys
This type provides details of an offer, and is used by the base request payload of the createOffer and bulkCreateOffer methods
Fields
- availableQuantity? Signed32 - The quantity of the inventory item available for purchase on the marketplace; must be 1 or more to be purchasable. Overrides the inventory item quantity. Omit for auction listings.
- hideBuyerDetails? boolean - Set to true to create a private listing, which hides buyer IDs from other users.
- includeCatalogProductDetails boolean - Whether eBay product catalog details are applied to the listing, based on the product identifier. Defaults to true.
- lotSize? Signed32 - The total number of items in a lot listing, whether identical or a mixed lot. Applies only to lot listings.
- quantityLimitPerBuyer? Signed32 - The maximum quantity that each buyer may purchase, across one or more transactions. Set only if the seller restricts purchase quantity.
- regulatory? Regulatory - Type defining regulatory information that the seller is required to disclose
- format FormatTypeEnum - Listing format of the offer. Creating an auction offer reserves one unit of the item's available quantity until the auction ends.
- secondaryCategoryId? string - The unique identifier of a secondary category, used when listing the item in two categories. A fee may apply.
- tax? Tax - Enables a sales-tax table, sets a tax exception category code, or specifies a VAT percentage. Sales-tax tables are available only for the US and Canada marketplaces.
- pricingSummary? PricingSummary - Listing price and Minimum Advertised Price and Strikethrough Pricing settings. Price is required before an offer is published, but can be omitted when the offer is created.
- listingPolicies? ListingPolicies - Business policies (payment, return and fulfillment) and custom policies for the listing. Every published offer needs payment, return and fulfillment policies; also holds shipping cost overrides, eBay Plus and Best Offer settings.
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- charity? Charity - Charitable organization associated with the listing and the percentage of sale proceeds it receives. The organization must be registered with the PayPal Giving Fund to receive proceeds.
- merchantLocationKey? string - The unique identifier of the inventory location where the item is located. Not required when creating the offer, but required before it is published. Maximum length: 36.
- storeCategoryNames? string[] - The full paths of up to two eBay store categories to place the item in, such as /Fashion/Men/Shirts.
- listingStartDate? string - The future UTC date and time the listing becomes active, for example 2023-05-30T19:08:00Z. Optional; if omitted, the listing starts once published.
- extendedProducerResponsibility? ExtendedProducerResponsibility - IDs of the producer or importer related to the new item, packaging, added documentation or an eco-participation fee.
- sku string - The seller-defined SKU of the product to list. Required. Only one offer may exist per SKU, marketplace and format combination. Maximum length: 50.
- categoryId? string - The unique identifier of the eBay category the product is listed under. Not required when creating the offer, but required before it is published.
- listingDuration? ListingDurationEnum - Listing duration periods. GTC applies to fixed-price listings and is their only supported duration; the DAYS_n values apply to auction listings.
- listingDescription? string - The listing description; HTML is allowed. Required before the offer is published. Maximum length: 500,000, including HTML markup.
ebay.inventory: EnergyEfficiencyLabel
Energy efficiency information for certain durable goods. The energy efficiency rating and range must be specified through the inventory item's aspects field.
Fields
- productInformationSheet? string - The URL to the Product Information Sheet that provides complete manufacturer-provided efficiency information about an item
- imageDescription? string - A brief verbal summary of the information included on the Energy Efficiency Label for an item. For example, On a scale of A to G the rating is E.
- imageURL? string - The URL to the Energy Efficiency Label image that is applicable to an item
ebay.inventory: ErrorDetailV3
This type is used to express detailed information on errors and warnings that may occur with a call request
Fields
- domain? string - The name of the domain in which the error or warning occurred
- subdomain? string - The name of the subdomain in which the error or warning occurred
- outputRefIds? 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
- errorId? Signed32 - A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms
- inputRefIds? 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
- category? string - This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.
- 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? string - A description of the condition that caused the error or warning
- parameters? ErrorParameterV3[] - Various warning and error messages return one or more variables that contain contextual information about the error or warning. This is often the field or value that triggered the error or warning
ebay.inventory: ErrorParameterV3
This type is used to indicate the parameter field/value that caused an issue with the call request
Fields
- name? string - This type contains the name and value of an input parameter that contributed to a specific error or warning condition
- value? string - This is the actual value that was passed in for the element specified in the name field
ebay.inventory: ExtendedProducerResponsibility
IDs of the producer or importer related to the new item, packaging, added documentation or an eco-participation fee.
Fields
- productPackageId? string - Deprecated and no longer supported.
- ecoParticipationFee? Amount - This type is used to express a dollar value and the applicable currency
- productDocumentationId? string - Deprecated and no longer supported.
- producerProductId? string - Deprecated and no longer supported.
- shipmentPackageId? string - Deprecated and no longer supported.
ebay.inventory: Fee
Expected listing fees per eBay marketplace for one or more unpublished offers, including any promotional discounts applied to a fee.
Fields
- amount Amount - This type is used to express a dollar value and the applicable currency
- promotionalDiscount? Amount - This type is used to express a dollar value and the applicable currency
- feeType string - The type of listing fee the seller may incur if the offers are published, such as InsertionFee or SubtitleFee. Fees may be returned even when 0.0.
ebay.inventory: FeesSummaryResponse
This type is used by the base response payload for the getListingFees call.
Fields
- feeSummaries FeeSummary[] - The listing fees the seller can expect to pay for the specified unpublished offers. Fees may be returned even when 0.0.
ebay.inventory: FeeSummary
This type is used to display the expected listing fees for each unpublished offer specified in the request of the getListingFees call
Fields
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- fees Fee[] - The listing fees expected to apply to an offer on the marketplace. Fees may be returned even when 0.0.
- warnings? ErrorDetailV3[] - This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur
ebay.inventory: FormatAllocation
This type is used to indicate the quantities of the inventory items that are reserved for the different listing formats of the SKU offers
Fields
- fixedPrice? Signed32 - This integer value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU
- auction? Signed32 - This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU
ebay.inventory: FulfillmentCenterSpecifications
This type is used to provide shipping specification details, such as the weekly cut-off schedule for order handling and cut-off override(s), for a fulfillment center location.
Fields
- sameDayShippingCutOffTimes? SameDayShippingCutOffTimes - This type is used by the createInventoryLocation call to specify cut-off time(s) for an inventory location, as well as any overrides for these times
ebay.inventory: GeoCoordinates
This type is used to express the Global Positioning System (GPS) latitude and longitude coordinates of an inventory location
Fields
- latitude? decimal - The latitude (north-south) of the location, for example 33.089805. Required if geoCoordinates is used; returned if set.
- longitude? decimal - The longitude (east-west) of the location, for example -88.709822. Required if geoCoordinates is used; returned if set.
ebay.inventory: GetInventoryItem
The seller-defined Stock-Keeping Unit (SKU) of each inventory item that the user wants to retrieve is passed in the request of the bulkGetInventoryItem method
Fields
- sku string - An array of SKU values are passed in under the sku container to retrieve up to 25 inventory item records. Use the getInventoryItems method to retrieve SKU values
ebay.inventory: GetInventoryItemResponse
This type is used by the response of the bulkGetInventoryItem method to give the status of each inventory item record that the user tried to retrieve
Fields
- inventoryItem InventoryItemWithSkuLocaleGroupKeys - This type is used to provide details about each retrieved inventory item record
- warnings? ErrorDetailV3[] - This container will be returned if there were one or more warnings associated with retrieving the inventory item record
- 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
- errors? ErrorDetailV3[] - This container will be returned if there were one or more errors associated with retrieving the inventory item record
- statusCode Signed32 - The HTTP status code indicating whether the inventory item for the given SKU was retrieved successfully.
ebay.inventory: GetInventoryItemsQueries
Represents the Queries record for the operation: getInventoryItems
Fields
- offset? string - Page number to retrieve, starting at 0 for the first page. Default: 0.
- 'limit? string - Maximum number of records to return per page, as an integer from 1 to 200. Default: 25.
ebay.inventory: GetInventoryLocationsQueries
Represents the Queries record for the operation: getInventoryLocations
Fields
- offset? string - Number of locations to skip before returning the first location in the paginated response. Default: 0.
- 'limit? string - Maximum number of records to return per page, as a positive integer (minimum 1). Up to 100 records are returned if not set.
ebay.inventory: GetListingFeesHeaders
Represents the Headers record for the operation: getListingFees
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: GetOffersQueries
Represents the Queries record for the operation: getOffers
Fields
- marketplaceId? string - eBay marketplace ID to restrict the returned offers to one marketplace.
- offset? string - Page number to retrieve, as an integer of 0 or greater, starting at 0 for the first page. Default: 0.
- format? string - Listing format of the offers to retrieve, such as FIXED_PRICE.
- 'limit? string - Maximum number of records to return per page, as a positive integer. Up to 100 records are returned if not set.
- sku string - Seller-defined SKU whose offers are returned. Maximum length: 50.
ebay.inventory: Hazmat
Hazardous material information for the listing. The statements field is required; pictograms, signalWord and component are optional.
Fields
- component? string - This field is used by the seller to provide component information for the listing. For example, component information can provide the specific material of Hazmat concern. Maximum length: 120
- pictograms? string[] - The hazard pictogram codes stated on the product's Safety Data Sheet, displayed on the listing.
- signalWord? string - The hazardous materials signal word stated on the product's Safety Data Sheet, displayed on the listing.
- statements? string[] - The hazard statement codes stated on the product's Safety Data Sheet. Required if hazardous material information is provided.
ebay.inventory: InventoryItem
This type is used to provide detailed information about an inventory item
Fields
- condition? ConditionEnum - Condition of the inventory item. Each value maps to an eBay condition ID, and valid conditions vary by category.
- product? Product - Product details such as title, description, aspects and image links. Can include an ePID or GTIN (EAN, ISBN or UPC) to match a product in the eBay Catalog.
- conditionDescriptors? ConditionDescriptor[] - Structured name-value pairs that describe the item's condition, required for graded or ungraded trading cards and coins.
- packageWeightAndSize? PackageWeightAndSize - Package type, weight and dimensions of the shipping package. Weight and dimensions are required for calculated shipping; weight alone is required for flat-rate shipping with a weight surcharge.
- availability? Availability - This type is used to specify the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer
- conditionDescription? string - A description of a used item's condition; ignored for new conditions. Required when updating an item that already has one. Returned if set. Maximum length: 1000.
ebay.inventory: InventoryItemGroup
This type is used by the base request payload of the createOrReplaceInventoryItemGroup call and the base response payload of the getInventoryItemGroup call
Fields
- variesBy? VariesBy - This type is used to specify the product aspect(s) where individual items of the group vary, as well as a list of the available variations of those aspects
- variantSKUs string[] - The SKUs of the inventory items in the group. Required and always returned; omit a SKU to remove it, unless that variation has sales.
- imageUrls? string[] - HTTPS links to images for the group. At least one image is required before publishing, and images must be given here if aspectsImageVariesBy is used.
- subtitle? string - An optional listing subtitle for the group, which incurs an extra fee and overrides item subtitles. Returned if set. Maximum length: 55.
- aspects? record { string[]... } - The item specifics name-value pairs shared by all variations in the group, such as pattern. Required before the group's first offer is published.
- inventoryItemGroupKey string - The seller-created unique identifier of the inventory item group. Returned by getInventoryItemGroup.
- description? string - The group's description, which becomes the listing description; HTML is allowed. Required before the first offer is published. Maximum length: 500,000, including HTML markup.
- title? string - The group's title, which becomes the listing title. Required before the first offer of the group is published. Maximum length: 80.
- videoIds? string[] - The eBay video IDs for the group, created when a video is uploaded. Only one video per listing is supported.
ebay.inventory: InventoryItemListing
SKU and offer ID pair returned in the inventoryItems container of the bulkMigrateListing response. Up to five pairs may be returned per listing.
Fields
- offerId? string - The eBay-generated unique identifier of the offer created by the listing migration. Returned only if the migration succeeds.
- sku string - The seller-defined SKU of the item in the listing, used to manage the inventory item after migration. Returned even if the migration fails.
ebay.inventory: InventoryItemResponse
Result of creating or updating one inventory item record with bulkCreateOrReplaceInventoryItem, identified by its SKU.
Fields
- warnings? ErrorDetailV3[] - This container will be returned if there were one or more warnings associated with the creation or update to the inventory item record
- locale LocaleEnum - Locale that indicates the language used to express the inventory item details.
- 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
- errors? ErrorDetailV3[] - This container will be returned if there were one or more errors associated with the creation or update to the inventory item record
- statusCode Signed32 - The HTTP status code indicating whether the inventory item for the given SKU was created or updated successfully.
ebay.inventory: InventoryItems
This type is used by the base response payload of getInventoryItems call.
Fields
- next? string - This is the URL to the next page of inventory items. This field will only be returned if there are additional inventory items to view
- total Signed32 - The total number of inventory items in the seller's account, used with the limit value to page through results.
- inventoryItems InventoryItemWithSkuLocaleGroupid[] - This container is an array of one or more inventory items, with detailed information on each inventory item
- size Signed32 - This integer value indicates the total number of pages of results that are available. This number will depend on the total number of inventory items available for viewing, and on the limit value
- prev? string - This is the URL to the previous page of inventory items. This field will only be returned if there are previous inventory items to view
- 'limit Signed32 - This integer value is the number of inventory items that will be displayed on each results page
- href string - This is the URL to the current page of inventory items
ebay.inventory: InventoryItemWithSkuLocale
Inventory item record to create or update with bulkCreateOrReplaceInventoryItem. Up to 25 records can be sent in one call.
Fields
- condition? ConditionEnum - Condition of the inventory item. Each value maps to an eBay condition ID, and valid conditions vary by category.
- product? Product - Product details such as title, description, aspects and image links. Can include an ePID or GTIN (EAN, ISBN or UPC) to match a product in the eBay Catalog.
- conditionDescriptors? ConditionDescriptor[] - Structured name-value pairs that describe the item's condition, required for graded or ungraded trading cards and coins.
- packageWeightAndSize? PackageWeightAndSize - Package type, weight and dimensions of the shipping package. Weight and dimensions are required for calculated shipping; weight alone is required for flat-rate shipping with a weight surcharge.
- availability? Availability - This type is used to specify the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer
- locale LocaleEnum - Locale that indicates the language used to express the inventory item details.
- sku string - The seller-defined SKU of the product to list. Required. Only one offer may exist per SKU, marketplace and format combination. Maximum length: 50.
- conditionDescription? string - A description of a used item's condition; ignored for new conditions. Required when updating an item that already has one. Returned if set. Maximum length: 1000.
ebay.inventory: InventoryItemWithSkuLocaleGroupid
This type is used to provide details of a single inventory item
Fields
- condition? ConditionEnum - Condition of the inventory item. Each value maps to an eBay condition ID, and valid conditions vary by category.
- product? Product - Product details such as title, description, aspects and image links. Can include an ePID or GTIN (EAN, ISBN or UPC) to match a product in the eBay Catalog.
- conditionDescriptors? ConditionDescriptor[] - Structured name-value pairs that describe the item's condition, required for graded or ungraded trading cards and coins.
- groupIds? string[] - The unique identifiers of the inventory item groups the item belongs to. Returned only if the item is in at least one group.
- packageWeightAndSize? PackageWeightAndSize - Package type, weight and dimensions of the shipping package. Weight and dimensions are required for calculated shipping; weight alone is required for flat-rate shipping with a weight surcharge.
- availability? AvailabilityWithAll - This type is used to specify the quantity of the inventory items that are available for purchase if the items will be shipped to the buyer
- locale LocaleEnum - Locale that indicates the language used to express the inventory item details.
- 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
- conditionDescription? string - A description of a used item's condition; ignored for items in a new condition. Maximum length: 1000.
- inventoryItemGroupKeys? string[] - The unique identifiers of the item's variations in multiple-variation listings. Returned only if the item is in at least one inventory item group.
ebay.inventory: InventoryItemWithSkuLocaleGroupKeys
This type is used to provide details about each retrieved inventory item record
Fields
- condition? ConditionEnum - Condition of the inventory item. Each value maps to an eBay condition ID, and valid conditions vary by category.
- product? Product - Product details such as title, description, aspects and image links. Can include an ePID or GTIN (EAN, ISBN or UPC) to match a product in the eBay Catalog.
- conditionDescriptors? ConditionDescriptor[] - Structured name-value pairs that describe the item's condition, required for graded or ungraded trading cards and coins.
- packageWeightAndSize? PackageWeightAndSize - Package type, weight and dimensions of the shipping package. Weight and dimensions are required for calculated shipping; weight alone is required for flat-rate shipping with a weight surcharge.
- availability? AvailabilityWithAll - This type is used to specify the quantity of the inventory items that are available for purchase if the items will be shipped to the buyer
- locale LocaleEnum - Locale that indicates the language used to express the inventory item details.
- 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
- conditionDescription? string - A description of a used item's condition; ignored for items in a new condition. Maximum length: 1000.
- inventoryItemGroupKeys? string[] - The identifiers of the inventory item groups the item belongs to. Returned only if the item is in a group.
ebay.inventory: InventoryLocation
This type is used by the updateInventoryLocation call to update operating hours, special hours, phone number, and other minor details of an inventory location
Fields
- locationTypes? StoreTypeEnum[] - This container is used to update the location type(s) associated with an inventory location
- phone? string - The phone number of the inventory location; replaces any existing phone number. Maximum length: 36.
- timeZoneId? string - The time zone of the inventory location in Olson format (for example America/Vancouver). Used for all hour-related fields; if omitted, it is derived from the address.
- locationWebUrl? string - The website URL of the inventory location; replaces any existing URL. Maximum length: 512.
- name? string - A human-friendly name for the inventory location; replaces any existing name. Not required for warehouse locations.
- location? LocationDetails - This type is used by the createInventoryLocation call to provide an full or partial address of an inventory location
- fulfillmentCenterSpecifications? FulfillmentCenterSpecifications - This type is used to provide shipping specification details, such as the weekly cut-off schedule for order handling and cut-off override(s), for a fulfillment center location.
- locationAdditionalInformation? string - Additional information about the inventory location; replaces the current value, so resend it unchanged if not updating. Maximum length: 256.
ebay.inventory: InventoryLocationFull
Details of an inventory location for createInventoryLocation, including name, physical address, operating hours, special hours and phone number.
Fields
- locationTypes? StoreTypeEnum[] - This array is used to define the function of the inventory location as either a WAREHOUSE or a FULFILLMENT_CENTER. To utilize the Multi-warehouse program, use FULFILLMENT_CENTER. Default: WAREHOUSE
- phone string - This field is used to specify the phone number for an inventory location. Maximum length: 36
- timeZoneId? string - The time zone of the inventory location in Olson format (for example America/Vancouver). Used for all hour-related fields; if omitted for a fulfillment center, it is derived from the address.
- locationWebUrl? string - This text field is used by the merchant to provide the Website address (URL) associated with the inventory location. Maximum length: 512
- name? string - The seller-defined name of the inventory location. This name should be a human-friendly name. Maximum length: 1000
- merchantLocationStatus? StatusEnum - Possible states of an inventory location.
- location LocationDetails - This type is used by the createInventoryLocation call to provide an full or partial address of an inventory location
- fulfillmentCenterSpecifications? FulfillmentCenterSpecifications - This type is used to provide shipping specification details, such as the weekly cut-off schedule for order handling and cut-off override(s), for a fulfillment center location.
- locationAdditionalInformation? string - This text field is used by the merchant to provide additional information about an inventory location. Maximum length: 256
ebay.inventory: InventoryLocationResponse
This type is used by the base response of the getInventoryLocation and getInventoryLocations calls. These responses provide details about inventory location(s) defined for the merchant's account
Fields
- timeZoneId? string - The time zone of the inventory location in Olson format (for example America/Vancouver).
- locationWebUrl? string - This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the location
- locationTypes StoreTypeEnum[] - This array indicates if the inventory location is a warehouse or a fulfillment center
- merchantLocationKey string - The unique identifier of the inventory location. This identifier is set up by the merchant when the location is first created with the createInventoryLocation call
- name? string - The name of the inventory location. This name should be a human-friendly name
- merchantLocationStatus StatusEnum - Possible states of an inventory location.
- location Location - A complex type that is used to provide the physical address of a location, and it geo-coordinates
- fulfillmentCenterSpecifications? FulfillmentCenterSpecifications - This type is used to provide shipping specification details, such as the weekly cut-off schedule for order handling and cut-off override(s), for a fulfillment center location.
- locationAdditionalInformation? string - This text field provides additional information about an inventory location. This field is returned if it is set for the location
ebay.inventory: ListingDetails
eBay listing ID, listing status and quantity sold for an offer. Returned only for published offers.
Fields
- listingStatus? ListingStatusEnum - Status of the eBay listing associated with an offer.
- listingOnHold? boolean - Whether the listing is on hold due to a policy violation. Returned as true while the listing is fixable and no longer returned once it is fixed.
- listingId? string - The unique identifier of the eBay listing that is associated with the published offer.
- soldQuantity? Signed32 - This integer value indicates the quantity of the product that has been sold for the published offer
ebay.inventory: ListingPolicies
Business policies (payment, return and fulfillment) and custom policies for the listing. Every published offer needs payment, return and fulfillment policies; also holds shipping cost overrides, eBay Plus and Best Offer settings.
Fields
- regionalTakeBackPolicies? RegionalTakeBackPolicies - This type lists regional take-back policies to be used by an offer when it is published and converted to a listing
- takeBackPolicyId? string - The ID of the seller's global take-back policy to apply to the listing. Only one per offer.
- regionalProductCompliancePolicies? RegionalProductCompliancePolicies - This type lists regional product compliance policies to be used by an offer when it is published and converted to a listing
- eBayPlusIfEligible? boolean - Set to true if a Top-Rated seller is opted in to the eBay Plus program (next-day delivery and free returns). Returned if set for the offer.
- returnPolicyId? string - The ID of the return business policy that sets the return settings for the listing. Required before the offer can be published; returned if set.
- bestOfferTerms? BestOffer - This type is used by the bestOfferTerms container, which is used if the seller would like to support the Best Offer feature on their listing
- shippingCostOverrides? ShippingCostOverride[] - Overrides the shipping costs or surcharge of shipping service options in the fulfillment policy, one entry per option. Returned if any overrides are applied.
- fulfillmentPolicyId? string - The ID of the fulfillment business policy that sets the fulfillment settings for the listing. Required before the offer can be published; returned if set.
- paymentPolicyId? string - The ID of the payment business policy that sets the payment settings for the listing. Required before the offer can be published; returned if set.
- productCompliancePolicyIds? string[] - The IDs of the seller's global product compliance policies to apply to the listing. Maximum of six per offer.
ebay.inventory: Location
A complex type that is used to provide the physical address of a location, and it geo-coordinates
Fields
- address Address - This type is used to define the physical address of an inventory location
- locationId string - The eBay-assigned ID of the location, used only internally by eBay. Not the same as the seller-defined merchantLocationKey.
- geoCoordinates? GeoCoordinates - This type is used to express the Global Positioning System (GPS) latitude and longitude coordinates of an inventory location
ebay.inventory: LocationAvailabilityDetails
This type provides the unique identifier of an inventory location that is associated with a SKU within a listing
Fields
- merchantLocationKey string - The seller-defined key of the fulfillment center location where inventory is available. For location mappings, it must be a FULFILLMENT_CENTER location.
ebay.inventory: LocationDetails
This type is used by the createInventoryLocation call to provide an full or partial address of an inventory location
Fields
- address Address - This type is used to define the physical address of an inventory location
- geoCoordinates? GeoCoordinates - This type is used to express the Global Positioning System (GPS) latitude and longitude coordinates of an inventory location
ebay.inventory: LocationMapping
This type provides an array of locations that are associated with a SKU within a listing
Fields
- locations LocationAvailabilityDetails[] - The fulfillment center locations mapped to the SKU. Only the first 50 locations are used to calculate estimated delivery dates.
ebay.inventory: LocationResponse
This type is used by the base response payload for the getInventoryLocations call
Fields
- next? string - The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Maximum length: 2048
- total? Signed32 - The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0
- offset? Signed32 - The number of results skipped before the first returned result, as set by the offset query parameter. The list is zero-based.
- prev? string - The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Maximum length: 2048
- 'limit? Signed32 - The number of items returned on a single page from the result set
- locations? InventoryLocationResponse[] - An array of one or more of the merchant's inventory locations
- href? string - The URI of the current page of results from the result set
ebay.inventory: Manufacturer
This type provides name and contact information about the manufacturer of the item
Fields
- country? CountryCodeEnum - Two-letter ISO 3166-1 Alpha-2 country codes.
- stateOrProvince? string - The state or province of the product manufacturer's street address. Maximum length: 64 characters
- city? string - The city of the product manufacturer's street address. Maximum length: 64 characters
- phone? string - The product manufacturer's business phone number. Maximum length: 64 characters
- companyName? string - The company name of the product manufacturer. Maximum length: 100 characters
- postalCode? string - The postal code of the product manufacturer's street address. Maximum length: 9 characters
- addressLine1? string - The first line of the product manufacturer's street address. Maximum length: 180 characters
- contactUrl? string - The contact URL of the product manufacturer. Maximum length: 250 characters
- addressLine2? string - The second line of the manufacturer's street address, such as a suite or apartment number. Maximum length: 180 characters.
- email? string - The product manufacturer's business email address. Maximum length: 180 characters
ebay.inventory: MigrateListing
This type is used to specify one to five eBay listings that will be migrated to the new Inventory model
Fields
- listingId string - The unique identifier of the eBay listing to migrate to the Inventory model. Up to five listings can be specified.
ebay.inventory: MigrateListingResponse
This type is used to display the results of each listing that the seller attempted to migrate
Fields
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- inventoryItems InventoryItemListing[] - The SKU values and offer IDs of the migrated listing: one pair for a single-variation listing, several for a multiple-variation listing.
- warnings? ErrorDetailV3[] - Details of any warnings raised while migrating the listing. A listing can still migrate successfully with warnings.
- inventoryItemGroupKey? string - The eBay-generated key of the inventory item group created for a migrated multiple-variation listing. Returned only for multiple-variation listings.
- listingId string - The unique identifier of the eBay listing that the seller attempted to migrate
- errors? ErrorDetailV3[] - If one or more errors occur with the attempt to migrate the listing, this container will be returned with detailed information on each error
- statusCode Signed32 - This field is returned for each listing that the seller attempted to migrate. See the HTTP status codes table to see which each status code indicates
ebay.inventory: NameValueList
This type is used by the compatibilityProperties container to identify a motor vehicle using name/value pairs
Fields
- name? string - The motor vehicle aspect name, such as make, model, year, trim or engine. Make, model and year are typically required.
- value? string - The value of the motor vehicle aspect named in the name field, for example Toyota for make.
ebay.inventory: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://api.ebay.com/identity/v1/oauth2/token") - Refresh URL
ebay.inventory: OfferKeysWithId
This type is used by the base request payload of the getListingFees call
Fields
- offers OfferKeyWithId[] - The unpublished offers (up to 250) to retrieve expected listing fees for. Fees are returned per marketplace, not per offer.
ebay.inventory: OfferKeyWithId
Unpublished offer for which getListingFees retrieves expected listing fees. Up to 250 offerId values can be passed.
Fields
- offerId string - The ID of an unpublished offer to retrieve expected listing fees for. Up to 250 per request; published offers cause errors.
ebay.inventory: OfferPriceQuantity
This type is used by the offers container in a Bulk Update Price and Quantity call to update the current price and/or quantity of one or more offers associated with a specific inventory item
Fields
- availableQuantity? Signed32 - The quantity of the item available in the offer's marketplace; should not exceed the total ship-to-home quantity. Either this or price is required.
- price? Amount - This type is used to express a dollar value and the applicable currency
- offerId? string - The unique identifier of the offer to update with a new price and/or quantity. Required when updating offers.
ebay.inventory: OfferResponse
Response of the createOffer and updateOffer calls with any errors or warnings. The offerId is returned only by a successful createOffer call.
Fields
- warnings? ErrorDetailV3[] - This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur
- offerId? string - The unique identifier of the offer created by createOffer. Returned only on success and not returned by updateOffer.
ebay.inventory: OfferResponseWithListingId
Publish status of an offer. Returns the eBay listing ID on success, or errors and/or warnings explaining why publishing failed.
Fields
- warnings? ErrorDetailV3[] - This container will be returned if there were one or more warnings associated with publishing the offer
- offerId string - The unique identifier of the offer that the seller published (or attempted to publish)
- listingId? string - The unique identifier of the newly-created eBay listing. This field is only returned if the seller successfully published the offer and created the new eBay listing
- errors? ErrorDetailV3[] - This container will be returned if there were one or more errors associated with publishing the offer
- statusCode Signed32 - The HTTP status code indicating whether publishing the offer succeeded or failed.
ebay.inventory: Offers
This type is used by the base response of the getOffers call, and it is an array of one or more of the seller's offers, along with pagination data
Fields
- next? string - This is the URL to the next page of offers. This field will only be returned if there are additional offers to view
- offers EbayOfferDetailsWithAll[] - The seller's offers for the SKU passed in the sku query parameter. Maximum of 25.
- total Signed32 - The total number of offers for the SKU, used with the limit value to page through results.
- size Signed32 - The number of offers on the current page of results.
- prev? string - This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view
- 'limit Signed32 - This integer value is the number of offers that will be displayed on each results page
- href string - This is the URL to the current page of offers
ebay.inventory: OfferSkuResponse
Status of each offer the seller attempted to create with bulkCreateOffer. A successful offer has statusCode 200 and a new offerId; otherwise errors and/or warnings are returned.
Fields
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- warnings? ErrorDetailV3[] - Warnings raised while creating the offer. An offer can still be created successfully with warnings.
- format FormatTypeEnum - Listing format of the offer. Creating an auction offer reserves one unit of the item's available quantity until the auction ends.
- offerId? string - The unique identifier of the newly created offer. Not returned if the offer could not be created.
- sku string - The seller-defined SKU of the inventory item. Required for each offer and always returned.
- errors? ErrorDetailV3[] - This container will be returned at the offer level, and will contain one or more errors if any occurred with the attempted creation of the corresponding offer
- statusCode Signed32 - The HTTP status code of the offer creation attempt; 200 indicates success.
ebay.inventory: Overrides
This type defines the override dates for cut-off times. This allows sellers to set special hours for their inventory location and specify different cut-off times on these days
Fields
- endDate? string - The end date of the cut-off time override in ISO 8601 format (YYYY-MM-DD). Use the same date as startDate for a single day.
- startDate? string - The start date of the cut-off time override in ISO 8601 format (YYYY-MM-DD). Use the same date as endDate for a single day.
- cutOffTime? string - The cut-off time that overrides the weekly schedule for the date range; orders after it are handled the next day. Format: 00:00.
ebay.inventory: PackageWeightAndSize
Package type, weight and dimensions of the shipping package. Weight and dimensions are required for calculated shipping; weight alone is required for flat-rate shipping with a weight surcharge.
Fields
- shippingIrregular? boolean - Whether the package is irregular and needs special or fragile handling. Applies to calculated shipping only.
- weight? Weight - Weight of a shipping package and its unit of measure. Conditionally required for calculated shipping rates or flat-rate shipping with a weight surcharge.
- packageType? PackageTypeEnum - Type of shipping package used to ship an inventory item.
- dimensions? Dimension - Dimensions of a shipping package and their unit of measure. Conditionally required when the seller offers calculated shipping rates.
ebay.inventory: PriceQuantity
Updates the total ship-to-home quantity of inventory items and/or the price and quantity of specific offers associated with them.
Fields
- offers? OfferPriceQuantity[] - The published offers whose price and/or quantity to update, one entry per offer. Not for unpublished offers.
- shipToLocationAvailability? ShipToLocationAvailability - This type is used to specify the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers
- sku string - The seller-defined SKU of the inventory item whose total ship-to-home quantity is updated. Required only when using shipToLocationAvailability. Maximum length: 50.
ebay.inventory: PriceQuantityResponse
Result for each offer or inventory item updated with bulkUpdatePriceQuantity, including any errors or warnings at that level.
Fields
- warnings? ErrorDetailV3[] - This array will be returned if there were one or more warnings associated with the update to the offer or inventory item record
- offerId? string - The unique identifier of the offer that was updated. This field will not be returned in situations where the seller is only updating the total 'ship-to-home' quantity of an inventory item record
- sku string - The seller-defined SKU of the product. Always returned. Maximum length: 50.
- errors? ErrorDetailV3[] - This array will be returned if there were one or more errors associated with the update to the offer or inventory item record
- statusCode Signed32 - The HTTP status code of the price and/or quantity update attempt; 200 indicates success.
ebay.inventory: PricingSummary
Listing price and Minimum Advertised Price and Strikethrough Pricing settings. Price is required before an offer is published, but can be omitted when the offer is created.
Fields
- pricingVisibility? MinimumAdvertisedPriceHandlingEnum - Controls how and when the Minimum Advertised Price is shown for an offer. Available only on the US site.
- auctionReservePrice? Amount - This type is used to express a dollar value and the applicable currency
- price? Amount - This type is used to express a dollar value and the applicable currency
- minimumAdvertisedPrice? Amount - This type is used to express a dollar value and the applicable currency
- auctionStartPrice? Amount - This type is used to express a dollar value and the applicable currency
- originallySoldForRetailPriceOn? SoldOnEnum - Where the product was sold for the originalRetailPrice: on eBay, off eBay, or both. Applies only to listings eligible for Strikethrough Pricing.
- originalRetailPrice? Amount - This type is used to express a dollar value and the applicable currency
ebay.inventory: Product
Product details such as title, description, aspects and image links. Can include an ePID or GTIN (EAN, ISBN or UPC) to match a product in the eBay Catalog.
Fields
- ean? string[] - The European Article Number (EAN) of the product, used to find a match in the eBay Catalog. Returned if defined.
- imageUrls? string[] - HTTPS URLs of the product images. At least one is required before an offer can be published; up to 24 per listing, or 12 per item in a group.
- isbn? string[] - The International Standard Book Number (ISBN) of the product, used to find a match in the eBay Catalog. Returned if defined.
- subtitle? string - An optional subtitle with extra product information; an additional listing fee applies. Returned only if set. Maximum length: 55.
- aspects? record { string[]... } - Item specifics (product aspects) as name-value pairs describing the product. Required before an offer can be published. Maximum lengths: name 40, value 50.
- description string - The description of the product; supports basic HTML but no active content. Required before an offer can be published. Returned if defined. Maximum length: 4000.
- epid? string - The eBay Product Identifier (ePID), the preferred way to match a product in the eBay Catalog and auto-populate product details. Returned if defined.
- upc? string[] - The Universal Product Code (UPC) of the product, used to find a match in the eBay Catalog. Returned if defined.
- mpn? string - The Manufacturer Part Number (MPN) of the product, paired with brand. Required by some categories. Returned if defined. Maximum length: 65.
- title string - The title of the inventory item. Required before an offer can be published; for a group, it becomes the variation title. Maximum length: 80.
- brand? string - The brand of the product, often paired with mpn. Conditionally required if the category requires an MPN. Returned if defined. Maximum length: 65.
- videoIds? string[] - The eBay-generated IDs of videos uploaded for the product. Only one video per listing is supported.
ebay.inventory: ProductFamilyProperties
This type is used to specify the details of a motor vehicle that is compatible with the inventory item specified through the SKU value in the call URI
Fields
- trim? string - Important! The productFamilyProperties container is no longer supported.
- engine? string - Important! The productFamilyProperties container is no longer supported.
- year? string - Important! The productFamilyProperties container is no longer supported.
- model? string - Important! The productFamilyProperties container is no longer supported.
- make? string - Important! The productFamilyProperties container is no longer supported.
ebay.inventory: ProductIdentifier
Identifies a motor vehicle compatible with the inventory item, by eBay Product ID or K-Type value. The gtin field is for future use only.
Fields
- gtin? string - The Global Trade Item Number of the compatible motor vehicle. Reserved for future use.
- epid? string - The eBay catalog product ID (ePID) of the compatible motor vehicle; if found, its properties are filled in automatically.
- ktype? string - The K Type Number of the compatible motor vehicle; if found, its properties are filled in automatically. Supported only on the AU, DE, ES, FR, IT and UK marketplaces.
ebay.inventory: ProductSafety
This type is used to define the pictograms and statement containers, and the optional component field, that provide product safety and compliance related information
Fields
- component? string - Product safety component information, such as a specific warning. Requires pictograms and/or statements. Maximum length: 120 characters.
- pictograms? string[] - The identifiers of product safety pictograms to display on the listing. Maximum of 2.
- statements? string[] - The identifiers of product safety statements to display on the listing. Maximum of 8.
ebay.inventory: PublishByInventoryItemGroupRequest
Request payload of publishByInventoryItemGroup, giving the inventory item group to publish and the eBay marketplace to publish it on.
Fields
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- inventoryItemGroupKey string - The eBay-generated key of the inventory item group whose unpublished offers are published as a multiple-variation listing.
ebay.inventory: PublishOfferByInventoryItemGroupHeaders
Represents the Headers record for the operation: publishOfferByInventoryItemGroup
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: PublishResponse
This type is used by the base response payload of the publishOffer and publishOfferByInventoryItemGroup calls
Fields
- warnings? ErrorDetailV3[] - This container will contain an array of errors and/or warnings if any occur when a publishOffer or publishOfferByInventoryItemGroup call is made
- listingId? string - The unique identifier of the newly created eBay listing. Returned if the offer or group of offers was successfully published.
ebay.inventory: RegionalProductCompliancePolicies
This type lists regional product compliance policies to be used by an offer when it is published and converted to a listing
Fields
- countryPolicies? CountryPolicy[] - The array of country-specific product compliance policies to be used by an offer when it is published and converted to a listing
ebay.inventory: RegionalTakeBackPolicies
This type lists regional take-back policies to be used by an offer when it is published and converted to a listing
Fields
- countryPolicies? CountryPolicy[] - The array of country-specific take-back policies to be used by an offer when it is published and converted to a listing
ebay.inventory: Regulatory
Type defining regulatory information that the seller is required to disclose
Fields
- energyEfficiencyLabel? EnergyEfficiencyLabel - Energy efficiency information for certain durable goods. The energy efficiency rating and range must be specified through the inventory item's aspects field.
- documents? Document[] - Regulatory documents associated with the listing. Conditionally required for sellers in or shipping to the EU or Northern Ireland.
- responsiblePersons? ResponsiblePerson[] - The EU-based Responsible Persons or entities for the listing. Maximum of 5; conditionally required for sellers in or shipping to the EU or Northern Ireland.
- hazmat? Hazmat - Hazardous material information for the listing. The statements field is required; pictograms, signalWord and component are optional.
- productSafety? ProductSafety - This type is used to define the pictograms and statement containers, and the optional component field, that provide product safety and compliance related information
- manufacturer? Manufacturer - This type provides name and contact information about the manufacturer of the item
- repairScore? decimal - The manufacturer's repair score, from 0.0 (difficult to repair) to 10.0 (easily repaired), with at most one decimal place. Not applicable to all categories.
ebay.inventory: ResponsiblePerson
This type provides information, such as name and contact details, for an EU-based Responsible Person or entity, associated with the product
Fields
- country? CountryCodeEnum - Two-letter ISO 3166-1 Alpha-2 country codes.
- types? ResponsiblePersonTypeEnum[] - The type(s) associated with the Responsible Person or entity. Note: Currently, the only supported value is EUResponsiblePerson.
- stateOrProvince? string - The state of province of the Responsible Person's street address. Maximum length: 64 characters
- city? string - The city of the Responsible Person's street address. Maximum length: 64 characters
- phone? string - The Responsible Person's business phone number. Maximum length: 64 characters
- companyName? string - The name of the Responsible Person or entity. Maximum length: 100 characters
- postalCode? string - The postal code of the Responsible Person's street address. Maximum length: 9 characters
- addressLine1? string - The first line of the Responsible Person's street address. Maximum length: 180 characters
- contactUrl? string - The contact URL of the Responsible Person or entity. Maximum length: 250 characters
- addressLine2? string - The second line of the Responsible Person's address, such as a suite or apartment number. Maximum length: 180 characters.
- email? string - The Responsible Person's email address. Maximum length: 180 characters
ebay.inventory: SameDayShippingCutOffTimes
This type is used by the createInventoryLocation call to specify cut-off time(s) for an inventory location, as well as any overrides for these times
Fields
- weeklySchedule? WeeklySchedule[] - The weekly schedule of shipping cut-off times, required for each business day; orders after the cut-off are handled the next day.
- overrides? Overrides[] - This container can be used to override the existing cut-off time(s), specified in the weeklySchedule container, for a specific date or date range
ebay.inventory: ShippingCostOverride
Overrides the shipping cost for one item, each additional item, or the surcharge of a domestic or international shipping service option in the fulfillment policy applied to the offer.
Fields
- surcharge? Amount - This type is used to express a dollar value and the applicable currency
- shippingServiceType? ShippingServiceTypeEnum - Whether the shipping service option whose costs are overridden is domestic or international.
- shippingCost? Amount - This type is used to express a dollar value and the applicable currency
- additionalShippingCost? Amount - This type is used to express a dollar value and the applicable currency
- priority? Signed32 - The sort order of the shipping service option in the fulfillment policy whose costs are overridden. Required for each override and always returned.
ebay.inventory: ShipToLocationAvailability
This type is used to specify the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers
Fields
- quantity? Signed32 - The total ship-to-home quantity available across all marketplaces. Must be set before an offer can be published; resend it on updates or it is lost.
- availabilityDistributions? AvailabilityDistribution[] - The available quantity of the inventory item at one or more warehouse locations. Returned if set.
ebay.inventory: ShipToLocationAvailabilityWithAll
This type is used to specify the total 'ship-to-home' quantity of the inventory items that will be available for purchase through one or more published offers
Fields
- quantity? Signed32 - The total ship-to-home quantity available for purchase. Must be set before publishing; omitting it or 0 makes the listing out of stock. Resend it on updates or it is lost.
- availabilityDistributions? AvailabilityDistribution[] - The available quantity of the inventory item at one or more warehouse locations. Returned if set.
- allocationByFormat? FormatAllocation - This type is used to indicate the quantities of the inventory items that are reserved for the different listing formats of the SKU offers
ebay.inventory: Specification
Product aspect on which variations within an inventory item group vary, such as size or color, and the order its values appear in the listing.
Fields
- values? string[] - The values of the product variation aspect named in the name field. At least one value is required. Maximum length: 50.
- name? string - The name of the product variation aspect, such as Size or Color. Required before an offer can be published. Maximum length: 40.
ebay.inventory: Tax
Enables a sales-tax table, sets a tax exception category code, or specifies a VAT percentage. Sales-tax tables are available only for the US and Canada marketplaces.
Fields
- vatPercentage? decimal - The VAT rate for the item, up to 6 characters with 3 decimal places (for example 12.345). Only for business sellers with a registered VAT-ID. Returned if set.
- applyTax? boolean - Whether the seller's account-level sales-tax table is used to calculate sales tax. Must be true when thirdPartyTaxCategory is used. Returned if set.
- thirdPartyTaxCategory? string - The tax exception category code, which applies sales tax to a service or fee as well as the item price. Requires applyTax set to true. Returned if set.
ebay.inventory: TimeDuration
This type is used to indicate the fulfillment time for an order that will be shipped to the buyer
Fields
- unit? TimeDurationUnitEnum - Time unit used by the TimeDuration type, typically BUSINESS_DAY for order fulfillment time.
- value? Signed32 - The fulfillment time, in the unit given by the unit field.
ebay.inventory: UpdateInventoryLocationHeaders
Represents the Headers record for the operation: updateInventoryLocation
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: UpdateOfferHeaders
Represents the Headers record for the operation: updateOffer
Fields
- contentLanguage string - This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: VariesBy
This type is used to specify the product aspect(s) where individual items of the group vary, as well as a list of the available variations of those aspects
Fields
- aspectsImageVariesBy? string[] - The product aspect, such as Color, whose variations are shown with different images. Only the first aspect is used. Required before an offer can be published.
- specifications? Specification[] - The product aspects that vary across the group and their values. Required before the first offer of the group is published; returned if set or once published.
ebay.inventory: WeeklySchedule
This type describes the weekly schedule for cut-off times
Fields
- dayOfWeekEnum? DayOfWeekEnum[] - This comma-separated array defines the days of week for which the specified cutOffTime is used
- cutOffTime? string - The cut-off time in 24-hour format for the specified days; defaults to the address time zone if timeZoneId is not set. Days without one are holidays. Format: 00:00.
ebay.inventory: Weight
Weight of a shipping package and its unit of measure. Conditionally required for calculated shipping rates or flat-rate shipping with a weight surcharge.
Fields
- unit? WeightUnitOfMeasureEnum - Unit of measure for the weight of a shipping package.
- value? decimal - The weight of the shipping package in the unit given by the unit field. Both unit and value are required.
ebay.inventory: WithdrawByInventoryItemGroupRequest
This type is used by the base request of the WithdrawByInventoryItemGroup method, which is used to end a multiple-variation listing
Fields
- marketplaceId MarketplaceEnum - eBay marketplace sites.
- inventoryItemGroupKey string - The eBay-generated unique identifier of the inventory item group.
ebay.inventory: WithdrawOfferByInventoryItemGroupHeaders
Represents the Headers record for the operation: withdrawOfferByInventoryItemGroup
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json
ebay.inventory: WithdrawResponse
The base response of the withdrawOffer call
Fields
- warnings? ErrorDetailV3[] - This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer
- listingId? string - The unique identifier of the eBay listing associated with the offer that was withdrawn. This field will not be returned if the eBay listing was not successfully ended
Union types
ebay.inventory: ListingDurationEnum
ListingDurationEnum
Listing duration periods. GTC applies to fixed-price listings and is their only supported duration; the DAYS_n values apply to auction listings.
ebay.inventory: ShippingServiceTypeEnum
ShippingServiceTypeEnum
Whether the shipping service option whose costs are overridden is domestic or international.
ebay.inventory: TimeDurationUnitEnum
TimeDurationUnitEnum
Time unit used by the TimeDuration type, typically BUSINESS_DAY for order fulfillment time.
ebay.inventory: MarketplaceEnum
MarketplaceEnum
eBay marketplace sites.
ebay.inventory: LengthUnitOfMeasureEnum
LengthUnitOfMeasureEnum
Unit of measure for the dimensions of a shipping package.
ebay.inventory: MinimumAdvertisedPriceHandlingEnum
MinimumAdvertisedPriceHandlingEnum
Controls how and when the Minimum Advertised Price is shown for an offer. Available only on the US site.
ebay.inventory: LocaleEnum
LocaleEnum
Locale that indicates the language used to express the inventory item details.
ebay.inventory: StoreTypeEnum
StoreTypeEnum
Inventory location types. STORE is deprecated and no longer supported.
ebay.inventory: ListingStatusEnum
ListingStatusEnum
Status of the eBay listing associated with an offer.
ebay.inventory: DayOfWeekEnum
DayOfWeekEnum
Days of the week, used by the weeklySchedule container to specify fulfillment center cut-off times.
ebay.inventory: WeightUnitOfMeasureEnum
WeightUnitOfMeasureEnum
Unit of measure for the weight of a shipping package.
ebay.inventory: PackageTypeEnum
PackageTypeEnum
Type of shipping package used to ship an inventory item.
ebay.inventory: StatusEnum
StatusEnum
Possible states of an inventory location.
ebay.inventory: OfferStatusEnum
OfferStatusEnum
Current status of the offer, published or unpublished.
ebay.inventory: CountryCodeEnum
CountryCodeEnum
Two-letter ISO 3166-1 Alpha-2 country codes.
ebay.inventory: FormatTypeEnum
FormatTypeEnum
Listing format of the offer. Creating an auction offer reserves one unit of the item's available quantity until the auction ends.
ebay.inventory: SoldOnEnum
SoldOnEnum
Where the product was sold for the originalRetailPrice: on eBay, off eBay, or both. Applies only to listings eligible for Strikethrough Pricing.
ebay.inventory: ConditionEnum
ConditionEnum
Condition of the inventory item. Each value maps to an eBay condition ID, and valid conditions vary by category.
Import
import ballerinax/ebay.inventory;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 51
Current verison: 1
Weekly downloads
Keywords
Vendor/eBay
Area/E-Commerce
Type/Connector
Contributors