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.
PHP 7.2 and later.
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/trollandtoad/ebay-sell-inventory.git"
}
],
"require": {
"trollandtoad/ebay-sell-inventory": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: api_auth
$config = eBay\Sell\Inventory\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new eBay\Sell\Inventory\Api\InventoryItemApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$content_type = 'content_type_example'; // string | This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"_blank \">HTTP request headers</a>.
$content_language = 'content_language_example'; // 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 <code>en-US</code> for English or <code>de-DE</code> for German. For more information on the Content-Language header, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"_blank \">HTTP request headers</a>.
$bulk_inventory_item = new \eBay\Sell\Inventory\Model\BulkInventoryItem(); // \eBay\Sell\Inventory\Model\BulkInventoryItem | Details of the inventories with sku and locale
try {
$result = $apiInstance->bulkCreateOrReplaceInventoryItem($content_type, $content_language, $bulk_inventory_item);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InventoryItemApi->bulkCreateOrReplaceInventoryItem: ', $e->getMessage(), PHP_EOL;
}
All URIs are relative to https://api.ebay.com/sell/inventory/v1
Class | Method | HTTP request | Description |
---|---|---|---|
InventoryItemApi | bulkCreateOrReplaceInventoryItem | POST /bulk_create_or_replace_inventory_item | |
InventoryItemApi | bulkGetInventoryItem | POST /bulk_get_inventory_item | |
InventoryItemApi | bulkUpdatePriceQuantity | POST /bulk_update_price_quantity | |
InventoryItemApi | createOrReplaceInventoryItem | PUT /inventory_item/{sku} | |
InventoryItemApi | deleteInventoryItem | DELETE /inventory_item/{sku} | |
InventoryItemApi | getInventoryItem | GET /inventory_item/{sku} | |
InventoryItemApi | getInventoryItems | GET /inventory_item | |
InventoryItemGroupApi | createOrReplaceInventoryItemGroup | PUT /inventory_item_group/{inventoryItemGroupKey} | |
InventoryItemGroupApi | deleteInventoryItemGroup | DELETE /inventory_item_group/{inventoryItemGroupKey} | |
InventoryItemGroupApi | getInventoryItemGroup | GET /inventory_item_group/{inventoryItemGroupKey} | |
ListingApi | bulkMigrateListing | POST /bulk_migrate_listing | |
LocationApi | createInventoryLocation | POST /location/{merchantLocationKey} | |
LocationApi | deleteInventoryLocation | DELETE /location/{merchantLocationKey} | |
LocationApi | disableInventoryLocation | POST /location/{merchantLocationKey}/disable | |
LocationApi | enableInventoryLocation | POST /location/{merchantLocationKey}/enable | |
LocationApi | getInventoryLocation | GET /location/{merchantLocationKey} | |
LocationApi | getInventoryLocations | GET /location | |
LocationApi | updateInventoryLocation | POST /location/{merchantLocationKey}/update_location_details | |
OfferApi | bulkCreateOffer | POST /bulk_create_offer | |
OfferApi | bulkPublishOffer | POST /bulk_publish_offer | |
OfferApi | createOffer | POST /offer | |
OfferApi | deleteOffer | DELETE /offer/{offerId} | |
OfferApi | getListingFees | POST /offer/get_listing_fees | |
OfferApi | getOffer | GET /offer/{offerId} | |
OfferApi | getOffers | GET /offer | |
OfferApi | publishOffer | POST /offer/{offerId}/publish/ | |
OfferApi | publishOfferByInventoryItemGroup | POST /offer/publish_by_inventory_item_group/ | |
OfferApi | updateOffer | PUT /offer/{offerId} | |
OfferApi | withdrawOffer | POST /offer/{offerId}/withdraw | |
OfferApi | withdrawOfferByInventoryItemGroup | POST /offer/withdraw_by_inventory_item_group | |
ProductCompatibilityApi | createOrReplaceProductCompatibility | PUT /inventory_item/{sku}/product_compatibility | |
ProductCompatibilityApi | deleteProductCompatibility | DELETE /inventory_item/{sku}/product_compatibility | |
ProductCompatibilityApi | getProductCompatibility | GET /inventory_item/{sku}/product_compatibility |
- Address
- Amount
- Availability
- AvailabilityDistribution
- AvailabilityWithAll
- BaseResponse
- BestOffer
- BulkEbayOfferDetailsWithKeys
- BulkGetInventoryItem
- BulkGetInventoryItemResponse
- BulkInventoryItem
- BulkInventoryItemResponse
- BulkMigrateListing
- BulkMigrateListingResponse
- BulkOffer
- BulkOfferResponse
- BulkPriceQuantity
- BulkPriceQuantityResponse
- BulkPublishResponse
- Charity
- Compatibility
- CompatibleProduct
- ConditionDescriptor
- CountryPolicy
- Dimension
- EbayOfferDetailsWithAll
- EbayOfferDetailsWithId
- EbayOfferDetailsWithKeys
- EnergyEfficiencyLabel
- Error
- ErrorParameter
- ExtendedProducerResponsibility
- Fee
- FeeSummary
- FeesSummaryResponse
- FormatAllocation
- GeoCoordinates
- GetInventoryItem
- GetInventoryItemResponse
- Hazmat
- Interval
- InventoryItem
- InventoryItemGroup
- InventoryItemListing
- InventoryItemResponse
- InventoryItemWithSkuLocale
- InventoryItemWithSkuLocaleGroupKeys
- InventoryItemWithSkuLocaleGroupid
- InventoryItems
- InventoryLocation
- InventoryLocationFull
- InventoryLocationResponse
- ListingDetails
- ListingPolicies
- Location
- LocationDetails
- LocationResponse
- MigrateListing
- MigrateListingResponse
- NameValueList
- OfferKeyWithId
- OfferKeysWithId
- OfferPriceQuantity
- OfferResponse
- OfferResponseWithListingId
- OfferSkuResponse
- Offers
- OperatingHours
- PackageWeightAndSize
- PickupAtLocationAvailability
- PriceQuantity
- PriceQuantityResponse
- PricingSummary
- Product
- ProductFamilyProperties
- ProductIdentifier
- PublishByInventoryItemGroupRequest
- PublishResponse
- RegionalProductCompliancePolicies
- RegionalTakeBackPolicies
- Regulatory
- ShipToLocationAvailability
- ShipToLocationAvailabilityWithAll
- ShippingCostOverride
- SpecialHours
- Specification
- Tax
- TimeDuration
- VariesBy
- Version
- Weight
- WithdrawByInventoryItemGroupRequest
- WithdrawResponse
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
https://auth.ebay.com/oauth2/authorize
- Scopes:
- https://api.ebay.com/oauth/api_scope/sell.inventory: View and manage your inventory and offers
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly: View your inventory and offers
To run the tests, use:
composer install
vendor/bin/phpunit
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.17.2
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen