From 862d38fd12f419162b1882dab68a6e8f6ed042da Mon Sep 17 00:00:00 2001 From: Brandon Clothier Date: Sun, 11 Dec 2022 21:27:21 -0500 Subject: [PATCH 1/2] feature/update-specs: Update API specs --- api-specs/buy_browse_v1_oas3.yaml | 20 +- api-specs/buy_feed_v1_beta_oas3.yaml | 16 +- api-specs/buy_feed_v1_oas3.yaml | 2 +- api-specs/buy_order_v2_oas3.yaml | 3002 +++-- api-specs/commerce_catalog_v1_beta_oas3.yaml | 1018 +- api-specs/commerce_charity_v1_oas3.yaml | 574 +- api-specs/commerce_identity_v1_oas3.yaml | 2 +- .../developer_analytics_v1_beta_oas3.yaml | 284 +- ...developer_client_registration_v1_oas3.yaml | 176 + .../developer_key_management_v1_oas3.yaml | 254 + api-specs/sell_account_v1_oas3.yaml | 7186 ++++++---- api-specs/sell_feed_v1_oas3.yaml | 29 +- api-specs/sell_finances_v1_oas3.yaml | 86 +- api-specs/sell_fulfillment_v1_oas3.yaml | 5170 +++++--- api-specs/sell_inventory_v1_oas3.yaml | 10956 ++++++---------- api-specs/sell_marketing_v1_oas3.yaml | 156 +- composer.json | 4 +- generate.sh | 2 +- src/Buy/Browse/V1/Api/ItemApi.php | 2 +- src/Buy/Browse/V1/Api/ItemSummaryApi.php | 12 +- src/Buy/Browse/V1/Api/SearchByImageApi.php | 2 +- src/Buy/Browse/V1/Api/ShoppingCartApi.php | 2 +- src/Buy/Browse/V1/ApiException.php | 2 +- src/Buy/Browse/V1/Configuration.php | 6 +- src/Buy/Browse/V1/HeaderSelector.php | 2 +- src/Buy/Browse/V1/Model/AddCartItemInput.php | 2 +- .../V1/Model/AdditionalProductIdentity.php | 2 +- src/Buy/Browse/V1/Model/AddonService.php | 2 +- src/Buy/Browse/V1/Model/Address.php | 2 +- src/Buy/Browse/V1/Model/Amount.php | 2 +- src/Buy/Browse/V1/Model/Aspect.php | 2 +- .../Browse/V1/Model/AspectDistribution.php | 2 +- src/Buy/Browse/V1/Model/AspectGroup.php | 2 +- .../V1/Model/AspectValueDistribution.php | 2 +- .../Browse/V1/Model/AttributeNameValue.php | 2 +- .../V1/Model/AuthenticityGuaranteeProgram.php | 2 +- .../Model/AuthenticityVerificationProgram.php | 2 +- src/Buy/Browse/V1/Model/AutoCorrections.php | 2 +- src/Buy/Browse/V1/Model/AvailableCoupon.php | 2 +- .../V1/Model/BuyingOptionDistribution.php | 2 +- src/Buy/Browse/V1/Model/CartItem.php | 2 +- src/Buy/Browse/V1/Model/Category.php | 36 +- .../Browse/V1/Model/CategoryDistribution.php | 2 +- .../Browse/V1/Model/CommonDescriptions.php | 2 +- .../Browse/V1/Model/CompatibilityPayload.php | 2 +- .../Browse/V1/Model/CompatibilityProperty.php | 2 +- .../Browse/V1/Model/CompatibilityResponse.php | 2 +- .../Browse/V1/Model/ConditionDistribution.php | 2 +- src/Buy/Browse/V1/Model/ConvertedAmount.php | 2 +- src/Buy/Browse/V1/Model/CoreItem.php | 2 +- src/Buy/Browse/V1/Model/CouponConstraint.php | 2 +- src/Buy/Browse/V1/Model/Error.php | 2 +- src/Buy/Browse/V1/Model/ErrorParameter.php | 2 +- .../Browse/V1/Model/EstimatedAvailability.php | 2 +- src/Buy/Browse/V1/Model/Image.php | 2 +- src/Buy/Browse/V1/Model/Item.php | 2 +- src/Buy/Browse/V1/Model/ItemGroup.php | 2 +- src/Buy/Browse/V1/Model/ItemGroupSummary.php | 2 +- src/Buy/Browse/V1/Model/ItemLocationImpl.php | 2 +- src/Buy/Browse/V1/Model/ItemReturnTerms.php | 2 +- src/Buy/Browse/V1/Model/ItemSummary.php | 34 +- src/Buy/Browse/V1/Model/Items.php | 2 +- src/Buy/Browse/V1/Model/LegalAddress.php | 2 +- src/Buy/Browse/V1/Model/MarketingPrice.php | 2 +- src/Buy/Browse/V1/Model/ModelInterface.php | 2 +- src/Buy/Browse/V1/Model/PaymentMethod.php | 2 +- .../Browse/V1/Model/PaymentMethodBrand.php | 2 +- .../Browse/V1/Model/PickupOptionSummary.php | 2 +- src/Buy/Browse/V1/Model/Price.php | 2 +- src/Buy/Browse/V1/Model/Product.php | 2 +- src/Buy/Browse/V1/Model/ProductIdentity.php | 2 +- src/Buy/Browse/V1/Model/RatingHistogram.php | 2 +- src/Buy/Browse/V1/Model/Refinement.php | 2 +- src/Buy/Browse/V1/Model/Region.php | 2 +- .../V1/Model/RemoteShopcartResponse.php | 2 +- .../Browse/V1/Model/RemoveCartItemInput.php | 2 +- src/Buy/Browse/V1/Model/ReviewRating.php | 2 +- .../Browse/V1/Model/SearchByImageRequest.php | 2 +- .../Browse/V1/Model/SearchPagedCollection.php | 2 +- src/Buy/Browse/V1/Model/Seller.php | 2 +- .../Browse/V1/Model/SellerCustomPolicy.php | 2 +- src/Buy/Browse/V1/Model/SellerDetail.php | 2 +- src/Buy/Browse/V1/Model/SellerLegalInfo.php | 2 +- src/Buy/Browse/V1/Model/ShipToLocation.php | 2 +- src/Buy/Browse/V1/Model/ShipToLocations.php | 2 +- src/Buy/Browse/V1/Model/ShipToRegion.php | 2 +- src/Buy/Browse/V1/Model/ShippingOption.php | 4 +- .../Browse/V1/Model/ShippingOptionSummary.php | 2 +- src/Buy/Browse/V1/Model/TargetLocation.php | 2 +- src/Buy/Browse/V1/Model/TaxJurisdiction.php | 2 +- src/Buy/Browse/V1/Model/Taxes.php | 2 +- src/Buy/Browse/V1/Model/TimeDuration.php | 2 +- src/Buy/Browse/V1/Model/TypedNameValue.php | 2 +- .../Browse/V1/Model/UpdateCartItemInput.php | 2 +- src/Buy/Browse/V1/Model/VatDetail.php | 2 +- src/Buy/Browse/V1/ObjectSerializer.php | 2 +- src/Buy/Browse/V1/README.md | 2 +- src/Buy/Browse/V1/docs/Api/ItemSummaryApi.md | 4 +- src/Buy/Browse/V1/docs/Model/Category.md | 3 +- src/Buy/Browse/V1/docs/Model/ItemSummary.md | 3 +- .../Browse/V1/docs/Model/ShippingOption.md | 2 +- src/Buy/Deal/V1/Configuration.php | 2 +- src/Buy/Feed/V1/Api/AccessApi.php | 2 +- src/Buy/Feed/V1/Api/FeedTypeApi.php | 2 +- src/Buy/Feed/V1/Api/FileApi.php | 2 +- src/Buy/Feed/V1/ApiException.php | 2 +- src/Buy/Feed/V1/Configuration.php | 6 +- src/Buy/Feed/V1/HeaderSelector.php | 2 +- src/Buy/Feed/V1/Model/Access.php | 2 +- src/Buy/Feed/V1/Model/ApplicationAccess.php | 2 +- src/Buy/Feed/V1/Model/Constraint.php | 2 +- src/Buy/Feed/V1/Model/Dimension.php | 2 +- src/Buy/Feed/V1/Model/Error.php | 2 +- src/Buy/Feed/V1/Model/ErrorParameter.php | 2 +- src/Buy/Feed/V1/Model/FeedType.php | 2 +- src/Buy/Feed/V1/Model/FeedTypeConstraint.php | 2 +- .../Feed/V1/Model/FeedTypeSearchResponse.php | 2 +- src/Buy/Feed/V1/Model/FileMetadata.php | 2 +- .../V1/Model/FileMetadataSearchResponse.php | 2 +- src/Buy/Feed/V1/Model/ModelInterface.php | 2 +- src/Buy/Feed/V1/Model/SupportedFeed.php | 2 +- src/Buy/Feed/V1/Model/SupportedSchema.php | 2 +- src/Buy/Feed/V1/Model/TimeDuration.php | 2 +- src/Buy/Feed/V1/ObjectSerializer.php | 2 +- src/Buy/Feed/V1/README.md | 2 +- src/Buy/FeedBeta/V1/Configuration.php | 2 +- src/Buy/FeedBeta/V1/docs/Api/ItemApi.md | 2 +- src/Buy/MarketingBeta/V1/Configuration.php | 2 +- .../V1/Configuration.php | 2 +- src/Buy/OfferBeta/V1/Configuration.php | 2 +- src/Buy/Order/V2/Configuration.php | 2 +- .../CatalogBeta/V1/Api/ProductApi.php | 38 +- .../CatalogBeta/V1/Api/ProductSummaryApi.php | 108 +- src/Commerce/CatalogBeta/V1/Configuration.php | 2 +- .../V1/Model/AspectDistribution.php | 4 +- .../V1/Model/AspectValueDistribution.php | 6 +- src/Commerce/CatalogBeta/V1/Model/Product.php | 6 +- .../V1/Model/ProductSearchResponse.php | 16 +- .../CatalogBeta/V1/Model/ProductSummary.php | 8 +- .../CatalogBeta/V1/Model/Refinement.php | 2 +- src/Commerce/CatalogBeta/V1/README.md | 5 +- .../CatalogBeta/V1/docs/Api/ProductApi.md | 12 +- .../V1/docs/Api/ProductSummaryApi.md | 36 +- .../V1/docs/Model/AspectDistribution.md | 4 +- .../V1/docs/Model/AspectValueDistribution.md | 6 +- .../CatalogBeta/V1/docs/Model/Product.md | 6 +- .../V1/docs/Model/ProductSearchResponse.md | 14 +- .../V1/docs/Model/ProductSummary.md | 6 +- .../CatalogBeta/V1/docs/Model/Refinement.md | 2 +- src/Commerce/Charity/V1/Configuration.php | 2 +- .../Charity/V1/docs/Api/CharityOrgApi.md | 4 +- .../Identity/V1/.openapi-generator/FILES | 31 - src/Commerce/Identity/V1/README.md | 124 - src/Commerce/Identity/V1/composer.json | 30 - src/Commerce/Identity/V1/docs/Api/UserApi.md | 65 - .../Identity/V1/docs/Model/Address.md | 15 - .../Identity/V1/docs/Model/BusinessAccount.md | 16 - .../V1/docs/Model/IndividualAccount.md | 14 - src/Commerce/Identity/V1/docs/Model/Phone.md | 11 - .../Identity/V1/docs/Model/UserResponse.md | 15 - src/Commerce/MediaBeta/V1/Configuration.php | 2 +- .../Notification/V1/Configuration.php | 2 +- src/Commerce/Taxonomy/V1/Configuration.php | 2 +- .../TranslationBeta/V1/Configuration.php | 2 +- .../AnalyticsBeta/V1/.openapi-generator/FILES | 2 - .../AnalyticsBeta/V1/Api/RateLimitApi.php | 46 +- .../AnalyticsBeta/V1/Api/UserRateLimitApi.php | 46 +- .../AnalyticsBeta/V1/ApiException.php | 2 +- .../AnalyticsBeta/V1/Configuration.php | 4 +- .../AnalyticsBeta/V1/HeaderSelector.php | 2 +- .../AnalyticsBeta/V1/Model/Error.php | 2 +- .../AnalyticsBeta/V1/Model/ErrorParameter.php | 2 +- .../AnalyticsBeta/V1/Model/ModelInterface.php | 2 +- src/Developer/AnalyticsBeta/V1/Model/Rate.php | 8 +- .../AnalyticsBeta/V1/Model/RateLimit.php | 12 +- .../V1/Model/RateLimitsResponse.php | 2 +- .../AnalyticsBeta/V1/Model/Resource.php | 2 +- .../AnalyticsBeta/V1/ObjectSerializer.php | 2 +- src/Developer/AnalyticsBeta/V1/README.md | 7 +- src/Developer/AnalyticsBeta/V1/composer.json | 2 +- .../AnalyticsBeta/V1/docs/Api/RateLimitApi.md | 10 +- .../V1/docs/Api/UserRateLimitApi.md | 10 +- .../AnalyticsBeta/V1/docs/Model/Rate.md | 4 +- .../AnalyticsBeta/V1/docs/Model/RateLimit.md | 8 +- .../ClientRegistration}/V1/.gitignore | 0 .../V1/.openapi-generator-ignore | 0 .../V1/.openapi-generator/FILES | 23 + .../V1/.openapi-generator/VERSION | 0 .../ClientRegistration}/V1/.php_cs | 0 .../ClientRegistration}/V1/.travis.yml | 0 .../ClientRegistration/V1/Api/RegisterApi.php | 411 + .../ClientRegistration}/V1/ApiException.php | 8 +- .../ClientRegistration}/V1/Configuration.php | 20 +- .../ClientRegistration}/V1/HeaderSelector.php | 8 +- .../V1/Model/ClientDetails.php | 677 + .../V1/Model/ClientSettings.php} | 210 +- .../ClientRegistration}/V1/Model/Error.php | 16 +- .../V1/Model/ErrorParameter.php | 10 +- .../V1/Model/ModelInterface.php | 8 +- .../V1/ObjectSerializer.php | 12 +- src/Developer/ClientRegistration/V1/README.md | 112 + .../ClientRegistration/V1/composer.json | 30 + .../V1/docs/Api/RegisterApi.md | 64 + .../V1/docs/Model/ClientDetails.md | 20 + .../V1/docs/Model/ClientSettings.md | 14 + .../ClientRegistration/V1/docs/Model/Error.md | 17 + .../V1/docs/Model/ErrorParameter.md | 0 .../ClientRegistration/V1/git_push.sh | 57 + .../ClientRegistration}/V1/phpunit.xml.dist | 0 src/Developer/KeyManagement/V1/.gitignore | 14 + .../V1/.openapi-generator-ignore | 23 + .../KeyManagement/V1/.openapi-generator/FILES | 25 + .../V1/.openapi-generator/VERSION | 1 + src/Developer/KeyManagement/V1/.php_cs | 23 + src/Developer/KeyManagement/V1/.travis.yml | 9 + .../KeyManagement/V1/Api/SigningKeyApi.php | 879 ++ .../KeyManagement/V1/ApiException.php | 154 + .../KeyManagement/V1/Configuration.php | 536 + .../KeyManagement/V1/HeaderSelector.php | 146 + .../V1/Model/CreateSigningKeyRequest.php | 347 + .../KeyManagement/V1/Model/Error.php | 587 + .../KeyManagement/V1/Model/ErrorParameter.php | 376 + .../KeyManagement/V1/Model/ModelInterface.php | 125 + .../V1/Model/QuerySigningKeysResponse.php | 347 + .../KeyManagement/V1/Model/SigningKey.php | 527 + .../KeyManagement/V1/ObjectSerializer.php | 533 + src/Developer/KeyManagement/V1/README.md | 119 + src/Developer/KeyManagement/V1/composer.json | 30 + .../V1/docs/Api/SigningKeyApi.md | 187 + .../V1/docs/Model/CreateSigningKeyRequest.md | 9 + .../KeyManagement}/V1/docs/Model/Error.md | 2 +- .../V1/docs/Model/ErrorParameter.md} | 6 +- .../V1/docs/Model/QuerySigningKeysResponse.md | 9 + .../KeyManagement/V1/docs/Model/SigningKey.md | 15 + .../KeyManagement}/V1/git_push.sh | 2 +- .../KeyManagement/V1/phpunit.xml.dist | 25 + src/Sell/Account/V1/.openapi-generator/FILES | 36 + .../V1/Api/AdvertisingEligibilityApi.php | 6 +- src/Sell/Account/V1/Api/CountryApi.php | 445 + src/Sell/Account/V1/Api/CustomPolicyApi.php | 18 +- .../Account/V1/Api/FulfillmentPolicyApi.php | 26 +- src/Sell/Account/V1/Api/KycApi.php | 6 +- src/Sell/Account/V1/Api/LocationApi.php | 1974 +++ src/Sell/Account/V1/Api/OnboardingApi.php | 6 +- src/Sell/Account/V1/Api/PaymentPolicyApi.php | 26 +- .../Account/V1/Api/PaymentsProgramApi.php | 6 +- src/Sell/Account/V1/Api/PrivilegeApi.php | 6 +- src/Sell/Account/V1/Api/ProgramApi.php | 14 +- src/Sell/Account/V1/Api/RateTableApi.php | 16 +- src/Sell/Account/V1/Api/ReturnPolicyApi.php | 26 +- src/Sell/Account/V1/Api/SalesTaxApi.php | 58 +- .../Account/V1/Api/SubscriptionApi.php} | 106 +- src/Sell/Account/V1/ApiException.php | 2 +- src/Sell/Account/V1/Configuration.php | 6 +- src/Sell/Account/V1/HeaderSelector.php | 2 +- .../Account}/V1/Model/Address.php | 26 +- src/Sell/Account/V1/Model/Amount.php | 4 +- src/Sell/Account/V1/Model/CategoryType.php | 2 +- .../V1/Model/CompactCustomPolicyResponse.php | 2 +- src/Sell/Account/V1/Model/CustomPolicy.php | 2 +- .../V1/Model/CustomPolicyCreateRequest.php | 2 +- .../Account/V1/Model/CustomPolicyRequest.php | 2 +- .../Account/V1/Model/CustomPolicyResponse.php | 2 +- src/Sell/Account/V1/Model/Deposit.php | 2 +- src/Sell/Account/V1/Model/Error.php | 2 +- src/Sell/Account/V1/Model/ErrorParameter.php | 2 +- .../Account/V1/Model/FulfillmentPolicy.php | 6 +- .../V1/Model/FulfillmentPolicyRequest.php | 6 +- .../V1/Model/FulfillmentPolicyResponse.php | 2 +- src/Sell/Account/V1/Model/GeoCoordinates.php | 377 + .../Model/InternationalReturnOverrideType.php | 4 +- .../Account/V1/Model/Interval.php} | 102 +- .../Account/V1/Model/InventoryLocation.php | 527 + .../V1/Model/InventoryLocationFull.php | 617 + .../V1/Model/InventoryLocationResponse.php | 647 + src/Sell/Account/V1/Model/KycCheck.php | 2 +- src/Sell/Account/V1/Model/KycResponse.php | 2 +- src/Sell/Account/V1/Model/Location.php | 407 + src/Sell/Account/V1/Model/LocationDetails.php | 377 + .../Account/V1/Model/LocationResponse.php} | 242 +- src/Sell/Account/V1/Model/ModelInterface.php | 2 +- src/Sell/Account/V1/Model/OperatingHours.php | 377 + src/Sell/Account/V1/Model/PaymentMethod.php | 2 +- src/Sell/Account/V1/Model/PaymentPolicy.php | 2 +- .../Account/V1/Model/PaymentPolicyRequest.php | 2 +- .../V1/Model/PaymentPolicyResponse.php | 2 +- .../PaymentsProgramOnboardingResponse.php | 2 +- .../Model/PaymentsProgramOnboardingSteps.php | 2 +- .../V1/Model/PaymentsProgramResponse.php | 2 +- src/Sell/Account/V1/Model/Program.php | 2 +- src/Sell/Account/V1/Model/Programs.php | 2 +- src/Sell/Account/V1/Model/RateTable.php | 4 +- .../Account/V1/Model/RateTableResponse.php | 2 +- .../V1/Model/RecipientAccountReference.php | 2 +- src/Sell/Account/V1/Model/Region.php | 4 +- src/Sell/Account/V1/Model/RegionSet.php | 6 +- src/Sell/Account/V1/Model/ReturnPolicy.php | 8 +- .../Account/V1/Model/ReturnPolicyRequest.php | 8 +- .../Account/V1/Model/ReturnPolicyResponse.php | 2 +- src/Sell/Account/V1/Model/SalesTax.php | 2 +- src/Sell/Account/V1/Model/SalesTaxBase.php | 2 +- .../V1/Model/SalesTaxJurisdiction.php} | 76 +- .../V1/Model/SalesTaxJurisdictions.php} | 47 +- src/Sell/Account/V1/Model/SalesTaxes.php | 2 +- .../SellerEligibilityMultiProgramResponse.php | 2 +- .../V1/Model/SellerEligibilityResponse.php | 2 +- src/Sell/Account/V1/Model/SellingLimit.php | 2 +- .../Account/V1/Model/SellingPrivileges.php | 2 +- .../V1/Model/SetFulfillmentPolicyResponse.php | 6 +- .../V1/Model/SetPaymentPolicyResponse.php | 2 +- .../V1/Model/SetReturnPolicyResponse.php | 6 +- src/Sell/Account/V1/Model/ShippingOption.php | 4 +- src/Sell/Account/V1/Model/ShippingService.php | 12 +- src/Sell/Account/V1/Model/SpecialHours.php | 377 + .../Account/V1/Model/Subscription.php} | 184 +- .../Account/V1/Model/SubscriptionResponse.php | 467 + src/Sell/Account/V1/Model/TimeDuration.php | 2 +- src/Sell/Account/V1/ObjectSerializer.php | 2 +- src/Sell/Account/V1/README.md | 40 +- .../V1/docs/Api/AdvertisingEligibilityApi.md | 5 +- src/Sell/Account/V1/docs/Api/CountryApi.md | 71 + .../Account/V1/docs/Api/CustomPolicyApi.md | 20 +- .../V1/docs/Api/FulfillmentPolicyApi.md | 30 +- src/Sell/Account/V1/docs/Api/KycApi.md | 5 +- src/Sell/Account/V1/docs/Api/LocationApi.md | 458 + src/Sell/Account/V1/docs/Api/OnboardingApi.md | 5 +- .../Account/V1/docs/Api/PaymentPolicyApi.md | 30 +- .../Account/V1/docs/Api/PaymentsProgramApi.md | 5 +- src/Sell/Account/V1/docs/Api/PrivilegeApi.md | 5 +- src/Sell/Account/V1/docs/Api/ProgramApi.md | 15 +- src/Sell/Account/V1/docs/Api/RateTableApi.md | 11 +- .../Account/V1/docs/Api/ReturnPolicyApi.md | 30 +- src/Sell/Account/V1/docs/Api/SalesTaxApi.md | 36 +- .../Account/V1/docs/Api/SubscriptionApi.md | 73 + src/Sell/Account/V1/docs/Model/Address.md | 15 + src/Sell/Account/V1/docs/Model/Amount.md | 2 +- .../V1/docs/Model/FulfillmentPolicy.md | 4 +- .../V1/docs/Model/FulfillmentPolicyRequest.md | 4 +- .../Account/V1/docs/Model/GeoCoordinates.md | 10 + .../Model/InternationalReturnOverrideType.md | 2 +- src/Sell/Account/V1/docs/Model/Interval.md | 10 + .../V1/docs/Model/InventoryLocation.md | 15 + .../V1/docs/Model/InventoryLocationFull.md | 18 + .../docs/Model/InventoryLocationResponse.md | 19 + src/Sell/Account/V1/docs/Model/Location.md | 11 + .../Account/V1/docs/Model/LocationDetails.md | 10 + .../Account/V1/docs/Model/LocationResponse.md | 15 + .../Account/V1/docs/Model/OperatingHours.md | 10 + src/Sell/Account/V1/docs/Model/RateTable.md | 2 +- src/Sell/Account/V1/docs/Model/Region.md | 2 +- src/Sell/Account/V1/docs/Model/RegionSet.md | 4 +- .../Account/V1/docs/Model/ReturnPolicy.md | 6 +- .../V1/docs/Model/ReturnPolicyRequest.md | 6 +- .../V1/docs/Model/SalesTaxJurisdiction.md | 9 + .../V1/docs/Model/SalesTaxJurisdictions.md | 9 + .../Model/SetFulfillmentPolicyResponse.md | 4 +- .../V1/docs/Model/SetReturnPolicyResponse.md | 4 +- .../Account/V1/docs/Model/ShippingOption.md | 2 +- .../Account/V1/docs/Model/ShippingService.md | 10 +- .../Account/V1/docs/Model/SpecialHours.md | 10 + .../Account/V1/docs/Model/Subscription.md | 13 + .../V1/docs/Model/SubscriptionResponse.md | 13 + src/Sell/Account/V2/Configuration.php | 2 +- src/Sell/Analytics/V1/Configuration.php | 2 +- src/Sell/Compliance/V1/Configuration.php | 2 +- src/Sell/Feed/V1/Configuration.php | 2 +- .../V1/Model/CreateInventoryTaskRequest.php | 32 +- .../Feed/V1/Model/InventoryFilterCriteria.php | 94 +- src/Sell/Feed/V1/Model/InventoryTask.php | 30 - .../docs/Model/CreateInventoryTaskRequest.md | 3 +- .../V1/docs/Model/InventoryFilterCriteria.md | 5 +- src/Sell/Feed/V1/docs/Model/InventoryTask.md | 1 - src/Sell/Finances/V1/Api/PayoutApi.php | 146 +- .../Finances/V1/Api/SellerFundsSummaryApi.php | 35 +- src/Sell/Finances/V1/Api/TransactionApi.php | 108 +- src/Sell/Finances/V1/Api/TransferApi.php | 40 +- src/Sell/Finances/V1/ApiException.php | 2 +- src/Sell/Finances/V1/Configuration.php | 6 +- src/Sell/Finances/V1/HeaderSelector.php | 2 +- src/Sell/Finances/V1/Model/Amount.php | 2 +- .../Finances/V1/Model/BalanceAdjustment.php | 2 +- src/Sell/Finances/V1/Model/Buyer.php | 2 +- src/Sell/Finances/V1/Model/Charge.php | 2 +- src/Sell/Finances/V1/Model/Error.php | 2 +- src/Sell/Finances/V1/Model/ErrorParameter.php | 2 +- src/Sell/Finances/V1/Model/Fee.php | 2 +- .../Finances/V1/Model/FeeJurisdiction.php | 6 +- src/Sell/Finances/V1/Model/FundingSource.php | 2 +- src/Sell/Finances/V1/Model/ModelInterface.php | 2 +- src/Sell/Finances/V1/Model/OrderLineItem.php | 2 +- src/Sell/Finances/V1/Model/Payout.php | 62 +- .../Finances/V1/Model/PayoutInstrument.php | 2 +- .../V1/Model/PayoutSummaryResponse.php | 2 +- src/Sell/Finances/V1/Model/Payouts.php | 2 +- src/Sell/Finances/V1/Model/Reference.php | 2 +- .../V1/Model/SellerFundsSummaryResponse.php | 2 +- src/Sell/Finances/V1/Model/Transaction.php | 32 +- .../V1/Model/TransactionSummaryResponse.php | 92 +- src/Sell/Finances/V1/Model/Transactions.php | 2 +- src/Sell/Finances/V1/Model/Transfer.php | 2 +- src/Sell/Finances/V1/Model/TransferDetail.php | 2 +- src/Sell/Finances/V1/ObjectSerializer.php | 2 +- src/Sell/Finances/V1/README.md | 5 +- src/Sell/Finances/V1/docs/Api/PayoutApi.md | 24 +- .../V1/docs/Api/SellerFundsSummaryApi.md | 11 +- .../Finances/V1/docs/Api/TransactionApi.md | 24 +- src/Sell/Finances/V1/docs/Api/TransferApi.md | 8 +- .../Finances/V1/docs/Model/FeeJurisdiction.md | 4 +- src/Sell/Finances/V1/docs/Model/Payout.md | 2 + .../Finances/V1/docs/Model/Transaction.md | 1 + .../docs/Model/TransactionSummaryResponse.md | 3 + .../Fulfillment/V1/.openapi-generator/FILES | 6 + src/Sell/Fulfillment/V1/Api/OrderApi.php | 32 +- .../Fulfillment/V1/Api/PaymentDisputeApi.php | 12 +- .../V1/Api/ShippingFulfillmentApi.php | 32 +- src/Sell/Fulfillment/V1/ApiException.php | 2 +- src/Sell/Fulfillment/V1/Configuration.php | 6 +- src/Sell/Fulfillment/V1/HeaderSelector.php | 2 +- .../V1/Model/AcceptPaymentDisputeRequest.php | 2 +- .../AddEvidencePaymentDisputeRequest.php | 2 +- .../AddEvidencePaymentDisputeResponse.php | 2 +- src/Sell/Fulfillment/V1/Model/Address.php | 2 +- src/Sell/Fulfillment/V1/Model/Amount.php | 2 +- .../Fulfillment/V1/Model/AppliedPromotion.php | 2 +- src/Sell/Fulfillment/V1/Model/Buyer.php | 2 +- .../Fulfillment/V1/Model/CancelRequest.php | 2 +- .../Fulfillment/V1/Model/CancelStatus.php | 2 +- .../V1/Model/ContestPaymentDisputeRequest.php | 2 +- .../Fulfillment/V1/Model/DeliveryCost.php | 2 +- .../Fulfillment/V1/Model/DisputeAmount.php | 2 +- .../Fulfillment/V1/Model/DisputeEvidence.php | 2 +- .../V1/Model/DisputeSummaryResponse.php | 2 +- .../V1/Model/EbayCollectAndRemitTax.php | 2 +- .../V1/Model/EbayCollectedCharges.php | 347 + .../V1/Model/EbayFulfillmentProgram.php | 2 +- .../V1/Model/EbayInternationalShipping.php | 347 + .../Fulfillment/V1/Model/EbayShipping.php | 347 + .../Fulfillment/V1/Model/EbayTaxReference.php | 2 +- .../Fulfillment/V1/Model/EbayVaultProgram.php | 2 +- src/Sell/Fulfillment/V1/Model/Error.php | 2 +- .../Fulfillment/V1/Model/ErrorParameter.php | 2 +- .../Fulfillment/V1/Model/EvidenceRequest.php | 2 +- .../Fulfillment/V1/Model/ExtendedContact.php | 2 +- .../Fulfillment/V1/Model/FileEvidence.php | 2 +- src/Sell/Fulfillment/V1/Model/FileInfo.php | 2 +- .../V1/Model/FulfillmentStartInstruction.php | 4 +- src/Sell/Fulfillment/V1/Model/GiftDetails.php | 2 +- .../Fulfillment/V1/Model/InfoFromBuyer.php | 2 +- .../V1/Model/IssueRefundRequest.php | 2 +- .../Fulfillment/V1/Model/ItemLocation.php | 2 +- .../Fulfillment/V1/Model/LegacyReference.php | 2 +- src/Sell/Fulfillment/V1/Model/LineItem.php | 32 +- .../Model/LineItemFulfillmentInstructions.php | 2 +- .../V1/Model/LineItemProperties.php | 2 +- .../V1/Model/LineItemReference.php | 2 +- .../Fulfillment/V1/Model/LineItemRefund.php | 2 +- .../Fulfillment/V1/Model/ModelInterface.php | 2 +- .../V1/Model/MonetaryTransaction.php | 2 +- src/Sell/Fulfillment/V1/Model/Order.php | 6 +- .../Fulfillment/V1/Model/OrderLineItems.php | 2 +- src/Sell/Fulfillment/V1/Model/OrderRefund.php | 2 +- .../V1/Model/OrderSearchPagedCollection.php | 2 +- src/Sell/Fulfillment/V1/Model/Payment.php | 2 +- .../Fulfillment/V1/Model/PaymentDispute.php | 4 +- .../V1/Model/PaymentDisputeActivity.php | 2 +- .../Model/PaymentDisputeActivityHistory.php | 2 +- .../V1/Model/PaymentDisputeOutcomeDetail.php | 2 +- .../V1/Model/PaymentDisputeSummary.php | 4 +- src/Sell/Fulfillment/V1/Model/PaymentHold.php | 2 +- .../Fulfillment/V1/Model/PaymentSummary.php | 2 +- src/Sell/Fulfillment/V1/Model/Phone.php | 2 +- src/Sell/Fulfillment/V1/Model/PhoneNumber.php | 2 +- src/Sell/Fulfillment/V1/Model/PickupStep.php | 2 +- .../Model/PostSaleAuthenticationProgram.php | 2 +- .../Fulfillment/V1/Model/PricingSummary.php | 2 +- src/Sell/Fulfillment/V1/Model/Program.php | 64 +- src/Sell/Fulfillment/V1/Model/Refund.php | 2 +- src/Sell/Fulfillment/V1/Model/RefundItem.php | 2 +- .../Fulfillment/V1/Model/ReturnAddress.php | 2 +- .../V1/Model/SellerActionsToRelease.php | 2 +- .../V1/Model/ShippingFulfillment.php | 2 +- .../V1/Model/ShippingFulfillmentDetails.php | 4 +- .../ShippingFulfillmentPagedCollection.php | 2 +- .../Fulfillment/V1/Model/ShippingStep.php | 2 +- .../Fulfillment/V1/Model/SimpleAmount.php | 2 +- src/Sell/Fulfillment/V1/Model/Tax.php | 2 +- src/Sell/Fulfillment/V1/Model/TaxAddress.php | 2 +- .../Fulfillment/V1/Model/TaxIdentifier.php | 2 +- .../Fulfillment/V1/Model/TrackingInfo.php | 2 +- .../UpdateEvidencePaymentDisputeRequest.php | 2 +- src/Sell/Fulfillment/V1/ObjectSerializer.php | 2 +- src/Sell/Fulfillment/V1/README.md | 7 +- src/Sell/Fulfillment/V1/docs/Api/OrderApi.md | 14 +- .../V1/docs/Api/PaymentDisputeApi.md | 6 +- .../V1/docs/Api/ShippingFulfillmentApi.md | 12 +- .../V1/docs/Model/EbayCollectedCharges.md} | 4 +- .../docs/Model/EbayInternationalShipping.md | 9 + .../Fulfillment/V1/docs/Model/EbayShipping.md | 9 + .../docs/Model/FulfillmentStartInstruction.md | 2 +- .../Fulfillment/V1/docs/Model/LineItem.md | 1 + src/Sell/Fulfillment/V1/docs/Model/Order.md | 4 +- .../V1/docs/Model/PaymentDispute.md | 2 +- .../V1/docs/Model/PaymentDisputeSummary.md | 2 +- src/Sell/Fulfillment/V1/docs/Model/Program.md | 2 + .../docs/Model/ShippingFulfillmentDetails.md | 2 +- .../Inventory/V1/Api/InventoryItemApi.php | 2 +- .../V1/Api/InventoryItemGroupApi.php | 2 +- src/Sell/Inventory/V1/Api/ListingApi.php | 2 +- src/Sell/Inventory/V1/Api/LocationApi.php | 72 +- src/Sell/Inventory/V1/Api/OfferApi.php | 2 +- .../V1/Api/ProductCompatibilityApi.php | 2 +- src/Sell/Inventory/V1/ApiException.php | 2 +- src/Sell/Inventory/V1/Configuration.php | 6 +- src/Sell/Inventory/V1/HeaderSelector.php | 2 +- src/Sell/Inventory/V1/Model/Address.php | 14 +- src/Sell/Inventory/V1/Model/Amount.php | 2 +- src/Sell/Inventory/V1/Model/Availability.php | 2 +- .../V1/Model/AvailabilityDistribution.php | 2 +- .../V1/Model/AvailabilityWithAll.php | 2 +- src/Sell/Inventory/V1/Model/BaseResponse.php | 2 +- src/Sell/Inventory/V1/Model/BestOffer.php | 2 +- .../V1/Model/BulkEbayOfferDetailsWithKeys.php | 2 +- .../V1/Model/BulkGetInventoryItem.php | 2 +- .../V1/Model/BulkGetInventoryItemResponse.php | 2 +- .../Inventory/V1/Model/BulkInventoryItem.php | 2 +- .../V1/Model/BulkInventoryItemResponse.php | 2 +- .../Inventory/V1/Model/BulkMigrateListing.php | 2 +- .../V1/Model/BulkMigrateListingResponse.php | 2 +- src/Sell/Inventory/V1/Model/BulkOffer.php | 2 +- .../Inventory/V1/Model/BulkOfferResponse.php | 2 +- .../Inventory/V1/Model/BulkPriceQuantity.php | 2 +- .../V1/Model/BulkPriceQuantityResponse.php | 2 +- .../V1/Model/BulkPublishResponse.php | 2 +- src/Sell/Inventory/V1/Model/Charity.php | 2 +- src/Sell/Inventory/V1/Model/Compatibility.php | 2 +- .../Inventory/V1/Model/CompatibleProduct.php | 2 +- src/Sell/Inventory/V1/Model/Dimension.php | 2 +- .../V1/Model/EbayOfferDetailsWithAll.php | 2 +- .../V1/Model/EbayOfferDetailsWithId.php | 2 +- .../V1/Model/EbayOfferDetailsWithKeys.php | 2 +- src/Sell/Inventory/V1/Model/Error.php | 2 +- .../Inventory/V1/Model/ErrorParameter.php | 2 +- .../Model/ExtendedProducerResponsibility.php | 2 +- src/Sell/Inventory/V1/Model/Fee.php | 2 +- src/Sell/Inventory/V1/Model/FeeSummary.php | 2 +- .../V1/Model/FeesSummaryResponse.php | 2 +- .../Inventory/V1/Model/FormatAllocation.php | 2 +- .../Inventory/V1/Model/GeoCoordinates.php | 6 +- .../Inventory/V1/Model/GetInventoryItem.php | 2 +- .../V1/Model/GetInventoryItemResponse.php | 2 +- src/Sell/Inventory/V1/Model/Interval.php | 6 +- src/Sell/Inventory/V1/Model/InventoryItem.php | 4 +- .../Inventory/V1/Model/InventoryItemGroup.php | 8 +- .../V1/Model/InventoryItemListing.php | 2 +- .../V1/Model/InventoryItemResponse.php | 4 +- .../V1/Model/InventoryItemWithSkuLocale.php | 6 +- .../InventoryItemWithSkuLocaleGroupKeys.php | 6 +- .../InventoryItemWithSkuLocaleGroupid.php | 6 +- .../Inventory/V1/Model/InventoryItems.php | 2 +- .../Inventory/V1/Model/InventoryLocation.php | 10 +- .../V1/Model/InventoryLocationFull.php | 12 +- .../V1/Model/InventoryLocationResponse.php | 16 +- .../Inventory/V1/Model/ListingDetails.php | 2 +- .../Inventory/V1/Model/ListingPolicies.php | 2 +- src/Sell/Inventory/V1/Model/Location.php | 4 +- .../Inventory/V1/Model/LocationDetails.php | 2 +- .../Inventory/V1/Model/LocationResponse.php | 8 +- .../Inventory/V1/Model/MigrateListing.php | 2 +- .../V1/Model/MigrateListingResponse.php | 2 +- .../Inventory/V1/Model/ModelInterface.php | 2 +- src/Sell/Inventory/V1/Model/NameValueList.php | 2 +- .../Inventory/V1/Model/OfferKeyWithId.php | 2 +- .../Inventory/V1/Model/OfferKeysWithId.php | 2 +- .../Inventory/V1/Model/OfferPriceQuantity.php | 2 +- src/Sell/Inventory/V1/Model/OfferResponse.php | 2 +- .../V1/Model/OfferResponseWithListingId.php | 2 +- .../Inventory/V1/Model/OfferSkuResponse.php | 2 +- src/Sell/Inventory/V1/Model/Offers.php | 2 +- .../Inventory/V1/Model/OperatingHours.php | 6 +- .../V1/Model/PackageWeightAndSize.php | 2 +- .../V1/Model/PickupAtLocationAvailability.php | 2 +- src/Sell/Inventory/V1/Model/PriceQuantity.php | 2 +- .../V1/Model/PriceQuantityResponse.php | 2 +- .../Inventory/V1/Model/PricingSummary.php | 2 +- src/Sell/Inventory/V1/Model/Product.php | 8 +- .../V1/Model/ProductFamilyProperties.php | 2 +- .../Inventory/V1/Model/ProductIdentifier.php | 2 +- .../PublishByInventoryItemGroupRequest.php | 2 +- .../Inventory/V1/Model/PublishResponse.php | 2 +- .../V1/Model/ShipToLocationAvailability.php | 2 +- .../ShipToLocationAvailabilityWithAll.php | 2 +- .../V1/Model/ShippingCostOverride.php | 2 +- src/Sell/Inventory/V1/Model/SpecialHours.php | 6 +- src/Sell/Inventory/V1/Model/Specification.php | 2 +- src/Sell/Inventory/V1/Model/Tax.php | 2 +- src/Sell/Inventory/V1/Model/TimeDuration.php | 2 +- src/Sell/Inventory/V1/Model/VariesBy.php | 2 +- src/Sell/Inventory/V1/Model/Version.php | 2 +- src/Sell/Inventory/V1/Model/Weight.php | 2 +- .../WithdrawByInventoryItemGroupRequest.php | 2 +- .../Inventory/V1/Model/WithdrawResponse.php | 2 +- src/Sell/Inventory/V1/ObjectSerializer.php | 2 +- src/Sell/Inventory/V1/README.md | 2 +- src/Sell/Inventory/V1/docs/Api/LocationApi.md | 32 +- src/Sell/Inventory/V1/docs/Api/OfferApi.md | 2 +- src/Sell/Inventory/V1/docs/Model/Address.md | 12 +- .../Inventory/V1/docs/Model/GeoCoordinates.md | 4 +- src/Sell/Inventory/V1/docs/Model/Interval.md | 4 +- .../Inventory/V1/docs/Model/InventoryItem.md | 2 +- .../V1/docs/Model/InventoryItemGroup.md | 6 +- .../V1/docs/Model/InventoryItemResponse.md | 2 +- .../docs/Model/InventoryItemWithSkuLocale.md | 4 +- .../InventoryItemWithSkuLocaleGroupKeys.md | 4 +- .../InventoryItemWithSkuLocaleGroupid.md | 4 +- .../V1/docs/Model/InventoryLocation.md | 8 +- .../V1/docs/Model/InventoryLocationFull.md | 10 +- .../docs/Model/InventoryLocationResponse.md | 14 +- src/Sell/Inventory/V1/docs/Model/Location.md | 2 +- .../V1/docs/Model/LocationResponse.md | 6 +- .../Inventory/V1/docs/Model/OperatingHours.md | 4 +- src/Sell/Inventory/V1/docs/Model/Product.md | 6 +- .../Inventory/V1/docs/Model/SpecialHours.md | 4 +- src/Sell/ListingBeta/V1/Configuration.php | 2 +- src/Sell/Logistics/V1/Configuration.php | 2 +- src/Sell/Marketing/V1/Api/AdApi.php | 2 +- src/Sell/Marketing/V1/Api/AdGroupApi.php | 2 +- src/Sell/Marketing/V1/Api/AdReportApi.php | 2 +- .../Marketing/V1/Api/AdReportMetadataApi.php | 2 +- src/Sell/Marketing/V1/Api/AdReportTaskApi.php | 2 +- src/Sell/Marketing/V1/Api/CampaignApi.php | 2 +- .../Marketing/V1/Api/ItemPriceMarkdownApi.php | 2 +- .../Marketing/V1/Api/ItemPromotionApi.php | 2 +- src/Sell/Marketing/V1/Api/KeywordApi.php | 2 +- .../Marketing/V1/Api/NegativeKeywordApi.php | 2 +- src/Sell/Marketing/V1/Api/PromotionApi.php | 2 +- .../Marketing/V1/Api/PromotionReportApi.php | 2 +- .../V1/Api/PromotionSummaryReportApi.php | 2 +- src/Sell/Marketing/V1/ApiException.php | 2 +- src/Sell/Marketing/V1/Configuration.php | 6 +- src/Sell/Marketing/V1/HeaderSelector.php | 2 +- src/Sell/Marketing/V1/Model/Ad.php | 2 +- src/Sell/Marketing/V1/Model/AdGroup.php | 2 +- .../Model/AdGroupPagedCollectionResponse.php | 2 +- src/Sell/Marketing/V1/Model/AdIds.php | 2 +- .../V1/Model/AdPagedCollectionResponse.php | 2 +- src/Sell/Marketing/V1/Model/AdReference.php | 2 +- src/Sell/Marketing/V1/Model/AdReferences.php | 2 +- src/Sell/Marketing/V1/Model/AdResponse.php | 2 +- .../Marketing/V1/Model/AdUpdateResponse.php | 2 +- .../AdUpdateStatusByListingIdResponse.php | 2 +- .../V1/Model/AdUpdateStatusResponse.php | 2 +- .../Marketing/V1/Model/AdditionalInfo.php | 2 +- .../Marketing/V1/Model/AdditionalInfoData.php | 2 +- src/Sell/Marketing/V1/Model/Ads.php | 2 +- src/Sell/Marketing/V1/Model/Alert.php | 2 +- src/Sell/Marketing/V1/Model/AlertDetails.php | 2 +- src/Sell/Marketing/V1/Model/Amount.php | 2 +- src/Sell/Marketing/V1/Model/Aspect.php | 2 +- src/Sell/Marketing/V1/Model/BaseResponse.php | 2 +- src/Sell/Marketing/V1/Model/Budget.php | 2 +- src/Sell/Marketing/V1/Model/BudgetRequest.php | 2 +- .../Marketing/V1/Model/BulkAdResponse.php | 2 +- .../V1/Model/BulkAdUpdateResponse.php | 2 +- .../BulkAdUpdateStatusByListingIdResponse.php | 2 +- .../V1/Model/BulkAdUpdateStatusResponse.php | 2 +- .../V1/Model/BulkCreateAdRequest.php | 2 +- ...lkCreateAdsByInventoryReferenceRequest.php | 2 +- ...kCreateAdsByInventoryReferenceResponse.php | 2 +- .../V1/Model/BulkCreateKeywordRequest.php | 2 +- .../V1/Model/BulkCreateKeywordResponse.php | 2 +- .../BulkCreateNegativeKeywordRequest.php | 2 +- .../BulkCreateNegativeKeywordResponse.php | 2 +- .../V1/Model/BulkDeleteAdRequest.php | 2 +- .../V1/Model/BulkDeleteAdResponse.php | 2 +- ...lkDeleteAdsByInventoryReferenceRequest.php | 2 +- ...kDeleteAdsByInventoryReferenceResponse.php | 2 +- .../BulkUpdateAdStatusByListingIdRequest.php | 2 +- .../V1/Model/BulkUpdateAdStatusRequest.php | 2 +- ...kUpdateAdsByInventoryReferenceResponse.php | 2 +- .../V1/Model/BulkUpdateKeywordRequest.php | 2 +- .../V1/Model/BulkUpdateKeywordResponse.php | 2 +- .../BulkUpdateNegativeKeywordRequest.php | 2 +- .../BulkUpdateNegativeKeywordResponse.php | 2 +- src/Sell/Marketing/V1/Model/Campaign.php | 2 +- .../Marketing/V1/Model/CampaignBudget.php | 2 +- .../V1/Model/CampaignBudgetRequest.php | 2 +- .../Marketing/V1/Model/CampaignCriterion.php | 2 +- .../Model/CampaignPagedCollectionResponse.php | 2 +- src/Sell/Marketing/V1/Model/Campaigns.php | 2 +- .../V1/Model/CloneCampaignRequest.php | 2 +- .../V1/Model/CouponConfiguration.php | 2 +- .../V1/Model/CreateAdGroupRequest.php | 2 +- .../Marketing/V1/Model/CreateAdRequest.php | 2 +- .../CreateAdsByInventoryReferenceRequest.php | 2 +- .../CreateAdsByInventoryReferenceResponse.php | 2 +- .../V1/Model/CreateCampaignRequest.php | 2 +- .../V1/Model/CreateKeywordRequest.php | 4 +- .../V1/Model/CreateNegativeKeywordRequest.php | 2 +- .../Marketing/V1/Model/CreateReportTask.php | 4 +- .../Marketing/V1/Model/DeleteAdRequest.php | 2 +- .../Marketing/V1/Model/DeleteAdResponse.php | 2 +- .../DeleteAdsByInventoryReferenceRequest.php | 2 +- .../DeleteAdsByInventoryReferenceResponse.php | 2 +- src/Sell/Marketing/V1/Model/Dimension.php | 2 +- .../V1/Model/DimensionKeyAnnotation.php | 2 +- .../Marketing/V1/Model/DimensionMetadata.php | 2 +- .../Marketing/V1/Model/DiscountBenefit.php | 2 +- src/Sell/Marketing/V1/Model/DiscountRule.php | 2 +- .../V1/Model/DiscountSpecification.php | 2 +- .../V1/Model/DynamicAdRatePreference.php | 2 +- src/Sell/Marketing/V1/Model/Error.php | 2 +- .../Marketing/V1/Model/ErrorParameter.php | 2 +- .../Marketing/V1/Model/FundingStrategy.php | 2 +- .../Marketing/V1/Model/InventoryCriterion.php | 2 +- src/Sell/Marketing/V1/Model/InventoryItem.php | 2 +- .../Marketing/V1/Model/InventoryReference.php | 2 +- src/Sell/Marketing/V1/Model/ItemBasis.php | 2 +- .../Marketing/V1/Model/ItemMarkdownStatus.php | 2 +- .../Marketing/V1/Model/ItemPriceMarkdown.php | 2 +- src/Sell/Marketing/V1/Model/ItemPromotion.php | 2 +- .../V1/Model/ItemPromotionResponse.php | 2 +- .../V1/Model/ItemsPagedCollection.php | 2 +- src/Sell/Marketing/V1/Model/Keyword.php | 4 +- .../Model/KeywordPagedCollectionResponse.php | 2 +- .../Marketing/V1/Model/KeywordRequest.php | 4 +- .../Marketing/V1/Model/KeywordResponse.php | 4 +- src/Sell/Marketing/V1/Model/ListingDetail.php | 4 +- .../Marketing/V1/Model/MetricMetadata.php | 2 +- .../Marketing/V1/Model/ModelInterface.php | 2 +- .../Marketing/V1/Model/NegativeKeyword.php | 2 +- ...NegativeKeywordPagedCollectionResponse.php | 2 +- .../V1/Model/NegativeKeywordResponse.php | 2 +- .../Marketing/V1/Model/PromotionDetail.php | 2 +- .../V1/Model/PromotionReportDetail.php | 2 +- .../V1/Model/PromotionsPagedCollection.php | 2 +- .../Model/PromotionsReportPagedCollection.php | 2 +- src/Sell/Marketing/V1/Model/ProposedBid.php | 2 +- .../Marketing/V1/Model/ReportMetadata.php | 2 +- .../Marketing/V1/Model/ReportMetadatas.php | 2 +- src/Sell/Marketing/V1/Model/ReportTask.php | 2 +- .../V1/Model/ReportTaskPagedCollection.php | 2 +- src/Sell/Marketing/V1/Model/RuleCriteria.php | 2 +- .../V1/Model/SelectedInventoryDiscount.php | 2 +- src/Sell/Marketing/V1/Model/SelectionRule.php | 4 +- src/Sell/Marketing/V1/Model/SuggestedBids.php | 4 +- .../Marketing/V1/Model/SuggestedKeywords.php | 4 +- .../V1/Model/SummaryReportResponse.php | 2 +- .../V1/Model/TargetedAdsPagedCollection.php | 2 +- .../Marketing/V1/Model/TargetedBidRequest.php | 2 +- .../V1/Model/TargetedBidsPagedCollection.php | 2 +- .../V1/Model/TargetedKeywordRequest.php | 4 +- .../Model/TargetedKeywordsPagedCollection.php | 2 +- .../Marketing/V1/Model/TargetingItems.php | 2 +- .../V1/Model/UpdateAdGroupRequest.php | 2 +- .../UpdateAdStatusByListingIdRequest.php | 2 +- .../V1/Model/UpdateAdStatusRequest.php | 2 +- .../V1/Model/UpdateAdrateStrategyRequest.php | 2 +- .../UpdateAdsByInventoryReferenceResponse.php | 2 +- .../V1/Model/UpdateBidPercentageRequest.php | 2 +- .../V1/Model/UpdateCampaignBudgetRequest.php | 2 +- .../UpdateCampaignIdentificationRequest.php | 2 +- .../Model/UpdateKeywordByKeywordIdRequest.php | 2 +- .../V1/Model/UpdateKeywordRequest.php | 2 +- .../V1/Model/UpdateKeywordResponse.php | 2 +- .../Model/UpdateNegativeKeywordIdRequest.php | 2 +- .../V1/Model/UpdateNegativeKeywordRequest.php | 2 +- .../Model/UpdateNegativeKeywordResponse.php | 2 +- src/Sell/Marketing/V1/ObjectSerializer.php | 2 +- src/Sell/Marketing/V1/README.md | 2 +- src/Sell/Marketing/V1/docs/Api/AdApi.md | 4 +- src/Sell/Marketing/V1/docs/Api/AdGroupApi.md | 12 +- .../Marketing/V1/docs/Api/AdReportTaskApi.md | 2 +- src/Sell/Marketing/V1/docs/Api/CampaignApi.md | 4 +- src/Sell/Marketing/V1/docs/Api/KeywordApi.md | 12 +- .../V1/docs/Api/NegativeKeywordApi.md | 12 +- .../V1/docs/Model/CreateKeywordRequest.md | 2 +- .../V1/docs/Model/CreateReportTask.md | 2 +- src/Sell/Marketing/V1/docs/Model/Keyword.md | 2 +- .../Marketing/V1/docs/Model/KeywordRequest.md | 2 +- .../V1/docs/Model/KeywordResponse.md | 2 +- .../Marketing/V1/docs/Model/ListingDetail.md | 2 +- .../Marketing/V1/docs/Model/SelectionRule.md | 2 +- .../Marketing/V1/docs/Model/SuggestedBids.md | 2 +- .../V1/docs/Model/SuggestedKeywords.md | 2 +- .../V1/docs/Model/TargetedKeywordRequest.md | 2 +- src/Sell/Metadata/V1/Configuration.php | 2 +- src/Sell/Negotiation/V1/Configuration.php | 2 +- src/Sell/Recommendation/V1/Configuration.php | 2 +- 788 files changed, 33298 insertions(+), 15543 deletions(-) create mode 100644 api-specs/developer_client_registration_v1_oas3.yaml create mode 100644 api-specs/developer_key_management_v1_oas3.yaml delete mode 100644 src/Commerce/Identity/V1/.openapi-generator/FILES delete mode 100644 src/Commerce/Identity/V1/README.md delete mode 100644 src/Commerce/Identity/V1/composer.json delete mode 100644 src/Commerce/Identity/V1/docs/Api/UserApi.md delete mode 100644 src/Commerce/Identity/V1/docs/Model/Address.md delete mode 100644 src/Commerce/Identity/V1/docs/Model/BusinessAccount.md delete mode 100644 src/Commerce/Identity/V1/docs/Model/IndividualAccount.md delete mode 100644 src/Commerce/Identity/V1/docs/Model/Phone.md delete mode 100644 src/Commerce/Identity/V1/docs/Model/UserResponse.md rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/.gitignore (100%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/.openapi-generator-ignore (100%) create mode 100644 src/Developer/ClientRegistration/V1/.openapi-generator/FILES rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/.openapi-generator/VERSION (100%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/.php_cs (100%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/.travis.yml (100%) create mode 100644 src/Developer/ClientRegistration/V1/Api/RegisterApi.php rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/ApiException.php (81%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/Configuration.php (90%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/HeaderSelector.php (80%) create mode 100644 src/Developer/ClientRegistration/V1/Model/ClientDetails.php rename src/{Commerce/Identity/V1/Model/UserResponse.php => Developer/ClientRegistration/V1/Model/ClientSettings.php} (52%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/Model/Error.php (90%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/Model/ErrorParameter.php (89%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/Model/ModelInterface.php (76%) rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/ObjectSerializer.php (94%) create mode 100644 src/Developer/ClientRegistration/V1/README.md create mode 100644 src/Developer/ClientRegistration/V1/composer.json create mode 100644 src/Developer/ClientRegistration/V1/docs/Api/RegisterApi.md create mode 100644 src/Developer/ClientRegistration/V1/docs/Model/ClientDetails.md create mode 100644 src/Developer/ClientRegistration/V1/docs/Model/ClientSettings.md create mode 100644 src/Developer/ClientRegistration/V1/docs/Model/Error.md rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/docs/Model/ErrorParameter.md (100%) create mode 100644 src/Developer/ClientRegistration/V1/git_push.sh rename src/{Commerce/Identity => Developer/ClientRegistration}/V1/phpunit.xml.dist (100%) create mode 100644 src/Developer/KeyManagement/V1/.gitignore create mode 100644 src/Developer/KeyManagement/V1/.openapi-generator-ignore create mode 100644 src/Developer/KeyManagement/V1/.openapi-generator/FILES create mode 100644 src/Developer/KeyManagement/V1/.openapi-generator/VERSION create mode 100644 src/Developer/KeyManagement/V1/.php_cs create mode 100644 src/Developer/KeyManagement/V1/.travis.yml create mode 100644 src/Developer/KeyManagement/V1/Api/SigningKeyApi.php create mode 100644 src/Developer/KeyManagement/V1/ApiException.php create mode 100644 src/Developer/KeyManagement/V1/Configuration.php create mode 100644 src/Developer/KeyManagement/V1/HeaderSelector.php create mode 100644 src/Developer/KeyManagement/V1/Model/CreateSigningKeyRequest.php create mode 100644 src/Developer/KeyManagement/V1/Model/Error.php create mode 100644 src/Developer/KeyManagement/V1/Model/ErrorParameter.php create mode 100644 src/Developer/KeyManagement/V1/Model/ModelInterface.php create mode 100644 src/Developer/KeyManagement/V1/Model/QuerySigningKeysResponse.php create mode 100644 src/Developer/KeyManagement/V1/Model/SigningKey.php create mode 100644 src/Developer/KeyManagement/V1/ObjectSerializer.php create mode 100644 src/Developer/KeyManagement/V1/README.md create mode 100644 src/Developer/KeyManagement/V1/composer.json create mode 100644 src/Developer/KeyManagement/V1/docs/Api/SigningKeyApi.md create mode 100644 src/Developer/KeyManagement/V1/docs/Model/CreateSigningKeyRequest.md rename src/{Commerce/Identity => Developer/KeyManagement}/V1/docs/Model/Error.md (83%) rename src/{Commerce/Identity/V1/docs/Model/Contact.md => Developer/KeyManagement/V1/docs/Model/ErrorParameter.md} (58%) create mode 100644 src/Developer/KeyManagement/V1/docs/Model/QuerySigningKeysResponse.md create mode 100644 src/Developer/KeyManagement/V1/docs/Model/SigningKey.md rename src/{Commerce/Identity => Developer/KeyManagement}/V1/git_push.sh (97%) create mode 100644 src/Developer/KeyManagement/V1/phpunit.xml.dist create mode 100644 src/Sell/Account/V1/Api/CountryApi.php create mode 100644 src/Sell/Account/V1/Api/LocationApi.php rename src/{Commerce/Identity/V1/Api/UserApi.php => Sell/Account/V1/Api/SubscriptionApi.php} (71%) rename src/{Commerce/Identity => Sell/Account}/V1/Model/Address.php (75%) create mode 100644 src/Sell/Account/V1/Model/GeoCoordinates.php rename src/{Commerce/Identity/V1/Model/Phone.php => Sell/Account/V1/Model/Interval.php} (71%) create mode 100644 src/Sell/Account/V1/Model/InventoryLocation.php create mode 100644 src/Sell/Account/V1/Model/InventoryLocationFull.php create mode 100644 src/Sell/Account/V1/Model/InventoryLocationResponse.php create mode 100644 src/Sell/Account/V1/Model/Location.php create mode 100644 src/Sell/Account/V1/Model/LocationDetails.php rename src/{Commerce/Identity/V1/Model/BusinessAccount.php => Sell/Account/V1/Model/LocationResponse.php} (55%) create mode 100644 src/Sell/Account/V1/Model/OperatingHours.php rename src/{Commerce/Identity/V1/Model/Contact.php => Sell/Account/V1/Model/SalesTaxJurisdiction.php} (75%) rename src/{Developer/AnalyticsBeta/V1/Model/InlineResponse500.php => Sell/Account/V1/Model/SalesTaxJurisdictions.php} (74%) create mode 100644 src/Sell/Account/V1/Model/SpecialHours.php rename src/{Commerce/Identity/V1/Model/IndividualAccount.php => Sell/Account/V1/Model/Subscription.php} (60%) create mode 100644 src/Sell/Account/V1/Model/SubscriptionResponse.php create mode 100644 src/Sell/Account/V1/docs/Api/CountryApi.md create mode 100644 src/Sell/Account/V1/docs/Api/LocationApi.md create mode 100644 src/Sell/Account/V1/docs/Api/SubscriptionApi.md create mode 100644 src/Sell/Account/V1/docs/Model/Address.md create mode 100644 src/Sell/Account/V1/docs/Model/GeoCoordinates.md create mode 100644 src/Sell/Account/V1/docs/Model/Interval.md create mode 100644 src/Sell/Account/V1/docs/Model/InventoryLocation.md create mode 100644 src/Sell/Account/V1/docs/Model/InventoryLocationFull.md create mode 100644 src/Sell/Account/V1/docs/Model/InventoryLocationResponse.md create mode 100644 src/Sell/Account/V1/docs/Model/Location.md create mode 100644 src/Sell/Account/V1/docs/Model/LocationDetails.md create mode 100644 src/Sell/Account/V1/docs/Model/LocationResponse.md create mode 100644 src/Sell/Account/V1/docs/Model/OperatingHours.md create mode 100644 src/Sell/Account/V1/docs/Model/SalesTaxJurisdiction.md create mode 100644 src/Sell/Account/V1/docs/Model/SalesTaxJurisdictions.md create mode 100644 src/Sell/Account/V1/docs/Model/SpecialHours.md create mode 100644 src/Sell/Account/V1/docs/Model/Subscription.md create mode 100644 src/Sell/Account/V1/docs/Model/SubscriptionResponse.md create mode 100644 src/Sell/Fulfillment/V1/Model/EbayCollectedCharges.php create mode 100644 src/Sell/Fulfillment/V1/Model/EbayInternationalShipping.php create mode 100644 src/Sell/Fulfillment/V1/Model/EbayShipping.php rename src/{Developer/AnalyticsBeta/V1/docs/Model/InlineResponse500.md => Sell/Fulfillment/V1/docs/Model/EbayCollectedCharges.md} (66%) create mode 100644 src/Sell/Fulfillment/V1/docs/Model/EbayInternationalShipping.md create mode 100644 src/Sell/Fulfillment/V1/docs/Model/EbayShipping.md diff --git a/api-specs/buy_browse_v1_oas3.yaml b/api-specs/buy_browse_v1_oas3.yaml index 504b0b61..39ab55ed 100644 --- a/api-specs/buy_browse_v1_oas3.yaml +++ b/api-specs/buy_browse_v1_oas3.yaml @@ -7,7 +7,7 @@ info: license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement - version: v1.16.0 + version: v1.18.0 servers: - url: https://api.ebay.com{basePath} description: Production @@ -24,7 +24,7 @@ paths: parameters: - name: aspect_filter in: query - description: 'This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

For example, the method below uses the category ID for Women''s Clothing. This will return only items for a woman''s red shirt.

/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}

To get a list of the aspects pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS.

/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTS

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter' + description: This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.

/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}

To get a list of the aspect pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS.

/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTS

Note: The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter.

The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:

/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed\|Stü|Nike}

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter required: false schema: type: string @@ -1606,8 +1606,11 @@ components: properties: categoryId: type: string - description: The unique identifier of the primary item category of the item, as well as the secondary item category if item was listed in two categories. - description: This type is used by the categories container in the response of the search method, and contains the primary item category ID of the item, as well as the secondary item category if the item was listed in two categories. + description: The unique identifier of the category. + categoryName: + type: string + description: The name of the category. + description: This type is used by the categories container in the response of the search method, and contains the name and ID of the item category. CategoryDistribution: type: object properties: @@ -2411,7 +2414,7 @@ components: type: string categories: type: array - description: 'This container returns the primary category ID of the item (as well as the secondary category if the item was listed in two categories). ' + description: This array returns the name and ID of each category associated with the item, including top level, branch, and leaf categories. items: $ref: '#/components/schemas/Category' compatibilityMatch: @@ -2470,6 +2473,11 @@ components: itemWebUrl: type: string description: The URL to the View Item page of the item. This enables you to include a "Report Item on eBay" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. + leafCategoryIds: + type: array + description: The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary. + items: + type: string legacyItemId: type: string description: The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page. @@ -2983,7 +2991,7 @@ components: description: The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.

This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. fulfilledThrough: type: string - description: If the item is being shipped by eBay's Global Shipping Program, this field returns GLOBAL_SHIPPING. Otherwise this field is null. For implementation help, refer to eBay API documentation + description: If the item is being shipped by the eBay Global Shipping program, this field returns GLOBAL_SHIPPING.

If the item is being shipped using the eBay International Shipping program, this field returns INTERNATIONAL_SHIPPING.

Otherwise, this field is null. For implementation help, refer to eBay API documentation guaranteedDelivery: type: boolean description: Indicates if the seller has committed to shipping the item with eBay Guaranteed Delivery. With eBay Guaranteed Delivery, the seller is committed to getting the line item to the buyer within 4 business days or less. See the Buying items with eBay Guaranteed Delivery help topic for more details about eBay Guaranteed Delivery. diff --git a/api-specs/buy_feed_v1_beta_oas3.yaml b/api-specs/buy_feed_v1_beta_oas3.yaml index af0bbd32..24fc8437 100644 --- a/api-specs/buy_feed_v1_beta_oas3.yaml +++ b/api-specs/buy_feed_v1_beta_oas3.yaml @@ -19,7 +19,7 @@ paths: get: tags: - item - description: '

This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.

There are two types of item feed files generated:

Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future.

URLs for this method

Downloading feed files

Item feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file.

In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.

Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

' + description: '

This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.

There are two types of item feed files generated:

Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future.

URLs for this method

Downloading feed files

Item feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file.

In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.

Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

' operationId: getItemFeed parameters: - name: Accept @@ -92,7 +92,7 @@ paths: schema: $ref: '#/components/schemas/ItemResponse' '400': - description: Bad Request + description: Bad request x-response-codes: errors: '13000': @@ -269,7 +269,7 @@ paths: schema: $ref: '#/components/schemas/ItemGroupResponse' '400': - description: Bad Request + description: Bad request x-response-codes: errors: '13000': @@ -359,7 +359,7 @@ paths: '416': description: Range not satisfiable '500': - description: Internal Server Error + description: Internal server error x-response-codes: errors: '13006': @@ -440,7 +440,7 @@ paths: schema: $ref: '#/components/schemas/ItemSnapshotResponse' '400': - description: Bad Request + description: Bad request x-response-codes: errors: '13000': @@ -522,7 +522,7 @@ paths: '416': description: Range not satisfiable '500': - description: Internal Server Error + description: Internal server error x-response-codes: errors: '13006': @@ -603,7 +603,7 @@ paths: schema: $ref: '#/components/schemas/ItemPriorityResponse' '400': - description: Bad Request + description: Bad request x-response-codes: errors: '13000': @@ -689,7 +689,7 @@ paths: category: REQUEST description: The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call. '500': - description: Internal server error + description: Internal Server Error x-response-codes: errors: '13006': diff --git a/api-specs/buy_feed_v1_oas3.yaml b/api-specs/buy_feed_v1_oas3.yaml index 0c5e197a..de78c8c3 100644 --- a/api-specs/buy_feed_v1_oas3.yaml +++ b/api-specs/buy_feed_v1_oas3.yaml @@ -7,7 +7,7 @@ info: license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement - version: v1.0.1 + version: v1.0.2 servers: - url: https://api.ebay.com{basePath} description: Production diff --git a/api-specs/buy_order_v2_oas3.yaml b/api-specs/buy_order_v2_oas3.yaml index 9e75d6a6..7b172771 100644 --- a/api-specs/buy_order_v2_oas3.yaml +++ b/api-specs/buy_order_v2_oas3.yaml @@ -1,1544 +1,2256 @@ -openapi: 3.0.0 +--- +openapi: "3.0.0" info: - title: Order API - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Note: This is a Limited Release(Limited Release) API available only to select developers approved by business units.

The Order API provides interfaces that let shoppers pay for items. It also returns payment and shipping status of the order. + title: "Order API" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

Note: This is a \"Limited(Limited\ + \ Release) API available only to select developers approved by business units.
The Order API provides interfaces that let shoppers pay for items. It\ + \ also returns payment and shipping status of the order." contact: - name: eBay Inc, + name: "eBay Inc," license: - name: eBay API License Agreement - url: https://go.developer.ebay.com/api-license-agreement - version: v2.1.0 + name: "eBay API License Agreement" + url: "https://go.developer.ebay.com/api-license-agreement" + version: "v2.1.0" servers: - - url: https://apix.ebay.com{basePath} - description: Production - variables: - basePath: - default: /buy/order/v2 - - url: https://api.ebay.com{basePath} - description: Production - variables: - basePath: - default: /buy/order/v2 +- url: "https://apix.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/buy/order/v2" +- url: "https://api.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/buy/order/v2" paths: /guest_checkout_session/{checkoutSessionId}/apply_coupon: post: tags: - - guest_checkout_session - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method adds a coupon to an eBay guest checkout session and applies it to all the eligible items in the order.

The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is in the payload and is also required.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are: - operationId: applyGuestCoupon + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method adds a coupon to an eBay guest\ + \ checkout session and applies it to all the eligible items in the order.
The checkoutSessionId is passed in as a URI parameter and\ + \ is required. The redemption code of the coupon is in the payload and is\ + \ also required.

For a list of supported sites and other restrictions,\ + \ see API Restrictions\ + \ in the Order API overview.

The URLs for this method are:
  • Production\ + \ URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/apply_coupon
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/apply_coupon
" + operationId: "applyGuestCoupon" parameters: - - name: checkoutSessionId - in: path - description: The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details. - required: true - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "checkoutSessionId" + in: "path" + description: "The eBay-assigned session ID, for a specific eBay marketplace,\ + \ that is returned by the initiateGuestCheckoutSession method.
Note: When using this ID, the\ + \ X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as\ + \ that used when this guest checkout session was created. See Checkout session\ + \ restrictions in the Buy Integration Guide for details." + required: true + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" requestBody: - description: The container for the fields used to apply a coupon to a guest checkout session. + description: "The container for the fields used to apply a coupon to a guest\ + \ checkout session." content: application/json: schema: - description: The container for the fields used to apply a coupon to a guest checkout session. - $ref: '#/components/schemas/CouponRequest' + description: "The container for the fields used to apply a coupon to\ + \ a guest checkout session." + $ref: "#/components/schemas/CouponRequest" required: false responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' - '400': - description: Bad Request + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" + 400: + description: "Bad Request" x-response-codes: errors: - '15001': - domain: API_ORDER - category: REQUEST - description: 'Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.' - '15002': - domain: API_ORDER - category: REQUEST - description: 'Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.' - '15003': - domain: API_ORDER - category: REQUEST - description: The checkout session requested does not exist. - '15025': - domain: API_ORDER - category: REQUEST - description: The App is not authorized to access this resource. - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '15032': - domain: API_ORDER - category: REQUEST - description: After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call. - '16002': - domain: API_ORDER - category: REQUEST - description: The coupon does not exist. The coupon was ignored and no discount was applied to this order. - '16003': - domain: API_ORDER - category: REQUEST - description: The coupon has expired. No discount was applied to this order. - '16004': - domain: API_ORDER - category: REQUEST - description: The coupon has not been activated. The coupon was ignored and no discount was applied to this order. - '16006': - domain: API_ORDER - category: REQUEST - description: The coupon code is invalid. The coupon was ignored and no discount was applied to this order. - '16022': - domain: API_ORDER - category: REQUEST - description: The coupon code is invalid. The coupon was ignored and no discount was applied to this order. - '16024': - domain: API_ORDER - category: REQUEST - description: The coupon provided could not be applied. You may proceed with this session or provide another coupon. - '403': - description: Access Forbidden - '404': - description: Resource Not Found - '409': - description: Conflict + 15025: + domain: "API_ORDER" + category: "REQUEST" + description: "The App is not authorized to access this resource." + 16002: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon does not exist. The coupon was ignored and\ + \ no discount was applied to this order." + 16003: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon has expired. No discount was applied to this\ + \ order." + 16004: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon has not been activated. The coupon was ignored\ + \ and no discount was applied to this order." + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 16006: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon code is invalid. The coupon was ignored and\ + \ no discount was applied to this order." + 16022: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon code is invalid. The coupon was ignored and\ + \ no discount was applied to this order." + 15032: + domain: "API_ORDER" + category: "REQUEST" + description: "After using the 'initiateGuestPayment' call, you cannot\ + \ make changes to the cart. If you need to change the cart, you\ + \ must start over using the 'initiateGuestCheckoutSession' call." + 16024: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon provided could not be applied. You may proceed\ + \ with this session or provide another coupon." + 15001: + domain: "API_ORDER" + category: "REQUEST" + description: "Missing field: {fieldName}. The indicated field is required\ + \ for this request. Add the field and resubmit the call." + 15002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid field: {fieldName}. The indicated field contains\ + \ an invalid value. Correct the value and resubmit the call." + 15003: + domain: "API_ORDER" + category: "REQUEST" + description: "The checkout session requested does not exist." + 500: + description: "Internal Error" x-response-codes: errors: - '15019': - domain: API_ORDER - category: BUSINESS - description: To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session. - '15021': - domain: API_ORDER - category: BUSINESS - description: This checkout session cannot be updated because the order has already been placed. - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '16000': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for any of the items in the order. The coupon was ignored and no discount was applied to this order. - '16001': - domain: API_ORDER - category: BUSINESS - description: You cannot apply multiple coupons to the same order. No discount was applied to this order. - '16005': - domain: API_ORDER - category: BUSINESS - description: The coupon requires the buyer to spend a specific monetary amount. This threshold has not been met. The coupon was ignored and no discount was applied to this order. - '16007': - domain: API_ORDER - category: BUSINESS - description: This coupon has already been used. The coupon was ignored and no discount was applied to this order. - '16008': - domain: API_ORDER - category: BUSINESS - description: This coupon is no longer valid. The coupon was ignored and no discount was applied to this order. - '16009': - domain: API_ORDER - category: BUSINESS - description: The coupon requires the buyer to spend a specific monetary amount. This threshold has not been met. The coupon was ignored and no discount was applied to this order. - '16010': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for the currency being used by the items. The coupon was ignored and no discount was applied to this order. - '16012': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for the {fieldName}. The coupon was ignored and no discount was applied to this order. - '16013': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for any of the item categories in the order. The coupon was ignored and no discount was applied to this order. - '16014': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for the selected payment method. The coupon was ignored and no discount was applied to this order. - '16015': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for the selected shipping option. The coupon was ignored and no discount was applied to this order. - '16016': - domain: API_ORDER - category: BUSINESS - description: The coupon is valid only for items that are shipped domestically. The coupon was ignored and no discount was applied to this order. - '16017': - domain: API_ORDER - category: BUSINESS - description: The coupon is valid only for items that are shipped internationally. The coupon was ignored and no discount was applied to this order. - '16018': - domain: API_ORDER - category: BUSINESS - description: The buyer is not eligible for this coupon. The coupon was ignored and no discount was applied to this order. - '16019': - domain: API_ORDER - category: BUSINESS - description: The coupon is not valid for guest eBay checkouts. The coupon was ignored and no discount was applied to this order. - '16023': - domain: API_ORDER - category: BUSINESS - description: You cannot apply multiple coupons to the same order. The coupon was ignored and no discount was applied to this order. - '500': - description: Internal Server Error + 16020: + domain: "API_ORDER" + category: "APPLICATION" + description: "Your application is not eligible for this coupon. The\ + \ coupon was ignored and no discount was applied to this order." + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. - '16020': - domain: API_ORDER - category: APPLICATION - description: Your application is not eligible for this coupon. The coupon was ignored and no discount was applied to this order. + 16000: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for any of the items in the\ + \ order. The coupon was ignored and no discount was applied to this\ + \ order." + 16001: + domain: "API_ORDER" + category: "BUSINESS" + description: "You cannot apply multiple coupons to the same order.\ + \ No discount was applied to this order." + 16005: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon requires the buyer to spend a specific monetary\ + \ amount. This threshold has not been met. The coupon was ignored\ + \ and no discount was applied to this order." + 16007: + domain: "API_ORDER" + category: "BUSINESS" + description: "This coupon has already been used. The coupon was ignored\ + \ and no discount was applied to this order." + 16008: + domain: "API_ORDER" + category: "BUSINESS" + description: "This coupon is no longer valid. The coupon was ignored\ + \ and no discount was applied to this order." + 16009: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon requires the buyer to spend a specific monetary\ + \ amount. This threshold has not been met. The coupon was ignored\ + \ and no discount was applied to this order." + 16010: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for the currency being used\ + \ by the items. The coupon was ignored and no discount was applied\ + \ to this order." + 15019: + domain: "API_ORDER" + category: "BUSINESS" + description: "To place an order, you must have at least one line item.\ + \ Use the initiateCheckoutSession call to add line items (maximum\ + \ of {maxLineItems}) and create a new checkout session." + 16012: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for the {fieldName}. The coupon\ + \ was ignored and no discount was applied to this order." + 15021: + domain: "API_ORDER" + category: "BUSINESS" + description: "This checkout session cannot be updated because the\ + \ order has already been placed." + 16013: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for any of the item categories\ + \ in the order. The coupon was ignored and no discount was applied\ + \ to this order." + 16014: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for the selected payment method.\ + \ The coupon was ignored and no discount was applied to this order." + 16015: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for the selected shipping option.\ + \ The coupon was ignored and no discount was applied to this order." + 16016: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is valid only for items that are shipped\ + \ domestically. The coupon was ignored and no discount was applied\ + \ to this order." + 16017: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is valid only for items that are shipped\ + \ internationally. The coupon was ignored and no discount was applied\ + \ to this order." + 16018: + domain: "API_ORDER" + category: "BUSINESS" + description: "The buyer is not eligible for this coupon. The coupon\ + \ was ignored and no discount was applied to this order." + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." + 16019: + domain: "API_ORDER" + category: "BUSINESS" + description: "The coupon is not valid for guest eBay checkouts. The\ + \ coupon was ignored and no discount was applied to this order." + 16023: + domain: "API_ORDER" + category: "BUSINESS" + description: "You cannot apply multiple coupons to the same order.\ + \ The coupon was ignored and no discount was applied to this order." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_checkout_session/{checkoutSessionId}: get: tags: - - guest_checkout_session - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method returns the details of the specified guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. This method has no request payload.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}
- operationId: getGuestCheckoutSession + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method returns the details of the specified\ + \ guest checkout session. The checkoutSessionId is passed in as a URI\ + \ parameter and is required. This method has no request payload.
For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this\ + \ method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}
" + operationId: "getGuestCheckoutSession" parameters: - - name: checkoutSessionId - in: path - description: The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details. - required: true - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "checkoutSessionId" + in: "path" + description: "The eBay-assigned session ID, for a specific eBay marketplace,\ + \ that is returned by the initiateGuestCheckoutSession method.
Note: When using this ID, the\ + \ X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as\ + \ that used when this guest checkout session was created. See Checkout session\ + \ restrictions in the Buy Integration Guide for details." + required: true + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" x-response-codes: errors: - '20000': - domain: API_ORDER - category: BUSINESS - description: This order contains the item {itemId} that may be subject to certain importation permitting/licensing requirements. Please check applicable regulations for specific import restrictions in your country. - '20001': - domain: API_ORDER - category: BUSINESS - description: This item {itemId} ships via a freight carrier. For information regarding shipping, tracking, delivery, etc. check with the seller. - '400': - description: Bad Request + 20000: + domain: "API_ORDER" + category: "BUSINESS" + description: "This order contains the item {itemId} that may be subject\ + \ to certain importation permitting/licensing requirements. Please\ + \ check applicable regulations for specific import restrictions\ + \ in your country." + 20001: + domain: "API_ORDER" + category: "BUSINESS" + description: "This item {itemId} ships via a freight carrier. For\ + \ information regarding shipping, tracking, delivery, etc. check\ + \ with the seller." + 400: + description: "Bad Request" x-response-codes: errors: - '15003': - domain: API_ORDER - category: REQUEST - description: The checkout session requested does not exist. - '15025': - domain: API_ORDER - category: REQUEST - description: The App is not authorized to access this resource. - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '403': - description: Access Forbidden - '404': - description: Resource Not Found - '409': - description: Conflict + 15025: + domain: "API_ORDER" + category: "REQUEST" + description: "The App is not authorized to access this resource." + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 15003: + domain: "API_ORDER" + category: "REQUEST" + description: "The checkout session requested does not exist." + 500: + description: "Internal Error" x-response-codes: errors: - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '500': - description: Internal Server Error + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_checkout_session/initiate: post: tags: - - guest_checkout_session - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method creates an eBay guest checkout session, which is the first step in performing a checkout. The method returns a checkoutSessionId that you use as a URI parameter in subsequent guest checkout methods.

Also see Negative Testing Using Stubs for information on how to emulate error conditions for this method using stubs.

TIP: To test the entire checkout flow, you might need a "test" credit card. You can generate a credit card number from http://www.getcreditcardnumbers.com.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/initiate
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/initiate
- operationId: initiateGuestCheckoutSession + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method creates an eBay guest checkout\ + \ session, which is the first step in performing a checkout. The method returns\ + \ a checkoutSessionId that you use as a URI parameter in subsequent\ + \ guest checkout methods.

Also see Negative Testing Using Stubs for information on how to emulate error\ + \ conditions for this method using stubs.

TIP: To test the entire checkout flow,\ + \ you might need a \"test\" credit card. You can generate a credit card number\ + \ from http://www.getcreditcardnumbers.com.
For a list of supported sites and other restrictions, see API Restrictions in the Order\ + \ API overview.

The URLs for this method are:
  • Production\ + \ URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/initiate
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/initiate
" + operationId: "initiateGuestCheckoutSession" parameters: - - name: X-EBAY-C-ENDUSERCTX - in: header - description: A header that is used to specify the affiliateCampaignId, and optionally the affiliateReferenceId, to enable revenue sharing when the buyer purchases items.

TIP: See Request headers in the Buying Integration Guide for more information. - required: false - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "X-EBAY-C-ENDUSERCTX" + in: "header" + description: "A header that is used to specify the affiliateCampaignId,\ + \ and optionally the affiliateReferenceId, to enable revenue sharing\ + \ when the buyer purchases items.

TIP: See Request headers in the Buying Integration Guide\ + \ for more information." + required: false + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" requestBody: - description: The container for the fields used by the initiateGuestCheckoutSession method. + description: "The container for the fields used by the initiateGuestCheckoutSession\ + \ method." content: application/json: schema: - description: The container for the fields used by the initiateGuestCheckoutSession method. - $ref: '#/components/schemas/CreateGuestCheckoutSessionRequestV2' + description: "The container for the fields used by the initiateGuestCheckoutSession\ + \ method." + $ref: "#/components/schemas/CreateGuestCheckoutSessionRequestV2" required: false responses: - '200': - description: OK + 200: + description: "OK" headers: X-EBAY-SECURITY-SIGNATURE: schema: - type: string - description: A token that is used to launch the Checkout with eBay widget. + type: "string" + description: "A token that is used to launch the Checkout with eBay\ + \ widget." content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" x-response-codes: errors: - '15007': - domain: API_ORDER - category: REQUEST - description: The address provided may be incorrect. You may proceed with this address or provide a correct address. - '15043': - domain: API_ORDER - category: BUSINESS - description: The item {itemId} cannot be purchased using this API and has been removed from the cart. The purchase can be done on ebay.com. - '15055': - domain: API_ORDER - category: BUSINESS - description: The item is removed due to one or more reasons (out of stock, the desired quantity exceeds the quantity available, etc). - '20000': - domain: API_ORDER - category: BUSINESS - description: This order contains the item {itemId} that may be subject to certain importation permitting/licensing requirements. Please check applicable regulations for specific import restrictions in your country. - '20001': - domain: API_ORDER - category: BUSINESS - description: This item {itemId} ships via a freight carrier. For information regarding shipping, tracking, delivery, etc. check with the seller. - '400': - description: Bad Request + 20000: + domain: "API_ORDER" + category: "BUSINESS" + description: "This order contains the item {itemId} that may be subject\ + \ to certain importation permitting/licensing requirements. Please\ + \ check applicable regulations for specific import restrictions\ + \ in your country." + 20001: + domain: "API_ORDER" + category: "BUSINESS" + description: "This item {itemId} ships via a freight carrier. For\ + \ information regarding shipping, tracking, delivery, etc. check\ + \ with the seller." + 15043: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item {itemId} cannot be purchased using this API\ + \ and has been removed from the cart. The purchase can be done on\ + \ ebay.com." + 15007: + domain: "API_ORDER" + category: "REQUEST" + description: "The address provided may be incorrect. You may proceed\ + \ with this address or provide a correct address." + 15055: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is removed due to one or more reasons (out\ + \ of stock, the desired quantity exceeds the quantity available,\ + \ etc)." + 400: + description: "Bad Request" x-response-codes: errors: - '15001': - domain: API_ORDER - category: REQUEST - description: 'Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.' - '15002': - domain: API_ORDER - category: REQUEST - description: 'Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.' - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '15048': - domain: API_ORDER - category: REQUEST - description: The value of {fieldName} is too long. For more information, see the documentation for this call. - '17002': - domain: API_ORDER - category: REQUEST - description: Invalid character(s) found in the shipping address. Please check name and shipping address fields, remove invalid character(s) and resubmit the call. - '409': - description: Conflict + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 15048: + domain: "API_ORDER" + category: "REQUEST" + description: "The value of {fieldName} is too long. For more information,\ + \ see the documentation for this call." + 15001: + domain: "API_ORDER" + category: "REQUEST" + description: "Missing field: {fieldName}. The indicated field is required\ + \ for this request. Add the field and resubmit the call." + 15002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid field: {fieldName}. The indicated field contains\ + \ an invalid value. Correct the value and resubmit the call." + 17002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid character(s) found in the shipping address.\ + \ Please check name and shipping address fields, remove invalid\ + \ character(s) and resubmit the call." + 500: + description: "Internal Server Error" x-response-codes: errors: - '15011': - domain: API_ORDER - category: BUSINESS - description: You have exceeded the maximum number of {maxLineItems} line items. Correct the request and resubmit the call. - '15012': - domain: API_ORDER - category: BUSINESS - description: There is a limit on the quantity of this item that can be purchased. Reduce the quantity and resubmit the call. - '15013': - domain: API_ORDER - category: BUSINESS - description: The item is either out of stock, or the desired quantity exceeds the quantity available. If out of stock, please wait for seller to restock. If desired quantity exceeds available quantity, please reduce the quantity value and try again. - '15014': - domain: API_ORDER - category: BUSINESS - description: The quantity submitted for this item is invalid. Correct the quantity value and resubmit the call. - '15015': - domain: API_ORDER - category: BUSINESS - description: There is a problem with the credit card and it cannot be used to purchase items. Use the updatePaymentInfo call to change the payment information. - '15017': - domain: API_ORDER - category: BUSINESS - description: The payment for the order line items in your cart could not be processed due to issues with one or more sellers. - '15018': - domain: API_ORDER - category: BUSINESS - description: The item is not available for purchase. This can be for several reason such as, the listing has ended, this is an auction item, etc. Remove the item and resubmit the call. - '15019': - domain: API_ORDER - category: BUSINESS - description: To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session. - '15026': - domain: API_ORDER - category: BUSINESS - description: The item is not shippable to the specified shipping address. - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '15028': - domain: API_ORDER - category: BUSINESS - description: The item {itemId} is not available for purchase because it cannot be shipped to {country}. - '15031': - domain: API_ORDER - category: BUSINESS - description: The item is not purchasable because the buyer has been blocked by the seller. - '15044': - domain: API_ORDER - category: BUSINESS - description: At least one of the items in the cart cannot be purchased using this API. The purchase can be done on eBay, through the eBay app or eBay website. - '15045': - domain: API_ORDER - category: BUSINESS - description: The item cannot be purchased because the seller is away and is not processing orders. If you are trying to purchase more than one item, you need to create a new checkout session to purchase the other items. - '15047': - domain: API_ORDER - category: BUSINESS - description: In compliance with applicable economic sanctions and trade restrictions, eBay is unavailable in your location. If you believe you are receiving this notice in error, please contact eBay's Customer Service. - '15053': - domain: API_ORDER - category: BUSINESS - description: Your desired item(s) are not available due to one or more reasons (out of stock, listing is an auction, listing ended, etc). - '20002': - domain: API_ORDER - category: BUSINESS - description: This item {itemId} is currently unavailable to buy from the seller. - '500': - description: Internal Server Error + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 20002: + domain: "API_ORDER" + category: "BUSINESS" + description: "This item {itemId} is currently unavailable to buy from\ + \ the seller." + 15011: + domain: "API_ORDER" + category: "BUSINESS" + description: "You have exceeded the maximum number of {maxLineItems}\ + \ line items. Correct the request and resubmit the call." + 15012: + domain: "API_ORDER" + category: "BUSINESS" + description: "There is a limit on the quantity of this item that can\ + \ be purchased. Reduce the quantity and resubmit the call." + 15044: + domain: "API_ORDER" + category: "BUSINESS" + description: "At least one of the items in the cart cannot be purchased\ + \ using this API. The purchase can be done on eBay, through the\ + \ eBay app or eBay website." + 15013: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is either out of stock, or the desired quantity\ + \ exceeds the quantity available. If out of stock, please wait for\ + \ seller to restock. If desired quantity exceeds available quantity,\ + \ please reduce the quantity value and try again." + 15045: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item cannot be purchased because the seller is away\ + \ and is not processing orders. If you are trying to purchase more\ + \ than one item, you need to create a new checkout session to purchase\ + \ the other items." + 15014: + domain: "API_ORDER" + category: "BUSINESS" + description: "The quantity submitted for this item is invalid. Correct\ + \ the quantity value and resubmit the call." + 15015: + domain: "API_ORDER" + category: "BUSINESS" + description: "There is a problem with the credit card and it cannot\ + \ be used to purchase items. Use the updatePaymentInfo call to change\ + \ the payment information." + 15047: + domain: "API_ORDER" + category: "BUSINESS" + description: "In compliance with applicable economic sanctions and\ + \ trade restrictions, eBay is unavailable in your location. If you\ + \ believe you are receiving this notice in error, please contact\ + \ eBay's Customer Service." + 15017: + domain: "API_ORDER" + category: "BUSINESS" + description: "The payment for the order line items in your cart could\ + \ not be processed due to issues with one or more sellers." + 15018: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is not available for purchase. This can be\ + \ for several reason such as, the listing has ended, this is an\ + \ auction item, etc. Remove the item and resubmit the call." + 15019: + domain: "API_ORDER" + category: "BUSINESS" + description: "To place an order, you must have at least one line item.\ + \ Use the initiateCheckoutSession call to add line items (maximum\ + \ of {maxLineItems}) and create a new checkout session." + 15053: + domain: "API_ORDER" + category: "BUSINESS" + description: "Your desired item(s) are not available due to one or\ + \ more reasons (out of stock, listing is an auction, listing ended,\ + \ etc)." + 15026: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is not shippable to the specified shipping\ + \ address." + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." + 15028: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item {itemId} is not available for purchase because\ + \ it cannot be shipped to {country}." + 15031: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is not purchasable because the buyer has been\ + \ blocked by the seller." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_checkout_session/{checkoutSessionId}/remove_coupon: post: tags: - - guest_checkout_session - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method removes a coupon from an eBay guest checkout session. The checkoutSessionId is passed in as a URI parameter and is required. The redemption code of the coupon is specified in the payload and is also required.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/remove_coupon
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/remove_coupon
- operationId: removeGuestCoupon + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method removes a coupon from an eBay\ + \ guest checkout session. The checkoutSessionId is passed in as a URI\ + \ parameter and is required. The redemption code of the coupon is specified\ + \ in the payload and is also required.

For a list of supported\ + \ sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this\ + \ method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/remove_coupon
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/remove_coupon
" + operationId: "removeGuestCoupon" parameters: - - name: checkoutSessionId - in: path - description: The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details. - required: true - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "checkoutSessionId" + in: "path" + description: "The eBay-assigned session ID, for a specific eBay marketplace,\ + \ that is returned by the initiateGuestCheckoutSession method.
Note: When using this ID, the\ + \ X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as\ + \ that used when this guest checkout session was created. See Checkout session\ + \ restrictions in the Buy Integration Guide for details." + required: true + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" requestBody: - description: The container for the fields used by the removeGuestCoupon method. + description: "The container for the fields used by the removeGuestCoupon\ + \ method." content: application/json: schema: - description: The container for the fields used by the removeGuestCoupon method. - $ref: '#/components/schemas/CouponRequest' + description: "The container for the fields used by the removeGuestCoupon\ + \ method." + $ref: "#/components/schemas/CouponRequest" required: false responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' - '400': - description: Bad Request + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" + 400: + description: "Bad Request" x-response-codes: errors: - '15001': - domain: API_ORDER - category: REQUEST - description: 'Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.' - '15002': - domain: API_ORDER - category: REQUEST - description: 'Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.' - '15003': - domain: API_ORDER - category: REQUEST - description: The checkout session requested does not exist. - '15025': - domain: API_ORDER - category: REQUEST - description: The App is not authorized to access this resource. - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '15032': - domain: API_ORDER - category: REQUEST - description: After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call. - '15033': - domain: API_ORDER - category: REQUEST - description: The payment cannot be processed because the payment information is invalid. You will need to create a new checkout session and submit corrected payment information. - '16025': - domain: API_ORDER - category: REQUEST - description: The coupon was not applied to this cart. - '403': - description: Access Forbidden - '404': - description: Resource Not Found - '409': - description: Conflict + 15025: + domain: "API_ORDER" + category: "REQUEST" + description: "The App is not authorized to access this resource." + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 15032: + domain: "API_ORDER" + category: "REQUEST" + description: "After using the 'initiateGuestPayment' call, you cannot\ + \ make changes to the cart. If you need to change the cart, you\ + \ must start over using the 'initiateGuestCheckoutSession' call." + 15001: + domain: "API_ORDER" + category: "REQUEST" + description: "Missing field: {fieldName}. The indicated field is required\ + \ for this request. Add the field and resubmit the call." + 16025: + domain: "API_ORDER" + category: "REQUEST" + description: "The coupon was not applied to this cart." + 15033: + domain: "API_ORDER" + category: "REQUEST" + description: "The payment cannot be processed because the payment\ + \ information is invalid. You will need to create a new checkout\ + \ session and submit corrected payment information." + 15002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid field: {fieldName}. The indicated field contains\ + \ an invalid value. Correct the value and resubmit the call." + 15003: + domain: "API_ORDER" + category: "REQUEST" + description: "The checkout session requested does not exist." + 500: + description: "Internal Error" x-response-codes: errors: - '15019': - domain: API_ORDER - category: BUSINESS - description: To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session. - '15021': - domain: API_ORDER - category: BUSINESS - description: This checkout session cannot be updated because the order has already been placed. - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '500': - description: Internal Server Error + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." + 15019: + domain: "API_ORDER" + category: "BUSINESS" + description: "To place an order, you must have at least one line item.\ + \ Use the initiateCheckoutSession call to add line items (maximum\ + \ of {maxLineItems}) and create a new checkout session." + 15021: + domain: "API_ORDER" + category: "BUSINESS" + description: "This checkout session cannot be updated because the\ + \ order has already been placed." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_checkout_session/{checkoutSessionId}/update_quantity: post: tags: - - guest_checkout_session - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method changes the quantity of the specified line item in an eBay guest checkout session.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_quantity
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_quantity
- operationId: updateGuestQuantity + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method changes the quantity of the specified\ + \ line item in an eBay guest checkout session.

For a list of supported\ + \ sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this\ + \ method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_quantity
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_quantity
" + operationId: "updateGuestQuantity" parameters: - - name: checkoutSessionId - in: path - description: The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details. - required: true - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "checkoutSessionId" + in: "path" + description: "The eBay-assigned session ID, for a specific eBay marketplace,\ + \ that is returned by the initiateGuestCheckoutSession method.
Note: When using this ID, the\ + \ X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as\ + \ that used when this guest checkout session was created. See Checkout session\ + \ restrictions in the Buy Integration Guide for details." + required: true + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" requestBody: - description: The container for the fields used by the updateGuestQuantity method. + description: "The container for the fields used by the updateGuestQuantity\ + \ method." content: application/json: schema: - description: The container for the fields used by the updateGuestQuantity method. - $ref: '#/components/schemas/UpdateQuantity' + description: "The container for the fields used by the updateGuestQuantity\ + \ method." + $ref: "#/components/schemas/UpdateQuantity" required: false responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' - '400': - description: Bad Request + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" + 400: + description: "Bad Request" x-response-codes: errors: - '15001': - domain: API_ORDER - category: REQUEST - description: 'Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.' - '15002': - domain: API_ORDER - category: REQUEST - description: 'Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.' - '15003': - domain: API_ORDER - category: REQUEST - description: The checkout session requested does not exist. - '15025': - domain: API_ORDER - category: REQUEST - description: The App is not authorized to access this resource. - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '15032': - domain: API_ORDER - category: REQUEST - description: After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call. - '403': - description: Access Forbidden - '404': - description: Resource Not Found - '409': - description: Conflict + 15025: + domain: "API_ORDER" + category: "REQUEST" + description: "The App is not authorized to access this resource." + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 15032: + domain: "API_ORDER" + category: "REQUEST" + description: "After using the 'initiateGuestPayment' call, you cannot\ + \ make changes to the cart. If you need to change the cart, you\ + \ must start over using the 'initiateGuestCheckoutSession' call." + 15001: + domain: "API_ORDER" + category: "REQUEST" + description: "Missing field: {fieldName}. The indicated field is required\ + \ for this request. Add the field and resubmit the call." + 15002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid field: {fieldName}. The indicated field contains\ + \ an invalid value. Correct the value and resubmit the call." + 15003: + domain: "API_ORDER" + category: "REQUEST" + description: "The checkout session requested does not exist." + 500: + description: "Internal Error" x-response-codes: errors: - '15012': - domain: API_ORDER - category: BUSINESS - description: There is a limit on the quantity of this item that can be purchased. Reduce the quantity and resubmit the call. - '15013': - domain: API_ORDER - category: BUSINESS - description: The item is either out of stock, or the desired quantity exceeds the quantity available. If out of stock, please wait for seller to restock. If desired quantity exceeds available quantity, please reduce the quantity value and try again. - '15014': - domain: API_ORDER - category: BUSINESS - description: The quantity submitted for this item is invalid. Correct the quantity value and resubmit the call. - '15019': - domain: API_ORDER - category: BUSINESS - description: To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session. - '15021': - domain: API_ORDER - category: BUSINESS - description: This checkout session cannot be updated because the order has already been placed. - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '15053': - domain: API_ORDER - category: BUSINESS - description: Your desired item(s) are not available due to one or more reasons (out of stock, listing is an auction, listing ended, etc). - '500': - description: Internal Error + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." + 15012: + domain: "API_ORDER" + category: "BUSINESS" + description: "There is a limit on the quantity of this item that can\ + \ be purchased. Reduce the quantity and resubmit the call." + 15013: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is either out of stock, or the desired quantity\ + \ exceeds the quantity available. If out of stock, please wait for\ + \ seller to restock. If desired quantity exceeds available quantity,\ + \ please reduce the quantity value and try again." + 15014: + domain: "API_ORDER" + category: "BUSINESS" + description: "The quantity submitted for this item is invalid. Correct\ + \ the quantity value and resubmit the call." + 15019: + domain: "API_ORDER" + category: "BUSINESS" + description: "To place an order, you must have at least one line item.\ + \ Use the initiateCheckoutSession call to add line items (maximum\ + \ of {maxLineItems}) and create a new checkout session." + 15021: + domain: "API_ORDER" + category: "BUSINESS" + description: "This checkout session cannot be updated because the\ + \ order has already been placed." + 15053: + domain: "API_ORDER" + category: "BUSINESS" + description: "Your desired item(s) are not available due to one or\ + \ more reasons (out of stock, listing is an auction, listing ended,\ + \ etc)." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_checkout_session/{checkoutSessionId}/update_shipping_address: post: tags: - - guest_checkout_session - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method changes the shipping address for the order in an eBay guest checkout session. All the line items in an order must be shipped to the same address, but the shipping method can be specific to the line item.

Note: If the address submitted cannot be validated, a warning message will be returned. This does not prevent the method from executing, but you may want to verify the address.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_address
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_address
- operationId: updateGuestShippingAddress + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method changes the shipping address for\ + \ the order in an eBay guest checkout session. All the line items in an order\ + \ must be shipped to the same address, but the shipping method can be specific\ + \ to the line item.

Note: If the\ + \ address submitted cannot be validated, a warning message will be returned.\ + \ This does not prevent the method from executing, but you may want to verify\ + \ the address.

For a list of supported sites and other restrictions,\ + \ see API Restrictions\ + \ in the Order API overview.

The URLs for this method are:
  • Production\ + \ URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_address
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_address
" + operationId: "updateGuestShippingAddress" parameters: - - name: checkoutSessionId - in: path - description: The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details. - required: true - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "checkoutSessionId" + in: "path" + description: "The eBay-assigned session ID, for a specific eBay marketplace,\ + \ that is returned by the initiateGuestCheckoutSession method.
Note: When using this ID, the\ + \ X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as\ + \ that used when this guest checkout session was created. See Checkout session\ + \ restrictions in the Buy Integration Guide for details." + required: true + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" requestBody: - description: The container for the fields used by the updateGuestShippingAddress method. + description: "The container for the fields used by the updateGuestShippingAddress\ + \ method." content: application/json: schema: - description: The container for the fields used by the updateGuestShippingAddress method. - $ref: '#/components/schemas/ShippingAddressImpl' + description: "The container for the fields used by the updateGuestShippingAddress\ + \ method." + $ref: "#/components/schemas/ShippingAddressImpl" required: false responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" x-response-codes: errors: - '15007': - domain: API_ORDER - category: REQUEST - description: The address provided may be incorrect. You may proceed with this address or provide a correct address. - '400': - description: Bad Request + 15007: + domain: "API_ORDER" + category: "REQUEST" + description: "The address provided may be incorrect. You may proceed\ + \ with this address or provide a correct address." + 400: + description: "Bad Request" x-response-codes: errors: - '15001': - domain: API_ORDER - category: REQUEST - description: 'Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.' - '15002': - domain: API_ORDER - category: REQUEST - description: 'Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.' - '15003': - domain: API_ORDER - category: REQUEST - description: The checkout session requested does not exist. - '15025': - domain: API_ORDER - category: REQUEST - description: The App is not authorized to access this resource. - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '15032': - domain: API_ORDER - category: REQUEST - description: After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call. - '15048': - domain: API_ORDER - category: REQUEST - description: The value of {fieldName} is too long. For more information, see the documentation for this call. - '17002': - domain: API_ORDER - category: REQUEST - description: Invalid character(s) found in the shipping address. Please check name and shipping address fields, remove invalid character(s) and resubmit the call. - '403': - description: Access Forbidden - '404': - description: Resource Not Found - '409': - description: Conflict + 15025: + domain: "API_ORDER" + category: "REQUEST" + description: "The App is not authorized to access this resource." + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 15032: + domain: "API_ORDER" + category: "REQUEST" + description: "After using the 'initiateGuestPayment' call, you cannot\ + \ make changes to the cart. If you need to change the cart, you\ + \ must start over using the 'initiateGuestCheckoutSession' call." + 15048: + domain: "API_ORDER" + category: "REQUEST" + description: "The value of {fieldName} is too long. For more information,\ + \ see the documentation for this call." + 15001: + domain: "API_ORDER" + category: "REQUEST" + description: "Missing field: {fieldName}. The indicated field is required\ + \ for this request. Add the field and resubmit the call." + 15002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid field: {fieldName}. The indicated field contains\ + \ an invalid value. Correct the value and resubmit the call." + 17002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid character(s) found in the shipping address.\ + \ Please check name and shipping address fields, remove invalid\ + \ character(s) and resubmit the call." + 15003: + domain: "API_ORDER" + category: "REQUEST" + description: "The checkout session requested does not exist." + 500: + description: "Internal Server Error" x-response-codes: errors: - '15019': - domain: API_ORDER - category: BUSINESS - description: To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session. - '15021': - domain: API_ORDER - category: BUSINESS - description: This checkout session cannot be updated because the order has already been placed. - '15026': - domain: API_ORDER - category: BUSINESS - description: The item is not shippable to the specified shipping address. - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '15047': - domain: API_ORDER - category: BUSINESS - description: In compliance with applicable economic sanctions and trade restrictions, eBay is unavailable in your location. If you believe you are receiving this notice in error, please contact eBay's Customer Service. - '500': - description: Internal Error + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 15026: + domain: "API_ORDER" + category: "BUSINESS" + description: "The item is not shippable to the specified shipping\ + \ address." + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." + 15047: + domain: "API_ORDER" + category: "BUSINESS" + description: "In compliance with applicable economic sanctions and\ + \ trade restrictions, eBay is unavailable in your location. If you\ + \ believe you are receiving this notice in error, please contact\ + \ eBay's Customer Service." + 15019: + domain: "API_ORDER" + category: "BUSINESS" + description: "To place an order, you must have at least one line item.\ + \ Use the initiateCheckoutSession call to add line items (maximum\ + \ of {maxLineItems}) and create a new checkout session." + 15021: + domain: "API_ORDER" + category: "BUSINESS" + description: "This checkout session cannot be updated because the\ + \ order has already been placed." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_checkout_session/{checkoutSessionId}/update_shipping_option: post: tags: - - guest_checkout_session - description: 'Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method changes the shipping method for the specified line item in an eBay guest checkout session. The shipping option can be set for each line item. This gives the shopper the ability choose the cost of shipping for each line item.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_option
  • Sandbox URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_option
' - operationId: updateGuestShippingOption + - "guest_checkout_session" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method changes the shipping method for\ + \ the specified line item in an eBay guest checkout session. The shipping\ + \ option can be set for each line item. This gives the shopper the ability\ + \ choose the cost of shipping for each line item.

For a list of\ + \ supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this\ + \ method are:
  • Production URL: https://apix.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_option
  • Sandbox\ + \ URL: https://apix.sandbox.ebay.com/buy/order/v2/guest_checkout_session/{checkoutSessionId}/update_shipping_option
    • \ + \
" + operationId: "updateGuestShippingOption" parameters: - - name: checkoutSessionId - in: path - description: The eBay-assigned session ID, for a specific eBay marketplace, that is returned by the initiateGuestCheckoutSession method.

Note: When using this ID, the X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as that used when this guest checkout session was created. See Checkout session restrictions in the Buy Integration Guide for details. - required: true - schema: - type: string - - name: X-EBAY-C-MARKETPLACE-ID - in: header - description: A header that identifies the user's business context and is specified using a marketplace ID value.

Note: This header does not indicate a language preference or consumer location.

See Marketplace ID values for a list of supported values. - required: true - schema: - type: string + - name: "checkoutSessionId" + in: "path" + description: "The eBay-assigned session ID, for a specific eBay marketplace,\ + \ that is returned by the initiateGuestCheckoutSession method.
Note: When using this ID, the\ + \ X-EBAY-C-MARKETPLACE-ID value and developer App ID must be the same as\ + \ that used when this guest checkout session was created. See Checkout session\ + \ restrictions in the Buy Integration Guide for details." + required: true + schema: + type: "string" + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "A header that identifies the user's business context and is\ + \ specified using a marketplace ID value.

Note: This header does not indicate a language preference\ + \ or consumer location.

See Marketplace ID values for a list of supported values." + required: true + schema: + type: "string" requestBody: - description: The container for the fields used by the updateGuestShippingOption method. + description: "The container for the fields used by the updateGuestShippingOption\ + \ method." content: application/json: schema: - description: The container for the fields used by the updateGuestShippingOption method. - $ref: '#/components/schemas/UpdateShippingOption' + description: "The container for the fields used by the updateGuestShippingOption\ + \ method." + $ref: "#/components/schemas/UpdateShippingOption" required: false responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestCheckoutSessionResponseV2' - '400': - description: Bad Request + $ref: "#/components/schemas/GuestCheckoutSessionResponseV2" + 400: + description: "Bad Request" x-response-codes: errors: - '15001': - domain: API_ORDER - category: REQUEST - description: 'Missing field: {fieldName}. The indicated field is required for this request. Add the field and resubmit the call.' - '15002': - domain: API_ORDER - category: REQUEST - description: 'Invalid field: {fieldName}. The indicated field contains an invalid value. Correct the value and resubmit the call.' - '15003': - domain: API_ORDER - category: REQUEST - description: The checkout session requested does not exist. - '15025': - domain: API_ORDER - category: REQUEST - description: The App is not authorized to access this resource. - '15029': - domain: API_ORDER - category: REQUEST - description: The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID header value used to create the session. For all calls in this checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}. - '15032': - domain: API_ORDER - category: REQUEST - description: After using the 'initiateGuestPayment' call, you cannot make changes to the cart. If you need to change the cart, you must start over using the 'initiateGuestCheckoutSession' call. - '403': - description: Access Forbidden - '404': - description: Resource Not Found - '409': - description: Conflict + 15025: + domain: "API_ORDER" + category: "REQUEST" + description: "The App is not authorized to access this resource." + 15029: + domain: "API_ORDER" + category: "REQUEST" + description: "The X-EBAY-C-MARKETPLACE-ID value {fieldValue} is invalid\ + \ for this checkout session because it is different from the X-EBAY-C-MARKETPLACE-ID\ + \ header value used to create the session. For all calls in this\ + \ checkout session, you must use X-EBAY-C-MARKETPLACE-ID {supportedValues}." + 15032: + domain: "API_ORDER" + category: "REQUEST" + description: "After using the 'initiateGuestPayment' call, you cannot\ + \ make changes to the cart. If you need to change the cart, you\ + \ must start over using the 'initiateGuestCheckoutSession' call." + 15001: + domain: "API_ORDER" + category: "REQUEST" + description: "Missing field: {fieldName}. The indicated field is required\ + \ for this request. Add the field and resubmit the call." + 15002: + domain: "API_ORDER" + category: "REQUEST" + description: "Invalid field: {fieldName}. The indicated field contains\ + \ an invalid value. Correct the value and resubmit the call." + 15003: + domain: "API_ORDER" + category: "REQUEST" + description: "The checkout session requested does not exist." + 500: + description: "Internal Error" x-response-codes: errors: - '15019': - domain: API_ORDER - category: BUSINESS - description: To place an order, you must have at least one line item. Use the initiateCheckoutSession call to add line items (maximum of {maxLineItems}) and create a new checkout session. - '15021': - domain: API_ORDER - category: BUSINESS - description: This checkout session cannot be updated because the order has already been placed. - '15027': - domain: API_ORDER - category: BUSINESS - description: 'The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.' - '500': - description: Internal Error + 15000: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '15000': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 15027: + domain: "API_ORDER" + category: "BUSINESS" + description: "The value {fieldValue} is not supported for the {fieldName}.\ + \ The supported values are: {supportedValues}." + 15019: + domain: "API_ORDER" + category: "BUSINESS" + description: "To place an order, you must have at least one line item.\ + \ Use the initiateCheckoutSession call to add line items (maximum\ + \ of {maxLineItems}) and create a new checkout session." + 15021: + domain: "API_ORDER" + category: "BUSINESS" + description: "This checkout session cannot be updated because the\ + \ order has already been placed." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" /guest_purchase_order/{purchaseOrderId}: get: tags: - - guest_purchase_order - description: Note: The Order API (v2) currently only supports the guest payment/checkout flow. If you need to support member payment/checkout flow, use the v1_beta version of the Order API.

Limited Release(Limited Release) This method is only available to select developers approved by business units.

This method retrieves the details about a specific guest purchase order. It returns the line items, including purchase order status, dates created and modified, item quantity and listing data, payment and shipping information, and prices, taxes, discounts and credits.

The purchaseOrderId is passed in as a URI parameter and is required.

Note: The purchaseOrderId value is returned in the call-back URL that is sent through the new eBay pay widget. For more information about eBay managed payments and the new Order API payment flow, see Order API in the Buying Integration Guide.

You can use this method to not only get the details of a purchase order, but to check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid for. If the order has been paid for, this field will return PAID.

For a list of supported sites and other restrictions, see API Restrictions in the Order API overview.

The URLs for this method are:
  • Production URL: https://api.ebay.com/buy/order/v2/guest_purchase_order/{purchaseOrderId}
  • Sandbox URL: https://api.sandbox.ebay.com/buy/order/v2/guest_purchase_order/{purchaseOrderId}
- operationId: getGuestPurchaseOrder + - "guest_purchase_order" + description: "Note: The Order API (v2) currently\ + \ only supports the guest payment/checkout flow. If you need to support member\ + \ payment/checkout flow, use the v1_beta version of the Order API.

\"Limited(Limited\ + \ Release) This method is only available to select developers approved\ + \ by business units.

This method retrieves the details about a\ + \ specific guest purchase order. It returns the line items, including purchase\ + \ order status, dates created and modified, item quantity and listing data,\ + \ payment and shipping information, and prices, taxes, discounts and credits.
The purchaseOrderId is passed in as a URI parameter and is\ + \ required.

Note: The purchaseOrderId\ + \ value is returned in the call-back URL that is sent through the new eBay\ + \ pay widget. For more information about eBay managed payments and the new\ + \ Order API payment flow, see Order API in the Buying Integration Guide.

You can\ + \ use this method to not only get the details of a purchase order, but to\ + \ check the value of the purchaseOrderPaymentStatus field to determine if the order has been paid\ + \ for. If the order has been paid for, this field will return PAID.
For a list of supported sites and other restrictions, see API Restrictions in the Order\ + \ API overview.

The URLs for this method are:
  • Production\ + \ URL: https://api.ebay.com/buy/order/v2/guest_purchase_order/{purchaseOrderId}
  • Sandbox\ + \ URL: https://api.sandbox.ebay.com/buy/order/v2/guest_purchase_order/{purchaseOrderId}
" + operationId: "getGuestPurchaseOrder" parameters: - - name: purchaseOrderId - in: path - description: The unique identifier of a purchase order made by a guest buyer, for which details are to be retrieved.

Note: This value is returned in the response URL that is sent through the new eBay pay widget. For more information about eBay managed payments and the new Order API payment flow, see Order API in the Buying Integration Guide. - required: true - schema: - type: string + - name: "purchaseOrderId" + in: "path" + description: "The unique identifier of a purchase order made by a guest buyer,\ + \ for which details are to be retrieved.

Note: This value is returned in the response URL that is sent through\ + \ the new eBay pay widget. For more information about eBay managed payments\ + \ and the new Order API payment flow, see Order API in the Buying Integration Guide." + required: true + schema: + type: "string" responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/GuestPurchaseOrderV2' - '400': - description: Bad Request + $ref: "#/components/schemas/GuestPurchaseOrderV2" + 400: + description: "Bad Request" x-response-codes: errors: - '16002': - domain: API_ORDER - category: REQUEST - description: The purchase order ID was not found. - '16003': - domain: API_ORDER - category: REQUEST - description: Access to the purchase order is not authorized. - '403': - description: Access Forbidden - '404': - description: Not Found - '500': - description: Internal Server Error + 16002: + domain: "API_ORDER" + category: "REQUEST" + description: "The purchase order ID was not found." + 16003: + domain: "API_ORDER" + category: "REQUEST" + description: "Access to the purchase order is not authorized." + 500: + description: "Internal Server Error" x-response-codes: errors: - '16001': - domain: API_ORDER - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 16001: + domain: "API_ORDER" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Not Found" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/buy.guest.order + - api_auth: + - "https://api.ebay.com/oauth/api_scope/buy.guest.order" servers: - - url: https://api.ebay.com{basePath} - description: Production - variables: - basePath: - default: /buy/order/v2 + - url: "https://api.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/buy/order/v2" components: schemas: Adjustment: - type: object + type: "object" properties: amount: - description: The container that returns the amount and currency of an adjustment. - $ref: '#/components/schemas/Amount' + description: "The container that returns the amount and currency of an adjustment." + $ref: "#/components/schemas/Amount" label: - type: string - description: The text indicating what the adjustment was for. - description: A type that defines the fields for seller adjustments. An adjustment can be a credit or debit. + type: "string" + description: "The text indicating what the adjustment was for." + description: "A type that defines the fields for seller adjustments. An adjustment\ + \ can be a credit or debit." Amount: - type: object + type: "object" properties: currency: - type: string - description: The currency used in the monetary transaction. Generally, this is the currency used by the country of the eBay site offering the item. For implementation help, refer to eBay API documentation + type: "string" + description: "The currency used in the monetary transaction. Generally,\ + \ this is the currency used by the country of the eBay site offering the\ + \ item. For implementation help, refer to eBay\ + \ API documentation" value: - type: string - description: The amount of the currency specified in the currency field. The value of the currency defaults to the standard currency used by the country of the eBay site offering the item. - description: A container defining the monetary value of an amount, in the currency used on the eBay site that offers the item, and the conversion of that value into another currency. + type: "string" + description: "The amount of the currency specified in the currency\ + \ field. The value of the currency defaults to the standard currency\ + \ used by the country of the eBay site offering the item." + description: "A container defining the monetary value of an amount, in the currency\ + \ used on the eBay site that offers the item, and the conversion of that value\ + \ into another currency." AuthenticityVerificationProgram: - type: object + type: "object" properties: description: - type: string - description: An informational message that applies to the Authenticity Guarantee program. + type: "string" + description: "An informational message that applies to the Authenticity\ + \ Guarantee program." outcomeReason: - type: string - description: An informational message regarding the authentication outcome of an Authenticity Guarantee verification inspection.

Note: This field is conditionally returned when there is information that applies to the Authenticity Guarantee program. + type: "string" + description: "An informational message regarding the authentication outcome\ + \ of an Authenticity Guarantee verification inspection.

Note: This field is conditionally returned\ + \ when there is information that applies to the Authenticity Guarantee\ + \ program." status: - type: string - description: An enumerated value that indicates whether the order line item has passed or failed the Authenticity Guarantee verification inspection, or whether the inspection and/or results are still pending.

Note: This field is conditionally returned when the purchase is complete.

Valid Values:
  • PENDING
  • PASSED
  • FAILED
  • INELIGIBLE
For implementation help, refer to eBay API documentation + type: "string" + description: "An enumerated value that indicates whether the order line\ + \ item has passed or failed the Authenticity Guarantee verification inspection,\ + \ or whether the inspection and/or results are still pending.
Note: This field is conditionally\ + \ returned when the purchase is complete.

Valid Values:
  • PENDING
  • PASSED
  • FAILED
  • INELIGIBLE
\ + \ For implementation help, refer to eBay\ + \ API documentation" termsWebUrl: - type: string - description: The terms and conditions that apply to the Authenticity Guarantee program. - description: A type that provides the status and outcome of an order line item going through the Authenticity Guarantee verification process. + type: "string" + description: "The terms and conditions that apply to the Authenticity Guarantee\ + \ program." + description: "A type that provides the status and outcome of an order line item\ + \ going through the Authenticity Guarantee verification process." Coupon: - type: object + type: "object" properties: redemptionCode: - type: string - description: The coupon redemption code. - description: A type that defines the fields for the coupon information.

Note: This container is not returned for the getGuestPurchaseOrder method. + type: "string" + description: "The coupon redemption code." + description: "A type that defines the fields for the coupon information.
Note: This container is not returned\ + \ for the getGuestPurchaseOrder method." CouponRequest: - type: object + type: "object" properties: redemptionCode: - type: string - description: The redemption code of the coupon.

Maximum: One redemption code per order - description: A type that defines the fields for the coupon information used in the request. + type: "string" + description: "The redemption code of the coupon.

Maximum:\ + \ One redemption code per order" + description: "A type that defines the fields for the coupon information used\ + \ in the request." CreateGuestCheckoutSessionRequestV2: - type: object + type: "object" properties: contactEmail: - type: string - description: The buyer's email address. + type: "string" + description: "The buyer's email address." lineItemInputs: - type: array - description: An array used to define the line item(s) and desired quantity for an eBay guest checkout session.

Maximum: 10 line items + type: "array" + description: "An array used to define the line item(s) and desired quantity\ + \ for an eBay guest checkout session.

Maximum: 10 line\ + \ items" items: - $ref: '#/components/schemas/LineItemInput' + $ref: "#/components/schemas/LineItemInput" shippingAddress: - description: A container that defines the shipping address for an eBay guest checkout session.

The Order API supports only domestic shipping. For example, an item purchased on the EBAY_DE marketplace can be shipped only to an address in Germany.

Note: If the address cannot be validated, a warning message is returned along with the response. - $ref: '#/components/schemas/ShippingAddress' - description: A type that defines the fields used to create an eBay guest checkout session. + description: "A container that defines the shipping address for an eBay\ + \ guest checkout session.

The Order API supports only domestic\ + \ shipping. For example, an item purchased on the EBAY_DE\ + \ marketplace can be shipped only to an address in Germany.

Note: If the address cannot be validated,\ + \ a warning message is returned along with the response." + $ref: "#/components/schemas/ShippingAddress" + description: "A type that defines the fields used to create an eBay guest checkout\ + \ session." Error: - type: object + type: "object" properties: category: - type: string - description: 'This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.' + type: "string" + description: "This string value indicates the error category. There are\ + \ three categories of errors: request errors, application errors, and\ + \ system errors." domain: - type: string - description: The name of the primary system where the error occurred. This is relevant for application errors. + type: "string" + description: "The name of the primary system where the error occurred. This\ + \ is relevant for application errors." errorId: - type: integer - description: 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. - format: int32 + type: "integer" + description: "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." + format: "int32" inputRefIds: - type: array - description: An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any. + type: "array" + description: "An array of reference IDs that identify the specific request\ + \ elements most closely associated to the error or warning, if any." items: - type: string + type: "string" longMessage: - type: string - description: A detailed description of the condition that caused the error or warning, and information on what what must be done to correct the problem. + type: "string" + description: "A detailed description of the condition that caused the error\ + \ or warning, and information on what what must be done to correct the\ + \ problem." message: - type: string - description: A description of the condition that caused the error or warning. + type: "string" + description: "A description of the condition that caused the error or warning." outputRefIds: - type: array - description: An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any. + type: "array" + description: "An array of reference IDs that identify the specific response\ + \ elements most closely associated to the error or warning, if any." items: - type: string + type: "string" parameters: - type: array - description: An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning. + type: "array" + description: "An array of warning and error messages that return one or\ + \ more variables contextual information about the error or warning. This\ + \ is often the field or value that triggered the error or warning." items: - $ref: '#/components/schemas/ErrorParameter' + $ref: "#/components/schemas/ErrorParameter" subdomain: - type: string - description: The name of the subdomain in which the error or warning occurred. - description: A type that defines the fields for the error messages. + type: "string" + description: "The name of the subdomain in which the error or warning occurred." + description: "A type that defines the fields for the error messages." ErrorParameter: - type: object + type: "object" properties: name: - type: string - description: The name of the input field that caused an issue with the method request. + type: "string" + description: "The name of the input field that caused an issue with the\ + \ method request." value: - type: string - description: The actual value that was passed in for the element specified in the name field. - description: An array of name/value pairs that provide details regarding the error. + type: "string" + description: "The actual value that was passed in for the element specified\ + \ in the name field." + description: "An array of name/value pairs that provide details regarding the\ + \ error." Fee: - type: object + type: "object" properties: amount: - description: A container for the currency type and monetary amount of the fee associated with the line item. - $ref: '#/components/schemas/Amount' + description: "A container for the currency type and monetary amount of the\ + \ fee associated with the line item." + $ref: "#/components/schemas/Amount" feeType: - type: string - description: The type of fee associated with the line item. For implementation help, refer to eBay API documentation - description: A breakdown of the fees associated with the line item. + type: "string" + description: "The type of fee associated with the line item. For implementation\ + \ help, refer to eBay\ + \ API documentation" + description: "A breakdown of the fees associated with the line item." GuestCheckoutSessionResponseV2: - type: object + type: "object" properties: appliedCoupons: - type: array - description: A container that returns the information for the coupons that were applied in the guest checkout session. + type: "array" + description: "A container that returns the information for the coupons that\ + \ were applied in the guest checkout session." items: - $ref: '#/components/schemas/Coupon' + $ref: "#/components/schemas/Coupon" checkoutSessionId: - type: string - description: The eBay-assigned guest checkout session ID. This ID is created after a successful initiateGuestCheckoutSession call. + type: "string" + description: "The eBay-assigned guest checkout session ID. This ID is created\ + \ after a successful initiateGuestCheckoutSession call." lineItems: - type: array - description: An array of line items associated with the guest checkout session. + type: "array" + description: "An array of line items associated with the guest checkout\ + \ session." items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" pricingSummary: - description: A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts. - $ref: '#/components/schemas/PricingSummaryV2' + description: "A container that breaks down the costs for the order, including\ + \ total cost, shipping cost, tax, fees, and any discounts." + $ref: "#/components/schemas/PricingSummaryV2" shippingAddress: - description: A container that returns the address to which the purchase order will be shipped. - $ref: '#/components/schemas/ShippingAddress' + description: "A container that returns the address to which the purchase\ + \ order will be shipped." + $ref: "#/components/schemas/ShippingAddress" warnings: - type: array - description: An array of errors or warnings that were generated during the method processing. + type: "array" + description: "An array of errors or warnings that were generated during\ + \ the method processing." items: - $ref: '#/components/schemas/Error' - description: 'Guest session response v2 ' + $ref: "#/components/schemas/Error" + description: "Guest session response v2 " GuestPurchaseOrderV2: - type: object + type: "object" properties: lineItems: - type: array - description: An array of line items in the order. + type: "array" + description: "An array of line items in the order." items: - $ref: '#/components/schemas/OrderLineItemV2' + $ref: "#/components/schemas/OrderLineItemV2" pricingSummary: - description: A container that breaks down the costs for the order, including total cost, shipping cost, tax, fees, and any discounts. - $ref: '#/components/schemas/PricingSummary' + description: "A container that breaks down the costs for the order, including\ + \ total cost, shipping cost, tax, fees, and any discounts." + $ref: "#/components/schemas/PricingSummary" purchaseOrderCreationDate: - type: string - description: The creation date of the purchase order. + type: "string" + description: "The creation date of the purchase order." purchaseOrderId: - type: string - description: The unique identifier of the purchase order. + type: "string" + description: "The unique identifier of the purchase order." purchaseOrderPaymentStatus: - type: string - description: A container that returns the payment status for the purchase order. For implementation help, refer to eBay API documentation + type: "string" + description: "A container that returns the payment status for the purchase\ + \ order. For implementation help, refer to eBay\ + \ API documentation" purchaseOrderStatus: - type: string - description: An enumeration value that indicates the current status of the buyer's payment and any refund that applies to the purchase order. For implementation help, refer to eBay API documentation + type: "string" + description: "An enumeration value that indicates the current status of\ + \ the buyer's payment and any refund that applies to the purchase order.\ + \ For implementation help, refer to eBay\ + \ API documentation" refundedAmount: - description: The total amount of any refunds for the purchase order. - $ref: '#/components/schemas/Amount' + description: "The total amount of any refunds for the purchase order." + $ref: "#/components/schemas/Amount" warnings: - type: array - description: A container for any warning messages. + type: "array" + description: "A container for any warning messages." items: - $ref: '#/components/schemas/Error' - description: A type that defines the fields for a guest purchase order. + $ref: "#/components/schemas/Error" + description: "A type that defines the fields for a guest purchase order." Image: - type: object + type: "object" properties: imageUrl: - type: string - description: The URL for the image. - description: A container that returns the URL for an image. + type: "string" + description: "The URL for the image." + description: "A container that returns the URL for an image." ImportChargesV2: - type: object + type: "object" properties: amount: - description: The amount of the import charge. - $ref: '#/components/schemas/Amount' + description: "The amount of the import charge." + $ref: "#/components/schemas/Amount" applicableChargeType: - type: string - description: The type of charge to apply to the order, such as import duties. For implementation help, refer to eBay API documentation - description: A type that defines the import charges that apply to an order. + type: "string" + description: "The type of charge to apply to the order, such as import duties.\ + \ For implementation help, refer to eBay\ + \ API documentation" + description: "A type that defines the import charges that apply to an order." ImportTax: - type: object + type: "object" properties: amount: - description: The total amount of import tax for all line items of an order. - $ref: '#/components/schemas/Amount' + description: "The total amount of import tax for all line items of an order." + $ref: "#/components/schemas/Amount" importTaxType: - type: string - description: An enumeration value that indicates the type of import tax applicable to the order. Currently, the only applicable import tax is the Goods and Services tax (indicated with GST). The Goods and Services tax is only applicable to orders for the eBay Australia marketplace. For implementation help, refer to eBay API documentation - description: This container defines the type of import tax applicable to the order, and the total amount of tax for all line items in the order. + type: "string" + description: "An enumeration value that indicates the type of import tax\ + \ applicable to the order. Currently, the only applicable import tax is\ + \ the Goods and Services tax (indicated with GST).\ + \ The Goods and Services tax is only applicable to orders for the eBay\ + \ Australia marketplace. For implementation help, refer to eBay\ + \ API documentation" + description: "This container defines the type of import tax applicable to the\ + \ order, and the total amount of tax for all line items in the order." LegacyReference: - type: object + type: "object" properties: legacyItemId: - type: string - description: The legacy ID used to identify an item.

This is used by the Post Order API Create Return Request method. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Create a return request in the Buy Integration Guide.

Restriction: The Post Order API can be used only with eBay member checkouts. + type: "string" + description: "The legacy ID used to identify an item.

This is\ + \ used by the Post Order API Create Return Request method. This call initiates\ + \ the item return process. For more information on how to use this field\ + \ in the Post Order API, see Create a return request in the Buy Integration Guide.

\ + \ Restriction: The Post Order API can be used only with eBay member\ + \ checkouts." legacyOrderId: - type: string - description: The legacy ID of the order.

This is used by the Post Order API Submit Cancellation Request method. This method initiates the item cancellation process. For more information on how to use this field in the Post Order API, see Using the Post Order API.

Restriction: The Post Order API can be used only with eBay member checkouts. + type: "string" + description: "The legacy ID of the order.

This is used by the\ + \ Post Order API Submit Cancellation Request method. This method\ + \ initiates the item cancellation process. For more information on how\ + \ to use this field in the Post Order API, see Using the Post Order API.

Restriction: The Post\ + \ Order API can be used only with eBay member checkouts." legacyTransactionId: - type: string - description: The legacy ID of the transaction.

This is used by the Post Order API Create Return Request call. This call initiates the item return process. For more information on how to use this field in the Post Order API, see Using the Post Order API in the Buy Integration Guide.

Restriction: The Post Order API can be used only with eBay member checkouts. - description: A type that defines the fields to support using the Post Order API for returns and cancellations.

Restriction: The Post Order API can be used only with eBay member checkouts. + type: "string" + description: "The legacy ID of the transaction.

This is used\ + \ by the Post Order API Create Return Request call. This call initiates\ + \ the item return process. For more information on how to use this field\ + \ in the Post Order API, see Using the Post Order API in the Buy Integration Guide.

Restriction:\ + \ The Post Order API can be used only with eBay member checkouts." + description: "A type that defines the fields to support using the Post\ + \ Order API for returns and cancellations.

Restriction:\ + \ The Post Order API can be used only with eBay member checkouts." LineItem: - type: object + type: "object" properties: authenticityVerification: - description: A container returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer. - $ref: '#/components/schemas/AuthenticityVerificationProgram' + description: "A container returned for orders that are eligible for eBay's\ + \ Authenticity Guarantee service. The seller ships Authenticity Guarantee\ + \ service items to the authentication partner instead of the buyer. If\ + \ the item is successfully authenticated, the authenticator will ship\ + \ the item to the buyer." + $ref: "#/components/schemas/AuthenticityVerificationProgram" baseUnitPrice: - description: The cost of a single quantity of the line item. This is the starting point for computing the price during the checkout session.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The cost of a single quantity of the line item. This is the\ + \ starting point for computing the price during the checkout session.
Note: The price includes the\ + \ value-added tax (VAT) for applicable jurisdictions when requested from\ + \ supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID\ + \ request header specifying the supported marketplace (such as EBAY_GB)\ + \ to see VAT-inclusive pricing. For more information on VAT, refer to\ + \ VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" fees: - type: array - description: A breakdown of the fees applicable to the line item. + type: "array" + description: "A breakdown of the fees applicable to the line item." items: - $ref: '#/components/schemas/Fee' + $ref: "#/components/schemas/Fee" image: - description: An eBay-assigned URL of the item image. - $ref: '#/components/schemas/Image' + description: "An eBay-assigned URL of the item image." + $ref: "#/components/schemas/Image" itemId: - type: string - description: The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. The ID is in RESTful item ID format.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility. + type: "string" + description: "The eBay identifier of an item. This ID is returned by the\ + \ Browse and Feed API methods. The ID is in RESTful item\ + \ ID format.

For example: v1|2**********6|5**********4\ + \ or v1|1**********9|0.

For more information about\ + \ item IDs for RESTful APIs, see Legacy API compatibility." lineItemId: - type: string - description: A unique eBay-assigned ID value that identifies a line item in a checkout session. + type: "string" + description: "A unique eBay-assigned ID value that identifies a line item\ + \ in a checkout session." netPrice: - description: The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies.

Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments. - $ref: '#/components/schemas/Amount' + description: "The total cost for the line item, taking into account the\ + \ quantity, any seller item discounts, and any coupon that applies.
Note: This does not include\ + \ any shipping discounts, shipping costs, fees, or seller adjustments." + $ref: "#/components/schemas/Amount" promotions: - type: array - description: An array of promotions applied to the line item. + type: "array" + description: "An array of promotions applied to the line item." items: - $ref: '#/components/schemas/Promotion' + $ref: "#/components/schemas/Promotion" quantity: - type: integer - description: The quantity ordered for the line item. - format: int32 + type: "integer" + description: "The quantity ordered for the line item." + format: "int32" seller: - description: A container that returns the information about the seller, such as their eBay user name. - $ref: '#/components/schemas/Seller' + description: "A container that returns the information about the seller,\ + \ such as their eBay user name." + $ref: "#/components/schemas/Seller" shippingOptions: - type: array - description: An array of shipping options that are available for the line item. By default, the first one will be selected.

Note: The updateGuestShippingOption method can be used to change the shipping option. + type: "array" + description: "An array of shipping options that are available for the line\ + \ item. By default, the first one will be selected.

Note: The updateGuestShippingOption method can\ + \ be used to change the shipping option." items: - $ref: '#/components/schemas/ShippingOption' + $ref: "#/components/schemas/ShippingOption" taxDetails: - type: array - description: A container that returns the tax information for the line item. + type: "array" + description: "A container that returns the tax information for the line\ + \ item." items: - $ref: '#/components/schemas/TaxDetail' + $ref: "#/components/schemas/TaxDetail" title: - type: string - description: The seller-created title of the item. - description: A type that defines the fields for an individual line item. + type: "string" + description: "The seller-created title of the item." + description: "A type that defines the fields for an individual line item." LineItemInput: - type: object + type: "object" properties: itemId: - type: string - description: The unique eBay-assigned identifier of an item. This ID is returned by the Browse and Feed API methods. The ID must be in RESTful item ID format.

For example: v1|2**********6|5**********4 or v1|1**********9|0.

For more information about item IDs for RESTful APIs, see Legacy API compatibility.

Each itemId will become a single line item.

Maximum:10 per checkout + type: "string" + description: "The unique eBay-assigned identifier of an item. This ID is\ + \ returned by the Browse and Feed API methods. The ID must\ + \ be in RESTful item ID format.

For example: v1|2**********6|5**********4\ + \ or v1|1**********9|0.

For more information about\ + \ item IDs for RESTful APIs, see Legacy API compatibility.

Each itemId will become\ + \ a single line item.

Maximum:10 per checkout" quantity: - type: integer - description: The quantity ordered in this line item. - format: int32 - description: A type that defines the fields for a line item. + type: "integer" + description: "The quantity ordered in this line item." + format: "int32" + description: "A type that defines the fields for a line item." OrderLineItemV2: - type: object + type: "object" properties: authenticityVerification: - description: A container that is returned for orders that are eligible for eBay's Authenticity Guarantee program. The seller ships Authenticity Guarantee program items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer. - $ref: '#/components/schemas/AuthenticityVerificationProgram' + description: "A container that is returned for orders that are eligible\ + \ for eBay's Authenticity Guarantee program. The seller ships Authenticity\ + \ Guarantee program items to the authentication partner instead of the\ + \ buyer. If the item is successfully authenticated, the authenticator\ + \ will ship the item to the buyer." + $ref: "#/components/schemas/AuthenticityVerificationProgram" baseUnitPrice: - description: The cost of a single quantity of the line item.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The cost of a single quantity of the line item.

Note: The price includes the value-added\ + \ tax (VAT) for applicable jurisdictions when requested from supported\ + \ marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the\ + \ supported marketplace (such as EBAY_GB) to see VAT-inclusive\ + \ pricing. For more information on VAT, refer to VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" fees: - type: array - description: A breakdown of the fees applicable to the line item. + type: "array" + description: "A breakdown of the fees applicable to the line item." items: - $ref: '#/components/schemas/Fee' + $ref: "#/components/schemas/Fee" image: - description: An eBay-assigned URL of the item image. - $ref: '#/components/schemas/Image' + description: "An eBay-assigned URL of the item image." + $ref: "#/components/schemas/Image" itemId: - type: string - description: The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. + type: "string" + description: "The eBay identifier of an item. This ID is returned by the\ + \ Browse and Feed API methods." legacyReference: - description: A container that returns fields to support using the Post Order API for returns and cancellations. For information about what is returned in these fields and how to use the Post Order API, see Using the Post Order API.

Note: The Post Order API can be used only with eBay member checkouts. - $ref: '#/components/schemas/LegacyReference' + description: "A container that returns fields to support using the Post\ + \ Order API for returns and cancellations. For information about what\ + \ is returned in these fields and how to use the Post Order API, see Using the Post Order\ + \ API.

Note: The Post Order API can be used only\ + \ with eBay member checkouts." + $ref: "#/components/schemas/LegacyReference" lineItemId: - type: string - description: A unique eBay-assigned ID value that identifies a line item in a checkout session. This is created by the initiateGuestCheckoutSession. + type: "string" + description: "A unique eBay-assigned ID value that identifies a line item\ + \ in a checkout session. This is created by the initiateGuestCheckoutSession." lineItemPaymentStatus: - type: string - description: An enumeration value that indicates the payment status of the line item. For implementation help, refer to eBay API documentation + type: "string" + description: "An enumeration value that indicates the payment status of\ + \ the line item. For implementation help, refer to eBay\ + \ API documentation" lineItemStatus: - type: string - description: An enumeration value that indicates the fulfillment state of this line item.

Note: When there is no tracking information, the status will never change from FULFILLMENT_IN_PROGRESS; without tracking information, eBay has no way of knowing whether the order was delivered. For implementation help, refer to eBay API documentation + type: "string" + description: "An enumeration value that indicates the fulfillment state\ + \ of this line item.

Note:\ + \ When there is no tracking information, the status will never change\ + \ from FULFILLMENT_IN_PROGRESS; without tracking information,\ + \ eBay has no way of knowing whether the order was delivered. For\ + \ implementation help, refer to eBay\ + \ API documentation" netPrice: - description: The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies.

Note: This does not include any shipping discounts, shipping costs, fees, or seller adjustments. - $ref: '#/components/schemas/Amount' + description: "The total cost for the line item, taking into account the\ + \ quantity, any seller item discounts, and any coupon that applies.
Note: This does not include\ + \ any shipping discounts, shipping costs, fees, or seller adjustments." + $ref: "#/components/schemas/Amount" orderId: - type: string - description: The unique order ID for the line item.

Maximum Length: 40 characters + type: "string" + description: "The unique order ID for the line item.

Maximum\ + \ Length: 40 characters" promotions: - type: array - description: An array of promotions applied to the line item. + type: "array" + description: "An array of promotions applied to the line item." items: - $ref: '#/components/schemas/Promotion' + $ref: "#/components/schemas/Promotion" quantity: - type: integer - description: The quantity ordered for the line item. - format: int32 + type: "integer" + description: "The quantity ordered for the line item." + format: "int32" seller: - description: A container for information about the seller offering this item, such as the seller's user name. - $ref: '#/components/schemas/Seller' + description: "A container for information about the seller offering this\ + \ item, such as the seller's user name." + $ref: "#/components/schemas/Seller" shippingDetail: - description: A container for information about the shipping details of the order. - $ref: '#/components/schemas/ShippingDetail' + description: "A container for information about the shipping details of\ + \ the order." + $ref: "#/components/schemas/ShippingDetail" taxDetails: - type: array - description: A container for the tax information for the line item. + type: "array" + description: "A container for the tax information for the line item." items: - $ref: '#/components/schemas/TaxDetail' + $ref: "#/components/schemas/TaxDetail" title: - type: string - description: The seller-created title of the item. - description: A type that defines the fields for line item information in a purchase order. + type: "string" + description: "The seller-created title of the item." + description: "A type that defines the fields for line item information in a\ + \ purchase order." PricingSummary: - type: object + type: "object" properties: additionalSavings: - description: The total amount of the coupon discounts in the purchase order. - $ref: '#/components/schemas/Amount' + description: "The total amount of the coupon discounts in the purchase order." + $ref: "#/components/schemas/Amount" adjustment: - description: The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the order that are not already captured in one of the other fields. - $ref: '#/components/schemas/Adjustment' + description: "The total amount of any seller adjustments. An adjustment\ + \ can be a credit or debit. This is used to catch any monetary changes\ + \ to the order that are not already captured in one of the other fields." + $ref: "#/components/schemas/Adjustment" deliveryCost: - description: The delivery cost for all of the line items, after any delivery discounts are applied.

For example, there are four line items, and the delivery cost for each line item is $5. One of the line items qualifies for free delivery. The deliveryCost would be $15, which is the total cost for delivering all of the line items after the discount is applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The delivery cost for all of the line items, after any delivery\ + \ discounts are applied.

For example, there are four line items,\ + \ and the delivery cost for each line item is $5. One of the line items\ + \ qualifies for free delivery. The deliveryCost would be $15, which\ + \ is the total cost for delivering all of the line items after the discount\ + \ is applied.

Note: The cost\ + \ includes the value-added tax (VAT) for applicable jurisdictions when\ + \ requested from supported marketplaces. In this case, users must pass\ + \ the X-EBAY-C-MARKETPLACE-ID\ + \ request header specifying the supported marketplace (such as EBAY_GB)\ + \ to see VAT-inclusive pricing. For more information on VAT, refer to\ + \ VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" deliveryDiscount: - description: The total amount of the order delivery discounts for all of the line items, such as free shipping. - $ref: '#/components/schemas/Amount' + description: "The total amount of the order delivery discounts for all of\ + \ the line items, such as free shipping." + $ref: "#/components/schemas/Amount" fee: - description: The total amount of any fees for all the line items in the order, such as a recycling fee. - $ref: '#/components/schemas/Amount' + description: "The total amount of any fees for all the line items in the\ + \ order, such as a recycling fee." + $ref: "#/components/schemas/Amount" importCharges: - description: The sum of all Global Shipping Program import charges, for all the line items in the order. - $ref: '#/components/schemas/Amount' + description: "The sum of all Global Shipping Program import charges, for all the line items in\ + \ the order." + $ref: "#/components/schemas/Amount" importTax: - description: The type of import tax applicable to the order, and the total amount of tax for all line items in the order. - $ref: '#/components/schemas/ImportTax' + description: "The type of import tax applicable to the order, and the total\ + \ amount of tax for all line items in the order." + $ref: "#/components/schemas/ImportTax" priceDiscount: - description: The total discount amount for all line items in the order.

For example, there are four line items in the order. Two of the line items qualify for a Buy 1, Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value returned would be 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are not reflected in the value returned in this field. - $ref: '#/components/schemas/Amount' + description: "The total discount amount for all line items in the order.
For example, there are four line items in the order. Two of\ + \ the line items qualify for a Buy 1, Get 1 offer, which is a $6\ + \ and a $15 discount. The priceDiscount value returned would be\ + \ 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are\ + \ not reflected in the value returned in this field." + $ref: "#/components/schemas/Amount" priceSubtotal: - description: The total cost for all line items in the order, taking into account the item quantity, but before adding taxes and delivery costs, or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The total cost for all line items in the order, taking into\ + \ account the item quantity, but before adding taxes and delivery costs,\ + \ or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT)\ + \ for applicable jurisdictions when requested from supported marketplaces.\ + \ In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the\ + \ supported marketplace (such as EBAY_GB) to see VAT-inclusive\ + \ pricing. For more information on VAT, refer to VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" tax: - description: The total amount of taxes for all line items in the order. - $ref: '#/components/schemas/Amount' + description: "The total amount of taxes for all line items in the order." + $ref: "#/components/schemas/Amount" total: - description: 'The total cost of the order, which includes: (priceSubtotal - priceDiscount) + deliveryCost + tax +/- adjustment + fee + importCharges - additionalSavings.' - $ref: '#/components/schemas/Amount' - description: A type that returns cost details for all of the line items in the order, such as tax, item price, delivery cost, and discounts. + description: "The total cost of the order, which includes: (priceSubtotal\ + \ - priceDiscount) + deliveryCost + tax +/- adjustment\ + \ + fee + importCharges - additionalSavings." + $ref: "#/components/schemas/Amount" + description: "A type that returns cost details for all of the line items in\ + \ the order, such as tax, item price, delivery cost, and discounts." PricingSummaryV2: - type: object + type: "object" properties: additionalSavings: - description: The total amount of the coupon discounts in the purchase order. - $ref: '#/components/schemas/Amount' + description: "The total amount of the coupon discounts in the purchase order." + $ref: "#/components/schemas/Amount" adjustment: - description: The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the order that are not already captured in one of the other fields. - $ref: '#/components/schemas/Adjustment' + description: "The total amount of any seller adjustments. An adjustment\ + \ can be a credit or debit. This is used to catch any monetary changes\ + \ to the order that are not already captured in one of the other fields." + $ref: "#/components/schemas/Adjustment" deliveryCost: - description: The delivery cost for all of the line items, after any delivery discounts are applied.

For example, there are four line items, and the delivery cost for each line item is $5. One of the line items qualifies for free delivery. The deliveryCost would be $15, which is the total cost for delivering all of the line items after the discount is applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The delivery cost for all of the line items, after any delivery\ + \ discounts are applied.

For example, there are four line items,\ + \ and the delivery cost for each line item is $5. One of the line items\ + \ qualifies for free delivery. The deliveryCost would be $15, which\ + \ is the total cost for delivering all of the line items after the discount\ + \ is applied.

Note: The cost\ + \ includes the value-added tax (VAT) for applicable jurisdictions when\ + \ requested from supported marketplaces. In this case, users must pass\ + \ the X-EBAY-C-MARKETPLACE-ID\ + \ request header specifying the supported marketplace (such as EBAY_GB)\ + \ to see VAT-inclusive pricing. For more information on VAT, refer to\ + \ VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" fee: - description: The total amount of any fees for all the line items in the order, such as a recycling fee. - $ref: '#/components/schemas/Amount' + description: "The total amount of any fees for all the line items in the\ + \ order, such as a recycling fee." + $ref: "#/components/schemas/Amount" importCharges: - description: The sum of all Global Shipping Program import charges, for all the line items in the order. - $ref: '#/components/schemas/ImportChargesV2' + description: "The sum of all Global Shipping Program import charges, for all the line items in\ + \ the order." + $ref: "#/components/schemas/ImportChargesV2" importTax: - description: The type of import tax applicable to the order, and the total amount of tax for all line items in the order. - $ref: '#/components/schemas/ImportTax' + description: "The type of import tax applicable to the order, and the total\ + \ amount of tax for all line items in the order." + $ref: "#/components/schemas/ImportTax" priceDiscount: - description: The total discount amount for all line items in the order.

For example, there are four line items in the order. Two of the line items qualify for a Buy 1, Get 1 offer, which is a $6 and a $15 discount. The priceDiscount value returned would be 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are not reflected in the value returned in this field. - $ref: '#/components/schemas/Amount' + description: "The total discount amount for all line items in the order.
For example, there are four line items in the order. Two of\ + \ the line items qualify for a Buy 1, Get 1 offer, which is a $6\ + \ and a $15 discount. The priceDiscount value returned would be\ + \ 21, which is the total of the two discounts.

Note: Delivery discount amounts, if applicable, are\ + \ not reflected in the value returned in this field." + $ref: "#/components/schemas/Amount" priceSubtotal: - description: The total cost for all line items in the order, taking into account the item quantity, but before adding taxes and delivery costs, or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The total cost for all line items in the order, taking into\ + \ account the item quantity, but before adding taxes and delivery costs,\ + \ or applying discounts, fees, and adjustments.

Note: The price includes the value-added tax (VAT)\ + \ for applicable jurisdictions when requested from supported marketplaces.\ + \ In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the\ + \ supported marketplace (such as EBAY_GB) to see VAT-inclusive\ + \ pricing. For more information on VAT, refer to VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" tax: - description: The total amount of taxes for all line items in the order. - $ref: '#/components/schemas/Amount' + description: "The total amount of taxes for all line items in the order." + $ref: "#/components/schemas/Amount" total: - description: 'The total cost of the order, which includes: (priceSubtotal - priceDiscount) + deliveryCost + tax +/- adjustment + fee + importCharges - additionalSavings.' - $ref: '#/components/schemas/Amount' - description: A type that returns cost details for all of the line items in the order, such as tax, item price, delivery cost, and discounts. + description: "The total cost of the order, which includes: (priceSubtotal\ + \ - priceDiscount) + deliveryCost + tax +/- adjustment\ + \ + fee + importCharges - additionalSavings." + $ref: "#/components/schemas/Amount" + description: "A type that returns cost details for all of the line items in\ + \ the order, such as tax, item price, delivery cost, and discounts." Promotion: - type: object + type: "object" properties: discount: - description: The details regarding the monetary value of the promotional discount.

Note: eBay Bucks are not supported. - $ref: '#/components/schemas/Amount' + description: "The details regarding the monetary value of the promotional\ + \ discount.

Note: eBay Bucks\ + \ are not supported." + $ref: "#/components/schemas/Amount" message: - type: string - description: The text for the promotion title, which describes the promotion. + type: "string" + description: "The text for the promotion title, which describes the promotion." promotionType: - type: string - description: 'The kind of promotion. Some examples are: SellerDiscountedPromotionalOffer and COUPON.' - description: A container that returns the details of an item promotion. + type: "string" + description: "The kind of promotion. Some examples are: SellerDiscountedPromotionalOffer\ + \ and COUPON." + description: "A container that returns the details of an item promotion." Recipient: - type: object + type: "object" properties: firstName: - type: string - description: The first name of the person receiving the purchase order. + type: "string" + description: "The first name of the person receiving the purchase order." lastName: - type: string - description: The last name of the person receiving the purchase order. - description: A container that defines the full name of the person receiving the purchase order. + type: "string" + description: "The last name of the person receiving the purchase order." + description: "A container that defines the full name of the person receiving\ + \ the purchase order." Region: - type: object + type: "object" properties: regionName: - type: string - description: A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level, or at the country level in the case of VAT tax. + type: "string" + description: "A localized text string that indicates the name of the region.\ + \ Taxes are generally charged at the state/province level, or at the country\ + \ level in the case of VAT tax." regionType: - type: string - description: An enumeration value that indicates the type of region for the tax jurisdiction.

Valid Values:
  • STATE_OR_PROVINCE
  • COUNTRY
For implementation help, refer to eBay API documentation - description: A type that provides region details for a tax jurisdiction. + type: "string" + description: "An enumeration value that indicates the type of region for\ + \ the tax jurisdiction.

Valid Values:
  • STATE_OR_PROVINCE
  • COUNTRY
\ + \ For implementation help, refer to eBay\ + \ API documentation" + description: "A type that provides region details for a tax jurisdiction." Seller: - type: object + type: "object" properties: username: - type: string - description: The user name created by the seller for use on eBay. - description: A type that identifies the seller. + type: "string" + description: "The user name created by the seller for use on eBay." + description: "A type that identifies the seller." ShippingAddress: - type: object + type: "object" properties: addressLine1: - type: string - description: The first line of the street address where the item is being shipped.

Maximum:
  • 40 characters for AU, CA, and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50 characters for all other marketplaces
+ type: "string" + description: "The first line of the street address where the item is being\ + \ shipped.

Maximum:
  • 40 characters for AU, CA,\ + \ and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50\ + \ characters for all other marketplaces
" addressLine2: - type: string - description: The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.

Maximum:
  • 40 characters for AU, CA, and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50 characters for all other marketplaces
+ type: "string" + description: "The second line of the street address where the item is being\ + \ shipped. This optional field can be used for information such as 'Suite\ + \ Number' or 'Apt Number'.

Maximum:
  • 40 characters\ + \ for AU, CA, and US marketplaces
  • 35 characters for DE and GB\ + \ marketplaces
  • 50 characters for all other marketplaces
" city: - type: string - description: The city of the address where the item is being shipped. + type: "string" + description: "The city of the address where the item is being shipped." country: - type: string - description: The two letter code representing the country of the address. For implementation help, refer to eBay API documentation + type: "string" + description: "The two letter code representing the country of the address.\ + \ For implementation help, refer to eBay\ + \ API documentation" county: - type: string - description: The county of the address where the item is being shipped. + type: "string" + description: "The county of the address where the item is being shipped." phoneNumber: - type: string - description: The phone number of the person receiving the package.

Note: It is highly recommended that when entering the phone number you include the country code.

For example, if a US phone number is 4********4, you would enter +14********4. If you do not include this code, the service will use the country specified in the country field.

You can find the country code at https://countrycode.org. + type: "string" + description: "The phone number of the person receiving the package.
Note: It is highly recommended that\ + \ when entering the phone number you include the country code.
For example, if a US phone number is 4********4, you\ + \ would enter +14********4. If you do not include this code,\ + \ the service will use the country specified in the country field.
You can find the country code at https://countrycode.org." postalCode: - type: string - description: The postal code of the address where the item is being shipped.

Note: This is optional when shipping to EBAY_HK (Hong Kong). + type: "string" + description: "The postal code of the address where the item is being shipped.
Note: This is optional when\ + \ shipping to EBAY_HK (Hong Kong)." recipient: - description: The name of the person receiving the package. - $ref: '#/components/schemas/Recipient' + description: "The name of the person receiving the package." + $ref: "#/components/schemas/Recipient" stateOrProvince: - type: string - description: The state or province of the address.

Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes. - description: A type that defines the fields for a shipping address. For restrictions, see Shipping restrictions.

Note: If the address cannot be validated, a warning message will be returned. + type: "string" + description: "The state or province of the address.

Note: For the US marketplace, this is a two-character\ + \ value. For a list of valid values, see US State and Canada Province Codes. " + description: "A type that defines the fields for a shipping address. For restrictions,\ + \ see Shipping restrictions.
Note: If the address cannot be\ + \ validated, a warning message will be returned." ShippingAddressImpl: - type: object + type: "object" properties: addressLine1: - type: string - description: The first line of the street address where the item is being shipped.

Maximum:
  • 40 characters for AU, CA, and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50 characters for all other marketplaces
+ type: "string" + description: "The first line of the street address where the item is being\ + \ shipped.

Maximum:
  • 40 characters for AU, CA,\ + \ and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50\ + \ characters for all other marketplaces
" addressLine2: - type: string - description: The second line of the street address where the item is being shipped. This optional field can be used for information such as 'Suite Number' or 'Apt Number'.

Maximum:
  • 40 characters for AU, CA, and US marketplaces
  • 35 characters for DE and GB marketplaces
  • 50 characters for all other marketplaces
+ type: "string" + description: "The second line of the street address where the item is being\ + \ shipped. This optional field can be used for information such as 'Suite\ + \ Number' or 'Apt Number'.

Maximum:
  • 40 characters\ + \ for AU, CA, and US marketplaces
  • 35 characters for DE and GB\ + \ marketplaces
  • 50 characters for all other marketplaces
" city: - type: string - description: The city of the address where the item is being shipped. + type: "string" + description: "The city of the address where the item is being shipped." country: - type: string - description: The two letter code representing the country of the address. For implementation help, refer to eBay API documentation + type: "string" + description: "The two letter code representing the country of the address.\ + \ For implementation help, refer to eBay\ + \ API documentation" county: - type: string - description: The county of the address where the item is being shipped. + type: "string" + description: "The county of the address where the item is being shipped." phoneNumber: - type: string - description: The phone number of the person receiving the package.

Note: It is highly recommended that when entering the phone number you include the country code.

For example, if a US phone number is 4********4, you would enter +14********4. If you do not include this code, the service will use the country specified in the country field.

You can find the country code at https://countrycode.org. + type: "string" + description: "The phone number of the person receiving the package.
Note: It is highly recommended that\ + \ when entering the phone number you include the country code.
For example, if a US phone number is 4********4, you\ + \ would enter +14********4. If you do not include this code,\ + \ the service will use the country specified in the country field.
You can find the country code at https://countrycode.org." postalCode: - type: string - description: The postal code of the address where the item is being shipped.

Note: This is optional when shipping to EBAY_HK (Hong Kong). + type: "string" + description: "The postal code of the address where the item is being shipped.
Note: This is optional when\ + \ shipping to EBAY_HK (Hong Kong)." recipient: - description: The name of the person receiving the package. - $ref: '#/components/schemas/Recipient' + description: "The name of the person receiving the package." + $ref: "#/components/schemas/Recipient" stateOrProvince: - type: string - description: The state or province of the address.

Note: For the US marketplace, this is a two-character value. For a list of valid values, see US State and Canada Province Codes. - description: A type that defines the shipping address fields.

Note: If the address cannot be validated, a warning message is returned along with the response. + type: "string" + description: "The state or province of the address.

Note: For the US marketplace, this is a two-character\ + \ value. For a list of valid values, see US State and Canada Province Codes. " + description: "A type that defines the shipping address fields.

Note: If the address cannot be validated, a warning\ + \ message is returned along with the response." ShippingDetail: - type: object + type: "object" properties: maxEstimatedDeliveryDate: - type: string - description: The end of the date range in which the purchase order is expected to be delivered to the shipping address (final destination). + type: "string" + description: "The end of the date range in which the purchase order is expected\ + \ to be delivered to the shipping address (final destination)." minEstimatedDeliveryDate: - type: string - description: The beginning of the date range in which the purchase order is expected to be delivered to the shipping address (final destination). + type: "string" + description: "The beginning of the date range in which the purchase order\ + \ is expected to be delivered to the shipping address (final destination)." shippingCarrierCode: - type: string - description: The shipping provider for the line item, such as FedEx or USPS. + type: "string" + description: "The shipping provider for the line item, such as FedEx or\ + \ USPS." shippingServiceCode: - type: string - description: The name of the shipping service option. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). - description: A type that defines the fields for the shipping information, such as delivery date estimates and shipping provider. + type: "string" + description: "The name of the shipping service option. For example, Priority\ + \ Mail Express (provided by USPS) or FedEx International Priority (Provided\ + \ by FedEx)." + description: "A type that defines the fields for the shipping information, such\ + \ as delivery date estimates and shipping provider." ShippingOption: - type: object + type: "object" properties: baseDeliveryCost: - description: The delivery cost using this shipping option, for this line item, before any delivery discounts are applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. - $ref: '#/components/schemas/Amount' + description: "The delivery cost using this shipping option, for this line\ + \ item, before any delivery discounts are applied.

Note: The cost includes the value-added tax (VAT) for\ + \ applicable jurisdictions when requested from supported marketplaces.\ + \ In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the\ + \ supported marketplace (such as EBAY_GB) to see VAT-inclusive\ + \ pricing. For more information on VAT, refer to VAT Obligations in the EU." + $ref: "#/components/schemas/Amount" deliveryDiscount: - description: The monetary value of any delivery discounts. - $ref: '#/components/schemas/Amount' + description: "The monetary value of any delivery discounts." + $ref: "#/components/schemas/Amount" importCharges: - description: The Global Shipping Program import charges for this line item. - $ref: '#/components/schemas/Amount' + description: "The Global Shipping Program import charges for this line item." + $ref: "#/components/schemas/Amount" maxEstimatedDeliveryDate: - type: string - description: The end of the date range in which the purchase order is expected to be delivered to the shipping address. + type: "string" + description: "The end of the date range in which the purchase order is expected\ + \ to be delivered to the shipping address." minEstimatedDeliveryDate: - type: string - description: The beginning of the date range in which the purchase order is expected to be delivered to the shipping address. + type: "string" + description: "The beginning of the date range in which the purchase order\ + \ is expected to be delivered to the shipping address." selected: - type: boolean - description: A field that indicates whether the shipping method is selected. + type: "boolean" + description: "A field that indicates whether the shipping method is selected." shippingCarrierCode: - type: string - description: The shipping provider for the line item, such as FedEx or USPS. + type: "string" + description: "The shipping provider for the line item, such as FedEx or\ + \ USPS." shippingOptionId: - type: string - description: A unique ID for the selected shipping option/method. + type: "string" + description: "A unique ID for the selected shipping option/method." shippingServiceCode: - type: string - description: The name of the shipping service code. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx). - description: A type that defines the fields for the shipping options. + type: "string" + description: "The name of the shipping service code. For example, Priority\ + \ Mail Express (provided by USPS) or FedEx International Priority (Provided\ + \ by FedEx)." + description: "A type that defines the fields for the shipping options." TaxDetail: - type: object + type: "object" properties: includedInPrice: - type: boolean - description: A field that indicates whether tax was applied for the cost of the item and its shipping. + type: "boolean" + description: "A field that indicates whether tax was applied for the cost\ + \ of the item and its shipping." taxJurisdiction: - description: A container that returns the tax jurisdiction information. - $ref: '#/components/schemas/TaxJurisdiction' + description: "A container that returns the tax jurisdiction information." + $ref: "#/components/schemas/TaxJurisdiction" taxType: - type: string - description: A field that indicates the type of tax that may be collected for the item. For implementation help, refer to eBay API documentation - description: A type that defines the tax fields. + type: "string" + description: "A field that indicates the type of tax that may be collected\ + \ for the item. For implementation help, refer to eBay\ + \ API documentation" + description: "A type that defines the tax fields." TaxJurisdiction: - type: object + type: "object" properties: region: - description: The region of the tax jurisdiction. - $ref: '#/components/schemas/Region' + description: "The region of the tax jurisdiction." + $ref: "#/components/schemas/Region" taxJurisdictionId: - type: string - description: The identifier of the tax jurisdiction. - description: The type that defines the fields for the tax jurisdiction details. + type: "string" + description: "The identifier of the tax jurisdiction." + description: "The type that defines the fields for the tax jurisdiction details." UpdateQuantity: - type: object + type: "object" properties: lineItemId: - type: string - description: A unique eBay-assigned ID value that identifies a line item in a purchase order. + type: "string" + description: "A unique eBay-assigned ID value that identifies a line item\ + \ in a purchase order." quantity: - type: integer - description: The number of individual items ordered in this line item, as specified by the buyer. - format: int32 - description: A type that defines the fields used to update the quantity of a line item. + type: "integer" + description: "The number of individual items ordered in this line item,\ + \ as specified by the buyer." + format: "int32" + description: "A type that defines the fields used to update the quantity of\ + \ a line item." UpdateShippingOption: - type: object + type: "object" properties: lineItemId: - type: string - description: A unique eBay-assigned ID value that identifies the line item in a checkout session. + type: "string" + description: "A unique eBay-assigned ID value that identifies the line item\ + \ in a checkout session." shippingOptionId: - type: string - description: A unique ID for the selected shipping option/method. - description: A type that defines the fields used to update the shipping option of a line item. + type: "string" + description: "A unique ID for the selected shipping option/method." + description: "A type that defines the fields used to update the shipping option\ + \ of a line item." securitySchemes: api_auth: - type: oauth2 - description: The security definitions for this API. Please check individual operations for applicable scopes. + type: "oauth2" + description: "The security definitions for this API. Please check individual\ + \ operations for applicable scopes." flows: clientCredentials: - tokenUrl: https://api.ebay.com/identity/v1/oauth2/token + tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token" scopes: - https://api.ebay.com/oauth/api_scope/buy.guest.order: Purchase eBay items off eBay + https://api.ebay.com/oauth/api_scope/buy.guest.order: "Purchase eBay items\ + \ off eBay" diff --git a/api-specs/commerce_catalog_v1_beta_oas3.yaml b/api-specs/commerce_catalog_v1_beta_oas3.yaml index 19152755..3be7ffe5 100644 --- a/api-specs/commerce_catalog_v1_beta_oas3.yaml +++ b/api-specs/commerce_catalog_v1_beta_oas3.yaml @@ -1,490 +1,806 @@ -openapi: 3.0.0 +--- +openapi: "3.0.0" info: - title: Catalog API - description: 'The Catalog API allows users to search for and locate an eBay catalog product that is a direct match for the product that they wish to sell. Listing against an eBay catalog product helps insure that all listings (based off of that catalog product) have complete and accurate information. In addition to helping to create high-quality listings, another benefit to the seller of using catalog information to create listings is that much of the details of the listing will be prefilled, including the listing title, the listing description, the item specifics, and a stock image for the product (if available). Sellers will not have to enter item specifics themselves, and the overall listing process is a lot faster and easier.' + title: "Catalog API" + description: "The Catalog API allows users to search for and locate an eBay catalog\ + \ product that is a direct match for the product that they wish to sell. Listing\ + \ against an eBay catalog product helps insure that all listings (based off of\ + \ that catalog product) have complete and accurate information. In addition to\ + \ helping to create high-quality listings, another benefit to the seller of using\ + \ catalog information to create listings is that much of the details of the listing\ + \ will be prefilled, including the listing title, the listing description, the\ + \ item specifics, and a stock image for the product (if available). Sellers will\ + \ not have to enter item specifics themselves, and the overall listing process\ + \ is a lot faster and easier." contact: - name: 'eBay Inc,' + name: "eBay Inc," license: - name: eBay API License Agreement - url: 'https://go.developer.ebay.com/api-license-agreement' - version: v1_beta.5.0 + name: "eBay API License Agreement" + url: "https://go.developer.ebay.com/api-license-agreement" + version: "v1_beta.5.0" servers: - - url: 'https://api.ebay.com{basePath}' - description: Production - variables: - basePath: - default: /commerce/catalog/v1_beta +- url: "https://api.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/commerce/catalog/v1_beta" paths: - '/product/{epid}': + /product/{epid}: get: tags: - - product - description: 'This call retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in the request. These details include the product''s title and description, aspects and their values, associated images, applicable category IDs, and any recognized identifiers that apply to the product. For a new listing, you can use the search call to identify candidate products on which to base the listing, then use the getProduct call to present the full details of those candidate products to the seller to make a a final selection.' - operationId: getProduct + - "product" + description: "This method retrieves details of the catalog product identified\ + \ by the eBay product identifier (ePID) specified in the request. These details\ + \ include the product's title and description, aspects and their values, associated\ + \ images, applicable category IDs, and any recognized identifiers that apply\ + \ to the product.

For a new listing, you can use the search\ + \ method to identify candidate products on which to base the listing, then\ + \ use the getProduct method to present the full details of those candidate\ + \ products to the seller to make a a final selection." + operationId: "getProduct" parameters: - - name: epid - in: path - description: The ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary. - required: true - schema: - type: string + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "This method also uses the X-EBAY-C-MARKETPLACE-ID\ + \ header to identify the seller's eBay marketplace. It is required for all\ + \ marketplaces except EBAY_US, which is the default. Note: This method\ + \ is limited to EBAY_US, EBAY_AU, EBAY_CA,\ + \ and EBAY_GB values." + required: false + schema: + type: "string" + - name: "epid" + in: "path" + description: "The ePID of the product being requested. This value can be discovered\ + \ by issuing the search method and examining the value of the productSummaries.epid\ + \ field for the desired returned product summary." + required: true + schema: + type: "string" responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/Product' - '400': - description: Bad Request + $ref: "#/components/schemas/Product" + 400: + description: "Bad Request" x-response-codes: errors: - '75007': - domain: API_CATALOG - category: REQUEST - description: 'Currently, the {marketplaceId} marketplace is not supported. The supported Marketplaces are: {allowedMarketplaces}.' - '75010': - domain: API_CATALOG - category: REQUEST - description: 'The specified EPID value {epid} was not found.' - '75011': - domain: API_CATALOG - category: REQUEST - description: 'The specified EPID value {epid} no longer exists. Its new value is {newepid}.' - '75015': - domain: API_CATALOG - category: REQUEST - description: Insufficient permissions to fulfill the request. - '75016': - domain: API_CATALOG - category: REQUEST - description: 'The specified EPID value {epid} is no longer available.' - '403': - description: Forbidden - '404': - description: Not Found - '500': - description: Internal Server Error + 75011: + domain: "API_CATALOG" + category: "REQUEST" + description: "The specified EPID value {epid} no longer exists. Its\ + \ new value is {newepid}." + 75010: + domain: "API_CATALOG" + category: "REQUEST" + description: "The specified EPID value {epid} was not found." + 75015: + domain: "API_CATALOG" + category: "REQUEST" + description: "Insufficient permissions to fulfill the request." + 75016: + domain: "API_CATALOG" + category: "REQUEST" + description: "The specified EPID value {epid} is no longer available." + 75007: + domain: "API_CATALOG" + category: "REQUEST" + description: "Currently, the {marketplaceId} marketplace is not supported.\ + \ The supported Marketplaces are: {allowedMarketplaces}." + 500: + description: "Internal Server Error" x-response-codes: errors: - '75000': - domain: API_CATALOG - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 75000: + domain: "API_CATALOG" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Forbidden" + 404: + description: "Not Found" security: - - api_auth: - - 'https://api.ebay.com/oauth/api_scope/sell.inventory' - - 'https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly' + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly" /product_summary/search: get: tags: - - product_summary - description: 'This call searches for and retrieves summaries of one or more products in the eBay catalog that match the search criteria provided by a seller. The seller can use the summaries to select the product in the eBay catalog that corresponds to the item that the seller wants to offer for sale. When a corresponding product is found and adopted by the seller, eBay will use the product information to populate the item listing. The criteria supported by search include keywords, product categories, and category aspects. To see the full details of a selected product, use the getProduct call. In addition to product summaries, this call can also be used to identify refinements, which help you to better pinpoint the product you''re looking for. A refinement consists of one or more aspect values and a count of the number of times that each value has been used in previous eBay listings. An aspect is a property (e.g. color or size) of an eBay category, used by sellers to provide details about the items they''re listing. The refinement container is returned when you include the fieldGroups query parameter in the request with a value of ASPECT_REFINEMENTS or FULL. Example A seller wants to find a product that is "gray" in color, but doesn''t know what term the manufacturer uses for that color. It might be Silver, Brushed Nickel, Pewter, or even Grey. The returned refinement container identifies all aspects that have been used in past listings for products that match your search criteria, along with all of the values those aspects have taken, and the number of times each value was used. You can use this data to present the seller with a histogram of the values of each aspect. The seller can see which color values have been used in the past, and how frequently they have been used, and selects the most likely value or values for their product. You issue the search call again with those values in the aspect_filter parameter to narrow down the collection of products returned by the call. Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide more than one of these parameters, they will be combined with a logical AND to further refine the returned collection of matching products. Note: This call requires that certain special characters in the query parameters be percent-encoded:     (space) = %20       , = %2C       : = %3A       [ = %5B       ] = %5D       { = %7B       | = %7C       } = %7D This requirement applies to all query parameter values. However, for readability, call examples and samples in this documentation will not use the encoding. This call returns product summaries rather than the full details of the products. To retrieve the full details of a product, use the getProduct call with an ePID.' - operationId: search + - "product_summary" + description: "This method searches for and retrieves summaries of one or more\ + \ products in the eBay catalog that match the search criteria provided by\ + \ a seller. The seller can use the summaries to select the product in the\ + \ eBay catalog that corresponds to the item that the seller wants to offer\ + \ for sale. When a corresponding product is found and adopted by the seller,\ + \ eBay will use the product information to populate the item listing. The\ + \ criteria supported by search include keywords, product categories,\ + \ and category aspects. To see the full details of a selected product, use\ + \ the getProduct call.

In addition to product summaries,\ + \ this method can also be used to identify refinements, which help\ + \ you to better pinpoint the product you're looking for. A refinement consists\ + \ of one or more aspect values and a count of the number of times that\ + \ each value has been used in previous eBay listings. An aspect is a property\ + \ (e.g. color or size) of an eBay category, used by sellers to provide details\ + \ about the items they're listing. The refinement container is returned\ + \ when you include the fieldGroups query parameter in the request with\ + \ a value of ASPECT_REFINEMENTS or FULL.
Example
A seller wants to find a product that is \"gray\" in\ + \ color, but doesn't know what term the manufacturer uses for that color.\ + \ It might be Silver, Brushed Nickel, Pewter,\ + \ or even Grey. The returned refinement container identifies\ + \ all aspects that have been used in past listings for products that match\ + \ your search criteria, along with all of the values those aspects have taken,\ + \ and the number of times each value was used. You can use this data to present\ + \ the seller with a histogram of the values of each aspect. The seller can\ + \ see which color values have been used in the past, and how frequently they\ + \ have been used, and selects the most likely value or values for their product.\ + \ You issue the search method again with those values in the aspect_filter\ + \ parameter to narrow down the collection of products returned by the call.\ + \

Although all query parameters are optional, this method must\ + \ include at least the q parameter, or the category_ids, gtin,\ + \ or mpn parameter with a valid value. If you provide more than one\ + \ of these parameters, they will be combined with a logical AND to further\ + \ refine the returned collection of matching products.

Note: This method requires that certain\ + \ special characters in the query parameters be percent-encoded:
    (space) = %20       ,\ + \ = %2C       : =\ + \ %3A       [ = %5B\ + \       ] = %5D       {\ + \ = %7B       | =\ + \ %7C       } = %7D\ + \

This requirement applies to all query parameter values. However,\ + \ for readability, method examples and samples in this documentation will\ + \ not use the encoding.

This method returns product summaries\ + \ rather than the full details of the products. To retrieve the full details\ + \ of a product, use the getProduct method with an ePID." + operationId: "search" parameters: - - name: aspect_filter - in: query - description: 'An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. You can determine appropriate values for the aspects by first submitting this call without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. Note: You can also use the Taxonomy API''s getItemAspectsForCategory call to retrieve detailed information about aspects and their values that are appropriate for your selected category. The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required): aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...}, aspect2:{valueC|valueD|...},... A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. Note: Aspect names and values are case sensitive. Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black} Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D, Storage%20Capacity:%128GB%7C256GB%7D Note: You cannot use the aspect_filter parameter in the same call with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter' - required: false - schema: - type: string - - name: category_ids - in: query - description: 'Important: Currently, only the first category_id value is accepted. One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. Note: This parameter requires a valid category ID value. You can use the Taxonomy API''s getCategorySuggestions call to retrieve appropriate category IDs for your product based on keywords. The syntax for this parameter is as follows: category_ids=category_id1,category_id2,... Here is an example of a call with the category_ids parameter: GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893 Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide only the category_ids parameter, you cannot specify a top-level (L1) category.' - required: false - schema: - type: string - - name: fieldgroups - in: query - description: 'The type of information to return in the response. Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination. Valid Values: ASPECT_REFINEMENTS — This returns the refinement container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for Ford Mustang, some of the category aspects might be Model Year, Exterior Color, Vehicle Mileage, and so on. Note: Aspects are category specific. FULL — This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored. MATCHING_PRODUCTS — This returns summaries for all products that match the values you provide for the q and category_ids parameters. This does not affect your use of the ASPECT_REFINEMENTS value, which you can use in the same call. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_PRODUCTS' - required: false - schema: - type: string - - name: gtin - in: query - description: 'A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the gtin parameter in the same call with either the q parameter or the aspect_filter parameter.' - required: false - schema: - type: string - - name: limit - in: query - description: 'The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. Maximum: 200 Default: 50' - required: false - schema: - type: string - - name: mpn - in: query - description: 'A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This call will return all products that have one of the specified MPNs. MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the mpn parameter in the same call with either the q parameter or the aspect_filter parameter.' - required: false - schema: - type: string - - name: offset - in: query - description: This parameter is reserved for internal or future use. - required: false - schema: - type: string - - name: q - in: query - description: 'A string consisting of one or more keywords to use to search for products in the eBay catalog. Note: This call searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed. The keywords are handled as follows: If the keywords are separated by a comma (e.g. iPhone,256GB), the query returns products that have iPhone AND 256GB. If the keywords are separated by a space (e.g. "iPhone ipad" or "iPhone, ipad"), the query ignores any commas and returns products that have iPhone OR iPad. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the q parameter in the same call with either the gtin parameter or the mpn parameter.' - required: false - schema: - type: string + - name: "X-EBAY-C-MARKETPLACE-ID" + in: "header" + description: "This method also uses the X-EBAY-C-MARKETPLACE-ID\ + \ header to identify the seller's eBay marketplace. It is required for all\ + \ marketplaces except EBAY_US, which is the default. Note: This method\ + \ is limited to EBAY_US, EBAY_AU, EBAY_CA,\ + \ and EBAY_GB values." + required: false + schema: + type: "string" + - name: "aspect_filter" + in: "query" + description: "An eBay category and one or more aspects of that category, with\ + \ the values that can be used to narrow down the collection of products\ + \ returned by this call.

Aspects are product attributes that\ + \ can represent different types of information for different products. Every\ + \ product has aspects, but different products have different sets of aspects.\ + \

You can determine appropriate values for the aspects by first\ + \ submitting this method without this parameter. It will return either the\ + \ productSummaries.aspects container, the refinement.aspectDistributions\ + \ container, or both, depending on the value of the fieldgroups parameter\ + \ in the request. The productSummaries.aspects container provides\ + \ the category aspects and their values that are associated with each returned\ + \ product. The refinement.aspectDistributions container provides\ + \ information about the distribution of values of the set of category aspects\ + \ associated with the specified categories. In both cases sellers can select\ + \ from among the returned aspects to use with this parameter.
Note: You can also use\ + \ the Taxonomy API's getItemAspectsForCategory method to retrieve\ + \ detailed information about aspects and their values that are appropriate\ + \ for your selected category.

The syntax for the aspect_filter\ + \ parameter is as follows (on several lines for readability; categoryId\ + \ is required):

aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...},
aspect2:{valueC|valueD|...},.\ + \

A matching product must be within the specified category,\ + \ and it must have least one of the values identified for every specified\ + \ aspect.

Note:\ + \ Aspect names and values are case sensitive.

Here\ + \ is an example of an aspect_filter parameter in which 9355\ + \ is the category ID, Color is an aspect of that category,\ + \ and Black and White are possible values of that\ + \ aspect (on several lines for readability):

GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black}
Here is the aspect_filter with required URL encoding and a second\ + \ aspect (on several lines for readability):

GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,
Storage%20Capacity:%128GB%7C256GB%7D\ + \

Note: You cannot\ + \ use the aspect_filter parameter in the same method with either\ + \ the gtin parameter or the mpn parameter. For implementation\ + \ help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter" + required: false + schema: + type: "string" + - name: "category_ids" + in: "query" + description: " Important: Currently,\ + \ only the first category_id value is accepted.
One or more comma-separated category identifiers for narrowing down\ + \ the collection of products returned by this call.

Note: This parameter requires a valid category\ + \ ID value. You can use the Taxonomy API's getCategorySuggestions\ + \ method to retrieve appropriate category IDs for your product based on\ + \ keywords.

The syntax for this parameter is as follows:\ + \

category_ids=category_id1,category_id2,.\ + \

Here is an example of a method with the category_ids\ + \ parameter: br />
GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893

\ + \ Note: Although all query parameters are optional, this\ + \ method must include at least the q parameter, or the category_ids,\ + \ gtin, or mpn parameter with a valid value.

\ + \ If you provide only the category_ids parameter, you cannot specify\ + \ a top-level (L1) category. " + required: false + schema: + type: "string" + - name: "fieldgroups" + in: "query" + description: "The type of information to return in the response.
Important: This parameter\ + \ may not produce valid results if you also provide more than one value\ + \ for the category_ids parameter. It is recommended that you avoid\ + \ using this combination.

Valid Values:
    \ + \
  • ASPECT_REFINEMENTS — This returns the refinement\ + \ container, which includes the category aspect and aspect value distributions\ + \ that apply to the returned products. For example, if you searched for\ + \ Ford Mustang, some of the category aspects might be Model\ + \ Year, Exterior Color, Vehicle Mileage, and so on.
    Note: Aspects are category\ + \ specific.
  • FULL — This returns all\ + \ the refinement containers and all the matching products. This value overrides\ + \ the other values, which will be ignored.
  • MATCHING_PRODUCTS\ + \ — This returns summaries for all products that match the values\ + \ you provide for the q and category_ids parameters. This\ + \ does not affect your use of the ASPECT_REFINEMENTS value,\ + \ which you can use in the same call.
Code so that your app gracefully\ + \ handles any future changes to this list.

Default: \ + \ MATCHING_PRODUCTS" + required: false + schema: + type: "string" + - name: "gtin" + in: "query" + description: "A string consisting of one or more comma-separated Global Trade\ + \ Item Numbers (GTINs) that identify products to search for. Currently the\ + \ GTIN values can include EAN, ISBN, and UPC identifier types.
Note: Although all query\ + \ parameters are optional, this method must include at least the q\ + \ parameter, or the category_ids, gtin, or mpn parameter\ + \ with a valid value.

You cannot use the gtin parameter\ + \ in the same method with either the q parameter or the aspect_filter\ + \ parameter. " + required: false + schema: + type: "string" + - name: "limit" + in: "query" + description: "The number of product summaries to return. This is the result\ + \ set, a subset of the full collection of products that match the search\ + \ or filter criteria of this call.

Maximum: 200\ + \
Default: 50" + required: false + schema: + type: "string" + - name: "mpn" + in: "query" + description: "A string consisting of one or more comma-separated Manufacturer\ + \ Part Numbers (MPNs) that identify products to search for. This method\ + \ will return all products that have one of the specified MPNs.
MPNs are defined by manufacturers for their own products, and are therefore\ + \ certain to be unique only within a given brand. However, many MPNs do\ + \ turn out to be globally unique.

Note: Although all query parameters are optional, this\ + \ method must include at least the q parameter, or the category_ids,\ + \ gtin, or mpn parameter with a valid value.

\ + \ You cannot use the mpn parameter in the same method with either\ + \ the q parameter or the aspect_filter parameter. " + required: false + schema: + type: "string" + - name: "offset" + in: "query" + description: "This parameter is reserved for internal or future use." + required: false + schema: + type: "string" + - name: "q" + in: "query" + description: "A string consisting of one or more keywords to use to search\ + \ for products in the eBay catalog.

Note: This method searches the following product record\ + \ fields: title, description, brand, and aspects.localizedName,\ + \ which do not include product IDs. Wildcard characters (e.g. *)\ + \ are not allowed.

The keywords are handled as follows:\ + \
  • If the keywords are separated by a comma (e.g. iPhone,256GB),\ + \ the query returns products that have iPhone AND 256GB.
    • \ + \
  • If the keywords are separated by a space (e.g. \"iPhone ipad\"\ + or \"iPhone, ipad\"), the query ignores any commas\ + \ and returns products that have iPhone OR iPad.
    • \ + \
Note: Although all query\ + \ parameters are optional, this method must include at least the q\ + \ parameter, or the category_ids, gtin, or mpn parameter\ + \ with a valid value.

You cannot use the q parameter\ + \ in the same method with either the gtin parameter or the mpn\ + \ parameter. " + required: false + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/ProductSearchResponse' - '204': - description: No Content - '400': - description: Bad Request + $ref: "#/components/schemas/ProductSearchResponse" + 400: + description: "Bad Request" x-response-codes: errors: - '75001': - domain: API_CATALOG - category: REQUEST - description: 'The call must have a valid ''q'', or ''category_ids'' or ''gtin'' or ''mpn'' query parameter.' - '75004': - domain: API_CATALOG - category: REQUEST - description: The 'limit' value should be between 1 and 200 (inclusive). - '75006': - domain: API_CATALOG - category: REQUEST - description: Top level category browsing is not allowed. Please provide keywords or more filters for the applied top level category. - '75007': - domain: API_CATALOG - category: REQUEST - description: 'Currently, the {marketplaceId} marketplace is not supported. The supported Marketplaces are: {allowedMarketplaces} .' - '75008': - domain: API_CATALOG - category: REQUEST - description: 'The ''fieldgroups'' value {fieldgroups} is invalid. The supported fieldgroups are: {supportedFieldgroups}' - '75012': - domain: API_CATALOG - category: REQUEST - description: 'The aspect_filter format is invalid. For more information, see the API call reference documentation.' - '75013': - domain: API_CATALOG - category: REQUEST - description: 'The ''aspect_filter'' query parameter must include a categoryId. For more information, see the API call reference documentation.' - '75014': - domain: API_CATALOG - category: REQUEST - description: 'The categoryId in ''aspect_filter'' query parameter is invalid. For more information, see the API call reference documentation.' - '75015': - domain: API_CATALOG - category: REQUEST - description: Insufficient permissions to fulfill the request. - '75017': - domain: API_CATALOG - category: REQUEST - description: The specified GTIN value is invalid. - '75018': - domain: API_CATALOG - category: REQUEST - description: The call must be made with either 'q' or 'gtin/mpn'. - '75019': - domain: API_CATALOG - category: REQUEST - description: The call with 'gtin/mpn' cannot be made with aspect_filter. - '403': - description: Forbidden - '500': - description: Internal Server Error + 75008: + domain: "API_CATALOG" + category: "REQUEST" + description: "The 'fieldgroups' value {fieldgroups} is invalid. The\ + \ supported fieldgroups are: {supportedFieldgroups}" + 75013: + domain: "API_CATALOG" + category: "REQUEST" + description: "The 'aspect_filter' query parameter must include a categoryId.\ + \ For more information, see the API call reference documentation." + 75012: + domain: "API_CATALOG" + category: "REQUEST" + description: "The aspect_filter format is invalid. For more information,\ + \ see the API call reference documentation." + 75015: + domain: "API_CATALOG" + category: "REQUEST" + description: "Insufficient permissions to fulfill the request." + 75014: + domain: "API_CATALOG" + category: "REQUEST" + description: "The categoryId in 'aspect_filter' query parameter is\ + \ invalid. For more information, see the API call reference documentation." + 75001: + domain: "API_CATALOG" + category: "REQUEST" + description: "The call must have a valid 'q', or 'category_ids' or\ + \ 'gtin' or 'mpn' query parameter." + 75017: + domain: "API_CATALOG" + category: "REQUEST" + description: "The specified GTIN value is invalid." + 75019: + domain: "API_CATALOG" + category: "REQUEST" + description: "The call with 'gtin/mpn' cannot be made with aspect_filter." + 75018: + domain: "API_CATALOG" + category: "REQUEST" + description: "The call must be made with either 'q' or 'gtin/mpn'." + 75004: + domain: "API_CATALOG" + category: "REQUEST" + description: "The 'limit' value should be between 1 and 200 (inclusive)." + 75007: + domain: "API_CATALOG" + category: "REQUEST" + description: "Currently, the {marketplaceId} marketplace is not supported.\ + \ The supported Marketplaces are: {allowedMarketplaces} ." + 75006: + domain: "API_CATALOG" + category: "REQUEST" + description: "Top level category browsing is not allowed. Please provide\ + \ keywords or more filters for the applied top level category." + 500: + description: "Internal Server Error" x-response-codes: errors: - '75000': - domain: API_CATALOG - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 75000: + domain: "API_CATALOG" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 204: + description: "No Content" + 403: + description: "Forbidden" security: - - api_auth: - - 'https://api.ebay.com/oauth/api_scope/sell.inventory' - - 'https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly' + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly" components: schemas: Aspect: - type: object + type: "object" properties: localizedName: - type: string - description: The localized name of this category aspect. + type: "string" + description: "The localized name of this category aspect." localizedValues: - type: array - description: A list of the localized values of this category aspect. + type: "array" + description: "A list of the localized values of this category aspect." items: - type: string - description: This type contains the name and values of a category aspect. + type: "string" + description: "This type contains the name and values of a category aspect." AspectDistribution: - type: object + type: "object" properties: aspectValueDistributions: - type: array - description: Contains information about one or more values of the category aspect identified by localizedAspectName. + type: "array" + description: "Contains information about one or more values of the category\ + \ aspect identified by localizedAspectName. " items: - $ref: '#/components/schemas/AspectValueDistribution' + $ref: "#/components/schemas/AspectValueDistribution" localizedAspectName: - type: string - description: The localized name of an aspect that is associated with the category identified by dominantCategoryId. - description: This type contains information about one category aspect that is associated with a specified category. + type: "string" + description: "The localized name of an aspect that is associated with the\ + \ category identified by dominantCategoryId." + description: "This type contains information about one category aspect that\ + \ is associated with a specified category." AspectValueDistribution: - type: object + type: "object" properties: localizedAspectValue: - type: string - description: The localized value of the category aspect identified by refinement.aspectDistributions.localizedAspectName. + type: "string" + description: "The localized value of the category aspect identified by refinement.aspectDistributions.localizedAspectName." matchCount: - type: integer - description: 'The number of times the value of localizedAspectValue has been used for eBay product listings. By comparing this quantity to the matchCount for other values of the same aspect, you can present a histogram of the values to sellers, who can use that information to select which aspect value is most appropriate for their product. You can then include the user-selected value in the the search call''s aspect_filter parameter to refine your search.' - format: int32 + type: "integer" + description: "The number of times the value of localizedAspectValue\ + \ has been used for eBay product listings. By comparing this quantity\ + \ to the matchCount for other values of the same aspect, you can\ + \ present a histogram of the values to sellers, who can use that information\ + \ to select which aspect value is most appropriate for their product.\ + \ You can then include the user-selected value in the the search\ + \ call's aspect_filter parameter to refine your search." + format: "int32" refinementHref: - type: string - description: A HATEOAS reference that further refines the search with this particular localizedAspectValue. - description: This type contains information about one value of a specified aspect. This value serves as a product refinement. + type: "string" + description: "A HATEOAS reference that further refines the search with this\ + \ particular localizedAspectValue." + description: "This type contains information about one value of a specified\ + \ aspect. This value serves as a product refinement." Error: - type: object + type: "object" properties: category: - type: string - description: Identifies the type of erro. + type: "string" + description: "Identifies the type of erro." domain: - type: string - description: Name for the primary system where the error occurred. This is relevant for application errors. + type: "string" + description: "Name for the primary system where the error occurred. This\ + \ is relevant for application errors." errorId: - type: integer - description: A unique number to identify the error. - format: int32 + type: "integer" + description: "A unique number to identify the error." + format: "int32" inputRefIds: - type: array - description: An array of request elements most closely associated to the error. + type: "array" + description: "An array of request elements most closely associated to the\ + \ error." items: - type: string + type: "string" longMessage: - type: string - description: A more detailed explanation of the error. + type: "string" + description: "A more detailed explanation of the error." message: - type: string - description: 'Information on how to correct the problem, in the end user''s terms and language where applicable.' + type: "string" + description: "Information on how to correct the problem, in the end user's\ + \ terms and language where applicable." outputRefIds: - type: array - description: An array of request elements most closely associated to the error. + type: "array" + description: "An array of request elements most closely associated to the\ + \ error." items: - type: string + type: "string" parameters: - type: array - description: An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. + type: "array" + description: "An array of name/value pairs that describe details the error\ + \ condition. These are useful when multiple errors are returned." items: - $ref: '#/components/schemas/ErrorParameter' + $ref: "#/components/schemas/ErrorParameter" subdomain: - type: string - description: 'Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.' - description: This type defines the fields that can be returned in an error. + type: "string" + description: "Further helps indicate which subsystem the error is coming\ + \ from. System subcategories include: Initialization, Serialization, Security,\ + \ Monitoring, Rate Limiting, etc." + description: "This type defines the fields that can be returned in an error." ErrorParameter: - type: object + type: "object" properties: name: - type: string - description: The object of the error. + type: "string" + description: "The object of the error." value: - type: string - description: The value of the object. + type: "string" + description: "The value of the object." Image: - type: object + type: "object" properties: height: - type: integer - description: The height of the image in pixels. - format: int32 + type: "integer" + description: "The height of the image in pixels." + format: "int32" imageUrl: - type: string - description: The eBay Picture Services (EPS) URL of the image. + type: "string" + description: "The eBay Picture Services (EPS) URL of the image." width: - type: integer - description: The width of the image in pixels. - format: int32 - description: This type contains information about a product image stored in eBay Picture Services (EPS). + type: "integer" + description: "The width of the image in pixels." + format: "int32" + description: "This type contains information about a product image stored in\ + \ eBay Picture Services (EPS)." Product: - type: object + type: "object" properties: additionalImages: - type: array - description: 'Contains information about additional images associated with this product. For the primary image, see the image container.' + type: "array" + description: "Contains information about additional images associated with\ + \ this product. For the primary image, see the image container." items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" aspects: - type: array - description: Contains an array of the category aspects and their values that are associated with this product. + type: "array" + description: "Contains an array of the category aspects and their values\ + \ that are associated with this product." items: - $ref: '#/components/schemas/Aspect' + $ref: "#/components/schemas/Aspect" brand: - type: string - description: The manufacturer's brand name for this product. + type: "string" + description: "The manufacturer's brand name for this product." description: - type: string - description: 'The rich description of this product, which might contain HTML.' + type: "string" + description: "The rich description of this product, which might contain\ + \ HTML." ean: - type: array - description: A list of all European Article Numbers (EANs) that identify this product. + type: "array" + description: "A list of all European Article Numbers (EANs) that identify\ + \ this product." items: - type: string + type: "string" epid: - type: string - description: The eBay product ID of this product. + type: "string" + description: "The eBay product ID of this product." gtin: - type: array - description: 'A list of all GTINs that identify this product. Currently this can include EAN, ISBN, and UPC identifier types.' + type: "array" + description: "A list of all GTINs that identify this product. Currently\ + \ this can include EAN, ISBN, and UPC identifier types." items: - type: string + type: "string" image: - description: 'Contains information about the primary image of this product. For more images of this product, see the additionalImages container.' - $ref: '#/components/schemas/Image' + description: "Contains information about the primary image of this product.\ + \ For more images of this product, see the additionalImages container." + $ref: "#/components/schemas/Image" isbn: - type: array - description: A list of all International Standard Book Numbers (ISBNs) that identify this product. + type: "array" + description: "A list of all International Standard Book Numbers (ISBNs)\ + \ that identify this product. " items: - type: string + type: "string" mpn: - type: array - description: A list of all MPN values that the manufacturer uses to identify this product. + type: "array" + description: "A list of all MPN values that the manufacturer uses to identify\ + \ this product." items: - type: string + type: "string" otherApplicableCategoryIds: - type: array - description: A list of category IDs (other than the value of primaryCategoryId) for all the leaf categories to which this product might belong. + type: "array" + description: "A list of category IDs (other than the value of primaryCategoryId)\ + \ for all the leaf categories to which this product might belong." items: - type: string + type: "string" primaryCategoryId: - type: string - description: 'The identifier of the leaf category that eBay recommends using to list this product, based on previous listings of similar products. Products in the eBay catalog are not automatically associated with any particular category, but using an inappropriate category can make it difficult for prospective buyers to find the product. For other possible categories that might be used, see otherApplicableCategoryIds.' + type: "string" + description: "The identifier of the leaf category that eBay recommends using\ + \ to list this product, based on previous listings of similar products.\ + \ Products in the eBay catalog are not automatically associated with any\ + \ particular category, but using an inappropriate category can make it\ + \ difficult for prospective buyers to find the product. For other possible\ + \ categories that might be used, see otherApplicableCategoryIds." productWebUrl: - type: string - description: The URL for this product's eBay product page. + type: "string" + description: "The URL for this product's eBay product page." title: - type: string - description: The title of this product on eBay. + type: "string" + description: "The title of this product on eBay." upc: - type: array - description: A list of Universal Product Codes (UPCs) that identify this product. + type: "array" + description: "A list of Universal Product Codes (UPCs) that identify this\ + \ product." items: - type: string + type: "string" version: - type: string - description: The current version number of this product record in the catalog. - description: 'This type contains the full details of a specified product, including information about the product''s identifiers, product images, aspects, and categories.' + type: "string" + description: "The current version number of this product record in the catalog." + description: "This type contains the full details of a specified product, including\ + \ information about the product's identifiers, product images, aspects, and\ + \ categories." ProductSearchResponse: - type: object + type: "object" properties: href: - type: string - description: This field is reserved for internal or future use. + type: "string" + description: "This field is reserved for internal or future use. " limit: - type: integer - description: 'The number of product summaries returned in the response. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. If the limit query parameter was included in the request, this field will have the same value. Default: 50' - format: int32 + type: "integer" + description: "The number of product summaries returned in the response.\ + \ This is the result set, a subset of the full collection of products\ + \ that match the search or filter criteria of this call. If the limit\ + \ query parameter was included in the request, this field will have the\ + \ same value.

Default: 50" + format: "int32" next: - type: string - description: This field is reserved for internal or future use. + type: "string" + description: "This field is reserved for internal or future use. " offset: - type: integer - description: This field is reserved for internal or future use. - format: int32 + type: "integer" + description: "This field is reserved for internal or future use. " + format: "int32" prev: - type: string - description: This field is reserved for internal or future use. + type: "string" + description: "This field is reserved for internal or future use. !-- Not\ + \ returned if the currently returned result set is the first set of\ + \ product records from the current collection of matching products. This\ + \ field contains the search call URI for the previous result set.\ + \ For example, the following URI returns products 21 thru 30 from the\ + \ collection of products:

path/product_summary/search?limit=10&offset=20\ + \

Note: This\ + \ feature employs a zero-based list, where the first product in the list\ + \ has an offset of 0. >" productSummaries: - type: array - description: 'Returned if the fieldGroups query parameter was omitted from the request, or if it was included with a value of MATCHING_PRODUCTS or FULL. This container provides an array of product summaries in the current result set for products that match the combination of the q, category_ids, and aspect_filter parameters that were provided in the request. Each product summary includes information about the product''s identifiers, product images, aspects, the product page URL, and the getProduct URL for retrieving the product details.' + type: "array" + description: "Returned if the fieldGroups query parameter\ + \ was omitted from the request, or if it was included with a value of\ + \ MATCHING_PRODUCTS or FULL. This container\ + \ provides an array of product summaries in the current result set for\ + \ products that match the combination of the q, category_ids,\ + \ and aspect_filter parameters that were provided in the request.\ + \ Each product summary includes information about the product's identifiers,\ + \ product images, aspects, the product page URL, and the getProduct\ + \ URL for retrieving the product details." items: - $ref: '#/components/schemas/ProductSummary' + $ref: "#/components/schemas/ProductSummary" refinement: - description: 'Returned only if the fieldGroups query parameter was included in the request with a value of ASPECT_REFINEMENTS or FULL. An aspect is a property of a category, used by sellers to provide details about the items they''re listing. For example, the Cell Phones & Smartphones category (#9355) includes a Storage Capacity aspect. This container provides information about the distribution of values of a set of category aspects. The category aspects are those associated with the category that eBay determines is most likely to cover the products that match the search criteria.' - $ref: '#/components/schemas/Refinement' + description: "Returned only if the fieldGroups query parameter\ + \ was included in the request with a value of ASPECT_REFINEMENTS\ + \ or FULL.

An aspect is a property of a category,\ + \ used by sellers to provide details about the items they're listing.\ + \ For example, the Cell Phones & Smartphones category (#9355)\ + \ includes a Storage Capacity aspect.

This container\ + \ provides information about the distribution of values of a set of category\ + \ aspects. The category aspects are those associated with the category\ + \ that eBay determines is most likely to cover the products that match\ + \ the search criteria." + $ref: "#/components/schemas/Refinement" total: - type: integer - description: This field is reserved for internal or future use. - format: int32 - description: 'This type contains the specifications for the collection of products that match the search or filter criteria of a search call. A maximum of 200 product summaries is returned (the result set), fewer if you include the limit query parameter in the request.' + type: "integer" + description: "This field is reserved for internal or future use. For implementation help, refer to eBay API documentation' - description: This type is used to define specific shipping regions. There are four 'levels' of shipping regions, including large geographical regions (like 'Asia', 'Europe', or 'Middle East'), individual countries, US states or Canadian provinces, and special locations/domestic regions within a country (like 'Alaska/Hawaii' or 'PO Box'). + type: "string" + description: "Reserved for future use. For implementation help, refer to\ + \ eBay\ + \ API documentation" + description: "This type is used to define specific shipping regions. There are\ + \ four 'levels' of shipping regions, including large geographical regions\ + \ (like 'Asia', 'Europe', or 'Middle East'), individual countries, US states\ + \ or Canadian provinces, and special locations/domestic regions within a country\ + \ (like 'Alaska/Hawaii' or 'PO Box')." RegionSet: - type: object + type: "object" properties: regionExcluded: - type: array - description: An array of one or more regionName values that specify the areas to where a seller does not ship. A regionExcluded list should only be set in the top-level shipToLocations container and not within the shippingServices.shipToLocations container used to specify which shipping regions are serviced by each available shipping service option.

Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.

This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy. + type: "array" + description: "An array of one or more regionName values that specify\ + \ the areas to where a seller does not ship. A regionExcluded list\ + \ should only be set in the top-level shipToLocations container\ + \ and not within the shippingServices.shipToLocations container\ + \ used to specify which shipping regions are serviced by each available\ + \ shipping service option.

Many sellers are willing to ship to many\ + \ international locations, but they may want to exclude some world regions\ + \ or some countries as places they are willing to ship to.

This\ + \ array will be returned as empty if no shipping regions are excluded\ + \ with the fulfillment business policy.

Note: The regionExcluded array is not applicable for motor\ + \ vehicle business policies on the US, CA, or UK marketplaces. If this\ + \ array is used in a createFulfillmentPolicy or updateFulfillmentPolicy\ + \ request, it will be ignored." items: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" regionIncluded: - type: array - description: An array of one or more regionName fields that specify the areas to where a seller ships.

Each eBay marketplace supports its own set of allowable shipping locations. + type: "array" + description: "An array of one or more regionName fields that specify\ + \ the areas to where a seller ships.
Each eBay marketplace supports\ + \ its own set of allowable shipping locations.

Note: The regionIncluded array is not applicable\ + \ for motor vehicle business policies on the US, CA, or UK marketplaces.\ + \ If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy\ + \ request, it will be ignored." items: - $ref: '#/components/schemas/Region' - description: This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship. + $ref: "#/components/schemas/Region" + description: "This type consists of the regionIncluded and regionExcluded\ + \ arrays, which indicate the areas to where the seller does and doesn't ship." ReturnPolicy: - type: object + type: "object" properties: categoryTypes: - type: array - description: 'This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.' + type: "array" + description: "This container indicates which category group that the return\ + \ policy applies to.

Note: Return\ + \ business policies are not applicable to motor vehicle listings, so the\ + \ categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES\ + \ for return business policies." items: - $ref: '#/components/schemas/CategoryType' + $ref: "#/components/schemas/CategoryType" description: - type: string - description: 'A seller-defined description of the return business policy. This description is only for the seller''s use, and is not exposed on any eBay pages.

Max length: 250' + type: "string" + description: "A seller-defined description of the return business policy.\ + \ This description is only for the seller's use, and is not exposed on\ + \ any eBay pages.

Max length: 250" extendedHolidayReturnsOffered: - type: boolean - description: '

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.

' + type: "boolean" + description: "

Important!\ + \ This field is deprecated, since eBay no longer supports extended holiday\ + \ returns. Any value supplied in this field is neither read nor returned.

" internationalOverride: - description: This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policies. Interational return policies are optional, even if the seller ships to international locations. If a separate international return policy is not set, all of the domestic return policy settings also apply to international orders. - $ref: '#/components/schemas/InternationalReturnOverrideType' + description: "This container shows the seller's international return policy\ + \ settings. This container is only returned if the seller has set a separate\ + \ international return policy for the business policies. Interational\ + \ return policies are optional, even if the seller ships to international\ + \ locations. If a separate international return policy is not set, all\ + \ of the domestic return policy settings also apply to international orders." + $ref: "#/components/schemas/InternationalReturnOverrideType" marketplaceId: - type: string - description: The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation + type: "string" + description: "The ID of the eBay marketplace to which this return business\ + \ policy applies. For implementation help, refer to eBay\ + \ API documentation" name: - type: string - description: A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64 + type: "string" + description: "A seller-defined name for this payment business policy. Names\ + \ must be unique for policies assigned to the same marketplace.
Max length: 64" refundMethod: - type: string - description: This value indicates the refund method that will be used by the seller for buyer returns. In most cases, this value is going to be MONEY_BACK, except for 'Click and Collect' and 'Buy Online, Pick up in Store' orders where the seller is able to offer a store/merchandise credit in addition to the 'money back' option. The buyer recieving money back for a return is always an option available to the buyer, even if this field returns MERCHANDISE_CREDIT. For implementation help, refer to eBay API documentation + type: "string" + description: "If a seller indicates that they will accept buyer returns,\ + \ this value will be set to MONEY_BACK. For implementation\ + \ help, refer to eBay\ + \ API documentation" restockingFeePercentage: - type: string - description: '

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.

' + type: "string" + description: "

Important!\ + \ This field is deprecated, since eBay no longer allows sellers to charge\ + \ a restocking fee for buyer remorse returns. If this field is included,\ + \ it is ignored and it is no longer returned.

" returnInstructions: - type: string - description: 'This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)' + type: "string" + description: "This text-based field provides more details on seller-specified\ + \ return instructions. This field is only returned if set for the return\ + \ business policy.

Important! This field is no longer supported on many eBay\ + \ marketplaces. To see if a marketplace and eBay category does support\ + \ this field, call getReturnPolicies method of the Metadata API. Then you will\ + \ look for the policyDescriptionEnabled field with a value of true\ + \ for the eBay category.


Max length: 5000 (8000\ + \ for DE)" returnMethod: - type: string - description: This field is only returned if the seller wants to offer an alternative return method other than 'money back', such as an exchange or replacement item. For implementation help, refer to eBay API documentation + type: "string" + description: "This field is only returned if the seller is willing to offer\ + \ a replacement item as an alternative to 'Money Back'. For implementation\ + \ help, refer to eBay\ + \ API documentation" returnPeriod: - description: 'This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer''s specified ship-to location.

Most categories support 30-day and 60-day return periods.

Note: Unless the seller has set a separate international return policy through the internationalOverride container, this return period will be valid for domestic and international returns (if the seller ships internationally).' - $ref: '#/components/schemas/TimeDuration' + description: "This container indicates the number of calendar days that\ + \ the buyer has to return an item. The return period begins when the item\ + \ is marked \"delivered\" at the buyer's specified ship-to location. \ + \

Most categories support 30-day and 60-day return periods.

Note: Unless the seller has set a separate\ + \ international return policy through the internationalOverride\ + \ container, this return period will be valid for domestic and international\ + \ returns (if the seller ships internationally)." + $ref: "#/components/schemas/TimeDuration" returnPolicyId: - type: string - description: A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created. + type: "string" + description: "A unique eBay-assigned ID for a return business policy. This\ + \ ID is generated when the policy is created." returnsAccepted: - type: boolean - description: If this field is returned as true, the seller accepts returns.

Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits. + type: "boolean" + description: "If this field is returned as true, the seller\ + \ accepts returns.

Note:Top-Rated\ + \ sellers must accept item returns and the handlingTime should\ + \ be set to zero days or one day for a listing to receive a Top-Rated\ + \ Plus badge on the View Item or search result pages. For more information\ + \ on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits." returnShippingCostPayer: - type: string - description: This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. For implementation help, refer to eBay API documentation - description: This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace. + type: "string" + description: "This field indicates who is responsible for paying for the\ + \ shipping charges for returned items. The field can be set to either\ + \ BUYER or SELLER.

Depending on the\ + \ return policy and specifics of the return, either the buyer or the seller\ + \ can be responsible for the return shipping costs. Note that the seller\ + \ is always responsible for return shipping costs for SNAD-related issues.\ + \ For implementation help, refer to eBay\ + \ API documentation" + description: "This type is used by the returnPolicy response container,\ + \ a container which defines a seller's return business policy for a specific\ + \ marketplace." ReturnPolicyRequest: - type: object + type: "object" properties: categoryTypes: - type: array - description: 'This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.' + type: "array" + description: "This container indicates which category group that the return\ + \ policy applies to.

Note: Return\ + \ business policies are not applicable to motor vehicle listings, so the\ + \ categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES\ + \ for return business policies." items: - $ref: '#/components/schemas/CategoryType' + $ref: "#/components/schemas/CategoryType" description: - type: string - description: 'A seller-defined description of the return business policy. This description is only for the seller''s use, and is not exposed on any eBay pages.

Max length: 250' + type: "string" + description: "A seller-defined description of the return business policy.\ + \ This description is only for the seller's use, and is not exposed on\ + \ any eBay pages.

Max length: 250" extendedHolidayReturnsOffered: - type: boolean - description: '

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.

' + type: "boolean" + description: "

Important!\ + \ This field is deprecated, since eBay no longer supports extended holiday\ + \ returns. Any value supplied in this field is neither read nor returned.

" internationalOverride: - description: This container is used by the seller to specify a separate international return policy. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders. - $ref: '#/components/schemas/InternationalReturnOverrideType' + description: "This container is used by the seller to specify a separate\ + \ international return policy. If a separate international return policy\ + \ is not defined by a seller, all of the domestic return policy settings\ + \ will also apply to international orders." + $ref: "#/components/schemas/InternationalReturnOverrideType" marketplaceId: - type: string - description: The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation + type: "string" + description: "The ID of the eBay marketplace to which this return business\ + \ policy applies. For implementation help, refer to eBay\ + \ API documentation" name: - type: string - description: 'A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64' + type: "string" + description: "A seller-defined name for this return business policy. Names\ + \ must be unique for policies assigned to the same marketplace.

Max\ + \ length: 64" refundMethod: - type: string - description: 'This value indicates the refund method that will be used by the seller for buyer returns. In most cases, buyers will get their money back for returns, but for sellers who offer the ''Click and Collect'' and ''Buy Online, Pick up in Store'' option, the seller is able to offer a store/merchandise credit in addition to the ''money back'' option. The buyer recieving money back for a return is always an option available to the buyer, even if this field is set to MERCHANDISE_CREDIT.

Important! If this field is not included in a return business policy, the seller will still have the money back option in the case of a return.

For implementation help, refer to eBay API documentation' + type: "string" + description: "This value indicates the refund method that will be used by\ + \ the seller for buyer returns.

Important! If this field is not included\ + \ in a return business policy, it will default to MONEY_BACK.

For\ + \ implementation help, refer to eBay\ + \ API documentation" restockingFeePercentage: - type: string - description: '

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.

' + type: "string" + description: "

Important!\ + \ This field is deprecated, since eBay no longer allows sellers to charge\ + \ a restocking fee for buyer remorse returns. If this field is included,\ + \ it is ignored.

" returnInstructions: - type: string - description: 'This text-based field provides more details on seller-specified return instructions.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)' + type: "string" + description: "This text-based field provides more details on seller-specified\ + \ return instructions.

Important! This field is no longer supported on many eBay\ + \ marketplaces. To see if a marketplace and eBay category does support\ + \ this field, call getReturnPolicies method of the Metadata API. Then you will\ + \ look for the policyDescriptionEnabled field with a value of true\ + \ for the eBay category.


Max length: 5000 (8000\ + \ for DE)" returnMethod: - type: string - description: This field can be used if the seller is willing and able to offer an alternative return method other than 'money back', such as an exchange or replacement item. For implementation help, refer to eBay API documentation + type: "string" + description: "This field can be used if the seller is willing and able to\ + \ offer a replacement item as an alternative to 'Money Back'. For implementation\ + \ help, refer to eBay\ + \ API documentation" returnPeriod: - description: This container is used to specify the number of days that the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location.

You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods.

For a definitive list of return periods for one or more categories, call getReturnPolicies method of the Metadata API.

The return period is set using the TimeDuration type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate).

Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.

Required if returnsAccepted is set to true. - $ref: '#/components/schemas/TimeDuration' + description: "This container is used to specify the number of days that\ + \ the buyer has to return an item. The return period begins when the item\ + \ is marked \"delivered\" at the buyer's specified ship-to location. \ + \

You must set the value to one that's accepted by the marketplace\ + \ and category where the item is listed. Most categories support 30-day\ + \ and 60-day return periods.

For a definitive list of return\ + \ periods for one or more categories, call getReturnPolicies method of the Metadata API.

The\ + \ return period is set using the TimeDuration type, where you set\ + \ unit to DAY and value to either 30\ + \ or 60 (or other value, as appropriate).

Note\ + \ that this value cannot be modified if the listing has bids or sales,\ + \ or if the listing ends within 12 hours.

Required if \ + \ returnsAccepted is set to true." + $ref: "#/components/schemas/TimeDuration" returnsAccepted: - type: boolean - description: If set to true, the seller accepts returns.

Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.

+ type: "boolean" + description: "If set to true, the seller accepts returns.

Note:Top-Rated sellers must accept\ + \ item returns and the handlingTime should be set to zero days\ + \ or one day for a listing to receive a Top-Rated Plus badge on the View\ + \ Item or search result pages. For more information on eBay's Top-Rated\ + \ seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.

" returnShippingCostPayer: - type: string - description: This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

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

This field is conditionally required if returnsAccepted is set to true. For implementation help, refer to eBay API documentation - description: This root container defines a seller's return business policy for a specific marketplace and category group. This type is used when creating or updating a return business policy. + type: "string" + description: "This field indicates who is responsible for paying for the\ + \ shipping charges for returned items. The field can be set to either\ + \ BUYER or SELLER.

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

This field is conditionally required if returnsAccepted\ + \ is set to true. For implementation help, refer to eBay\ + \ API documentation" + description: "This root container defines a seller's return business policy\ + \ for a specific marketplace and category group. This type is used when creating\ + \ or updating a return business policy." ReturnPolicyResponse: - type: object + type: "object" properties: href: - type: string - description: This field is for future use. + type: "string" + description: "This field is for future use." limit: - type: integer - description: This field is for future use. - format: int32 + type: "integer" + description: "This field is for future use." + format: "int32" next: - type: string - description: This field is for future use. + type: "string" + description: "This field is for future use." offset: - type: integer - description: This field is for future use. - format: int32 + type: "integer" + description: "This field is for future use." + format: "int32" prev: - type: string - description: This field is for future use. + type: "string" + description: "This field is for future use." returnPolicies: - type: array - description: A list of all of the seller's return business policies defined for the specified marketplace. This array will be returned as empty if no return business policies are defined for the specified marketplace. + type: "array" + description: "A list of all of the seller's return business policies defined\ + \ for the specified marketplace. This array will be returned as empty\ + \ if no return business policies are defined for the specified marketplace." items: - $ref: '#/components/schemas/ReturnPolicy' + $ref: "#/components/schemas/ReturnPolicy" total: - type: integer - description: The total number of return business policies retrieved in the result set.

If no return business policies are defined for the specified marketplace, this field is returned with a value of 0. - format: int32 - description: 'The response payload for the getReturnPolicies method.

Note: Pagination has not yet been enabled for getReturnPolicies, so all of the pagination-related fields are for future use.' + type: "integer" + description: "The total number of return business policies retrieved in\ + \ the result set.

If no return business policies are defined\ + \ for the specified marketplace, this field is returned with a value of\ + \ 0." + format: "int32" + description: "The response payload for the getReturnPolicies method.\ + \

Note: Pagination has not yet\ + \ been enabled for getReturnPolicies, so all of the pagination-related\ + \ fields are for future use." SalesTax: - type: object + type: "object" properties: countryCode: - type: string - description: The country code enumeration value identifies the country to which this sales tax rate applies. For implementation help, refer to eBay API documentation + type: "string" + description: "The country code enumeration value identifies the country\ + \ to which this sales tax rate applies. For implementation help, refer\ + \ to eBay\ + \ API documentation" salesTaxJurisdictionId: - type: string - description: A unique ID that identifies the sales tax jurisdiction to which the salest tax rate applies (for example, a state within the United States). + type: "string" + description: "A unique ID that identifies the sales tax jurisdiction to\ + \ which the salest tax rate applies (for example, a state within the United\ + \ States)." salesTaxPercentage: - type: string - description: The sales tax rate that will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is returned here, such as 7.75 + type: "string" + description: "The sales tax rate that will be applied to sales price. The\ + \ shippingAndHandlingTaxed value will indicate whether or not sales\ + \ tax is also applied to shipping and handling charges

Although\ + \ it is a string, a percentage value is returned here, such as 7.75" shippingAndHandlingTaxed: - type: boolean - description: If returned as true, sales tax is also applied to shipping and handling charges, and not just the total sales price of the order. - description: This type is used to provide sales tax settings for a specific tax jurisdiction. + type: "boolean" + description: "If returned as true, sales tax is also applied\ + \ to shipping and handling charges, and not just the total sales price\ + \ of the order." + description: "This type is used to provide sales tax settings for a specific\ + \ tax jurisdiction." SalesTaxBase: - type: object + type: "object" properties: salesTaxPercentage: - type: string - description: This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is set here, such as 7.75. + type: "string" + description: "This field is used to set the sales tax rate for the tax jurisdiction\ + \ set in the call URI. When applicable to an order, this sales tax rate\ + \ will be applied to sales price. The shippingAndHandlingTaxed\ + \ value will indicate whether or not sales tax is also applied to shipping\ + \ and handling charges

Although it is a string, a percentage value\ + \ is set here, such as 7.75." shippingAndHandlingTaxed: - type: boolean - description: This field is set to true if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to false. - description: 'This type is used by the base request of the createOrReplaceSalesTax. ' + type: "boolean" + description: "This field is set to true if the seller wishes\ + \ to apply sales tax to shipping and handling charges, and not just the\ + \ total sales price of the order. Otherwise, this field's value should\ + \ be set to false." + description: "This type is used by the base request of the createOrReplaceSalesTax. " + SalesTaxJurisdiction: + type: "object" + properties: + salesTaxJurisdictionId: + type: "string" + description: "The unique ID for a sales tax jurisdiction." + description: "A unique ID for a sales tax jurisdiction." + SalesTaxJurisdictions: + type: "object" + properties: + salesTaxJurisdictions: + type: "array" + description: "A list of sales tax jurisdictions." + items: + $ref: "#/components/schemas/SalesTaxJurisdiction" + description: "This complex type contains a list of sales tax jurisdictions." SalesTaxes: - type: object + type: "object" properties: salesTaxes: - type: array - description: An array of one or more sales tax rate entries for a specific marketplace (or all applicable marketplaces if the country_code query parameter is not used.

If no sales tax rate entries are set up, no response payload is returned, but only an HTTP status code of 204 No Content. + type: "array" + description: "An array of one or more sales tax rate entries for a specific\ + \ marketplace (or all applicable marketplaces if the country_code\ + \ query parameter is not used.

If no sales tax rate entries are\ + \ set up, no response payload is returned, but only an HTTP status code\ + \ of 204 No Content." items: - $ref: '#/components/schemas/SalesTax' - description: This type is used by the root response of the getSalesTaxes method. + $ref: "#/components/schemas/SalesTax" + description: "This type is used by the root response of the getSalesTaxes\ + \ method." SellerEligibilityMultiProgramResponse: - type: object + type: "object" properties: advertisingEligibility: - type: array - description: An array of response fields that define the seller eligibility for eBay adverstising programs. + type: "array" + description: "An array of response fields that define the seller eligibility\ + \ for eBay adverstising programs." items: - $ref: '#/components/schemas/SellerEligibilityResponse' - description: The base response of the getAdvertisingEligibility method that contains the seller eligibility information for one or more advertising programs. + $ref: "#/components/schemas/SellerEligibilityResponse" + description: "The base response of the getAdvertisingEligibility method\ + \ that contains the seller eligibility information for one or more advertising\ + \ programs." SellerEligibilityResponse: - type: object + type: "object" properties: programType: - type: string - description: The eBay advertising program for which a seller may be eligible. For implementation help, refer to eBay API documentation + type: "string" + description: "The eBay advertising program for which a seller may be eligible.\ + \ For implementation help, refer to eBay\ + \ API documentation" reason: - type: string - description: The reason why a seller is ineligible for the specified eBay advertising program.

This field is only returned if the seller is ineligible for the eBay advertising program. For implementation help, refer to eBay API documentation + type: "string" + description: "The reason why a seller is ineligible for the specified eBay\ + \ advertising program.

This field is only returned if the seller\ + \ is ineligible for the eBay advertising program. For implementation help,\ + \ refer to eBay\ + \ API documentation" status: - type: string - description: The seller elibibilty status for the specified eBay advertising program. For implementation help, refer to eBay API documentation - description: A type that is used to provide the seller's eligibility status for an eBay advertising program. + type: "string" + description: "The seller elibibilty status for the specified eBay advertising\ + \ program. For implementation help, refer to eBay\ + \ API documentation" + description: "A type that is used to provide the seller's eligibility status\ + \ for an eBay advertising program." SellingLimit: - type: object + type: "object" properties: amount: - description: This container shows the monthly cap for total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total sales amount. - $ref: '#/components/schemas/Amount' + description: "This container shows the monthly cap for total sales amount\ + \ allowed for the seller's account. This container may not be returned\ + \ if a seller does not have a monthly cap for total sales amount." + $ref: "#/components/schemas/Amount" quantity: - type: integer - description: This field shows the monthly cap for total quantity sold allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold. - format: int32 - description: Type used by the sellingLimit container, a container that lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. + type: "integer" + description: "This field shows the monthly cap for total quantity sold allowed\ + \ for the seller's account. This container may not be returned if a seller\ + \ does not have a monthly cap for total quantity sold." + format: "int32" + description: "Type used by the sellingLimit container, a container that\ + \ lists the monthly cap for the quantity of items sold and total sales amount\ + \ allowed for the seller's account." SellingPrivileges: - type: object + type: "object" properties: sellerRegistrationCompleted: - type: boolean - description: If this field is returned as true, the seller's registration is completed. If this field is returned as false, the registration process is not complete. + type: "boolean" + description: "If this field is returned as true, the seller's\ + \ registration is completed. If this field is returned as false,\ + \ the registration process is not complete." sellingLimit: - description: This container lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold and total sales amount. - $ref: '#/components/schemas/SellingLimit' - description: This type is used by the base response of the getPrivileges method. + description: "This container lists the monthly cap for the quantity of items\ + \ sold and total sales amount allowed for the seller's account. This container\ + \ may not be returned if a seller does not have a monthly cap for total\ + \ quantity sold and total sales amount." + $ref: "#/components/schemas/SellingLimit" + description: "This type is used by the base response of the getPrivileges\ + \ method." SetFulfillmentPolicyResponse: - type: object + type: "object" properties: categoryTypes: - type: array - description: This container indicates whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. + type: "array" + description: "This container indicates whether the fulfillment business\ + \ policy applies to motor vehicle listings, or if it applies to non-motor\ + \ vehicle listings." items: - $ref: '#/components/schemas/CategoryType' + $ref: "#/components/schemas/CategoryType" description: - type: string - description: 'A seller-defined description of the fulfillment policy. This description is only for the seller''s use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250' + type: "string" + description: "A seller-defined description of the fulfillment policy. This\ + \ description is only for the seller's use, and is not exposed on any\ + \ eBay pages. This field is returned if set for the policy.

Max\ + \ length: 250" freightShipping: - type: boolean - description: If returned as true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. + type: "boolean" + description: "If returned as true, the seller offers freight\ + \ shipping. Freight shipping can be used for large items over 150 lbs." fulfillmentPolicyId: - type: string - description: A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created. + type: "string" + description: "A unique eBay-assigned ID for a fulfillment business policy.\ + \ This ID is generated when the policy is created." globalShipping: - type: boolean - description: If returned as true, eBay's Global Shipping Program will be used by the seller to ship items to international locations. + type: "boolean" + description: "If returned as true, the eBay Global Shipping\ + \ Program will be used by the seller to ship items to international locations.
Note: On the US marketplace,\ + \ the Global Shipping Program is scheduled to be replaced\ + \ by a new intermediated international shipping program called eBay\ + \ International Shipping. US sellers who are opted in to the\ + \ Global Shipping Program will be automatically opted in to eBay International\ + \ Shipping when it becomes available to them. All US sellers will be migrated\ + \ by March 31, 2023.

eBay International Shipping is an account\ + \ level setting, and no field needs to be set in a Fulfillment business\ + \ policy to enable it. As long as the US seller's account is opted in\ + \ to eBay International Shipping, this shipping option will be enabled\ + \ automatically for all listings where international shipping is available.\ + \

A US seller who is opted in to eBay International Shipping\ + \ can also specify individual international shipping service options for\ + \ a Fulfillment business policy." handlingTime: - description: Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.

If only local pickup or freight shipping is available for the item, this container may not get returned.

- $ref: '#/components/schemas/TimeDuration' + description: "Specifies the maximum number of business days the seller commits\ + \ to for preparing and shipping an order after receiving a cleared payment\ + \ for the order. This time does not include the transit time it takes\ + \ the shipping carrier to deliver the order.

If only local pickup or\ + \ freight shipping is available for the item, this container may not get\ + \ returned.

" + $ref: "#/components/schemas/TimeDuration" localPickup: - type: boolean - description: If returned as true, local pickup is available for this policy. + type: "boolean" + description: "If returned as true, local pickup is available\ + \ for this policy." marketplaceId: - type: string - description: The ID of the eBay marketplace to which this fulfillment business policy applies. For implementation help, refer to eBay API documentation + type: "string" + description: "The ID of the eBay marketplace to which this fulfillment business\ + \ policy applies. For implementation help, refer to eBay\ + \ API documentation" name: - type: string - description: 'A seller-defined name for this fulfillment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64' + type: "string" + description: "A seller-defined name for this fulfillment business policy.\ + \ Names must be unique for policies assigned to the same marketplace.\ + \

Max length: 64" pickupDropOff: - type: boolean - description: If returned as true, the seller offers the "Click and Collect" option.

Currently, "Click and Collect" is available only to large retail merchants the eBay AU and UK marketplaces. + type: "boolean" + description: "If returned as true, the seller offers the \"\ + Click and Collect\" option.

Currently, \"Click and Collect\"\ + \ is available only to large retail merchants the eBay AU and UK marketplaces." shippingOptions: - type: array - description: This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). The optionType field indicates whether the ShippingOption object applies to domestic or international shipping, and the costType field indicates whether flat-rate shipping or calculated shipping will be used.

A separate ShippingServices object is used to specify cost and other details for every available domestic and international shipping service option.

+ type: "array" + description: "This array is used to provide detailed information on the\ + \ domestic and international shipping options available for the policy.\ + \ A separate ShippingOption object covers domestic shipping service\ + \ options and international shipping service options (if the seller ships\ + \ to international locations).

The optionType field\ + \ indicates whether the ShippingOption object applies to domestic\ + \ or international shipping, and the costType field indicates whether\ + \ flat-rate shipping or calculated shipping will be used.

A separate\ + \ ShippingServices object is used to specify cost and other details\ + \ for every available domestic and international shipping service option.\ + \

" items: - $ref: '#/components/schemas/ShippingOption' + $ref: "#/components/schemas/ShippingOption" shipToLocations: - description: This container consists of the regionIncluded and regionExcluded containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy. - $ref: '#/components/schemas/RegionSet' + description: "This container consists of the regionIncluded and regionExcluded\ + \ containers, which define the geographical regions/countries/states or\ + \ provinces/domestic regions where the seller does and doesn't ship to\ + \ with this fulfillment policy." + $ref: "#/components/schemas/RegionSet" warnings: - type: array - description: An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. + type: "array" + description: "An array of one or more errors or warnings that were generated\ + \ during the processing of the request. If there were no issues with the\ + \ request, this array will return empty." items: - $ref: '#/components/schemas/Error' - description: Complex type that that gets populated with a response containing a fulfillment policy. + $ref: "#/components/schemas/Error" + description: "Complex type that that gets populated with a response containing\ + \ a fulfillment policy." SetPaymentPolicyResponse: - type: object + type: "object" properties: categoryTypes: - type: array - description: This container indicates whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. + type: "array" + description: "This container indicates whether the payment business policy\ + \ applies to motor vehicle listings, or if it applies to non-motor vehicle\ + \ listings." items: - $ref: '#/components/schemas/CategoryType' + $ref: "#/components/schemas/CategoryType" deposit: - description: This container is only returned if the seller just created or updated a motor vehicles payment business policy and requires buyers to pay an initial deposit after they commit to buying a motor vehicle. - $ref: '#/components/schemas/Deposit' + description: "This container is only returned if the seller just created\ + \ or updated a motor vehicles payment business policy and requires buyers\ + \ to pay an initial deposit after they commit to buying a motor vehicle." + $ref: "#/components/schemas/Deposit" description: - type: string - description: 'A seller-defined description of the payment business policy. This description is only for the seller''s use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250' + type: "string" + description: "A seller-defined description of the payment business policy.\ + \ This description is only for the seller's use, and is not exposed on\ + \ any eBay pages. This field is returned if set for the policy.

Max\ + \ length: 250" fullPaymentDueIn: - description: 'The number of days (after the buyer commits to buy) that a buyer has to pay the remaining balance of a motor vehicle transaction. Sellers can set this value to 3, 7, 10, or 14 days.

Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES.

' - $ref: '#/components/schemas/TimeDuration' + description: "The number of days (after the buyer commits to buy) that a\ + \ buyer has to pay the remaining balance of a motor vehicle transaction.\ + \ Sellers can set this value to 3, 7, 10, or 14 days.

Note: This value is always returned if categoryTypes is\ + \ set to MOTORS_VEHICLES.

" + $ref: "#/components/schemas/TimeDuration" immediatePay: - type: boolean - description: 'The value returned in this field will reflect the value set by the seller in the immediatePay request field. A value of true indicates that immediate payment is required from the buyer for:
  • A fixed-price item
  • An auction item where the buyer is using the ''Buy it Now'' option
  • A deposit for a motor vehicle listing

It is possible for the seller to set this field as true in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller.' + type: "boolean" + description: "The value returned in this field will reflect the value set\ + \ by the seller in the immediatePay request field. A value of true\ + \ indicates that immediate payment is required from the buyer for:
  • A\ + \ fixed-price item
  • An auction item where the buyer is using the\ + \ 'Buy it Now' option
  • A deposit for a motor vehicle listing
It is possible for the seller to set this field as true\ + \ in the payment business policy, but it will not apply in some scenarios.\ + \ For example, immediate payment is not applicable for auction listings\ + \ that have a winning bidder, for buyer purchases that involve the Best\ + \ Offer feature, or for transactions that happen offline between the buyer\ + \ and seller." marketplaceId: - type: string - description: The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation + type: "string" + description: "The ID of the eBay marketplace to which this payment business\ + \ policy applies. For implementation help, refer to eBay\ + \ API documentation" name: - type: string - description: A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64 + type: "string" + description: "A seller-defined name for this payment business policy. Names\ + \ must be unique for policies assigned to the same marketplace.
Max length: 64" paymentInstructions: - type: string - description:

Note: NO LONGER SUPPORTED. Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.

A free-form string field that allows sellers to add detailed payment instructions to their listings. + type: "string" + description: "

Note: NO LONGER SUPPORTED. Although\ + \ this field may be returned for some older payment business policies,\ + \ payment instructions are no longer supported by payment business policies.\ + \ If this field is returned, it can be ignored and these payment instructions\ + \ will not appear in any listings that use the corresponding business\ + \ policy.

A free-form string field that allows sellers to add detailed\ + \ payment instructions to their listings." paymentMethods: - type: array - description: This array shows the available payment methods that the seller has set for the payment business policy.

Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported. + type: "array" + description: "This array shows the available payment methods that the seller\ + \ has set for the payment business policy.

Sellers do not have\ + \ to specify any electronic payment methods for listings, so this array\ + \ will often be returned empty unless the payment business policy is intended\ + \ for motor vehicle listings or other items in categories where offline\ + \ payments are required or supported." items: - $ref: '#/components/schemas/PaymentMethod' + $ref: "#/components/schemas/PaymentMethod" paymentPolicyId: - type: string - description: A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created. + type: "string" + description: "A unique eBay-assigned ID for a payment business policy. This\ + \ ID is generated when the policy is created." warnings: - type: array - description: An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. + type: "array" + description: "An array of one or more errors or warnings that were generated\ + \ during the processing of the request. If there were no issues with the\ + \ request, this array will return empty." items: - $ref: '#/components/schemas/Error' - description: Complex type that that gets populated with a response containing a payment policy. + $ref: "#/components/schemas/Error" + description: "Complex type that that gets populated with a response containing\ + \ a payment policy." SetReturnPolicyResponse: - type: object + type: "object" properties: categoryTypes: - type: array - description: This field always returns ALL_EXCLUDING_MOTORS_VEHICLES for return business policies, since return business policies are not applicable to motor vehicle listings. + type: "array" + description: "This field always returns ALL_EXCLUDING_MOTORS_VEHICLES\ + \ for return business policies, since return business policies are not\ + \ applicable to motor vehicle listings." items: - $ref: '#/components/schemas/CategoryType' + $ref: "#/components/schemas/CategoryType" description: - type: string - description: 'A seller-defined description of the return business policy. This description is only for the seller''s use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250' + type: "string" + description: "A seller-defined description of the return business policy.\ + \ This description is only for the seller's use, and is not exposed on\ + \ any eBay pages. This field is returned if set for the policy.

Max\ + \ length: 250" extendedHolidayReturnsOffered: - type: boolean - description: '

Important! This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.

' + type: "boolean" + description: "

Important!\ + \ This field is deprecated, since eBay no longer supports extended holiday\ + \ returns. This field should no longer be returned.

" internationalOverride: - description: This container is used by the seller to specify a separate international return policy, and will only be returned if the seller has set a separate return policy for international orders. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders. - $ref: '#/components/schemas/InternationalReturnOverrideType' + description: "This container is used by the seller to specify a separate\ + \ international return policy, and will only be returned if the seller\ + \ has set a separate return policy for international orders. If a separate\ + \ international return policy is not defined by a seller, all of the domestic\ + \ return policy settings will also apply to international orders." + $ref: "#/components/schemas/InternationalReturnOverrideType" marketplaceId: - type: string - description: The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation + type: "string" + description: "The ID of the eBay marketplace to which this return business\ + \ policy applies. For implementation help, refer to eBay\ + \ API documentation" name: - type: string - description: A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64 + type: "string" + description: "A seller-defined name for this return business policy. Names\ + \ must be unique for policies assigned to the same marketplace.
Max length: 64" refundMethod: - type: string - description: This value indicates the refund method that will be used by the seller for buyer returns. In most cases, buyers will get their money back for returns, but for sellers who offer the 'Click and Collect' and 'Buy Online, Pick up in Store' option, the seller is able to offer a store/merchandise credit in addition to the 'money back' option. The buyer recieving money back for a return is always an option available to the buyer, even if this field is set to MERCHANDISE_CREDIT, or if this field is not returned at all. For implementation help, refer to eBay API documentation + type: "string" + description: "If a seller indicates that they will accept buyer returns,\ + \ this value will be MONEY_BACK. For implementation help,\ + \ refer to eBay\ + \ API documentation" restockingFeePercentage: - type: string - description: '

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.

' + type: "string" + description: "

Important!\ + \ This field is deprecated, since eBay no longer allows sellers to charge\ + \ a restocking fee for buyer remorse returns.

" returnInstructions: - type: string - description: 'This text-based field provides more details on seller-specified return instructions.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)' + type: "string" + description: "This text-based field provides more details on seller-specified\ + \ return instructions.

Important! This field is no longer supported on many eBay\ + \ marketplaces. To see if a marketplace and eBay category does support\ + \ this field, call getReturnPolicies method of the Metadata API. Then you will\ + \ look for the policyDescriptionEnabled field with a value of true\ + \ for the eBay category.


Max length: 5000 (8000\ + \ for DE)" returnMethod: - type: string - description: This field will be returned if the seller is willing and able to offer an alternative return method other than 'money back', such as an exchange or replacement item. For implementation help, refer to eBay API documentation + type: "string" + description: "This field will be returned if the seller is willing and able\ + \ to offer a replacement item as an alternative to 'Money Back'. For implementation\ + \ help, refer to eBay\ + \ API documentation" returnPeriod: - description: This container specifies the amount of days that the buyer has to return the item after receiving it. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. This container will be returned unless the business policy states that the seller does not accept returns. - $ref: '#/components/schemas/TimeDuration' + description: "This container specifies the amount of days that the buyer\ + \ has to return the item after receiving it. The return period begins\ + \ when the item is marked \"delivered\" at the buyer's specified ship-to\ + \ location. This container will be returned unless the business policy\ + \ states that the seller does not accept returns." + $ref: "#/components/schemas/TimeDuration" returnPolicyId: - type: string - description: A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created. + type: "string" + description: "A unique eBay-assigned ID for a return business policy. This\ + \ ID is generated when the policy is created." returnsAccepted: - type: boolean - description: If set to true, the seller accepts returns. If set to false, this field indicates that the seller does not accept returns. + type: "boolean" + description: "If set to true, the seller accepts returns. If\ + \ set to false, this field indicates that the seller does\ + \ not accept returns." returnShippingCostPayer: - type: string - description: This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Note that the seller is always responsible for return shipping costs for SNAD-related issues.

This container will be returned unless the business policy states that the seller does not accept returns. For implementation help, refer to eBay API documentation + type: "string" + description: "This field indicates who is responsible for paying for the\ + \ shipping charges for returned items. The field can be set to either\ + \ BUYER or SELLER.

Note that the\ + \ seller is always responsible for return shipping costs for SNAD-related\ + \ issues.

This container will be returned unless the business\ + \ policy states that the seller does not accept returns. For implementation\ + \ help, refer to eBay\ + \ API documentation" warnings: - type: array - description: An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. + type: "array" + description: "An array of one or more errors or warnings that were generated\ + \ during the processing of the request. If there were no issues with the\ + \ request, this array will return empty." items: - $ref: '#/components/schemas/Error' - description: Complex type that that gets populated with a response containing a return policy. + $ref: "#/components/schemas/Error" + description: "Complex type that that gets populated with a response containing\ + \ a return policy." ShippingOption: - type: object + type: "object" properties: costType: - type: string - description: This field defines whether the shipping cost model is FLAT_RATE (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package).

This field is conditionally required if any shipping service options are specified (domestic and/or international). For implementation help, refer to eBay API documentation + type: "string" + description: "This field defines whether the shipping cost model is FLAT_RATE\ + \ (the same rate for all buyers, or buyers within a region if shipping\ + \ rate tables are used) or CALCULATED (the shipping rate\ + \ varies by the ship-to location and size and weight of the package).\ + \

This field is conditionally required if any shipping service\ + \ options are specified (domestic and/or international). For implementation\ + \ help, refer to eBay\ + \ API documentation" insuranceFee: - description: This field has been deprecated.

Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies. - $ref: '#/components/schemas/Amount' + description: "This field has been deprecated.

Shipping insurance\ + \ is offered only via a shipping carrier's shipping services and is no\ + \ longer available via eBay shipping policies." + $ref: "#/components/schemas/Amount" insuranceOffered: - type: boolean - description: This field has been deprecated.

Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies. + type: "boolean" + description: "This field has been deprecated.

Shipping insurance\ + \ is offered only via a shipping carrier's shipping services and is no\ + \ longer available via eBay shipping policies." optionType: - type: string - description: This field is used to indicate if the corresponding shipping service options (under shippingServices array) are domestic or international shipping service options. This field is conditionally required if any shipping service options are specified (domestic and/or international). For implementation help, refer to eBay API documentation + type: "string" + description: "This field is used to indicate if the corresponding shipping\ + \ service options (under shippingServices array) are domestic or\ + \ international shipping service options. This field is conditionally\ + \ required if any shipping service options are specified (domestic and/or\ + \ international). For implementation help, refer to eBay\ + \ API documentation" packageHandlingCost: - description: This container is used if the seller adds handling charges to domestic and/or international shipments.

Sellers can not specify any domestic handling charges if they offered 'free shipping' in the policy.

This container will only be returned if set for the policy. - $ref: '#/components/schemas/Amount' + description: "This container is used if the seller adds handling charges\ + \ to domestic and/or international shipments.

Sellers can not\ + \ specify any domestic handling charges if they offered 'free shipping'\ + \ in the policy.

This container will only be returned if set\ + \ for the policy." + $ref: "#/components/schemas/Amount" rateTableId: - type: string - description: This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy. The getRateTables method can be used to retrieve shipping rate table IDs.

With domestic and international shipping rate tables, the seller can set different shipping costs based on shipping regions and shipping speed/level of service (one-day, expedited, standard, economy). There are also options to additional per-weight and handling charges.

Sellers need to be careful that shipping rate tables match the corresponding shipping service options. In other words, a domestic shipping rate table must not be specified in the same container where international shipping service options are being specified, and vice versa, and the shipping speed/level of service of the provided shipping service options should match the shipping speed/level of service options that are defined in the shipping rate tables. For example, if the corresponding shipping rate table defines costs for one-day shipping services, there should be at least one one-day shipping service option specified under the shippingServices array.

This field is returned if set. + type: "string" + description: "This field is used if the seller wants to associate a domestic\ + \ or international shipping rate table to the fulfillment business policy.\ + \ The getRateTables method can be used to retrieve shipping rate table\ + \ IDs.

With domestic and international shipping rate tables,\ + \ the seller can set different shipping costs based on shipping regions\ + \ and shipping speed/level of service (one-day, expedited, standard, economy).\ + \ There are also options to additional per-weight and handling charges.

Sellers\ + \ need to be careful that shipping rate tables match the corresponding\ + \ shipping service options. In other words, a domestic shipping rate table\ + \ must not be specified in the same container where international shipping\ + \ service options are being specified, and vice versa, and the shipping\ + \ speed/level of service of the provided shipping service options should\ + \ match the shipping speed/level of service options that are defined in\ + \ the shipping rate tables.

For example, if the corresponding\ + \ shipping rate table defines costs for one-day shipping services, there\ + \ should be at least one one-day shipping service option specified under\ + \ the shippingServices array.

This field is returned if\ + \ set." shippingServices: - type: array - description: This array consists of the domestic or international shipping services options that are defined for the policy. The shipping service options defined under this array should match what is set in the corresponding shippingOptions.optionType field (which controls whether domestic or international shipping service options are being defined). If a shipping rate table is being used, the specified shipping service options should also match the shipping rate table settings (domestic or international, shipping speed/level of service, etc.)

Sellers can specify up to four domestic shipping services and up to five international shipping service options by using separate shippingService containers for each. If the seller is using the Global Shipping Program as an international option, only a total of four international shipping service options (including GSP) can be offered.

See How to set up shipping carrier and shipping service values.

To use the eBay standard envelope service (eSE), see Using eBay standard envelope (eSE) service.

This array is conditionally required if the seller is offering one or more domestic and/or international shipping service options. + type: "array" + description: "This array consists of the domestic or international shipping\ + \ services options that are defined for the policy. The shipping service\ + \ options defined under this array should match what is set in the corresponding\ + \ shippingOptions.optionType field (which controls whether domestic\ + \ or international shipping service options are being defined). If a shipping\ + \ rate table is being used, the specified shipping service options should\ + \ also match the shipping rate table settings (domestic or international,\ + \ shipping speed/level of service, etc.)

Sellers can specify\ + \ up to four domestic shipping services and up to five international shipping\ + \ service options by using separate shippingService containers\ + \ for each. If the seller is using the Global Shipping Program as an international\ + \ option, only a total of four international shipping service options\ + \ (including GSP) can be offered.

See How to set up shipping carrier and shipping service\ + \ values.

To use the eBay standard envelope service (eSE),\ + \ see Using eBay standard envelope (eSE) service.
This array is conditionally required if the seller is offering\ + \ one or more domestic and/or international shipping service options." items: - $ref: '#/components/schemas/ShippingService' - description: This type is used by the shippingOptions array, which is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). + $ref: "#/components/schemas/ShippingService" + description: "This type is used by the shippingOptions array, which is\ + \ used to provide detailed information on the domestic and international shipping\ + \ options available for the policy. A separate ShippingOption object\ + \ covers domestic shipping service options and international shipping service\ + \ options (if the seller ships to international locations)." ShippingService: - type: object + type: "object" properties: additionalShippingCost: - description: This container is used by the seller to cover the use case when a single buyer purchases multiple quantities of the same line item. This cost cannot exceed the corresponding shippingCost value. A seller will generally set this field when he/she wants to pass on a shipping discount to the buyer if that buyer purchases multiple quantities of a line item. The seller can ship multiple quantities of the line item in the same package and pass on the shipping savings to the buyer.

If this field is not set, and a buyer purchases multiple quantities of an item, the seller can technically charge the same cost set in the shippingCost container for each individual item, but in general, it behooves both the seller and the buyer (and saves both parties money) if they discuss combined shipping.

This field is not applicable to auction listings or single-quantity, fixed-price listings.

This container is returned if set. - $ref: '#/components/schemas/Amount' + description: "This container is used by the seller to cover the use case\ + \ when a single buyer purchases multiple quantities of the same line item.\ + \ This cost cannot exceed the corresponding shippingCost value.\ + \ A seller will generally set this field when he/she wants to pass on\ + \ a shipping discount to the buyer if that buyer purchases multiple quantities\ + \ of a line item.

The seller can ship multiple quantities\ + \ of the line item in the same package and pass on the shipping savings\ + \ to the buyer.

If this field is not set, and a buyer purchases\ + \ multiple quantities of an item, the seller can technically charge the\ + \ same cost set in the shippingCost container for each individual\ + \ item, but in general, it behooves both the seller and the buyer (and\ + \ saves both parties money) if they discuss combined shipping.

This\ + \ field is not applicable to auction listings or single-quantity, fixed-price\ + \ listings.

This container is returned if set." + $ref: "#/components/schemas/Amount" buyerResponsibleForPickup: - type: boolean - description: 'This field should be included and set to true for a motor vehicle listing if it will be the buyer''s responsibility to pick up the purchased motor vehicle after full payment is made. This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle.

This field is returned if set.

Default: false' + type: "boolean" + description: "This field should be included and set to true\ + \ for a motor vehicle listing if it will be the buyer's responsibility\ + \ to pick up the purchased motor vehicle after full payment is made.
This field is only applicable to motor vehicle listings. In\ + \ the majority of motor vehicle listings, the seller does make the buyer\ + \ responsible for pickup or shipment of the vehicle.

This field\ + \ is returned if set.

Default: false" buyerResponsibleForShipping: - type: boolean - description: 'This field should be included and set to true for a motor vehicle listing if it will be the buyer''s responsibility to arrange for shipment of a purchased motor vehicle after full payment is made. This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle.

This field is returned if set.

Default: false' + type: "boolean" + description: "This field should be included and set to true\ + \ for a motor vehicle listing if it will be the buyer's responsibility\ + \ to arrange for shipment of a purchased motor vehicle after full payment\ + \ is made.

This field is only applicable to motor vehicle\ + \ listings. In the majority of motor vehicle listings, the seller does\ + \ make the buyer responsible for pickup or shipment of the vehicle.

This\ + \ field is returned if set.

Default: false" cashOnDeliveryFee: - description: This container is used if the seller charges a Cash on Delivery (COD) fee. This fee will only be applicable in the case of a 'local pickup', and if one of the specified offline payment methods is a 'cash on pickup' or 'cash on delivery' option. This fee is added to the total cost of the item, and the total cost is due from the buyer upon the delivery of the item.

This container is returned if set. - $ref: '#/components/schemas/Amount' + description: "This container is used if the seller charges a Cash on Delivery\ + \ (COD) fee.
  • This fee will only be applicable in the case of a\ + \ 'local pickup', and if one of the specified offline payment methods\ + \ is a 'cash on pickup' or 'cash on delivery' option.
  • This fee\ + \ is added to the total cost of the item, and the total cost is due from\ + \ the buyer upon the delivery of the item.
This container is\ + \ returned if set." + $ref: "#/components/schemas/Amount" freeShipping: - type: boolean - description: This field is included and set to true if the seller offers a free shipping option to the buyer. This field can only be included and set to true for the first domestic shipping service option specified in the shippingServices container (it is ignored if set for subsequent shipping services or for any international shipping service option). The first specified shipping service option has a sortOrder value of 1 or if the sortOrderId field is not used, it is the shipping service option that's specified first in the shippingServices container.

This container is returned if set. + type: "boolean" + description: "This field is included and set to true if the\ + \ seller offers a free shipping option to the buyer.

This\ + \ field can only be included and set to true for the first\ + \ domestic shipping service option specified in the shippingServices\ + \ container (it is ignored if set for subsequent shipping services or\ + \ for any international shipping service option).

The first\ + \ specified shipping service option has a sortOrder value of 1\ + \ or if the sortOrderId field is not used, it is the shipping service\ + \ option that's specified first in the shippingServices container.

This\ + \ container is returned if set." shippingCarrierCode: - type: string - description: This field sets/indicates the shipping carrier, such as USPS, FedEx, or UPS. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here. For a full list of shipping carrier enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingCarrierDetails. The enum values for each shipping carriers can be found in each ShippingCarrierDetails.ShippingCarrier field in the response payload.

This field is actually optional, as the shipping carrier is also tied into the shippingServiceCode enum value, and that field is required for every specified shipping service option.

This field is returned if set. + type: "string" + description: "This field sets/indicates the shipping carrier, such as USPS,\ + \ FedEx, or UPS. Although this field uses the\ + \ string type, the seller must pass in a pre-defined enumeration\ + \ value here.

For a full list of shipping carrier enum values\ + \ for a specified eBay marketplace, the GeteBayDetails call of\ + \ the Trading API can be used, and the DetailName field's\ + \ value should be set to ShippingCarrierDetails. The enum\ + \ values for each shipping carriers can be found in each ShippingCarrierDetails.ShippingCarrier\ + \ field in the response payload.

This field is actually optional,\ + \ as the shipping carrier is also tied into the shippingServiceCode\ + \ enum value, and that field is required for every specified shipping\ + \ service option.

This field is returned if set." shippingCost: - description: This container is used to set the shipping cost to ship one item using the corresponding shipping service option. This container is conditionally required if the seller is using flat-rate shipping and is not using a domestic or international shipping rate table. This container is not necessary for calculated shipping, since eBay will calculate the shipping cost and display it in the View Item page based off of the potential buyer's ship-to location.

This value is automatically set to 0.0 for the first specified domestic shipping service option and if the corresponding freeShipping field is set to true.

This container is returned if set for the policy. - $ref: '#/components/schemas/Amount' + description: "This container is used to set the shipping cost to ship one\ + \ item using the corresponding shipping service option. This container\ + \ is conditionally required if the seller is using flat-rate shipping\ + \ and is not using a domestic or international shipping rate table.
This container is not necessary for calculated shipping, since\ + \ eBay will calculate the shipping cost and display it in the View Item\ + \ page based off of the potential buyer's ship-to location.

This\ + \ value is automatically set to 0.0 for the first specified\ + \ domestic shipping service option and if the corresponding freeShipping\ + \ field is set to true.

This container is returned\ + \ if set for the policy." + $ref: "#/components/schemas/Amount" shippingServiceCode: - type: string - description: This field sets/indicates the domestic or international shipping service option, such as USPSPriority, FedEx2Day, or UPS3rdDay. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here. For a full list of shipping service option enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingServiceDetails. The enum values for each shipping service option can be found in each ShippingServiceDetails.ShippingService field in the response payload. The seller must make sure that the shipping service option is still valid, which is indicated by a true value in the corresponding ValidForSellingFlow boolean field. International shipping service options are typically returned at the top of the response payload, and are indicated by an InternationalService boolean field that reads true. The InternationalService boolean field is not returned at all for domestic shipping service options.

This field is required for every specified shipping service option.

This field is returned if set. + type: "string" + description: "This field sets/indicates the domestic or international shipping\ + \ service option, such as USPSPriority, FedEx2Day,\ + \ or UPS3rdDay. Although this field uses the string\ + \ type, the seller must pass in a pre-defined enumeration value here.\ + \

For a full list of shipping service option enum values for\ + \ a specified eBay marketplace, the GeteBayDetails call of the\ + \ Trading API can be used, and the DetailName field's value\ + \ should be set to ShippingServiceDetails.

The\ + \ enum values for each shipping service option can be found in each ShippingServiceDetails.ShippingService\ + \ field in the response payload. The seller must make sure that the shipping\ + \ service option is still valid, which is indicated by a true\ + \ value in the corresponding ValidForSellingFlow boolean field.\ + \ International shipping service options are typically returned at the\ + \ top of the response payload, and are indicated by an InternationalService\ + \ boolean field that reads true.

The InternationalService\ + \ boolean field is not returned at all for domestic shipping service options.\ + \

This field is required for every specified shipping service\ + \ option.

This field is returned if set." shipToLocations: - description: This container is used to set the ship-to locations applicable to the corresponding shipping service option. Although the regionExcluded container is defined for RegionSet type and could technically be used here, it is recommened that only the regionIncluded container be used at the shipping service level. The excluded shipping regions (if any) can instead be set up in the top-level regionExcluded container. The regionIncluded and regionExcluded containers define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.

To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call GeteBayDetails with DetailName value set to ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in the regionIncluded.regionName field. For valid geographical region names, look for the ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields. For valid two-digit country codes, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition. For valid domestic region values, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields. The STATE_OR_PROVINCE region type is only applicable to the US and Canada, and valid values for US states are the same two-digit abbreviations used by the United States Postal Service, and valid values for Canadian provinces and territories are the same two-digit abbreviations used by the Canada Post. - $ref: '#/components/schemas/RegionSet' + description: "This container is used to set the ship-to locations applicable\ + \ to the corresponding shipping service option. Although the regionExcluded\ + \ container is defined for RegionSet type and could technically\ + \ be used here, it is recommened that only the regionIncluded container\ + \ be used at the shipping service level. The excluded shipping regions\ + \ (if any) can instead be set up in the top-level regionExcluded\ + \ container.

The regionIncluded and regionExcluded\ + \ containers define the geographical regions/countries/states or provinces/domestic\ + \ regions where the seller does and doesn't ship to with this fulfillment\ + \ policy.

To retrieve the valid geographical shipping region\ + \ values, two-digit country values, or special domestic regions for an\ + \ eBay marketplace, call GeteBayDetails with DetailName\ + \ value set to ExcludeShippingLocationDetails, then review\ + \ the ExcludeShippingLocationDetails containers in the response\ + \ for the strings you use in the regionIncluded.regionName field.\ + \
  • For valid geographical region names, look for the ExcludeShippingLocationDetails\ + \ containers in the GeteBayDetails response where the Region\ + \ value is Worldwide, and the valid values will be shown\ + \ in the corresponding Location fields.
  • For valid two-digit\ + \ country codes, look for ExcludeShippingLocationDetails\ + \ in the GeteBayDetails response where the Region value\ + \ is one of the defined geographical regions, and the valid values will\ + \ be shown in the corresponding Location fields. Alternatively,\ + \ you can find the two-digit country code values in the CountryCodeEnum type definition.
  • For valid domestic region\ + \ values, look for ExcludeShippingLocationDetails in the\ + \ GeteBayDetails response where the Region value is either\ + \ Domestic Location or Additional Locations,\ + \ and the valid values will be shown in the corresponding Location\ + \ fields.
The STATE_OR_PROVINCE region type is\ + \ only applicable to the US and Canada, and valid values for US states\ + \ are the same two-digit abbreviations used by the United States Postal Service,\ + \ and valid values for Canadian provinces and territories are the same\ + \ two-digit abbreviations used by the Canada Post." + $ref: "#/components/schemas/RegionSet" sortOrder: - type: integer - description: 'The integer value set in this field controls the order of the corresponding domestic or international shipping service option in the View Item and Checkout pages.

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

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

If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call.

Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).' - format: int32 + type: "integer" + description: "The integer value set in this field controls the order of\ + \ the corresponding domestic or international shipping service option\ + \ in the View Item and Checkout pages.

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

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

If the sortOrder field is not supplied, the order of\ + \ domestic and international shipping service options is determined by\ + \ the order in which they are listed in the API call.

Min:\ + \ 1. Max: 4 (for domestic shipping service) or 5 (for international\ + \ shipping service)." + format: "int32" surcharge: - description: Note: DO NOT USE THIS FIELD. Shipping surcharges for domestic shipping service options can no longer be set with fulfillment business policies, except through shipping rate tables. To do this, a seller would set up a surcharge-based shipping rate table and specify the surcharge in that table. Then, the seller would need to associate this shipping rate table to the fulfillment business policy by specifying the unique ID of the shipping rate table through the shippingOptions.rateTableId field.

Shipping surcharges cannot be applied at all to international shipping service options. - $ref: '#/components/schemas/Amount' - description: This type is used by the shippingServices array, an array that provides details about every domestic and international shipping service option that is defined for the policy. + description: " Note: DO NOT USE\ + \ THIS FIELD. Shipping surcharges for domestic shipping service options\ + \ can no longer be set with fulfillment business policies, except through\ + \ shipping rate tables.

To do this, a seller would set up\ + \ a surcharge-based shipping rate table and specify the surcharge in that\ + \ table. Then, the seller would need to associate this shipping rate table\ + \ to the fulfillment business policy by specifying the unique ID of the\ + \ shipping rate table through the shippingOptions.rateTableId field.\ + \ Shipping surcharges cannot be applied at all to international\ + \ shipping service options." + $ref: "#/components/schemas/Amount" + description: "This type is used by the shippingServices array, an array\ + \ that provides details about every domestic and international shipping service\ + \ option that is defined for the policy." + SpecialHours: + type: "object" + properties: + date: + type: "string" + description: "A date value is required for each specific\ + \ date that the store location has special operating hours.

The\ + \ timestamp is formatted as an ISO 8601 string,\ + \ which is based on the 24-hour Coordinated Universal Time (UTC) clock.\ + \

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2018-08-04T07:09:00.000Z

This\ + \ field is returned if set for the store location." + intervals: + type: "array" + description: "This container is used to define the opening and closing times\ + \ of a store on a specific date (defined in the date\ + \ field). An intervals container is needed for each specific\ + \ date that the store has special operating hours. These special operating\ + \ hours on the specific date override the normal operating hours for the\ + \ specific day of the week. If a store location closes for lunch (or any\ + \ other period during the day) and then reopens, multiple open\ + \ and close pairs are needed.

This container\ + \ is returned if set for the store location." + items: + $ref: "#/components/schemas/Interval" + description: "This type is used to express the special operating hours of a\ + \ store location on a specific date. A specialHours container\ + \ is needed when the store's opening hours on a specific date are different\ + \ than the normal operating hours on that particular day of the week." + Subscription: + type: "object" + properties: + marketplaceId: + type: "string" + description: "The marketplace with which the subscription is associated.\ + \ For implementation help, refer to eBay\ + \ API documentation" + subscriptionId: + type: "string" + description: "The subscription ID." + subscriptionLevel: + type: "string" + description: "The subscription level. For example, subscription levels for\ + \ an eBay store include Starter, Basic, Featured, Anchor, and Enterprise\ + \ levels." + subscriptionType: + type: "string" + description: "The kind of entity with which the subscription is associated,\ + \ such as an eBay store. For implementation help, refer to eBay\ + \ API documentation" + term: + description: "The term of the subscription plan (typically in months)." + $ref: "#/components/schemas/TimeDuration" + description: "This type is used by the getSubscription response\ + \ container, which defines the subscription types and levels for the seller\ + \ account." + SubscriptionResponse: + type: "object" + properties: + href: + type: "string" + description: "This field is for future use." + limit: + type: "integer" + description: "This field is for future use." + format: "int32" + next: + type: "string" + description: "This field is for future use." + subscriptions: + type: "array" + description: "An array of subscriptions associated with the seller account." + items: + $ref: "#/components/schemas/Subscription" + total: + type: "integer" + description: "The total number of subscriptions displayed on the current\ + \ page of results." + format: "int32" + description: "This type is used by the response payload for the getSubscription\ + \ method.

Note: Pagination has\ + \ not yet been enabled for getSubscription, so all of the pagination-related\ + \ fields are for future use." TimeDuration: - type: object + type: "object" properties: unit: - type: string - description: These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to eBay API documentation + type: "string" + description: "These enum values represent the time measurement unit, such\ + \ as DAY. A span of time is defined when you apply the value\ + \ specified in the value field to the value specified for unit.\ + \

See TimeDurationUnitEnum for a complete list of possible\ + \ time-measurement units. For implementation help, refer to eBay\ + \ API documentation" value: - type: integer - description: An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. - format: int32 - description: A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned. + type: "integer" + description: "An integer that represents an amount of time, as measured\ + \ by the time-measurement unit specified in the unit field." + format: "int32" + description: "A type used to specify a period of time using a specified time-measurement\ + \ unit. Payment, return, and fulfillment business policies all use this type\ + \ to specify time windows.

Whenever a container that uses this type\ + \ is used in a request, both of these fields are required. Similarly, whenever\ + \ a container that uses this type is returned in a response, both of these\ + \ fields are always returned." securitySchemes: api_auth: - type: oauth2 - description: The security definitions for this API. Please check individual operations for applicable scopes. + type: "oauth2" + description: "The security definitions for this API. Please check individual\ + \ operations for applicable scopes." flows: + clientCredentials: + tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token" + scopes: + https://api.ebay.com/oauth/api_scope: "View public data from eBay" authorizationCode: - authorizationUrl: https://auth.ebay.com/oauth2/authorize - tokenUrl: https://api.ebay.com/identity/v1/oauth2/token + authorizationUrl: "https://auth.ebay.com/oauth2/authorize" + tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token" scopes: - https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings - https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings + https://api.ebay.com/oauth/api_scope/sell.inventory: "View and manage\ + \ your inventory and offers" + https://api.ebay.com/oauth/api_scope/sell.account.readonly: "View your\ + \ account settings" + https://api.ebay.com/oauth/api_scope/sell.inventory.readonly: "View your\ + \ inventory and offers" + https://api.ebay.com/oauth/api_scope/sell.account: "View and manage your\ + \ account settings" diff --git a/api-specs/sell_feed_v1_oas3.yaml b/api-specs/sell_feed_v1_oas3.yaml index ef9f8fd3..58641623 100644 --- a/api-specs/sell_feed_v1_oas3.yaml +++ b/api-specs/sell_feed_v1_oas3.yaml @@ -1461,6 +1461,10 @@ paths: domain: API_FEED category: REQUEST description: The file you tried to upload is too large. Please try using a smaller file. For more information, see the documentation for this API. + '160100': + domain: API_FEED + category: REQUEST + description: Payload not found. Make sure your file is uploaded inside the Request Body under the key name 'file'. '403': description: Forbidden x-response-codes: @@ -1738,13 +1742,10 @@ components: description: The schemaVersion/version number of the file format (use the schema version of the API to which you are programming): feedType: type: string - description: The feed type associated with the inventory task you are about to create. Use a feedType that is available for your API. Presently, only one feed type is available:
  • LMS_ACTIVE_INVENTORY_REPORT


See Report download feed types for more information. + description: The feed type associated with the inventory task you are about to create. Use a feedType that is available for your API. Presently, only one feed type is available:
  • LMS_ACTIVE_INVENTORY_REPORT

See Report download feed types for more information. filterCriteria: - description: The container for the filter fields. This container is used to set the filter criteria for the ActiveInventoryReport. A seller can set date range filters and/or can retrieve listings in a specific state, date, or format. + description: The container for the filter fields. This container is used to set the filter criteria for the ActiveInventoryReport. A seller can retrieve listings for a specified format. $ref: '#/components/schemas/InventoryFilterCriteria' - inventoryFileTemplate: - type: string - description: The inventory file template used to return specific types of inventory tasks. Presently not applicable for LMS_ACTIVE_INVENTORY_REPORT. For implementation help, refer to eBay API documentation CreateOrderTaskRequest: type: object properties: @@ -1954,19 +1955,10 @@ components: InventoryFilterCriteria: type: object properties: - creationDateRange: - description: The creation date range of the listings you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a creationDateRange, results from the last 10 days will be returned in ActiveInventoryReport by default. - $ref: '#/components/schemas/DateRange' - modifiedDateRange: - description: The modified date range of the listings you want returned. - $ref: '#/components/schemas/DateRange' listingFormat: type: string - description: The type of buying option for the order. Supports LMS_ACTIVE_INVENTORY_REPORT. For implementation help, refer to eBay API documentation - listingStatus: - type: string - description: The status of the listing (whether the listing was unsold or is active). The UNSOLD value does not apply to LMS_ACTIVE_INVENTORY_REPORT feed types. For implementation help, refer to eBay API documentation - description: The container for the filter fields. This container is used to set the filter criteria for the order report. A seller can set date range filters and/or can retrieve orders in a specific state. + description: The type of buying option for the order. For implementation help, refer to eBay API documentation + description: The container for the filter fields. This container is used to set the filter criteria for the order report. A seller can retrieve listings for a specified format. InventoryTask: type: object properties: @@ -1995,11 +1987,8 @@ components: description: This container provides summary information on an upload feed (not applicable for download feed types). $ref: '#/components/schemas/UploadSummary' filterCriteria: - description: This container is used to set the filter criteria for the ActiveInventoryReport. A seller can set date range filters and/or can retrieve listings in a specific state, date, or format. + description: This container is used to set the filter criteria for the ActiveInventoryReport. A seller can retrieve listings for a specified format. $ref: '#/components/schemas/InventoryFilterCriteria' - inventoryFileTemplate: - type: string - description: The inventory file template used to return specific types of inventory tasks, if set in the createInventoryTask method. This field does not apply to LMS_ACTIVE_INVENTORY_REPORT feed types. For implementation help, refer to eBay API documentation InventoryTaskCollection: type: object properties: diff --git a/api-specs/sell_finances_v1_oas3.yaml b/api-specs/sell_finances_v1_oas3.yaml index d7922d23..eb1ba471 100644 --- a/api-specs/sell_finances_v1_oas3.yaml +++ b/api-specs/sell_finances_v1_oas3.yaml @@ -7,7 +7,7 @@ info: license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement - version: v1.12.0 + version: v1.15.0 servers: - url: https://apiz.ebay.com{basePath} description: Production @@ -19,9 +19,15 @@ paths: get: tags: - payout - description: This method retrieves details on a specific seller payout. The unique identfier of the payout is passed in as a path parameter at the end of the call URI.

The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub. + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method retrieves details on a specific seller payout. The unique identfier of the payout is passed in as a path parameter at the end of the call URI.

The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub.' operationId: getPayout parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string - name: payout_Id in: path description: The unique identfier of the payout is passed in as a path parameter at the end of the call URI.

The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub to get the payout ID. @@ -60,9 +66,15 @@ paths: get: tags: - payout - description: This method is used to retrieve the details of one or more seller payouts. By using the filter query parameter, users can retrieve payouts processed within a specific date range, and/or they can retrieve payouts in a specific state.

There are also pagination and sort query parameters that allow users to control the payouts that are returned in the response.

If no payouts match the input criteria, an empty payload is returned. + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method is used to retrieve the details of one or more seller payouts. By using the filter query parameter, users can retrieve payouts processed within a specific date range, and/or they can retrieve payouts in a specific state.

There are also pagination and sort query parameters that allow users to control the payouts that are returned in the response.

If no payouts match the input criteria, an empty payload is returned.' operationId: getPayouts parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string - name: filter in: query description: 'The three filter types that can be used here are discussed below. If none of these filters are used, all recent payouts in all states are returned:
  • payoutDate: search for payouts within a specific range of dates. The date format to use is YYYY-MM-DDTHH:MM:SS.SSSZ. Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • lastAttemptedPayoutDate: search for attempted payouts that failed within a specific range of dates. In order to use this filter, the payoutStatus filter must also be used and its value must be set to RETRYABLE_FAILED. The date format to use is YYYY-MM-DDTHH:MM:SS.SSSZ. The same syntax used for the payoutDate filter is also used for the lastAttemptedPayoutDate filter.

    This filter is only applicable (and will return results) if one or more seller payouts have failed, but are retryable.
  • payoutStatus: search for payouts in a particular state. Only one payout state can be specified with this filter. The supported payoutStatus values are as follows:
    • INITIATED: search for payouts that have been initiated but not processed.
    • SUCCEEDED: search for successful payouts.
    • RETRYABLE_FAILED: search for payouts that failed, but ones which will be tried again. This value must be used if filtering by lastAttemptedPayoutDate.
    • TERMINAL_FAILED: search for payouts that failed, and ones that will not be tried again.
    • REVERSED: search for payouts that were reversed.
    Below is the proper syntax to use if filtering by payout status:

    https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutStatus:{SUCCEEDED}

If both the payoutDate and payoutStatus filters are used, payouts must satisfy both criteria to be returned. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' @@ -131,9 +143,15 @@ paths: get: tags: - payout - description: This method is used to retrieve cumulative values for payouts in a particular state, or all states. The metadata in the response includes total payouts, the total number of monetary transactions (sales, refunds, credits) associated with those payouts, and the total dollar value of all payouts.

If the filter query parameter is used to filter by payout status, only one payout status value may be used. If the filter query parameter is not used to filter by a specific payout status, cumulative values for payouts in all states are returned.

The user can also use the filter query parameter to specify a date range, and then only payouts that were processed within that date range are considered. + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method is used to retrieve cumulative values for payouts in a particular state, or all states. The metadata in the response includes total payouts, the total number of monetary transactions (sales, refunds, credits) associated with those payouts, and the total dollar value of all payouts.

If the filter query parameter is used to filter by payout status, only one payout status value may be used. If the filter query parameter is not used to filter by a specific payout status, cumulative values for payouts in all states are returned.

The user can also use the filter query parameter to specify a date range, and then only payouts that were processed within that date range are considered.' operationId: getPayoutSummary parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string - name: filter in: query description: 'The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect payouts, in all states, processed within the last 90 days.
  • payoutDate: consider payouts processed within a specific range of dates. The date format to use is YYYY-MM-DDTHH:MM:SS.SSSZ. Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • payoutStatus: consider only the payouts in a particular state. Only one payout state can be specified with this filter. The supported payoutStatus values are as follows:
    • INITIATED: search for payouts that have been initiated but not processed.
    • SUCCEEDED: consider only successful payouts.
    • RETRYABLE_FAILED: consider only payouts that failed, but ones which will be tried again.
    • TERMINAL_FAILED: consider only payouts that failed, and ones that will not be tried again.
    • REVERSED: consider only payouts that were reversed.
    Below is the proper syntax to use if filtering by payout status:

    https://apiz.ebay.com/sell/finances/v1/payout_summary?filter=payoutStatus:{SUCCEEDED}

If both the payoutDate and payoutStatus filters are used, only the payouts that satisfy both criteria are considered in the results. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' @@ -174,8 +192,15 @@ paths: get: tags: - seller_funds_summary - description: This method retrieves all pending funds that have not yet been distibuted through a seller payout.

There are no input parameters for this method. The response payload includes available funds, funds being processed, funds on hold, and also an aggregate count of all three of these categories.

If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of 204 - No Content is returned instead. + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method retrieves all pending funds that have not yet been distibuted through a seller payout.

There are no input parameters for this method. The response payload includes available funds, funds being processed, funds on hold, and also an aggregate count of all three of these categories.

If there are no funds that are pending, on hold, or being processed for the seller''s account, no response payload is returned, and an http status code of 204 - No Content is returned instead.' operationId: getSellerFundsSummary + parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string responses: '200': description: Success @@ -200,12 +225,18 @@ paths: get: tags: - transaction - description: This method allows a seller to retrieve one or monetary transactions. In this case, 'monetary transactions' include sales orders, buyer refunds, seller credits, buyer-initiated payment disputes, eBay shipping label purchases, and transfers. There are numerous input filters available for use, including filters to retrieve specific types of monetary transactions, to retrieve monetary transactions processed within a specific date range, or to retrieve monetary transactions in a specific state. See the filter field for more information on each filter, and how each one is used.

There are also pagination and sort query parameters that allow users to further control the monetary transactions that are returned in the response.

If no monetary transactions match the input criteria, an http status code of 204 No Content is returned with no response payload. + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


The getTransactions method allows a seller to retrieve information about one or more of their monetary transactions.

Note: For a complete list of transaction types, refer to TransactionTypeEnum.
Numerous input filters are available which can be used individualy or combined to refine the data that are returned. For example:
  • SALE transactions for August 15, 2022;
  • RETURN transactions for the month of January, 2021;
  • Transactions currently in a transactionStatus equal to FUNDS_ON_HOLD.
Refer to the filter field for additional information about each filter and its use.

Pagination and sort query parameters are also provided that allow users to further control how monetary transactions are displayed in the response.

If no monetary transactions match the input criteria, an http status code of 204 No Content is returned with no response payload.' operationId: getTransactions parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string - name: filter in: query - description: 'Numerous filters are available for the getTransactions method, and these filters are discussed below. One or more of these filter types can be used. If none of these filters are used, all monetary transactions from the last 90 days are returned:
  • transactionDate: search for monetary transactions that occurred within a specific range of dates.

    Note: All dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.

    Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • transactionType: search for a specific type of monetary transaction. The supported transactionType values are as follows:
    • SALE: a sales order.
    • REFUND: a refund to the buyer after an order cancellation or return.
    • CREDIT: a credit issued by eBay to the seller''s account.
    • DISPUTE: a monetary transaction associated with a payment dispute between buyer and seller.
    • NON_SALE_CHARGE: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.
    • SHIPPING_LABEL: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.
    • TRANSFER: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
    • ADJUSTMENT: An adjustment is a monetary transaction where eBay is crediting or debiting the seller''s account.
    • WITHDRAWAL: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay.
    Below is the proper syntax to use if filtering by a monetary transaction type:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}
  • transactionStatus: this filter type is only applicable for sales orders, and allows the user to filter seller payouts in a particular state. The supported transactionStatus values are as follows:
    • PAYOUT: this indicates that the proceeds from the corresponding sales order has been paid out to the seller''s account.
    • FUNDS_PROCESSING: this indicates that the funds for the corresponding monetary transaction are currently being processed.
    • FUNDS_AVAILABLE_FOR_PAYOUT: this indicates that the proceeds from the corresponding sales order are available for a seller payout, but processing has not yet begun.
    • FUNDS_ON_HOLD: this indicates that the proceeds from the corresponding sales order are currently being held by eBay, and are not yet available for a seller payout.
    • COMPLETED: this indicates that the funds for the corresponding TRANSFER monetary transaction have transferred and the transaction has completed.
    • FAILED: this indicates the process has failed for the corresponding TRANSFER monetary transaction.
    Below is the proper syntax to use if filtering by transaction status:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}
  • buyerUsername: the eBay user ID of the buyer involved in the monetary transaction. Only monetary transactions involving this buyer are returned. Below is the proper syntax to use if filtering by a specific eBay buyer:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234}
  • salesRecordReference: the unique Selling Manager identifier of the order involved in the monetary transaction. Only monetary transactions involving this Selling Manager Sales Record ID are returned. Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=salesRecordReference:{123}

    Note: For all orders originating after February 1, 2020, a value of 0 will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date.
  • payoutId: the unique identifier of a seller payout. This value is auto-generated by eBay once the seller payout is set to be processed. Only monetary transactions involving this Payout ID are returned. Below is the proper syntax to use if filtering by a specific Payout ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{5********8}
  • transactionId: the unique identifier of a monetary transaction. For a sales order, the orderId filter should be used instead. Only the monetary transaction defined by the identifier is returned.

    Note: This filter cannot be used alone; the transactionType must also be specified when filtering by transaction ID.

    Below is the proper syntax to use if filtering by a specific transaction ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}
  • orderId: the unique identifier of a sales order. For any other monetary transaction, the transactionId filter should be used instead. Only the sales order defined by the identifier is returned. Below is the proper syntax to use if filtering by a specific order ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-0***0-3***3}
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' + description: 'Numerous filters are available for the getTransactions method, and these filters are discussed below. One or more of these filter types can be used. If none of these filters are used, all monetary transactions from the last 90 days are returned:
  • transactionDate: search for monetary transactions that occurred within a specific range of dates.

    Note: All dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.

    Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • transactionType: search for a specific type of monetary transaction. The supported transactionType values are as follows:
    • SALE: a sales order.
    • REFUND: a refund to the buyer after an order cancellation or return.
    • CREDIT: a credit issued by eBay to the seller''s account.
    • DISPUTE: a monetary transaction associated with a payment dispute between buyer and seller.
    • NON_SALE_CHARGE: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.
    • SHIPPING_LABEL: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.
    • TRANSFER: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
    • ADJUSTMENT: An adjustment is a monetary transaction where eBay is crediting or debiting the seller''s account.
    • WITHDRAWAL: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay.

      Note: On-demand payout is not available for sellers who are already on a daily payout schedule. In order to initiate an on-demand payout, a seller must be on a weekly, bi-weekly, or monthly payout schedule.
    • LOAN_REPAYMENT: A monetary transaction related to the repayment of an outstanding loan balance for approved participants enrolled in the eBay Seller Capital financing program.

      Note: eBay Seller Capital financing is only available in select marketplaces. Refer to Marketplace availability for eBay Seller Capital funding program for current marketplace eligibility.
    Below is the proper syntax to use if filtering by a monetary transaction type:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionType:{SALE}
  • transactionStatus: this filter type is only applicable for sales orders, and allows the user to filter seller payouts in a particular state. The supported transactionStatus values are as follows:
    • PAYOUT: this indicates that the proceeds from the corresponding sales order has been paid out to the seller''s account.
    • FUNDS_PROCESSING: this indicates that the funds for the corresponding monetary transaction are currently being processed.
    • FUNDS_AVAILABLE_FOR_PAYOUT: this indicates that the proceeds from the corresponding sales order are available for a seller payout, but processing has not yet begun.
    • FUNDS_ON_HOLD: this indicates that the proceeds from the corresponding sales order are currently being held by eBay, and are not yet available for a seller payout.
    • COMPLETED: this indicates that the funds for the corresponding TRANSFER monetary transaction have transferred and the transaction has completed.
    • FAILED: this indicates the process has failed for the corresponding TRANSFER monetary transaction.
    Below is the proper syntax to use if filtering by transaction status:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionStatus:{PAYOUT}
  • buyerUsername: the eBay user ID of the buyer involved in the monetary transaction. Only monetary transactions involving this buyer are returned. Below is the proper syntax to use if filtering by a specific eBay buyer:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=buyerUsername:{buyer1234}
  • salesRecordReference: the unique Selling Manager identifier of the order involved in the monetary transaction. Only monetary transactions involving this Selling Manager Sales Record ID are returned. Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=salesRecordReference:{123}

    Note: For all orders originating after February 1, 2020, a value of 0 will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date.
  • payoutId: the unique identifier of a seller payout. This value is auto-generated by eBay once the seller payout is set to be processed. Only monetary transactions involving this Payout ID are returned. Below is the proper syntax to use if filtering by a specific Payout ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=payoutId:{5********8}
  • transactionId: the unique identifier of a monetary transaction. For a sales order, the orderId filter should be used instead. Only the monetary transaction defined by the identifier is returned.

    Note: This filter cannot be used alone; the transactionType must also be specified when filtering by transaction ID.

    Below is the proper syntax to use if filtering by a specific transaction ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}
  • orderId: the unique identifier of a sales order. For any other monetary transaction, the transactionId filter should be used instead. Only the sales order defined by the identifier is returned. Below is the proper syntax to use if filtering by a specific order ID:

    https://apiz.ebay.com/sell/finances/v1/transaction?filter=orderId:{0*-0***0-3***3}
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' required: false schema: type: string @@ -279,12 +310,18 @@ paths: get: tags: - transaction - description: This method is used to retrieve cumulative values for five types of monetary transactions (order sales, seller credits, buyer refunds, buyer-initiated payment disputes, eBay shipping label purchases, and transfers). If applicable, the number of payment holds and the amount of the holds are also returned.

See the description for the filter query parameter for more information on the available filters.

Note: Unless the transactionType filter is used to retrieve a specific type of monetary transaction (such as sale, buyer refund, seller credit, payment dispute, shipping label, transfer, etc.), the creditCount and creditAmount response fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types). + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


The getTransactionSummary method retrieves cumulative information for monetary transactions. If applicable, the number of payments with a transactionStatus equal to FUNDS_ON_HOLD and the total monetary amount of these on-hold payments are also returned.

Note: For a complete list of transaction types, refer to TransactionTypeEnum.
Refer to the filter field for additional information about each filter and its use.

Note: Unless a transactionType filter is used to retrieve a specific type of transaction (e.g., SALE, REFUND, etc.,) the creditCount and creditAmount response fields both include order sales and seller credits information. That is, the count and value fields do not distinguish between these two types monetary transactions.' operationId: getTransactionSummary parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string - name: filter in: query - description: 'Numerous filters are available for the getTransactionSummary method, and these filters are discussed below. One or more of these filter types can be used. The transactionStatus filter must be used. All other filters are optional.
  • transactionStatus: the data returned in the response pertains to the sales, payouts, and transfer status set. The supported transactionStatus values are as follows:
    • PAYOUT: only consider monetary transactions where the proceeds from the sales order(s) have been paid out to the seller''s bank account.
    • FUNDS_PROCESSING: only consider monetary transactions where the proceeds from the sales order(s) are currently being processed.
    • FUNDS_AVAILABLE_FOR_PAYOUT: only consider monetary transactions where the proceeds from the sales order(s) are available for a seller payout, but processing has not yet begun.
    • FUNDS_ON_HOLD: only consider monetary transactions where the proceeds from the sales order(s) are currently being held by eBay, and are not yet available for a seller payout.
    • COMPLETED: this indicates that the funds for the corresponding TRANSFER monetary transaction have transferred and the transaction has completed.
    • FAILED: this indicates the process has failed for the corresponding TRANSFER monetary transaction.
    Below is the proper syntax to use when setting up the transactionStatus filter:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}
  • transactionDate: only consider monetary transactions that occurred within a specific range of dates.

    Note: All dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.

    Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • transactionType: only consider a specific type of monetary transaction. The supported transactionType values are as follows:
    • SALE: a sales order.
    • REFUND: a refund to the buyer after an order cancellation or return.
    • CREDIT: a credit issued by eBay to the seller''s account.
    • DISPUTE: a monetary transaction associated with a payment dispute between buyer and seller.
    • NON_SALE_CHARGE: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.
    • SHIPPING_LABEL: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.
    • TRANSFER: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
    • ADJUSTMENT: An adjustment is a monetary transaction where eBay is crediting or debiting the seller''s account.
    • WITHDRAWAL: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay.
    Below is the proper syntax to use if filtering by a monetary transaction type:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}
  • buyerUsername: only consider monetary transactions involving a specific buyer (specified with the buyer''s eBay user ID). Below is the proper syntax to use if filtering by a specific eBay buyer:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234}
  • salesRecordReference: only consider monetary transactions corresponding to a specific order (identified with a Selling Manager order identifier). Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=salesRecordReference:{123}

    Note: For all orders originating after February 1, 2020, a value of 0 will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date.
  • payoutId: only consider monetary transactions related to a specific seller payout (identified with a Payout ID). This value is auto-generated by eBay once the seller payout is set to be processed. Below is the proper syntax to use if filtering by a specific Payout ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{5********8}
  • transactionId: the unique identifier of a monetary transaction. For a sales order, the orderId filter should be used instead. Only the monetary transaction(s) associated with this transactionId value are returned.

    Note: This filter cannot be used alone; the transactionType must also be specified when filtering by transaction ID.

    Below is the proper syntax to use if filtering by a specific transaction ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}
  • orderId: the unique identifier of a sales order. For any other monetary transaction, the transactionId filter should be used instead. Only the monetary transaction(s) associated with this orderId value are returned. Below is the proper syntax to use if filtering by a specific order ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=orderId:{0*-0***0-3***3}
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' + description: 'Numerous filters are available for the getTransactionSummary method, and these filters are discussed below. One or more of these filter types can be used. The transactionStatus filter must be used. All other filters are optional.
  • transactionStatus: the data returned in the response pertains to the sales, payouts, and transfer status set. The supported transactionStatus values are as follows:
    • PAYOUT: only consider monetary transactions where the proceeds from the sales order(s) have been paid out to the seller''s bank account.
    • FUNDS_PROCESSING: only consider monetary transactions where the proceeds from the sales order(s) are currently being processed.
    • FUNDS_AVAILABLE_FOR_PAYOUT: only consider monetary transactions where the proceeds from the sales order(s) are available for a seller payout, but processing has not yet begun.
    • FUNDS_ON_HOLD: only consider monetary transactions where the proceeds from the sales order(s) are currently being held by eBay, and are not yet available for a seller payout.
    • COMPLETED: this indicates that the funds for the corresponding TRANSFER monetary transaction have transferred and the transaction has completed.
    • FAILED: this indicates the process has failed for the corresponding TRANSFER monetary transaction.
    Below is the proper syntax to use when setting up the transactionStatus filter:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionStatus:{PAYOUT}
  • transactionDate: only consider monetary transactions that occurred within a specific range of dates.

    Note: All dates must be input using UTC format (YYYY-MM-DDTHH:MM:SS.SSSZ) and should be adjusted accordingly for the local timezone of the user.

    Below is the proper syntax to use if filtering by a date range:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionDate:[2018-10-23T00:00:01.000Z..2018-11-09T00:00:01.000Z]

    Alternatively, the user could omit the ending date, and the date range would include the starting date and up to 90 days past that date, or the current date if the starting date is less than 90 days in the past.
  • transactionType: only consider a specific type of monetary transaction. The supported transactionType values are as follows:
    • SALE: a sales order.
    • REFUND: a refund to the buyer after an order cancellation or return.
    • CREDIT: a credit issued by eBay to the seller''s account.
    • DISPUTE: a monetary transaction associated with a payment dispute between buyer and seller.
    • NON_SALE_CHARGE: a monetary transaction involving a seller transferring money to eBay for the balance of a charge for NON_SALE_CHARGE transactions (transactions that contain non-transactional seller fees). These can include a one-time payment, monthly/yearly subscription fees charged monthly, NRC charges, and fee credits.
    • SHIPPING_LABEL: a monetary transaction where eBay is billing the seller for an eBay shipping label. Note that the shipping label functionality will initially only be available to a select number of sellers.
    • TRANSFER: A transfer is a monetary transaction where eBay is billing the seller for reimbursement of a charge. An example of a transfer is a seller reimbursing eBay for a buyer refund.
    • ADJUSTMENT: An adjustment is a monetary transaction where eBay is crediting or debiting the seller''s account.
    • WITHDRAWAL: A withdrawal is a monetary transaction where the seller requests an on-demand payout from eBay.

      Note: On-demand payout is not available for sellers who are already on a daily payout schedule. In order to initiate an on-demand payout, a seller must be on a weekly, bi-weekly, or monthly payout schedule.
    • LOAN_REPAYMENT: A monetary transaction related to the repayment of an outstanding loan balance for approved participants enrolled in the eBay Seller Capital financing program.

      Note: eBay Seller Capital financing is only available in select marketplaces. Refer to Marketplace availability for eBay Seller Capital funding program for current marketplace eligibility.
    Below is the proper syntax to use if filtering by a monetary transaction type:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionType:{SALE}
  • buyerUsername: only consider monetary transactions involving a specific buyer (specified with the buyer''s eBay user ID). Below is the proper syntax to use if filtering by a specific eBay buyer:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=buyerUsername:{buyer1234}
  • salesRecordReference: only consider monetary transactions corresponding to a specific order (identified with a Selling Manager order identifier). Below is the proper syntax to use if filtering by a specific Selling Manager Sales Record ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=salesRecordReference:{123}

    Note: For all orders originating after February 1, 2020, a value of 0 will be returned in the salesRecordReference field. So, this filter will only be useful to retrieve orders than occurred before this date.
  • payoutId: only consider monetary transactions related to a specific seller payout (identified with a Payout ID). This value is auto-generated by eBay once the seller payout is set to be processed. Below is the proper syntax to use if filtering by a specific Payout ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=payoutId:{5********8}
  • transactionId: the unique identifier of a monetary transaction. For a sales order, the orderId filter should be used instead. Only the monetary transaction(s) associated with this transactionId value are returned.

    Note: This filter cannot be used alone; the transactionType must also be specified when filtering by transaction ID.

    Below is the proper syntax to use if filtering by a specific transaction ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=transactionId:{0*-0***0-3***3}&filter=transactionType:{SALE}
  • orderId: the unique identifier of a sales order. For any other monetary transaction, the transactionId filter should be used instead. Only the monetary transaction(s) associated with this orderId value are returned. Below is the proper syntax to use if filtering by a specific order ID:

    https://apiz.ebay.com/sell/finances/v1/transaction_summary?filter=orderId:{0*-0***0-3***3}
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField' required: false schema: type: string @@ -334,9 +371,15 @@ paths: get: tags: - transfer - description: This method retrieves detailed information regarding a TRANSFER transaction type. A TRANSFER is a monetary transaction type that involves a seller transferring money to eBay for reimbursement of one or more charges. For example, when a seller reimburses eBay for a buyer refund.

If an ID is passed into the URI that is an identifier for another transaction type, this call will return an http status code of 404 Not found. + description: '

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method retrieves detailed information regarding a TRANSFER transaction type. A TRANSFER is a monetary transaction type that involves a seller transferring money to eBay for reimbursement of one or more charges. For example, when a seller reimburses eBay for a buyer refund.

If an ID is passed into the URI that is an identifier for another transaction type, this call will return an http status code of 404 Not found.' operationId: getTransfer parameters: + - name: X-EBAY-C-MARKETPLACE-ID + in: header + description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US. See HTTP request headers for the marketplace ID values. + required: false + schema: + type: string - name: transfer_Id in: path description: The unique identifier of the TRANSFER transaction type you wish to retrieve. @@ -505,10 +548,10 @@ components: properties: regionName: type: string - description: String value that indicates the name of the region to which a region-specific fee applies.

The set of valid regionName values that may be returned is determined by the regionType value.

Note: Currently, supported regionName values that may be returned are standard two-character country codes.

Typical examples include:
  • MX [Mexico]
  • IN [India]
  • US [United States]
 + description: String value that indicates the name of the region to which a region-specific fee applies.

The set of valid regionName values that may be returned is determined by the regionType value.

Note: Currently, supported regionName values that may be returned are standard two-character country or state codes.

Typical examples include:
  • MX [Mexico]
  • IN [India]
  • US [United States]
  • CA [California]
  • VT [Vermont]
  • ME [Maine]
 regionType: type: string - description: The enumeration value returned here indicates the type of region that is collecting the corresponding fee.
Note: Currently, the only supported regionType is COUNTRY. For implementation help, refer to eBay API documentation + description: The enumeration value returned here indicates the type of region that is collecting the corresponding fee. For implementation help, refer to eBay API documentation description: This container returns jurisdiction information about region-specific fees that are charged to sellers. FundingSource: type: object @@ -568,6 +611,12 @@ components: payoutStatusDescription: type: string description: 'This field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the payoutStatus field. The following shows what description text might appear based on the different payoutStatus values:
  • INITIATED: Preparing to send
  • SUCCEEDED: Funds sent
  • REVERSED: Waiting to retry : Money rejected by seller''s bank
  • RETRYABLE_FAILED: Waiting to retry
  • TERMINAL_FAILED: Payout failed
' + totalAmount: + description: This container indicates the sum of a seller's net payout amount plus the EXPRESS_PAYOUT_FEE charged by eBay. The is expressed as a numeric value and the currency used. + $ref: '#/components/schemas/Amount' + totalFee: + description: This container indicates the amount of the EXPRESS_PAYOUT_FEE charged by eBay when a seller requests payout to a debit card. The fee is expressed as a numeric value and the currency used. + $ref: '#/components/schemas/Amount' transactionCount: type: integer description: This integer value indicates the number of monetary transactions (all orders, refunds, and credits, etc.) that have occurred with the corresponding payout. Its value should always be at least 1, since there is at least one order per seller payout. @@ -669,6 +718,9 @@ components: buyer: description: This is the unique eBay user ID for the buyer who purchased the order. This field is not returned for TRANSFER monetary transaction types. $ref: '#/components/schemas/Buyer' + eBayCollectedTaxAmount: + description: This is the amount of sales tax that has been collected by eBay for an order.

Note: Sales tax applies only to SALE and REFUND transactions (transactionType). + $ref: '#/components/schemas/Amount' feeJurisdiction: description: This container stores information about region-specific fees that are charged to sellers.

This is returned for fees (i.e., FeeTypeEnum values,) that are mandated by a seller's governing jurisdiction.

For example:
  • INCOME_TAX_WITHHOLDING
  • TAX_DEDUCTION_AT_SOURCE
  • VAT_WITHHOLDING
$ref: '#/components/schemas/FeeJurisdiction' @@ -762,6 +814,16 @@ components: type: integer description: This integer value indicates the total number of payment disputes that have been initiated by one or more buyers. Only the orders that match the input criteria are considered. The Payment Disputes methods in the Fulfillment API can be used by the seller to retrieve more information about any payment disputes.

This field is generally returned, even if 0, but it will not be returned if a transactionType filter is used, and its value is set to any value other than DISPUTE. format: int32 + loanRepaymentAmount: + description: The sum of all LOAN_REPAYMENT transactions (i.e., debit and credit,) that match the input criteria.

For example, within a specified transactionDate range, three LOAN_REPAYMENT transactions are identified:
  • DEBIT of 15.00 USD
  • DEBIT of 10.00 USD
  • CREDIT of 5.00 USD
The net amount of these three transactions is a DEBIT of 20.00 USD to the seller's account. Therefore, the value returned for loanRepaymentAmount will be 20.00 USD.

Note: For this example:
  • The value returned for loanRepaymentCount will be 3
  • The loanRepaymentBookingEntry will be DEBIT


If there are no transactions that match the input criteria (i.e., loanRepaymentCount=0,) this container is not returned. + $ref: '#/components/schemas/Amount' + loanRepaymentBookingEntry: + type: string + description: The enumeration value indicates whether the loanRepaymentAmount is a DEBIT against, or a CREDIT to, the sellers's account.

For most loanRepaymentAmount transactions, loanRepaymentBookingEntry will be DEBIT. However, if a loan repayment transaction is reversed, that transaction will be shown as a CREDIT. For implementation help, refer to eBay API documentation + loanRepaymentCount: + type: integer + description: This integer value indicates the total number of LOAN_REPAYMENT transactions (i.e., DEBIT and CREDIT,) that match the input criteria.

This field is generally returned even if it equals 0. However it will not be returned if a transactionType filter is used and its value has been set to any enumeration value other than LOAN_REPAYMENT. + format: int32 nonSaleChargeAmount: description: The total non-sale charge amount for given payee within a specified period. $ref: '#/components/schemas/Amount' diff --git a/api-specs/sell_fulfillment_v1_oas3.yaml b/api-specs/sell_fulfillment_v1_oas3.yaml index a7f5bd21..710cf935 100644 --- a/api-specs/sell_fulfillment_v1_oas3.yaml +++ b/api-specs/sell_fulfillment_v1_oas3.yaml @@ -1,2417 +1,4233 @@ -openapi: 3.0.0 +--- +openapi: "3.0.0" info: - title: Fulfillment API - description: Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on behalf of the seller, in accordance with the payment method and timing specified at checkout. + title: "Fulfillment API" + description: "Use the Fulfillment API to complete the process of packaging, addressing,\ + \ handling, and shipping each order on behalf of the seller, in accordance with\ + \ the payment method and timing specified at checkout." contact: - name: eBay Inc. + name: "eBay Inc." license: - name: eBay API License Agreement - url: https://go.developer.ebay.com/api-license-agreement - version: v1.19.13 + name: "eBay API License Agreement" + url: "https://go.developer.ebay.com/api-license-agreement" + version: "v1.19.17" servers: - - url: https://api.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 +- url: "https://api.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" +- url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" paths: /order/{orderId}: get: tags: - - order - description: 'Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call''s orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees.

The returned Order object contains information you can use to create and process fulfillments, including:
  • Information about the buyer and seller
  • Information about the order''s line items
  • The plans for packaging, addressing and shipping the order
  • The status of payment, packaging, addressing, and shipping the order
  • A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs
  • A summary of applied taxes and fees, and optionally a breakdown of each
' - operationId: getOrder + - "order" + description: "Use this call to retrieve the contents of an order based on its\ + \ unique identifier, orderId. This value was returned in the getOrders\ + \ call's orders.orderId field when you searched for orders by creation\ + \ date, modification date, or fulfillment status. Include the optional fieldGroups\ + \ query parameter set to TAX_BREAKDOWN to return a breakdown\ + \ of the taxes and fees.

The returned Order object contains\ + \ information you can use to create and process fulfillments, including:
    \ + \
  • Information about the buyer and seller
  • Information about the\ + \ order's line items
  • The plans for packaging, addressing and shipping\ + \ the order
  • The status of payment, packaging, addressing, and shipping\ + \ the order
  • A summary of monetary amounts specific to the order such\ + \ as pricing, payments, and shipping costs
  • A summary of applied taxes\ + \ and fees, and optionally a breakdown of each
" + operationId: "getOrder" parameters: - - name: fieldGroups - in: query - description: The response type associated with the order. The only presently supported value is TAX_BREAKDOWN. This type returns a breakdown of tax and fee values associated with the order. - required: false - schema: - type: string - - name: orderId - in: path - description: The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.

Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getOrder method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. - required: true - schema: - type: string + - name: "fieldGroups" + in: "query" + description: "The response type associated with the order. The only presently\ + \ supported value is TAX_BREAKDOWN. This type returns a breakdown\ + \ of tax and fee values associated with the order." + required: false + schema: + type: "string" + - name: "orderId" + in: "path" + description: "The unique identifier of the order. Order ID values are shown\ + \ in My eBay/Seller Hub, and are also returned by the getOrders method\ + \ in the orders.orderId field." + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/Order' - '400': - description: Bad Request + $ref: "#/components/schemas/Order" + 400: + description: "Bad Request" x-response-codes: errors: - '32100': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid order ID: {orderId}' - '32800': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid field group: {fieldGroup}' - '404': - description: Not Found - '500': - description: Internal Server Error + 32800: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid field group: {fieldGroup}" + 32100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid order ID: {orderId}" + 500: + description: "Internal Server Error" x-response-codes: errors: - '30500': - domain: API_FULFILLMENT - category: APPLICATION - description: System error + 30500: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "System error" + 404: + description: "Not Found" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.fulfillment - - https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment" + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" /order: get: tags: - - order - description: 'Use this call to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees.

The returned Order objects contain information you can use to create and process fulfillments, including:
  • Information about the buyer and seller
  • Information about the order''s line items
  • The plans for packaging, addressing and shipping the order
  • The status of payment, packaging, addressing, and shipping the order
  • A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs
  • A summary of applied taxes and fees, and optionally a breakdown of each


Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests.' - operationId: getOrders + - "order" + description: "Use this call to search for and retrieve one or more orders based\ + \ on their creation date, last modification date, or fulfillment status using\ + \ the filter parameter. You can alternatively specify a list of orders\ + \ using the orderIds parameter. Include the optional fieldGroups\ + \ query parameter set to TAX_BREAKDOWN to return a breakdown\ + \ of the taxes and fees.

The returned Order objects contain\ + \ information you can use to create and process fulfillments, including:
    \ + \
  • Information about the buyer and seller
  • Information about the\ + \ order's line items
  • The plans for packaging, addressing and shipping\ + \ the order
  • The status of payment, packaging, addressing, and shipping\ + \ the order
  • A summary of monetary amounts specific to the order such\ + \ as pricing, payments, and shipping costs
  • A summary of applied taxes\ + \ and fees, and optionally a breakdown of each


Important: In this call, the cancelStatus.cancelRequests\ + \ array is returned but is always empty. Use the getOrder call instead,\ + \ which returns this array fully populated with information about any cancellation\ + \ requests." + operationId: "getOrders" parameters: - - name: fieldGroups - in: query - description: The response type associated with the order. The only presently supported value is TAX_BREAKDOWN. This type returns a breakdown of tax and fee values associated with the order. - required: false - schema: - type: string - - name: filter - in: query - description: 'One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results.

Note: Currently, filter returns data from only the last 90 days. If the orderIds parameter is included in the request, the filter parameter will be ignored.

The available criteria are as follows:
creationdate
The time period during which qualifying orders were created (the orders.creationDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example:
  • creationdate:[2016-02-21T08:25:43.511Z..] identifies orders created on or after the given timestamp.
  • creationdate:[2016-02-21T08:25:43.511Z..2016-04-21T08:25:43.511Z] identifies orders created between the given timestamps, inclusive.
lastmodifieddate
The time period during which qualifying orders were last modified (the orders.modifiedDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example:
  • lastmodifieddate:[2016-05-15T08:25:43.511Z..] identifies orders modified on or after the given timestamp.
  • lastmodifieddate:[2016-05-15T08:25:43.511Z..2016-05-31T08:25:43.511Z] identifies orders modified between the given timestamps, inclusive.
Note: If creationdate and lastmodifieddate are both included, only creationdate is used.

orderfulfillmentstatus
The degree to which qualifying orders have been shipped (the orders.orderFulfillmentStatus field). In the URI, this is expressed as one of the following value combinations:
  • orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS} specifies orders for which no shipping fulfillments have been started, plus orders for which at least one shipping fulfillment has been started but not completed.
  • orderfulfillmentstatus:{FULFILLED|IN_PROGRESS} specifies orders for which all shipping fulfillments have been completed, plus orders for which at least one shipping fulfillment has been started but not completed.
Note: The values NOT_STARTED, IN_PROGRESS, and FULFILLED can be used in various combinations, but only the combinations shown here are currently supported.
Here is an example of a getOrders call using all of these filters:

GET https://api.ebay.com/sell/v1/order?
filter=creationdate:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,
lastmodifieddate:%5B2016-05-15T08:25:43.511Z..%5D,
orderfulfillmentstatus:%7BNOT_STARTED%7CIN_PROGRESS%7D

Note: This call requires that certain special characters in the URI query string be percent-encoded:
    [ = %5B       ] = %5D       { = %7B       | = %7C       } = %7D
This query filter example uses these codes. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/fulfillment/types/api:FilterField' - required: false - schema: - type: string - - name: limit - in: query - description: The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 thru 20 from the result set.

If a limit is not set, the limit defaults to 50 and returns up to 50 orders. If a requested limit is more than 200, the call fails and returns an error.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0. If the orderIds parameter is included in the request, this parameter will be ignored.

Maximum: 200
Default: 50 - required: false - schema: - type: string - - name: offset - in: query - description: Specifies the number of orders to skip in the result set before returning the first order in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

- required: false - schema: - type: string - - name: orderIds - in: query - description: A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the orderIds query parameter, all other query parameters will be ignored.

Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getOrders method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. - required: false - schema: - type: string + - name: "fieldGroups" + in: "query" + description: "The response type associated with the order. The only presently\ + \ supported value is TAX_BREAKDOWN. This type returns a breakdown\ + \ of tax and fee values associated with the order." + required: false + schema: + type: "string" + - name: "filter" + in: "query" + description: "One or more comma-separated criteria for narrowing down the\ + \ collection of orders returned by this call. These criteria correspond\ + \ to specific fields in the response payload. Multiple filter criteria combine\ + \ to further restrict the results.

Note: Currently, filter returns data from only\ + \ the last 90 days. If the orderIds parameter is included in the\ + \ request, the filter parameter will be ignored.
The available criteria are as follows:
creationdate
\ + \
The time period during which qualifying orders were created (the orders.creationDate\ + \ field). In the URI, this is expressed as a starting timestamp, with or\ + \ without an ending timestamp (in brackets). The timestamps are in ISO 8601\ + \ format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For\ + \ example:
  • creationdate:[2016-02-21T08:25:43.511Z..]\ + \ identifies orders created on or after the given timestamp.
  • creationdate:[2016-02-21T08:25:43.511Z..2016-04-21T08:25:43.511Z]\ + \ identifies orders created between the given timestamps, inclusive.
    • \ + \
lastmodifieddate
The time\ + \ period during which qualifying orders were last modified (the orders.modifiedDate\ + \ field). In the URI, this is expressed as a starting timestamp, with or\ + \ without an ending timestamp (in brackets). The timestamps are in ISO 8601\ + \ format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For\ + \ example:
  • lastmodifieddate:[2016-05-15T08:25:43.511Z..]\ + \ identifies orders modified on or after the given timestamp.
  • lastmodifieddate:[2016-05-15T08:25:43.511Z..2016-05-31T08:25:43.511Z]\ + \ identifies orders modified between the given timestamps, inclusive.
    • \ + \
Note: If creationdate\ + \ and lastmodifieddate are both included, only creationdate\ + \ is used.

orderfulfillmentstatus
\ + \
The degree to which qualifying orders have been shipped (the orders.orderFulfillmentStatus\ + \ field). In the URI, this is expressed as one of the following value combinations:\ + \
  • orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS}\ + \ specifies orders for which no shipping fulfillments have been started,\ + \ plus orders for which at least one shipping fulfillment has been started\ + \ but not completed.
  • orderfulfillmentstatus:{FULFILLED|IN_PROGRESS}\ + \ specifies orders for which all shipping fulfillments have been completed,\ + \ plus orders for which at least one shipping fulfillment has been started\ + \ but not completed.
Note:\ + \ The values NOT_STARTED, IN_PROGRESS, and FULFILLED\ + \ can be used in various combinations, but only the combinations shown here\ + \ are currently supported.
Here is an example of a getOrders\ + \ call using all of these filters:

GET https://api.ebay.com/sell/v1/order?filter=creationdate:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,lastmodifieddate:%5B2016-05-15T08:25:43.511Z..%5D,
orderfulfillmentstatus:%7BNOT_STARTED%7CIN_PROGRESS%7D\ + \

Note: This call\ + \ requires that certain special characters in the URI query string be percent-encoded:\ + \
    [ = %5B       ]\ + \ = %5D       {\ + \ = %7B       |\ + \ = %7C       }\ + \ = %7D
This query filter example uses these codes.\ + \ For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/fulfillment/types/api:FilterField" + required: false + schema: + type: "string" + - name: "limit" + in: "query" + description: "The number of orders to return per page of the result set. Use\ + \ this parameter in conjunction with the offset parameter to control\ + \ the pagination of the output.

For example, if offset\ + \ is set to 10 and limit is set to 10,\ + \ the call retrieves orders 11 thru 20 from the result set.

\ + \ If a limit is not set, the limit defaults to 50 and returns up\ + \ to 50 orders. If a requested limit is more than 200, the call fails and\ + \ returns an error.

Note:\ + \ This feature employs a zero-based list, where the first item in the list\ + \ has an offset of 0. If the orderIds parameter is included\ + \ in the request, this parameter will be ignored.

Maximum:\ + \ 200
Default: 50" + required: false + schema: + type: "string" + - name: "offset" + in: "query" + description: "Specifies the number of orders to skip in the result set before\ + \ returning the first order in the paginated response.

Combine offset\ + \ with the limit query parameter to control the items returned in\ + \ the response. For example, if you supply an offset of 0\ + \ and a limit of 10, the first page of the response\ + \ contains the first 10 items from the complete list of items retrieved\ + \ by the call. If offset is 10 and limit is 20,\ + \ the first page of the response contains items 11-30 from the complete\ + \ result set.

Default: 0

" + required: false + schema: + type: "string" + - name: "orderIds" + in: "query" + description: "A comma-separated list of the unique identifiers of the orders\ + \ to retrieve (maximum 50). If one or more order ID values are specified\ + \ through the orderIds query parameter, all other query parameters\ + \ will be ignored." + required: false + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/OrderSearchPagedCollection' - '400': - description: Bad Request + $ref: "#/components/schemas/OrderSearchPagedCollection" + 400: + description: "Bad Request" x-response-codes: errors: - '30700': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid filter name: {fieldname}' - '30800': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid filter value {fieldvalue} for filter {fieldname} - '30810': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid date format - '30820': - domain: API_FULFILLMENT - category: REQUEST - description: Start date is missing - '30830': - domain: API_FULFILLMENT - category: REQUEST - description: Start date must be within 90 days of end date and current date. - '30840': - domain: API_FULFILLMENT - category: REQUEST - description: Start date should be before end date - '30850': - domain: API_FULFILLMENT - category: REQUEST - description: Start and end dates can't be in the future - '30900': - domain: API_FULFILLMENT - category: REQUEST - description: Exceeded maximum number of order IDs (the current limit is 50) - '31000': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid offset: {offsetvalue}' - '31100': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid limit: {limitvalue}' - '32800': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid field group: {fieldGroup}' - '500': - description: Internal Server Error + 30800: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid filter value {fieldvalue} for filter {fieldname}" + 32800: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid field group: {fieldGroup}" + 30850: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Start and end dates can't be in the future" + 30820: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Start date is missing" + 30900: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Exceeded maximum number of order IDs (the current limit\ + \ is 50)" + 30840: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Start date should be before end date" + 31000: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid offset: {offsetvalue}" + 30810: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid date format" + 30700: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid filter name: {fieldname}" + 31100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid limit: {limitvalue}" + 30830: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Start date must be within 90 days of end date and current\ + \ date." + 500: + description: "Internal Server Error" x-response-codes: errors: - '30500': - domain: API_FULFILLMENT - category: APPLICATION - description: System error + 30500: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "System error" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.fulfillment - - https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment" + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" /order/{order_id}/issue_refund: post: tags: - - order - summary: Issue Refund - description: This method allows a seller to issue a full or partial refund to a buyer for an order. Full or partial refunds can be issued at the order level or line item level.

The refunds issued through this method are processed asynchronously, so the refund will not show as 'Refunded' right away. A seller will have to make a subsequent getOrder call to check the status of the refund. The status of an order refund can be found in the paymentSummary.refunds.refundStatus field of the getOrder response. - operationId: issueRefund + - "order" + summary: "Issue Refund" + description: "

Important!\ + \ Due to EU & UK Payments regulatory requirements, an additional security\ + \ verification via Digital Signatures is required for certain API calls that\ + \ are made on behalf of EU/UK sellers, including issueRefund. Please\ + \ refer to Digital Signatures for APIs to learn more on the impacted APIs\ + \ and the process to create signatures to be included in the HTTP payload.


\ + \ This method allows a seller to issue a full or partial refund to a buyer\ + \ for an order. Full or partial refunds can be issued at the order level or\ + \ line item level.

The refunds issued through this method are processed\ + \ asynchronously, so the refund will not show as 'Refunded' right away. A\ + \ seller will have to make a subsequent getOrder call to check the status of the refund. \ + \ The status of an order refund can be found in the paymentSummary.refunds.refundStatus field of the getOrder response." + operationId: "issueRefund" parameters: - - name: order_id - in: path - description: The unique identifier of the order. Order IDs are returned in the getOrders method (and GetOrders call of Trading API). The issueRefund method supports the legacy API Order IDs and REST API order IDs.

Note: In the Trading API (and other legacy APIs), Order IDs are transitioning to a new format. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the identifier format, eBay is rolling out the Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely. See the OrderID field description in the GetOrders call for more details and requirements on transitioning to the new Order ID format. - required: true - schema: - type: string + - name: "order_id" + in: "path" + description: "The unique identifier of the order. Order IDs are returned in\ + \ the getOrders method (and GetOrders call of Trading API).\ + \ The issueRefund method supports the legacy API Order IDs and REST\ + \ API order IDs." + required: true + schema: + type: "string" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IssueRefundRequest' + $ref: "#/components/schemas/IssueRefundRequest" required: false responses: - '200': - description: OK + 200: + description: "OK" content: application/json: schema: - $ref: '#/components/schemas/Refund' - '400': - description: Bad Request + $ref: "#/components/schemas/Refund" + 400: + description: "Bad Request" x-response-codes: errors: - '34901': - domain: API_FULFILLMENT - category: REQUEST - description: Order id can't be null or empty. - '34902': - domain: API_FULFILLMENT - category: REQUEST - description: Request can't be empty. - '34903': - domain: API_FULFILLMENT - category: REQUEST - description: The refund reason must be specified. - '34905': - domain: API_FULFILLMENT - category: REQUEST - description: Either orderLevelRefundAmount or refundItems must be specified. - '34906': - domain: API_FULFILLMENT - category: REQUEST - description: The amount value must be specified. - '34907': - domain: API_FULFILLMENT - category: REQUEST - description: The amount value must be positive and within two decimals. - '34908': - domain: API_FULFILLMENT - category: REQUEST - description: The amount currency must be specified. - '34909': - domain: API_FULFILLMENT - category: REQUEST - description: The amount currency isn't correct. - '34910': - domain: API_FULFILLMENT - category: REQUEST - description: Either legacyReference or lineItemId must be specified for item level refund. - '34911': - domain: API_FULFILLMENT - category: REQUEST - description: Legacy item id must be specified for item level refund if you use legacyReference. - '34912': - domain: API_FULFILLMENT - category: REQUEST - description: Legacy transaction id must be specified for item level refund if you use legacyReference. - '34914': - domain: API_FULFILLMENT - category: REQUEST - description: Can't find the item in the order. - '34915': - domain: API_FULFILLMENT - category: REQUEST - description: The refund amount exceeds order amount. - '34916': - domain: API_FULFILLMENT - category: BUSINESS - description: A post-transaction case exists on this order, seller refund can't be triggered. - '34917': - domain: API_FULFILLMENT - category: BUSINESS - description: This order was already refunded. - '34920': - domain: API_FULFILLMENT - category: BUSINESS - description: It's too late to issue a refund for this order. - '34921': - domain: API_FULFILLMENT - category: REQUEST - description: The comment exceeds the length limit, please make sure it doesn't exceed 1000 characters. - '34922': - domain: API_FULFILLMENT - category: REQUEST - description: Refund can't be issued while previous refund is processing. - '34923': - domain: API_FULFILLMENT - category: REQUEST - description: Refund cannot be issued for this type of order. - '403': - description: Access Forbidden - '404': - description: Resource Not found + 34912: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Legacy transaction id must be specified for item level\ + \ refund if you use legacyReference." + 34914: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Can't find the item in the order." + 34915: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The refund amount exceeds order amount." + 34916: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "A post-transaction case exists on this order, seller\ + \ refund can't be triggered." + 34917: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "This order was already refunded." + 34920: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "It's too late to issue a refund for this order." + 34921: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The comment exceeds the length limit, please make sure\ + \ it doesn't exceed 1000 characters." + 34922: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Refund can't be issued while previous refund is processing." + 34923: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Refund cannot be issued for this type of order." + 34901: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Order id can't be null or empty." + 34902: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Request can't be empty." + 34903: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The refund reason must be specified." + 34905: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Either orderLevelRefundAmount or refundItems must be\ + \ specified." + 34906: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The amount value must be specified." + 34907: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The amount value must be positive and within two decimals." + 34908: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The amount currency must be specified." + 34909: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The amount currency isn't correct." + 34910: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Either legacyReference or lineItemId must be specified\ + \ for item level refund." + 34911: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Legacy item id must be specified for item level refund\ + \ if you use legacyReference." + 500: + description: "Internal Server Error" x-response-codes: errors: - '34913': - domain: API_FULFILLMENT - category: REQUEST - description: Can not find the order. - '409': - description: Conflict + 34900: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 403: + description: "Access Forbidden" + 404: + description: "Resource Not found" x-response-codes: errors: - '34918': - domain: API_FULFILLMENT - category: BUSINESS - description: This is not an eBay managed payments order. - '34919': - domain: API_FULFILLMENT - category: REQUEST - description: Unauthorized access. - '34924': - domain: API_FULFILLMENT - category: BUSINESS - description: The item refund amount exceeds the item remaining amount. - '34925': - domain: API_FULFILLMENT - category: BUSINESS - description: The refund operation could not be completed with any of the payment methods saved to the seller's account. - '34926': - domain: API_FULFILLMENT - category: BUSINESS - description: A suitable payment method could not be found for the refund operation. Please resolve in Seller Hub. - '34927': - domain: API_FULFILLMENT - category: BUSINESS - description: The selected payment method for the refund operation was invalid or declined. - '34928': - domain: API_FULFILLMENT - category: BUSINESS - description: Your refund did not go through because we could not verify your payment option. Please change your payment option and try again. - '34929': - domain: API_FULFILLMENT - category: REQUEST - description: You cannot refund this order yet since the buyer payment has not been processed. Please try again later. - '34930': - domain: API_FULFILLMENT - category: REQUEST - description: Default payment method limit exceeded. Please use a different payment option or try again later. - '500': - description: Internal Server Error + 34913: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Can not find the order." + 409: + description: "Conflict" x-response-codes: errors: - '34900': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 34928: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "Your refund did not go through because we could not\ + \ verify your payment option. Please change your payment option\ + \ and try again." + 34929: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "You cannot refund this order yet since the buyer payment\ + \ has not been processed. Please try again later." + 34930: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Default payment method limit exceeded. Please use a\ + \ different payment option or try again later." + 34918: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "This is not an eBay managed payments order." + 34919: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Unauthorized access." + 34924: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "The item refund amount exceeds the item remaining amount." + 34925: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "The refund operation could not be completed with any\ + \ of the payment methods saved to the seller's account." + 34926: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "A suitable payment method could not be found for the\ + \ refund operation. Please resolve in Seller Hub." + 34927: + domain: "API_FULFILLMENT" + category: "BUSINESS" + description: "The selected payment method for the refund operation\ + \ was invalid or declined." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.finances + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.finances" /order/{orderId}/shipping_fulfillment: get: tags: - - shipping_fulfillment - description: Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId. This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status. - operationId: getShippingFulfillments + - "shipping_fulfillment" + description: "Use this call to retrieve the contents of all fulfillments currently\ + \ defined for a specified order based on the order's unique identifier, orderId.\ + \ This value is returned in the getOrders call's members.orderId\ + \ field when you search for orders by creation date or shipment status." + operationId: "getShippingFulfillments" parameters: - - name: orderId - in: path - description: The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.

Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getShippingFulfillments method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. - required: true - schema: - type: string + - name: "orderId" + in: "path" + description: "The unique identifier of the order. Order ID values are shown\ + \ in My eBay/Seller Hub, and are also returned by the getOrders method\ + \ in the orders.orderId field." + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/ShippingFulfillmentPagedCollection' - '400': - description: Bad Request + $ref: "#/components/schemas/ShippingFulfillmentPagedCollection" + 400: + description: "Bad Request" x-response-codes: errors: - '32100': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid order ID: {orderId}' - '500': - description: Internal Server Error + 32100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid order ID: {orderId}" + 500: + description: "Internal Server Error" x-response-codes: errors: - '30500': - domain: API_FULFILLMENT - category: APPLICATION - description: System error + 30500: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "System error" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.fulfillment - - https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment" + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" post: tags: - - shipping_fulfillment - description: When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is a shipping fulfillment. For each package, execute this call once to generate a shipping fulfillment associated with that package.

Note: A single line item in an order can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller must include all components of a given line item in the same package.

Before using this call for a given package, you must determine which line items are in the package. If the package has been shipped, you should provide the date of shipment in the request. If not provided, it will default to the current date and time. - operationId: createShippingFulfillment + - "shipping_fulfillment" + description: "When you group an order's line items into one or more packages,\ + \ each package requires a corresponding plan for handling, addressing, and\ + \ shipping; this is a shipping fulfillment. For each package, execute\ + \ this call once to generate a shipping fulfillment associated with that package.\ + \

Note: A single line\ + \ item in an order can consist of multiple units of a purchased item, and\ + \ one unit can consist of multiple parts or components. Although these components\ + \ might be provided by the manufacturer in separate packaging, the seller\ + \ must include all components of a given line item in the same package.\ + \

Before using this call for a given package, you must determine\ + \ which line items are in the package. If the package has been shipped, you\ + \ should provide the date of shipment in the request. If not provided, it\ + \ will default to the current date and time." + operationId: "createShippingFulfillment" parameters: - - name: orderId - in: path - description: The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.

Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the createShippingFulfillment method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. - required: true - schema: - type: string + - name: "orderId" + in: "path" + description: "The unique identifier of the order. Order ID values are shown\ + \ in My eBay/Seller Hub, and are also returned by the getOrders method\ + \ in the orders.orderId field." + required: true + schema: + type: "string" requestBody: - description: fulfillment payload + description: "fulfillment payload" content: application/json: schema: - description: fulfillment payload - $ref: '#/components/schemas/ShippingFulfillmentDetails' + description: "fulfillment payload" + $ref: "#/components/schemas/ShippingFulfillmentDetails" required: true responses: - '201': - description: 'Created. The call also returns the following location code:

{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}

The ENV string is the HTTPS path to the same eBay supported environment in which this call was issued. The ORDERID parameter is the unique identifier of the order addressed by this call; for example, 01-03955-36441. The FULFILLMENTID parameter identifies the newly created fulfillment; for example, 9405509699937003457459. Use this Get Fulfillment URI to retrieve the contents of the new fulfillment.' + 201: + description: "Created. The call also returns the following location code:\ + \

{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}\ + \

The ENV string is the HTTPS path to the same\ + \ eBay supported environment in which this call was issued. The ORDERID\ + \ parameter is the unique identifier of the order addressed by this call;\ + \ for example, 01-03955-36441. The FULFILLMENTID\ + \ parameter identifies the newly created fulfillment; for example, 9405509699937003457459.\ + \ Use this Get Fulfillment URI to retrieve the contents of the new fulfillment." headers: Location: schema: - type: string - description: 'A successful call returns the following location code:

{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}

The ENV string is the HTTPS path to the same eBay supported environment in which this call was issued. The ORDERID parameter is the unique identifier of the order addressed by this call; for example, 01-03955-36441. The FULFILLMENTID parameter identifies the newly created fulfillment; for example, 9405509699937003457459. Use this Get Fulfillment URI to retrieve the contents of the new fulfillment.' + type: "string" + description: "A successful call returns the following location code:\ + \

{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}\ + \

The ENV string is the HTTPS path to the\ + \ same eBay supported environment in which this call was issued.\ + \ The ORDERID parameter is the unique identifier of\ + \ the order addressed by this call; for example, 01-03955-36441.\ + \ The FULFILLMENTID parameter identifies the newly\ + \ created fulfillment; for example, 9405509699937003457459.\ + \ Use this Get Fulfillment URI to retrieve the contents of the new\ + \ fulfillment." content: application/json: schema: - type: object - '400': - description: Bad Request + type: "object" + 400: + description: "Bad Request" x-response-codes: errors: - '32100': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid order Id - '32200': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid line item id - '32300': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid shipment tracking number or carrier - '32400': - domain: API_FULFILLMENT - category: REQUEST - description: Requested user is suspended - '32500': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid shipped date - '32600': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid input data - '500': - description: Internal Server Error + 32400: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Requested user is suspended" + 32210: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Duplicate line item in the request" + 32100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Order Id: {orderId}" + 32500: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid shipped date" + 34100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Maximum tracking number for order is exceeded" + 34500: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Please use PUT operation for updating shipping fulfillment" + 32200: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid line item id: {lineItemId}" + 32600: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid input data" + 34200: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Line Items contain Global Shipping Program and non-Global\ + \ Shipping Program orders" + 32300: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid shipment tracking number or carrier" + 34300: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Mark As Shipped for multiple Global Shipping Program\ + \ line items is not supported" + 500: + description: "Internal Server Error" x-response-codes: errors: - '30500': - domain: API_FULFILLMENT - category: APPLICATION - description: System error + 30500: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "System error" + 409: + description: "Conflict" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.fulfillment + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment" /order/{orderId}/shipping_fulfillment/{fulfillmentId}: get: tags: - - shipping_fulfillment - description: Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field. - operationId: getShippingFulfillment + - "shipping_fulfillment" + description: "Use this call to retrieve the contents of a fulfillment based\ + \ on its unique identifier, fulfillmentId (combined with the associated\ + \ order's orderId). The fulfillmentId value was originally generated\ + \ by the createShippingFulfillment call, and is returned by the getShippingFulfillments\ + \ call in the members.fulfillmentId field." + operationId: "getShippingFulfillment" parameters: - - name: fulfillmentId - in: path - description: The unique identifier of the fulfillment. This eBay-generated value was created by the Create Shipping Fulfillment call, and returned by the getShippingFulfillments call in the fulfillments.fulfillmentId field; for example, 9405509699937003457459. - required: true - schema: - type: string - - name: orderId - in: path - description: The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.

Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getShippingFulfillment method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. - required: true - schema: - type: string + - name: "fulfillmentId" + in: "path" + description: "The unique identifier of the fulfillment. This eBay-generated\ + \ value was created by the Create Shipping Fulfillment call, and\ + \ returned by the getShippingFulfillments call in the fulfillments.fulfillmentId\ + \ field; for example, 9405509699937003457459." + required: true + schema: + type: "string" + - name: "orderId" + in: "path" + description: "The unique identifier of the order. Order ID values are shown\ + \ in My eBay/Seller Hub, and are also returned by the getOrders method\ + \ in the orders.orderId field." + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/ShippingFulfillment' - '400': - description: Bad Request + $ref: "#/components/schemas/ShippingFulfillment" + 400: + description: "Bad Request" x-response-codes: errors: - '32100': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid order ID: {orderId}' - '32110': - domain: API_FULFILLMENT - category: REQUEST - description: 'Invalid shipping fulfillment ID: {fulfillmentId}' - '404': - description: Not Found - '500': - description: Internal Server Error + 32100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid order ID: {orderId}" + 32110: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid shipping fulfillment ID: {fulfillmentId}" + 500: + description: "Internal Server Error" x-response-codes: errors: - '30500': - domain: API_FULFILLMENT - category: APPLICATION - description: System error + 30500: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "System error" + 404: + description: "Not Found" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.fulfillment - - https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment" + - "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" /payment_dispute/{payment_dispute_id}: get: tags: - - payment_dispute - summary: Get Payment Dispute Details - description: This method retrieves detailed information on a specific payment dispute. The payment dispute identifier is passed in as path parameter at the end of the call URI.

Below is a summary of the information that is retrieved:
  • Current status of payment dispute
  • Amount of the payment dispute
  • Reason the payment dispute was opened
  • Order and line items associated with the payment dispute
  • Seller response options if an action is currently required on the payment dispute
  • Details on the results of the payment dispute if it has been closed
  • Details on any evidence that was provided by the seller to fight the payment dispute
- operationId: getPaymentDispute + - "payment_dispute" + summary: "Get Payment Dispute Details" + description: "This method retrieves detailed information on a specific payment\ + \ dispute. The payment dispute identifier is passed in as path parameter at\ + \ the end of the call URI.

Below is a summary of the information\ + \ that is retrieved:
  • Current status of payment dispute
  • Amount\ + \ of the payment dispute
  • Reason the payment dispute was opened
  • Order\ + \ and line items associated with the payment dispute
  • Seller response\ + \ options if an action is currently required on the payment dispute
  • Details\ + \ on the results of the payment dispute if it has been closed
  • Details\ + \ on any evidence that was provided by the seller to fight the payment dispute
" + operationId: "getPaymentDispute" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the payment dispute to retrieve. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed in at the end of the call URI to identify the\ + \ payment dispute to retrieve. This identifier is automatically created\ + \ by eBay once the payment dispute comes into the eBay system. The unique\ + \ identifier for payment disputes is returned in the paymentDisputeId\ + \ field in the getPaymentDisputeSummaries response." + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/PaymentDispute' - '400': - description: Bad Request - '404': - description: Invalid Payment Dispute Id + $ref: "#/components/schemas/PaymentDispute" + 400: + description: "Bad Request" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Payment Dispute Id - '500': - description: Internal Server Error + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 404: + description: "Invalid Payment Dispute Id" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Payment Dispute Id" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/fetch_evidence_content: get: tags: - - payment_dispute - summary: Get Payment Dispute Evidence File - description: 'This call retrieves a specific evidence file for a payment dispute. The following three identifying parameters are needed in the call URI:
  • payment_dispute_id: the identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response.
  • evidence_id: the identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response.
  • file_id: the identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter. The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response.

An actual binary file is returned if the call is successful. An error will occur if any of three identifiers are invalid.

' - operationId: fetchEvidenceContent + - "payment_dispute" + summary: "Get Payment Dispute Evidence File" + description: "This call retrieves a specific evidence file for a payment dispute.\ + \ The following three identifying parameters are needed in the call URI:
  • payment_dispute_id:\ + \ the identifier of the payment dispute. The identifier of each payment dispute\ + \ is returned in the getPaymentDisputeSummaries response.
  • evidence_id:\ + \ the identifier of the evidential file set. The identifier of an evidential\ + \ file set for a payment dispute is returned under the evidence\ + \ array in the getPaymentDispute response.
  • file_id:\ + \ the identifier of an evidential file. This file must belong to the evidential\ + \ file set identified through the evidence_id query parameter.\ + \ The identifier of each evidential file is returned under the evidence.files\ + \ array in the getPaymentDispute response.

An\ + \ actual binary file is returned if the call is successful. An error will\ + \ occur if any of three identifiers are invalid.

" + operationId: "fetchEvidenceContent" parameters: - - name: payment_dispute_id - in: path - description: The identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response. This identifier is passed in as a path parameter at the end of the call URI. - required: true - schema: - type: string - - name: evidence_id - in: query - description: The identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response.

Below is an example of the syntax to use for this query parameter:

evidence_id=12345678 - required: true - schema: - type: string - - name: file_id - in: query - description: 'The identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter. The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response.

Below is an example of the syntax to use for this query parameter:

file_id=12345678 ' - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "The identifier of the payment dispute. The identifier of each\ + \ payment dispute is returned in the getPaymentDisputeSummaries\ + \ response. This identifier is passed in as a path parameter at the end\ + \ of the call URI." + required: true + schema: + type: "string" + - name: "evidence_id" + in: "query" + description: "The identifier of the evidential file set. The identifier of\ + \ an evidential file set for a payment dispute is returned under the evidence\ + \ array in the getPaymentDispute response.

Below\ + \ is an example of the syntax to use for this query parameter:

evidence_id=12345678" + required: true + schema: + type: "string" + - name: "file_id" + in: "query" + description: "The identifier of an evidential file. This file must belong\ + \ to the evidential file set identified through the evidence_id\ + \ query parameter. The identifier of each evidential file is returned under\ + \ the evidence.files array in the getPaymentDispute\ + \ response.

Below is an example of the syntax to use for this query\ + \ parameter:

file_id=12345678 " + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/octet-stream: schema: - type: array + type: "array" items: - type: string - '400': - description: Bad Request + type: "string" + 400: + description: "Bad Request" x-response-codes: errors: - '33002': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Evidence Id - '33003': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Evidence File Id - '404': - description: Invalid Payment Dispute Id + 33002: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Evidence Id" + 33003: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Evidence File Id" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Payment Dispute Id - '500': - description: Internal Server Error + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 404: + description: "Invalid Payment Dispute Id" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Payment Dispute Id" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/activity: get: tags: - - payment_dispute - summary: Get Payment Dispute Activity - description: This method retrieve a log of activity for a payment dispute. The identifier of the payment dispute is passed in as a path parameter. The output includes a timestamp for each action of the payment dispute, from creation to resolution, and all steps in between. - operationId: getActivities + - "payment_dispute" + summary: "Get Payment Dispute Activity" + description: "This method retrieve a log of activity for a payment dispute.\ + \ The identifier of the payment dispute is passed in as a path parameter.\ + \ The output includes a timestamp for each action of the payment dispute,\ + \ from creation to resolution, and all steps in between." + operationId: "getActivities" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the payment dispute for which the user wishes to see all activity. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response.

This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed in at the end of the call URI to identify the\ + \ payment dispute for which the user wishes to see all activity. This identifier\ + \ is automatically created by eBay once the payment dispute comes into the\ + \ eBay system. The unique identifier for payment disputes is returned in\ + \ the paymentDisputeId field in the getPaymentDisputeSummaries\ + \ response.

This path parameter is required, and the actual identifier\ + \ value is passed in right after the payment_dispute resource.\ + \ See the Resource URI above." + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/PaymentDisputeActivityHistory' - '400': - description: Bad Request - '404': - description: Invalid Payment Dispute Id + $ref: "#/components/schemas/PaymentDisputeActivityHistory" + 400: + description: "Bad Request" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Payment Dispute Id - '500': - description: Internal Server Error + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 404: + description: "Invalid Payment Dispute Id" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Payment Dispute Id" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute_summary: get: tags: - - payment_dispute - summary: Search Payment Dispute by Filters - description: This method is used retrieve one or more payment disputes filed against the seller. These payment disputes can be open or recently closed. The following filter types are available in the request payload to control the payment disputes that are returned:
  • Dispute filed against a specific order (order_id parameter is used)
  • Dispute(s) filed by a specific buyer (buyer_username parameter is used)
  • Dispute(s) filed within a specific date range (open_date_from and/or open_date_to parameters are used)
  • Disputes in a specific state (payment_dispute_status parameter is used)
More than one of these filter types can be used together. See the request payload request fields for more information about how each filter is used.

If none of the filters are used, all open and recently closed payment disputes are returned.

Pagination is also available. See the limit and offset fields for more information on how pagination is used for this method. - operationId: getPaymentDisputeSummaries + - "payment_dispute" + summary: "Search Payment Dispute by Filters" + description: "This method is used retrieve one or more payment disputes filed\ + \ against the seller. These payment disputes can be open or recently closed.\ + \ The following filter types are available in the request payload to control\ + \ the payment disputes that are returned:
  • Dispute filed against a specific\ + \ order (order_id parameter is used)
  • Dispute(s) filed by a\ + \ specific buyer (buyer_username parameter is used)
  • Dispute(s)\ + \ filed within a specific date range (open_date_from and/or open_date_to\ + \ parameters are used)
  • Disputes in a specific state (payment_dispute_status\ + \ parameter is used)
More than one of these filter types can be used\ + \ together. See the request payload request fields for more information about\ + \ how each filter is used.

If none of the filters are used, all open\ + \ and recently closed payment disputes are returned.

Pagination is\ + \ also available. See the limit and offset fields for more information\ + \ on how pagination is used for this method." + operationId: "getPaymentDisputeSummaries" parameters: - - name: order_id - in: query - description: This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order. It is possible that there can be more than one dispute filed against an order if the order has multiple line items. If this filter is used, any other filters are ignored.

Note: The order identifier passed into this field must be an Order ID in the new format. The legacy APIs still support the old and new order ID format to identify orders, but only the new order ID format is supported in REST-based APIs. eBay rolled out a new Order ID format in June 2019. - required: false - schema: - type: string - - name: buyer_username - in: query - description: This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific seller. The string that is passed in to this query parameter is the eBay user ID of the buyer. - required: false - schema: - type: string - - name: open_date_from - in: query - description: 'The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.

The open_date_from field sets the beginning date of the date range, and can be set as far back as 18 months from the present time. If a open_date_from field is used, but a open_date_to field is not used, the open_date_to value will default to 90 days after the date specified in the open_date_from field, or to the present time if less than 90 days in the past.

The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' - required: false - schema: - type: string - - name: open_date_to - in: query - description: 'The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.

The open_date_to field sets the ending date of the date range, and can be set up to 90 days from the date set in the open_date_from field.

The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' - required: false - schema: - type: string - - name: payment_dispute_status - in: query - description: This filter is used if the seller wishes to only retrieve payment disputes in a specific state. More than one value can be specified. If no payment_dispute_status filter is used, payment disputes in all states are returned in the response. See DisputeStateEnum type for supported values. - required: false - schema: - type: string - - name: limit - in: query - description: 'The value passed in this query parameter sets the maximum number of payment disputes to return per page of data. The value passed in this field should be an integer from 1 to 200. If this query parameter is not set, up to 200 records will be returned on each page of results.

Min: 1; Max: 200; Default: 200' - required: false - schema: - type: string - - name: offset - in: query - description: 'This field is used to specify the number of records to skip in the result set before returning the first payment dispute in the paginated response. A zero-based index is used, so if you set the offset value to 0 (default value), the first payment dispute in the result set appears at the top of the response.

Combine offset with the limit parameter to control the payment disputes returned in the response. For example, if you supply an offset value of 0 and a limit value of 10, the response will contain the first 10 payment disputes from the result set that matches the input criteria. If you supply an offset value of 10 and a limit value of 20, the response will contain payment disputes 11-30 from the result set that matches the input criteria.

Min: 0; Max: total number of payment disputes - 1; Default: 0' - required: false - schema: - type: string + - name: "order_id" + in: "query" + description: "This filter is used if the seller wishes to retrieve one or\ + \ more payment disputes filed against a specific order. It is possible that\ + \ there can be more than one dispute filed against an order if the order\ + \ has multiple line items. If this filter is used, any other filters are\ + \ ignored." + required: false + schema: + type: "string" + - name: "buyer_username" + in: "query" + description: "This filter is used if the seller wishes to retrieve one or\ + \ more payment disputes opened by a specific seller. The string that is\ + \ passed in to this query parameter is the eBay user ID of the buyer." + required: false + schema: + type: "string" + - name: "open_date_from" + in: "query" + description: "The open_date_from and/or open_date_to date filters\ + \ are used if the seller wishes to retrieve payment disputes opened within\ + \ a specific date range. A maximum date range that may be set with the open_date_from\ + \ and/or open_date_to filters is 90 days. These date filters use\ + \ the ISO-8601 24-hour date and time format, and time zone used is Universal\ + \ Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.

The\ + \ open_date_from field sets the beginning date of the date range,\ + \ and can be set as far back as 18 months from the present time. If a open_date_from\ + \ field is used, but a open_date_to field is not used, the open_date_to\ + \ value will default to 90 days after the date specified in the open_date_from\ + \ field, or to the present time if less than 90 days in the past.

The\ + \ ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An\ + \ example would be 2019-08-04T19:09:02.768Z." + required: false + schema: + type: "string" + - name: "open_date_to" + in: "query" + description: "The open_date_from and/or open_date_to date filters\ + \ are used if the seller wishes to retrieve payment disputes opened within\ + \ a specific date range. A maximum date range that may be set with the open_date_from\ + \ and/or open_date_to filters is 90 days. These date filters use\ + \ the ISO-8601 24-hour date and time format, and the time zone used is Universal\ + \ Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.

The\ + \ open_date_to field sets the ending date of the date range, and\ + \ can be set up to 90 days from the date set in the open_date_from\ + \ field.

The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ.\ + \ An example would be 2019-08-04T19:09:02.768Z." + required: false + schema: + type: "string" + - name: "payment_dispute_status" + in: "query" + description: "This filter is used if the seller wishes to only retrieve payment\ + \ disputes in a specific state. More than one value can be specified. If\ + \ no payment_dispute_status filter is used, payment disputes in all\ + \ states are returned in the response. See DisputeStateEnum\ + \ type for supported values." + required: false + schema: + type: "string" + - name: "limit" + in: "query" + description: "The value passed in this query parameter sets the maximum number\ + \ of payment disputes to return per page of data. The value passed in this\ + \ field should be an integer from 1 to 200. If this query parameter is not\ + \ set, up to 200 records will be returned on each page of results.

Min:\ + \ 1; Max: 200; Default: 200" + required: false + schema: + type: "string" + - name: "offset" + in: "query" + description: "This field is used to specify the number of records to skip\ + \ in the result set before returning the first payment dispute in the paginated\ + \ response. A zero-based index is used, so if you set the offset\ + \ value to 0 (default value), the first payment dispute in\ + \ the result set appears at the top of the response.

Combine offset\ + \ with the limit parameter to control the payment disputes returned\ + \ in the response. For example, if you supply an offset value of\ + \ 0 and a limit value of 10, the response\ + \ will contain the first 10 payment disputes from the result set that matches\ + \ the input criteria. If you supply an offset value of 10\ + \ and a limit value of 20, the response will contain\ + \ payment disputes 11-30 from the result set that matches the input criteria.

Min:\ + \ 0; Max: total number of payment disputes - 1; Default: 0" + required: false + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/DisputeSummaryResponse' - '400': - description: Bad Request + $ref: "#/components/schemas/DisputeSummaryResponse" + 400: + description: "Bad Request" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid input request - '500': - description: Internal Server Error + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid input request" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/contest: post: tags: - - payment_dispute - summary: Contest Payment Dispute - description: This method is used if the seller wishes to contest a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: Before contesting a payment dispute, the seller must upload all evidence files using the addEvidence and updateEvidence methods. Once the seller has officially contested the dispute (using contestPaymentDispute), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute.

If a seller decides to contest a payment dispute, that seller should be prepared to provide evidential documents such as proof of delivery, proof of authentication, or other documents. The type of evidential documents that the seller will provide will depend on why the buyer initiated the payment dispute.

The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on theste fields. - operationId: contestPaymentDispute + - "payment_dispute" + summary: "Contest Payment Dispute" + description: "This method is used if the seller wishes to contest a payment\ + \ dispute initiated by the buyer. The unique identifier of the payment dispute\ + \ is passed in as a path parameter, and unique identifiers for payment disputes\ + \ can be retrieved with the getPaymentDisputeSummaries method.

Note: Before contesting a payment dispute,\ + \ the seller must upload all supporting files using the addEvidence\ + \ and updateEvidence methods. Once the seller has officially\ + \ contested the dispute (using contestPaymentDispute), the\ + \ addEvidence and updateEvidence methods\ + \ can no longer be used. In the evidenceRequests array of\ + \ the getPaymentDispute response, eBay prompts the seller\ + \ with the type of supporting file(s) that will be needed to contest the payment\ + \ dispute.

If a seller decides to contest a payment dispute,\ + \ that seller should be prepared to provide supporting documents such as proof\ + \ of delivery, proof of authentication, or other documents. The type of supporting\ + \ documents that the seller will provide will depend on why the buyer filed\ + \ the payment dispute.

The revision field in the request\ + \ payload is required, and the returnAddress field should\ + \ be supplied if the seller is expecting the buyer to return the item. See\ + \ the Request Payload section for more information on these fields." + operationId: "contestPaymentDispute" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute for which the user plans to contest. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response.

This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed into the call URI to identify the payment dispute\ + \ for which the user plans to contest. This identifier is automatically\ + \ created by eBay once the payment dispute comes into the eBay system. The\ + \ unique identifier for payment disputes is returned in the paymentDisputeId\ + \ field in the getPaymentDisputeSummaries response.

This\ + \ path parameter is required, and the actual identifier value is passed\ + \ in right after the payment_dispute resource. See the\ + \ Resource URI above." + required: true + schema: + type: "string" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ContestPaymentDisputeRequest' + $ref: "#/components/schemas/ContestPaymentDisputeRequest" required: false responses: - '204': - description: Success - '400': - description: Bad Request + 400: + description: "Bad Request" x-response-codes: errors: - '33100': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid input request - '404': - description: Not Found - '409': - description: Conflict + 33100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid input request" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33011': - domain: API_FULFILLMENT - category: REQUEST - description: There was a change in payment dispute attributes. Please use get payment dispute api to get latest details. - '33101': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid payment dispute state - '33102': - domain: API_FULFILLMENT - category: REQUEST - description: No evidence available for contest - '500': - description: Internal Server Error + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 204: + description: "Success" + 404: + description: "Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33011: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "There was a change in payment dispute attributes. Please\ + \ use get payment dispute api to get latest details." + 33101: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid payment dispute state" + 33102: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "No evidence available for contest" security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/accept: post: tags: - - payment_dispute - summary: Accept Payment Dispute - description: This method is used if the seller wishes to accept a payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on theste fields. - operationId: acceptPaymentDispute + - "payment_dispute" + summary: "Accept Payment Dispute" + description: "This method is used if the seller wishes to accept a payment dispute.\ + \ The unique identifier of the payment dispute is passed in as a path parameter,\ + \ and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries\ + \ method.

The revision field in the request payload\ + \ is required, and the returnAddress field should be supplied\ + \ if the seller is expecting the buyer to return the item. See the Request\ + \ Payload section for more information on theste fields." + operationId: "acceptPaymentDispute" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute for which the user plans to accept. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response.

This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed into the call URI to identify the payment dispute\ + \ for which the user plans to accept. This identifier is automatically created\ + \ by eBay once the payment dispute comes into the eBay system. The unique\ + \ identifier for payment disputes is returned in the paymentDisputeId\ + \ field in the getPaymentDisputeSummaries response.

This\ + \ path parameter is required, and the actual identifier value is passed\ + \ in right after the payment_dispute resource. See the\ + \ Resource URI above." + required: true + schema: + type: "string" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AcceptPaymentDisputeRequest' + $ref: "#/components/schemas/AcceptPaymentDisputeRequest" required: false responses: - '204': - description: Success - '400': - description: Bad Request + 400: + description: "Bad Request" x-response-codes: errors: - '33100': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid input request - '404': - description: Not Found - '409': - description: Conflict + 33100: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid input request" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33011': - domain: API_FULFILLMENT - category: REQUEST - description: There was a change in payment dispute attributes. Please use get payment dispute api to get latest details. - '500': - description: Internal Server Error + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 204: + description: "Success" + 404: + description: "Not Found" + 409: + description: "Conflict" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33011: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "There was a change in payment dispute attributes. Please\ + \ use get payment dispute api to get latest details." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/upload_evidence_file: post: tags: - - payment_dispute - summary: Upload an Evidence File - description: This method is used to upload an evidence file for a contested payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: The uploadEvidenceFile only uploads an encrypted, binary image file (using multipart/form-data HTTP request header), and does not have a JSON-based request payload.

Use 'file' as the name of the key that you use to upload the image file. The upload will not be successful if a different key name is used.

The three image formats supported at this time are .JPEG, .JPG, and .PNG.

After the file is successfully uploaded, the seller will need to grab the fileId value in the response payload to add this file to a new evidence set using the addEvidence method, or to add this file to an existing evidence set using the updateEvidence method. - operationId: uploadEvidenceFile + - "payment_dispute" + summary: "Upload an Evidence File" + description: "This method is used to upload an evidence file for a contested\ + \ payment dispute. The unique identifier of the payment dispute is passed\ + \ in as a path parameter, and unique identifiers for payment disputes can\ + \ be retrieved with the getPaymentDisputeSummaries method.

Note: The uploadEvidenceFile\ + \ only uploads an encrypted, binary image file (using multipart/form-data\ + \ HTTP request header), and does not have a JSON-based request payload.

Use\ + \ 'file' as the name of the key that you use to upload the image file. The\ + \ upload will not be successful if a different key name is used.

The\ + \ three image formats supported at this time are .JPEG, .JPG,\ + \ and .PNG.

After the file is successfully\ + \ uploaded, the seller will need to grab the fileId value\ + \ in the response payload to add this file to a new evidence set using the\ + \ addEvidence method, or to add this file to an existing\ + \ evidence set using the updateEvidence method." + operationId: "uploadEvidenceFile" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute for which the user plans to upload an evidence file. This identifier is automatically created by eBay after the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response.

This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed into the call URI to identify the payment dispute\ + \ for which the user plans to upload an evidence file. This identifier is\ + \ automatically created by eBay after the payment dispute comes into the\ + \ eBay system. The unique identifier for payment disputes is returned in\ + \ the paymentDisputeId field in the getPaymentDisputeSummaries\ + \ response.

This path parameter is required, and the actual identifier\ + \ value is passed in right after the payment_dispute resource.\ + \ See the Resource URI above." + required: true + schema: + type: "string" responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/FileEvidence' - '400': - description: Bad Request + $ref: "#/components/schemas/FileEvidence" + 400: + description: "Bad Request" x-response-codes: errors: - '33005': - domain: API_FULFILLMENT - category: REQUEST - description: File type is invalid. - '33006': - domain: API_FULFILLMENT - category: REQUEST - description: File size should be 1.5 MB or less. - '33106': - domain: API_FULFILLMENT - category: REQUEST - description: The file name should not be empty and should not exceed 255 characters. - '33107': - domain: API_FULFILLMENT - category: REQUEST - description: Only one file can be uploaded per request. - '404': - description: Not Found + 33106: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The file name should not be empty and should not exceed\ + \ 255 characters." + 33107: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Only one file can be uploaded per request." + 33005: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "File type is invalid." + 33006: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "File size should be 1.5 MB or less." + 500: + description: "Internal Server Error" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Payment Dispute Id - '409': - description: Conflict + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 404: + description: "Not Found" x-response-codes: errors: - '33004': - domain: API_FULFILLMENT - category: REQUEST - description: Upload file for evidence is not permitted for given payment dispute state. - '33105': - domain: API_FULFILLMENT - category: REQUEST - description: You reached the maximum number of files you can upload. - '500': - description: Internal Server Error + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Payment Dispute Id" + 409: + description: "Conflict" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33105: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "You reached the maximum number of files you can upload." + 33004: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Upload file for evidence is not permitted for given\ + \ payment dispute state." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/add_evidence: post: tags: - - payment_dispute - summary: Add an Evidence File - description: This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute.

The file(s) to add are identified through the files array in the request payload. Adding one or more new evidence files for a payment dispute triggers the creation of an evidence file, and the unique identifier for the new evidence file is automatically generated and returned in the evidenceId field of the addEvidence response payload upon a successful call.

The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type.

Upon a successful call, an evidenceId value is returned in the response. This indicates that a new evidence set has been created for the payment dispute, and this evidence set includes the evidence file(s) that were passed in to the fileId array. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent method. - operationId: addEvidence + - "payment_dispute" + summary: "Add an Evidence File" + description: "This method is used by the seller to add one or more evidence\ + \ files to address a payment dispute initiated by the buyer. The unique identifier\ + \ of the payment dispute is passed in as a path parameter, and unique identifiers\ + \ for payment disputes can be retrieved with the getPaymentDisputeSummaries\ + \ method.

Note: All evidence\ + \ files should be uploaded using addEvidence and updateEvidence\ + \ before the seller decides to contest the payment dispute. Once the seller\ + \ has officially contested the dispute (using contestPaymentDispute\ + \ or through My eBay), the addEvidence and updateEvidence\ + \ methods can no longer be used. In the evidenceRequests\ + \ array of the getPaymentDispute response, eBay prompts the\ + \ seller with the type of evidence file(s) that will be needed to contest\ + \ the payment dispute.

The file(s) to add are identified through\ + \ the files array in the request payload. Adding one or\ + \ more new evidence files for a payment dispute triggers the creation of an\ + \ evidence file, and the unique identifier for the new evidence file is automatically\ + \ generated and returned in the evidenceId field of the addEvidence\ + \ response payload upon a successful call.

The type of evidence being\ + \ added should be specified in the evidenceType field. All\ + \ files being added (if more than one) should correspond to this evidence\ + \ type.

Upon a successful call, an evidenceId value\ + \ is returned in the response. This indicates that a new evidence set has\ + \ been created for the payment dispute, and this evidence set includes the\ + \ evidence file(s) that were passed in to the fileId array.\ + \ The evidenceId value will be needed if the seller wishes\ + \ to add to the evidence set by using the updateEvidence\ + \ method, or if they want to retrieve a specific evidence file within the\ + \ evidence set by using the fetchEvidenceContent method." + operationId: "addEvidence" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute for which the user plans to add evidence for a contested payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response.

This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed into the call URI to identify the payment dispute\ + \ for which the user plans to add evidence for a contested payment dispute.\ + \ This identifier is automatically created by eBay once the payment dispute\ + \ comes into the eBay system. The unique identifier for payment disputes\ + \ is returned in the paymentDisputeId field in the getPaymentDisputeSummaries\ + \ response.

This path parameter is required, and the actual identifier\ + \ value is passed in right after the payment_dispute resource.\ + \ See the Resource URI above." + required: true + schema: + type: "string" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddEvidencePaymentDisputeRequest' + $ref: "#/components/schemas/AddEvidencePaymentDisputeRequest" required: false responses: - '200': - description: Success + 200: + description: "Success" content: application/json: schema: - $ref: '#/components/schemas/AddEvidencePaymentDisputeResponse' - '400': - description: Bad Request + $ref: "#/components/schemas/AddEvidencePaymentDisputeResponse" + 400: + description: "Bad Request" x-response-codes: errors: - '33007': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid line items. - '33008': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid evidence type. - '33009': - domain: API_FULFILLMENT - category: REQUEST - description: User did not echo back the evidence metadata correctly. - '33103': - domain: API_FULFILLMENT - category: REQUEST - description: Exceed allowed file count - '33104': - domain: API_FULFILLMENT - category: REQUEST - description: The combined size of attached files should be 1.5MB or less. - '404': - description: Not Found + 33008: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid evidence type." + 33104: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The combined size of attached files should be 1.5MB\ + \ or less." + 33009: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "User did not echo back the evidence metadata correctly." + 33007: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid line items." + 33103: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Exceed allowed file count" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Payment Dispute Id - '409': - description: Conflict + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 404: + description: "Not Found" x-response-codes: errors: - '33004': - domain: API_FULFILLMENT - category: REQUEST - description: Upload file for evidence is not permitted for given payment dispute state. - '500': - description: Internal Server Error + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Payment Dispute Id" + 409: + description: "Conflict" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33004: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Upload file for evidence is not permitted for given\ + \ payment dispute state." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" /payment_dispute/{payment_dispute_id}/update_evidence: post: tags: - - payment_dispute - summary: Update evidence - description: This method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute.

The unique identifier of the evidence set to update is specified through the evidenceId field, and the file(s) to add are identified through the files array in the request payload. The unique identifier for an evidence file is automatically generated and returned in the fileId field of the uploadEvidence response payload upon a successful call. Sellers must make sure to capture the fileId value for each evidence file that is uploaded with the uploadEvidence method.

The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type.

Upon a successful call, an http status code of 204 Success is returned. There is no response payload unless an error occurs. To verify that a new file is a part of the evidence set, the seller can use the fetchEvidenceContent method, passing in the proper evidenceId and fileId values. - operationId: updateEvidence + - "payment_dispute" + summary: "Update evidence" + description: "This method is used by the seller to update an existing evidence\ + \ set for a payment dispute with one or more evidence files. The unique identifier\ + \ of the payment dispute is passed in as a path parameter, and unique identifiers\ + \ for payment disputes can be retrieved with the getPaymentDisputeSummaries\ + \ method.

Note: All evidence\ + \ files should be uploaded using addEvidence and updateEvidence\ + \ before the seller decides to contest the payment dispute. Once the seller\ + \ has officially contested the dispute (using contestPaymentDispute\ + \ or through My eBay), the addEvidence and updateEvidence\ + \ methods can no longer be used. In the evidenceRequests\ + \ array of the getPaymentDispute response, eBay prompts the\ + \ seller with the type of evidence file(s) that will be needed to contest\ + \ the payment dispute.

The unique identifier of the evidence\ + \ set to update is specified through the evidenceId field,\ + \ and the file(s) to add are identified through the files\ + \ array in the request payload. The unique identifier for an evidence file\ + \ is automatically generated and returned in the fileId field\ + \ of the uploadEvidence response payload upon a successful\ + \ call. Sellers must make sure to capture the fileId value\ + \ for each evidence file that is uploaded with the uploadEvidence\ + \ method.

The type of evidence being added should be specified in the\ + \ evidenceType field. All files being added (if more than\ + \ one) should correspond to this evidence type.

Upon a successful call,\ + \ an http status code of 204 Success is returned. There is no\ + \ response payload unless an error occurs. To verify that a new file is a\ + \ part of the evidence set, the seller can use the fetchEvidenceContent\ + \ method, passing in the proper evidenceId and fileId\ + \ values." + operationId: "updateEvidence" parameters: - - name: payment_dispute_id - in: path - description: This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute for which the user plans to update the evidence set for a contested payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response.

This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. - required: true - schema: - type: string + - name: "payment_dispute_id" + in: "path" + description: "This is the unique identifier of the payment dispute. This path\ + \ parameter must be passed into the call URI to identify the payment dispute\ + \ for which the user plans to update the evidence set for a contested payment\ + \ dispute. This identifier is automatically created by eBay once the payment\ + \ dispute comes into the eBay system. The unique identifier for payment\ + \ disputes is returned in the paymentDisputeId field in\ + \ the getPaymentDisputeSummaries response.

This\ + \ path parameter is required, and the actual identifier value is passed\ + \ in right after the payment_dispute resource. See the\ + \ Resource URI above." + required: true + schema: + type: "string" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateEvidencePaymentDisputeRequest' + $ref: "#/components/schemas/UpdateEvidencePaymentDisputeRequest" required: false responses: - '204': - description: Success - '400': - description: Bad Request + 400: + description: "Bad Request" x-response-codes: errors: - '33007': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid line items. - '33008': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid evidence type. - '33009': - domain: API_FULFILLMENT - category: REQUEST - description: User did not echo back the evidence metadata correctly. - '33010': - domain: API_FULFILLMENT - category: REQUEST - description: Evidence Id is invalid - '33103': - domain: API_FULFILLMENT - category: REQUEST - description: Exceed allowed file count - '33104': - domain: API_FULFILLMENT - category: REQUEST - description: The combined size of attached files should be 1.5MB or less. - '404': - description: Not Found + 33008: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid evidence type." + 33104: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "The combined size of attached files should be 1.5MB\ + \ or less." + 33009: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "User did not echo back the evidence metadata correctly." + 33010: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Evidence Id is invalid" + 33007: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid line items." + 33103: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Exceed allowed file count" + 500: + description: "Internal Server Error" x-response-codes: errors: - '33001': - domain: API_FULFILLMENT - category: REQUEST - description: Invalid Payment Dispute Id - '409': - description: Conflict + 33000: + domain: "API_FULFILLMENT" + category: "APPLICATION" + description: "There was a problem with an eBay internal system or\ + \ process. Contact eBay developer support for assistance." + 204: + description: "Success" + 404: + description: "Not Found" x-response-codes: errors: - '33004': - domain: API_FULFILLMENT - category: REQUEST - description: Upload file for evidence is not permitted for given payment dispute state. - '500': - description: Internal Server Error + 33001: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Invalid Payment Dispute Id" + 409: + description: "Conflict" x-response-codes: errors: - '33000': - domain: API_FULFILLMENT - category: APPLICATION - description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. + 33004: + domain: "API_FULFILLMENT" + category: "REQUEST" + description: "Upload file for evidence is not permitted for given\ + \ payment dispute state." security: - - api_auth: - - https://api.ebay.com/oauth/api_scope/sell.payment.dispute + - api_auth: + - "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" servers: - - url: https://apiz.ebay.com{basePath} - description: Production - variables: - basePath: - default: /sell/fulfillment/v1 + - url: "https://apiz.ebay.com{basePath}" + description: "Production" + variables: + basePath: + default: "/sell/fulfillment/v1" components: schemas: AcceptPaymentDisputeRequest: - type: object + type: "object" properties: returnAddress: - description: This container is used if the seller wishes to provide a return address to the buyer. This container should be used if the seller is requesting that the buyer return the item. - $ref: '#/components/schemas/ReturnAddress' + description: "This container is used if the seller wishes to provide a return\ + \ address to the buyer. This container should be used if the seller is\ + \ requesting that the buyer return the item." + $ref: "#/components/schemas/ReturnAddress" revision: - type: integer - description: This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1. - format: int32 - description: This type is used by base request of the acceptPaymentDispute method. + type: "integer" + description: "This integer value indicates the revision number of the payment\ + \ dispute. This field is required. The current revision\ + \ number for a payment dispute can be retrieved with the getPaymentDispute\ + \ method. Each time an action is taken against a payment dispute, this\ + \ integer value increases by 1." + format: "int32" + description: "This type is used by base request of the acceptPaymentDispute\ + \ method." AddEvidencePaymentDisputeRequest: - type: object + type: "object" properties: evidenceType: - type: string - description: This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field. See the EvidenceTypeEnum type for the supported evidence types. For implementation help, refer to eBay API documentation + type: "string" + description: "This field is used to indicate the type of evidence being\ + \ provided through one or more evidence files. All evidence files (if\ + \ more than one) should be associated with the evidence type passed in\ + \ this field. See the EvidenceTypeEnum type for the supported\ + \ evidence types. For implementation help, refer to eBay\ + \ API documentation" files: - type: array - description: This array is used to specify one or more evidence files that will become part of a new evidence set associated with a payment dispute. At least one evidence file must be specified in the files array.

The unique identifier of an evidence file is returned in the response payload of the uploadEvidence method. + type: "array" + description: "This array is used to specify one or more evidence files that\ + \ will become part of a new evidence set associated with a payment dispute.\ + \ At least one evidence file must be specified in the files\ + \ array.

The unique identifier of an evidence file is returned\ + \ in the response payload of the uploadEvidence method." items: - $ref: '#/components/schemas/FileEvidence' + $ref: "#/components/schemas/FileEvidence" lineItems: - type: array - description: This required array identifies the order line item(s) for which the evidence file(s) will be applicable. Both the itemId and lineItemID fields are needed to identify each order line item, and both of these values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response. + type: "array" + description: "This required array identifies the order line item(s) for\ + \ which the evidence file(s) will be applicable. Both the itemId\ + \ and lineItemID fields are needed to identify each order\ + \ line item, and both of these values are returned under the evidenceRequests.lineItems\ + \ array in the getPaymentDispute response." items: - $ref: '#/components/schemas/OrderLineItems' - description: This type is used by the request payload of the addEvidence method. The addEvidence method is used to create a new evidence set against a payment dispute with one or more evidence files. + $ref: "#/components/schemas/OrderLineItems" + description: "This type is used by the request payload of the addEvidence\ + \ method. The addEvidence method is used to create a new\ + \ evidence set against a payment dispute with one or more evidence files." AddEvidencePaymentDisputeResponse: - type: object + type: "object" properties: evidenceId: - type: string - description: The value returned in this field is the unique identifier of the newly-created evidence set. Upon a successful call, this value is automatically genererated. This new evidence set for the payment dispute includes the evidence file(s) that were passed in to the fileId array in the request payload. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent method. - description: This type is used by the response payload of the addEvidence method. Its only field is an unique identifier of an evidence set. + type: "string" + description: "The value returned in this field is the unique identifier\ + \ of the newly-created evidence set. Upon a successful call, this value\ + \ is automatically genererated. This new evidence set for the payment\ + \ dispute includes the evidence file(s) that were passed in to the fileId\ + \ array in the request payload. The evidenceId value\ + \ will be needed if the seller wishes to add to the evidence set by using\ + \ the updateEvidence method, or if they want to retrieve\ + \ a specific evidence file within the evidence set by using the fetchEvidenceContent\ + \ method." + description: "This type is used by the response payload of the addEvidence\ + \ method. Its only field is an unique identifier of an evidence set." Address: - type: object + type: "object" properties: addressLine1: - type: string - description: The first line of the street address. + type: "string" + description: "The first line of the street address." addressLine2: - type: string - description: The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address. + type: "string" + description: "The second line of the street address. This field can be used\ + \ for additional address information, such as a suite or apartment number.\ + \ This field will be returned if defined for the shipping address." city: - type: string - description: The city of the shipping destination. + type: "string" + description: "The city of the shipping destination." country: - type: string - description: The country of the shipping destination, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany. For implementation help, refer to eBay API documentation + type: "string" + description: "The country of the shipping destination, represented as a\ + \ two-letter ISO 3166-1 alpha-2 country code. For example, US\ + \ represents the United States, and DE represents Germany.\ + \ For implementation help, refer to eBay\ + \ API documentation" county: - type: string - description: The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available. + type: "string" + description: "The county of the shipping destination. Counties typically,\ + \ but not always, contain multiple cities or towns. This field is returned\ + \ if known/available." postalCode: - type: string - description: The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable. + type: "string" + description: "The postal code of the shipping destination. Usually referred\ + \ to as Zip codes in the US. Most countries have postal codes, but not\ + \ all. The postal code will be returned if applicable." stateOrProvince: - type: string - description: The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable. - description: This type contains the details of a geographical address. + type: "string" + description: "The state or province of the shipping destination. Most countries\ + \ have states or provinces, but not all. The state or province will be\ + \ returned if applicable." + description: "This type contains the details of a geographical address." Amount: - type: object + type: "object" properties: convertedFromCurrency: - type: string - description: A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency. For implementation help, refer to eBay API documentation + type: "string" + description: "A three-letter ISO 4217 code that indicates the currency of\ + \ the amount in the convertedFromValue field. This value is required\ + \ or returned only if currency conversion/localization is required, and\ + \ represents the pre-conversion currency. For implementation help, refer\ + \ to eBay\ + \ API documentation" convertedFromValue: - type: string - description: The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field. + type: "string" + description: "The monetary amount before any conversion is performed, in\ + \ the currency specified by the convertedFromCurrency field. This\ + \ value is required or returned only if currency conversion/localization\ + \ is required. The value field contains the converted amount of\ + \ this value, in the currency specified by the currency field." currency: - type: string - description: A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to eBay API documentation + type: "string" + description: "A three-letter ISO 4217 code that indicates the currency of\ + \ the amount in the value field. If currency conversion/localization\ + \ is required, this is the post-conversion currency of the amount in the\ + \ value field.

Default: The default currency\ + \ of the eBay marketplace that hosts the listing. For implementation help,\ + \ refer to eBay\ + \ API documentation" value: - type: string - description: The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Required in the amount type. - description: This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable. + type: "string" + description: "The monetary amount, in the currency specified by the currency\ + \ field. If currency conversion/localization is required, this value is\ + \ the converted amount, and the convertedFromValue field contains\ + \ the amount in the original currency.

Required in the\ + \ amount type." + description: "This type defines the monetary value of an amount. It can provide\ + \ the amount in both the currency used on the eBay site where an item is being\ + \ offered and the conversion of that value into another currency, if applicable." AppliedPromotion: - type: object + type: "object" properties: description: - type: string - description: A description of the applied sales promotion. + type: "string" + description: "A description of the applied sales promotion." discountAmount: - description: The monetary amount of the sales promotion. - $ref: '#/components/schemas/Amount' + description: "The monetary amount of the sales promotion." + $ref: "#/components/schemas/Amount" promotionId: - type: string - description: An eBay-generated unique identifier of the sales promotion.

Multiple types of sales promotions are available to eBay Store owners, including order size/volume discounts, shipping discounts, special coupons, and price markdowns. Sales promotions can be managed through the Marketing tab of Seller Hub in My eBay, or by using the Trading API's SetPromotionalSale call or the Marketing API's createItemPromotion method. - description: This type contains information about a sales promotion that is applied to a line item. + type: "string" + description: "An eBay-generated unique identifier of the sales promotion.

\ + \ Multiple types of sales promotions are available to eBay Store owners,\ + \ including order size/volume discounts, shipping discounts, special coupons,\ + \ and price markdowns. Sales promotions can be managed through the Marketing\ + \ tab of Seller Hub in My eBay, or by using the Trading API's SetPromotionalSale\ + \ call or the Marketing API's createItemPromotion method." + description: "This type contains information about a sales promotion that is\ + \ applied to a line item." Buyer: - type: object + type: "object" properties: taxAddress: - description: This container consists of address information that can be used by sellers for tax purpose.

Note: When using the eBay vault program, if an item is shipped to a vault, the tax address will be the vault address. - $ref: '#/components/schemas/TaxAddress' + description: "This container consists of address information that can be\ + \ used by sellers for tax purpose.

Note: When using the eBay vault program, if an item\ + \ is shipped to a vault, the tax address will be the vault address." + $ref: "#/components/schemas/TaxAddress" taxIdentifier: - description: This container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces.

Note: Currently, the taxIdentifier container is only returned in getOrder and not in getOrders. So, if a seller wanted to view a buyer's tax information for a particular order returned in getOrders, that seller would need to use the orderId value for that particular order, and then run a getOrder call against that order ID. - $ref: '#/components/schemas/TaxIdentifier' + description: "This container consists of taxpayer identification information\ + \ for buyers from Italy, Spain, or Guatemala. It is currently only returned\ + \ for orders occurring on the eBay Italy or eBay Spain marketplaces.
Note: Currently,\ + \ the taxIdentifier container is only returned in getOrder\ + \ and not in getOrders. So, if a seller wanted to view\ + \ a buyer's tax information for a particular order returned in getOrders,\ + \ that seller would need to use the orderId value for\ + \ that particular order, and then run a getOrder call\ + \ against that order ID. " + $ref: "#/components/schemas/TaxIdentifier" username: - type: string - description: The buyer's eBay user ID. - description: This type contains information about the order's buyer. + type: "string" + description: "The buyer's eBay user ID." + description: "This type contains information about the order's buyer." CancelRequest: - type: object + type: "object" properties: cancelCompletedDate: - type: string - description: The date and time that the order cancellation was completed, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the cancellation request has actually been approved by the seller.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the order cancellation was completed,\ + \ if applicable. This timestamp is in ISO 8601 format, which uses the\ + \ 24-hour Universal Coordinated Time (UTC) clock. This field is not returned\ + \ until the cancellation request has actually been approved by the seller.
Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" cancelInitiator: - type: string - description: This string value indicates the party who made the initial cancellation request. Typically, either the 'Buyer' or 'Seller'. If a cancellation request has been made, this field should be returned. + type: "string" + description: "This string value indicates the party who made the initial\ + \ cancellation request. Typically, either the 'Buyer' or 'Seller'. If\ + \ a cancellation request has been made, this field should be returned." cancelReason: - type: string - description: The reason why the cancelInitiator initiated the cancellation request. Cancellation reasons for a buyer might include 'order placed by mistake' or 'order won't arrive in time'. For a seller, a typical cancellation reason is 'out of stock'. If a cancellation request has been made, this field should be returned. + type: "string" + description: "The reason why the cancelInitiator initiated the cancellation\ + \ request. Cancellation reasons for a buyer might include 'order placed\ + \ by mistake' or 'order won't arrive in time'. For a seller, a typical\ + \ cancellation reason is 'out of stock'. If a cancellation request has\ + \ been made, this field should be returned." cancelRequestedDate: - type: string - description: The date and time that the order cancellation was requested. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is returned for each cancellation request.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the order cancellation was requested.\ + \ This timestamp is in ISO 8601 format, which uses the 24-hour Universal\ + \ Coordinated Time (UTC) clock. This field is returned for each cancellation\ + \ request.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" cancelRequestId: - type: string - description: The unique identifier of the order cancellation request. This field is returned for each cancellation request. + type: "string" + description: "The unique identifier of the order cancellation request. This\ + \ field is returned for each cancellation request." cancelRequestState: - type: string - description: The current stage or condition of the cancellation request. This field is returned for each cancellation request. For implementation help, refer to eBay API documentation - description: This type contains information about a buyer request to cancel an order. + type: "string" + description: "The current stage or condition of the cancellation request.\ + \ This field is returned for each cancellation request. For implementation\ + \ help, refer to eBay\ + \ API documentation" + description: "This type contains information about a buyer request to cancel\ + \ an order." CancelStatus: - type: object + type: "object" properties: cancelledDate: - type: string - description: The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time the order was cancelled, if applicable.\ + \ This timestamp is in ISO 8601 format, which uses the 24-hour Universal\ + \ Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" cancelRequests: - type: array - description: This array contains details of one or more buyer requests to cancel the order.

For the getOrders call: This array is returned but is always empty.
For the getOrder call: This array is returned fully populated with information about any cancellation requests. + type: "array" + description: "This array contains details of one or more buyer requests\ + \ to cancel the order.

For the getOrders call: This\ + \ array is returned but is always empty.
For the getOrder call:\ + \ This array is returned fully populated with information about any cancellation\ + \ requests." items: - $ref: '#/components/schemas/CancelRequest' + $ref: "#/components/schemas/CancelRequest" cancelState: - type: string - description: The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of NONE_REQUESTED is returned. For implementation help, refer to eBay API documentation - description: This type contains information about any requests that have been made to cancel an order. + type: "string" + description: "The state of the order with regard to cancellation. This field\ + \ is always returned, and if there are no cancellation requests, a value\ + \ of NONE_REQUESTED is returned. For implementation help,\ + \ refer to eBay\ + \ API documentation" + description: "This type contains information about any requests that have been\ + \ made to cancel an order." ContestPaymentDisputeRequest: - type: object + type: "object" properties: returnAddress: - description: This container is needed if the seller is requesting that the buyer return the item. If this container is used, all relevant fields must be included, including fullName and primaryPhone. - $ref: '#/components/schemas/ReturnAddress' + description: "This container is needed if the seller is requesting that\ + \ the buyer return the item. If this container is used, all relevant fields\ + \ must be included, including fullName and primaryPhone." + $ref: "#/components/schemas/ReturnAddress" revision: - type: integer - description: This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1. - format: int32 - description: This type is used by the request payload of the contestPaymentDispute method. + type: "integer" + description: "This integer value indicates the revision number of the payment\ + \ dispute. This field is required. The current revision\ + \ number for a payment dispute can be retrieved with the getPaymentDispute\ + \ method. Each time an action is taken against a payment dispute, this\ + \ integer value increases by 1." + format: "int32" + description: "This type is used by the request payload of the contestPaymentDispute\ + \ method." DeliveryCost: - type: object + type: "object" properties: importCharges: - description: The amount of any import charges applied to international shipping of the line item. This container is only returned if import charges apply to the line item. - $ref: '#/components/schemas/Amount' + description: "The amount of any import charges applied to international\ + \ shipping of the line item. This container is only returned if import\ + \ charges apply to the line item." + $ref: "#/components/schemas/Amount" shippingCost: - description: The total cost of shipping all units of the line item. This container is always returned even when the shipping cost is free, in which case the value field will show 0.0 (dollars). - $ref: '#/components/schemas/Amount' + description: "The total cost of shipping all units of the line item. This\ + \ container is always returned even when the shipping cost is free, in\ + \ which case the value field will show 0.0 (dollars)." + $ref: "#/components/schemas/Amount" shippingIntermediationFee: - description: This field shows the fee due to eBay's international shipping provider for a line item that is being shipped through the Global Shipping Program.

This container is only returned for line items being shipped internationally through the Global Shipping Program, which is currently only supported in the US and UK marketplaces.

Note: The value returned for this field will always be 0.0 for line items sold in the UK marketplace. - $ref: '#/components/schemas/Amount' - description: This type contains a breakdown of all costs associated with the fulfillment of a line item. + description: "This field shows the fee due to eBay's international shipping\ + \ provider for a line item that is being shipped through the Global Shipping\ + \ Program.

This container is only returned for line items being\ + \ shipped internationally through the Global Shipping Program, which is\ + \ currently only supported in the US and UK marketplaces.

Note: The value returned for this\ + \ field will always be 0.0 for line items sold in the UK\ + \ marketplace." + $ref: "#/components/schemas/Amount" + description: "This type contains a breakdown of all costs associated with the\ + \ fulfillment of a line item." DisputeAmount: - type: object + type: "object" properties: convertedFromCurrency: - type: string - description: The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay. For implementation help, refer to eBay API documentation + type: "string" + description: "The three-letter ISO 4217 code representing the currency of the\ + \ amount in the convertedFromValue field. This value is the pre-conversion\ + \ currency.

This field is only returned if/when currency conversion\ + \ was applied by eBay. For implementation help, refer to eBay\ + \ API documentation" convertedFromValue: - type: string - description: The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay. + type: "string" + description: "The monetary amount before any conversion is performed, in\ + \ the currency specified by the convertedFromCurrency field. This\ + \ value is the pre-conversion amount. The value field contains\ + \ the converted amount of this value, in the currency specified by the\ + \ currency field.

This field is only returned if/when currency\ + \ conversion was applied by eBay." currency: - type: string - description: 'A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user''s country. For implementation help, refer to eBay API documentation' + type: "string" + description: "A three-letter ISO 4217 code that indicates the currency of\ + \ the amount in the value field. This field is always returned\ + \ with any container using Amount type.

Default:\ + \ The currency of the authenticated user's country. For implementation\ + \ help, refer to eBay\ + \ API documentation" exchangeRate: - type: string - description: The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

This field is only returned if/when currency conversion was applied by eBay. + type: "string" + description: "The exchange rate used for the monetary conversion. This field\ + \ shows the exchange rate used to convert the dollar value in the value\ + \ field from the dollar value in the convertedFromValue field.

This\ + \ field is only returned if/when currency conversion was applied by eBay." value: - type: string - description: The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. - description: This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable. + type: "string" + description: "The monetary amount, in the currency specified by the currency\ + \ field. This field is always returned with any container using Amount\ + \ type." + description: "This type defines the monetary value of an amount. It can provide\ + \ the amount in both the currency used on the eBay site where an item is being\ + \ offered and the conversion of that value into another currency, if applicable." DisputeEvidence: - type: object + type: "object" properties: evidenceId: - type: string - description: Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set. + type: "string" + description: "Unique identifier of the evidential file set. Potentially,\ + \ each evidential file set can have more than one file, that is why there\ + \ is this file set identifier, and then an identifier for each file within\ + \ this file set." evidenceType: - type: string - description: This enumeration value shows the type of evidential file provided. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value shows the type of evidential file provided.\ + \ For implementation help, refer to eBay\ + \ API documentation" files: - type: array - description: This array shows the name, ID, file type, and upload date for each provided file. + type: "array" + description: "This array shows the name, ID, file type, and upload date\ + \ for each provided file." items: - $ref: '#/components/schemas/FileInfo' + $ref: "#/components/schemas/FileInfo" lineItems: - type: array - description: This array shows one or more order line items associated with the evidential document that has been provided. + type: "array" + description: "This array shows one or more order line items associated with\ + \ the evidential document that has been provided." items: - $ref: '#/components/schemas/OrderLineItems' + $ref: "#/components/schemas/OrderLineItems" providedDate: - type: string - description: 'The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the seller\ + \ provided a requested evidential document to eBay.

The timestamps\ + \ returned here use the ISO-8601 24-hour date and time format, and the\ + \ time zone used is Universal Coordinated Time (UTC), also known as Greenwich\ + \ Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ.\ + \ An example would be 2019-08-04T19:09:02.768Z." requestDate: - type: string - description: 'The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when eBay\ + \ requested the evidential document from the seller in response to a payment\ + \ dispute.

The timestamps returned here use the ISO-8601 24-hour\ + \ date and time format, and the time zone used is Universal Coordinated\ + \ Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601\ + \ format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example\ + \ would be 2019-08-04T19:09:02.768Z." respondByDate: - type: string - description: 'The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the seller\ + \ was expected to provide a requested evidential document to eBay.

The\ + \ timestamps returned here use the ISO-8601 24-hour date and time format,\ + \ and the time zone used is Universal Coordinated Time (UTC), also known\ + \ as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like\ + \ this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." shipmentTracking: - type: array - description: This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned if the seller has provided shipment tracking information as evidence to support PROOF_OF_DELIVERY. + type: "array" + description: "This array shows the shipping carrier and shipment tracking\ + \ number associated with each shipment package of the order. This array\ + \ is returned if the seller has provided shipment tracking information\ + \ as evidence to support PROOF_OF_DELIVERY." items: - $ref: '#/components/schemas/TrackingInfo' - description: 'This type is used by the evidence array that is returned in the getPaymentDispute response if one or more evidential documents are associated with the payment dispute. ' + $ref: "#/components/schemas/TrackingInfo" + description: "This type is used by the evidence array that\ + \ is returned in the getPaymentDispute response if one or\ + \ more evidential documents are associated with the payment dispute. " DisputeSummaryResponse: - type: object + type: "object" properties: href: - type: string - description: The URI of the getPaymentDisputeSummaries call request that produced the current page of the result set. + type: "string" + description: "The URI of the getPaymentDisputeSummaries\ + \ call request that produced the current page of the result set." limit: - type: integer - description: 'This value shows the maximum number of payment disputes that will appear on one page of the result set. The limit value can be passed in as a query parameter in the request, or if it is not used, it defaults to 200. If the value in the total field exceeds this limit value, there are multiple pages in the current result set.

Min: 1; Max: 200; Default: 200' - format: int32 + type: "integer" + description: "This value shows the maximum number of payment disputes that\ + \ will appear on one page of the result set. The limit\ + \ value can be passed in as a query parameter in the request, or if it\ + \ is not used, it defaults to 200. If the value in the total\ + \ field exceeds this limit value, there are multiple\ + \ pages in the current result set.

Min: 1; Max: 200;\ + \ Default: 200" + format: "int32" next: - type: string - description: The getPaymentDisputeSummaries call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 11 thru 20 from the collection of payment disputes:

path/payment_dispute_summary?limit=10&offset=10

This field is only returned if there is a next page of results to view based on the current input criteria. + type: "string" + description: "The getPaymentDisputeSummaries call URI to\ + \ use if you wish to view the next page of the result set. For example,\ + \ the following URI returns records 11 thru 20 from the collection of\ + \ payment disputes:

path/payment_dispute_summary?limit=10&offset=10

This\ + \ field is only returned if there is a next page of results to view based\ + \ on the current input criteria." offset: - type: integer - description: This integer value indicates the number of payment disputes skipped before listing the first payment dispute from the result set. The offset value can be passed in as a query parameter in the request, or if it is not used, it defaults to 0 and the first payment dispute of the result set is shown at the top of the response. - format: int32 + type: "integer" + description: "This integer value indicates the number of payment disputes\ + \ skipped before listing the first payment dispute from the result set.\ + \ The offset value can be passed in as a query parameter\ + \ in the request, or if it is not used, it defaults to 0\ + \ and the first payment dispute of the result set is shown at the top\ + \ of the response." + format: "int32" paymentDisputeSummaries: - type: array - description: Each payment dispute that matches the input criteria is returned under this array. If no payment disputes are found, an empty array is returned. + type: "array" + description: "Each payment dispute that matches the input criteria is returned\ + \ under this array. If no payment disputes are found, an empty array is\ + \ returned." items: - $ref: '#/components/schemas/PaymentDisputeSummary' + $ref: "#/components/schemas/PaymentDisputeSummary" prev: - type: string - description: The getPaymentDisputeSummaries call URI to use if you wish to view the previous page of the result set. For example, the following URI returns records 1 thru 10 from the collection of payment disputes:

path/payment_dispute_summary?limit=10&offset=0

This field is only returned if there is a previous page of results to view based on the current input criteria. + type: "string" + description: "The getPaymentDisputeSummaries call URI to\ + \ use if you wish to view the previous page of the result set. For example,\ + \ the following URI returns records 1 thru 10 from the collection of payment\ + \ disputes:

path/payment_dispute_summary?limit=10&offset=0

This\ + \ field is only returned if there is a previous page of results to view\ + \ based on the current input criteria." total: - type: integer - description: This integer value is the total number of payment disputes that matched the input criteria. If the total number of entries exceeds the value that was set for limit in the request payload, you will have to make multiple API calls to see all pages of the results set. This field is returned even if it is 0. - format: int32 - description: This type defines the base response payload of the getPaymentDisputeSummaries method. Each payment dispute that matches the input criteria is returned under the paymentDisputeSummaries array. + type: "integer" + description: "This integer value is the total number of payment disputes\ + \ that matched the input criteria. If the total number of entries exceeds\ + \ the value that was set for limit in the request payload,\ + \ you will have to make multiple API calls to see all pages of the results\ + \ set. This field is returned even if it is 0." + format: "int32" + description: "This type defines the base response payload of the getPaymentDisputeSummaries\ + \ method. Each payment dispute that matches the input criteria is returned\ + \ under the paymentDisputeSummaries array." EbayCollectAndRemitTax: - type: object + type: "object" properties: amount: - description: The monetary amount of the 'Collect and Remit' tax. This currently includes:
  • US state-mandated sales tax
  • Federal and Provincial Sales Tax in Canada
  • 'Goods and Services' tax in Canada, Australia, and New Zealand
  • VAT collected for the UK and EU countries


Note: If the corresponding taxType is STATE_SALES_TAX, PROVINCE_SALES_TAX, GST, or VAT, and the lineItems.taxes container also appears for this line item with the same tax amount, the order is subject to 'eBay Collect and Remit' tax. For orders that are subject to 'eBay Collect and Remit' tax, the tax amount in this field will be included in the lineItems.total, paymentSummary.payments.amount, paymentSummary.totalDueSeller, and pricingSummary.total fields. - $ref: '#/components/schemas/Amount' + description: "The monetary amount of the 'Collect and Remit' tax. This currently\ + \ includes:
  • US state-mandated sales tax
  • Federal and\ + \ Provincial Sales Tax in Canada
  • 'Goods and Services' tax in Canada,\ + \ Australia, and New Zealand
  • VAT collected for the UK and EU countries

Note: If the corresponding\ + \ taxType is STATE_SALES_TAX, PROVINCE_SALES_TAX,\ + \ GST, or VAT, and the lineItems.taxes\ + \ container also appears for this line item with the same tax amount,\ + \ the order is subject to 'eBay Collect and Remit' tax. For orders that\ + \ are subject to 'eBay Collect and Remit' tax, the tax amount in this\ + \ field will be included in the lineItems.total, paymentSummary.payments.amount,\ + \ paymentSummary.totalDueSeller, and pricingSummary.total\ + \ fields." + $ref: "#/components/schemas/Amount" ebayReference: - description: This container field describes the line-item level VAT tax details.

Note: On January 31, 2022, the orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2 will stop being used to return VAT information, so developers should make sure they integrate with the new fields before that time.

- $ref: '#/components/schemas/EbayTaxReference' + description: "This container field describes the line-item level VAT tax\ + \ details.

Note: On January 31, 2022,\ + \ the orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2\ + \ will stop being used to return VAT information, so developers should\ + \ make sure they integrate with the new fields before that time.

" + $ref: "#/components/schemas/EbayTaxReference" taxType: - type: string - description: The type of tax and fees that eBay will collect and remit to the taxing or fee authority. See the TaxTypeEnum type definition for more information about each tax or fee type. For implementation help, refer to eBay API documentation + type: "string" + description: "The type of tax and fees that eBay will collect and remit\ + \ to the taxing or fee authority. See the TaxTypeEnum\ + \ type definition for more information about each tax or fee type. For\ + \ implementation help, refer to eBay\ + \ API documentation" collectionMethod: - type: string - description: This field indicates the collection method used to collect the 'Collect and Remit' tax for the order. This field is always returned for orders subject to 'Collect and Remit' tax, and its value is always NET.

Note: Although the collectionMethod field is returned for all orders subject to 'Collect and Remit' tax, the collectionMethod field and the CollectionMethodEnum type are not currently of any practical use, although this field may have use in the future. If and when the logic of this field is changed, this note will be updated and a note will also be added to the Release Notes. For implementation help, refer to eBay API documentation - description: This type contains information about the type and amount of tax that eBay will collect and remit to the state, province, country, or other taxing authority in the buyer's location, as required by that taxing authority.

'Collect and Remit' tax includes:
  • US state-mandated sales tax
  • Federal and Provincial Sales Tax in Canada
  • 'Goods and Services' tax in Canada, Australia, and New Zealand
  • VAT collected for the UK and EU countries
+ type: "string" + description: "This field indicates the collection method used to collect\ + \ the 'Collect and Remit' tax for the order. This field is always returned\ + \ for orders subject to 'Collect and Remit' tax, and its value is always\ + \ NET.

Note:\ + \ Although the collectionMethod field is returned for\ + \ all orders subject to 'Collect and Remit' tax, the collectionMethod\ + \ field and the CollectionMethodEnum type are not currently\ + \ of any practical use, although this field may have use in the future.\ + \ If and when the logic of this field is changed, this note will be updated\ + \ and a note will also be added to the Release Notes. For implementation\ + \ help, refer to eBay\ + \ API documentation" + description: "This type contains information about the type and amount of tax\ + \ that eBay will collect and remit to the state, province, country, or other\ + \ taxing authority in the buyer's location, as required by that taxing authority.

'Collect\ + \ and Remit' tax includes:
  • US state-mandated sales tax
  • Federal\ + \ and Provincial Sales Tax in Canada
  • 'Goods and Services' tax in Canada,\ + \ Australia, and New Zealand
  • VAT collected for the UK and EU countries
" + EbayCollectedCharges: + type: "object" + properties: + ebayShipping: + description: "This container consists of costs related to eBay Shipping\ + \ collected by eBay from the buyer of this order." + $ref: "#/components/schemas/Amount" + description: "This type contains the breakdown of costs that are collected by\ + \ eBay from the buyer." EbayFulfillmentProgram: - type: object + type: "object" properties: fulfilledBy: - type: string - description: 'The value returned in this field indicates the party that is handling fulfillment of the order line item.

Valid value: EBAY' - description: This type is used to provide details about an order line item being fulfilled by eBay or an eBay fulfillment partner. + type: "string" + description: "The value returned in this field indicates the party that\ + \ is handling fulfillment of the order line item.

Valid value:\ + \ EBAY" + description: "This type is used to provide details about an order line item\ + \ being fulfilled by eBay or an eBay fulfillment partner." + EbayInternationalShipping: + type: "object" + properties: + returnsManagedBy: + type: "string" + description: "The value returned in this field indicates the party that\ + \ is responsible for managing returns of the order line item.
Valid value: EBAY" + description: "This type is used to provide details about an order line item\ + \ being managed through eBay International Shipping." + EbayShipping: + type: "object" + properties: + shippingLabelProvidedBy: + type: "string" + description: "This field contains the shipping label provider. If EBAY,\ + \ this order is managed by eBay shipping and a free shipping label by\ + \ eBay is downloadable by the seller via the eBay website." + description: "This type contains information about the management of the shipping\ + \ for the order." EbayTaxReference: - type: object + type: "object" properties: name: - type: string - description: 'This field value is returned to indicate the VAT tax type, which will vary by country/region. This string value will be one of the following:
  • ABN: if this string is returned, the ID in the value field is an Australia tax ID
  • DDG: if this string is returned, it indicates that tax has been collected and remitted for Digitally Delivered Goods (DDG)
  • IOSS: if this string is returned, the ID in the value field is an eBay EU or UK IOSS number
  • IRD: if this string is returned, the ID in the value field is an eBay New Zealand tax ID
  • OSS: if this string is returned, the ID in the value field is an eBay Germany VAT ID
  • VOEC: if this string is returned, the ID in the value field is an eBay Norway tax ID
' + type: "string" + description: "This field value is returned to indicate the VAT tax type,\ + \ which will vary by country/region. This string value will be one of\ + \ the following:
  • ABN: if this string is returned,\ + \ the ID in the value field is an Australia tax ID
  • DDG:\ + \ if this string is returned, it indicates that tax has been collected\ + \ and remitted for Digitally Delivered Goods (DDG)
  • IOSS:\ + \ if this string is returned, the ID in the value field\ + \ is an eBay EU or UK IOSS number
  • IRD: if this string\ + \ is returned, the ID in the value field is an eBay New\ + \ Zealand tax ID
  • OSS: if this string is returned,\ + \ the ID in the value field is an eBay Germany VAT ID
  • VOEC:\ + \ if this string is returned, the ID in the value field\ + \ is an eBay Norway tax ID
" value: - type: string - description: 'The value returned in this field is the VAT identifier number (VATIN), which will vary by country/region. This field will be returned if VAT tax is applicable for the order. The name field indicates the VAT tax type, which will vary by country/region:
  • ABN: eBay AU tax ID
  • IOSS: eBay EU IOSS number / eBay UK IOSS number
  • IRD: eBay NZ tax ID
  • OSS: eBay DE VAT ID
  • VOEC: eBay NO number
' - description: This type describes the VAT tax details. The eBay VAT tax type and the eBay VAT identifier number will be returned if a VAT tax is applicable for the order.

Note: On January 31, 2022, the orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2 will stop being used to return VAT information, so developers should make sure they integrate with the new fields before that time.

+ type: "string" + description: "The value returned in this field is the VAT identifier number\ + \ (VATIN), which will vary by country/region. This field will be returned\ + \ if VAT tax is applicable for the order. The name field\ + \ indicates the VAT tax type, which will vary by country/region:
  • ABN:\ + \ eBay AU tax ID
  • IOSS: eBay EU IOSS\ + \ number / eBay UK IOSS number
  • IRD:\ + \ eBay NZ tax ID
  • OSS: eBay DE VAT\ + \ ID
  • VOEC: eBay NO number
" + description: "This type describes the VAT tax details. The eBay VAT tax type\ + \ and the eBay VAT identifier number will be returned if a VAT tax is applicable\ + \ for the order.

Note: On January 31,\ + \ 2022, the orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2\ + \ will stop being used to return VAT information, so developers should make\ + \ sure they integrate with the new fields before that time.

" EbayVaultProgram: - type: object + type: "object" properties: fulfillmentType: - type: string - description: 'This field specifies how an eBay vault order will be fulfilled. Supported options are:
  • Seller to Vault: the order will be shipped by the seller to an authenticator.
  • Vault to Vault: the order will be shipped from an eBay vault to the buyer''s vault.
  • Vault to Buyer: the order will be shipped from an eBay vault to the buyer''s shipping address.
For implementation help, refer to eBay API documentation' + type: "string" + description: "This field specifies how an eBay vault order will be fulfilled.\ + \ Supported options are:
  • Seller to Vault: the order will\ + \ be shipped by the seller to an authenticator.
  • Vault to Vault:\ + \ the order will be shipped from an eBay vault to the buyer's vault.
  • Vault\ + \ to Buyer: the order will be shipped from an eBay vault to the buyer's\ + \ shipping address.
For implementation help, refer to eBay\ + \ API documentation" Error: - type: object + type: "object" properties: category: - type: string - description: The context or source of this error or warning. + type: "string" + description: "The context or source of this error or warning." domain: - type: string - description: The name of the domain containing the service or application. For example, sell is a domain. + type: "string" + description: "The name of the domain containing the service or application.\ + \ For example, sell is a domain." errorId: - type: integer - description: A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms. - format: int32 + type: "integer" + description: "A positive integer that uniquely identifies the specific error\ + \ condition that occurred. Your application can use these values as error\ + \ code identifiers in your customized error-handling algorithms." + format: "int32" inputRefIds: - type: array - description: A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation. + type: "array" + description: "A list of one or more specific request elements (if any) associated\ + \ with the error or warning. The format of these strings depends on the\ + \ request payload format. For JSON, use JSONPath notation." items: - type: string + type: "string" longMessage: - type: string - description: An expanded version of the message field.

Maximum length: 200 characters + type: "string" + description: "An expanded version of the message field.
Maximum length: 200 characters" message: - type: string - description: A message about the error or warning which is device agnostic and readable by end users and application developers. It explains what the error or warning is, and how to fix it (in a general sense). If applicable, the value is localized to the end user's requested locale.

Maximum length: 50 characters + type: "string" + description: "A message about the error or warning which is device agnostic\ + \ and readable by end users and application developers. It explains what\ + \ the error or warning is, and how to fix it (in a general sense). If\ + \ applicable, the value is localized to the end user's requested locale.\ + \

Maximum length: 50 characters" outputRefIds: - type: array - description: A list of one or more specific response elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation. + type: "array" + description: "A list of one or more specific response elements (if any)\ + \ associated with the error or warning. The format of these strings depends\ + \ on the request payload format. For JSON, use JSONPath notation." items: - type: string + type: "string" parameters: - type: array - description: Contains a list of name/value pairs that provide additional information concerning this error or warning. Each item in the list is an input parameter that contributed to the error or warning condition. + type: "array" + description: "Contains a list of name/value pairs that provide additional\ + \ information concerning this error or warning. Each item in the list\ + \ is an input parameter that contributed to the error or warning condition." items: - $ref: '#/components/schemas/ErrorParameter' + $ref: "#/components/schemas/ErrorParameter" subdomain: - type: string - description: The name of the domain's subsystem or subdivision. For example, fulfillment is a subdomain in the sell domain. - description: 'This type contains a error or warning related to a call request. ' + type: "string" + description: "The name of the domain's subsystem or subdivision. For example,\ + \ fulfillment is a subdomain in the sell domain." + description: "This type contains a error or warning related to a call request. " ErrorParameter: - type: object + type: "object" properties: name: - type: string - description: This is the name of input field that caused an issue with the call request. + type: "string" + description: "This is the name of input field that caused an issue with\ + \ the call request." value: - type: string - description: This is the actual value that was passed in for the element specified in the name field. - description: This type contains the name and value of an input parameter that contributed to a specific error or warning condition. + type: "string" + description: "This is the actual value that was passed in for the element\ + \ specified in the name field." + description: "This type contains the name and value of an input parameter that\ + \ contributed to a specific error or warning condition." EvidenceRequest: - type: object + type: "object" properties: evidenceId: - type: string - description: Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set. + type: "string" + description: "Unique identifier of the evidential file set. Potentially,\ + \ each evidential file set can have more than one file, that is why there\ + \ is this file set identifier, and then an identifier for each file within\ + \ this file set." evidenceType: - type: string - description: This enumeration value shows the type of evidential document provided. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value shows the type of evidential document\ + \ provided. For implementation help, refer to eBay\ + \ API documentation" lineItems: - type: array - description: This array shows one or more order line items associated with the evidential document that has been provided. + type: "array" + description: "This array shows one or more order line items associated with\ + \ the evidential document that has been provided." items: - $ref: '#/components/schemas/OrderLineItems' + $ref: "#/components/schemas/OrderLineItems" requestDate: - type: string - description: 'The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when eBay\ + \ requested the evidential document from the seller in response to a payment\ + \ dispute.

The timestamps returned here use the ISO-8601 24-hour\ + \ date and time format, and the time zone used is Universal Coordinated\ + \ Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601\ + \ format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example\ + \ would be 2019-08-04T19:09:02.768Z." respondByDate: - type: string - description: 'The timestamp in this field shows the date/time when the seller is expected to provide a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' - description: This type is used by the evidenceRequests array that is returned in the getPaymentDispute response if one or more evidential documents are being requested to help resolve the payment dispute. + type: "string" + description: "The timestamp in this field shows the date/time when the seller\ + \ is expected to provide a requested evidential document to eBay.

The\ + \ timestamps returned here use the ISO-8601 24-hour date and time format,\ + \ and the time zone used is Universal Coordinated Time (UTC), also known\ + \ as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like\ + \ this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." + description: "This type is used by the evidenceRequests array\ + \ that is returned in the getPaymentDispute response if one\ + \ or more evidential documents are being requested to help resolve the payment\ + \ dispute." ExtendedContact: - type: object + type: "object" properties: companyName: - type: string - description: The company name associated with the buyer or eBay shipping partner. This field is only returned if defined/applicable to the buyer or eBay shipping partner. + type: "string" + description: "The company name associated with the buyer or eBay shipping\ + \ partner. This field is only returned if defined/applicable to the buyer\ + \ or eBay shipping partner." contactAddress: - description: This container shows the shipping address of the buyer or eBay shipping partner. - $ref: '#/components/schemas/Address' + description: "This container shows the shipping address of the buyer or\ + \ eBay shipping partner." + $ref: "#/components/schemas/Address" email: - type: string - description: This field contains the email address of the buyer. This address will be returned for up to 14 days from order creation. If an order is more than 14 days old, no address is returned.

Note: If returned, this field contains the email address of the buyer, even for Global Shipping Program shipments. + type: "string" + description: "This field contains the email address of the buyer. This address\ + \ will be returned for up to 14 days from order creation. If an order\ + \ is more than 14 days old, no address is returned.

Note: If returned, this field\ + \ contains the email address of the buyer, even for Global Shipping Program\ + \ shipments." fullName: - type: string - description: The full name of the buyer or eBay shipping partner. + type: "string" + description: "The full name of the buyer or eBay shipping partner." primaryPhone: - description: The primary telephone number of the buyer or eBay shipping partner. - $ref: '#/components/schemas/PhoneNumber' - description: This type contains shipping and contact information for a buyer or an eBay shipping partner. + description: "The primary telephone number of the buyer or eBay shipping\ + \ partner." + $ref: "#/components/schemas/PhoneNumber" + description: "This type contains shipping and contact information for a buyer\ + \ or an eBay shipping partner." FileEvidence: - type: object + type: "object" properties: fileId: - type: string - description: If an uploadEvidenceFile call is successful, a unique identifier of this evidence file will be returned in the uploadEvidenceFile response payload. This unique fileId value is then used to either add this evidence file to a new evidence set using the addEvidence method, or to add this file to an existing evidence set using the updateEvidence method.

Note that if an evidence set already exists for a payment dispute, the getPaymentDispute method will return both the evidenceId (unique identifier of evidence set) value, and the fileId (unique identifier of a file within that evidence set) value(s). - description: This type is used to store the unique identifier of an evidence file. Evidence files are used by seller to contest a payment dispute. + type: "string" + description: "If an uploadEvidenceFile call is successful,\ + \ a unique identifier of this evidence file will be returned in the uploadEvidenceFile\ + \ response payload. This unique fileId value is then\ + \ used to either add this evidence file to a new evidence set using the\ + \ addEvidence method, or to add this file to an existing\ + \ evidence set using the updateEvidence method.

Note\ + \ that if an evidence set already exists for a payment dispute, the getPaymentDispute\ + \ method will return both the evidenceId (unique identifier\ + \ of evidence set) value, and the fileId (unique identifier\ + \ of a file within that evidence set) value(s)." + description: "This type is used to store the unique identifier of an evidence\ + \ file. Evidence files are used by seller to contest a payment dispute." FileInfo: - type: object + type: "object" properties: fileId: - type: string - description: The unique identifier of the evidence file. + type: "string" + description: "The unique identifier of the evidence file." fileType: - type: string - description: The type of file uploaded. Supported file extensions are .JPEG, .JPG, and .PNG., and maximum file size allowed is 1.5 MB. + type: "string" + description: "The type of file uploaded. Supported file extensions are .JPEG,\ + \ .JPG, and .PNG., and maximum file size allowed is 1.5 MB." name: - type: string - description: The seller-provided name of the evidence file. + type: "string" + description: "The seller-provided name of the evidence file." uploadedDate: - type: string - description: 'The timestamp in this field shows the date/time when the seller uploaded the evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' - description: This type is used by the files array, which shows the name, ID, file type, and upload date for each provided evidential file. + type: "string" + description: "The timestamp in this field shows the date/time when the seller\ + \ uploaded the evidential document to eBay.

The timestamps returned\ + \ here use the ISO-8601 24-hour date and time format, and the time zone\ + \ used is Universal Coordinated Time (UTC), also known as Greenwich Mean\ + \ Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ.\ + \ An example would be 2019-08-04T19:09:02.768Z." + description: "This type is used by the files array, which shows\ + \ the name, ID, file type, and upload date for each provided evidential file." FulfillmentStartInstruction: - type: object + type: "object" properties: ebaySupportedFulfillment: - type: boolean - description: This field is only returned if its value is true and indicates that the fulfillment will be shipped via eBay's Global Shipping Program.

For more information, see the Global Shipping Program help topic. + type: "boolean" + description: "This field is only returned if its value is true\ + \ and indicates that the fulfillment will be shipped via eBay's Global\ + \ Shipping Program, eBay International Shipping, or the Authenticity Guarantee\ + \ service program.

For more information, see the Global Shipping Program help topic." finalDestinationAddress: - description: This container is only returned if the value of ebaySupportedFulfillment field is true.

This is the final destination address for a Global Shipping Program shipment, which is usually the buyer's home. Sellers should not ship directly to this address; instead they should ship this package to their international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address.

For more information, see Addressing a Global Shipping Program Shipment.

Note: For Authenticity Guarantee program shipment, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer shipping address.

- $ref: '#/components/schemas/Address' + description: "This container is only returned if the value of ebaySupportedFulfillment\ + \ field is true.

This is the final destination\ + \ address for a Global Shipping Program shipment or an eBay International\ + \ Shipping shipment, which is usually the recipient's home. Sellers should\ + \ not ship directly to this address; instead they should ship this package\ + \ to their international shipping provider's domestic warehouse. The international\ + \ shipping provider is responsible for delivery to the final destination\ + \ address.

For more information, see Addressing a Global Shipping Program Shipment.

\ + \ Note: For Authenticity Guarantee\ + \ program shipment, this is the address of the authenticator's warehouse.\ + \ The authenticator is responsible for delivery to the buyer shipping\ + \ address.

" + $ref: "#/components/schemas/Address" fulfillmentInstructionsType: - type: string - description: The enumeration value returned in this field indicates the method of fulfillment that will be used to deliver this set of line items (this package) to the buyer. This field will have a value of SHIP_TO if the ebaySupportedFulfillment field is returned with a value of true. See the FulfillmentInstructionsType definition for more information about different fulfillment types. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value returned in this field indicates the\ + \ method of fulfillment that will be used to deliver this set of line\ + \ items (this package) to the buyer. This field will have a value of SHIP_TO\ + \ if the ebaySupportedFulfillment field is returned with a value\ + \ of true. See the FulfillmentInstructionsType\ + \ definition for more information about different fulfillment types. For\ + \ implementation help, refer to eBay\ + \ API documentation" maxEstimatedDeliveryDate: - type: string - description: This is the estimated latest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned ifthe value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "This is the estimated latest date that the fulfillment will\ + \ be completed. This timestamp is in ISO 8601 format, which uses the 24-hour\ + \ Universal Coordinated Time (UTC) clock. This field is not returned ifthe\ + \ value of the fulfillmentInstructionsType field is DIGITAL\ + \ or PREPARE_FOR_PICKUP.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" minEstimatedDeliveryDate: - type: string - description: This is the estimated earliest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned if the value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "This is the estimated earliest date that the fulfillment will\ + \ be completed. This timestamp is in ISO 8601 format, which uses the 24-hour\ + \ Universal Coordinated Time (UTC) clock. This field is not returned if\ + \ the value of the fulfillmentInstructionsType field is DIGITAL\ + \ or PREPARE_FOR_PICKUP.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" pickupStep: - description: This container is only returned for In-Store Pickup orders, and it indicates the specific merchant's store where the buyer will pick up the order. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces. - $ref: '#/components/schemas/PickupStep' + description: "This container is only returned for In-Store Pickup orders,\ + \ and it indicates the specific merchant's store where the buyer will\ + \ pick up the order. The In-Store Pickup feature is supported in the US,\ + \ Canada, UK, Germany, and Australia marketplaces." + $ref: "#/components/schemas/PickupStep" shippingStep: - description: This container consists of shipping information for this fulfillment, including the shipping carrier, the shipping service option, and the shipment destination. This container is not returned if the value of the fulfillmentInstructionsType field is DIGITAL, or for In-Store Pickup orders.

For Click and Collect orders, the shipping destination will be a brick-and-mortar store where the buyer will pick up the order. - $ref: '#/components/schemas/ShippingStep' - description: This type contains a set of specifications for processing a fulfillment of an order, including the type of fulfillment, shipping carrier and service, addressing details, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order. + description: "This container consists of shipping information for this fulfillment,\ + \ including the shipping carrier, the shipping service option, and the\ + \ shipment destination. This container is not returned if the value of\ + \ the fulfillmentInstructionsType field is DIGITAL,\ + \ or for In-Store Pickup orders.

For Click and Collect orders,\ + \ the shipping destination will be a brick-and-mortar store where the\ + \ buyer will pick up the order." + $ref: "#/components/schemas/ShippingStep" + description: "This type contains a set of specifications for processing a fulfillment\ + \ of an order, including the type of fulfillment, shipping carrier and service,\ + \ addressing details, and estimated delivery window. These instructions are\ + \ derived from the buyer's and seller's eBay account preferences, the listing\ + \ parameters, and the buyer's checkout selections. The seller can use them\ + \ as a starting point for packaging, addressing, and shipping the order." GiftDetails: - type: object + type: "object" properties: message: - type: string - description: This field contains the gift message from the buyer to the gift recipient. This field is only returned if the buyer of the gift included a message for the gift. + type: "string" + description: "This field contains the gift message from the buyer to the\ + \ gift recipient. This field is only returned if the buyer of the gift\ + \ included a message for the gift." recipientEmail: - type: string - description: The email address of the gift recipient. The seller will send the digital gift card to this email address. + type: "string" + description: "The email address of the gift recipient. The seller will send\ + \ the digital gift card to this email address." senderName: - type: string - description: The name of the buyer, which will appear on the email that is sent to the gift recipient. - description: This type contains information about a digital gift card line item that was purchased as a gift, and sent to the recipient by email. + type: "string" + description: "The name of the buyer, which will appear on the email that\ + \ is sent to the gift recipient." + description: "This type contains information about a digital gift card line\ + \ item that was purchased as a gift, and sent to the recipient by email." InfoFromBuyer: - type: object + type: "object" properties: note: - type: string - description: This field shows any note that was left by the buyer for in regards to the dispute. + type: "string" + description: "This field shows any note that was left by the buyer for in\ + \ regards to the dispute." returnShipmentTracking: - type: array - description: This array shows shipment tracking information for one or more shipping packages being returned to the buyer after a payment dispute. + type: "array" + description: "This array shows shipment tracking information for one or\ + \ more shipping packages being returned to the buyer after a payment dispute." items: - $ref: '#/components/schemas/TrackingInfo' - description: This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return. + $ref: "#/components/schemas/TrackingInfo" + description: "This container is returned if the buyer is returning one or more\ + \ line items in an order that is associated with the payment dispute, and\ + \ that buyer has provided return shipping tracking information and/or a note\ + \ about the return." IssueRefundRequest: - type: object + type: "object" properties: reasonForRefund: - type: string - description: The enumeration value passed into this field indicates the reason for the refund. One of the defined enumeration values in the ReasonForRefundEnum type must be used.

This field is required, and it is highly recommended that sellers use the correct refund reason, especially in the case of a buyer-requested cancellation or 'buyer remorse' return to indicate that there was nothing wrong with the item(s) or with the shipment of the order.

Note: If issuing refunds for more than one order line item, keep in mind that the refund reason must be the same for each of the order line items. If the refund reason is different for one or more order line items in an order, the seller would need to make separate issueRefund calls, one for each refund reason. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value passed into this field indicates the\ + \ reason for the refund. One of the defined enumeration values in the\ + \ ReasonForRefundEnum type must be used.

This field is\ + \ required, and it is highly recommended that sellers use the correct\ + \ refund reason, especially in the case of a buyer-requested cancellation\ + \ or 'buyer remorse' return to indicate that there was nothing wrong with\ + \ the item(s) or with the shipment of the order.

Note: If issuing refunds for more than one\ + \ order line item, keep in mind that the refund reason must be the same\ + \ for each of the order line items. If the refund reason is different\ + \ for one or more order line items in an order, the seller would need\ + \ to make separate issueRefund calls, one for each refund reason.\ + \ For implementation help, refer to eBay\ + \ API documentation" comment: - type: string - description: 'This free-text field allows the seller to clarify why the refund is being issued to the buyer.

Max Length: 100' + type: "string" + description: "This free-text field allows the seller to clarify why the\ + \ refund is being issued to the buyer.

Max Length: 100" refundItems: - type: array - description: The refundItems array is only required if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount container to specify the amount of the refund for the entire order. + type: "array" + description: "The refundItems array is only required if the seller\ + \ is issuing a refund for one or more individual order line items in a\ + \ multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount\ + \ container to specify the amount of the refund for the entire order." items: - $ref: '#/components/schemas/RefundItem' + $ref: "#/components/schemas/RefundItem" orderLevelRefundAmount: - description: This container is used to specify the amount of the refund for the entire order. If a seller wants to issue a refund for an individual line item within a multiple line item order, the seller would use the refundItems array instead. - $ref: '#/components/schemas/SimpleAmount' - description: The base type used by the request payload of the issueRefund method. + description: "This container is used to specify the amount of the refund\ + \ for the entire order. If a seller wants to issue a refund for an individual\ + \ line item within a multiple line item order, the seller would use the\ + \ refundItems array instead." + $ref: "#/components/schemas/SimpleAmount" + description: "The base type used by the request payload of the issueRefund\ + \ method." ItemLocation: - type: object + type: "object" properties: countryCode: - type: string - description: The two-letter ISO 3166 code representing the country of the address. For implementation help, refer to eBay API documentation + type: "string" + description: "The two-letter ISO 3166 code\ + \ representing the country of the address. For implementation help, refer\ + \ to eBay\ + \ API documentation" location: - type: string - description: Indicates the geographical location of the item (along with the value in the countryCode field). This field provides city, province, state, or similar information. + type: "string" + description: "Indicates the geographical location of the item (along with\ + \ the value in the countryCode field). This field provides\ + \ city, province, state, or similar information." postalCode: - type: string - description: The postal code of the address. - description: This type describes the physical location of an order. + type: "string" + description: "The postal code of the address." + description: "This type describes the physical location of an order." LegacyReference: - type: object + type: "object" properties: legacyItemId: - type: string - description: The unique identifier of a listing in legacy/Trading API format.

Note: Both legacyItemId and legacyTransactionId are needed to identify an order line item. + type: "string" + description: "The unique identifier of a listing in legacy/Trading API format.\ + \

Note: Both legacyItemId\ + \ and legacyTransactionId are needed to identify an order line\ + \ item. " legacyTransactionId: - type: string - description: The unique identifier of a sale/transaction in legacy/Trading API format. A 'transaction ID' is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder.

Note: Both legacyItemId and legacyTransactionId are needed to identify an order line item. - description: Type defining the legacyReference container. This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID and transaction ID to identify the order line item. + type: "string" + description: "The unique identifier of a sale/transaction in legacy/Trading\ + \ API format. A 'transaction ID' is created once a buyer purchases a 'Buy\ + \ It Now' item or if an auction listing ends with a winning bidder.

Note: Both legacyItemId\ + \ and legacyTransactionId are needed to identify an order line\ + \ item. " + description: "Type defining the legacyReference container. This container\ + \ is needed if the seller is issuing a refund for an individual order line\ + \ item, and wishes to use an item ID and transaction ID to identify the order\ + \ line item." LineItem: - type: object + type: "object" properties: appliedPromotions: - type: array - description: This array contains information about one or more sales promotions or discounts applied to the line item. It is always returned, but will be returned as an empty array if no special sales promotions or discounts apply to the order line item. + type: "array" + description: "This array contains information about one or more sales promotions\ + \ or discounts applied to the line item. It is always returned, but will\ + \ be returned as an empty array if no special sales promotions or discounts\ + \ apply to the order line item." items: - $ref: '#/components/schemas/AppliedPromotion' + $ref: "#/components/schemas/AppliedPromotion" deliveryCost: - description: This container consists of a breakdown of all costs associated with the fulfillment of the line item. - $ref: '#/components/schemas/DeliveryCost' + description: "This container consists of a breakdown of all costs associated\ + \ with the fulfillment of the line item." + $ref: "#/components/schemas/DeliveryCost" discountedLineItemCost: - description: The cost of the line item after applying any discounts. This container is only returned if the order line item was discounted through a promotion. - $ref: '#/components/schemas/Amount' + description: "The cost of the line item after applying any discounts. This\ + \ container is only returned if the order line item was discounted through\ + \ a promotion." + $ref: "#/components/schemas/Amount" ebayCollectAndRemitTaxes: - type: array - description: This container will be returned if the order line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf.

'Collect and Remit' tax includes:
  • US state-mandated sales tax
  • Federal and Provincial Sales Tax in Canada
  • 'Goods and Services' tax in Canada, Australia, and New Zealand
  • VAT collected for the UK and EU countries
The amount of this tax is shown in the amount field, and the type of tax is shown in the taxType field.

eBay will display the tax type and amount during checkout in accordance with the buyer's address, and handle collection and remittance of the tax without requiring the seller to take any action. + type: "array" + description: "This container will be returned if the order line item is\ + \ subject to a 'Collect and Remit' tax that eBay will collect and remit\ + \ to the proper taxing authority on the buyer's behalf.

'Collect\ + \ and Remit' tax includes:
  • US state-mandated sales tax
  • Federal\ + \ and Provincial Sales Tax in Canada
  • 'Goods and Services' tax\ + \ in Canada, Australia, and New Zealand
  • VAT collected for the\ + \ UK and EU countries
The amount of this tax is shown in the\ + \ amount field, and the type of tax is shown in the taxType\ + \ field.

eBay will display the tax type and amount during checkout\ + \ in accordance with the buyer's address, and handle collection and remittance\ + \ of the tax without requiring the seller to take any action." items: - $ref: '#/components/schemas/EbayCollectAndRemitTax' + $ref: "#/components/schemas/EbayCollectAndRemitTax" + ebayCollectedCharges: + description: "This container consists of a breakdown of costs that are collected\ + \ by eBay from the buyer for this order.

Note: Currently, this container is returned only if\ + \ eBay is directly charging the buyer for eBay shipping." + $ref: "#/components/schemas/EbayCollectedCharges" giftDetails: - description: This container consists of information that is needed by the seller to send a digital gift card to the buyer, or recipient of the digital gift card. This container is only returned and applicable for digital gift card line items. - $ref: '#/components/schemas/GiftDetails' + description: "This container consists of information that is needed by the\ + \ seller to send a digital gift card to the buyer, or recipient of the\ + \ digital gift card. This container is only returned and applicable for\ + \ digital gift card line items." + $ref: "#/components/schemas/GiftDetails" itemLocation: - description: This container field describes the physical location of the order line item. - $ref: '#/components/schemas/ItemLocation' + description: "This container field describes the physical location of the\ + \ order line item." + $ref: "#/components/schemas/ItemLocation" legacyItemId: - type: string - description: The eBay-generated legacy listing item ID of the listing. Note that the unique identifier of a listing in REST-based APIs is called the listingId instead. + type: "string" + description: "The eBay-generated legacy listing item ID of the listing.\ + \ Note that the unique identifier of a listing in REST-based APIs is called\ + \ the listingId instead." legacyVariationId: - type: string - description: The unique identifier of a single variation within a multiple-variation listing. This field is only returned if the line item purchased was from a multiple-variation listing. + type: "string" + description: "The unique identifier of a single variation within a multiple-variation\ + \ listing. This field is only returned if the line item purchased was\ + \ from a multiple-variation listing." lineItemCost: - description: The selling price of the line item before applying any discounts. The value of this field is calculated by multiplying the single unit price by the number of units purchased (value of the quantity field). - $ref: '#/components/schemas/Amount' + description: "The selling price of the line item before applying any discounts.\ + \ The value of this field is calculated by multiplying the single unit\ + \ price by the number of units purchased (value of the quantity\ + \ field)." + $ref: "#/components/schemas/Amount" lineItemFulfillmentInstructions: - description: This container consists of information related to shipping dates and expectations, including the 'ship-by date' and expected delivery windows that are based on the seller's stated handling time and the shipping service option that will be used. These fields provide guidance on making sure expected delivery dates are made, whether the order is a eBay Guaranteed Delivery order or a non-guaranteed delivery order. - $ref: '#/components/schemas/LineItemFulfillmentInstructions' + description: "This container consists of information related to shipping\ + \ dates and expectations, including the 'ship-by date' and expected delivery\ + \ windows that are based on the seller's stated handling time and the\ + \ shipping service option that will be used. These fields provide guidance\ + \ on making sure expected delivery dates are made, whether the order is\ + \ a eBay Guaranteed Delivery order or a non-guaranteed delivery\ + \ order." + $ref: "#/components/schemas/LineItemFulfillmentInstructions" lineItemFulfillmentStatus: - type: string - description: This enumeration value indicates the current fulfillment status of the line item. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value indicates the current fulfillment status\ + \ of the line item. For implementation help, refer to eBay\ + \ API documentation" lineItemId: - type: string - description: This is the unique identifier of an eBay order line item. This field is created as soon as there is a commitment to buy from the seller. + type: "string" + description: "This is the unique identifier of an eBay order line item.\ + \ This field is created as soon as there is a commitment to buy from the\ + \ seller." listingMarketplaceId: - type: string - description: The unique identifier of the eBay marketplace where the line item was listed. For implementation help, refer to eBay API documentation + type: "string" + description: "The unique identifier of the eBay marketplace where the line\ + \ item was listed. For implementation help, refer to eBay\ + \ API documentation" properties: - description: Contains information about the eBay programs, if any, under which the line item was listed. - $ref: '#/components/schemas/LineItemProperties' + description: "Contains information about the eBay programs, if any, under\ + \ which the line item was listed." + $ref: "#/components/schemas/LineItemProperties" purchaseMarketplaceId: - type: string - description: The unique identifier of the eBay marketplace where the line item was listed. Often, the listingMarketplaceId and the purchaseMarketplaceId identifier are the same, but there are occasions when an item will surface on multiple eBay marketplaces. For implementation help, refer to eBay API documentation + type: "string" + description: "The unique identifier of the eBay marketplace where the line\ + \ item was listed. Often, the listingMarketplaceId and\ + \ the purchaseMarketplaceId identifier are the same,\ + \ but there are occasions when an item will surface on multiple eBay marketplaces.\ + \ For implementation help, refer to eBay\ + \ API documentation" quantity: - type: integer - description: The number of units of the line item in the order. These are represented as a group by a single lineItemId. - format: int32 + type: "integer" + description: "The number of units of the line item in the order. These are\ + \ represented as a group by a single lineItemId." + format: "int32" refunds: - type: array - description: This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund. + type: "array" + description: "This array is always returned, but is returned as an empty\ + \ array unless the seller has submitted a partial or full refund to the\ + \ buyer for the order. If a refund has occurred, the refund amount and\ + \ refund date will be shown for each refund." items: - $ref: '#/components/schemas/LineItemRefund' + $ref: "#/components/schemas/LineItemRefund" sku: - type: string - description: Seller-defined Stock-Keeping Unit (SKU). This inventory identifier must be unique within the seller's eBay inventory. SKUs are optional when listing in the legacy/Trading API system, but SKUs are required when listing items through the Inventory API model. + type: "string" + description: "Seller-defined Stock-Keeping Unit (SKU). This inventory identifier\ + \ must be unique within the seller's eBay inventory. SKUs are optional\ + \ when listing in the legacy/Trading API system, but SKUs are required\ + \ when listing items through the Inventory API model." soldFormat: - type: string - description: The eBay listing type of the line item. The most common listing types are AUCTION and FIXED_PRICE. For implementation help, refer to eBay API documentation + type: "string" + description: "The eBay listing type of the line item. The most common listing\ + \ types are AUCTION and FIXED_PRICE. For implementation\ + \ help, refer to eBay\ + \ API documentation" taxes: - type: array - description: Contains a list of taxes applied to the line item, if any. This array is always returned, but will be returned as empty if no taxes are applicable to the line item. + type: "array" + description: "Contains a list of taxes applied to the line item, if any.\ + \ This array is always returned, but will be returned as empty if no taxes\ + \ are applicable to the line item." items: - $ref: '#/components/schemas/Tax' + $ref: "#/components/schemas/Tax" title: - type: string - description: The title of the listing. + type: "string" + description: "The title of the listing." total: - description: 'This is the total price that the buyer must pay for the line item after all costs (item cost, delivery cost, taxes,) are added, minus any discounts and/or promotions.

Note: For orders that are subject to ''eBay Collect and Remit'' tax, the ''Collect and Remit'' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN. If the fieldGroups query parameter is not set to TAX_BREAKDOWN, ''Collect and Remit'' will not be added into this total value.

To determine if ''Collect and Remit'' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the ''Collect and Remit'' tax amount that the buyer paid is in this amount:
  • STATE_SALES_TAX: US state-mandated sales tax
  • PROVINCE_SALES_TAX: Provincial Sales Tax in Canada
  • GST: ''Goods and Services'' tax in Canada, Australia, and New Zealand
  • VAT: VAT collected for UK and EU countries
' - $ref: '#/components/schemas/Amount' - description: This type contains the details of each line item in an order. + description: "This is the total price that the buyer must pay for the line\ + \ item after all costs (item cost, delivery cost, taxes,) are added, minus\ + \ any discounts and/or promotions.

Note: For orders that are subject to 'eBay Collect and\ + \ Remit' tax, the 'Collect and Remit' tax amount for the order will be\ + \ included in this total value only when the fieldGroups\ + \ query parameter is set to TAX_BREAKDOWN. If the fieldGroups\ + \ query parameter is not set to TAX_BREAKDOWN, 'Collect and\ + \ Remit' will not be added into this total value.

To\ + \ determine if 'Collect and Remit' taxes were added into this total\ + \ value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes\ + \ and the lineItems.taxes containers in the response.\ + \ If both of these containers appear for one or more line items in the\ + \ response with the following taxType values, the 'Collect\ + \ and Remit' tax amount that the buyer paid is in this amount:
  • STATE_SALES_TAX:\ + \ US state-mandated sales tax
  • PROVINCE_SALES_TAX:\ + \ Provincial Sales Tax in Canada
  • GST: 'Goods and\ + \ Services' tax in Canada, Australia, and New Zealand
  • VAT:\ + \ VAT collected for UK and EU countries
" + $ref: "#/components/schemas/Amount" + description: "This type contains the details of each line item in an order." LineItemFulfillmentInstructions: - type: object + type: "object" properties: guaranteedDelivery: - type: boolean - description: This field is returned as true if the order line item is qualified for eBay Guaranteed Delivery, or false if it is not eligible. Only domestic shipments are available for eBay Guaranteed Delivery. At this time, eBay Guaranteed Delivery is only available to a select number of sellers on the US and Australia sites, but this feature will be enabled on more eBay sites in 2019.

There are two different eBay Guaranteed Delivery options - 'Handling time' option and 'Door-to-Door' option. With both options, the seller is commiting to getting the order delivered to the buyer within three business days after purchase.

With the 'Handling time' option, the seller's stated handling time for a listing must be 'same-day' or '1-day', and at least one of the available shipping service options should have a shipping time that guarantees that the buyer receives the order on time. With this option, eBay will set the 'ship-by date' and expected delivery window for the seller, and the seller should just make sure they physically ship the order by the shipToDate.

With the 'Door-to-door' option, the seller must create regional shipping rate tables (with shipping costs and delivery times based on destination regions), and then apply these regional shipping rates/delivery times to the listing.

If a 'Door-to-door' order does not arrive on time, the seller must refund the buyer the full shipping cost (if any), and the buyer also has the option of returning the item for a full refund, and the seller will also have to pay the return shipping cost. With 'Handling time' option, as long as the seller meets the stated handling time, and ships using the correct shipping service option, eBay will refund the buyer the shipping cost and pay for return shipping label (if buyer wants to return item) if the order arrives after the expected delivery time.

For more information on the details and requirements of eBay Guaranteed Delivery, see the Offering eBay Guaranteed Delivery help topic.

This field will always be returned regardless of whether the listing site offers eBay Guaranteed Delivery or if the seller is opted in to the feature. + type: "boolean" + description: "This field is returned as true if the order line\ + \ item is qualified for eBay Guaranteed Delivery, or false\ + \ if it is not eligible. Only domestic shipments are available for eBay\ + \ Guaranteed Delivery. At this time, eBay Guaranteed Delivery is only\ + \ available to a select number of sellers on the US and Australia sites,\ + \ but this feature will be enabled on more eBay sites in 2019.

\ + \ There are two different eBay Guaranteed Delivery options - 'Handling\ + \ time' option and 'Door-to-Door' option. With both options, the seller\ + \ is commiting to getting the order delivered to the buyer within three\ + \ business days after purchase.

With the 'Handling time' option,\ + \ the seller's stated handling time for a listing must be 'same-day' or\ + \ '1-day', and at least one of the available shipping service options\ + \ should have a shipping time that guarantees that the buyer receives\ + \ the order on time. With this option, eBay will set the 'ship-by date'\ + \ and expected delivery window for the seller, and the seller should just\ + \ make sure they physically ship the order by the shipToDate.

\ + \ With the 'Door-to-door' option, the seller must create regional shipping\ + \ rate tables (with shipping costs and delivery times based on destination\ + \ regions), and then apply these regional shipping rates/delivery times\ + \ to the listing.

If a 'Door-to-door' order does not arrive\ + \ on time, the seller must refund the buyer the full shipping cost (if\ + \ any), and the buyer also has the option of returning the item for a\ + \ full refund, and the seller will also have to pay the return shipping\ + \ cost. With 'Handling time' option, as long as the seller meets the stated\ + \ handling time, and ships using the correct shipping service option,\ + \ eBay will refund the buyer the shipping cost and pay for return shipping\ + \ label (if buyer wants to return item) if the order arrives after the\ + \ expected delivery time.

For more information on the details\ + \ and requirements of eBay Guaranteed Delivery, see the Offering eBay Guaranteed Delivery help topic.

\ + \ This field will always be returned regardless of whether the listing\ + \ site offers eBay Guaranteed Delivery or if the seller is opted in to\ + \ the feature." maxEstimatedDeliveryDate: - type: string - description: The estimated latest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. If the listing is eligible for eBay Guaranteed Delivery (value of guaranteedDelivery field is true, the seller must pay extra attention to this date, as a failure to deliver by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The estimated latest date and time that the buyer can expect\ + \ to receive the line item based on the seller's stated handling time\ + \ and the transit times of the available shipping service options. If\ + \ the listing is eligible for eBay Guaranteed Delivery (value of guaranteedDelivery\ + \ field is true, the seller must pay extra attention to this\ + \ date, as a failure to deliver by this date/time can result in a 'Late\ + \ shipment' seller defect, and can affect seller level and Top-Rated Seller\ + \ status. In addition to the seller defect, buyers will be eligible for\ + \ a shipping cost refund, and will also be eligible to return the item\ + \ for a full refund (with no return shipping charge) if they choose.
Note: This timestamp\ + \ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\ + \ Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" minEstimatedDeliveryDate: - type: string - description: The estimated earliest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The estimated earliest date and time that the buyer can expect\ + \ to receive the line item based on the seller's stated handling time\ + \ and the transit times of the available shipping service options.
Note: This timestamp\ + \ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\ + \ Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" shipByDate: - type: string - description: The latest date and time by which the seller should ship line item in order to meet the expected delivery window. This timestamp will be set by eBay based on time of purchase and the seller's stated handling time. If the listing is eligible for eBay Guaranteed Delivery (value of guaranteedDelivery field is true, the seller must pay extra attention to this date, as a failure to physically ship the line item by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z - description: This type contains the specifications for processing the fulfillment of a line item, including the handling window and the delivery window. These fields provide guidance for eBay Guaranteed Delivery as well as for non-guaranteed delivery. + type: "string" + description: "The latest date and time by which the seller should ship line\ + \ item in order to meet the expected delivery window. This timestamp will\ + \ be set by eBay based on time of purchase and the seller's stated handling\ + \ time. If the listing is eligible for eBay Guaranteed Delivery (value\ + \ of guaranteedDelivery field is true, the seller\ + \ must pay extra attention to this date, as a failure to physically ship\ + \ the line item by this date/time can result in a 'Late shipment' seller\ + \ defect, and can affect seller level and Top-Rated Seller status. In\ + \ addition to the seller defect, buyers will be eligible for a shipping\ + \ cost refund, and will also be eligible to return the item for a full\ + \ refund (with no return shipping charge) if they choose.

Note: This timestamp is in ISO\ + \ 8601 format, which uses the 24-hour Universal Coordinated Time (UTC)\ + \ clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" + description: "This type contains the specifications for processing the fulfillment\ + \ of a line item, including the handling window and the delivery window. These\ + \ fields provide guidance for eBay Guaranteed Delivery as well as for\ + \ non-guaranteed delivery." LineItemProperties: - type: object + type: "object" properties: buyerProtection: - type: boolean - description: A value of true indicates that the line item is covered by eBay's Buyer Protection program. + type: "boolean" + description: "A value of true indicates that the line item\ + \ is covered by eBay's Buyer Protection program." fromBestOffer: - type: boolean - description: This field is only returned if true and indicates that the purchase occurred by the buyer and seller mutually agreeing on a Best Offer amount. The Best Offer feature can be set up for any listing type, but if this feature is set up for an auction listing, it will no longer be available once a bid has been placed on the listing. + type: "boolean" + description: "This field is only returned if true and indicates\ + \ that the purchase occurred by the buyer and seller mutually agreeing\ + \ on a Best Offer amount. The Best Offer feature can be set up for any\ + \ listing type, but if this feature is set up for an auction listing,\ + \ it will no longer be available once a bid has been placed on the listing." soldViaAdCampaign: - type: boolean - description: This field is only returned if true and indicates that the line item was sold as a result of a seller's ad campaign. - description: This type contains information about the eBay programs under which a line item was listed and sold. + type: "boolean" + description: "This field is only returned if true and indicates\ + \ that the line item was sold as a result of a seller's ad campaign." + description: "This type contains information about the eBay programs under which\ + \ a line item was listed and sold." LineItemReference: - type: object + type: "object" properties: lineItemId: - type: string - description: This is the unique identifier of the eBay order line item that is part of the shipping fulfillment. The line item ID is created as soon as there is a commitment to buy from the seller. + type: "string" + description: "This is the unique identifier of the eBay order line item\ + \ that is part of the shipping fulfillment. The line item ID is created\ + \ as soon as there is a commitment to buy from the seller." quantity: - type: integer - description: This field is reserved for internal or future use. - format: int32 - description: This type identifies the line item and quantity of that line item that comprises one fulfillment, such as a shipping package. + type: "integer" + description: "This field is reserved for internal or future use." + format: "int32" + description: "This type identifies the line item and quantity of that line item\ + \ that comprises one fulfillment, such as a shipping package." LineItemRefund: - type: object + type: "object" properties: amount: - description: This field shows the refund amount for a line item. This field is only returned if the buyer is due a refund for the line item.

Note: The refund amount shown is the seller's net amount received from the sale/transaction. eBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value. - $ref: '#/components/schemas/Amount' + description: "This field shows the refund amount for a line item. This field\ + \ is only returned if the buyer is due a refund for the line item.

Note: The refund amount shown is the seller's\ + \ net amount received from the sale/transaction. eBay-collected\ + \ tax will not be included in this amount, so the actual amount of the\ + \ buyer's refund may be higher than this value." + $ref: "#/components/schemas/Amount" refundDate: - type: string - description: The date and time that the refund was issued for the line item. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the refund was issued for the line\ + \ item. This timestamp is in ISO 8601 format, which uses the 24-hour Universal\ + \ Coordinated Time (UTC) clock. This field is not returned until the refund\ + \ has been issued.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" refundId: - type: string - description: Unique identifier of a refund that was initiated for an order's line item through the issueRefund method. If the issueRefund method was used to issue a refund at the order level, this identifier is returned at the order level instead (paymentSummary.refunds.refundId field).

A refundId value is returned in the response of the issueRefund method, and this same value will be returned in the getOrder and getOrders responses for pending and completed refunds. + type: "string" + description: "Unique identifier of a refund that was initiated for an order's\ + \ line item through the issueRefund method. If the issueRefund\ + \ method was used to issue a refund at the order level, this identifier\ + \ is returned at the order level instead (paymentSummary.refunds.refundId\ + \ field).

A refundId value is returned in the response\ + \ of the issueRefund method, and this same value will be returned\ + \ in the getOrder and getOrders responses for pending and\ + \ completed refunds." refundReferenceId: - type: string - description: This field is reserved for internal or future use. - description: This type contains refund information for a line item. + type: "string" + description: "This field is reserved for internal or future use." + description: "This type contains refund information for a line item." MonetaryTransaction: - type: object + type: "object" properties: date: - type: string - description: 'This timestamp indicates when the monetary transaction occurred. A date is returned for all monetary transactions.

The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z.' + type: "string" + description: "This timestamp indicates when the monetary transaction occurred.\ + \ A date is returned for all monetary transactions.

The following\ + \ format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example,\ + \ 2015-08-04T19:09:02.768Z." type: - type: string - description: This enumeration value indicates whether the monetary transaction is a charge or a credit to the seller. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value indicates whether the monetary transaction\ + \ is a charge or a credit to the seller. For implementation help, refer\ + \ to eBay\ + \ API documentation" reason: - type: string - description: This enumeration value indicates the reason for the monetary transaction. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value indicates the reason for the monetary\ + \ transaction. For implementation help, refer to eBay\ + \ API documentation" amount: - description: The amount involved in the monetary transaction. For active cross-border trade orders, the currency conversion and exchangeRate fields will be displayed as well. - $ref: '#/components/schemas/DisputeAmount' - description: This type is used to provide details about one or more monetary transactions that occur as part of a payment dispute. + description: "The amount involved in the monetary transaction. For active\ + \ cross-border trade orders, the currency conversion and exchangeRate\ + \ fields will be displayed as well." + $ref: "#/components/schemas/DisputeAmount" + description: "This type is used to provide details about one or more monetary\ + \ transactions that occur as part of a payment dispute." Order: - type: object + type: "object" properties: buyer: - description: This container consists of information about the order's buyer. At this time, only the buyer's eBay user ID is returned, but it's possible that more buyer information can be added to this container in the future. - $ref: '#/components/schemas/Buyer' + description: "This container consists of information about the order's buyer.\ + \ At this time, only the buyer's eBay user ID is returned, but it's possible\ + \ that more buyer information can be added to this container in the future." + $ref: "#/components/schemas/Buyer" buyerCheckoutNotes: - type: string - description: 'This field contains any comments that the buyer left for the seller about the order during checkout process. This field is only returned if a buyer left comments at checkout time. ' + type: "string" + description: "This field contains any comments that the buyer left for the\ + \ seller about the order during checkout process. This field is only returned\ + \ if a buyer left comments at checkout time. " cancelStatus: - description: This container consists of order cancellation information if a cancel request has been made. This container is always returned, and if no cancel request has been made, the cancelState field is returned with a value of NONE_REQUESTED, and an empty cancelRequests array is also returned. - $ref: '#/components/schemas/CancelStatus' + description: "This container consists of order cancellation information\ + \ if a cancel request has been made. This container is always returned,\ + \ and if no cancel request has been made, the cancelState\ + \ field is returned with a value of NONE_REQUESTED, and an\ + \ empty cancelRequests array is also returned." + $ref: "#/components/schemas/CancelStatus" creationDate: - type: string - description: The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the order was created. This timestamp\ + \ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\ + \ Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" ebayCollectAndRemitTax: - type: boolean - description: This field is only returned if true, and indicates that eBay will collect tax (US state-mandated sales tax, Federal and Provincial Sales Tax in Canada, 'Goods and Services' tax in Canada, Australia, and New Zealand, and VAT collected for UK and EU countries,) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence. If this field is returned, the seller should search for one or more ebayCollectAndRemitTaxes containers at the line item level to get more information about the type of tax and the amount. + type: "boolean" + description: "This field is only returned if true, and indicates\ + \ that eBay will collect tax (US state-mandated sales tax, Federal and\ + \ Provincial Sales Tax in Canada, 'Goods and Services' tax in Canada,\ + \ Australia, and New Zealand, and VAT collected for UK and EU countries,)\ + \ for at least one line item in the order, and remit the tax to the taxing\ + \ authority of the buyer's residence. If this field is returned, the seller\ + \ should search for one or more ebayCollectAndRemitTaxes\ + \ containers at the line item level to get more information about the\ + \ type of tax and the amount." fulfillmentHrefs: - type: array - description: This array contains a list of one or more getShippingFulfillment call URIs that can be used to retrieve shipping fulfillments that have been set up for the order. + type: "array" + description: "This array contains a list of one or more getShippingFulfillment\ + \ call URIs that can be used to retrieve shipping fulfillments that have\ + \ been set up for the order." items: - type: string + type: "string" fulfillmentStartInstructions: - type: array - description: This container consists of a set of specifications for fulfilling the order, including the type of fulfillment, shipping carrier and service, shipping address, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order.

Note: Although this container is presented as an array, it currently returns only one set of fulfillment specifications. Additional array members will be supported in future functionality. + type: "array" + description: "This container consists of a set of specifications for fulfilling\ + \ the order, including the type of fulfillment, shipping carrier and service,\ + \ shipping address, and estimated delivery window. These instructions\ + \ are derived from the buyer's and seller's eBay account preferences,\ + \ the listing parameters, and the buyer's checkout selections. The seller\ + \ can use them as a starting point for packaging, addressing, and shipping\ + \ the order.

Note:\ + \ Although this container is presented as an array, it currently returns\ + \ only one set of fulfillment specifications. Additional array members\ + \ will be supported in future functionality." items: - $ref: '#/components/schemas/FulfillmentStartInstruction' + $ref: "#/components/schemas/FulfillmentStartInstruction" lastModifiedDate: - type: string - description: The date and time that the order was last modified. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the order was last modified. This timestamp\ + \ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\ + \ Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" legacyOrderId: - type: string - description: The unique identifier of the order in legacy format, as traditionally used by the Trading API (and other legacy APIs). Both the orderId field and this field are always returned.

Note: In June 2019, Order IDs in REST APIs transitioned to a new format. For the Trading and other legacy APIs, by using version control/compatibility level, users have the option of using the older legacy order ID format, or they can migrate to the new order ID format, which is the same order ID format being used by REST APIs. Although users of the Trading API (and other legacy APIs) can now transition to the new order ID format, this legacyOrderId field will still return order IDs in the old format to distinguish between the old and new order IDs. + type: "string" + description: "The unique identifier of the order in legacy format, as traditionally\ + \ used by the Trading API (and other legacy APIs). Both the orderId\ + \ field and this field are always returned." lineItems: - type: array - description: This array contains the details for all line items that comprise the order. + type: "array" + description: "This array contains the details for all line items that comprise\ + \ the order." items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" orderFulfillmentStatus: - type: string - description: The degree to which fulfillment of the order is complete. See the OrderFulfillmentStatus type definition for more information about each possible fulfillment state. For implementation help, refer to eBay API documentation + type: "string" + description: "The degree to which fulfillment of the order is complete.\ + \ See the OrderFulfillmentStatus type definition for\ + \ more information about each possible fulfillment state. For implementation\ + \ help, refer to eBay\ + \ API documentation" orderId: - type: string - description: The unique identifier of the order. Both the legacyOrderId field (traditionally used by Trading and other legacy APIS) and this field are always returned.

Note: In June 2019, Order IDs in REST APIs transitioned to a new format. For the Trading and other legacy APIs, by using version control/compatibility level, users have the option of using the older legacy order ID format, or they can migrate to the new order ID format, which is the same order ID format being used by REST APIs. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers are automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. + type: "string" + description: "The unique identifier of the order. Both the legacyOrderId\ + \ field (traditionally used by Trading and other legacy APIS) and this\ + \ field are always returned." orderPaymentStatus: - type: string - description: The enumeration value returned in this field indicates the current payment status of an order, or in case of a refund request, the current status of the refund. See the OrderPaymentStatusEnum type definition for more information about each possible payment/refund state. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value returned in this field indicates the\ + \ current payment status of an order, or in case of a refund request,\ + \ the current status of the refund. See the OrderPaymentStatusEnum\ + \ type definition for more information about each possible payment/refund\ + \ state. For implementation help, refer to eBay\ + \ API documentation" paymentSummary: - description: This container consists of detailed payment information for the order, including buyer payment for the order, refund information (if applicable), and seller payment holds (if applicable). - $ref: '#/components/schemas/PaymentSummary' + description: "This container consists of detailed payment information for\ + \ the order, including buyer payment for the order, refund information\ + \ (if applicable), and seller payment holds (if applicable)." + $ref: "#/components/schemas/PaymentSummary" pricingSummary: - description: This container consists of a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts. - $ref: '#/components/schemas/PricingSummary' + description: "This container consists of a summary of cumulative costs and\ + \ charges for all line items of an order, including item price, price\ + \ adjustments, sales taxes, delivery costs, and order discounts." + $ref: "#/components/schemas/PricingSummary" program: - description: This container is returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. The authenticator address is found in the fulfillmentStartInstructions.shippingStep.shipTo container. If the item is successfully authenticated, the authenticator will ship the item to the buyer. - $ref: '#/components/schemas/Program' + description: "This container is returned for orders that are eligible for\ + \ eBay's Authenticity Guarantee service. The seller ships Authenticity\ + \ Guarantee service items to the authentication partner instead of the\ + \ buyer. The authenticator address is found in the fulfillmentStartInstructions.shippingStep.shipTo\ + \ container. If the item is successfully authenticated, the authenticator\ + \ will ship the item to the buyer." + $ref: "#/components/schemas/Program" salesRecordReference: - type: string - description: An eBay-generated identifier that is used to identify and manage orders through the Selling Manager and Selling Manager Pro tools. This order identifier can also be found on the Orders grid page and in the Sales Record pages in Seller Hub. A salesRecordReference number is only generated and returned at the order level, and not at the order line item level.

In cases where the seller does not have a Selling Manager or Selling Manager Pro subscription nor access to Seller Hub, this field may not be returned. + type: "string" + description: "An eBay-generated identifier that is used to identify and\ + \ manage orders through the Selling Manager and Selling Manager Pro tools.\ + \ This order identifier can also be found on the Orders grid page and\ + \ in the Sales Record pages in Seller Hub. A salesRecordReference\ + \ number is only generated and returned at the order level, and not at\ + \ the order line item level.

In cases where the seller does not\ + \ have a Selling Manager or Selling Manager Pro subscription nor access\ + \ to Seller Hub, this field may not be returned." sellerId: - type: string - description: The unique eBay user ID of the seller who sold the order. + type: "string" + description: "The unique eBay user ID of the seller who sold the order." totalFeeBasisAmount: - description: 'This is the cumulative base amount used to calculate the final value fees for each order. The final value fees are deducted from the seller payout associated with the order. Final value fees are calculated as a percentage of order cost (item cost + shipping cost) and the percentage rate can vary by eBay category. ' - $ref: '#/components/schemas/Amount' + description: "This is the cumulative base amount used to calculate the final\ + \ value fees for each order. The final value fees are deducted from the\ + \ seller payout associated with the order. Final value fees are calculated\ + \ as a percentage of order cost (item cost + shipping cost) and the percentage\ + \ rate can vary by eBay category. " + $ref: "#/components/schemas/Amount" totalMarketplaceFee: - description: This is the cumulative fees accrued for the order and deducted from the seller payout. - $ref: '#/components/schemas/Amount' - description: This type contains the details of an order, including information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status. + description: "This is the cumulative fees accrued for the order and deducted\ + \ from the seller payout." + $ref: "#/components/schemas/Amount" + description: "This type contains the details of an order, including information\ + \ about the buyer, order history, shipping fulfillments, line items, costs,\ + \ payments, and order fulfillment status." OrderLineItems: - type: object + type: "object" properties: itemId: - type: string - description: The unique identifier of the eBay listing associated with the order. + type: "string" + description: "The unique identifier of the eBay listing associated with\ + \ the order." lineItemId: - type: string - description: The unique identifier of the line item within the order. The lineItemId value is created once the buyer actually purchases the item, or if there is a commitment to buy (such as an auction that is won by the buyer, an accepted Best Offer, or other situation that does not require immediate payment from the buyer). - description: This type is used by the lineItems array that is used to identify one or more line items in the order with the payment dispute. + type: "string" + description: "The unique identifier of the line item within the order. The\ + \ lineItemId value is created once the buyer actually\ + \ purchases the item, or if there is a commitment to buy (such as an auction\ + \ that is won by the buyer, an accepted Best Offer, or other situation\ + \ that does not require immediate payment from the buyer)." + description: "This type is used by the lineItems array that\ + \ is used to identify one or more line items in the order with the payment\ + \ dispute." OrderRefund: - type: object + type: "object" properties: amount: - description: This field shows the refund amount for an order. This container is always returned for each refund.

Note: The refund amount shown is the seller's net amount received from the sale/transaction. eBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value. - $ref: '#/components/schemas/Amount' + description: "This field shows the refund amount for an order. This container\ + \ is always returned for each refund.

Note: The refund amount shown is the seller's net amount\ + \ received from the sale/transaction. eBay-collected tax will not be included\ + \ in this amount, so the actual amount of the buyer's refund may be higher\ + \ than this value." + $ref: "#/components/schemas/Amount" refundDate: - type: string - description: The date and time that the refund was issued. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the refund was issued. This timestamp\ + \ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\ + \ Time (UTC) clock. This field is not returned until the refund has been\ + \ issued.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" refundId: - type: string - description: Unique identifier of a refund that was initiated for an order through the issueRefund method. If the issueRefund method was used to issue one or more refunds at the line item level, these refund identifiers are returned at the line item level instead (lineItems.refunds.refundId field).

A refundId value is returned in the response of the issueRefund method, and this same value will be returned in the getOrders and getOrders responses for pending and completed refunds. For other refunds, see the refundReferenceId field. + type: "string" + description: "Unique identifier of a refund that was initiated for an order\ + \ through the issueRefund method. If the issueRefund method\ + \ was used to issue one or more refunds at the line item level, these\ + \ refund identifiers are returned at the line item level instead (lineItems.refunds.refundId\ + \ field).

A refundId value is returned in the response\ + \ of the issueRefund method, and this same value will be returned\ + \ in the getOrders and getOrders responses for pending and\ + \ completed refunds. For other refunds, see the refundReferenceId\ + \ field." refundReferenceId: - type: string - description: The eBay-generated unique identifier for the refund. This field is not returned until the refund has been issued. + type: "string" + description: "The eBay-generated unique identifier for the refund. This\ + \ field is not returned until the refund has been issued." refundStatus: - type: string - description: This enumeration value indicates the current status of the refund to the buyer. This container is always returned for each refund. For implementation help, refer to eBay API documentation - description: This type contains information about a refund issued for an order. This does not include line item level refunds. + type: "string" + description: "This enumeration value indicates the current status of the\ + \ refund to the buyer. This container is always returned for each refund.\ + \ For implementation help, refer to eBay\ + \ API documentation" + description: "This type contains information about a refund issued for an order.\ + \ This does not include line item level refunds." OrderSearchPagedCollection: - type: object + type: "object" properties: href: - type: string - description: The URI of the getOrders call request that produced the current page of the result set. + type: "string" + description: "The URI of the getOrders call request that produced\ + \ the current page of the result set." limit: - type: integer - description: The maximum number of orders returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 50.

Note: If this is the last or only page of the result set, the page may contain fewer orders than the limit value. To determine the number of pages in a result set, divide the total value (total number of orders matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total orders) and the limit value was 50 (show 50 orders per page), the total number of pages in the result set is three, so the seller would have to make three separate getOrders calls to view all orders matching the input criteria. Default: 50 - format: int32 + type: "integer" + description: "The maximum number of orders returned per page of the result\ + \ set. The limit value can be passed in as a query parameter,\ + \ or if omitted, its value defaults to 50.

Note: If this is the last or only\ + \ page of the result set, the page may contain fewer orders than the limit\ + \ value. To determine the number of pages in a result set, divide the\ + \ total value (total number of orders matching input criteria)\ + \ by this limit value, and then round up to the next\ + \ integer. For example, if the total value was 120\ + \ (120 total orders) and the limit value was 50\ + \ (show 50 orders per page), the total number of pages in the result set\ + \ is three, so the seller would have to make three separate getOrders\ + \ calls to view all orders matching the input criteria. Default:\ + \ 50" + format: "int32" next: - type: string - description: 'The getOrders call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 41 thru 50 from the collection of orders:

path/order?limit=10&offset=40

This field is only returned if there is a next page of results to view based on the current input criteria.
' + type: "string" + description: "The getOrders call URI to use if you wish to view the\ + \ next page of the result set. For example, the following URI returns\ + \ records 41 thru 50 from the collection of orders:

path/order?limit=10&offset=40\ + \

This field is only returned if there is a next page\ + \ of results to view based on the current input criteria.
" offset: - type: integer - description: 'The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

' - format: int32 + type: "integer" + description: "The number of results skipped in the result set before listing\ + \ the first returned result. This value can be set in the request with\ + \ the offset query parameter.

Note:\ + \ The items in a paginated result set use a zero-based list where\ + \ the first item in the list has an offset of 0.

" + format: "int32" orders: - type: array - description: This array contains one or more orders that are part of the current result set, that is controlled by the input criteria. The details of each order include information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.

By default, orders are returned according to creation date (oldest to newest), but the order will vary according to any filter that is set in request. + type: "array" + description: "This array contains one or more orders that are part of the\ + \ current result set, that is controlled by the input criteria. The details\ + \ of each order include information about the buyer, order history, shipping\ + \ fulfillments, line items, costs, payments, and order fulfillment status.\ + \

By default, orders are returned according to creation date\ + \ (oldest to newest), but the order will vary according to any filter\ + \ that is set in request." items: - $ref: '#/components/schemas/Order' + $ref: "#/components/schemas/Order" prev: - type: string - description: 'The getOrders call URI for the previous result set. For example, the following URI returns orders 21 thru 30 from the collection of orders:

path/order?limit=10&offset=20

This field is only returned if there is a previous page of results to view based on the current input criteria.' + type: "string" + description: "The getOrders call URI for the previous result set.\ + \ For example, the following URI returns orders 21 thru 30 from the collection\ + \ of orders:

path/order?limit=10&offset=20

This\ + \ field is only returned if there is a previous page of results to view\ + \ based on the current input criteria." total: - type: integer - description: The total number of orders in the results set based on the current input criteria.

Note: If no orders are found, this field is returned with a value of 0. - format: int32 + type: "integer" + description: "The total number of orders in the results set based on the\ + \ current input criteria.

Note:\ + \ If no orders are found, this field is returned with a value of 0." + format: "int32" warnings: - type: array - description: This array is returned if one or more errors or warnings occur with the call request. + type: "array" + description: "This array is returned if one or more errors or warnings occur\ + \ with the call request." items: - $ref: '#/components/schemas/Error' - description: This type contains the specifications for the collection of orders that match the search or filter criteria of a getOrders call. The collection is grouped into a result set, and based on the query parameters that are set (including the limit and offset parameters), the result set may included multiple pages, but only one page of the result set can be viewed at a time. + $ref: "#/components/schemas/Error" + description: "This type contains the specifications for the collection of orders\ + \ that match the search or filter criteria of a getOrders call. The\ + \ collection is grouped into a result set, and based on the query parameters\ + \ that are set (including the limit and offset\ + \ parameters), the result set may included multiple pages, but only one page\ + \ of the result set can be viewed at a time." Payment: - type: object + type: "object" properties: amount: - description: 'The amount that seller receives for the order via the payment method mentioned in Payment.paymentMethod.

Note: For orders that are subject to ''eBay Collect and Remit'' tax, which includes US state-mandated sales tax, Federal and Provincial Sales Tax in Canada, ''Good and Services'' tax in Canada, Australia, and New Zealand, and VAT collected for UK or EU, the ''Collect and Remit'' tax amount for the order will be included in this amount.value field (and in the amount.convertedFromValue field if currency conversion is applicable).

To determine if ''Collect and Remit'' taxes were added into this totalDueSeller value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the ''Collect and Remit'' tax amount that the buyer paid is included in this amount:
  • STATE_SALES_TAX: US
  • PROVINCE_SALES_TAX: Provincial Sales Tax in Canada
  • GST: Canada, Australia, and New Zealand
  • VAT: UK and EU countries
' - $ref: '#/components/schemas/Amount' + description: "The amount that seller receives for the order via the payment\ + \ method mentioned in Payment.paymentMethod.
Note: For orders that are\ + \ subject to 'eBay Collect and Remit' tax, which includes US state-mandated\ + \ sales tax, Federal and Provincial Sales Tax in Canada, 'Good and Services'\ + \ tax in Canada, Australia, and New Zealand, and VAT collected for UK\ + \ or EU, the 'Collect and Remit' tax amount for the order will be included\ + \ in this amount.value field (and in the amount.convertedFromValue\ + \ field if currency conversion is applicable).

To determine if\ + \ 'Collect and Remit' taxes were added into this totalDueSeller\ + \ value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes\ + \ and the lineItems.taxes containers in the response.\ + \ If both of these containers appear for one or more line items in the\ + \ response with the following taxType values, the 'Collect\ + \ and Remit' tax amount that the buyer paid is included in this amount:
  • STATE_SALES_TAX:\ + \ US
  • PROVINCE_SALES_TAX: Provincial Sales Tax in\ + \ Canada
  • GST: Canada, Australia, and New Zealand
  • VAT:\ + \ UK and EU countries
" + $ref: "#/components/schemas/Amount" paymentDate: - type: string - description: The date and time that the payment was received by the seller. This field will not be returned if buyer has yet to pay for the order. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the payment was received by the seller.\ + \ This field will not be returned if buyer has yet to pay for the order.\ + \ This timestamp is in ISO 8601 format, which uses the 24-hour Universal\ + \ Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" paymentHolds: - type: array - description: This container is only returned if eBay is temporarily holding the seller's funds for the order. If a payment hold has been placed on the order, this container includes the reason for the payment hold, the expected release date of the funds into the seller's account, the current state of the hold, and as soon as the payment hold has been released, the actual release date. + type: "array" + description: "This container is only returned if eBay is temporarily holding\ + \ the seller's funds for the order. If a payment hold has been placed\ + \ on the order, this container includes the reason for the payment hold,\ + \ the expected release date of the funds into the seller's account, the\ + \ current state of the hold, and as soon as the payment hold has been\ + \ released, the actual release date." items: - $ref: '#/components/schemas/PaymentHold' + $ref: "#/components/schemas/PaymentHold" paymentMethod: - type: string - description: The payment method used to pay for the order. See the PaymentMethodTypeEnum type for more information on the payment methods. For implementation help, refer to eBay API documentation + type: "string" + description: "The payment method used to pay for the order. See the PaymentMethodTypeEnum\ + \ type for more information on the payment methods. For implementation\ + \ help, refer to eBay\ + \ API documentation" paymentReferenceId: - type: string - description: This field is only returned if payment has been made by the buyer, and the paymentMethod is ESCROW. This field contains a special ID for ESCROW. + type: "string" + description: "This field is only returned if payment has been made by the\ + \ buyer, and the paymentMethod is ESCROW.\ + \ This field contains a special ID for ESCROW." paymentStatus: - type: string - description: The enumeration value returned in this field indicates the status of the payment for the order. See the PaymentStatusEnum type definition for more information on the possible payment states. For implementation help, refer to eBay API documentation - description: This type is used to provide details about the seller payments for an order. + type: "string" + description: "The enumeration value returned in this field indicates the\ + \ status of the payment for the order. See the PaymentStatusEnum\ + \ type definition for more information on the possible payment states.\ + \ For implementation help, refer to eBay\ + \ API documentation" + description: "This type is used to provide details about the seller payments\ + \ for an order." PaymentDispute: - type: object + type: "object" properties: amount: - description: This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace. - $ref: '#/components/schemas/SimpleAmount' + description: "This container shows the dollar value associated with the\ + \ payment dispute in the currency used by the seller's marketplace." + $ref: "#/components/schemas/SimpleAmount" availableChoices: - type: array - description: The value(s) returned in this array indicate the choices that the seller has when responding to the payment dispute. Once the seller has responded to the payment dispute, this field will no longer be shown, and instead, the sellerResponse field will show the decision that the seller made. + type: "array" + description: "The value(s) returned in this array indicate the choices that\ + \ the seller has when responding to the payment dispute. Once the seller\ + \ has responded to the payment dispute, this field will no longer be shown,\ + \ and instead, the sellerResponse field will show the\ + \ decision that the seller made." items: - type: string - description: ' For implementation help, refer to eBay API documentation' + type: "string" + description: " For implementation help, refer to eBay\ + \ API documentation" buyerProvided: - description: This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return. - $ref: '#/components/schemas/InfoFromBuyer' + description: "This container is returned if the buyer is returning one or\ + \ more line items in an order that is associated with the payment dispute,\ + \ and that buyer has provided return shipping tracking information and/or\ + \ a note about the return." + $ref: "#/components/schemas/InfoFromBuyer" buyerUsername: - type: string - description: This is the eBay user ID of the buyer that initiated the payment dispute. + type: "string" + description: "This is the eBay user ID of the buyer that initiated the payment\ + \ dispute." closedDate: - type: string - description: 'The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the payment\ + \ dispute was closed, so this field is only returned for payment disputes\ + \ in the CLOSED state.

The timestamps returned here\ + \ use the ISO-8601 24-hour date and time format, and the time zone used\ + \ is Universal Coordinated Time (UTC), also known as Greenwich Mean Time\ + \ (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ.\ + \ An example would be 2019-08-04T19:09:02.768Z." evidence: - type: array - description: This container shows any evidence that has been provided by the seller to contest the payment dispute. Evidence may include shipment tracking information, proof of authentication documentation, image(s) to proof that an item is as described, or financial documentation/invoice.

This container is only returned if the seller has provided at least one document used as evidence against the payment dispute. + type: "array" + description: "This container shows any evidence that has been provided by\ + \ the seller to contest the payment dispute. Evidence may include shipment\ + \ tracking information, proof of authentication documentation, image(s)\ + \ to proof that an item is as described, or financial documentation/invoice.

This\ + \ container is only returned if the seller has provided at least one document\ + \ used as evidence against the payment dispute." items: - $ref: '#/components/schemas/DisputeEvidence' + $ref: "#/components/schemas/DisputeEvidence" evidenceRequests: - type: array - description: This container is returned if one or more evidence documents are being requested from the seller. + type: "array" + description: "This container is returned if one or more evidence documents\ + \ are being requested from the seller." items: - $ref: '#/components/schemas/EvidenceRequest' + $ref: "#/components/schemas/EvidenceRequest" lineItems: - type: array - description: This array is used to identify one or more order line items associated with the payment dispute. There will always be at least one itemId/lineItemId pair returned in this array. + type: "array" + description: "This array is used to identify one or more order line items\ + \ associated with the payment dispute. There will always be at least one\ + \ itemId/lineItemId pair returned in this array." items: - $ref: '#/components/schemas/OrderLineItems' + $ref: "#/components/schemas/OrderLineItems" monetaryTransactions: - type: array - description: This array provide details about one or more monetary transactions that occur as part of a payment dispute. This array is only returned once one or more monetary transacations occur with a payment dispute. + type: "array" + description: "This array provide details about one or more monetary transactions\ + \ that occur as part of a payment dispute. This array is only returned\ + \ once one or more monetary transacations occur with a payment dispute." items: - $ref: '#/components/schemas/MonetaryTransaction' + $ref: "#/components/schemas/MonetaryTransaction" openDate: - type: string - description: 'The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the payment\ + \ dispute was opened. This field is returned for payment disputes in all\ + \ states.

The timestamps returned here use the ISO-8601 24-hour\ + \ date and time format, and the time zone used is Universal Coordinated\ + \ Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601\ + \ format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example\ + \ would be 2019-08-04T19:09:02.768Z." orderId: - type: string - description: This is the unique identifier of the order involved in the payment dispute.

Note: eBay rolled out a new Order ID format in June 2019. The legacy APIs still support the old and new order ID format to identify orders, but only the new order ID format is returned in REST-based API responses. + type: "string" + description: "This is the unique identifier of the order involved in the\ + \ payment dispute." paymentDisputeId: - type: string - description: This is the unique identifier of the payment dispute. This is the same identifier that is passed in to the call URI. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. + type: "string" + description: "This is the unique identifier of the payment dispute. This\ + \ is the same identifier that is passed in to the call URI. This identifier\ + \ is automatically created by eBay once the payment dispute comes into\ + \ the eBay system." paymentDisputeStatus: - type: string - description: The enumeration value in this field gives the current status of the payment dispute. The status of a payment dispute partially determines other fields that are returned in the response. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value in this field gives the current status\ + \ of the payment dispute. The status of a payment dispute partially determines\ + \ other fields that are returned in the response. For implementation help,\ + \ refer to eBay\ + \ API documentation" reason: - type: string - description: The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value in this field gives the reason why the\ + \ buyer initiated the payment dispute. See DisputeReasonEnum\ + \ type for a description of the supported reasons that buyers can give\ + \ for initiating a payment dispute. For implementation help, refer to\ + \ eBay\ + \ API documentation" resolution: - description: This container gives details about a payment dispute that has been resolved. This container is only returned for resolved/closed payment disputes. - $ref: '#/components/schemas/PaymentDisputeOutcomeDetail' + description: "This container gives details about a payment dispute that\ + \ has been resolved. This container is only returned for resolved/closed\ + \ payment disputes." + $ref: "#/components/schemas/PaymentDisputeOutcomeDetail" respondByDate: - type: string - description: 'The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that currently require action by the seller, that same seller should look at the availableChoices array to see the available actions.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the seller\ + \ must response to a payment dispute, so this field is only returned for\ + \ payment disputes in the ACTION_NEEDED state. For payment\ + \ disputes that currently require action by the seller, that same seller\ + \ should look at the availableChoices array to see the\ + \ available actions.

The timestamps returned here use the ISO-8601\ + \ 24-hour date and time format, and the time zone used is Universal Coordinated\ + \ Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601\ + \ format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example\ + \ would be 2019-08-04T19:09:02.768Z." returnAddress: - description: This container gives the address where the order will be returned to. This container is returned if the seller is accepting the payment dispute and will issue a refund to the buyer once the item is returned to this address. - $ref: '#/components/schemas/ReturnAddress' + description: "This container gives the address where the order will be returned\ + \ to. This container is returned if the seller is accepting the payment\ + \ dispute and will issue a refund to the buyer once the item is returned\ + \ to this address." + $ref: "#/components/schemas/ReturnAddress" revision: - type: integer - description: This integer value indicates the revision number of the payment dispute. Each time an action is taken against a payment dispute, this integer value increases by 1. - format: int32 + type: "integer" + description: "This integer value indicates the revision number of the payment\ + \ dispute. Each time an action is taken against a payment dispute, this\ + \ integer value increases by 1." + format: "int32" sellerResponse: - type: string - description: The enumeration value returned in this field indicates how the seller has responded to the payment dispute. The seller has the option of accepting the payment dispute and agreeing to issue a refund, accepting the payment dispute and agreeing to issue a refund as long as the buyer returns the item, or contesting the payment dispute. This field is returned as soon as the seller makes an initial decision on the payment dispute. For implementation help, refer to eBay API documentation - description: This type is used by the base response of the getPaymentDispute method. The getPaymentDispute method retrieves detailed information on a specific payment dispute. + type: "string" + description: "The enumeration value returned in this field indicates how\ + \ the seller has responded to the payment dispute. The seller has the\ + \ option of accepting the payment dispute and agreeing to issue a refund,\ + \ accepting the payment dispute and agreeing to issue a refund as long\ + \ as the buyer returns the item, or contesting the payment dispute. This\ + \ field is returned as soon as the seller makes an initial decision on\ + \ the payment dispute. For implementation help, refer to eBay\ + \ API documentation" + description: "This type is used by the base response of the getPaymentDispute\ + \ method. The getPaymentDispute method retrieves detailed\ + \ information on a specific payment dispute." PaymentDisputeActivity: - type: object + type: "object" properties: activityDate: - type: string - description: 'The timestamp in this field shows the date/time of the payment dispute activity.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time of the payment\ + \ dispute activity.

The timestamps returned here use the ISO-8601\ + \ 24-hour date and time format, and the time zone used is Universal Coordinated\ + \ Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601\ + \ format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example\ + \ would be 2019-08-04T19:09:02.768Z." activityType: - type: string - description: This enumeration value indicates the type of activity that occured on the payment dispute. For example, a value of DISPUTE_OPENED is returned when a payment disute is first created, a value indicating the seller's decision on the dispute, such as SELLER_CONTEST, is returned when seller makes a decision to accept or contest dispute, and a value of DISPUTE_CLOSED is returned when a payment disute is resolved. See ActivityEnum for an explanation of each of the values that may be returned here. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value indicates the type of activity that\ + \ occured on the payment dispute. For example, a value of DISPUTE_OPENED\ + \ is returned when a payment disute is first created, a value indicating\ + \ the seller's decision on the dispute, such as SELLER_CONTEST,\ + \ is returned when seller makes a decision to accept or contest dispute,\ + \ and a value of DISPUTE_CLOSED is returned when a payment\ + \ disute is resolved. See ActivityEnum for an explanation\ + \ of each of the values that may be returned here. For implementation\ + \ help, refer to eBay\ + \ API documentation" actor: - type: string - description: This enumeration value indicates the actor that performed the action. Possible values include the BUYER, SELLER, CS_AGENT (eBay customer service), or SYSTEM. For implementation help, refer to eBay API documentation - description: This type is used by each recorded activity on a payment dispute, from creation to resolution. + type: "string" + description: "This enumeration value indicates the actor that performed\ + \ the action. Possible values include the BUYER, SELLER,\ + \ CS_AGENT (eBay customer service), or SYSTEM.\ + \ For implementation help, refer to eBay\ + \ API documentation" + description: "This type is used by each recorded activity on a payment dispute,\ + \ from creation to resolution." PaymentDisputeActivityHistory: - type: object + type: "object" properties: activity: - type: array - description: This array holds all activities of a payment dispute, from creation to resolution. For each activity, the activity type, the actor, and a timestamp is shown. The getActivities response is dynamic, and grows with each recorded activity. + type: "array" + description: "This array holds all activities of a payment dispute, from\ + \ creation to resolution. For each activity, the activity type, the actor,\ + \ and a timestamp is shown. The getActivities response\ + \ is dynamic, and grows with each recorded activity." items: - $ref: '#/components/schemas/PaymentDisputeActivity' - description: This type is used by the base response of the getActivities method, and includes a log of all activities of a payment dispute, from creation to resolution. + $ref: "#/components/schemas/PaymentDisputeActivity" + description: "This type is used by the base response of the getActivities\ + \ method, and includes a log of all activities of a payment dispute, from\ + \ creation to resolution." PaymentDisputeOutcomeDetail: - type: object + type: "object" properties: fees: - description: This container will show the dollar value of any fees associated with the payment dispute. This container is only returned if there are fees associated with the payment dispute. - $ref: '#/components/schemas/SimpleAmount' + description: "This container will show the dollar value of any fees associated\ + \ with the payment dispute. This container is only returned if there are\ + \ fees associated with the payment dispute." + $ref: "#/components/schemas/SimpleAmount" protectedAmount: - description: This container shows the amount of money that the seller is protected against in a payment dispute under eBay's seller protection policy. - $ref: '#/components/schemas/SimpleAmount' + description: "This container shows the amount of money that the seller is\ + \ protected against in a payment dispute under eBay's seller protection\ + \ policy." + $ref: "#/components/schemas/SimpleAmount" protectionStatus: - type: string - description: This enumeration value indicates if the seller is fully protected, partially protected, or not protected by eBay for the payment dispute. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value indicates if the seller is fully protected,\ + \ partially protected, or not protected by eBay for the payment dispute.\ + \ This field is always returned once the payment dispute is resolved.\ + \ For implementation help, refer to eBay\ + \ API documentation" reasonForClosure: - type: string - description: The enumeration value returned in this field indicates the outcome of the payment dispute for the seller. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value returned in this field indicates the\ + \ outcome of the payment dispute for the seller. This field is always\ + \ returned once the payment dispute is resolved. For implementation help,\ + \ refer to eBay\ + \ API documentation" recoupAmount: - description: This container shows the dollar amount being recouped from the seller. This container is empty if the seller wins the payment dispute or if the seller is fully protected by eBay's seller protection policy. - $ref: '#/components/schemas/SimpleAmount' + description: "This container shows the dollar amount being recouped from\ + \ the seller. This container is empty if the seller wins the payment dispute\ + \ or if the seller is fully protected by eBay's seller protection policy." + $ref: "#/components/schemas/SimpleAmount" totalFeeCredit: - description: This container shows the amount of money in selling fee credits due back to the seller after a payment dispute is settled. - $ref: '#/components/schemas/SimpleAmount' - description: This type is used by the resolution container that is returned for payment disputes that have been resolved. + description: "This container shows the amount of money in selling fee credits\ + \ due back to the seller after a payment dispute is settled." + $ref: "#/components/schemas/SimpleAmount" + description: "This type is used by the resolution container\ + \ that is returned for payment disputes that have been resolved." PaymentDisputeSummary: - type: object + type: "object" properties: amount: - description: This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace. This container is returned for all payment disputes returned in the response. - $ref: '#/components/schemas/SimpleAmount' + description: "This container shows the dollar value associated with the\ + \ payment dispute in the currency used by the seller's marketplace. This\ + \ container is returned for all payment disputes returned in the response." + $ref: "#/components/schemas/SimpleAmount" buyerUsername: - type: string - description: This is the buyer's eBay user ID. This field is returned for all payment disputes returned in the response. + type: "string" + description: "This is the buyer's eBay user ID. This field is returned for\ + \ all payment disputes returned in the response." closedDate: - type: string - description: 'The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the payment\ + \ dispute was closed, so this field is only returned for payment disputes\ + \ in the CLOSED state.

The timestamps returned here\ + \ use the ISO-8601 24-hour date and time format, and the time zone used\ + \ is Universal Coordinated Time (UTC), also known as Greenwich Mean Time\ + \ (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ.\ + \ An example would be 2019-08-04T19:09:02.768Z." openDate: - type: string - description: 'The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' + type: "string" + description: "The timestamp in this field shows the date/time when the payment\ + \ dispute was opened. This field is returned for payment disputes in all\ + \ states.

The timestamps returned here use the ISO-8601 24-hour\ + \ date and time format, and the time zone used is Universal Coordinated\ + \ Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601\ + \ format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example\ + \ would be 2019-08-04T19:09:02.768Z." orderId: - type: string - description: This is the unique identifier of the order involved in the payment dispute.

Note: eBay rolled out a new Order ID format in June 2019. The legacy APIs still support the old and new order ID format to identify orders, but only the new order ID format is supported in REST-based APIs. + type: "string" + description: "This is the unique identifier of the order involved in the\ + \ payment dispute." paymentDisputeId: - type: string - description: This is the unique identifier of the payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. This identifier is passed in at the end of the getPaymentDispute call URI to retrieve a specific payment dispute. The getPaymentDispute method returns more details about a payment dispute than the getPaymentDisputeSummaries method. + type: "string" + description: "This is the unique identifier of the payment dispute. This\ + \ identifier is automatically created by eBay once the payment dispute\ + \ comes into the eBay system. This identifier is passed in at the end\ + \ of the getPaymentDispute call URI to retrieve a specific\ + \ payment dispute. The getPaymentDispute method returns\ + \ more details about a payment dispute than the getPaymentDisputeSummaries\ + \ method." paymentDisputeStatus: - type: string - description: The enumeration value in this field gives the current status of the payment dispute. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value in this field gives the current status\ + \ of the payment dispute. For implementation help, refer to eBay\ + \ API documentation" reason: - type: string - description: The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation + type: "string" + description: "The enumeration value in this field gives the reason why the\ + \ buyer initiated the payment dispute. See DisputeReasonEnum\ + \ type for a description of the supported reasons that buyers can give\ + \ for initiating a payment dispute. For implementation help, refer to\ + \ eBay\ + \ API documentation" respondByDate: - type: string - description: 'The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that require action by the seller, that same seller must call getPaymentDispute to see the next action(s) that they can take against the payment dispute.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.' - description: This type is used by each payment dispute that is returned with the getPaymentDisputeSummaries method. + type: "string" + description: "The timestamp in this field shows the date/time when the seller\ + \ must response to a payment dispute, so this field is only returned for\ + \ payment disputes in the ACTION_NEEDED state. For payment\ + \ disputes that require action by the seller, that same seller must call\ + \ getPaymentDispute to see the next action(s) that they\ + \ can take against the payment dispute.

The timestamps returned\ + \ here use the ISO-8601 24-hour date and time format, and the time zone\ + \ used is Universal Coordinated Time (UTC), also known as Greenwich Mean\ + \ Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ.\ + \ An example would be 2019-08-04T19:09:02.768Z." + description: "This type is used by each payment dispute that is returned with\ + \ the getPaymentDisputeSummaries method." PaymentHold: - type: object + type: "object" properties: expectedReleaseDate: - type: string - description: The date and time that the payment being held is expected to be released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field will be returned if known by eBay.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the payment being held is expected\ + \ to be released to the seller. This timestamp is in ISO 8601 format,\ + \ which uses the 24-hour Universal Coordinated Time (UTC) clock. This\ + \ field will be returned if known by eBay.

Format:\ + \ [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example:\ + \ 2015-08-04T19:09:02.768Z" holdAmount: - description: 'The monetary amount of the payment being held. This field is always returned with the paymentHolds array. ' - $ref: '#/components/schemas/Amount' + description: "The monetary amount of the payment being held. This field\ + \ is always returned with the paymentHolds array. " + $ref: "#/components/schemas/Amount" holdReason: - type: string - description: The reason that the payment is being held. A seller's payment may be held for a number of reasons, including when the seller is new, the seller's level is below standard, or if a return case or 'Significantly not as described' case is pending against the seller. This field is always returned with the paymentHolds array. + type: "string" + description: "The reason that the payment is being held. A seller's payment\ + \ may be held for a number of reasons, including when the seller is new,\ + \ the seller's level is below standard, or if a return case or 'Significantly\ + \ not as described' case is pending against the seller. This field is\ + \ always returned with the paymentHolds array." holdState: - type: string - description: The current stage or condition of the hold. This field is always returned with the paymentHolds array.

Applicable values:
  • HELD
  • HELD_PENDING
  • NOT_HELD
  • RELEASE_CONFIRMED
  • RELEASE_FAILED
  • RELEASE_PENDING
  • RELEASED
+ type: "string" + description: "The current stage or condition of the hold. This field is\ + \ always returned with the paymentHolds array.
Applicable values:
  • HELD
  • HELD_PENDING
  • NOT_HELD
  • RELEASE_CONFIRMED
  • RELEASE_FAILED
  • RELEASE_PENDING
  • RELEASED
" releaseDate: - type: string - description: The date and time that the payment being held was actually released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the seller's payment is actually released into the seller's account.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the payment being held was actually\ + \ released to the seller. This timestamp is in ISO 8601 format, which\ + \ uses the 24-hour Universal Coordinated Time (UTC) clock. This field\ + \ is not returned until the seller's payment is actually released into\ + \ the seller's account.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" sellerActionsToRelease: - type: array - description: A list of one or more possible actions that the seller can take to expedite the release of the payment hold. + type: "array" + description: "A list of one or more possible actions that the seller can\ + \ take to expedite the release of the payment hold." items: - $ref: '#/components/schemas/SellerActionsToRelease' - description: This type contains information about a hold placed on a payment to a seller for an order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, the current state of the hold, and the actual release date if the payment has been released, and possible actions the seller can take to expedite the payout of funds into their account. + $ref: "#/components/schemas/SellerActionsToRelease" + description: "This type contains information about a hold placed on a payment\ + \ to a seller for an order, including the reason why the buyer's payment for\ + \ the order is being held, the expected release date of the funds into the\ + \ seller's account, the current state of the hold, and the actual release\ + \ date if the payment has been released, and possible actions the seller can\ + \ take to expedite the payout of funds into their account." PaymentSummary: - type: object + type: "object" properties: payments: - type: array - description: This array consists of payment information for the order, including payment status, payment method, payment amount, and payment date. This array is always returned, although some of the fields under this container will not be returned until payment has been made. + type: "array" + description: "This array consists of payment information for the order,\ + \ including payment status, payment method, payment amount, and payment\ + \ date. This array is always returned, although some of the fields under\ + \ this container will not be returned until payment has been made." items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" refunds: - type: array - description: This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund. + type: "array" + description: "This array is always returned, but is returned as an empty\ + \ array unless the seller has submitted a partial or full refund to the\ + \ buyer for the order. If a refund has occurred, the refund amount and\ + \ refund date will be shown for each refund." items: - $ref: '#/components/schemas/OrderRefund' + $ref: "#/components/schemas/OrderRefund" totalDueSeller: - description: 'This is the total price that the seller receives for the entire order after all costs (item cost, delivery cost, taxes) are added for all line items, minus any discounts and/or promotions for any of the line items. Note that this value is subject to change before payment is actually made by the buyer (if the paymentStatus value was PENDING or FAILED), or if a partial or full refund occurs with the order.

Note: For orders that are subject to ''eBay Collect and Remit'' tax, the ''Collect and Remit'' tax amount for the order will be included in this totalDueSeller value.

To determine if ''Collect and Remit'' taxes were added into this totalDueSeller value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the ''Collect and Remit'' tax amount that the buyer paid is included in this amount:
  • STATE_SALES_TAX: US
  • PROVINCE_SALES_TAX: Provincial Sales Tax in Canada
  • GST: Canada, Australia, and New Zealand
  • VAT: VAT collected for UK and EU countries
' - $ref: '#/components/schemas/Amount' - description: This type contains information about the various monetary exchanges that apply to the net balance due for the order. + description: "This is the total price that the seller receives for the entire\ + \ order after all costs (item cost, delivery cost, taxes) are added for\ + \ all line items, minus any discounts and/or promotions for any of the\ + \ line items. Note that this value is subject to change before payment\ + \ is actually made by the buyer (if the paymentStatus\ + \ value was PENDING or FAILED), or if a partial\ + \ or full refund occurs with the order.

Note: For orders that are subject to 'eBay Collect and\ + \ Remit' tax, the 'Collect and Remit' tax amount for the order will be\ + \ included in this totalDueSeller value.

To determine\ + \ if 'Collect and Remit' taxes were added into this totalDueSeller\ + \ value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes\ + \ and the lineItems.taxes containers in the response.\ + \ If both of these containers appear for one or more line items in the\ + \ response with the following taxType values, the 'Collect\ + \ and Remit' tax amount that the buyer paid is included in this amount:
  • STATE_SALES_TAX:\ + \ US
  • PROVINCE_SALES_TAX: Provincial Sales Tax in\ + \ Canada
  • GST: Canada, Australia, and New Zealand
  • VAT:\ + \ VAT collected for UK and EU countries
" + $ref: "#/components/schemas/Amount" + description: "This type contains information about the various monetary exchanges\ + \ that apply to the net balance due for the order." Phone: - type: object + type: "object" properties: countryCode: - type: string - description: The seller's country calling code. This field is needed if the buyer is located in a different country than the seller. It is also OK to provide if the buyer and seller are both located in the same country. For a full list of calling codes for all countries, see the countrycode.org site. + type: "string" + description: "The seller's country calling code. This field is needed if\ + \ the buyer is located in a different country than the seller. It is also\ + \ OK to provide if the buyer and seller are both located in the same country.\ + \ For a full list of calling codes for all countries, see the countrycode.org site." number: - type: string - description: 'The seller''s primary phone number associated with the return address. When this number is provided in a contestPaymentDispute or contestPaymentDispute method, it is provided as one continuous numeric string, including the area code. So, if the phone number''s area code was ''408'', a number in this field may look something like this:

"number" : "4088084356"

If the buyer is located in a different country than the seller, the seller''s country calling code will need to be specified in the countryCode field.' - description: This type is used by the returnAddresscontestPaymentDispute\ + \ or contestPaymentDispute method, it is provided as\ + \ one continuous numeric string, including the area code. So, if the phone\ + \ number's area code was '408', a number in this field may look something\ + \ like this:

\"number\" : \"4088084356\"

If\ + \ the buyer is located in a different country than the seller, the seller's\ + \ country calling code will need to be specified in the countryCode\ + \ field." + description: "This type is used by the returnAddress
This field is always returned with the pickupStep container. - description: This type is used to indicate the merchant's store where the buyer will pickup their In-Store Pickup order. The pickupStep container is only returned for In-Store Pickup orders. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces. + type: "string" + description: "A merchant-defined unique identifier of the merchant's store\ + \ where the buyer will pick up their In-Store Pickup order.

\ + \ This field is always returned with the pickupStep container." + description: "This type is used to indicate the merchant's store where the buyer\ + \ will pickup their In-Store Pickup order. The pickupStep container\ + \ is only returned for In-Store Pickup orders. The In-Store Pickup feature\ + \ is supported in the US, Canada, UK, Germany, and Australia marketplaces." PostSaleAuthenticationProgram: - type: object + type: "object" properties: outcomeReason: - type: string - description: This field indicates the result of the authenticity verification inspection on an order line item. This field is not returned when the status value of the order line item is PENDING or PASSED. The possible values returned here are NOT_AUTHENTIC, NOT_AS_DESCRIBED, CUSTOMIZED, MISCATEGORIZED, or NOT_AUTHENTIC_NO_RETURN. For implementation help, refer to eBay API documentation + type: "string" + description: "This field indicates the result of the authenticity verification\ + \ inspection on an order line item. This field is not returned when the\ + \ status value of the order line item is PENDING or PASSED.\ + \ The possible values returned here are NOT_AUTHENTIC, NOT_AS_DESCRIBED,\ + \ CUSTOMIZED, MISCATEGORIZED, or NOT_AUTHENTIC_NO_RETURN.\ + \ For implementation help, refer to eBay\ + \ API documentation" status: - type: string - description: The value in this field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are PENDING, PASSED, FAILED, or PASSED_WITH_EXCEPTION. For implementation help, refer to eBay API documentation - description: This type is used to provide the status and outcome of an order line item going through the Authenticity Guarantee verification process. + type: "string" + description: "The value in this field indicates whether the order line item\ + \ has passed or failed the authenticity verification inspection, or if\ + \ the inspection and/or results are still pending. The possible values\ + \ returned here are PENDING, PASSED, FAILED,\ + \ or PASSED_WITH_EXCEPTION. For implementation help, refer\ + \ to eBay\ + \ API documentation" + description: "This type is used to provide the status and outcome of an order\ + \ line item going through the Authenticity Guarantee verification process." PricingSummary: - type: object + type: "object" properties: adjustment: - description: This container shows the total amount of any adjustments that were applied to the cost of the item(s) in the order. This amount does not include shipping, discounts, fixed fees, or taxes.

This container is only returned if price adjustments were made to the order after the initial transaction/commitment to buy occurred. - $ref: '#/components/schemas/Amount' + description: "This container shows the total amount of any adjustments that\ + \ were applied to the cost of the item(s) in the order. This amount does\ + \ not include shipping, discounts, fixed fees, or taxes.

This\ + \ container is only returned if price adjustments were made to the order\ + \ after the initial transaction/commitment to buy occurred." + $ref: "#/components/schemas/Amount" deliveryCost: - description: This container shows the total cost of delivering the order to the buyer, before any shipping/delivery discount is applied. - $ref: '#/components/schemas/Amount' + description: "This container shows the total cost of delivering the order\ + \ to the buyer, before any shipping/delivery discount is applied." + $ref: "#/components/schemas/Amount" deliveryDiscount: - description: This container shows the total amount of delivery discounts (including shipping discounts) that apply to the order. This should be a negative real number.

This container is only returned if delivery discounts are being applied to the order. - $ref: '#/components/schemas/Amount' + description: "This container shows the total amount of delivery discounts\ + \ (including shipping discounts) that apply to the order. This should\ + \ be a negative real number.

This container is only returned\ + \ if delivery discounts are being applied to the order." + $ref: "#/components/schemas/Amount" fee: - description: This container shows the total amount of any special fees applied to the order, such as a tire recycling fee or an electronic waste fee.

This container is returned if special fees are being applied to the order and if the fieldGroups is set to TAX_BREAKDOWN. - $ref: '#/components/schemas/Amount' + description: "This container shows the total amount of any special fees\ + \ applied to the order, such as a tire recycling fee or an electronic\ + \ waste fee.

This container is returned if special fees are\ + \ being applied to the order and if the fieldGroups is set to TAX_BREAKDOWN." + $ref: "#/components/schemas/Amount" priceDiscountSubtotal: - description: This container shows the total amount of all item price discounts (including promotions) that apply to the order and reduce its cost to the buyer. This should be a negative real number.

This container is only returned if special discounts are being applied to the order. - $ref: '#/components/schemas/Amount' + description: "This container shows the total amount of all item price discounts\ + \ (including promotions) that apply to the order and reduce its cost to\ + \ the buyer. This should be a negative real number.

This container\ + \ is only returned if special discounts are being applied to the order." + $ref: "#/components/schemas/Amount" priceSubtotal: - description: This container shows the cumulative costs of of all units of all line items in the order, before any discount is applied. - $ref: '#/components/schemas/Amount' + description: "This container shows the cumulative costs of of all units\ + \ of all line items in the order, before any discount is applied." + $ref: "#/components/schemas/Amount" tax: - description: This container shows the total amount of tax for the order. To calculate the tax percentage rate, divide this value by the value of the total field.

This container is only returned if any type of tax (sales tax, tax on shipping, tax on handling, import tax, etc.) is applied to the order. - $ref: '#/components/schemas/Amount' + description: "This container shows the total amount of tax for the order.\ + \ To calculate the tax percentage rate, divide this value by the value\ + \ of the total field.

This container is only returned\ + \ if any type of tax (sales tax, tax on shipping, tax on handling, import\ + \ tax, etc.) is applied to the order." + $ref: "#/components/schemas/Amount" total: - description: 'The total cost of the order after adding all line item costs, delivery costs, sales tax, and special fees, and then subtracting all special discounts and price adjustments.

Note: For orders that are subject to ''eBay Collect and Remit'' tax, the ''Collect and Remit'' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN. If the fieldGroups query parameter is not set to TAX_BREAKDOWN, ''Collect and Remit'' will not be added into this total value.

To determine if ''Collect and Remit'' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the ''Collect and Remit'' tax amount that the buyer paid is included in this amount:
  • STATE_SALES_TAX: US state-mandated sales tax
  • PROVINCE_SALES_TAX: Provincial Sales Tax in Canada
  • GST: ''Good and Services'' tax in Canada, Australia, and New Zealand
  • VAT: VAT collected for UK and EU countries
' - $ref: '#/components/schemas/Amount' - description: This type contains a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts. + description: "The total cost of the order after adding all line item costs,\ + \ delivery costs, sales tax, and special fees, and then subtracting all\ + \ special discounts and price adjustments.

Note: For orders that are subject to 'eBay Collect and\ + \ Remit' tax, the 'Collect and Remit' tax amount for the order will be\ + \ included in this total value only when the fieldGroups\ + \ query parameter is set to TAX_BREAKDOWN. If the fieldGroups\ + \ query parameter is not set to TAX_BREAKDOWN, 'Collect and\ + \ Remit' will not be added into this total value.

To\ + \ determine if 'Collect and Remit' taxes were added into this total\ + \ value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes\ + \ and the lineItems.taxes containers in the response.\ + \ If both of these containers appear for one or more line items in the\ + \ response with the following taxType values, the 'Collect\ + \ and Remit' tax amount that the buyer paid is included in this amount:
  • STATE_SALES_TAX:\ + \ US state-mandated sales tax
  • PROVINCE_SALES_TAX:\ + \ Provincial Sales Tax in Canada
  • GST: 'Good and Services'\ + \ tax in Canada, Australia, and New Zealand
  • VAT:\ + \ VAT collected for UK and EU countries
" + $ref: "#/components/schemas/Amount" + description: "This type contains a summary of cumulative costs and charges for\ + \ all line items of an order, including item price, price adjustments, sales\ + \ taxes, delivery costs, and order discounts." Program: - type: object + type: "object" properties: authenticityVerification: - description: This field is returned when the third-party authenticator performs the authentication verification inspection on the order line item. Different values will be returned based on whether the item passed or failed the authentication verification inspection. - $ref: '#/components/schemas/PostSaleAuthenticationProgram' + description: "This field is returned when the third-party authenticator\ + \ performs the authentication verification inspection on the order line\ + \ item. Different values will be returned based on whether the item passed\ + \ or failed the authentication verification inspection." + $ref: "#/components/schemas/PostSaleAuthenticationProgram" + ebayShipping: + description: "This container is returned only if the order is an eBay shipping\ + \ order. It consists of a field that indicates the provider of a shipping\ + \ label for this order." + $ref: "#/components/schemas/EbayShipping" ebayVault: - description: This field provides information about the eBay vault program that has been selected for an order. This is returned only for those items that are eligible for the eBay Vault Program. - $ref: '#/components/schemas/EbayVaultProgram' + description: "This field provides information about the eBay vault program\ + \ that has been selected for an order. This is returned only for those\ + \ items that are eligible for the eBay Vault Program." + $ref: "#/components/schemas/EbayVaultProgram" + ebayInternationalShipping: + description: "This container is returned if the order is being fulfilled\ + \ through eBay International Shipping." + $ref: "#/components/schemas/EbayInternationalShipping" fulfillmentProgram: - description: This field provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner. - $ref: '#/components/schemas/EbayFulfillmentProgram' - description: This type is returned for order line items eligible for the Authenticity Guarantee service and/or for order line items fulfilled by the eBay Fulfillment program. + description: "This field provides details about an order line item being\ + \ handled by eBay fulfillment. It is only returned for paid orders being\ + \ fulfilled by eBay or an eBay fulfillment partner." + $ref: "#/components/schemas/EbayFulfillmentProgram" + description: "This type is returned for order line items eligible for the Authenticity\ + \ Guarantee service and/or for order line items fulfilled by the eBay Fulfillment\ + \ program or eBay shipping." Refund: - type: object + type: "object" properties: refundId: - type: string - description: The unique identifier of the order refund. This value is returned unless the refund operation fails (refundStatus value shows FAILED). This identifier can be used to track the status of the refund through a getOrder or getOrders call. For order-level refunds, check the paymentSummary.refunds.refundId field in the getOrder/getOrders response, and for line item level refunds, check the lineItems.refunds.refundId field(s) in the getOrder/getOrders response. + type: "string" + description: "The unique identifier of the order refund. This value is returned\ + \ unless the refund operation fails (refundStatus value shows FAILED).\ + \ This identifier can be used to track the status of the refund through\ + \ a getOrder or getOrders call. For order-level refunds,\ + \ check the paymentSummary.refunds.refundId field in the getOrder/getOrders\ + \ response, and for line item level refunds, check the lineItems.refunds.refundId\ + \ field(s) in the getOrder/getOrders response." refundStatus: - type: string - description: The value returned in this field indicates the success or failure of the refund operation. A successful issueRefund operation should result in a value of PENDING. A failed issueRefund operation should result in a value of FAILED, and an HTTP status code and/or and API error code may also get returned to possibly indicate the issue.

The refunds issued through this method are processed asynchronously, so the refund will not show as 'Refunded' right away. A seller will have to make a subsequent getOrder call to check the status of the refund. The status of an order refund can be found in the paymentSummary.refunds.refundStatus field of the getOrder response. For implementation help, refer to eBay API documentation - description: This is the base type of the issueRefund response payload. As long as the issueRefund method does not trigger an error, a response payload will be returned. + type: "string" + description: "The value returned in this field indicates the success or\ + \ failure of the refund operation. A successful issueRefund operation\ + \ should result in a value of PENDING. A failed issueRefund\ + \ operation should result in a value of FAILED, and an HTTP\ + \ status code and/or and API error code may also get returned to possibly\ + \ indicate the issue.

The refunds issued through this method\ + \ are processed asynchronously, so the refund will not show as 'Refunded'\ + \ right away. A seller will have to make a subsequent getOrder call to check the status of the refund.\ + \ The status of an order refund can be found in the paymentSummary.refunds.refundStatus field of the\ + \ getOrder response. For implementation help, refer\ + \ to eBay\ + \ API documentation" + description: "This is the base type of the issueRefund response payload.\ + \ As long as the issueRefund method does not trigger an error, a response\ + \ payload will be returned." RefundItem: - type: object + type: "object" properties: refundAmount: - description: This container is used to specify the amount of the refund for the corresponding order line item. If a seller wants to issue a refund for an entire order, the seller would use the orderLevelRefundAmount container instead. - $ref: '#/components/schemas/SimpleAmount' + description: "This container is used to specify the amount of the refund\ + \ for the corresponding order line item. If a seller wants to issue a\ + \ refund for an entire order, the seller would use the orderLevelRefundAmount\ + \ container instead." + $ref: "#/components/schemas/SimpleAmount" lineItemId: - type: string - description: The unique identifier of an order line item. This identifier is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder. Either this field or the legacyReference container is needed to identify an individual order line item that will receive a refund.

Note: The lineItemId field is used to identify an order line item in REST API format, and the legacyReference container is used to identify an order line item in Trading/legacy API format. Both legacy and REST API identifiers are returned in getOrder (Fulfillment API) and GetOrders (Trading API). + type: "string" + description: "The unique identifier of an order line item. This identifier\ + \ is created once a buyer purchases a 'Buy It Now' item or if an auction\ + \ listing ends with a winning bidder. Either this field or the legacyReference\ + \ container is needed to identify an individual order line item that will\ + \ receive a refund.

Note:\ + \ The lineItemId field is used to identify an order line item in\ + \ REST API format, and the legacyReference container is used to\ + \ identify an order line item in Trading/legacy API format. Both legacy\ + \ and REST API identifiers are returned in getOrder (Fulfillment\ + \ API) and GetOrders (Trading API)." legacyReference: - description: This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID/transaction ID pair to identify the order line item. Either this container or the lineItemId field is needed to identify an individual order line item that will receive a refund.

Note: The lineItemId field is used to identify an order line item in REST API format, and the legacyReference container is used to identify an order line item in Trading/legacy API format. Both legacy and REST API identifiers are returned in getOrder (Fulfillment API) and GetOrders (Trading API). - $ref: '#/components/schemas/LegacyReference' - description: This type is used if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount container to specify the amount of the refund for the entire order. + description: "This container is needed if the seller is issuing a refund\ + \ for an individual order line item, and wishes to use an item ID/transaction\ + \ ID pair to identify the order line item. Either this container or the\ + \ lineItemId field is needed to identify an individual order line\ + \ item that will receive a refund.

Note: The lineItemId field is used to identify\ + \ an order line item in REST API format, and the legacyReference\ + \ container is used to identify an order line item in Trading/legacy API\ + \ format. Both legacy and REST API identifiers are returned in getOrder\ + \ (Fulfillment API) and GetOrders (Trading API)." + $ref: "#/components/schemas/LegacyReference" + description: "This type is used if the seller is issuing a refund for one or\ + \ more individual order line items in a multiple line item order. Otherwise,\ + \ the seller just uses the orderLevelRefundAmount container to specify\ + \ the amount of the refund for the entire order." ReturnAddress: - type: object + type: "object" properties: addressLine1: - type: string - description: The first line of the street address. + type: "string" + description: "The first line of the street address." addressLine2: - type: string - description: The second line of the street address. This line is not always necessarily, but is often used for apartment number or suite number, or other relevant information that can not fit on the first line. + type: "string" + description: "The second line of the street address. This line is not always\ + \ necessarily, but is often used for apartment number or suite number,\ + \ or other relevant information that can not fit on the first line." city: - type: string - description: The city of the return address. + type: "string" + description: "The city of the return address." country: - type: string - description: The country's two-digt, ISO 3166-1 country code. See the enumeration type for a country's value. For implementation help, refer to eBay API documentation + type: "string" + description: "The country's two-digt, ISO 3166-1 country code. See the enumeration\ + \ type for a country's value. For implementation help, refer to eBay\ + \ API documentation" county: - type: string - description: The county of the return address. Counties are not applicable to all countries. + type: "string" + description: "The county of the return address. Counties are not applicable\ + \ to all countries." fullName: - type: string - description: The full name of return address owner. + type: "string" + description: "The full name of return address owner." postalCode: - type: string - description: The postal code of the return address. + type: "string" + description: "The postal code of the return address." primaryPhone: - description: This container shows the seller's primary phone number associated with the return address. - $ref: '#/components/schemas/Phone' + description: "This container shows the seller's primary phone number associated\ + \ with the return address." + $ref: "#/components/schemas/Phone" stateOrProvince: - type: string - description: The state or province of the return address. - description: This type is used by the payment dispute methods, and is relevant if the buyer will be returning the item to the seller. + type: "string" + description: "The state or province of the return address." + description: "This type is used by the payment dispute methods, and is relevant\ + \ if the buyer will be returning the item to the seller." SellerActionsToRelease: - type: object + type: "object" properties: sellerActionToRelease: - type: string - description: A possible action that the seller can take to expedite the release of a payment hold. A sellerActionToRelease field is returned for each possible action that a seller may take. Possible actions may include providing shipping/tracking information, issuing a refund, providing refund information, contacting customer support, etc. - description: This type is used to state possible action(s) that a seller can take to release a payment hold placed against an order. + type: "string" + description: "A possible action that the seller can take to expedite the\ + \ release of a payment hold. A sellerActionToRelease\ + \ field is returned for each possible action that a seller may take. Possible\ + \ actions may include providing shipping/tracking information, issuing\ + \ a refund, providing refund information, contacting customer support,\ + \ etc." + description: "This type is used to state possible action(s) that a seller can\ + \ take to release a payment hold placed against an order." ShippingFulfillment: - type: object + type: "object" properties: fulfillmentId: - type: string - description: The unique identifier of the fulfillment; for example, 9405509699937003457459. This eBay-generated value is created with a successful createShippingFulfillment call. + type: "string" + description: "The unique identifier of the fulfillment; for example, 9405509699937003457459.\ + \ This eBay-generated value is created with a successful createShippingFulfillment\ + \ call." lineItems: - type: array - description: This array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies. + type: "array" + description: "This array contains a list of one or more line items (and\ + \ purchased quantity) to which the fulfillment applies." items: - $ref: '#/components/schemas/LineItemReference' + $ref: "#/components/schemas/LineItemReference" shipmentTrackingNumber: - type: string - description: The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available. + type: "string" + description: "The tracking number provided by the shipping carrier for the\ + \ package shipped in this fulfillment. This field is returned if available." shippedDate: - type: string - description: The date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field should only be returned if the package has been shipped.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z + type: "string" + description: "The date and time that the fulfillment package was shipped.\ + \ This timestamp is in ISO 8601 format, which uses the 24-hour Universal\ + \ Coordinated Time (UTC) clock. This field should only be returned if\ + \ the package has been shipped.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ + \
Example: 2015-08-04T19:09:02.768Z" shippingCarrierCode: - type: string - description: The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available.

Note: The Trading API's ShippingCarrierCodeType enumeration type contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See ShippingCarrierCodeType. - description: This type contains the complete details of an existing fulfillment for an order. + type: "string" + description: "The eBay code identifying the shipping carrier for this fulfillment.\ + \ This field is returned if available.

Note: The Trading API's ShippingCarrierCodeType\ + \ enumeration type contains the most current list of eBay shipping carrier\ + \ codes and the countries served by each carrier. See ShippingCarrierCodeType." + description: "This type contains the complete details of an existing fulfillment\ + \ for an order." ShippingFulfillmentDetails: - type: object + type: "object" properties: lineItems: - type: array - description: This array contains a list of or more line items and the quantity that will be shipped in the same package. + type: "array" + description: "This array contains a list of or more line items and the quantity\ + \ that will be shipped in the same package." items: - $ref: '#/components/schemas/LineItemReference' + $ref: "#/components/schemas/LineItemReference" shippedDate: - type: string - description: This is the actual date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. The seller should use the actual date/time that the package was shipped, but if this field is omitted, it will default to the current date/time.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z

Default: The current date and time. + type: "string" + description: "This is the actual date and time that the fulfillment package\ + \ was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour\ + \ Universal Coordinated Time (UTC) clock. The seller should use the actual\ + \ date/time that the package was shipped, but if this field is omitted,\ + \ it will default to the current date/time.

Format:\ + \ [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example:\ + \ 2015-08-04T19:09:02.768Z

Default: The\ + \ current date and time." shippingCarrierCode: - type: string - description: The unique identifier of the shipping carrier being used to ship the line item(s). Technically, the shippingCarrierCode and trackingNumber fields are optional, but generally these fields will be provided if the shipping carrier and tracking number are known.

Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingCarrierDetails. Each valid shipping carrier enumeration value is returned in a ShippingCarrierDetails.ShippingCarrier field in the response payload. + type: "string" + description: "The unique identifier of the shipping carrier being used to\ + \ ship the line item(s). Technically, the shippingCarrierCode\ + \ and trackingNumber fields are optional, but generally\ + \ these fields will be provided if the shipping carrier and tracking number\ + \ are known.

Note:\ + \ Use the Trading API's GeteBayDetails call to retrieve the latest\ + \ shipping carrier enumeration values. When making the GeteBayDetails call, include the DetailName\ + \ field in the request payload and set its value to ShippingCarrierDetails.\ + \ Each valid shipping carrier enumeration value is returned in a ShippingCarrierDetails.ShippingCarrier\ + \ field in the response payload." trackingNumber: - type: string - description: The tracking number provided by the shipping carrier for this fulfillment. The seller should be careful that this tracking number is accurate since the buyer will use this tracking number to track shipment, and eBay has no way to verify the accuracy of this number.

This field and the shippingCarrierCode field are mutually dependent. If you include one, you must also include the other.

Note: If you include trackingNumber (and shippingCarrierCode) in the request, the resulting fulfillment's ID (returned in the HTTP location code) is the tracking number. If you do not include shipment tracking information, the resulting fulfillment ID will default to an arbitrary number such as 999. - description: This type contains the details for creating a fulfillment for an order. + type: "string" + description: "The tracking number provided by the shipping carrier for this\ + \ fulfillment. The seller should be careful that this tracking number\ + \ is accurate since the buyer will use this tracking number to track shipment,\ + \ and eBay has no way to verify the accuracy of this number.
This field and the shippingCarrierCode field are mutually dependent.\ + \ If you include one, you must also include the other.

Note: If you include trackingNumber\ + \ (and shippingCarrierCode) in the request, the resulting fulfillment's\ + \ ID (returned in the HTTP location code) is the tracking number. If you\ + \ do not include shipment tracking information, the resulting fulfillment\ + \ ID will default to an arbitrary number such as 999.Note: Only alphanumeric\ + \ characters are supported for shipment tracking numbers. Spaces, hyphens,\ + \ and all other special characters are not supported. Do not include a\ + \ space in the tracking number even if a space appears in the tracking\ + \ number on the shipping label." + description: "This type contains the details for creating a fulfillment for\ + \ an order." ShippingFulfillmentPagedCollection: - type: object + type: "object" properties: fulfillments: - type: array - description: This array contains one or more fulfillments required for the order that was specified in method endpoint. + type: "array" + description: "This array contains one or more fulfillments required for\ + \ the order that was specified in method endpoint." items: - $ref: '#/components/schemas/ShippingFulfillment' + $ref: "#/components/schemas/ShippingFulfillment" total: - type: integer - description: The total number of fulfillments in the specified order.

Note: If no fulfillments are found for the order, this field is returned with a value of 0. - format: int32 + type: "integer" + description: "The total number of fulfillments in the specified order.
Note: If no fulfillments\ + \ are found for the order, this field is returned with a value of 0." + format: "int32" warnings: - type: array - description: This array is only returned if one or more errors or warnings occur with the call request. + type: "array" + description: "This array is only returned if one or more errors or warnings\ + \ occur with the call request." items: - $ref: '#/components/schemas/Error' - description: This type contains the specifications for the entire collection of shipping fulfillments that are associated with the order specified by a getShippingFulfillments call. The fulfillments container returns an array of all the fulfillments in the collection. + $ref: "#/components/schemas/Error" + description: "This type contains the specifications for the entire collection\ + \ of shipping fulfillments that are associated with the order specified by\ + \ a getShippingFulfillments call. The fulfillments container\ + \ returns an array of all the fulfillments in the collection." ShippingStep: - type: object + type: "object" properties: shippingCarrierCode: - type: string - description: The unique identifier of the shipping carrier being used to ship the line item.

Note: The Trading API's GeteBayDetails call can be used to retrieve the latest shipping carrier and shipping service option enumeration values. + type: "string" + description: "The unique identifier of the shipping carrier being used to\ + \ ship the line item.

Note:\ + \ The Trading API's GeteBayDetails call can be used to retrieve\ + \ the latest shipping carrier and shipping service option enumeration\ + \ values." shippingServiceCode: - type: string - description: The unique identifier of the shipping service option being used to ship the line item.

Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier and shipping service option enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingServiceDetails. Each valid shipping service option (returned in ShippingServiceDetails.ShippingService field) and corresponding shipping carrier (returned in ShippingServiceDetails.ShippingCarrier field) is returned in response payload. + type: "string" + description: "The unique identifier of the shipping service option being\ + \ used to ship the line item.

Note:\ + \ Use the Trading API's GeteBayDetails call to retrieve the latest\ + \ shipping carrier and shipping service option enumeration values. When\ + \ making the GeteBayDetails call, include the DetailName\ + \ field in the request payload and set its value to ShippingServiceDetails.\ + \ Each valid shipping service option (returned in ShippingServiceDetails.ShippingService\ + \ field) and corresponding shipping carrier (returned in ShippingServiceDetails.ShippingCarrier\ + \ field) is returned in response payload." shipTo: - description: This container consists of shipping and contact information about the individual or organization to whom the fulfillment package will be shipped.
Note: When FulfillmentInstructionsType is FULFILLED_BY_EBAY, there will be no shipTo address displayed.
Note: For Digitally Delivered Goods (DDG), this address is the same as the Buyer's Registration Address.
Note: For a Global Shipping Program shipment, this is the address of the international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address. For more information, see Addressing a Global Shipping Program Shipment. - $ref: '#/components/schemas/ExtendedContact' + description: "This container consists of shipping and contact information\ + \ about the individual or organization to whom the fulfillment package\ + \ will be shipped.
Note:\ + \ When FulfillmentInstructionsType is FULFILLED_BY_EBAY,\ + \ there will be no shipTo address displayed.
Note: For Digitally Delivered Goods (DDG),\ + \ this address is the same as the Buyer's Registration Address.
Note: For a Global Shipping Program\ + \ shipment, this is the address of the international shipping provider's\ + \ domestic warehouse. The international shipping provider is responsible\ + \ for delivery to the final destination address. For more information,\ + \ see Addressing a Global Shipping Program Shipment." + $ref: "#/components/schemas/ExtendedContact" shipToReferenceId: - type: string - description: 'This is the unique identifer of the Global Shipping Program (GSP) shipment. This field is only returned if the line item is being shipped via GSP (the value of the fulfillmentStartInstructions.ebaySupportedFulfillment field will be true. The international shipping provider uses the shipToReferenceId value as the primary reference number to retrieve the relevant details about the buyer, the order, and the fulfillment, so the shipment can be completed.

Sellers must include this value on the shipping label immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456"

Note: This value is the same as the ShipToAddress.ReferenceID value returned by the Trading API''s GetOrders call.' - description: This type contains shipping information for a fulfillment, including the shipping carrier, the shipping service option, the shipment destination, and the Global Shipping Program reference ID. + type: "string" + description: "This is the unique identifer of the Global Shipping Program\ + \ (GSP) shipment. This field is only returned if the line item is being\ + \ shipped via GSP (the value of the fulfillmentStartInstructions.ebaySupportedFulfillment\ + \ field will be true. The international shipping provider\ + \ uses the shipToReferenceId value as the primary reference number\ + \ to retrieve the relevant details about the buyer, the order, and the\ + \ fulfillment, so the shipment can be completed.

Sellers must\ + \ include this value on the shipping label immediately above the street\ + \ address of the international shipping provider.

Example:\ + \ \"Reference #1234567890123456\"

Note: This value is the same as the ShipToAddress.ReferenceID\ + \ value returned by the Trading API's GetOrders call." + description: "This type contains shipping information for a fulfillment, including\ + \ the shipping carrier, the shipping service option, the shipment destination,\ + \ and the Global Shipping Program reference ID." SimpleAmount: - type: object + type: "object" properties: currency: - type: string - description: A three-letter ISO 4217 code (such as USD for US site) that indicates the currency of the amount in the value field. Both the value and currency fields are always returned with the amount container. For implementation help, refer to eBay API documentation + type: "string" + description: "A three-letter ISO 4217 code (such as USD for\ + \ US site) that indicates the currency of the amount in the value\ + \ field. Both the value and currency\ + \ fields are always returned with the amount container.\ + \ For implementation help, refer to eBay\ + \ API documentation" value: - type: string - description: The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container. - description: This type defines the monetary value of the payment dispute, and the currency used. + type: "string" + description: "The monetary amount of the payment dispute. Both the value\ + \ and currency fields are always returned with the amount\ + \ container." + description: "This type defines the monetary value of the payment dispute, and\ + \ the currency used." Tax: - type: object + type: "object" properties: amount: - description: 'The monetary amount of the tax. The taxes array is always returned for each line item in the order, but this amount will only be returned when the line item is subject to any type of sales tax. ' - $ref: '#/components/schemas/Amount' + description: "The monetary amount of the tax. The taxes\ + \ array is always returned for each line item in the order, but this amount\ + \ will only be returned when the line item is subject to any type of sales\ + \ tax. " + $ref: "#/components/schemas/Amount" taxType: - type: string - description: Tax type. This field is only available when fieldGroups is set to TAX_BREAKDOWN. If the order has fees, a breakdown of the fees is also provided. For implementation help, refer to eBay API documentation - description: This type contains information about any sales tax applied to a line item. + type: "string" + description: "Tax type. This field is only available when fieldGroups\ + \ is set to TAX_BREAKDOWN. If the order has fees, a breakdown\ + \ of the fees is also provided. For implementation help, refer to eBay\ + \ API documentation" + description: "This type contains information about any sales tax applied to\ + \ a line item." TaxAddress: - type: object + type: "object" properties: city: - type: string - description: The city name that can be used by sellers for tax purpose. + type: "string" + description: "The city name that can be used by sellers for tax purpose." countryCode: - type: string - description: The country code that can be used by sellers for tax purpose, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany. For implementation help, refer to eBay API documentation + type: "string" + description: "The country code that can be used by sellers for tax purpose,\ + \ represented as a two-letter ISO 3166-1 alpha-2 country code. For example,\ + \ US represents the United States, and DE\ + \ represents Germany. For implementation help, refer to eBay\ + \ API documentation" postalCode: - type: string - description: The postal code that can be used by sellers for tax purpose. Usually referred to as Zip codes in the US. + type: "string" + description: "The postal code that can be used by sellers for tax purpose.\ + \ Usually referred to as Zip codes in the US." stateOrProvince: - type: string - description: The state name that can be used by sellers for tax purpose. - description: This container consists of address information that can be used by sellers for tax purpose. + type: "string" + description: "The state name that can be used by sellers for tax purpose." + description: "This container consists of address information that can be used\ + \ by sellers for tax purpose." TaxIdentifier: - type: object + type: "object" properties: taxpayerId: - type: string - description: This value is the unique tax ID associated with the buyer. The type of tax identification is shown in the taxIdentifierType field. + type: "string" + description: "This value is the unique tax ID associated with the buyer.\ + \ The type of tax identification is shown in the taxIdentifierType\ + \ field." taxIdentifierType: - type: string - description: This enumeration value indicates the type of tax identification being used for the buyer. The different tax types are defined in the TaxIdentifierTypeEnum type. For implementation help, refer to eBay API documentation + type: "string" + description: "This enumeration value indicates the type of tax identification\ + \ being used for the buyer. The different tax types are defined in the\ + \ TaxIdentifierTypeEnum type. For implementation help,\ + \ refer to eBay\ + \ API documentation" issuingCountry: - type: string - description: This two-letter code indicates the country that issued the buyer's tax ID. The country that the two-letter code represents can be found in the CountryCodeEnum type, or in the ISO 3166 standard. For implementation help, refer to eBay API documentation - description: This type is used by the taxIdentifier container that is returned in getOrder. The taxIdentifier container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces.

Note: Currently, the taxIdentifier container is only returned in getOrder and not in getOrders. So, if a seller wanted to view a buyer's tax information for a particular order returned in getOrders, that seller would need to use the orderId value for that particular order, and then run a getOrder call against that order ID. + type: "string" + description: "This two-letter code indicates the country that issued the\ + \ buyer's tax ID. The country that the two-letter code represents can\ + \ be found in the CountryCodeEnum type, or in the ISO 3166\ + \ standard. For implementation help, refer to eBay\ + \ API documentation" + description: "This type is used by the taxIdentifier container\ + \ that is returned in getOrder. The taxIdentifier\ + \ container consists of taxpayer identification information for buyers from\ + \ Italy, Spain, or Guatemala. It is currently only returned for orders occurring\ + \ on the eBay Italy or eBay Spain marketplaces.

Note: Currently, the taxIdentifier\ + \ container is only returned in getOrder and not in getOrders.\ + \ So, if a seller wanted to view a buyer's tax information for a particular\ + \ order returned in getOrders, that seller would need to\ + \ use the orderId value for that particular order, and then\ + \ run a getOrder call against that order ID. " TrackingInfo: - type: object + type: "object" properties: shipmentTrackingNumber: - type: string - description: This string value represents the shipment tracking number of the package. + type: "string" + description: "This string value represents the shipment tracking number\ + \ of the package." shippingCarrierCode: - type: string - description: This string value represents the shipping carrier used to ship the package. - description: This type is used by the shipmentTracking array returned under the evidence container if the seller has provided shipment tracking information as evidence to support PROOF_OF_DELIVERY for an INR-related payment dispute. + type: "string" + description: "This string value represents the shipping carrier used to\ + \ ship the package." + description: "This type is used by the shipmentTracking array\ + \ returned under the evidence container if the seller has\ + \ provided shipment tracking information as evidence to support PROOF_OF_DELIVERY\ + \ for an INR-related payment dispute." UpdateEvidencePaymentDisputeRequest: - type: object + type: "object" properties: evidenceId: - type: string - description: The unique identifier of the evidence set that is being updated with new evidence files. + type: "string" + description: "The unique identifier of the evidence set that is being updated\ + \ with new evidence files." evidenceType: - type: string - description: This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field. See the EvidenceTypeEnum type for the supported evidence types. For implementation help, refer to eBay API documentation + type: "string" + description: "This field is used to indicate the type of evidence being\ + \ provided through one or more evidence files. All evidence files (if\ + \ more than one) should be associated with the evidence type passed in\ + \ this field. See the EvidenceTypeEnum type for the supported\ + \ evidence types. For implementation help, refer to eBay\ + \ API documentation" files: - type: array - description: This array is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the files array.

The unique identifier of an evidence file is returned in the response payload of the uploadEvidence method. + type: "array" + description: "This array is used to specify one or more evidence files that\ + \ will be added to the evidence set associated with a payment dispute.\ + \ At least one evidence file must be specified in the files\ + \ array.

The unique identifier of an evidence file is returned\ + \ in the response payload of the uploadEvidence method." items: - $ref: '#/components/schemas/FileEvidence' + $ref: "#/components/schemas/FileEvidence" lineItems: - type: array - description: This required array identifies the order line item(s) for which the evidence file(s) will be applicable. Both the itemId and lineItemID fields are needed to identify each order line item, and both of these values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response. + type: "array" + description: "This required array identifies the order line item(s) for\ + \ which the evidence file(s) will be applicable. Both the itemId\ + \ and lineItemID fields are needed to identify each order\ + \ line item, and both of these values are returned under the evidenceRequests.lineItems\ + \ array in the getPaymentDispute response." items: - $ref: '#/components/schemas/OrderLineItems' - description: This type is used by the request payload of the updateEvidence method. The updateEvidence method is used to update an existing evidence set against a payment dispute with one or more evidence files. + $ref: "#/components/schemas/OrderLineItems" + description: "This type is used by the request payload of the updateEvidence\ + \ method. The updateEvidence method is used to update an\ + \ existing evidence set against a payment dispute with one or more evidence\ + \ files." securitySchemes: api_auth: - type: oauth2 - description: The security definitions for this API. Please check individual operations for applicable scopes. + type: "oauth2" + description: "The security definitions for this API. Please check individual\ + \ operations for applicable scopes." flows: authorizationCode: - authorizationUrl: https://auth.ebay.com/oauth2/authorize - tokenUrl: https://api.ebay.com/identity/v1/oauth2/token + authorizationUrl: "https://auth.ebay.com/oauth2/authorize" + tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token" scopes: - https://api.ebay.com/oauth/api_scope/sell.fulfillment: View and manage your order fulfillments - https://api.ebay.com/oauth/api_scope/sell.finances: View and manage your payment and order information to display this information to you and allow you to initiate refunds using the third party application - https://api.ebay.com/oauth/api_scope/sell.payment.dispute: View and manage disputes and related details (including payment and order information). - https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly: View your order fulfillments + https://api.ebay.com/oauth/api_scope/sell.fulfillment: "View and manage\ + \ your order fulfillments" + https://api.ebay.com/oauth/api_scope/sell.finances: "View and manage your\ + \ payment and order information to display this information to you and\ + \ allow you to initiate refunds using the third party application" + https://api.ebay.com/oauth/api_scope/sell.payment.dispute: "View and manage\ + \ disputes and related details (including payment and order information)." + https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly: "View\ + \ your order fulfillments" diff --git a/api-specs/sell_inventory_v1_oas3.yaml b/api-specs/sell_inventory_v1_oas3.yaml index fe275af6..76598f25 100644 --- a/api-specs/sell_inventory_v1_oas3.yaml +++ b/api-specs/sell_inventory_v1_oas3.yaml @@ -1,8305 +1,4923 @@ ---- -openapi: "3.0.0" +openapi: 3.0.0 info: - title: "Inventory API" - description: "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." + title: Inventory API + description: 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. contact: - name: "eBay Inc," + name: eBay Inc, license: - name: "eBay API License Agreement" - url: "https://go.developer.ebay.com/api-license-agreement" - version: "1.16.0" + name: eBay API License Agreement + url: https://go.developer.ebay.com/api-license-agreement + version: 1.16.1 servers: -- url: "https://api.ebay.com{basePath}" - description: "Production" - variables: - basePath: - default: "/sell/inventory/v1" + - url: https://api.ebay.com{basePath} + description: Production + variables: + basePath: + default: /sell/inventory/v1 paths: /bulk_create_or_replace_inventory_item: post: tags: - - "inventory_item" - description: "Note: Please note that\ - \ any eBay listing created using the Inventory API cannot be revised or relisted\ - \ using the Trading API calls.

Note: Each listing can be revised up to 250 times in one\ - \ calendar day. If this revision threshold is reached, the seller will be\ - \ blocked from revising the item until the next calendar day.

This\ - \ call can be used to create and/or update up to 25 new inventory item records.\ - \ It is up to sellers whether they want to create a complete inventory item\ - \ records right from the start, or sellers can provide only some information\ - \ with the initial bulkCreateOrReplaceInventoryItem call,\ - \ and then make one or more additional bulkCreateOrReplaceInventoryItem\ - \ calls to complete all required fields for the inventory item records and\ - \ prepare for publishing. Upon first creating inventory item records, only\ - \ the SKU values are required.

In the case of updating existing\ - \ inventory item records, the bulkCreateOrReplaceInventoryItem\ - \ call will do a complete replacement of the existing inventory item records,\ - \ so all fields that are currently defined for the inventory item record are\ - \ required in that update action, regardless of whether their values changed.\ - \ So, when replacing/updating an inventory item record, it is advised that\ - \ the seller run a 'Get' call to retrieve the full details of the inventory\ - \ item records and see all of its current values/settings before attempting\ - \ to update the records. Any changes that are made to inventory item records\ - \ that are part of one or more active eBay listings, a successful call will\ - \ automatically update these active listings.

The key information\ - \ that is set with the bulkCreateOrReplaceInventoryItem call\ - \ include:
  • Seller-defined SKU value for the product. Each seller\ - \ product, including products within an item inventory group, must have their\ - \ own SKU value.
  • Condition of the item
  • Product details,\ - \ including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer\ - \ Part Number pair, a product description, a product title, product/item aspects,\ - \ and links to images. eBay will use any supplied eBay Product ID (ePID) or\ - \ a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product\ - \ in the eBay Catalog, and if a product match is found, the product details\ - \ for the inventory item will automatically be populated.
  • Quantity\ - \ of the inventory item that is available for purchase
  • Package weight\ - \ and dimensions, which is required if the seller will be offering calculated\ - \ shipping options. The package weight will also be required if the seller\ - \ will be providing flat-rate shipping services, but charging a weight surcharge.
    • \ - \

In addition to the authorization header, which is\ - \ required for all eBay REST API calls, the bulkCreateOrReplaceInventoryItem\ - \ call also requires the Content-Language header, that sets the\ - \ natural language that will be used in the field values of the request payload.\ - \ For US English, the code value passed in this header should be en-US.\ - \ To view other supported Content-Language values, and to read\ - \ more about all supported HTTP headers for eBay REST API calls, see the HTTP request\ - \ headers topic in the Using eBay RESTful APIs document.

For\ - \ those who prefer to create or update a single inventory item record, the\ - \ createOrReplaceInventoryItem method can be used.

" - operationId: "bulkCreateOrReplaceInventoryItem" + - inventory_item + description: 'Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.

Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

This call can be used to create and/or update up to 25 new inventory item records. It is up to sellers whether they want to create a complete inventory item records right from the start, or sellers can provide only some information with the initial bulkCreateOrReplaceInventoryItem call, and then make one or more additional bulkCreateOrReplaceInventoryItem calls to complete all required fields for the inventory item records and prepare for publishing. Upon first creating inventory item records, only the SKU values are required.

In the case of updating existing inventory item records, the bulkCreateOrReplaceInventoryItem call will do a complete replacement of the existing inventory item records, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a ''Get'' call to retrieve the full details of the inventory item records and see all of its current values/settings before attempting to update the records. Any changes that are made to inventory item records that are part of one or more active eBay listings, a successful call will automatically update these active listings.

The key information that is set with the bulkCreateOrReplaceInventoryItem call include:
  • Seller-defined SKU value for the product. Each seller product, including products within an item inventory group, must have their own SKU value.
  • Condition of the item
  • Product details, including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number pair, a product description, a product title, product/item aspects, and links to images. eBay will use any supplied eBay Product ID (ePID) or a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product in the eBay Catalog, and if a product match is found, the product details for the inventory item will automatically be populated.
  • Quantity of the inventory item that is available for purchase
  • Package weight and dimensions, which is required if the seller will be offering calculated shipping options. The package weight will also be required if the seller will be providing flat-rate shipping services, but charging a weight surcharge.

In addition to the authorization header, which is required for all eBay REST API calls, the bulkCreateOrReplaceInventoryItem call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

For those who prefer to create or update a single inventory item record, the createOrReplaceInventoryItem method can be used.

' + operationId: bulkCreateOrReplaceInventoryItem requestBody: - description: "Details of the inventories with sku and locale" + description: Details of the inventories with sku and locale content: application/json: schema: - description: "Details of the inventories with sku and locale" - $ref: "#/components/schemas/BulkInventoryItem" + description: Details of the inventories with sku and locale + $ref: '#/components/schemas/BulkInventoryItem' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/BulkInventoryItemResponse" + $ref: '#/components/schemas/BulkInventoryItemResponse' x-response-codes: errors: - 25504: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "{additionalInfo}" - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing options removed. {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 400: - description: "Bad Request" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing options removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '25504': + domain: API_INVENTORY + category: APPLICATION + description: '{additionalInfo}' + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '207': + description: Multi-Status + '400': + description: Bad Request x-response-codes: errors: - 25728: - domain: "API_INVENTORY" - category: "REQUEST" - description: "InventoryItems should be unique in the request." - 25601: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limits exceeded. {additionalInfo}" - 25604: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25733: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Valid SKU and locale information are required for all\ - \ the InventoryItems in the request." - 25501: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid picture. {additionalInfo}" - 25502: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute information. {additionalInfo}" - 25503: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid product information. {additionalInfo}" - 25759: - domain: "API_INVENTORY" - category: "REQUEST" - description: "shipToLocationAvailability quantity value should be\ - \ greater than or equal to auction allocation. Please provide valid\ - \ quantity or unpublish auction offers of the sku." - 25701: - domain: "API_INVENTORY" - category: "REQUEST" - description: "These SKU(s) are not in the system" - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "SKU {additionalInfo} is not available in the system" - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Any User error. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid price. {additionalInfo}" - 25707: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid sku. sku has to be alphanumeric with upto 50\ - \ characters in length" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid quantity. {additionalInfo}" - 25708: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid sku" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid category. {additionalInfo}" - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid request. Invalid value for field {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid listing option. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Shipping policy information. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Payment policy information. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Return policy information. {additionalInfo}" - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid tax information. {additionalInfo}" - 25715: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Dimension and Weight" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid InventoryItemGroup information. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid {fieldName}. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Missing field {fieldName}. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid package details. {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid condition information. {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 25727: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The number of InventoryItems in the request cannot exceed\ - \ {additionalInfo}." - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: Any User error. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: Invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: Invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: Invalid category. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: Invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: Invalid Shipping policy information. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: Invalid Payment policy information. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: Invalid Return policy information. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: Invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid InventoryItemGroup information. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: Invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: Invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: Invalid {fieldName}. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: Missing field {fieldName}. {additionalInfo} + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: Invalid package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: Invalid condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limits exceeded. {additionalInfo} + '25501': + domain: API_INVENTORY + category: REQUEST + description: Invalid picture. {additionalInfo} + '25502': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute information. {additionalInfo} + '25503': + domain: API_INVENTORY + category: REQUEST + description: Invalid product information. {additionalInfo} + '25601': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25604': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25701': + domain: API_INVENTORY + category: REQUEST + description: These SKU(s) are not in the system + '25702': + domain: API_INVENTORY + category: REQUEST + description: SKU {additionalInfo} is not available in the system + '25707': + domain: API_INVENTORY + category: REQUEST + description: Invalid sku. sku has to be alphanumeric with upto 50 characters in length + '25708': + domain: API_INVENTORY + category: REQUEST + description: Invalid sku + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid request. Invalid value for field {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '25715': + domain: API_INVENTORY + category: REQUEST + description: Invalid Dimension and Weight + '25727': + domain: API_INVENTORY + category: REQUEST + description: The number of InventoryItems in the request cannot exceed {additionalInfo}. + '25728': + domain: API_INVENTORY + category: REQUEST + description: InventoryItems should be unique in the request. + '25733': + domain: API_INVENTORY + category: REQUEST + description: Valid SKU and locale information are required for all the InventoryItems in the request. + '25759': + domain: API_INVENTORY + category: REQUEST + description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku. + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of Inventory or InventoryItemGroup.\ - \ Please try again later" - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 207: - description: "Multi-Status" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of Inventory or InventoryItemGroup. Please try again later security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /bulk_get_inventory_item: post: tags: - - "inventory_item" - description: "This call retrieves up to 25 inventory item records. The SKU value\ - \ of each inventory item record to retrieve is specified in the request payload.\ - \

The authorization header is the only required HTTP\ - \ header for this call, and it is required for all Inventory API calls. See\ - \ the HTTP request headers section for more information.

For\ - \ those who prefer to retrieve only one inventory item record by SKU value,\ - \ , the getInventoryItem method can be used. To retrieve\ - \ all inventory item records defined on the seller's account, the getInventoryItems\ - \ method can be used (with pagination control if desired)." - operationId: "bulkGetInventoryItem" + - inventory_item + description: This call retrieves up to 25 inventory item records. The SKU value of each inventory item record to retrieve is specified in the request payload.

The authorization header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.

For those who prefer to retrieve only one inventory item record by SKU value, , the getInventoryItem method can be used. To retrieve all inventory item records defined on the seller's account, the getInventoryItems method can be used (with pagination control if desired). + operationId: bulkGetInventoryItem requestBody: - description: "Details of the inventories with sku and locale" + description: Details of the inventories with sku and locale content: application/json: schema: - description: "Details of the inventories with sku and locale" - $ref: "#/components/schemas/BulkGetInventoryItem" + description: Details of the inventories with sku and locale + $ref: '#/components/schemas/BulkGetInventoryItem' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/BulkGetInventoryItemResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/BulkGetInventoryItemResponse' + '207': + description: Multi-Status + '400': + description: Bad Request x-response-codes: errors: - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "SKU {additionalInfo} is not available in the system" - 25734: - domain: "API_INVENTORY" - category: "REQUEST" - description: "SKU should be unique in the request." - 25708: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid SKU." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid request. Invalid value for field {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 25727: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The number of InventoryItems in the request cannot exceed\ - \ {additionalInfo}." - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: SKU {additionalInfo} is not available in the system + '25708': + domain: API_INVENTORY + category: REQUEST + description: Invalid SKU. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid request. Invalid value for field {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '25727': + domain: API_INVENTORY + category: REQUEST + description: The number of InventoryItems in the request cannot exceed {additionalInfo}. + '25734': + domain: API_INVENTORY + category: REQUEST + description: SKU should be unique in the request. + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 207: - description: "Multi-Status" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory /bulk_update_price_quantity: post: tags: - - "inventory_item" - description: "This call is used by the seller to update the total ship-to-home\ - \ quantity of one inventory item, and/or to update the price and/or quantity\ - \ of one or more offers associated with one inventory item. Up to 25 offers\ - \ associated with an inventory item may be updated with one bulkUpdatePriceQuantity\ - \ call. Only one SKU (one product) can be updated per call.

Note: Each listing can be revised up\ - \ to 250 times in one calendar day. If this revision threshold is reached,\ - \ the seller will be blocked from revising the item until the next calendar\ - \ day.

The getOffers call can be used to\ - \ retrieve all offers associated with a SKU. The seller will just pass in\ - \ the correct SKU value through the sku query parameter.\ - \ To update an offer, the offerId value is required, and\ - \ this value is returned in the getOffers call response.\ - \ It is also useful to know which offers are unpublished and which ones are\ - \ published. To get this status, look for the status value\ - \ in the getOffers call response. Offers in the published\ - \ state are live eBay listings, and these listings will be revised with a\ - \ successful bulkUpdatePriceQuantity call.

An\ - \ issue will occur if duplicate offerId values are passed\ - \ through the same offers container, or if one or more of\ - \ the specified offers are associated with different products/SKUs.
Note: For multiple-variation\ - \ listings, it is recommended that the bulkUpdatePriceQuantity\ - \ call be used to update price and quantity information for each SKU within\ - \ that multiple-variation listing instead of using createOrReplaceInventoryItem\ - \ calls to update the price and quantity for each SKU. Just remember that\ - \ only one SKU (one product variation) can be updated per call.

The\ - \ authorization header is the only required HTTP header for this\ - \ call. See the HTTP request headers section for more information.

" - operationId: "bulkUpdatePriceQuantity" + - inventory_item + description: This call is used by the seller to update the total ship-to-home quantity of one inventory item, and/or to update the price and/or quantity of one or more offers associated with one inventory item. Up to 25 offers associated with an inventory item may be updated with one bulkUpdatePriceQuantity call. Only one SKU (one product) can be updated per call.

Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

The getOffers call can be used to retrieve all offers associated with a SKU. The seller will just pass in the correct SKU value through the sku query parameter. To update an offer, the offerId value is required, and this value is returned in the getOffers call response. It is also useful to know which offers are unpublished and which ones are published. To get this status, look for the status value in the getOffers call response. Offers in the published state are live eBay listings, and these listings will be revised with a successful bulkUpdatePriceQuantity call.

An issue will occur if duplicate offerId values are passed through the same offers container, or if one or more of the specified offers are associated with different products/SKUs.

Note: For multiple-variation listings, it is recommended that the bulkUpdatePriceQuantity call be used to update price and quantity information for each SKU within that multiple-variation listing instead of using createOrReplaceInventoryItem calls to update the price and quantity for each SKU. Just remember that only one SKU (one product variation) can be updated per call.

The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information.

+ operationId: bulkUpdatePriceQuantity requestBody: - description: "Price and allocation details for the given SKU and Marketplace" + description: Price and allocation details for the given SKU and Marketplace content: application/json: schema: - description: "Price and allocation details for the given SKU and Marketplace" - $ref: "#/components/schemas/BulkPriceQuantity" + description: Price and allocation details for the given SKU and Marketplace + $ref: '#/components/schemas/BulkPriceQuantity' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/BulkPriceQuantityResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/BulkPriceQuantityResponse' + '207': + description: Multi-Status + '400': + description: Bad Request x-response-codes: errors: - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Any User error. {additionalInfo}" - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25759: - domain: "API_INVENTORY" - category: "REQUEST" - description: "shipToLocationAvailability quantity value should be\ - \ greater than or equal to auction allocation. Please provide valid\ - \ quantity or unpublish auction offers of the sku." - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: Any User error. {additionalInfo} + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25759': + domain: API_INVENTORY + category: REQUEST + description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku. + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 207: - description: "Multi-Status" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /inventory_item/{sku}: get: tags: - - "inventory_item" - description: "This call retrieves the inventory item record for a given SKU.\ - \ The SKU value is passed in at the end of the call URI. There is no request\ - \ payload for this call.

The authorization header is\ - \ the only required HTTP header for this call, and it is required for all\ - \ Inventory API calls. See the HTTP request headers section\ - \ for more information.

For those who prefer to retrieve numerous\ - \ inventory item records by SKU value with one call (up to 25 at a time),\ - \ the bulkGetInventoryItem method can be used. To retrieve\ - \ all inventory item records defined on the seller's account, the getInventoryItems\ - \ method can be used (with pagination control if desired)." - operationId: "getInventoryItem" + - inventory_item + description: This call retrieves the inventory item record for a given SKU. The SKU value is passed in at the end of the call URI. There is no request payload for this call.

The authorization header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.

For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the bulkGetInventoryItem method can be used. To retrieve all inventory item records defined on the seller's account, the getInventoryItems method can be used (with pagination control if desired). + operationId: getInventoryItem parameters: - - name: "sku" - in: "path" - description: "This is the seller-defined SKU value of the product whose inventory\ - \ item record you wish to retrieve.

Max length:\ - \ 50." - required: true - schema: - type: "string" + - name: sku + in: path + description: 'This is the seller-defined SKU value of the product whose inventory item record you wish to retrieve.

Max length: 50.' + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/InventoryItemWithSkuLocaleGroupid" - 400: - description: "Bad Request" + $ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupid' + '400': + description: Bad Request x-response-codes: errors: - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory put: tags: - - "inventory_item" - description: "Note: Please note that\ - \ any eBay listing created using the Inventory API cannot be revised or relisted\ - \ using the Trading API calls.

Note: Each listing can be revised up to 250 times in one\ - \ calendar day. If this revision threshold is reached, the seller will be\ - \ blocked from revising the item until the next calendar day.

This\ - \ call creates a new inventory item record or replaces an existing inventory\ - \ item record. It is up to sellers whether they want to create a complete\ - \ inventory item record right from the start, or sellers can provide only\ - \ some information with the initial createOrReplaceInventoryItem\ - \ call, and then make one or more additional createOrReplaceInventoryItem\ - \ calls to complete all required fields for the inventory item record and\ - \ prepare it for publishing. Upon first creating an inventory item record,\ - \ only the SKU value in the call path is required.

In the case\ - \ of replacing an existing inventory item record, the createOrReplaceInventoryItem\ - \ call will do a complete replacement of the existing inventory item record,\ - \ so all fields that are currently defined for the inventory item record are\ - \ required in that update action, regardless of whether their values changed.\ - \ So, when replacing/updating an inventory item record, it is advised that\ - \ the seller run a getInventoryItem call to retrieve the\ - \ full inventory item record and see all of its current values/settings before\ - \ attempting to update the record. And if changes are made to an inventory\ - \ item that is part of one or more active eBay listings, a successful call\ - \ will automatically update these eBay listings.

The key information\ - \ that is set with the createOrReplaceInventoryItem call\ - \ include:
  • Seller-defined SKU value for the product. Each seller\ - \ product, including products within an item inventory group, must have their\ - \ own SKU value. This SKU value is passed in at the end of the call URI
    • \ - \
  • Condition of the item
  • Product details, including any product\ - \ identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number\ - \ pair, a product description, a product title, product/item aspects, and\ - \ links to images. eBay will use any supplied eBay Product ID (ePID) or a\ - \ GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product\ - \ in the eBay Catalog, and if a product match is found, the product details\ - \ for the inventory item will automatically be populated.
  • Quantity\ - \ of the inventory item that is available for purchase
  • Package weight\ - \ and dimensions, which is required if the seller will be offering calculated\ - \ shipping options. The package weight will also be required if the seller\ - \ will be providing flat-rate shipping services, but charging a weight surcharge.
    • \ - \

In addition to the authorization header, which is\ - \ required for all eBay REST API calls, the createOrReplaceInventoryItem\ - \ call also requires the Content-Language header, that sets the\ - \ natural language that will be used in the field values of the request payload.\ - \ For US English, the code value passed in this header should be en-US.\ - \ To view other supported Content-Language values, and to read\ - \ more about all supported HTTP headers for eBay REST API calls, see the HTTP request\ - \ headers topic in the Using eBay RESTful APIs document.

For\ - \ those who prefer to create or update numerous inventory item records with\ - \ one call (up to 25 at a time), the bulkCreateOrReplaceInventoryItem\ - \ method can be used.

" - operationId: "createOrReplaceInventoryItem" + - inventory_item + description: 'Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.

Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

This call creates a new inventory item record or replaces an existing inventory item record. It is up to sellers whether they want to create a complete inventory item record right from the start, or sellers can provide only some information with the initial createOrReplaceInventoryItem call, and then make one or more additional createOrReplaceInventoryItem calls to complete all required fields for the inventory item record and prepare it for publishing. Upon first creating an inventory item record, only the SKU value in the call path is required.

In the case of replacing an existing inventory item record, the createOrReplaceInventoryItem call will do a complete replacement of the existing inventory item record, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a getInventoryItem call to retrieve the full inventory item record and see all of its current values/settings before attempting to update the record. And if changes are made to an inventory item that is part of one or more active eBay listings, a successful call will automatically update these eBay listings.

The key information that is set with the createOrReplaceInventoryItem call include:
  • Seller-defined SKU value for the product. Each seller product, including products within an item inventory group, must have their own SKU value. This SKU value is passed in at the end of the call URI
  • Condition of the item
  • Product details, including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number pair, a product description, a product title, product/item aspects, and links to images. eBay will use any supplied eBay Product ID (ePID) or a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product in the eBay Catalog, and if a product match is found, the product details for the inventory item will automatically be populated.
  • Quantity of the inventory item that is available for purchase
  • Package weight and dimensions, which is required if the seller will be offering calculated shipping options. The package weight will also be required if the seller will be providing flat-rate shipping services, but charging a weight surcharge.

In addition to the authorization header, which is required for all eBay REST API calls, the createOrReplaceInventoryItem call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

For those who prefer to create or update numerous inventory item records with one call (up to 25 at a time), the bulkCreateOrReplaceInventoryItem method can be used.

' + operationId: createOrReplaceInventoryItem parameters: - - name: "Content-Language" - in: "header" - description: "This request header sets the natural language that will be provided\ - \ in the field values of the request payload." - required: true - schema: - type: "string" - - name: "sku" - in: "path" - description: "The seller-defined SKU value for the inventory item is required\ - \ whether the seller is creating a new inventory item, or updating an existing\ - \ inventory item. This SKU value is passed in at the end of the call URI.\ - \ SKU values must be unique across the seller's inventory.

Max\ - \ length: 50." - required: true - schema: - type: "string" + - name: Content-Language + in: header + description: This request header sets the natural language that will be provided in the field values of the request payload. + required: true + schema: + type: string + - name: sku + in: path + description: 'The seller-defined SKU value for the inventory item is required whether the seller is creating a new inventory item, or updating an existing inventory item. This SKU value is passed in at the end of the call URI. SKU values must be unique across the seller''s inventory.

Max length: 50.' + required: true + schema: + type: string requestBody: - description: "Details of the inventory item record." + description: Details of the inventory item record. content: application/json: schema: - description: "Details of the inventory item record." - $ref: "#/components/schemas/InventoryItem" + description: Details of the inventory item record. + $ref: '#/components/schemas/InventoryItem' required: true responses: - 200: - description: "Success" + '200': + description: Success headers: Content-Language: schema: - type: "string" - description: "This header controls the language that is used for any\ - \ returned errors or warnings in the call response." + type: string + description: This header controls the language that is used for any returned errors or warnings in the call response. content: application/json: schema: - $ref: "#/components/schemas/BaseResponse" + $ref: '#/components/schemas/BaseResponse' x-response-codes: errors: - 25504: - domain: "API_INVENTORY" - category: "APPLICATION" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing format removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '25504': + domain: API_INVENTORY + category: APPLICATION description: "service\t{additionalInfo}" - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing format removed. {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 201: - description: "Created" + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '201': + description: Created headers: Content-Language: schema: - type: "string" - description: "This header controls the language that is used for any\ - \ returned errors or warnings in the call response." + type: string + description: This header controls the language that is used for any returned errors or warnings in the call response. content: application/json: schema: - $ref: "#/components/schemas/BaseResponse" + $ref: '#/components/schemas/BaseResponse' x-response-codes: errors: - 25504: - domain: "API_INVENTORY" - category: "APPLICATION" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing format removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '25504': + domain: API_INVENTORY + category: APPLICATION description: "service\t{additionalInfo}" - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing format removed. {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 400: - description: "Bad Request" + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25601: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is an invalid attribute. " - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limit exceeded. {additionalInfo}" - 25604: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25501: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid picture. {additionalInfo}" - 25502: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute information. {additionalInfo}" - 25503: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid product information. {additionalInfo}" - 25759: - domain: "API_INVENTORY" - category: "REQUEST" - description: "shipToLocationAvailability quantity value should be\ - \ greater than or equal to auction allocation. Please provide valid\ - \ quantity or unpublish auction offers of the sku." - 25701: - domain: "API_INVENTORY" - category: "REQUEST" - description: "One or more of the supplied SKU(s) could not be found\ - \ in the system." - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "A user error has occurred. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid price. {additionalInfo}" - 25707: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This is an invalid value for a SKU. Only alphanumeric\ - \ characters can be used for SKUs, and their length must not exceed\ - \ 50 characters." - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid quantity. {additionalInfo}" - 25708: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid SKU." - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid category ID. {additionalInfo}" - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid listing option. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request." - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Fulfillment\ - \ policy. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Payment\ - \ policy. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Return\ - \ policy. {additionalInfo}" - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid tax information. {additionalInfo}" - 25715: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid values for dimensions and/or weight of shipping\ - \ package." - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid inventory location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid data in the Inventory Item Group. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The {fieldName} value is invalid. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is missing. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid shipping package details.\ - \ {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid item condition information.\ - \ {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: A user error has occurred. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid inventory location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid data in the Inventory Item Group. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: The {fieldName} value is invalid. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is missing. {additionalInfo}' + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limit exceeded. {additionalInfo} + '25501': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture. {additionalInfo} + '25502': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute information. {additionalInfo} + '25503': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid product information. {additionalInfo} + '25601': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is an invalid attribute. ' + '25604': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25701': + domain: API_INVENTORY + category: REQUEST + description: One or more of the supplied SKU(s) could not be found in the system. + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25707': + domain: API_INVENTORY + category: REQUEST + description: This is an invalid value for a SKU. Only alphanumeric characters can be used for SKUs, and their length must not exceed 50 characters. + '25708': + domain: API_INVENTORY + category: REQUEST + description: Invalid SKU. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request. + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '25715': + domain: API_INVENTORY + category: REQUEST + description: Invalid values for dimensions and/or weight of shipping package. + '25759': + domain: API_INVENTORY + category: REQUEST + description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku. + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of the same Inventory or Inventory\ - \ Item Group object is not allowed. Please try again later." - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory delete: tags: - - "inventory_item" - description: "This call is used to delete an inventory item record associated\ - \ with a specified SKU. A successful call will not only delete that inventory\ - \ item record, but will also have the following effects:
  • Delete any\ - \ and all unpublished offers associated with that SKU;
  • Delete any\ - \ and all single-variation eBay listings associated with that SKU;
  • Automatically\ - \ remove that SKU from a multiple-variation listing and remove that SKU from\ - \ any and all inventory item groups in which that SKU was a member.

The\ - \ authorization header is the only required HTTP header for this\ - \ call. See the HTTP request headers section for more information.

" - operationId: "deleteInventoryItem" + - inventory_item + description: This call is used to delete an inventory item record associated with a specified SKU. A successful call will not only delete that inventory item record, but will also have the following effects:
  • Delete any and all unpublished offers associated with that SKU;
  • Delete any and all single-variation eBay listings associated with that SKU;
  • Automatically remove that SKU from a multiple-variation listing and remove that SKU from any and all inventory item groups in which that SKU was a member.

The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information.

+ operationId: deleteInventoryItem parameters: - - name: "sku" - in: "path" - description: "This is the seller-defined SKU value of the product whose inventory\ - \ item record you wish to delete.

Max length:\ - \ 50." - required: true - schema: - type: "string" + - name: sku + in: path + description: 'This is the seller-defined SKU value of the product whose inventory item record you wish to delete.

Max length: 50.' + required: true + schema: + type: string responses: - 400: - description: "Bad Request" + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /inventory_item: get: tags: - - "inventory_item" - description: "This call retrieves all inventory item records defined for the\ - \ seller's account. The limit query parameter allows the\ - \ seller to control how many records are returned per page, and the offset\ - \ query parameter is used to retrieve a specific page of records. The seller\ - \ can make multiple calls to scan through multiple pages of records. There\ - \ is no request payload for this call.

The authorization\ - \ header is the only required HTTP header for this call, and it is required\ - \ for all Inventory API calls. See the HTTP request headers\ - \ section for more information.

For those who prefer to retrieve\ - \ numerous inventory item records by SKU value with one call (up to 25 at\ - \ a time), the bulkGetInventoryItem method can be used." - operationId: "getInventoryItems" + - inventory_item + description: This call retrieves all inventory item records defined for the seller's account. The limit query parameter allows the seller to control how many records are returned per page, and the offset query parameter is used to retrieve a specific page of records. The seller can make multiple calls to scan through multiple pages of records. There is no request payload for this call.

The authorization header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.

For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the bulkGetInventoryItem method can be used. + operationId: getInventoryItems parameters: - - name: "limit" - in: "query" - description: "The value passed in this query parameter sets the maximum number\ - \ of records to return per page of data. Although this field is a string,\ - \ the value passed in this field should be an integer from 1\ - \ to 100. If this query parameter is not set, up to 100 records\ - \ will be returned on each page of results.

Min:\ - \ 1, Max: 100 " - required: false - schema: - type: "string" - - name: "offset" - in: "query" - description: "The value passed in this query parameter sets the page number\ - \ to retrieve. The first page of records has a value of 0,\ - \ the second page of records has a value of 1, and so on. If\ - \ this query parameter is not set, its value defaults to 0,\ - \ and the first page of records is returned. " - required: false - schema: - type: "string" + - name: limit + in: query + description: 'The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be an integer from 1 to 100. If this query parameter is not set, up to 100 records will be returned on each page of results.

Min: 1, Max: 100 ' + required: false + schema: + type: string + - name: offset + in: query + description: 'The value passed in this query parameter sets the page number to retrieve. The first page of records has a value of 0, the second page of records has a value of 1, and so on. If this query parameter is not set, its value defaults to 0, and the first page of records is returned. ' + required: false + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/InventoryItems" - 400: - description: "Bad Request" + $ref: '#/components/schemas/InventoryItems' + '400': + description: Bad Request x-response-codes: errors: - 25706: - domain: "API_INVENTORY" - category: "REQUEST" - description: "You have provided invalid pagination values. {additionalInfo}." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}." - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25706': + domain: API_INVENTORY + category: REQUEST + description: You have provided invalid pagination values. {additionalInfo}. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory /inventory_item/{sku}/product_compatibility: get: tags: - - "product_compatibility" - description: "This call is used by the seller to retrieve the list of products\ - \ that are compatible with the inventory item. The SKU value for the inventory\ - \ item is passed into the call URI, and a successful call with return the\ - \ compatible vehicle list associated with this inventory item. Product compatibility\ - \ is currently only applicable to motor vehicle parts and accessory categories,\ - \ but more categories may be supported in the future." - operationId: "getProductCompatibility" + - product_compatibility + description: This call is used by the seller to retrieve the list of products that are compatible with the inventory item. The SKU value for the inventory item is passed into the call URI, and a successful call with return the compatible vehicle list associated with this inventory item. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future. + operationId: getProductCompatibility parameters: - - name: "sku" - in: "path" - description: "A SKU (stock keeping unit) is an unique identifier defined by\ - \ a seller for a product" - required: true - schema: - type: "string" + - name: sku + in: path + description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/Compatibility" - 400: - description: "Bad Request" + $ref: '#/components/schemas/Compatibility' + '400': + description: Bad Request x-response-codes: errors: - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory put: tags: - - "product_compatibility" - description: "This call is used by the seller to create or replace a list of\ - \ products that are compatible with the inventory item. The inventory item\ - \ is identified with a SKU value in the URI. Product compatibility is currently\ - \ only applicable to motor vehicle parts and accessory categories, but more\ - \ categories may be supported in the future.

In addition to\ - \ the authorization header, which is required for all eBay REST\ - \ API calls, the createOrReplaceProductCompatibility call\ - \ also requires the Content-Language header, that sets the natural\ - \ language that will be used in the field values of the request payload. For\ - \ US English, the code value passed in this header should be en-US.\ - \ To view other supported Content-Language values, and to read\ - \ more about all supported HTTP headers for eBay REST API calls, see the HTTP request\ - \ headers topic in the Using eBay RESTful APIs document.

" - operationId: "createOrReplaceProductCompatibility" + - product_compatibility + description: This call is used by the seller to create or replace a list of products that are compatible with the inventory item. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.

In addition to the authorization header, which is required for all eBay REST API calls, the createOrReplaceProductCompatibility call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

+ operationId: createOrReplaceProductCompatibility parameters: - - name: "Content-Language" - in: "header" - description: "This request header sets the natural language that will be provided\ - \ in the field values of the request payload." - required: true - schema: - type: "string" - - name: "sku" - in: "path" - description: "A SKU (stock keeping unit) is an unique identifier defined by\ - \ a seller for a product" - required: true - schema: - type: "string" + - name: Content-Language + in: header + description: This request header sets the natural language that will be provided in the field values of the request payload. + required: true + schema: + type: string + - name: sku + in: path + description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product + required: true + schema: + type: string requestBody: - description: "Details of the compatibility" + description: Details of the compatibility content: application/json: schema: - description: "Details of the compatibility" - $ref: "#/components/schemas/Compatibility" + description: Details of the compatibility + $ref: '#/components/schemas/Compatibility' required: true responses: - 200: - description: "Success" + '200': + description: Success headers: Content-Language: schema: - type: "string" - description: "This response header sets the natural language that\ - \ will be provided in the field values of the response payload." + type: string + description: This response header sets the natural language that will be provided in the field values of the response payload. content: application/json: schema: - $ref: "#/components/schemas/BaseResponse" + $ref: '#/components/schemas/BaseResponse' x-response-codes: errors: - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing format removed. {additionalInfo}" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 201: - description: "Created" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing format removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '201': + description: Created headers: Content-Language: schema: - type: "string" - description: "This response header sets the natural language that\ - \ will be provided in the field values of the response payload." + type: string + description: This response header sets the natural language that will be provided in the field values of the response payload. content: application/json: schema: - $ref: "#/components/schemas/BaseResponse" + $ref: '#/components/schemas/BaseResponse' x-response-codes: errors: - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing format removed. {additionalInfo}" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 400: - description: "Bad Request" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing format removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limit exceeded. {additionalInfo}" - 25739: - domain: "API_INVENTORY" - category: "REQUEST" - description: "User input error. The number of compatibilityProperties\ - \ in the request cannot exceed {additionalInfo}." - 25740: - domain: "API_INVENTORY" - category: "REQUEST" - description: "User input error. Invalid name for compatibilityProperties.\ - \ The length should be between 1 and {additionalInfo} characters." - 25741: - domain: "API_INVENTORY" - category: "REQUEST" - description: "User input error. Invalid value for compatibilityProperties.\ - \ The length should be between 1 and {additionalInfo} characters." - 25742: - domain: "API_INVENTORY" - category: "REQUEST" - description: "User input error. productFamilyProperties and compatibilityProperties\ - \ cannot be used together. Please use compatibilityProperties." - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "A user error has occurred. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid price. {additionalInfo}" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid quantity. {additionalInfo}" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid category ID. {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid listing option. {additionalInfo}" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Fulfillment\ - \ policy. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Payment\ - \ policy. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Return\ - \ policy. {additionalInfo}" - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid tax information. {additionalInfo}" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid inventory location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid data in the Inventory Item Group. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The {fieldName} value is invalid. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is missing. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid shipping package details.\ - \ {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid item condition information.\ - \ {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: A user error has occurred. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid inventory location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid data in the Inventory Item Group. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: The {fieldName} value is invalid. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is missing. {additionalInfo}' + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limit exceeded. {additionalInfo} + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25739': + domain: API_INVENTORY + category: REQUEST + description: User input error. The number of compatibilityProperties in the request cannot exceed {additionalInfo}. + '25740': + domain: API_INVENTORY + category: REQUEST + description: User input error. Invalid name for compatibilityProperties. The length should be between 1 and {additionalInfo} characters. + '25741': + domain: API_INVENTORY + category: REQUEST + description: User input error. Invalid value for compatibilityProperties. The length should be between 1 and {additionalInfo} characters. + '25742': + domain: API_INVENTORY + category: REQUEST + description: User input error. productFamilyProperties and compatibilityProperties cannot be used together. Please use compatibilityProperties. + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of the same Inventory or Inventory\ - \ Item Group object is not allowed. Please try again later." - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory delete: tags: - - "product_compatibility" - description: "This call is used by the seller to delete the list of products\ - \ that are compatible with the inventory item that is associated with the\ - \ compatible product list. The inventory item is identified with a SKU value\ - \ in the URI. Product compatibility is currently only applicable to motor\ - \ vehicle parts and accessory categories, but more categories may be supported\ - \ in the future." - operationId: "deleteProductCompatibility" + - product_compatibility + description: This call is used by the seller to delete the list of products that are compatible with the inventory item that is associated with the compatible product list. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future. + operationId: deleteProductCompatibility parameters: - - name: "sku" - in: "path" - description: "A SKU (stock keeping unit) is an unique identifier defined by\ - \ a seller for a product" - required: true - schema: - type: "string" + - name: sku + in: path + description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product + required: true + schema: + type: string responses: - 400: - description: "Bad Request" + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. <additional_information>" - 204: - description: "No Content" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. <additional_information> security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /inventory_item_group/{inventoryItemGroupKey}: get: tags: - - "inventory_item_group" - description: "This call retrieves the inventory item group for a given inventoryItemGroupKey\ - \ value. The inventoryItemGroupKey value is passed in at\ - \ the end of the call URI." - operationId: "getInventoryItemGroup" + - inventory_item_group + description: This call retrieves the inventory item group for a given inventoryItemGroupKey value. The inventoryItemGroupKey value is passed in at the end of the call URI. + operationId: getInventoryItemGroup parameters: - - name: "inventoryItemGroupKey" - in: "path" - description: "The unique identifier of an inventory item group. This value\ - \ is assigned by the seller when an inventory item group is created. The\ - \ inventoryItemGroupKey value for the inventory item group\ - \ to retrieve is passed in at the end of the call URI." - required: true - schema: - type: "string" + - name: inventoryItemGroupKey + in: path + description: The unique identifier of an inventory item group. This value is assigned by the seller when an inventory item group is created. The inventoryItemGroupKey value for the inventory item group to retrieve is passed in at the end of the call URI. + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/InventoryItemGroup" - 400: - description: "Bad Request" + $ref: '#/components/schemas/InventoryItemGroup' + '400': + description: Bad Request x-response-codes: errors: - 25705: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The Inventory Item Group named {inventoryItemGroupKey}\ - \ could not be found or is not available in the system." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25705': + domain: API_INVENTORY + category: REQUEST + description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory put: tags: - - "inventory_item_group" - description: "Note: Each listing\ - \ can be revised up to 250 times in one calendar day. If this revision threshold\ - \ is reached, the seller will be blocked from revising the item until the\ - \ next calendar day.

This call creates a new inventory item\ - \ group or updates an existing inventory item group. It is up to sellers whether\ - \ they want to create a complete inventory item group record right from the\ - \ start, or sellers can provide only some information with the initial createOrReplaceInventoryItemGroup\ - \ call, and then make one or more additional createOrReplaceInventoryItemGroup\ - \ calls to complete the inventory item group record. Upon first creating an\ - \ inventory item group record, the only required elements are the inventoryItemGroupKey\ - \ identifier in the call URI, and the members of the inventory item group\ - \ specified through the variantSKUs array in the request\ - \ payload.

In the case of updating/replacing an existing inventory\ - \ item group, this call does a complete replacement of the existing inventory\ - \ item group record, so all fields (including the member SKUs) that make up\ - \ the inventory item group are required, regardless of whether their values\ - \ changed. So, when replacing/updating an inventory item group record, it\ - \ is advised that the seller run a getInventoryItemGroup\ - \ call for that inventory item group to see all of its current values/settings/members\ - \ before attempting to update the record. And if changes are made to an inventory\ - \ item group that is part of a live, multiple-variation eBay listing, these\ - \ changes automatically update the eBay listing. For example, if a SKU value\ - \ is removed from the inventory item group, the corresponding product variation\ - \ will be removed from the eBay listing as well.

In addition to\ - \ the required inventory item group identifier and member SKUs, other key\ - \ information that is set with this call include:
  • Title and description\ - \ of the inventory item group. The string values provided in these fields\ - \ will actually become the listing title and listing description of the listing\ - \ once the first SKU of the inventory item group is published successfully
    • \ - \
  • Common aspects that inventory items in the qroup share
  • Product\ - \ aspects that vary within each product variation
  • Links to images\ - \ demonstrating the variations of the product, and these images should correspond\ - \ to the product aspect that is set with the variesBy.aspectsImageVariesBy\ - \ field

In addition to the authorization header,\ - \ which is required for all eBay REST API calls, the createOrReplaceInventoryItemGroup\ - \ call also requires the Content-Language header, that sets the\ - \ natural language that will be used in the field values of the request payload.\ - \ For US English, the code value passed in this header should be en-US.\ - \ To view other supported Content-Language values, and to read\ - \ more about all supported HTTP headers for eBay REST API calls, see the HTTP request\ - \ headers topic in the Using eBay RESTful APIs document.

" - operationId: "createOrReplaceInventoryItemGroup" + - inventory_item_group + description: 'Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

This call creates a new inventory item group or updates an existing inventory item group. It is up to sellers whether they want to create a complete inventory item group record right from the start, or sellers can provide only some information with the initial createOrReplaceInventoryItemGroup call, and then make one or more additional createOrReplaceInventoryItemGroup calls to complete the inventory item group record. Upon first creating an inventory item group record, the only required elements are the inventoryItemGroupKey identifier in the call URI, and the members of the inventory item group specified through the variantSKUs array in the request payload.

In the case of updating/replacing an existing inventory item group, this call does a complete replacement of the existing inventory item group record, so all fields (including the member SKUs) that make up the inventory item group are required, regardless of whether their values changed. So, when replacing/updating an inventory item group record, it is advised that the seller run a getInventoryItemGroup call for that inventory item group to see all of its current values/settings/members before attempting to update the record. And if changes are made to an inventory item group that is part of a live, multiple-variation eBay listing, these changes automatically update the eBay listing. For example, if a SKU value is removed from the inventory item group, the corresponding product variation will be removed from the eBay listing as well.

In addition to the required inventory item group identifier and member SKUs, other key information that is set with this call include:
  • Title and description of the inventory item group. The string values provided in these fields will actually become the listing title and listing description of the listing once the first SKU of the inventory item group is published successfully
  • Common aspects that inventory items in the qroup share
  • Product aspects that vary within each product variation
  • Links to images demonstrating the variations of the product, and these images should correspond to the product aspect that is set with the variesBy.aspectsImageVariesBy field

In addition to the authorization header, which is required for all eBay REST API calls, the createOrReplaceInventoryItemGroup call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

' + operationId: createOrReplaceInventoryItemGroup parameters: - - name: "Content-Language" - in: "header" - description: "This request header sets the natural language that will be provided\ - \ in the field values of the request payload." - required: true - schema: - type: "string" - - name: "inventoryItemGroupKey" - in: "path" - description: "Unique identifier of the inventory item group. This identifier\ - \ is supplied by the seller. The inventoryItemGroupKey\ - \ value for the inventory item group to create/update is passed in at the\ - \ end of the call URI. This value cannot be changed once it is set." - required: true - schema: - type: "string" + - name: Content-Language + in: header + description: This request header sets the natural language that will be provided in the field values of the request payload. + required: true + schema: + type: string + - name: inventoryItemGroupKey + in: path + description: Unique identifier of the inventory item group. This identifier is supplied by the seller. The inventoryItemGroupKey value for the inventory item group to create/update is passed in at the end of the call URI. This value cannot be changed once it is set. + required: true + schema: + type: string requestBody: - description: "Details of the inventory Item Group" + description: Details of the inventory Item Group content: application/json: schema: - description: "Details of the inventory Item Group" - $ref: "#/components/schemas/InventoryItemGroup" + description: Details of the inventory Item Group + $ref: '#/components/schemas/InventoryItemGroup' required: true responses: - 200: - description: "Success" + '200': + description: Success headers: Content-Language: schema: - type: "string" - description: "This describes the natural language(s) of the intended\ - \ audience for the enclosed entity" + type: string + description: This describes the natural language(s) of the intended audience for the enclosed entity content: application/json: schema: - $ref: "#/components/schemas/BaseResponse" + $ref: '#/components/schemas/BaseResponse' x-response-codes: errors: - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing format removed {additionalInfo}" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 201: - description: "Created" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing format removed {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '201': + description: Created headers: Content-Language: schema: - type: "string" - description: "This describes the natural language(s) of the intended\ - \ audience for the enclosed entity" + type: string + description: This describes the natural language(s) of the intended audience for the enclosed entity content: application/json: schema: - $ref: "#/components/schemas/BaseResponse" + $ref: '#/components/schemas/BaseResponse' x-response-codes: errors: - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing format removed {additionalInfo}" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 400: - description: "Bad Request" + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing format removed {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25024: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Best Offer information. {additionalInfo}" - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limit exceeded. {additionalInfo}" - 25041: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, maximum\ - \ handling time must be {replaceable_value} business day(s)." - 25042: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, free\ - \ shipping must be provided." - 25043: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, returns\ - \ must be accepted." - 25044: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, refund\ - \ must be provided as Money Back." - 25045: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, the\ - \ minimum time you'll accept returns must be {replaceable_value}\ - \ days." - 25046: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, seller\ - \ must pay the cost for return shipping." - 25047: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition" - 25048: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ in this Category" - 25049: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ for the selected Brand" - 25050: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Title." - 25051: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Subtitle" - 25756: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Auction format is not permitted with a SKU that is part\ - \ of an InventoryItemGroup." - 25052: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, at\ - \ least {replaceable_value} images must be provided" - 25701: - domain: "API_INVENTORY" - category: "REQUEST" - description: "One or more of the supplied SKU(s) could not be found\ - \ in the system." - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25703: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The following SKU is already a member of another group.\ - \ SKU : {skuValue} groupId : {inventoryItemGroupKey}" - 25704: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The following SKU is already listed as a single SKU\ - \ listing. SKU : {skuValue} Listing ID : {listingId}" - 25705: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The Inventory Item Group named {inventoryItemGroupKey}\ - \ could not be found or is not available in the system." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "A user error has occurred. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid price. {additionalInfo}" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid quantity. {additionalInfo}" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid category ID. {additionalInfo}" - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid listing option. {additionalInfo}" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Fulfillment\ - \ policy. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Payment\ - \ policy. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Return\ - \ policy. {additionalInfo}" - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid tax information. {additionalInfo}" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid inventory location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid data in the Inventory Item Group. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The {fieldName} value is invalid. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is missing. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid shipping package details.\ - \ {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid item condition information.\ - \ {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: A user error has occurred. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid inventory location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid data in the Inventory Item Group. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: The {fieldName} value is invalid. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is missing. {additionalInfo}' + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25024': + domain: API_INVENTORY + category: REQUEST + description: Invalid Best Offer information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limit exceeded. {additionalInfo} + '25041': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). + '25042': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, free shipping must be provided. + '25043': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, returns must be accepted. + '25044': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, refund must be provided as Money Back. + '25045': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. + '25046': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. + '25047': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition + '25048': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition in this Category + '25049': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition for the selected Brand + '25050': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. + '25051': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle + '25052': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided + '25701': + domain: API_INVENTORY + category: REQUEST + description: One or more of the supplied SKU(s) could not be found in the system. + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25703': + domain: API_INVENTORY + category: REQUEST + description: 'The following SKU is already a member of another group. SKU : {skuValue} groupId : {inventoryItemGroupKey}' + '25704': + domain: API_INVENTORY + category: REQUEST + description: 'The following SKU is already listed as a single SKU listing. SKU : {skuValue} Listing ID : {listingId}' + '25705': + domain: API_INVENTORY + category: REQUEST + description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25756': + domain: API_INVENTORY + category: REQUEST + description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of the same Inventory or Inventory\ - \ Item Group object is not allowed. Please try again later." - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory delete: tags: - - "inventory_item_group" - description: "This call deletes the inventory item group for a given inventoryItemGroupKey\ - \ value." - operationId: "deleteInventoryItemGroup" + - inventory_item_group + description: This call deletes the inventory item group for a given inventoryItemGroupKey value. + operationId: deleteInventoryItemGroup parameters: - - name: "inventoryItemGroupKey" - in: "path" - description: "The unique identifier of an inventory item group. This value\ - \ is assigned by the seller when an inventory item group is created. The\ - \ inventoryItemGroupKey value for the inventory item group\ - \ to delete is passed in at the end of the call URI." - required: true - schema: - type: "string" + - name: inventoryItemGroupKey + in: path + description: The unique identifier of an inventory item group. This value is assigned by the seller when an inventory item group is created. The inventoryItemGroupKey value for the inventory item group to delete is passed in at the end of the call URI. + required: true + schema: + type: string responses: - 400: - description: "Bad Request" + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25705: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The Inventory Item Group named {inventoryItemGroupKey}\ - \ could not be found or is not available in the system." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 500: - description: "Internal Server Error" + '25705': + domain: API_INVENTORY + category: REQUEST + description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /bulk_migrate_listing: post: tags: - - "listing" - description: "This call is used to convert existing eBay Listings to the corresponding\ - \ Inventory API objects. If an eBay listing is successfully migrated to the\ - \ Inventory API model, new Inventory Location, Inventory Item, and Offer objects\ - \ are created. For a multiple-variation listing that is successfully migrated,\ - \ in addition to the three new Inventory API objects just mentioned, an Inventory\ - \ Item Group object will also be created. If the eBay listing is a motor vehicle\ - \ part or accessory listing with a compatible vehicle list (ItemCompatibilityList\ - \ container in Trading API's Add/Revise/Relist/Verify calls), a Product Compatibility\ - \ object will be created.

Migration Requirements


To\ - \ be eligible for migration, the active eBay listings must meet the following\ - \ requirements:
  • Listing type is Fixed-Price

    Note: Auction listings are supported by the Inventory API,\ - \ but the bulkMigrateListing method cannot be used to migrate auction\ - \ listings.

  • The item(s) in the listings must have seller-defined\ - \ SKU values associated with them, and in the case of a multiple-variation\ - \ listing, each product variation must also have its own SKU value
  • Business\ - \ Polices (Payment, Return Policy, and Shipping) must be used on the listing,\ - \ as legacy payment, return policy, and shipping fields will not be accepted.\ - \ With the Payment Policy associated with a listing, the immediate payment\ - \ requirement must be enabled.
  • The postal/zip code (PostalCode\ - \ field in Trading's ItemType) or city (Location\ - \ field in Trading's ItemType) must be set in the listing;\ - \ the country is also needed, but this value is required in Trading API, so\ - \ it will always be set for every listing

Unsupported Listing\ - \ Features


The following features are not yet available to be set\ - \ or modified through the Inventory API, but they will remain on the active\ - \ eBay listing, even after a successful migration to the Inventory model.\ - \ The downside to this is that the seller will be completely blocked (in APIs\ - \ or My eBay) from revising these features/settings once the migration takes\ - \ place:
  • Any listing-level Buyer Requirements
  • Listing enhancements\ - \ like a bold listing title or Gallery Plus

Making the\ - \ Call


In the request payload of the bulkMigrateListings\ - \ call, the seller will pass in an array of one to five eBay listing IDs (aka\ - \ Item IDs). To save time and hassle, that seller should do a pre-check on\ - \ each listing to make sure those listings meet the requirements to be migrated\ - \ to the new Inventory model. There are no path or query parameters for this\ - \ call.

Call Response


If an eBay listing is migrated\ - \ successfully to the new Inventory model, the following will occur:
  • An\ - \ Inventory Item object will be created for the item(s) in the listing, and\ - \ this object will be accessible through the Inventory API
  • An Offer\ - \ object will be created for the listing, and this object will be accessible\ - \ through the Inventory API
  • An Inventory Location object will be created\ - \ and associated with the Offer object, as an Inventory Location must be associated\ - \ with a published Offer
The response payload of the Bulk Migrate\ - \ Listings call will show the results of each listing migration. These results\ - \ include an HTTP status code to indicate the success or failure of each listing\ - \ migration, the SKU value associated with each item, and if the migration\ - \ is successful, an Offer ID value. The SKU value will be used in the Inventory\ - \ API to manage the Inventory Item object, and the Offer ID value will be\ - \ used in the Inventory API to manage the Offer object. Errors and/or warnings\ - \ containers will be returned for each listing where an error and/or warning\ - \ occurred with the attempted migration.

If a multiple-variation\ - \ listing is successfully migrated, along with the Offer and Inventory Location\ - \ objects, an Inventory Item object will be created for each product variation\ - \ within the listing, and an Inventory Item Group object will also be created,\ - \ grouping those variations together in the Inventory API platform. For a\ - \ motor vehicle part or accessory listing that has a specified list of compatible\ - \ vehicles, in addition to the Inventory Item, Inventory Location, and Offer\ - \ objects that are created, a Product Compatibility object will also be created\ - \ in the Inventory API platform." - operationId: "bulkMigrateListing" + - listing + description: This call is used to convert existing eBay Listings to the corresponding Inventory API objects. If an eBay listing is successfully migrated to the Inventory API model, new Inventory Location, Inventory Item, and Offer objects are created. For a multiple-variation listing that is successfully migrated, in addition to the three new Inventory API objects just mentioned, an Inventory Item Group object will also be created. If the eBay listing is a motor vehicle part or accessory listing with a compatible vehicle list (ItemCompatibilityList container in Trading API's Add/Revise/Relist/Verify calls), a Product Compatibility object will be created.

Migration Requirements


To be eligible for migration, the active eBay listings must meet the following requirements:
  • Listing type is Fixed-Price

    Note: Auction listings are supported by the Inventory API, but the bulkMigrateListing method cannot be used to migrate auction listings.

  • The item(s) in the listings must have seller-defined SKU values associated with them, and in the case of a multiple-variation listing, each product variation must also have its own SKU value
  • Business Polices (Payment, Return Policy, and Shipping) must be used on the listing, as legacy payment, return policy, and shipping fields will not be accepted. With the Payment Policy associated with a listing, the immediate payment requirement must be enabled.
  • The postal/zip code (PostalCode field in Trading's ItemType) or city (Location field in Trading's ItemType) must be set in the listing; the country is also needed, but this value is required in Trading API, so it will always be set for every listing

Unsupported Listing Features


The following features are not yet available to be set or modified through the Inventory API, but they will remain on the active eBay listing, even after a successful migration to the Inventory model. The downside to this is that the seller will be completely blocked (in APIs or My eBay) from revising these features/settings once the migration takes place:
  • Any listing-level Buyer Requirements
  • Listing enhancements like a bold listing title or Gallery Plus

Making the Call


In the request payload of the bulkMigrateListings call, the seller will pass in an array of one to five eBay listing IDs (aka Item IDs). To save time and hassle, that seller should do a pre-check on each listing to make sure those listings meet the requirements to be migrated to the new Inventory model. There are no path or query parameters for this call.

Call Response


If an eBay listing is migrated successfully to the new Inventory model, the following will occur:
  • An Inventory Item object will be created for the item(s) in the listing, and this object will be accessible through the Inventory API
  • An Offer object will be created for the listing, and this object will be accessible through the Inventory API
  • An Inventory Location object will be created and associated with the Offer object, as an Inventory Location must be associated with a published Offer
The response payload of the Bulk Migrate Listings call will show the results of each listing migration. These results include an HTTP status code to indicate the success or failure of each listing migration, the SKU value associated with each item, and if the migration is successful, an Offer ID value. The SKU value will be used in the Inventory API to manage the Inventory Item object, and the Offer ID value will be used in the Inventory API to manage the Offer object. Errors and/or warnings containers will be returned for each listing where an error and/or warning occurred with the attempted migration.

If a multiple-variation listing is successfully migrated, along with the Offer and Inventory Location objects, an Inventory Item object will be created for each product variation within the listing, and an Inventory Item Group object will also be created, grouping those variations together in the Inventory API platform. For a motor vehicle part or accessory listing that has a specified list of compatible vehicles, in addition to the Inventory Item, Inventory Location, and Offer objects that are created, a Product Compatibility object will also be created in the Inventory API platform. + operationId: bulkMigrateListing requestBody: - description: "Details of the listings that needs to be migrated into Inventory" + description: Details of the listings that needs to be migrated into Inventory content: application/json: schema: - description: "Details of the listings that needs to be migrated into\ - \ Inventory" - $ref: "#/components/schemas/BulkMigrateListing" + description: Details of the listings that needs to be migrated into Inventory + $ref: '#/components/schemas/BulkMigrateListing' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/BulkMigrateListingResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/BulkMigrateListingResponse' + '207': + description: Multi-Status + '400': + description: Bad Request x-response-codes: errors: - 25718: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot migrate listing. {additionalInfo}" - 500: - description: "Internal Server Error" + '25718': + domain: API_INVENTORY + category: REQUEST + description: Cannot migrate listing. {additionalInfo} + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 207: - description: "Multi-Status" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /bulk_create_offer: post: tags: - - "offer" - description: "This call creates multiple offers (up to 25) for specific inventory\ - \ items on a specific eBay marketplace. Although it is not a requirement for\ - \ the seller to create complete offers (with all necessary details) right\ - \ from the start, eBay recommends that the seller provide all necessary details\ - \ with this call since there is currently no bulk operation available to update\ - \ multiple offers with one call. The following fields are always required\ - \ in the request payload: sku, marketplaceId,\ - \ and (listing) format.

Other information that will\ - \ be required before a offer can be published are highlighted below:
  • Inventory\ - \ location
  • Offer price
  • Available quantity
  • eBay\ - \ listing category
  • Referenced listing policy profiles to set payment,\ - \ return, and fulfillment values/settings

Note: Though the includeCatalogProductDetails\ - \ parameter is not required to be submitted in the request, the parameter\ - \ defaults to true if omitted.

If the call is successful,\ - \ unique offerId values are returned in the response for\ - \ each successfully created offer. The offerId value will\ - \ be required for many other offer-related calls. Note that this call only\ - \ stages an offer for publishing. The seller must run either the publishOffer,\ - \ bulkPublishOffer, or publishOfferByInventoryItemGroup\ - \ call to convert offer(s) into an active single- or multiple-variation listing.

\ - \

In addition to the authorization header, which is required\ - \ for all eBay REST API calls, the bulkCreateOffer call also\ - \ requires the Content-Language header, that sets the natural\ - \ language that will be used in the field values of the request payload. For\ - \ US English, the code value passed in this header should be en-US.\ - \ To view other supported Content-Language values, and to read\ - \ more about all supported HTTP headers for eBay REST API calls, see the HTTP request\ - \ headers topic in the Using eBay RESTful APIs document.

For\ - \ those who prefer to create a single offer per call, the createOffer\ - \ method can be used instead.

" - operationId: "bulkCreateOffer" + - offer + description: 'This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace. Although it is not a requirement for the seller to create complete offers (with all necessary details) right from the start, eBay recommends that the seller provide all necessary details with this call since there is currently no bulk operation available to update multiple offers with one call. The following fields are always required in the request payload: sku, marketplaceId, and (listing) format.

Other information that will be required before a offer can be published are highlighted below:
  • Inventory location
  • Offer price
  • Available quantity
  • eBay listing category
  • Referenced listing policy profiles to set payment, return, and fulfillment values/settings

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted.

If the call is successful, unique offerId values are returned in the response for each successfully created offer. The offerId value will be required for many other offer-related calls. Note that this call only stages an offer for publishing. The seller must run either the publishOffer, bulkPublishOffer, or publishOfferByInventoryItemGroup call to convert offer(s) into an active single- or multiple-variation listing.

In addition to the authorization header, which is required for all eBay REST API calls, the bulkCreateOffer call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

For those who prefer to create a single offer per call, the createOffer method can be used instead.

' + operationId: bulkCreateOffer requestBody: - description: "Details of the offer for the channel" + description: Details of the offer for the channel content: application/json: schema: - description: "Details of the offer for the channel" - $ref: "#/components/schemas/BulkEbayOfferDetailsWithKeys" + description: Details of the offer for the channel + $ref: '#/components/schemas/BulkEbayOfferDetailsWithKeys' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/BulkOfferResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/BulkOfferResponse' + '207': + description: Multi-Status + '400': + description: Bad Request x-response-codes: errors: - 25729: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The combination of SKU, marketplaceId and format should\ - \ be unique." - 25761: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Discount pricing is not applicable for auction offer." - 25730: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The number of offers in the request cannot exceed {additionalInfo}" - 25762: - domain: "API_INVENTORY" - category: "REQUEST" - description: "availableQuantity is not applicable for auction offer." - 25763: - domain: "API_INVENTORY" - category: "REQUEST" - description: "quantityLimitPerBuyer is not applicable for auction\ - \ offer." - 25764: - domain: "API_INVENTORY" - category: "REQUEST" - description: "eBayPlusIfEligible is not applicable for auction offer." - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "SKU {additionalInfo} is not available in the system" - 25735: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid SKU, marketplaceId or format." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid request. Invalid value for field {additionalInfo}" - 25752: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate provided is invalid." - 25755: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingDuration is required for auction offer." - 25756: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Auction format is not permitted with a SKU that is part\ - \ of an InventoryItemGroup." - 25757: - domain: "API_INVENTORY" - category: "REQUEST" - description: "auctionStartPrice is required for auction offer." - 25758: - domain: "API_INVENTORY" - category: "REQUEST" - description: "auctionStartPrice and auctionReservePrice are not supported\ - \ for fixed price offer." - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: SKU {additionalInfo} is not available in the system + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid request. Invalid value for field {additionalInfo} + '25729': + domain: API_INVENTORY + category: REQUEST + description: The combination of SKU, marketplaceId and format should be unique. + '25730': + domain: API_INVENTORY + category: REQUEST + description: The number of offers in the request cannot exceed {additionalInfo} + '25735': + domain: API_INVENTORY + category: REQUEST + description: Invalid SKU, marketplaceId or format. + '25752': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate provided is invalid. + '25755': + domain: API_INVENTORY + category: REQUEST + description: listingDuration is required for auction offer. + '25756': + domain: API_INVENTORY + category: REQUEST + description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. + '25757': + domain: API_INVENTORY + category: REQUEST + description: auctionStartPrice is required for auction offer. + '25758': + domain: API_INVENTORY + category: REQUEST + description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer. + '25761': + domain: API_INVENTORY + category: REQUEST + description: Discount pricing is not applicable for auction offer. + '25762': + domain: API_INVENTORY + category: REQUEST + description: availableQuantity is not applicable for auction offer. + '25763': + domain: API_INVENTORY + category: REQUEST + description: quantityLimitPerBuyer is not applicable for auction offer. + '25764': + domain: API_INVENTORY + category: REQUEST + description: eBayPlusIfEligible is not applicable for auction offer. + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 207: - description: "Multi-Status" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /bulk_publish_offer: post: tags: - - "offer" - description: "Note: Each listing\ - \ can be revised up to 250 times in one calendar day. If this revision threshold\ - \ is reached, the seller will be blocked from revising the item until the\ - \ next calendar day.

This call is used to convert unpublished\ - \ offers (up to 25) into published offers, or live eBay listings. The unique\ - \ identifier (offerId) of each offer to publlish is passed\ - \ into the request payload. It is possible that some unpublished offers will\ - \ be successfully created into eBay listings, but others may fail. The response\ - \ payload will show the results for each offerId value that\ - \ is passed into the request payload. The errors and warnings\ - \ containers will be returned for an offer that had one or more issues being\ - \ published.

For those who prefer to publish one offer per call,\ - \ the publishOffer method can be used instead. In the case\ - \ of a multiple-variation listing, the publishOfferByInventoryItemGroup\ - \ call should be used instead, as this call will convert all unpublished offers\ - \ associated with an inventory item group into a multiple-variation listing." - operationId: "bulkPublishOffer" + - offer + description: Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

This call is used to convert unpublished offers (up to 25) into published offers, or live eBay listings. The unique identifier (offerId) of each offer to publlish is passed into the request payload. It is possible that some unpublished offers will be successfully created into eBay listings, but others may fail. The response payload will show the results for each offerId value that is passed into the request payload. The errors and warnings containers will be returned for an offer that had one or more issues being published.

For those who prefer to publish one offer per call, the publishOffer method can be used instead. In the case of a multiple-variation listing, the publishOfferByInventoryItemGroup call should be used instead, as this call will convert all unpublished offers associated with an inventory item group into a multiple-variation listing. + operationId: bulkPublishOffer requestBody: - description: "The base request of the bulkPublishOffer method." + description: The base request of the bulkPublishOffer method. content: application/json: schema: - description: "The base request of the bulkPublishOffer\ - \ method." - $ref: "#/components/schemas/BulkOffer" + description: The base request of the bulkPublishOffer method. + $ref: '#/components/schemas/BulkOffer' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/BulkPublishResponse" + $ref: '#/components/schemas/BulkPublishResponse' x-response-codes: errors: - 25028: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable and has been dropped" - 25030: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable for the condition and has\ - \ been dropped" - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing options removed. {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25033: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Duplicate policy IDs found" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 25037: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Item level Eco Participation Fee will be ignored" - 400: - description: "Bad Request" + '25028': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable and has been dropped' + '25030': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable for the condition and has been dropped' + '25033': + domain: API_INVENTORY + category: REQUEST + description: Duplicate policy IDs found + '25037': + domain: API_INVENTORY + category: REQUEST + description: Item level Eco Participation Fee will be ignored + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing options removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '207': + description: Multi-Status + '400': + description: Bad Request x-response-codes: errors: - 25601: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25730: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The number of offers in the request cannot exceed {additionalInfo}." - 25731: - domain: "API_INVENTORY" - category: "REQUEST" - description: "OfferId should be unique in the request." - 25604: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25732: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Offers associated with SKUs that are part of a variation\ - \ group cannot be published using this endpoint." - 25752: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate provided is invalid." - 25760: - domain: "API_INVENTORY" - category: "REQUEST" - description: "shipToLocationAvailability quantity insufficient to\ - \ create auction listings." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Any User error. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid price. {additionalInfo}" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid quantity. {additionalInfo}" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid category. {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid listing option. {additionalInfo}" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Shipping policy information. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Payment policy information. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Return policy information. {additionalInfo}" - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid tax information. {additionalInfo}" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid InventoryItemGroup information. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid {fieldName}. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Missing field {fieldName}. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid package details. {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid condition information. {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limits exceeded. {additionalInfo}" - 25029: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is required for this category." - 25031: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid and needs to be a number between\ - \ {min} and {max}" - 25032: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid" - 25034: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Only {max value} policies can be specified" - 25035: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The specified policy is not found for the market place" - 25036: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The policy(ies) {PolicyId} is not of type {PolicyEnum}" - 25038: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer or is ending within 12 hours" - 25039: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25040: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25041: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, maximum\ - \ handling time must be {replaceable_value} business day(s)." - 25042: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, free\ - \ shipping must be provided." - 25043: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, returns\ - \ must be accepted." - 25044: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, refund\ - \ must be provided as Money Back." - 25045: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, the\ - \ minimum time you'll accept returns must be {replaceable_value}\ - \ days." - 25046: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, seller\ - \ must pay the cost for return shipping." - 25047: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition" - 25048: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ in this Category" - 25049: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ for the selected Brand" - 25050: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Title." - 25051: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Subtitle" - 25052: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, at\ - \ least {replaceable_value} images must be provided" - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid offerId" - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: Any User error. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: Invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: Invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: Invalid category. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: Invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: Invalid Shipping policy information. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: Invalid Payment policy information. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: Invalid Return policy information. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: Invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid InventoryItemGroup information. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: Invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: Invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: Invalid {fieldName}. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: Missing field {fieldName}. {additionalInfo} + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: Invalid package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: Invalid condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limits exceeded. {additionalInfo} + '25029': + domain: API_INVENTORY + category: REQUEST + description: '{field} is required for this category.' + '25031': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid and needs to be a number between {min} and {max}' + '25032': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid' + '25034': + domain: API_INVENTORY + category: REQUEST + description: Only {max value} policies can be specified + '25035': + domain: API_INVENTORY + category: REQUEST + description: The specified policy is not found for the market place + '25036': + domain: API_INVENTORY + category: REQUEST + description: The policy(ies) {PolicyId} is not of type {PolicyEnum} + '25038': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' + '25039': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25040': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25041': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). + '25042': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, free shipping must be provided. + '25043': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, returns must be accepted. + '25044': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, refund must be provided as Money Back. + '25045': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. + '25046': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. + '25047': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition + '25048': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition in this Category + '25049': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition for the selected Brand + '25050': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. + '25051': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle + '25052': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided + '25601': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25604': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid offerId + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '25730': + domain: API_INVENTORY + category: REQUEST + description: The number of offers in the request cannot exceed {additionalInfo}. + '25731': + domain: API_INVENTORY + category: REQUEST + description: OfferId should be unique in the request. + '25732': + domain: API_INVENTORY + category: REQUEST + description: Offers associated with SKUs that are part of a variation group cannot be published using this endpoint. + '25752': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate provided is invalid. + '25760': + domain: API_INVENTORY + category: REQUEST + description: shipToLocationAvailability quantity insufficient to create auction listings. + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of Inventory or InventoryItemGroup.\ - \ Please try again later" - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 207: - description: "Multi-Status" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of Inventory or InventoryItemGroup. Please try again later security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer: get: tags: - - "offer" - description: "This call retrieves all existing offers for the specified SKU\ - \ value. The seller has the option of limiting the offers that are retrieved\ - \ to a specific eBay marketplace, or to a listing format.

Note: At this time, the same SKU value\ - \ can not be offered across multiple eBay marketplaces, and the only supported\ - \ listing format is fixed-price, so the marketplace_id and\ - \ format query parameters currently do not have any practical\ - \ use for this call.

The authorization header\ - \ is the only required HTTP header for this call. See the HTTP request\ - \ headers section for more information.

" - operationId: "getOffers" + - offer + description: This call retrieves all existing offers for the specified SKU value. The seller has the option of limiting the offers that are retrieved to a specific eBay marketplace, or to a listing format.

Note: At this time, the same SKU value can not be offered across multiple eBay marketplaces, and the only supported listing format is fixed-price, so the marketplace_id and format query parameters currently do not have any practical use for this call.

The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information.

+ operationId: getOffers parameters: - - name: "format" - in: "query" - description: "This enumeration value sets the listing format for the offer.\ - \ This query parameter will be passed in if the seller only wants to see\ - \ offers in this specified listing format." - required: false - schema: - type: "string" - - name: "limit" - in: "query" - description: "The value passed in this query parameter sets the maximum number\ - \ of records to return per page of data. Although this field is a string,\ - \ the value passed in this field should be a positive integer value. If\ - \ this query parameter is not set, up to 100 records will be returned on\ - \ each page of results." - required: false - schema: - type: "string" - - name: "marketplace_id" - in: "query" - description: "The unique identifier of the eBay marketplace. This query parameter\ - \ will be passed in if the seller only wants to see the product's offers\ - \ on a specific eBay marketplace.

Note:\ - \ At this time, the same SKU value can not be offered across multiple eBay\ - \ marketplaces, so the marketplace_id query parameter currently\ - \ does not have any practical use for this call." - required: false - schema: - type: "string" - - name: "offset" - in: "query" - description: "The value passed in this query parameter sets the page number\ - \ to retrieve. Although this field is a string, the value passed in this\ - \ field should be a integer value equal to or greater than 0.\ - \ The first page of records has a value of 0, the second page\ - \ of records has a value of 1, and so on. If this query parameter\ - \ is not set, its value defaults to 0, and the first page of\ - \ records is returned." - required: false - schema: - type: "string" - - name: "sku" - in: "query" - description: "The seller-defined SKU value is passed in as a query parameter.\ - \ All offers associated with this product are returned in the response.

\ - \ Max length: 50." - required: false - schema: - type: "string" + - name: format + in: query + description: This enumeration value sets the listing format for the offer. This query parameter will be passed in if the seller only wants to see offers in this specified listing format. + required: false + schema: + type: string + - name: limit + in: query + description: The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be a positive integer value. If this query parameter is not set, up to 100 records will be returned on each page of results. + required: false + schema: + type: string + - name: marketplace_id + in: query + description: The unique identifier of the eBay marketplace. This query parameter will be passed in if the seller only wants to see the product's offers on a specific eBay marketplace.

Note: At this time, the same SKU value can not be offered across multiple eBay marketplaces, so the marketplace_id query parameter currently does not have any practical use for this call. + required: false + schema: + type: string + - name: offset + in: query + description: The value passed in this query parameter sets the page number to retrieve. Although this field is a string, the value passed in this field should be a integer value equal to or greater than 0. The first page of records has a value of 0, the second page of records has a value of 1, and so on. If this query parameter is not set, its value defaults to 0, and the first page of records is returned. + required: false + schema: + type: string + - name: sku + in: query + description: 'The seller-defined SKU value is passed in as a query parameter. All offers associated with this product are returned in the response.

Max length: 50.' + required: false + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/Offers" - 400: - description: "Bad Request" + $ref: '#/components/schemas/Offers' + '400': + description: Bad Request x-response-codes: errors: - 25706: - domain: "API_INVENTORY" - category: "REQUEST" - description: "You have provided invalid pagination values. {additionalInfo}." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 500: - description: "Internal Server Error" + '25706': + domain: API_INVENTORY + category: REQUEST + description: You have provided invalid pagination values. {additionalInfo}. + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory post: tags: - - "offer" - description: "This call creates an offer for a specific inventory item on a\ - \ specific eBay marketplace. It is up to the sellers whether they want to\ - \ create a complete offer (with all necessary details) right from the start,\ - \ or sellers can provide only some information with the initial createOffer\ - \ call, and then make one or more subsequent updateOffer\ - \ calls to complete the offer and prepare to publish the offer. Upon first\ - \ creating an offer, the following fields are required in the request payload:\ - \ sku, marketplaceId, and (listing) format.\ - \

Other information that will be required before an offer can be published\ - \ are highlighted below. These settings are either set with createOffer,\ - \ or they can be set with a subsequent updateOffer call:\ - \
  • Inventory location
  • Offer price
  • Available quantity
    • \ - \
  • eBay listing category
  • Referenced listing policy profiles to\ - \ set payment, return, and fulfillment values/settings

Note: Though the includeCatalogProductDetails\ - \ parameter is not required to be submitted in the request, the parameter\ - \ defaults to true if omitted.

If the call is successful,\ - \ a unique offerId value is returned in the response. This\ - \ value will be required for many other offer-related calls. Note that this\ - \ call only stages an offer for publishing. The seller must run the publishOffer\ - \ call to convert the offer to an active eBay listing.

In addition\ - \ to the authorization header, which is required for all eBay\ - \ REST API calls, the createOffer call also requires the\ - \ Content-Language header, that sets the natural language that\ - \ will be used in the field values of the request payload. For US English,\ - \ the code value passed in this header should be en-US. To view\ - \ other supported Content-Language values, and to read more about\ - \ all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs\ - \ document.

For those who prefer to create multiple offers (up to 25\ - \ at a time) with one call, the bulkCreateOffer method can\ - \ be used.

" - operationId: "createOffer" + - offer + description: 'This call creates an offer for a specific inventory item on a specific eBay marketplace. It is up to the sellers whether they want to create a complete offer (with all necessary details) right from the start, or sellers can provide only some information with the initial createOffer call, and then make one or more subsequent updateOffer calls to complete the offer and prepare to publish the offer. Upon first creating an offer, the following fields are required in the request payload: sku, marketplaceId, and (listing) format.

Other information that will be required before an offer can be published are highlighted below. These settings are either set with createOffer, or they can be set with a subsequent updateOffer call:
  • Inventory location
  • Offer price
  • Available quantity
  • eBay listing category
  • Referenced listing policy profiles to set payment, return, and fulfillment values/settings

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted.

If the call is successful, a unique offerId value is returned in the response. This value will be required for many other offer-related calls. Note that this call only stages an offer for publishing. The seller must run the publishOffer call to convert the offer to an active eBay listing.

In addition to the authorization header, which is required for all eBay REST API calls, the createOffer call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

For those who prefer to create multiple offers (up to 25 at a time) with one call, the bulkCreateOffer method can be used.

' + operationId: createOffer parameters: - - name: "Content-Language" - in: "header" - description: "This request header sets the natural language that will be provided\ - \ in the field values of the request payload." - required: true - schema: - type: "string" + - name: Content-Language + in: header + description: This request header sets the natural language that will be provided in the field values of the request payload. + required: true + schema: + type: string requestBody: - description: "Details of the offer for the channel" + description: Details of the offer for the channel content: application/json: schema: - description: "Details of the offer for the channel" - $ref: "#/components/schemas/EbayOfferDetailsWithKeys" + description: Details of the offer for the channel + $ref: '#/components/schemas/EbayOfferDetailsWithKeys' required: true responses: - 201: - description: "Created" + '201': + description: Created headers: Content-Language: schema: - type: "string" - description: "This response header sets the natural language that\ - \ will be provided in the field values of the response payload." + type: string + description: This response header sets the natural language that will be provided in the field values of the response payload. content: application/json: schema: - $ref: "#/components/schemas/OfferResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/OfferResponse' + '400': + description: Bad Request x-response-codes: errors: - 25761: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Discount pricing is not applicable for auction offer." - 25762: - domain: "API_INVENTORY" - category: "REQUEST" - description: "availableQuantity is not applicable for auction offer." - 25763: - domain: "API_INVENTORY" - category: "REQUEST" - description: "quantityLimitPerBuyer is not applicable for auction\ - \ offer." - 25764: - domain: "API_INVENTORY" - category: "REQUEST" - description: "eBayPlusIfEligible is not applicable for auction offer." - 25702: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{skuValue} could not be found or is not available in\ - \ the system." - 25752: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate provided is invalid." - 25755: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingDuration is required for auction offer." - 25756: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Auction format is not permitted with a SKU that is part\ - \ of an InventoryItemGroup." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 25757: - domain: "API_INVENTORY" - category: "REQUEST" - description: "auctionStartPrice is required for auction offer." - 25758: - domain: "API_INVENTORY" - category: "REQUEST" - description: "auctionStartPrice and auctionReservePrice are not supported\ - \ for fixed price offer." - 500: - description: "Internal Server Error" + '25702': + domain: API_INVENTORY + category: REQUEST + description: '{skuValue} could not be found or is not available in the system.' + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25752': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate provided is invalid. + '25755': + domain: API_INVENTORY + category: REQUEST + description: listingDuration is required for auction offer. + '25756': + domain: API_INVENTORY + category: REQUEST + description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. + '25757': + domain: API_INVENTORY + category: REQUEST + description: auctionStartPrice is required for auction offer. + '25758': + domain: API_INVENTORY + category: REQUEST + description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer. + '25761': + domain: API_INVENTORY + category: REQUEST + description: Discount pricing is not applicable for auction offer. + '25762': + domain: API_INVENTORY + category: REQUEST + description: availableQuantity is not applicable for auction offer. + '25763': + domain: API_INVENTORY + category: REQUEST + description: quantityLimitPerBuyer is not applicable for auction offer. + '25764': + domain: API_INVENTORY + category: REQUEST + description: eBayPlusIfEligible is not applicable for auction offer. + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/{offerId}: get: tags: - - "offer" - description: "This call retrieves a specific published or unpublished offer.\ - \ The unique identifier of the offer (offerId) is passed\ - \ in at the end of the call URI.

The authorization header is\ - \ the only required HTTP header for this call. See the HTTP request\ - \ headers section for more information.

" - operationId: "getOffer" + - offer + description: This call retrieves a specific published or unpublished offer. The unique identifier of the offer (offerId) is passed in at the end of the call URI.

The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information.

+ operationId: getOffer parameters: - - name: "offerId" - in: "path" - description: "The unique identifier of the offer that is to be retrieved." - required: true - schema: - type: "string" + - name: offerId + in: path + description: The unique identifier of the offer that is to be retrieved. + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/EbayOfferDetailsWithAll" - 400: - description: "Bad Request" + $ref: '#/components/schemas/EbayOfferDetailsWithAll' + '400': + description: Bad Request x-response-codes: errors: - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 500: - description: "Internal Server Error" + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory put: tags: - - "offer" - description: "This call updates an existing offer. An existing offer may be\ - \ in published state (active eBay listing), or in an unpublished state and\ - \ yet to be published with the publishOffer call. The unique\ - \ identifier (offerId) for the offer to update is passed\ - \ in at the end of the call URI.

The updateOffer\ - \ call does a complete replacement of the existing offer object, so all fields\ - \ that make up the current offer object are required, regardless of whether\ - \ their values changed.

Other information that is required before\ - \ an unpublished offer can be published or before a published offer can be\ - \ revised include:
  • Inventory location
  • Offer price
  • Available\ - \ quantity
  • eBay listing category
  • Referenced listing policy\ - \ profiles to set payment, return, and fulfillment values/settings
\ - \

Note: Though the includeCatalogProductDetails\ - \ parameter is not required to be submitted in the request, the parameter\ - \ defaults to true if omitted from both the updateOffer\ - \ and the createOffer calls. If a value is specified in the\ - \ updateOffer call, this value will be used.
Note: Each listing can be revised\ - \ up to 250 times in one calendar day. If this revision threshold is reached,\ - \ the seller will be blocked from revising the item until the next calendar\ - \ day.

For published offers, the listingDescription\ - \ field is also required to update the offer/eBay listing. For unpublished\ - \ offers, this field is not necessarily required unless it is already set\ - \ for the unpublished offer.

In addition to the authorization\ - \ header, which is required for all eBay REST API calls, the updateOffer\ - \ call also requires the Content-Language header, that sets the\ - \ natural language that will be used in the field values of the request payload.\ - \ For US English, the code value passed in this header should be en-US.\ - \ To view other supported Content-Language values, and to read\ - \ more about all supported HTTP headers for eBay REST API calls, see the HTTP request\ - \ headers topic in the Using eBay RESTful APIs document.

" - operationId: "updateOffer" + - offer + description: 'This call updates an existing offer. An existing offer may be in published state (active eBay listing), or in an unpublished state and yet to be published with the publishOffer call. The unique identifier (offerId) for the offer to update is passed in at the end of the call URI.

The updateOffer call does a complete replacement of the existing offer object, so all fields that make up the current offer object are required, regardless of whether their values changed.

Other information that is required before an unpublished offer can be published or before a published offer can be revised include:
  • Inventory location
  • Offer price
  • Available quantity
  • eBay listing category
  • Referenced listing policy profiles to set payment, return, and fulfillment values/settings

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted from both the updateOffer and the createOffer calls. If a value is specified in the updateOffer call, this value will be used.

Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

For published offers, the listingDescription field is also required to update the offer/eBay listing. For unpublished offers, this field is not necessarily required unless it is already set for the unpublished offer.

In addition to the authorization header, which is required for all eBay REST API calls, the updateOffer call also requires the Content-Language header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US. To view other supported Content-Language values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.

' + operationId: updateOffer parameters: - - name: "Content-Language" - in: "header" - description: "This request header sets the natural language that will be provided\ - \ in the field values of the request payload." - required: true - schema: - type: "string" - - name: "offerId" - in: "path" - description: "The unique identifier of the offer that is being updated. This\ - \ identifier is passed in at the end of the call URI." - required: true - schema: - type: "string" + - name: Content-Language + in: header + description: This request header sets the natural language that will be provided in the field values of the request payload. + required: true + schema: + type: string + - name: offerId + in: path + description: The unique identifier of the offer that is being updated. This identifier is passed in at the end of the call URI. + required: true + schema: + type: string requestBody: - description: "Details of the offer for the channel" + description: Details of the offer for the channel content: application/json: schema: - description: "Details of the offer for the channel" - $ref: "#/components/schemas/EbayOfferDetailsWithId" + description: Details of the offer for the channel + $ref: '#/components/schemas/EbayOfferDetailsWithId' required: true responses: - 200: - description: "Success" + '200': + description: Success headers: Content-Language: schema: - type: "string" - description: "This response header sets the natural language that\ - \ will be provided in the field values of the response payload." + type: string + description: This response header sets the natural language that will be provided in the field values of the response payload. content: application/json: schema: - $ref: "#/components/schemas/OfferResponse" + $ref: '#/components/schemas/OfferResponse' x-response-codes: errors: - 25028: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable and has been dropped" - 25030: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable for the condition and has\ - \ been dropped" - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing options removed. {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25033: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Duplicate policy IDs found" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 25037: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Item level Eco Participation Fee will be ignored" - 400: - description: "Bad Request" + '25028': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable and has been dropped' + '25030': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable for the condition and has been dropped' + '25033': + domain: API_INVENTORY + category: REQUEST + description: Duplicate policy IDs found + '25037': + domain: API_INVENTORY + category: REQUEST + description: Item level Eco Participation Fee will be ignored + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing options removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25601: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limit exceeded. {additionalInfo}" - 25604: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25029: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is required for this category." - 25031: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid and needs to be a number between\ - \ {min} and {max}" - 25032: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid" - 25034: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Only {max value} policies can be specified" - 25035: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The specified policy is not found for the market place" - 25036: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The policy(ies) {PolicyId} is not of type {PolicyEnum}" - 25038: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer or is ending within 12 hours" - 25039: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25040: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25752: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate provided is invalid." - 25756: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Auction format is not permitted with a SKU that is part\ - \ of an InventoryItemGroup." - 25757: - domain: "API_INVENTORY" - category: "REQUEST" - description: "auctionStartPrice is required for auction offer." - 25758: - domain: "API_INVENTORY" - category: "REQUEST" - description: "auctionStartPrice and auctionReservePrice are not supported\ - \ for fixed price offer." - 25761: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Discount pricing is not applicable for auction offer." - 25762: - domain: "API_INVENTORY" - category: "REQUEST" - description: "availableQuantity is not applicable for auction offer." - 25763: - domain: "API_INVENTORY" - category: "REQUEST" - description: "quantityLimitPerBuyer is not applicable for auction\ - \ offer." - 25764: - domain: "API_INVENTORY" - category: "REQUEST" - description: "eBayPlusIfEligible is not applicable for auction offer." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "A user error has occurred. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid price. {additionalInfo}" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid quantity. {additionalInfo}" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid category ID. {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid listing option. {additionalInfo}" - 25710: - domain: "API_INVENTORY" - category: "REQUEST" - description: "We didn't find the resource/entity you are requesting.\ - \ Please verify the request" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Fulfillment\ - \ policy. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Payment\ - \ policy. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Return\ - \ policy. {additionalInfo}" - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid tax information. {additionalInfo}" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid inventory location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid data in the Inventory Item Group. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The {fieldName} value is invalid. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is missing. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid shipping package details.\ - \ {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid item condition information.\ - \ {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: A user error has occurred. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid inventory location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid data in the Inventory Item Group. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: The {fieldName} value is invalid. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is missing. {additionalInfo}' + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limit exceeded. {additionalInfo} + '25029': + domain: API_INVENTORY + category: REQUEST + description: '{field} is required for this category.' + '25031': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid and needs to be a number between {min} and {max}' + '25032': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid' + '25034': + domain: API_INVENTORY + category: REQUEST + description: Only {max value} policies can be specified + '25035': + domain: API_INVENTORY + category: REQUEST + description: The specified policy is not found for the market place + '25036': + domain: API_INVENTORY + category: REQUEST + description: The policy(ies) {PolicyId} is not of type {PolicyEnum} + '25038': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' + '25039': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25040': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25601': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25604': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25710': + domain: API_INVENTORY + category: REQUEST + description: We didn't find the resource/entity you are requesting. Please verify the request + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '25752': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate provided is invalid. + '25756': + domain: API_INVENTORY + category: REQUEST + description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. + '25757': + domain: API_INVENTORY + category: REQUEST + description: auctionStartPrice is required for auction offer. + '25758': + domain: API_INVENTORY + category: REQUEST + description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer. + '25761': + domain: API_INVENTORY + category: REQUEST + description: Discount pricing is not applicable for auction offer. + '25762': + domain: API_INVENTORY + category: REQUEST + description: availableQuantity is not applicable for auction offer. + '25763': + domain: API_INVENTORY + category: REQUEST + description: quantityLimitPerBuyer is not applicable for auction offer. + '25764': + domain: API_INVENTORY + category: REQUEST + description: eBayPlusIfEligible is not applicable for auction offer. + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of the same Inventory or Inventory\ - \ Item Group object is not allowed. Please try again later." - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory delete: tags: - - "offer" - description: "If used against an unpublished offer, this call will permanently\ - \ delete that offer. In the case of a published offer (or live eBay listing),\ - \ a successful call will either end the single-variation listing associated\ - \ with the offer, or it will remove that product variation from the eBay listing\ - \ and also automatically remove that product variation from the inventory\ - \ item group. In the case of a multiple-variation listing, the deleteOffer\ - \ will not remove the product variation from the listing if that variation\ - \ has one or more sales. If that product variation has one or more sales,\ - \ the seller can alternately just set the available quantity of that product\ - \ variation to 0, so it is not available in the eBay search or\ - \ View Item page, and then the seller can remove that product variation from\ - \ the inventory item group at a later time." - operationId: "deleteOffer" + - offer + description: If used against an unpublished offer, this call will permanently delete that offer. In the case of a published offer (or live eBay listing), a successful call will either end the single-variation listing associated with the offer, or it will remove that product variation from the eBay listing and also automatically remove that product variation from the inventory item group. In the case of a multiple-variation listing, the deleteOffer will not remove the product variation from the listing if that variation has one or more sales. If that product variation has one or more sales, the seller can alternately just set the available quantity of that product variation to 0, so it is not available in the eBay search or View Item page, and then the seller can remove that product variation from the inventory item group at a later time. + operationId: deleteOffer parameters: - - name: "offerId" - in: "path" - description: "The unique identifier of the offer to delete. The unique identifier\ - \ of the offer (offerId) is passed in at the end of the\ - \ call URI." - required: true - schema: - type: "string" + - name: offerId + in: path + description: The unique identifier of the offer to delete. The unique identifier of the offer (offerId) is passed in at the end of the call URI. + required: true + schema: + type: string responses: - 400: - description: "Bad Request" + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 500: - description: "Internal Server Error" + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 204: - description: "No Content" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/get_listing_fees: post: tags: - - "offer" - description: "This call is used to retrieve the expected listing fees for up\ - \ to 250 unpublished offers. An array of one or more offerId\ - \ values are passed in under the offers container.

\ - \ In the response payload, all listing fees are grouped by eBay marketplace,\ - \ and listing fees per offer are not shown. A fees container\ - \ will be returned for each eBay marketplace where the seller is selling the\ - \ products associated with the specified offers.

Errors will occur\ - \ if the seller passes in offerIds that represent published\ - \ offers, so this call should be made before the seller publishes offers with\ - \ the publishOffer." - operationId: "getListingFees" + - offer + description: This call is used to retrieve the expected listing fees for up to 250 unpublished offers. An array of one or more offerId values are passed in under the offers container.

In the response payload, all listing fees are grouped by eBay marketplace, and listing fees per offer are not shown. A fees container will be returned for each eBay marketplace where the seller is selling the products associated with the specified offers.

Errors will occur if the seller passes in offerIds that represent published offers, so this call should be made before the seller publishes offers with the publishOffer. + operationId: getListingFees requestBody: - description: "List of offers that needs fee information" + description: List of offers that needs fee information content: application/json: schema: - description: "List of offers that needs fee information" - $ref: "#/components/schemas/OfferKeysWithId" + description: List of offers that needs fee information + $ref: '#/components/schemas/OfferKeysWithId' required: false responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/FeesSummaryResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/FeesSummaryResponse' + '400': + description: Bad Request x-response-codes: errors: - 25754: - domain: "API_INVENTORY" - category: "REQUEST" - description: "One or more provided offerId(s) are invalid. All offerId(s)\ - \ in the request should belong to an inventoryItem or inventoryItemGroup\ - \ for a specific marketplaceId and format." - 25709: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid value for {fieldName}. {additionalInfo}" - 500: - description: "Internal Server Error" + '25709': + domain: API_INVENTORY + category: REQUEST + description: Invalid value for {fieldName}. {additionalInfo} + '25754': + domain: API_INVENTORY + category: REQUEST + description: One or more provided offerId(s) are invalid. All offerId(s) in the request should belong to an inventoryItem or inventoryItemGroup for a specific marketplaceId and format. + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/{offerId}/publish/: post: tags: - - "offer" - description: "Note: Each listing\ - \ can be revised up to 250 times in one calendar day. If this revision threshold\ - \ is reached, the seller will be blocked from revising the item until the\ - \ next calendar day.

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

For those who prefer to publish multiple offers (up to 25\ - \ at a time) with one call, the bulkPublishOffer method can\ - \ be used. In the case of a multiple-variation listing, the publishOfferByInventoryItemGroup\ - \ call should be used instead, as this call will convert all unpublished offers\ - \ associated with an inventory item group into a multiple-variation listing." - operationId: "publishOffer" + - offer + description: Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

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

For those who prefer to publish multiple offers (up to 25 at a time) with one call, the bulkPublishOffer method can be used. In the case of a multiple-variation listing, the publishOfferByInventoryItemGroup call should be used instead, as this call will convert all unpublished offers associated with an inventory item group into a multiple-variation listing. + operationId: publishOffer parameters: - - name: "offerId" - in: "path" - description: "The unique identifier of the offer that is to be published." - required: true - schema: - type: "string" + - name: offerId + in: path + description: The unique identifier of the offer that is to be published. + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/PublishResponse" + $ref: '#/components/schemas/PublishResponse' x-response-codes: errors: - 25028: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable and has been dropped" - 25030: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable for the condition and has\ - \ been dropped" - 25401: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid listing format removed {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25033: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Duplicate policy IDs found" - 25402: - domain: "API_INVENTORY" - category: "REQUEST" - description: "System warning. {additionalInfo}" - 25037: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Item level Eco Participation Fee will be ignored" - 400: - description: "Bad Request" + '25028': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable and has been dropped' + '25030': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable for the condition and has been dropped' + '25033': + domain: API_INVENTORY + category: REQUEST + description: Duplicate policy IDs found + '25037': + domain: API_INVENTORY + category: REQUEST + description: Item level Eco Participation Fee will be ignored + '25401': + domain: API_INVENTORY + category: REQUEST + description: Invalid listing format removed {additionalInfo} + '25402': + domain: API_INVENTORY + category: REQUEST + description: System warning. {additionalInfo} + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '400': + description: Bad Request x-response-codes: errors: - 25601: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is an invalid attribute." - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limit exceeded. {additionalInfo}" - 25604: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25029: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is required for this category." - 25031: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid and needs to be a number between\ - \ {min} and {max}" - 25032: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid" - 25034: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Only {max value} policies can be specified" - 25035: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The specified policy is not found for the market place" - 25036: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The policy(ies) {PolicyId} is not of type {PolicyEnum}" - 25038: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer or is ending within 12 hours" - 25039: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25040: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25041: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, maximum\ - \ handling time must be {replaceable_value} business day(s)." - 25042: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, free\ - \ shipping must be provided." - 25043: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, returns\ - \ must be accepted." - 25044: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, refund\ - \ must be provided as Money Back." - 25045: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, the\ - \ minimum time you'll accept returns must be {replaceable_value}\ - \ days." - 25046: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, seller\ - \ must pay the cost for return shipping." - 25047: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition" - 25752: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate provided is invalid." - 25048: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ in this Category" - 25049: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ for the selected Brand" - 25050: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Title." - 25051: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Subtitle" - 25052: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, at\ - \ least {replaceable_value} images must be provided" - 25760: - domain: "API_INVENTORY" - category: "REQUEST" - description: "shipToLocationAvailability quantity insufficient to\ - \ create auction listings." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "A user error has occurred. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid price. {additionalInfo}" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid quantity. {additionalInfo}" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid category ID. {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid listing option. {additionalInfo}" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Fulfillment\ - \ policy. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Payment\ - \ policy. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid data in the associated Return\ - \ policy. {additionalInfo}" - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid tax information. {additionalInfo}" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid inventory location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid data in the Inventory Item Group. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has an invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The {fieldName} value is invalid. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} is missing. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid shipping package details.\ - \ {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The eBay listing associated with the inventory item,\ - \ or the unpublished offer has invalid item condition information.\ - \ {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: A user error has occurred. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: Invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid inventory location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid data in the Inventory Item Group. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: The {fieldName} value is invalid. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is missing. {additionalInfo}' + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limit exceeded. {additionalInfo} + '25029': + domain: API_INVENTORY + category: REQUEST + description: '{field} is required for this category.' + '25031': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid and needs to be a number between {min} and {max}' + '25032': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid' + '25034': + domain: API_INVENTORY + category: REQUEST + description: Only {max value} policies can be specified + '25035': + domain: API_INVENTORY + category: REQUEST + description: The specified policy is not found for the market place + '25036': + domain: API_INVENTORY + category: REQUEST + description: The policy(ies) {PolicyId} is not of type {PolicyEnum} + '25038': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' + '25039': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25040': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25041': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). + '25042': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, free shipping must be provided. + '25043': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, returns must be accepted. + '25044': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, refund must be provided as Money Back. + '25045': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. + '25046': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. + '25047': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition + '25048': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition in this Category + '25049': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition for the selected Brand + '25050': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. + '25051': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle + '25052': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided + '25601': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} is an invalid attribute.' + '25604': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '25752': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate provided is invalid. + '25760': + domain: API_INVENTORY + category: REQUEST + description: shipToLocationAvailability quantity insufficient to create auction listings. + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of the same Inventory or Inventory\ - \ Item Group object is not allowed. Please try again later." - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "A system error has occurred. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: A system error has occurred. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/publish_by_inventory_item_group/: post: tags: - - "offer" - description: "Note: Please note that\ - \ any eBay listing created using the Inventory API cannot be revised or relisted\ - \ using the Trading API calls.

Note:\ - \ Each listing can be revised up to 250 times in one calendar day. If this\ - \ revision threshold is reached, the seller will be blocked from revising\ - \ the item until the next calendar day.

This call is used\ - \ to convert all unpublished offers associated with an inventory item group\ - \ into an active, multiple-variation listing.

The unique identifier\ - \ of the inventory item group (inventoryItemGroupKey) is\ - \ passed in the request payload. All inventory items and their corresponding\ - \ offers in the inventory item group must be valid (meet all requirements)\ - \ for the publishOfferByInventoryItemGroup call to be completely\ - \ successful. For any inventory items in the group that are missing required\ - \ data or have no corresponding offers, the publishOfferByInventoryItemGroup\ - \ will create a new multiple-variation listing, but any inventory items with\ - \ missing required data/offers will not be in the newly-created listing. If\ - \ any inventory items in the group to be published have invalid data, or one\ - \ or more of the inventory items have conflicting data with one another, the\ - \ publishOfferByInventoryItemGroup call will fail. Be sure\ - \ to check for any error or warning messages in the call response for any\ - \ applicable information about one or more inventory items/offers having issues." - operationId: "publishOfferByInventoryItemGroup" + - offer + description: Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.

Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.

This call is used to convert all unpublished offers associated with an inventory item group into an active, multiple-variation listing.

The unique identifier of the inventory item group (inventoryItemGroupKey) is passed in the request payload. All inventory items and their corresponding offers in the inventory item group must be valid (meet all requirements) for the publishOfferByInventoryItemGroup call to be completely successful. For any inventory items in the group that are missing required data or have no corresponding offers, the publishOfferByInventoryItemGroup will create a new multiple-variation listing, but any inventory items with missing required data/offers will not be in the newly-created listing. If any inventory items in the group to be published have invalid data, or one or more of the inventory items have conflicting data with one another, the publishOfferByInventoryItemGroup call will fail. Be sure to check for any error or warning messages in the call response for any applicable information about one or more inventory items/offers having issues. + operationId: publishOfferByInventoryItemGroup requestBody: - description: "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." + description: 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. content: application/json: schema: - description: "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." - $ref: "#/components/schemas/PublishByInventoryItemGroupRequest" + description: 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. + $ref: '#/components/schemas/PublishByInventoryItemGroupRequest' required: true responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/PublishResponse" + $ref: '#/components/schemas/PublishResponse' x-response-codes: errors: - 25028: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable and has been dropped" - 25030: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not applicable for the condition and has\ - \ been dropped" - 25401: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Invalid listing options removed. {additionalInfo}" - 25753: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate is in the past or the offer is live.\ - \ Value is not updated on the listing." - 25033: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Duplicate policy IDs found" - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 25037: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Item level Eco Participation Fee will be ignored" - 400: - description: "Bad Request" + '25028': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable and has been dropped' + '25030': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not applicable for the condition and has been dropped' + '25033': + domain: API_INVENTORY + category: REQUEST + description: Duplicate policy IDs found + '25037': + domain: API_INVENTORY + category: REQUEST + description: Item level Eco Participation Fee will be ignored + '25401': + domain: API_INVENTORY + category: APPLICATION + description: Invalid listing options removed. {additionalInfo} + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '25753': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. + '400': + description: Bad Request x-response-codes: errors: - 25601: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25026: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Selling limits exceeded. {additionalInfo}" - 25604: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25029: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is required for this category." - 25031: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid and needs to be a number between\ - \ {min} and {max}" - 25032: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{field} is not valid" - 25034: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Only {max value} policies can be specified" - 25035: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The specified policy is not found for the market place" - 25036: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The policy(ies) {PolicyId} is not of type {PolicyEnum}" - 25038: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer or is ending within 12 hours" - 25039: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25040: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{ItemId} cannot be revised if the item has a bid or\ - \ a best offer and is ending within 12 hours" - 25041: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, maximum\ - \ handling time must be {replaceable_value} business day(s)." - 25042: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, free\ - \ shipping must be provided." - 25043: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, returns\ - \ must be accepted." - 25044: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, refund\ - \ must be provided as Money Back." - 25045: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, the\ - \ minimum time you'll accept returns must be {replaceable_value}\ - \ days." - 25046: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, seller\ - \ must pay the cost for return shipping." - 25047: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition" - 25752: - domain: "API_INVENTORY" - category: "REQUEST" - description: "listingStartDate provided is invalid." - 25048: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ in this Category" - 25049: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Seller is not eligible to use Refurbished Item Condition\ - \ for the selected Brand" - 25050: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Title." - 25051: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, {replaceable_value}\ - \ cannot be used in the Subtitle" - 25052: - domain: "API_INVENTORY" - category: "REQUEST" - description: "When listing an item with Refurbished condition, at\ - \ least {replaceable_value} images must be provided" - 25705: - domain: "API_INVENTORY" - category: "REQUEST" - description: "The Inventory Item Group named {inventoryItemGroupKey}\ - \ could not be found or is not available in the system." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Any User error. {additionalInfo}" - 25003: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid price. {additionalInfo}" - 25004: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid quantity. {additionalInfo}" - 25005: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid category. {additionalInfo}" - 25006: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid listing option. {additionalInfo}" - 25007: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Shipping policy information. {additionalInfo}" - 25008: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Payment policy information. {additionalInfo}" - 25009: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid Return policy information. {additionalInfo}" - 25011: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid tax information. {additionalInfo}" - 25012: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid location. {additionalInfo}" - 25013: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid InventoryItemGroup information. {additionalInfo}" - 25014: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid pictures. {additionalInfo}" - 25015: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid picture URL. {additionalInfo}" - 25016: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid {fieldName}. {additionalInfo}" - 25017: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Missing field {fieldName}. {additionalInfo}" - 25018: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Incomplete account information. {additionalInfo}" - 25019: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Cannot revise listing. {additionalInfo}" - 25020: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid package details. {additionalInfo}" - 25021: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid condition information. {additionalInfo}" - 25022: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid attribute. {fieldName}" - 25023: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid compatibility information. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: Any User error. {additionalInfo} + '25003': + domain: API_INVENTORY + category: REQUEST + description: Invalid price. {additionalInfo} + '25004': + domain: API_INVENTORY + category: REQUEST + description: Invalid quantity. {additionalInfo} + '25005': + domain: API_INVENTORY + category: REQUEST + description: Invalid category. {additionalInfo} + '25006': + domain: API_INVENTORY + category: REQUEST + description: Invalid listing option. {additionalInfo} + '25007': + domain: API_INVENTORY + category: REQUEST + description: Invalid Shipping policy information. {additionalInfo} + '25008': + domain: API_INVENTORY + category: REQUEST + description: Invalid Payment policy information. {additionalInfo} + '25009': + domain: API_INVENTORY + category: REQUEST + description: Invalid Return policy information. {additionalInfo} + '25011': + domain: API_INVENTORY + category: REQUEST + description: Invalid tax information. {additionalInfo} + '25012': + domain: API_INVENTORY + category: REQUEST + description: Invalid location. {additionalInfo} + '25013': + domain: API_INVENTORY + category: REQUEST + description: Invalid InventoryItemGroup information. {additionalInfo} + '25014': + domain: API_INVENTORY + category: REQUEST + description: Invalid pictures. {additionalInfo} + '25015': + domain: API_INVENTORY + category: REQUEST + description: Invalid picture URL. {additionalInfo} + '25016': + domain: API_INVENTORY + category: REQUEST + description: Invalid {fieldName}. {additionalInfo} + '25017': + domain: API_INVENTORY + category: REQUEST + description: Missing field {fieldName}. {additionalInfo} + '25018': + domain: API_INVENTORY + category: REQUEST + description: Incomplete account information. {additionalInfo} + '25019': + domain: API_INVENTORY + category: REQUEST + description: Cannot revise listing. {additionalInfo} + '25020': + domain: API_INVENTORY + category: REQUEST + description: Invalid package details. {additionalInfo} + '25021': + domain: API_INVENTORY + category: REQUEST + description: Invalid condition information. {additionalInfo} + '25022': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25023': + domain: API_INVENTORY + category: REQUEST + description: Invalid compatibility information. {additionalInfo} + '25026': + domain: API_INVENTORY + category: REQUEST + description: Selling limits exceeded. {additionalInfo} + '25029': + domain: API_INVENTORY + category: REQUEST + description: '{field} is required for this category.' + '25031': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid and needs to be a number between {min} and {max}' + '25032': + domain: API_INVENTORY + category: REQUEST + description: '{field} is not valid' + '25034': + domain: API_INVENTORY + category: REQUEST + description: Only {max value} policies can be specified + '25035': + domain: API_INVENTORY + category: REQUEST + description: The specified policy is not found for the market place + '25036': + domain: API_INVENTORY + category: REQUEST + description: The policy(ies) {PolicyId} is not of type {PolicyEnum} + '25038': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' + '25039': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25040': + domain: API_INVENTORY + category: REQUEST + description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' + '25041': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). + '25042': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, free shipping must be provided. + '25043': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, returns must be accepted. + '25044': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, refund must be provided as Money Back. + '25045': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. + '25046': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. + '25047': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition + '25048': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition in this Category + '25049': + domain: API_INVENTORY + category: REQUEST + description: Seller is not eligible to use Refurbished Item Condition for the selected Brand + '25050': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. + '25051': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle + '25052': + domain: API_INVENTORY + category: REQUEST + description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided + '25601': + domain: API_INVENTORY + category: REQUEST + description: Invalid attribute. {fieldName} + '25604': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25705': + domain: API_INVENTORY + category: REQUEST + description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system. + '25752': + domain: API_INVENTORY + category: REQUEST + description: listingStartDate provided is invalid. + '500': + description: Internal Server Error x-response-codes: errors: - 25025: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Concurrent access of Inventory or InventoryItemGroup.\ - \ Please try again later" - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} + '25025': + domain: API_INVENTORY + category: APPLICATION + description: Concurrent access of Inventory or InventoryItemGroup. Please try again later security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/{offerId}/withdraw: post: tags: - - "offer" - description: "This call is used to end a single-variation listing that is associated\ - \ with the specified offer. This call is used in place of the deleteOffer\ - \ call if the seller only wants to end the listing associated with the offer\ - \ but does not want to delete the offer object. With this call, the offer\ - \ object remains, but it goes into the unpublished state, and will require\ - \ a publishOffer call to relist the offer.

To end\ - \ a multiple-variation listing that is associated with an inventory item group,\ - \ the withdrawOfferByInventoryItemGroup method can be used.\ - \ This call only ends the multiple-variation listing associated with an inventory\ - \ item group but does not delete the inventory item group object, nor does\ - \ it delete any of the offers associated with the inventory item group, but\ - \ instead all of these offers go into the unpublished state." - operationId: "withdrawOffer" + - offer + description: This call is used to end a single-variation listing that is associated with the specified offer. This call is used in place of the deleteOffer call if the seller only wants to end the listing associated with the offer but does not want to delete the offer object. With this call, the offer object remains, but it goes into the unpublished state, and will require a publishOffer call to relist the offer.

To end a multiple-variation listing that is associated with an inventory item group, the withdrawOfferByInventoryItemGroup method can be used. This call only ends the multiple-variation listing associated with an inventory item group but does not delete the inventory item group object, nor does it delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state. + operationId: withdrawOffer parameters: - - name: "offerId" - in: "path" - description: "The unique identifier of the offer that is to be withdrawn.\ - \ This value is passed into the path of the call URI." - required: true - schema: - type: "string" + - name: offerId + in: path + description: The unique identifier of the offer that is to be withdrawn. This value is passed into the path of the call URI. + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/WithdrawResponse" + $ref: '#/components/schemas/WithdrawResponse' x-response-codes: errors: - 25402: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System warning. {additionalInfo}" - 400: - description: "Bad Request" + '25402': + domain: API_INVENTORY + category: APPLICATION + description: System warning. {additionalInfo} + '400': + description: Bad Request x-response-codes: errors: - 25713: - domain: "API_INVENTORY" - category: "REQUEST" - description: "This Offer is not available : {additionalInfo}." - 25002: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Any User error. {additionalInfo}" - 500: - description: "Internal Server Error" + '25002': + domain: API_INVENTORY + category: REQUEST + description: Any User error. {additionalInfo} + '25713': + domain: API_INVENTORY + category: REQUEST + description: 'This Offer is not available : {additionalInfo}.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/withdraw_by_inventory_item_group: post: tags: - - "offer" - description: "This call is used to end a multiple-variation eBay listing that\ - \ is associated with the specified inventory item group. This call only ends\ - \ multiple-variation eBay listing associated with the inventory item group\ - \ but does not delete the inventory item group object. Similarly, this call\ - \ also does not delete any of the offers associated with the inventory item\ - \ group, but instead all of these offers go into the unpublished state. If\ - \ the seller wanted to relist the multiple-variation eBay listing, they could\ - \ use the publishOfferByInventoryItemGroup method." - operationId: "withdrawOfferByInventoryItemGroup" + - offer + description: This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. This call only ends multiple-variation eBay listing associated with the inventory item group but does not delete the inventory item group object. Similarly, this call also does not delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state. If the seller wanted to relist the multiple-variation eBay listing, they could use the publishOfferByInventoryItemGroup method. + operationId: withdrawOfferByInventoryItemGroup requestBody: - description: "The base request of the withdrawOfferByInventoryItemGroup\ - \ call." + description: The base request of the withdrawOfferByInventoryItemGroup call. content: application/json: schema: - description: "The base request of the withdrawOfferByInventoryItemGroup\ - \ call." - $ref: "#/components/schemas/WithdrawByInventoryItemGroupRequest" + description: The base request of the withdrawOfferByInventoryItemGroup call. + $ref: '#/components/schemas/WithdrawByInventoryItemGroupRequest' required: true responses: - 400: - description: "Bad Request" + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25725: - domain: "API_INVENTORY" - category: "REQUEST" - description: "No offer found" - 500: - description: "Internal Server Error" + '25725': + domain: API_INVENTORY + category: REQUEST + description: No offer found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "Any System error. {additionalInfo}" - 204: - description: "No Content" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: Any System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /location/{merchantLocationKey}: get: tags: - - "location" - description: "This call retrieves all defined details of the inventory location\ - \ that is specified by the merchantLocationKey path parameter.

The\ - \ authorization HTTP header is the only required request header\ - \ for this call.

A successful call will return an HTTP status value\ - \ of 200 OK.

" - operationId: "getInventoryLocation" + - location + description: This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter.

The authorization HTTP header is the only required request header for this call.

A successful call will return an HTTP status value of 200 OK.

+ operationId: getInventoryLocation parameters: - - name: "merchantLocationKey" - in: "path" - description: "A unique merchant-defined key (ID) for an inventory location.\ - \ This value is passed in at the end of the call URI to specify the inventory\ - \ location to retrieve.

Max length: 36" - required: true - schema: - type: "string" + - name: merchantLocationKey + in: path + description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in at the end of the call URI to specify the inventory location to retrieve.

Max length: 36' + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/InventoryLocationResponse" - 400: - description: "Bad Request" + $ref: '#/components/schemas/InventoryLocationResponse' + '400': + description: Bad Request x-response-codes: errors: - 25804: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25805: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} Not Found." - 500: - description: "Internal Server Error" + '25804': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25805': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} Not Found.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory post: tags: - - "location" - description: "

Use this call to create a new inventory location. In order\ - \ to create and publish an offer (and create an eBay listing), a seller must\ - \ have at least one inventory location, as every offer must be associated\ - \ with a location.

Upon first creating an inventory location, only a\ - \ seller-defined location identifier and a physical location is required,\ - \ and once set, these values can not be changed. The unique identifier value\ - \ (merchantLocationKey) is passed in at the end of the call URI. This\ - \ merchantLocationKey value will be used in other Inventory Location\ - \ calls to identify the inventory location to perform an action against.

At\ - \ this time, location types are either warehouse or store. Warehouse locations\ - \ are used for traditional shipping, and store locations are generally used\ - \ by US merchants selling products through the In-Store Pickup program, or\ - \ used by UK, Australian, and German merchants selling products through the\ - \ Click and Collect program. A full address is required for store inventory\ - \ locations. However, for warehouse inventory locations, a full street address\ - \ is not needed, but the city, state/province, and country of the location\ - \ must be provided.

Note that all inventory locations are \"enabled\"\ - \ by default when they are created, and you must specifically disable them\ - \ (by passing in a value of DISABLED in the merchantLocationStatus\ - \ field) if you want them to be set to the disabled state. The seller's inventory\ - \ cannot be loaded to inventory locations in the disabled state.

In\ - \ addition to the authorization header, which is required for\ - \ all eBay REST API calls, the following table includes another request header\ - \ that is mandatory for the createInventoryLocation call,\ - \ and two other request headers that are optional:


\ - \ \ - \ \ - \ \ - \ \ - \
HeaderDescription Required? Applicable Values
Accept Describes the response encoding, as\ - \ required by the caller. Currently, the interfaces require payloads formatted\ - \ in JSON, and JSON is the default. No application/json
Content-Language Use this header to\ - \ control the language that is used for any returned errors or warnings in\ - \ the call response. No en-US
Content-Type The MIME type of the body of the\ - \ request. Must be JSON. Yes application/json


Unless one or more errors and/or warnings occur\ - \ with the call, there is no response payload for this call. A successful\ - \ call will return an HTTP status value of 204 No Content.

" - operationId: "createInventoryLocation" + - location + description:

Use this call to create a new inventory location. In order to create and publish an offer (and create an eBay listing), a seller must have at least one inventory location, as every offer must be associated with a location.

Upon first creating an inventory location, only a seller-defined location identifier and a physical location is required, and once set, these values can not be changed. The unique identifier value (merchantLocationKey) is passed in at the end of the call URI. This merchantLocationKey value will be used in other Inventory Location calls to identify the inventory location to perform an action against.

At this time, location types are either warehouse or store. Warehouse locations are used for traditional shipping, and store locations are generally used by US merchants selling products through the In-Store Pickup program, or used by UK, Australian, and German merchants selling products through the Click and Collect program. A full address is required for store inventory locations. However, for warehouse inventory locations, a full street address is not needed, but the city, state/province, and country of the location must be provided.

Note that all inventory locations are "enabled" by default when they are created, and you must specifically disable them (by passing in a value of DISABLED in the merchantLocationStatus field) if you want them to be set to the disabled state. The seller's inventory cannot be loaded to inventory locations in the disabled state.

In addition to the authorization header, which is required for all eBay REST API calls, the following table includes another request header that is mandatory for the createInventoryLocation call, and two other request headers that are optional:


Header Description Required? Applicable Values
Accept Describes the response encoding, as required by the caller. Currently, the interfaces require payloads formatted in JSON, and JSON is the default. No application/json
Content-Language Use this header to control the language that is used for any returned errors or warnings in the call response. No en-US
Content-Type The MIME type of the body of the request. Must be JSON. Yes application/json


Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of 204 No Content.

+ operationId: createInventoryLocation parameters: - - name: "merchantLocationKey" - in: "path" - description: "A unique, merchant-defined key (ID) for an inventory location.\ - \ This unique identifier, or key, is used in other Inventory API calls to\ - \ identify an inventory location.

Max length: 36" - required: true - schema: - type: "string" + - name: merchantLocationKey + in: path + description: 'A unique, merchant-defined key (ID) for an inventory location. This unique identifier, or key, is used in other Inventory API calls to identify an inventory location.

Max length: 36' + required: true + schema: + type: string requestBody: - description: "Inventory Location details" + description: Inventory Location details content: application/json: schema: - description: "Inventory Location details" - $ref: "#/components/schemas/InventoryLocationFull" + description: Inventory Location details + $ref: '#/components/schemas/InventoryLocationFull' required: true responses: - 400: - description: "Bad Request" + '204': + description: No Content + '400': + description: Bad Request x-response-codes: errors: - 25800: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid {fieldName}." - 25801: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Missing field {fieldName}." - 25802: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25803: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} already exists." - 25804: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 500: - description: "Internal Server Error" + '25800': + domain: API_INVENTORY + category: REQUEST + description: Invalid {fieldName}. + '25801': + domain: API_INVENTORY + category: REQUEST + description: Missing field {fieldName}. + '25802': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25803': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} already exists.' + '25804': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '409': + description: Location Already Exists + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" - 204: - description: "No Content" - 409: - description: "Location Already Exists" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory delete: tags: - - "location" - description: "

This call deletes the inventory location that is specified\ - \ in the merchantLocationKey path parameter. Note that deleting\ - \ a location will not affect any active eBay listings associated with the\ - \ deleted location, but the seller will not be able modify the offers associated\ - \ with the inventory location once it is deleted.

The authorization\ - \ HTTP header is the only required request header for this call.

Unless\ - \ one or more errors and/or warnings occur with the call, there is no response\ - \ payload for this call. A successful call will return an HTTP status value\ - \ of 200 OK.

" - operationId: "deleteInventoryLocation" + - location + description:

This call deletes the inventory location that is specified in the merchantLocationKey path parameter. Note that deleting a location will not affect any active eBay listings associated with the deleted location, but the seller will not be able modify the offers associated with the inventory location once it is deleted.

The authorization HTTP header is the only required request header for this call.

Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of 200 OK.

+ operationId: deleteInventoryLocation parameters: - - name: "merchantLocationKey" - in: "path" - description: "A unique merchant-defined key (ID) for an inventory location.\ - \ This value is passed in at the end of the call URI to indicate the inventory\ - \ location to be deleted.

Max length: 36" - required: true - schema: - type: "string" + - name: merchantLocationKey + in: path + description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in at the end of the call URI to indicate the inventory location to be deleted.

Max length: 36' + required: true + schema: + type: string responses: - 400: - description: "Bad Request" + '204': + description: Success + '400': + description: Bad Request x-response-codes: errors: - 25802: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25804: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25805: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} Not Found." - 500: - description: "Internal Server Error" + '25802': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25804': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25805': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} Not Found.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" - 204: - description: "Success" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /location/{merchantLocationKey}/disable: post: tags: - - "location" - description: "

This call disables the inventory location that is specified\ - \ in the merchantLocationKey path parameter. Sellers can not\ - \ load/modify inventory to disabled inventory locations. Note that disabling\ - \ an inventory location will not affect any active eBay listings associated\ - \ with the disabled location, but the seller will not be able modify the offers\ - \ associated with a disabled inventory location.

The authorization\ - \ HTTP header is the only required request header for this call.

A successful\ - \ call will return an HTTP status value of 200 OK.

" - operationId: "disableInventoryLocation" + - location + description:

This call disables the inventory location that is specified in the merchantLocationKey path parameter. Sellers can not load/modify inventory to disabled inventory locations. Note that disabling an inventory location will not affect any active eBay listings associated with the disabled location, but the seller will not be able modify the offers associated with a disabled inventory location.

The authorization HTTP header is the only required request header for this call.

A successful call will return an HTTP status value of 200 OK.

+ operationId: disableInventoryLocation parameters: - - name: "merchantLocationKey" - in: "path" - description: "A unique merchant-defined key (ID) for an inventory location.\ - \ This value is passed in through the call URI to disable the specified\ - \ inventory location.

Max length: 36" - required: true - schema: - type: "string" + - name: merchantLocationKey + in: path + description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in through the call URI to disable the specified inventory location.

Max length: 36' + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - type: "object" - 400: - description: "Bad Request" + type: object + '400': + description: Bad Request x-response-codes: errors: - 25802: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25804: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25805: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} Not Found." - 500: - description: "Internal Server Error" + '25802': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25804': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25805': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} Not Found.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /location/{merchantLocationKey}/enable: post: tags: - - "location" - description: "

This call enables a disabled inventory location that is specified\ - \ in the merchantLocationKey path parameter. Once a disabled\ - \ inventory location is enabled, sellers can start loading/modifying inventory\ - \ to that inventory location.

The authorization HTTP header\ - \ is the only required request header for this call.

A successful call\ - \ will return an HTTP status value of 200 OK.

" - operationId: "enableInventoryLocation" + - location + description:

This call enables a disabled inventory location that is specified in the merchantLocationKey path parameter. Once a disabled inventory location is enabled, sellers can start loading/modifying inventory to that inventory location.

The authorization HTTP header is the only required request header for this call.

A successful call will return an HTTP status value of 200 OK.

+ operationId: enableInventoryLocation parameters: - - name: "merchantLocationKey" - in: "path" - description: "A unique merchant-defined key (ID) for an inventory location.\ - \ This value is passed in through the call URI to specify the disabled inventory\ - \ location to enable.

Max length: 36" - required: true - schema: - type: "string" + - name: merchantLocationKey + in: path + description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in through the call URI to specify the disabled inventory location to enable.

Max length: 36' + required: true + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - type: "object" - 400: - description: "Bad Request" + type: object + '400': + description: Bad Request x-response-codes: errors: - 25802: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25804: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25805: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} Not Found." - 500: - description: "Internal Server Error" + '25802': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25804': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25805': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} Not Found.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory /location: get: tags: - - "location" - description: "This call retrieves all defined details for every inventory location\ - \ associated with the seller's account. There are no required parameters for\ - \ this call and no request payload. However, there are two optional query\ - \ parameters, limit and offset. The limit\ - \ query parameter sets the maximum number of inventory locations returned\ - \ on one page of data, and the offset query parameter specifies\ - \ the page of data to return. These query parameters are discussed more in\ - \ the URI parameters table below.

The authorization\ - \ HTTP header is the only required request header for this call.

A\ - \ successful call will return an HTTP status value of 200 OK.

" - operationId: "getInventoryLocations" + - location + description: This call retrieves all defined details for every inventory location associated with the seller's account. There are no required parameters for this call and no request payload. However, there are two optional query parameters, limit and offset. The limit query parameter sets the maximum number of inventory locations returned on one page of data, and the offset query parameter specifies the page of data to return. These query parameters are discussed more in the URI parameters table below.

The authorization HTTP header is the only required request header for this call.

A successful call will return an HTTP status value of 200 OK.

+ operationId: getInventoryLocations parameters: - - name: "limit" - in: "query" - description: "The value passed in this query parameter sets the maximum number\ - \ of records to return per page of data. Although this field is a string,\ - \ the value passed in this field should be a positive integer value. If\ - \ this query parameter is not set, up to 100 records will be returned on\ - \ each page of results.

Min: 1" - required: false - schema: - type: "string" - - name: "offset" - in: "query" - description: "Specifies the number of locations to skip in the result set\ - \ before returning the first location in the paginated response.

Combine\ - \ offset with the limit query parameter to control the items\ - \ returned in the response. For example, if you supply an offset\ - \ of 0 and a limit of 10, the first page\ - \ of the response contains the first 10 items from the complete list of\ - \ items retrieved by the call. If offset is 10 and limit\ - \ is 20, the first page of the response contains items 11-30\ - \ from the complete result set.

Default: 0

" - required: false - schema: - type: "string" + - name: limit + in: query + description: 'The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be a positive integer value. If this query parameter is not set, up to 100 records will be returned on each page of results.

Min: 1' + required: false + schema: + type: string + - name: offset + in: query + description: Specifies the number of locations to skip in the result set before returning the first location in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

+ required: false + schema: + type: string responses: - 200: - description: "Success" + '200': + description: Success content: application/json: schema: - $ref: "#/components/schemas/LocationResponse" - 400: - description: "Bad Request" - 500: - description: "Internal Server Error" + $ref: '#/components/schemas/LocationResponse' + '400': + description: Bad Request + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly" - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly + - https://api.ebay.com/oauth/api_scope/sell.inventory /location/{merchantLocationKey}/update_location_details: post: tags: - - "location" - description: "

Use this call to update non-physical location details for an\ - \ existing inventory location. Specify the inventory location you want to\ - \ update using the merchantLocationKey path parameter.

You\ - \ can update the following text-based fields: name, phone,\ - \ locationWebUrl, locationInstructions and\ - \ locationAdditionalInformation. Whatever text is passed\ - \ in for these fields in an updateInventoryLocation call\ - \ will replace the current text strings defined for these fields. For store\ - \ inventory locations, the operating hours and/or the special hours can also\ - \ be updated.

The merchant location key, the physical location of\ - \ the store, and its geo-location coordinates can not be updated with an updateInventoryLocation\ - \ call

In addition to the authorization header, which\ - \ is required for all eBay REST API calls, the following table includes another\ - \ request header that is mandatory for the updateInventoryLocation\ - \ call, and two other request headers that are optional:


\ - \ \ - \ \ - \ \ - \ \ - \
Header Description Required? Applicable Values
Accept Describes the response encoding,\ - \ as required by the caller. Currently, the interfaces require payloads formatted\ - \ in JSON, and JSON is the default. No application/json
Content-Language Use this header to\ - \ control the language that is used for any returned errors or warnings in\ - \ the call response. No en-US
Content-Type The MIME type of the body of the\ - \ request. Must be JSON. Yes application/json

Unless one or more errors and/or warnings occurs with\ - \ the call, there is no response payload for this call. A successful call\ - \ will return an HTTP status value of 204 No Content.

" - operationId: "updateInventoryLocation" + - location + description: '

Use this call to update non-physical location details for an existing inventory location. Specify the inventory location you want to update using the merchantLocationKey path parameter.

You can update the following text-based fields: name, phone, locationWebUrl, locationInstructions and locationAdditionalInformation. Whatever text is passed in for these fields in an updateInventoryLocation call will replace the current text strings defined for these fields. For store inventory locations, the operating hours and/or the special hours can also be updated.

The merchant location key, the physical location of the store, and its geo-location coordinates can not be updated with an updateInventoryLocation call

In addition to the authorization header, which is required for all eBay REST API calls, the following table includes another request header that is mandatory for the updateInventoryLocation call, and two other request headers that are optional:


Header Description Required? Applicable Values
Accept Describes the response encoding, as required by the caller. Currently, the interfaces require payloads formatted in JSON, and JSON is the default. No application/json
Content-Language Use this header to control the language that is used for any returned errors or warnings in the call response. No en-US
Content-Type The MIME type of the body of the request. Must be JSON. Yes application/json

Unless one or more errors and/or warnings occurs with the call, there is no response payload for this call. A successful call will return an HTTP status value of 204 No Content.

' + operationId: updateInventoryLocation parameters: - - name: "merchantLocationKey" - in: "path" - description: "A unique merchant-defined key (ID) for an inventory location.\ - \ This value is passed in the call URI to indicate the inventory location\ - \ to be updated.

Max length: 36" - required: true - schema: - type: "string" + - name: merchantLocationKey + in: path + description: 'A unique merchant-defined key (ID) for an inventory location. This value is passed in the call URI to indicate the inventory location to be updated.

Max length: 36' + required: true + schema: + type: string requestBody: - description: "The inventory location details to be updated (other than the\ - \ address and geo co-ordinates)." + description: The inventory location details to be updated (other than the address and geo co-ordinates). content: application/json: schema: - description: "The inventory location details to be updated (other than\ - \ the address and geo co-ordinates)." - $ref: "#/components/schemas/InventoryLocation" + description: The inventory location details to be updated (other than the address and geo co-ordinates). + $ref: '#/components/schemas/InventoryLocation' required: true responses: - 400: - description: "Bad Request" + '204': + description: Success + '400': + description: Bad Request x-response-codes: errors: - 25800: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Invalid {fieldName}." - 25801: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Missing field {fieldName}." - 25802: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25804: - domain: "API_INVENTORY" - category: "REQUEST" - description: "Input error. {additionalInfo}" - 25805: - domain: "API_INVENTORY" - category: "REQUEST" - description: "{fieldName} Not Found." - 500: - description: "Internal Server Error" + '25800': + domain: API_INVENTORY + category: REQUEST + description: Invalid {fieldName}. + '25801': + domain: API_INVENTORY + category: REQUEST + description: Missing field {fieldName}. + '25802': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25804': + domain: API_INVENTORY + category: REQUEST + description: Input error. {additionalInfo} + '25805': + domain: API_INVENTORY + category: REQUEST + description: '{fieldName} Not Found.' + '404': + description: Not Found + '500': + description: Internal Server Error x-response-codes: errors: - 25001: - domain: "API_INVENTORY" - category: "APPLICATION" - description: "System error. {additionalInfo}" - 204: - description: "Success" - 404: - description: "Not Found" + '25001': + domain: API_INVENTORY + category: APPLICATION + description: System error. {additionalInfo} security: - - api_auth: - - "https://api.ebay.com/oauth/api_scope/sell.inventory" + - api_auth: + - https://api.ebay.com/oauth/api_scope/sell.inventory components: schemas: Address: - type: "object" + type: object properties: addressLine1: - type: "string" - description: "The first line of a street address. This field is required\ - \ for store inventory locations that will be holding In-Store Pickup inventory.\ - \ A street address is not required if the inventory location is not holding\ - \ In-Store Pickup Inventory. This field will be returned if defined for\ - \ an inventory location.

Max length: 128" + type: string + description: 'The first line of a street address. This field is required for store inventory locations that will be holding In-Store Pickup inventory. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location.

Max length: 128' addressLine2: - type: "string" - description: "The second line of a street address. This field can be used\ - \ for additional address information, such as a suite or apartment number.\ - \ A street address is not required if the inventory location is not holding\ - \ In-Store Pickup Inventory. This field will be returned if defined for\ - \ an inventory location.

Max length: 128" + type: string + description: 'The second line of a street address. This field can be used for additional address information, such as a suite or apartment number. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location.

Max length: 128' city: - type: "string" - description: "The city in which the inventory location resides. This field\ - \ is required for store inventory locations that will be holding In-Store\ - \ Pickup inventory. For warehouse locations, this field is technically\ - \ optional, as a postalCode can be used instead of city/stateOrProvince\ - \ pair, and then the city is just derived from this postal/zip code. This\ - \ field is returned if defined for an inventory location.

Max\ - \ length: 128" + type: string + description: 'The city in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a postalCode can be used instead of city/stateOrProvince pair, and then the city is just derived from this postal/zip code. This field is returned if defined for an inventory location.

Max length: 128' country: - type: "string" - description: "The country in which the address resides, represented as two-letter\ - \ ISO 3166 country code. For\ - \ example, US represents the United States, and DE\ - \ represents Germany.

Max length: 2 For implementation\ - \ help, refer to eBay API documentation" + type: string + description: 'The country in which the address resides, represented as two-letter ISO 3166 country code. For example, US represents the United States, and DE represents Germany.

Max length: 2 For implementation help, refer to eBay API documentation' county: - type: "string" - description: "The county in which the address resides. This field is returned\ - \ if defined for an inventory location." + type: string + description: The county in which the address resides. This field is returned if defined for an inventory location. postalCode: - type: "string" - description: "The postal/zip code of the address. eBay uses postal codes\ - \ to surface In-Store Pickup items within the vicinity of a buyer's location,\ - \ and it also user postal codes (origin and destination) to estimate shipping\ - \ costs when the seller uses calculated shipping. A city/stateOrProvince\ - \ pair can be used instead of a postalCode value, and\ - \ then the postal code is just derived from the city and state/province.\ - \ This field is returned if defined for an inventory location.

Max\ - \ length: 16" + type: string + description: 'The postal/zip code of the address. eBay uses postal codes to surface In-Store Pickup items within the vicinity of a buyer''s location, and it also user postal codes (origin and destination) to estimate shipping costs when the seller uses calculated shipping. A city/stateOrProvince pair can be used instead of a postalCode value, and then the postal code is just derived from the city and state/province. This field is returned if defined for an inventory location.

Max length: 16' stateOrProvince: - type: "string" - description: "The state/province in which the inventory location resides.\ - \ This field is required for store inventory locations that will be holding\ - \ In-Store Pickup inventory. For warehouse locations, this field is technically\ - \ optional, as a postalCode can be used instead of city/stateOrProvince\ - \ pair, and then the state or province is just derived from this postal/zip\ - \ code.

Max length: 128" - description: "This type is used to define the physical address of an inventory\ - \ location." + type: string + description: 'The state/province in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a postalCode can be used instead of city/stateOrProvince pair, and then the state or province is just derived from this postal/zip code.

Max length: 128' + description: This type is used to define the physical address of an inventory location. Amount: - type: "object" + type: object properties: currency: - type: "string" - description: "A three-digit string value respresenting the type of currency\ - \ being used. Both the value and currency\ - \ fields are required/always returned when expressing prices. See the\ - \ CurrencyCodeEnum\ - \ type for the full list of currencies and their corresponding three-digit\ - \ string values." + type: string + description: A three-digit string value respresenting the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. See the CurrencyCodeEnum type for the full list of currencies and their corresponding three-digit string values. value: - type: "string" - description: "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." - description: "This type is used to express a dollar value and the applicable\ - \ currency." + type: string + description: 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. + description: This type is used to express a dollar value and the applicable currency. Availability: - type: "object" + type: object properties: pickupAtLocationAvailability: - type: "array" - description: "This container consists of an array of one or more of the\ - \ merchant's physical store locations where the inventory item is available\ - \ for In-Store Pickup orders. The merchant's location, the quantity available,\ - \ and the fulfillment time (how soon the item will be ready for pickup\ - \ after the order takes place) are all in this container. In-Store Pickup\ - \ is only available to large merchants selling on the US, UK, Germany,\ - \ and Australia sites." + type: array + description: This container consists of an array of one or more of the merchant's physical store locations where the inventory item is available for In-Store Pickup orders. The merchant's location, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order takes place) are all in this container. In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites. items: - $ref: "#/components/schemas/PickupAtLocationAvailability" + $ref: '#/components/schemas/PickupAtLocationAvailability' shipToLocationAvailability: - description: "This container specifies the quantity of the inventory item\ - \ that are available for purchase across one or more eBay marketplaces." - $ref: "#/components/schemas/ShipToLocationAvailability" - description: "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,\ - \ and the quantity of the inventory item that is available for In-Store Pickup\ - \ at one or more of the merchant's physical stores. In-Store Pickup is only\ - \ available to large merchants selling on the US, UK, Germany, and Australia\ - \ sites." + description: This container specifies the quantity of the inventory item that are available for purchase across one or more eBay marketplaces. + $ref: '#/components/schemas/ShipToLocationAvailability' + description: 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, and the quantity of the inventory item that is available for In-Store Pickup at one or more of the merchant's physical stores. In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites. AvailabilityDistribution: - type: "object" + type: object properties: fulfillmentTime: - description: "This container is used to indicate the expected fulfillment\ - \ time if the inventory item is shipped from the warehouse location identified\ - \ in the corresponding merchantLocationKey field. The\ - \ fulfillment time is the estimated number of business days after purchase\ - \ that the buyer can expect the item to be delivered.

This field\ - \ is optional, and is used by eBay to provide the estimated delivery date\ - \ to buyers. This field is returned if set for the inventory item. " - $ref: "#/components/schemas/TimeDuration" + description: 'This container is used to indicate the expected fulfillment time if the inventory item is shipped from the warehouse location identified in the corresponding merchantLocationKey field. The fulfillment time is the estimated number of business days after purchase that the buyer can expect the item to be delivered.

This field is optional, and is used by eBay to provide the estimated delivery date to buyers. This field is returned if set for the inventory item. ' + $ref: '#/components/schemas/TimeDuration' merchantLocationKey: - type: "string" - description: "The unique identifier of an inventory location where quantity\ - \ is available for the inventory item. This field is conditionally required\ - \ to identify the inventory location that has quantity of the inventory\ - \ item." + type: string + description: The unique identifier of an inventory location where quantity is available for the inventory item. This field is conditionally required to identify the inventory location that has quantity of the inventory item. quantity: - type: "integer" - description: "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." - format: "int32" - description: "This type is used to set the available quantity of the inventory\ - \ item at one or more warehouse locations." + type: integer + description: 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. + format: int32 + description: This type is used to set the available quantity of the inventory item at one or more warehouse locations. AvailabilityWithAll: - type: "object" + type: object properties: pickupAtLocationAvailability: - type: "array" - description: "This container consists of an array of one or more of the\ - \ merchant's physical stores where the inventory item is available for\ - \ in-store pickup.

The store ID, the quantity available, and\ - \ the fulfillment time (how soon the item will be ready for pickup after\ - \ the order occurs) are all returned in this container." + type: array + description: This container consists of an array of one or more of the merchant's physical stores where the inventory item is available for in-store pickup.

The store ID, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order occurs) are all returned in this container. items: - $ref: "#/components/schemas/PickupAtLocationAvailability" + $ref: '#/components/schemas/PickupAtLocationAvailability' shipToLocationAvailability: - description: "This container specifies the quantity of the inventory items\ - \ that are available for a standard purchase, where the item is shipped\ - \ to the buyer." - $ref: "#/components/schemas/ShipToLocationAvailabilityWithAll" - description: "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,\ - \ and the quantity of the inventory items that are available for In-Store\ - \ Pickup at one or more of the merchant's physical stores.

In-Store\ - \ Pickup is only available to large merchants selling on the US, UK, Germany,\ - \ and Australia sites." + description: This container specifies the quantity of the inventory items that are available for a standard purchase, where the item is shipped to the buyer. + $ref: '#/components/schemas/ShipToLocationAvailabilityWithAll' + description: 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, and the quantity of the inventory items that are available for In-Store Pickup at one or more of the merchant's physical stores.

In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites. BaseResponse: - type: "object" + type: object properties: warnings: - type: "array" - description: "This container will be returned in a call response payload\ - \ if one or more warnings or errors are triggered when an Inventory API\ - \ call is made. This container will contain detailed information about\ - \ the error or warning." + type: array + description: This container will be returned in a call response payload if one or more warnings or errors are triggered when an Inventory API call is made. This container will contain detailed information about the error or warning. items: - $ref: "#/components/schemas/Error" - description: "This is the base response of the createOrReplaceInventoryItem,\ - \ createOrReplaceInventoryItemGroup, and createOrReplaceProductCompatibility\ - \ calls. A response payload will only be returned for these three calls if\ - \ one or more errors or warnings occur with the call." + $ref: '#/components/schemas/Error' + description: This is the base response of the createOrReplaceInventoryItem, createOrReplaceInventoryItemGroup, and createOrReplaceProductCompatibility calls. A response payload will only be returned for these three calls if one or more errors or warnings occur with the call. BestOffer: - type: "object" + type: object properties: autoAcceptPrice: - description: "This is the price at which Best Offers are automatically accepted.\ - \ If a buyer submits a Best Offer that is equal to or above this value,\ - \ the offer is automatically accepted on behalf of the seller. This field\ - \ is only applicable if the bestOfferEnabled value is\ - \ set to true.

The price set here must be lower than\ - \ the current 'Buy it Now' price. This field is only returned if set." - $ref: "#/components/schemas/Amount" + description: This is the price at which Best Offers are automatically accepted. If a buyer submits a Best Offer that is equal to or above this value, the offer is automatically accepted on behalf of the seller. This field is only applicable if the bestOfferEnabled value is set to true.

The price set here must be lower than the current 'Buy it Now' price. This field is only returned if set. + $ref: '#/components/schemas/Amount' autoDeclinePrice: - description: "This is the price at which Best Offers are automatically declined.\ - \ If a buyer submits a Best Offer that is equal to or below this value,\ - \ the offer is automatically declined on behalf of the seller. This field\ - \ is only applicable if the bestOfferEnabled value is\ - \ set to true.

The price set here must be lower than\ - \ the current 'Buy it Now' price and the price set in the autoAcceptPrice\ - \ field (if used). This field is only returned if set." - $ref: "#/components/schemas/Amount" + description: This is the price at which Best Offers are automatically declined. If a buyer submits a Best Offer that is equal to or below this value, the offer is automatically declined on behalf of the seller. This field is only applicable if the bestOfferEnabled value is set to true.

The price set here must be lower than the current 'Buy it Now' price and the price set in the autoAcceptPrice field (if used). This field is only returned if set. + $ref: '#/components/schemas/Amount' bestOfferEnabled: - type: "boolean" - description: "This field indicates whether or not the Best Offer feature\ - \ is enabled for the listing. A seller can enable the Best Offer feature\ - \ for a listing as long as the category supports the Best Offer feature.

The\ - \ seller includes this field and sets its value to true to\ - \ enable Best Offer feature." - description: "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." + type: boolean + description: This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature.

The seller includes this field and sets its value to true to enable Best Offer feature. + description: 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. BulkEbayOfferDetailsWithKeys: - type: "object" + type: object properties: requests: - type: "array" - description: "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." + type: array + description: 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. items: - $ref: "#/components/schemas/EbayOfferDetailsWithKeys" - description: "This type is used by the base request of the bulkCreateOffer\ - \ method, which is used to create up to 25 new offers." + $ref: '#/components/schemas/EbayOfferDetailsWithKeys' + description: This type is used by the base request of the bulkCreateOffer method, which is used to create up to 25 new offers. BulkGetInventoryItem: - type: "object" + type: object properties: requests: - type: "array" - description: "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." + type: array + description: 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. items: - $ref: "#/components/schemas/GetInventoryItem" - description: "This type is used by the base request of the bulkGetInventoryItem\ - \ method." + $ref: '#/components/schemas/GetInventoryItem' + description: This type is used by the base request of the bulkGetInventoryItem method. BulkGetInventoryItemResponse: - type: "object" + type: object properties: responses: - type: "array" - description: "This is the base container of the bulkGetInventoryItem\ - \ response. The results of each attempted inventory item retrieval is\ - \ captured under this container." + type: array + description: This is the base container of the bulkGetInventoryItem response. The results of each attempted inventory item retrieval is captured under this container. items: - $ref: "#/components/schemas/GetInventoryItemResponse" - description: "This type is used by the base response of the bulkGetInventoryItem\ - \ method." + $ref: '#/components/schemas/GetInventoryItemResponse' + description: This type is used by the base response of the bulkGetInventoryItem method. BulkInventoryItem: - type: "object" + type: object properties: requests: - type: "array" - description: "The details of each inventory item that is being created or\ - \ updated is passed in under this container. Up to 25 inventory item records\ - \ can be created and/or updated with one bulkCreateOrReplaceInventoryItem\ - \ call." + type: array + description: The details of each inventory item that is being created or updated is passed in under this container. Up to 25 inventory item records can be created and/or updated with one bulkCreateOrReplaceInventoryItem call. items: - $ref: "#/components/schemas/InventoryItemWithSkuLocale" - description: "The base request of the bulkCreateOrReplaceInventoryItem\ - \ method." + $ref: '#/components/schemas/InventoryItemWithSkuLocale' + description: The base request of the bulkCreateOrReplaceInventoryItem method. BulkInventoryItemResponse: - type: "object" + type: object properties: responses: - type: "array" - description: "This is the base container of the bulkCreateOrReplaceInventoryItem\ - \ response. The results of each attempted inventory item creation/update\ - \ is captured under this container." + type: array + description: This is the base container of the bulkCreateOrReplaceInventoryItem response. The results of each attempted inventory item creation/update is captured under this container. items: - $ref: "#/components/schemas/InventoryItemResponse" - description: "This type is used by the base response of the bulkCreateOrReplaceInventoryItem\ - \ method." + $ref: '#/components/schemas/InventoryItemResponse' + description: This type is used by the base response of the bulkCreateOrReplaceInventoryItem method. BulkMigrateListing: - type: "object" + type: object properties: requests: - type: "array" - description: "This is the base container of the bulkMigrateListings\ - \ request payload. One to five eBay listings will be included under this\ - \ container." + type: array + description: This is the base container of the bulkMigrateListings request payload. One to five eBay listings will be included under this container. items: - $ref: "#/components/schemas/MigrateListing" - description: "This type is used by the base container of the bulkMigrateListings\ - \ request payload." + $ref: '#/components/schemas/MigrateListing' + description: This type is used by the base container of the bulkMigrateListings request payload. BulkMigrateListingResponse: - type: "object" + type: object properties: responses: - type: "array" - description: "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." + type: array + description: 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. items: - $ref: "#/components/schemas/MigrateListingResponse" - description: "This type is used by the response payload of the bulkMigrateListings\ - \ call." + $ref: '#/components/schemas/MigrateListingResponse' + description: This type is used by the response payload of the bulkMigrateListings call. BulkOffer: - type: "object" + type: object properties: requests: - type: "array" - description: "This container is used to pass in an array of offers to publish.\ - \ Up to 25 offers can be published with one bulkPublishOffer\ - \ method." + type: array + description: This container is used to pass in an array of offers to publish. Up to 25 offers can be published with one bulkPublishOffer method. items: - $ref: "#/components/schemas/OfferKeyWithId" - description: "This type is used by the base request of the bulkPublishOffer\ - \ method, which is used to publish up to 25 different offers." + $ref: '#/components/schemas/OfferKeyWithId' + description: This type is used by the base request of the bulkPublishOffer method, which is used to publish up to 25 different offers. BulkOfferResponse: - type: "object" + type: object properties: responses: - type: "array" + type: array items: - $ref: "#/components/schemas/OfferSkuResponse" - description: "This type is used by the base response of the bulkCreateOffer\ - \ method." + $ref: '#/components/schemas/OfferSkuResponse' + description: This type is used by the base response of the bulkCreateOffer method. BulkPriceQuantity: - type: "object" + type: object properties: requests: - type: "array" - description: "This container is used by the seller to update the total 'ship-to-home'\ - \ quantity of one or more inventory items (up to 25) and/or to update\ - \ the price and/or quantity of one or more specific published offers." + type: array + description: This container is used by the seller to update the total 'ship-to-home' quantity of one or more inventory items (up to 25) and/or to update the price and/or quantity of one or more specific published offers. items: - $ref: "#/components/schemas/PriceQuantity" - description: "This type is used by the base request payload of the bulkUpdatePriceQuantity\ - \ call. The bulkUpdatePriceQuantity call allows the seller\ - \ to update the total 'ship-to-home' quantity of one or more inventory items\ - \ (up to 25) and/or to update the price and/or quantity of one or more specific\ - \ published offers." + $ref: '#/components/schemas/PriceQuantity' + description: This type is used by the base request payload of the bulkUpdatePriceQuantity call. The bulkUpdatePriceQuantity call allows the seller to update the total 'ship-to-home' quantity of one or more inventory items (up to 25) and/or to update the price and/or quantity of one or more specific published offers. BulkPriceQuantityResponse: - type: "object" + type: object properties: responses: - type: "array" - description: "This container will return an HTTP status code, offer ID,\ - \ and SKU value for each offer/inventory item being updated, as well as\ - \ an errors and/or warnings container\ - \ if any errors or warnings are triggered while trying to update those\ - \ offers/inventory items." + type: array + description: This container will return an HTTP status code, offer ID, and SKU value for each offer/inventory item being updated, as well as an errors and/or warnings container if any errors or warnings are triggered while trying to update those offers/inventory items. items: - $ref: "#/components/schemas/PriceQuantityResponse" - description: "This type is use by the base response payload of the bulkUpdatePriceQuantity\ - \ call. The bulkUpdatePriceQuantity call response will return\ - \ an HTTP status code, offer ID, and SKU value for each offer/inventory item\ - \ being updated, as well as an errors and/or warnings\ - \ container if any errors or warnings are triggered while trying to update\ - \ those offers/inventory items." + $ref: '#/components/schemas/PriceQuantityResponse' + description: This type is use by the base response payload of the bulkUpdatePriceQuantity call. The bulkUpdatePriceQuantity call response will return an HTTP status code, offer ID, and SKU value for each offer/inventory item being updated, as well as an errors and/or warnings container if any errors or warnings are triggered while trying to update those offers/inventory items. BulkPublishResponse: - type: "object" + type: object properties: responses: - type: "array" - description: "A node is returned under the responses container\ - \ to indicate the success or failure of each offer that the seller was\ - \ attempting to publish." + type: array + description: A node is returned under the responses container to indicate the success or failure of each offer that the seller was attempting to publish. items: - $ref: "#/components/schemas/OfferResponseWithListingId" - description: "This type is used by the base response of the bulkPublishOffer\ - \ method." + $ref: '#/components/schemas/OfferResponseWithListingId' + description: This type is used by the base response of the bulkPublishOffer method. Charity: - type: "object" + type: object properties: charityId: - type: "string" - description: "The eBay-assigned unique identifier of the charitable organization\ - \ that will receive a percentage of the sales proceeds. The charitable\ - \ organization must be reqistered with the PayPal Giving Fund in order\ - \ to receive sales proceeds through eBay listings.

This field\ - \ is conditionally required if a seller is planning on donating a percentage\ - \ of the sale proceeds to a charitable organization.

The eBay-assigned\ - \ unique identifier of a charitable organization can be found using the\ - \ GetCharities call of the Trading API. In the GetCharities\ - \ call response, this unique identifier is shown in the id\ - \ attribute of the Charity container." + type: string + description: The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds. The charitable organization must be reqistered with the PayPal Giving Fund in order to receive sales proceeds through eBay listings.

This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.

The eBay-assigned unique identifier of a charitable organization can be found using the GetCharities call of the Trading API. In the GetCharities call response, this unique identifier is shown in the id attribute of the Charity container. donationPercentage: - type: "string" - description: "This field is the percentage of the purchase price that the\ - \ charitable organization (identified in the charityId\ - \ field) will receive for each sale that the listing generates. This field\ - \ is conditionally required if a seller is planning on donating a percentage\ - \ of the sale proceeds to a charitable organization. This numeric value\ - \ can range from 10 to 100, and in any 5 (percent) increments in between\ - \ this range (e.g. 10, 15, 20...95,...\ - \ 100). The seller would pass in 10 for 10 percent,\ - \ 15 for 15 percent, 20 for 20 percent, and\ - \ so on, all the way to 100 for 100 percent." - description: "This type is used to identify the charitable organization associated\ - \ with the listing, and the percentage of the sale proceeds that the charitable\ - \ organization will receive for each sale generated by the listing.

In\ - \ order to receive a percentage of the sales proceeds, the charitable organization\ - \ must be registered with the PayPal Giving Fund, which is a partner of eBay\ - \ for Charity." + type: string + description: This field is the percentage of the purchase price that the charitable organization (identified in the charityId field) will receive for each sale that the listing generates. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization. This numeric value can range from 10 to 100, and in any 5 (percent) increments in between this range (e.g. 10, 15, 20...95,... 100). The seller would pass in 10 for 10 percent, 15 for 15 percent, 20 for 20 percent, and so on, all the way to 100 for 100 percent. + description: This type is used to identify the charitable organization associated with the listing, and the percentage of the sale proceeds that the charitable organization will receive for each sale generated by the listing.

In order to receive a percentage of the sales proceeds, the charitable organization must be registered with the PayPal Giving Fund, which is a partner of eBay for Charity. Compatibility: - type: "object" + type: object properties: compatibleProducts: - type: "array" - description: "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." + type: array + description: 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. items: - $ref: "#/components/schemas/CompatibleProduct" + $ref: '#/components/schemas/CompatibleProduct' sku: - type: "string" - description: "This is the seller-defined SKU value of the inventory item\ - \ that will be associated with the compatible vehicles. This field is\ - \ not applicable to the createOrReplaceProductCompatibility\ - \ call, but it is always returned with the getProductCompatibility\ - \ call. For the createOrReplaceProductCompatibility \ - \ call, the SKU value for the inventory item is actually passed in as\ - \ part of the call URI, and not in the request payload." - description: "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." + type: string + description: This is the seller-defined SKU value of the inventory item that will be associated with the compatible vehicles. This field is not applicable to the createOrReplaceProductCompatibility call, but it is always returned with the getProductCompatibility call. For the createOrReplaceProductCompatibility call, the SKU value for the inventory item is actually passed in as part of the call URI, and not in the request payload. + description: 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. CompatibleProduct: - type: "object" + type: object properties: compatibilityProperties: - type: "array" - description: "This container consists of an array of motor vehicles that\ - \ are compatible with the motor vehicle part or accessory specified by\ - \ the SKU value in the call URI. Each motor vehicle is defined through\ - \ a separate set of name/value pairs. In the name field,\ - \ the vehicle aspect (such as 'make', 'model', 'year', 'trim', or 'engine')\ - \ will be identified, and the value field will be used\ - \ to identify the value of each aspect. The getCompatibilityProperties method of the Taxonomy API can be used\ - \ to retrieve applicable vehicle aspect names for a specified category,\ - \ and the getCompatibilityPropertyValues method of the Taxonomy API can be\ - \ used to retrieve possible values for these same vehicle aspect names.\ - \ Below is an example of identifying one motor vehicle using the compatibilityProperties\ - \ container:

"compatibilityProperties" : [
  {
   "name"\ - \ : "make",
   "value" : "Subaru"
  },
  {
   "name"\ - \ : "model",
   "value" : "GL"
  },
  {
   "name"\ - \ : "year",
   "value" : "1983"
  },
  {
   "name"\ - \ : "trim",
   "value" : "Base\ - \ Wagon 4-Door"
  },
  {
   "name"\ - \ : "engine",
   "value" : "1.8L\ - \ Turbocharged"
  }
]

Typically,\ - \ the make, model, and year of the motor vehicle are always required,\ - \ with the trim and engine being necessary sometimes, but it will be dependent\ - \ on the part or accessory, and on the vehicle class.

Note: The productFamilyProperties\ - \ container is in the process of being deprecated and will no longer be\ - \ supported in February of 2021, so if you are a new user of createOrReplaceProductCompatibility,\ - \ you should use the compatibilityProperties container\ - \ instead, and if you are already integrated and using the productFamilyProperties\ - \ container, you should make plans to migrate to compatibilityProperties.\ - \ The productFamilyProperties and compatibilityProperties\ - \ containers may not be used together or the call will fail." + type: array + description: 'This container consists of an array of motor vehicles that are compatible with the motor vehicle part or accessory specified by the SKU value in the call URI. Each motor vehicle is defined through a separate set of name/value pairs. In the name field, the vehicle aspect (such as ''make'', ''model'', ''year'', ''trim'', or ''engine'') will be identified, and the value field will be used to identify the value of each aspect. The getCompatibilityProperties method of the Taxonomy API can be used to retrieve applicable vehicle aspect names for a specified category, and the getCompatibilityPropertyValues method of the Taxonomy API can be used to retrieve possible values for these same vehicle aspect names. Below is an example of identifying one motor vehicle using the compatibilityProperties container:

"compatibilityProperties" : [
  {
   "name" : "make",
   "value" : "Subaru"
  },
  {
   "name" : "model",
   "value" : "GL"
  },
  {
   "name" : "year",
   "value" : "1983"
  },
  {
   "name" : "trim",
   "value" : "Base Wagon 4-Door"
  },
  {
   "name" : "engine",
   "value" : "1.8L Turbocharged"
  }
]

Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.

Note: The productFamilyProperties container is in the process of being deprecated and will no longer be supported in February of 2021, so if you are a new user of createOrReplaceProductCompatibility, you should use the compatibilityProperties container instead, and if you are already integrated and using the productFamilyProperties container, you should make plans to migrate to compatibilityProperties. The productFamilyProperties and compatibilityProperties containers may not be used together or the call will fail.' items: - $ref: "#/components/schemas/NameValueList" + $ref: '#/components/schemas/NameValueList' notes: - type: "string" - description: "This field is optionally used by the seller to input any notes\ - \ pertaining to the compatible vehicle list being defined. The seller\ - \ might use this field to specify the placement of the part on a vehicle\ - \ or other applicable information. This field will only be returned if\ - \ specified by the seller.

Max Length: 500
" + type: string + description: 'This field is optionally used by the seller to input any notes pertaining to the compatible vehicle list being defined. The seller might use this field to specify the placement of the part on a vehicle or other applicable information. This field will only be returned if specified by the seller.

Max Length: 500
' productFamilyProperties: - description: "This container consists of an array of motor vehicles that\ - \ are compatible with the motor vehicle part or accessory specified by\ - \ the SKU value in the call URI. These motor vehicles are identified by\ - \ properties such as make, model, year, trim, and engine type. A separate\ - \ productFamilyProperties node is needed to specify each\ - \ compatible motor vehicle. Typically, the make, model, and year of the\ - \ motor vehicle are always required, with the trim and engine being necessary\ - \ sometimes, but it will be dependent on the part or accessory, and on\ - \ the vehicle class.

Note:\ - \ The productFamilyProperties container is in the process\ - \ of being deprecated and will no longer be supported in February of 2021,\ - \ so if you are a new user of createOrReplaceProductCompatibility,\ - \ you should use the newer compatibilityProperties container\ - \ instead, and if you are already integrated and using the productFamilyProperties\ - \ container, you should make plans to migrate to compatibilityProperties.\ - \ The productFamilyProperties and compatibilityProperties\ - \ containers may not be used together or the call will fail." - $ref: "#/components/schemas/ProductFamilyProperties" + description: This container consists of an array of motor vehicles that are compatible with the motor vehicle part or accessory specified by the SKU value in the call URI. These motor vehicles are identified by properties such as make, model, year, trim, and engine type. A separate productFamilyProperties node is needed to specify each compatible motor vehicle. Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.

Note: The productFamilyProperties container is in the process of being deprecated and will no longer be supported in February of 2021, so if you are a new user of createOrReplaceProductCompatibility, you should use the newer compatibilityProperties container instead, and if you are already integrated and using the productFamilyProperties container, you should make plans to migrate to compatibilityProperties. The productFamilyProperties and compatibilityProperties containers may not be used together or the call will fail. + $ref: '#/components/schemas/ProductFamilyProperties' productIdentifier: - description: "This container is used in a createOrReplaceProductCompatibility\ - \ call to identify a motor vehicle that is compatible with the inventory\ - \ item. The user specifies either an eBay Product ID (ePID) or K-Type\ - \ value to identify a vehicle, and if the motor vehicle is found in the\ - \ eBay product catalog, the motor vehicle properties (make, model, year,\ - \ trim, engine) will automatically be populated for the vehicle. If the\ - \ vehicle cannot be found using these identifiers, the vehicle will not\ - \ be added to the compatible vehicle list.

Note that this container\ - \ will not be returned in the getProductCompatibility\ - \ call." - $ref: "#/components/schemas/ProductIdentifier" - description: "This type is used to specify/indicate the motor vehicles that\ - \ are compatible with the corresponding inventory item. " + description: This container is used in a createOrReplaceProductCompatibility call to identify a motor vehicle that is compatible with the inventory item. The user specifies either an eBay Product ID (ePID) or K-Type value to identify a vehicle, and if the motor vehicle is found in the eBay product catalog, the motor vehicle properties (make, model, year, trim, engine) will automatically be populated for the vehicle. If the vehicle cannot be found using these identifiers, the vehicle will not be added to the compatible vehicle list.

Note that this container will not be returned in the getProductCompatibility call. + $ref: '#/components/schemas/ProductIdentifier' + description: 'This type is used to specify/indicate the motor vehicles that are compatible with the corresponding inventory item. ' Dimension: - type: "object" + type: object properties: height: - type: "number" - description: "The actual height (in the measurement unit specified in the\ - \ unit field) of the shipping package. All fields of\ - \ the dimensions container are required if package dimensions\ - \ are specified.

If a shipping package measured 21.5 inches\ - \ in length, 15.0 inches in width, and 12.0 inches in height, the dimensions\ - \ container would look as follows: 
\"dimensions\": {
\
-            \ \"length\": 21.5,
 \"width\": 15.0,
 \"height\": 12.0,
\
-            \ \"unit\": \"INCH\"
 }
" + type: number + description: 'The actual height (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows: 
"dimensions": {
 "length": 21.5,
 "width": 15.0,
 "height": 12.0,
 "unit": "INCH"
 }
' length: - type: "number" - description: "The actual length (in the measurement unit specified in the\ - \ unit field) of the shipping package. All fields of\ - \ the dimensions container are required if package dimensions\ - \ are specified.

If a shipping package measured 21.5 inches\ - \ in length, 15.0 inches in width, and 12.0 inches in height, the dimensions\ - \ container would look as follows: 
\"dimensions\": {
\
-            \ \"length\": 21.5,
 \"width\": 15.0,
 \"height\": 12.0,
\
-            \ \"unit\": \"INCH\"
 }
" + type: number + description: 'The actual length (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows: 
"dimensions": {
 "length": 21.5,
 "width": 15.0,
 "height": 12.0,
 "unit": "INCH"
 }
' unit: - type: "string" - description: "The unit of measurement used to specify the dimensions of\ - \ a shipping package. All fields of the dimensions container\ - \ are required if package dimensions are specified. If the English system\ - \ of measurement is being used, the applicable values for dimension units\ - \ are FEET and INCH. If the metric system of\ - \ measurement is being used, the applicable values for weight units are\ - \ METER and CENTIMETER. The metric system is\ - \ used by most countries outside of the US. For implementation help, refer\ - \ to eBay\ - \ API documentation" + type: string + description: The unit of measurement used to specify the dimensions of a shipping package. All fields of the dimensions container are required if package dimensions are specified. If the English system of measurement is being used, the applicable values for dimension units are FEET and INCH. If the metric system of measurement is being used, the applicable values for weight units are METER and CENTIMETER. The metric system is used by most countries outside of the US. For implementation help, refer to eBay API documentation width: - type: "number" - description: "The actual width (in the measurement unit specified in the\ - \ unit field) of the shipping package. All fields of\ - \ the dimensions container are required if package dimensions\ - \ are specified.

If a shipping package measured 21.5 inches\ - \ in length, 15.0 inches in width, and 12.0 inches in height, the dimensions\ - \ container would look as follows: 
\"dimensions\": {
\
-            \ \"length\": 21.5,
 \"width\": 15.0,
 \"height\": 12.0,
\
-            \ \"unit\": \"INCH\"
 }
" - description: "This type is used to specify the dimensions (and the unit used\ - \ to measure those dimensions) of a shipping package. The dimensions\ - \ container is conditionally required if the seller will be offering calculated\ - \ shipping rates to determine shipping cost. See the Calculated shipping help page for more information\ - \ on calculated shipping." + type: number + description: 'The actual width (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows: 
"dimensions": {
 "length": 21.5,
 "width": 15.0,
 "height": 12.0,
 "unit": "INCH"
 }
' + description: This type is used to specify the dimensions (and the unit used to measure those dimensions) of a shipping package. The dimensions container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost. See the Calculated shipping help page for more information on calculated shipping. EbayOfferDetailsWithAll: - type: "object" + type: object properties: availableQuantity: - type: "integer" - description: "This integer value indicates the quantity of the inventory\ - \ item (specified by the sku value) that will be available\ - \ for purchase by buyers shopping on the eBay site specified in the marketplaceId\ - \ field. For unpublished offers where the available quantity has yet to\ - \ be set, the availableQuantity value is set to 0." - format: "int32" + type: integer + description: This integer value indicates the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field. For unpublished offers where the available quantity has yet to be set, the availableQuantity value is set to 0. + format: int32 categoryId: - type: "string" - description: "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." + type: string + description: 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. charity: - description: "This container is returned if a charitable organization will\ - \ receive a percentage of sale proceeds for each sale generated by the\ - \ listing. This container consists of the charityId field\ - \ to identify the charitable organization, and the donationPercentage\ - \ field that indicates the percentage of the sales proceeds that will\ - \ be donated to the charitable organization." - $ref: "#/components/schemas/Charity" + description: This container is returned if a charitable organization will receive a percentage of sale proceeds for each sale generated by the listing. This container consists of the charityId field to identify the charitable organization, and the donationPercentage field that indicates the percentage of the sales proceeds that will be donated to the charitable organization. + $ref: '#/components/schemas/Charity' extendedProducerResponsibility: - description: "This container provides IDs for the producer or importer related\ - \ to the new item, packaging, added documentation, or an eco-participation\ - \ fee. In some markets, such as in France, this may be the importer of\ - \ the item. This field is supported by a limited number of sites and specific\ - \ categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell\ - \ Metatdata API to retrieve valid categories for a site." - $ref: "#/components/schemas/ExtendedProducerResponsibility" + description: This container provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. This field is supported by a limited number of sites and specific categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metatdata API to retrieve valid categories for a site. + $ref: '#/components/schemas/ExtendedProducerResponsibility' format: - type: "string" - description: "This enumerated value indicates the listing format of the\ - \ offer. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumerated value indicates the listing format of the offer. For implementation help, refer to eBay API documentation hideBuyerDetails: - type: "boolean" - description: "This field is returned as true if the private\ - \ listing feature has been enabled for the offer. Sellers may want to\ - \ use this feature when they believe that a listing's potential bidders/buyers\ - \ would not want their obfuscated user IDs (and feedback scores) exposed\ - \ to other users.

This field is always returned even if not explicitly\ - \ set in the offer. It defaults to false, so will get returned\ - \ as false if seller does not set this feature with a 'Create'\ - \ or 'Update' offer method." + type: boolean + description: This field is returned as true if the private listing feature has been enabled for the offer. Sellers may want to use this feature when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.

This field is always returned even if not explicitly set in the offer. It defaults to false, so will get returned as false if seller does not set this feature with a 'Create' or 'Update' offer method. includeCatalogProductDetails: - type: "boolean" - description: "This field indicates whether or not eBay product catalog details\ - \ are applied to a listing. A value of true indicates the\ - \ listing corresponds to the eBay product associated with the provided\ - \ product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Note: Though the includeCatalogProductDetails\ - \ parameter is not required to be submitted in the request, the parameter\ - \ defaults to 'true' if omitted.

" + type: boolean + description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted.

listing: - description: "For published offers, this container is always returned in\ - \ the getOffer and getOffers calls,\ - \ and includes the eBay listing ID associated with the offer, the status\ - \ of the listing, and the quantity sold through the listing. The listing\ - \ container is not returned at all for unpublished offers." - $ref: "#/components/schemas/ListingDetails" + description: For published offers, this container is always returned in the getOffer and getOffers calls, and includes the eBay listing ID associated with the offer, the status of the listing, and the quantity sold through the listing. The listing container is not returned at all for unpublished offers. + $ref: '#/components/schemas/ListingDetails' listingDescription: - type: "string" - description: "The description of the eBay listing that is part of the unpublished\ - \ or published offer. This field is always returned for published offers,\ - \ but is only returned if set for unpublished offers.

Max\ - \ Length: 500000 (which includes HTML markup/tags)" + type: string + description: 'The description of the eBay listing that is part of the unpublished or published offer. This field is always returned for published offers, but is only returned if set for unpublished offers.

Max Length: 500000 (which includes HTML markup/tags)' listingDuration: - type: "string" - description: "This field indicates the number of days that the listing will\ - \ be active.

This field is returned for both auction and fixed-price\ - \ listings; however, the value returned for fixed-price listings will\ - \ always be GTC. The GTC (Good 'Til Cancelled) listings are\ - \ automatically renewed each calendar month until the seller decides to\ - \ end the listing.

Note:\ - \ If the listing duration expires for an auction offer, the listing then\ - \ becomes available as a fixed-price offer and will be GTC. For\ - \ implementation help, refer to eBay\ - \ API documentation" + type: string + description: This field indicates the number of days that the listing will be active.

This field is returned for both auction and fixed-price listings; however, the value returned for fixed-price listings will always be GTC. The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.

Note: If the listing duration expires for an auction offer, the listing then becomes available as a fixed-price offer and will be GTC. For implementation help, refer to eBay API documentation listingPolicies: - description: "This container indicates the listing policies that are applied\ - \ to the offer. Listing policies include business policies, custom listing\ - \ policies, and fields that override shipping costs, enable eBay Plus\ - \ eligibility, or enable the Best Offer feature.

It is required\ - \ that the seller be opted into Business Policies before being able to\ - \ create live eBay listings through the Inventory API. Sellers can opt-in\ - \ to Business Policies through My eBay or by using the Account API's optInToProgram\ - \ call. Payment, return, and fulfillment listing policies may be created/managed\ - \ in My eBay or by using the listing policy calls of the sell Account\ - \ API. The sell Account API can also be used\ - \ to create and manage custom policies. For more information, see the\ - \ sell Account API.

For\ - \ unpublished offers where business policies have yet to be specified,\ - \ this container will be returned as empty." - $ref: "#/components/schemas/ListingPolicies" + description: This container indicates the listing policies that are applied to the offer. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature.

It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the sell Account API. The sell Account API can also be used to create and manage custom policies. For more information, see the sell Account API.

For unpublished offers where business policies have yet to be specified, this container will be returned as empty. + $ref: '#/components/schemas/ListingPolicies' listingStartDate: - type: "string" - description: "This timestamp is the date/time that the seller set for the\ - \ scheduled listing. With the scheduled listing feature, the seller can\ - \ set a time in the future that the listing will become active, instead\ - \ of the listing becoming active immediately after a publishOffer\ - \ call.

Scheduled listings do not always start at the exact date/time\ - \ specified by the seller, but the date/time of the timestamp returned\ - \ in getOffer/getOffers will be the\ - \ same as the timestamp passed into a 'Create' or 'Update' offer call.\ - \

This field is returned if set for an offer." + type: string + description: This timestamp is the date/time that the seller set for the scheduled listing. With the scheduled listing feature, the seller can set a time in the future that the listing will become active, instead of the listing becoming active immediately after a publishOffer call.

Scheduled listings do not always start at the exact date/time specified by the seller, but the date/time of the timestamp returned in getOffer/getOffers will be the same as the timestamp passed into a 'Create' or 'Update' offer call.

This field is returned if set for an offer. lotSize: - type: "integer" - description: "This field is only applicable and returned if the listing\ - \ is a lot listing. A lot listing is a listing that has multiple quantity\ - \ of the same product. An example would be a set of four identical car\ - \ tires. The integer value in this field is the number of identical items\ - \ being sold through the lot listing." - format: "int32" + type: integer + description: This field is only applicable and returned if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same product. An example would be a set of four identical car tires. The integer value in this field is the number of identical items being sold through the lot listing. + format: int32 marketplaceId: - type: "string" - description: "This enumeration value is the unique identifier of the eBay\ - \ site on which the offer is available, or will be made available. For\ - \ implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value is the unique identifier of the eBay site on which the offer is available, or will be made available. For implementation help, refer to eBay API documentation merchantLocationKey: - type: "string" - description: "The unique identifier of the inventory location. This identifier\ - \ is set up by the merchant when the inventory location is first created\ - \ with the createInventoryLocation call. Once this value\ - \ is set for an inventory location, it can not be modified. To get more\ - \ information about this inventory location, the getInventoryLocation\ - \ call can be used, passing in this value at the end of the call URI.

This\ - \ field is always returned for published offers, but is only returned\ - \ if set for unpublished offers.

Max length: 36" + type: string + description: 'The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the createInventoryLocation call. Once this value is set for an inventory location, it can not be modified. To get more information about this inventory location, the getInventoryLocation call can be used, passing in this value at the end of the call URI.

This field is always returned for published offers, but is only returned if set for unpublished offers.

Max length: 36' offerId: - type: "string" - description: "The unique identifier of the offer. This identifier is used\ - \ in many offer-related calls, and it is also used in the bulkUpdatePriceQuantity\ - \ call." + type: string + description: The unique identifier of the offer. This identifier is used in many offer-related calls, and it is also used in the bulkUpdatePriceQuantity call. pricingSummary: - description: "This container shows the listing price for the product offer,\ - \ and if applicable, the settings for the Minimum Advertised Price and\ - \ Strikethrough Pricing features. The Minimum Advertised Price feature\ - \ is only available on the US site. Strikethrough Pricing is available\ - \ on the US, eBay Motors, UK, Germany, Canada (English and French), France,\ - \ Italy, and Spain sites.

For unpublished offers where pricing\ - \ information has yet to be specified, this container will be returned\ - \ as empty." - $ref: "#/components/schemas/PricingSummary" + description: This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.

For unpublished offers where pricing information has yet to be specified, this container will be returned as empty. + $ref: '#/components/schemas/PricingSummary' quantityLimitPerBuyer: - type: "integer" - description: "This field is only applicable and set if the seller wishes\ - \ to set a restriction on the purchase quantity of an inventory item per\ - \ seller. If this field is set by the seller for the offer, then each\ - \ distinct buyer may purchase up to, but not exceed the quantity in this\ - \ field. So, if this field's value is 5, each buyer may purchase\ - \ a quantity of the inventory item between one and five, and the purchases\ - \ can occur in one multiple-quantity purchase, or over multiple transactions.\ - \ If a buyer attempts to purchase one or more of these products, and the\ - \ cumulative quantity will take the buyer beyond the quantity limit, that\ - \ buyer will be blocked from that purchase.
" - format: "int32" + type: integer + description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity in this field. So, if this field's value is 5, each buyer may purchase a quantity of the inventory item between one and five, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.
+ format: int32 secondaryCategoryId: - type: "string" - description: "The unique identifier for a secondary category. This field\ - \ is applicable if the seller decides to list the item under two categories.\ - \ Sellers can use the getCategorySuggestions method of the Taxonomy\ - \ API to retrieve suggested category ID values. A fee may be charged when\ - \ adding a secondary category to a listing.

Note: You cannot list US eBay Motors\ - \ vehicles in two categories. However, you can list Parts & Accessories\ - \ in two categories." + type: string + description: The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing.

Note: You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. sku: - type: "string" - description: "This is the seller-defined SKU value of the product in the\ - \ offer.

Max Length: 50
" + type: string + description: 'This is the seller-defined SKU value of the product in the offer.

Max Length: 50
' status: - type: "string" - description: "The enumeration value in this field specifies the status of\ - \ the offer - either PUBLISHED or UNPUBLISHED.\ - \ For implementation help, refer to eBay\ - \ API documentation" + type: string + description: The enumeration value in this field specifies the status of the offer - either PUBLISHED or UNPUBLISHED. For implementation help, refer to eBay API documentation storeCategoryNames: - type: "array" - description: "This container is returned if the seller chose to place the\ - \ inventory item into one or two eBay store categories that the seller\ - \ has set up for their eBay store. The string value(s) in this container\ - \ will be the full path(s) to the eBay store categories, as shown below:
\ - \ 
\"storeCategoryNames\": [
 \"/Fashion/Men/Shirts\", 
\
-            \ \"/Fashion/Men/Accessories\" ],
" + type: array + description: 'This container is returned if the seller chose to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) in this container will be the full path(s) to the eBay store categories, as shown below:
"storeCategoryNames": [
 "/Fashion/Men/Shirts", 
 "/Fashion/Men/Accessories" ],
' items: - type: "string" + type: string tax: - description: "This container is only returned if a sales tax table, a Value-Added\ - \ Tax (VAT) rate, and/or a tax exception category code was applied to\ - \ the offer. Only Business Sellers can apply VAT to their listings. It\ - \ is possible that the applyTax field will be included\ - \ with a value of true, but a buyer's purchase will not involve\ - \ sales tax. A sales tax rate must be set up in the seller's sales tax\ - \ table for the buyer's state/tax jurisdiction in order for that buyer\ - \ to be subject to sales tax.

See the Using a tax table help page for more information\ - \ on setting up and using a sales tax table." - $ref: "#/components/schemas/Tax" - description: "This type provides details of an offer, and is used by the response\ - \ payloads of the getOffer and the getOffers\ - \ calls." + description: This container is only returned if a sales tax table, a Value-Added Tax (VAT) rate, and/or a tax exception category code was applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax.

See the Using a tax table help page for more information on setting up and using a sales tax table. + $ref: '#/components/schemas/Tax' + description: This type provides details of an offer, and is used by the response payloads of the getOffer and the getOffers calls. EbayOfferDetailsWithId: - type: "object" + type: object properties: availableQuantity: - type: "integer" - description: "This integer value sets the quantity of the inventory item\ - \ that will be available through the offer. Quantity must be set to 1\ - \ or more in order for the inventory item to be purchasable. This value\ - \ should not be more than the quantity that is specified for the inventory\ - \ item record. For auction listings, this value must be 1.\ - \

If this field exists for the current unpublished or published\ - \ offer, it should be provided again in the updateOffer\ - \ call, even if the value is not changing. If this particular field is\ - \ omitted in an updateOffer call, the general available\ - \ quantity set for the inventory item record may be used instead, and\ - \ this may not be accurate if the inventory item is being sold across\ - \ multiple marketplaces." - format: "int32" + type: integer + description: This integer value sets the quantity of the inventory item that will be available through the offer. Quantity must be set to 1 or more in order for the inventory item to be purchasable. This value should not be more than the quantity that is specified for the inventory item record. For auction listings, this value must be 1.

If this field exists for the current unpublished or published offer, it should be provided again in the updateOffer call, even if the value is not changing. If this particular field is omitted in an updateOffer call, the general available quantity set for the inventory item record may be used instead, and this may not be accurate if the inventory item is being sold across multiple marketplaces. + format: int32 categoryId: - type: "string" - description: "The unique identifier of the eBay category that the inventory\ - \ item is/will be listed under. This field is not immediately required\ - \ for an unpublished offer, but will be required before publishing the\ - \ offer. Sellers can use the getCategorySuggestions method of the Taxonomy\ - \ API to retrieve suggested category ID values. The seller passes in a\ - \ query string like \"iPhone 6\", and category ID values for\ - \ suggested categories are returned in the response.

If this\ - \ field exists for the current unpublished offer, it should be provided\ - \ again in the updateOffer call, even if the eBay category\ - \ is not changing. For a published offer (aka active eBay listing), this\ - \ field must be provided or an error may occur. The eBay category of an\ - \ active eBay listing cannot be changed once the listing has one or more\ - \ sales, or if the listing is scheduled to end in less than 12 hours." + type: string + description: The unique identifier of the eBay category that the inventory item is/will be listed under. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. The seller passes in a query string like "iPhone 6", and category ID values for suggested categories are returned in the response.

If this field exists for the current unpublished offer, it should be provided again in the updateOffer call, even if the eBay category is not changing. For a published offer (aka active eBay listing), this field must be provided or an error may occur. The eBay category of an active eBay listing cannot be changed once the listing has one or more sales, or if the listing is scheduled to end in less than 12 hours. charity: - description: "This container is used if the seller wishes to update a published\ - \ or unpublished offer with a charitable organization that will receive\ - \ a percentage of sale proceeds for each sale generated by the eBay listing.\ - \ This container consists of the charityId field to identify\ - \ the charitable organization, and the donationPercentage\ - \ field that indicates the percentage of the sales proceeds that will\ - \ be donated to the charitable organization for each sale. Both fields\ - \ in this container are conditionally required for charitable listings." - $ref: "#/components/schemas/Charity" + description: This container is used if the seller wishes to update a published or unpublished offer with a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing. This container consists of the charityId field to identify the charitable organization, and the donationPercentage field that indicates the percentage of the sales proceeds that will be donated to the charitable organization for each sale. Both fields in this container are conditionally required for charitable listings. + $ref: '#/components/schemas/Charity' extendedProducerResponsibility: - description: "This container provides IDs for the producer or importer related\ - \ to the new item, packaging, added documentation, or an eco-participation\ - \ fee. In some markets, such as in France, this may be the importer of\ - \ the item. This field is supported by a limited number of sites and specific\ - \ categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell\ - \ Metatdata API to retrieve valid categories for a site." - $ref: "#/components/schemas/ExtendedProducerResponsibility" + description: This container provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. This field is supported by a limited number of sites and specific categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metatdata API to retrieve valid categories for a site. + $ref: '#/components/schemas/ExtendedProducerResponsibility' hideBuyerDetails: - type: "boolean" - description: "This field is included and set to true if the\ - \ seller wishes to update a published or unpublished offer with the private\ - \ listing feature. Alternatively, the seller could also remove the private\ - \ listing feature (if already set for a published or unpublished offer)\ - \ by including this field and setting it to false.

\ - \ Sellers may want to use this option when they believe that a listing's\ - \ potential bidders/buyers would not want their obfuscated user IDs (and\ - \ feedback scores) exposed to other users." + type: boolean + description: This field is included and set to true if the seller wishes to update a published or unpublished offer with the private listing feature. Alternatively, the seller could also remove the private listing feature (if already set for a published or unpublished offer) by including this field and setting it to false.

Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. includeCatalogProductDetails: - type: "boolean" - description: "This field indicates whether or not eBay product catalog details\ - \ are applied to a listing. A value of true indicates the\ - \ listing corresponds to the eBay product associated with the provided\ - \ product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Note: Though the includeCatalogProductDetails\ - \ parameter is not required to be submitted in the request, the parameter\ - \ defaults to 'true' if omitted.

" + type: boolean + description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted.

listingDescription: - type: "string" - description: "The text in this field is (published offers), or will become\ - \ (unpublished offers) the description of the eBay listing. This field\ - \ is not immediately required for an unpublished offer, but will be required\ - \ before publishing the offer. Note that if the listingDescription\ - \ field was omitted in the createOffer call for the offer,\ - \ the offer entity should have picked up the text provided in the product.description\ - \ field of the inventory item record, or if the inventory item is part\ - \ of a group, the offer entity should have picked up the text provided\ - \ in the description field of the inventory item group\ - \ record.

HTML tags and markup can be used in listing descriptions,\ - \ but each character counts toward the max length limit.

Note: To ensure that their short\ - \ listing description is optimized when viewed on mobile devices, sellers\ - \ should strongly consider using eBay's View Item description summary feature when listing\ - \ their items. Keep in mind that the 'short' listing description is what\ - \ prospective buyers first see when they view the listing on a mobile\ - \ device. The 'full' listing description is also available to mobile users\ - \ when they click on the short listing description, but the full description\ - \ is not automatically optimized for viewing in mobile devices, and many\ - \ users won't even drill down to the full description.

Using HTML\ - \ div and span tag attributes, this feature allows sellers to customize\ - \ and fully control the short listing description that is displayed to\ - \ prospective buyers when viewing the listing on a mobile device. The\ - \ short listing description on mobile devices is limited to 800 characters,\ - \ and whenever the full listing description (provided in this field, in\ - \ UI, or seller tool) exceeds this limit, eBay uses a special algorithm\ - \ to derive the best possible short listing description within the 800-character\ - \ limit. However, due to some short listing description content being\ - \ removed, it is definitely not ideal for the seller, and could lead to\ - \ a bad buyer experience and possibly to a Significantly not as described\ - \ (SNAD) case, since the buyer may not get complete details on the item\ - \ when viewing the short listing description. See the eBay help page for\ - \ more details on using the HTML div and span tags.

If\ - \ this field exists for the current unpublished offer, it should be provided\ - \ again in the updateOffer call, even if the text is\ - \ not changing. For a published offer (aka active eBay listing), this\ - \ field must be provided or an error may occur.

Max length:\ - \ 500000 (which includes HTML markup/tags)" + type: string + description: 'The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Note that if the listingDescription field was omitted in the createOffer call for the offer, the offer entity should have picked up the text provided in the product.description field of the inventory item record, or if the inventory item is part of a group, the offer entity should have picked up the text provided in the description field of the inventory item group record.

HTML tags and markup can be used in listing descriptions, but each character counts toward the max length limit.

Note: To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s View Item description summary feature when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.

Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.

If this field exists for the current unpublished offer, it should be provided again in the updateOffer call, even if the text is not changing. For a published offer (aka active eBay listing), this field must be provided or an error may occur.

Max length: 500000 (which includes HTML markup/tags)' listingDuration: - type: "string" - description: "This field indicates the number of days that the listing will\ - \ be active. For fixed-price listings, this value must be set to GTC,\ - \ but auction listings support different listing durations.

\ - \ The GTC (Good 'Til Cancelled) listings are automatically renewed each\ - \ calendar month until the seller decides to end the listing.
Note: If the listing duration\ - \ expires for an auction offer without a winning bidder, the listing then\ - \ becomes available as a fixed-price offer and listing duration will be\ - \ GTC. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to GTC, but auction listings support different listing durations.

The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.

Note: If the listing duration expires for an auction offer without a winning bidder, the listing then becomes available as a fixed-price offer and listing duration will be GTC. For implementation help, refer to eBay API documentation listingPolicies: - description: "This container sets listing policies that will be used to\ - \ construct the listing. Listing policies include business policies, custom\ - \ listing policies, and fields that override shipping costs, enable eBay\ - \ Plus eligibility, or enable the Best Offer feature. This container is\ - \ not initially required when creating an offer but will become required\ - \ before the offer can be published. Busines policies (payment, return,\ - \ fulfillment policies) will always be required before publishing an offer.\ - \ Other policies, including the seller created compliance policies and\ - \ seller created take-back policy, will be required as needed by the marketplace,\ - \ category, or product.
This container is required for updating\ - \ published offers, regardless of whether or not the business policies\ - \ are being changed or not. For an unpublished offer, this field is not\ - \ necessarily required, but will be required before an offer can be published.

It\ - \ is required that the seller be opted in to Business Policies before\ - \ being able to create live eBay listings through the Inventory API. Sellers\ - \ can opt-in to Business Policies through My eBay or by using the Account\ - \ API's optInToProgram call. Similarly, payment, return,\ - \ and fulfillment business policies may be created/managed in My eBay\ - \ or by using the business policy calls of the Account API." - $ref: "#/components/schemas/ListingPolicies" + description: This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published. Busines policies (payment, return, fulfillment policies) will always be required before publishing an offer. Other policies, including the seller created compliance policies and seller created take-back policy, will be required as needed by the marketplace, category, or product.
This container is required for updating published offers, regardless of whether or not the business policies are being changed or not. For an unpublished offer, this field is not necessarily required, but will be required before an offer can be published.

It is required that the seller be opted in to Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Similarly, payment, return, and fulfillment business policies may be created/managed in My eBay or by using the business policy calls of the Account API. + $ref: '#/components/schemas/ListingPolicies' listingStartDate: - type: "string" - description: "This field can be used with an unpublished offer if the seller\ - \ wants to specify a time in the future that the listing will become active\ - \ on eBay. The timestamp supplied in this field should be in UTC format,\ - \ and it should be far enough in the future so that the seller will have\ - \ enough time to publish the listing with the publishOffer\ - \ method.

This field is optional, and it doesn't apply to offers\ - \ where the corresponding listing is already active. If this field is\ - \ not provided, the listing starts immediately after a successful publishOffer\ - \ method." + type: string + description: This field can be used with an unpublished offer if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enough time to publish the listing with the publishOffer method.

This field is optional, and it doesn't apply to offers where the corresponding listing is already active. If this field is not provided, the listing starts immediately after a successful publishOffer method. lotSize: - type: "integer" - description: "This field is only applicable if the listing is a lot listing.\ - \ A lot listing is a listing that has multiple quantity of the same item,\ - \ such as four identical tires being sold as a single offer, or it can\ - \ be a mixed lot of similar items, such as used clothing items or an assortment\ - \ of baseball cards. Whether the lot listing involved identical items\ - \ or a mixed lot, the integer value passed into this field is the total\ - \ number of items in the lot. Lots can be used for auction and fixed-price\ - \ listings." - format: "int32" + type: integer + description: This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards. Whether the lot listing involved identical items or a mixed lot, the integer value passed into this field is the total number of items in the lot. Lots can be used for auction and fixed-price listings. + format: int32 merchantLocationKey: - type: "string" - description: "The unique identifier of a merchant's inventory location (where\ - \ the inventory item in the offer is located). A merchantLocationKey\ - \ value is established when the merchant creates an inventory location\ - \ using the createInventoryLocation call. To get more\ - \ information about inventory locations, the getInventoryLocation\ - \ call can be used.

This field is not initially required upon\ - \ first creating an offer, but will become required before an offer can\ - \ be published.

Max length: 36" + type: string + description: 'The unique identifier of a merchant''s inventory location (where the inventory item in the offer is located). A merchantLocationKey value is established when the merchant creates an inventory location using the createInventoryLocation call. To get more information about inventory locations, the getInventoryLocation call can be used.

This field is not initially required upon first creating an offer, but will become required before an offer can be published.

Max length: 36' pricingSummary: - description: "This container shows the listing price for the product offer,\ - \ and if applicable, the settings for the Minimum Advertised Price and\ - \ Strikethrough Pricing features. The Minimum Advertised Price feature\ - \ is only available on the US site. Strikethrough Pricing is available\ - \ on the US, eBay Motors, UK, Germany, Canada (English and French), France,\ - \ Italy, and Spain sites.

This container is required for updating\ - \ published offers, regardless of whether or not the pricing information\ - \ is being changed or not. For an unpublished offer, this container is\ - \ not necessarily required, but an offer price will be required before\ - \ an offer can be published, and if a pricingSummary\ - \ container already exists for an unpublished offer, it must be provided\ - \ again, even if the values are not changing." - $ref: "#/components/schemas/PricingSummary" + description: This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.

This container is required for updating published offers, regardless of whether or not the pricing information is being changed or not. For an unpublished offer, this container is not necessarily required, but an offer price will be required before an offer can be published, and if a pricingSummary container already exists for an unpublished offer, it must be provided again, even if the values are not changing. + $ref: '#/components/schemas/PricingSummary' quantityLimitPerBuyer: - type: "integer" - description: "This field is only applicable and set if the seller wishes\ - \ to set a restriction on the purchase quantity per seller. If this field\ - \ is set by the seller for the offer, then each distinct buyer may purchase\ - \ up to, but not exceeding the quantity specified for this field. So,\ - \ if this field's value is 5, each buyer may purchase between\ - \ one to five of these products, and the purchases can occur in one multiple-quantity\ - \ purchase, or over multiple transactions. If a buyer attempts to purchase\ - \ one or more of these products, and the cumulative quantity will take\ - \ the buyer beyond the quantity limit, that buyer will be blocked from\ - \ that purchase.

If this field currently exists for an unpublished\ - \ or published offer, it should be provided again in an updateOffer\ - \ call, even if the value is not changing.
" - format: "int32" + type: integer + description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceeding the quantity specified for this field. So, if this field's value is 5, each buyer may purchase between one to five of these products, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.

If this field currently exists for an unpublished or published offer, it should be provided again in an updateOffer call, even if the value is not changing.
+ format: int32 secondaryCategoryId: - type: "string" - description: "The unique identifier for a secondary category. This field\ - \ is applicable if the seller decides to list the item under two categories.\ - \ Sellers can use the getCategorySuggestions method of the Taxonomy\ - \ API to retrieve suggested category ID values. A fee may be charged when\ - \ adding a secondary category to a listing.

Note: You cannot list US eBay Motors\ - \ vehicles in two categories. However, you can list Parts & Accessories\ - \ in two categories." + type: string + description: The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing.

Note: You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. storeCategoryNames: - type: "array" - description: "This container is used if the seller would like to place the\ - \ inventory item into one or two store categories that the seller has\ - \ set up for their eBay store. The string value(s) passed in to this container\ - \ will be the full path(s) to the store categories, as shown below:
\ - \ 
\"storeCategoryNames\": [
 \"/Fashion/Men/Shirts\", 
\
-            \ \"/Fashion/Men/Accessories\" ],
If this field currently\ - \ exists for an unpublished or published offer, it should be provided\ - \ again in an updateOffer call, even if the eBay categories\ - \ are not changing." + type: array + description: 'This container is used if the seller would like to place the inventory item into one or two store categories that the seller has set up for their eBay store. The string value(s) passed in to this container will be the full path(s) to the store categories, as shown below:
"storeCategoryNames": [
 "/Fashion/Men/Shirts", 
 "/Fashion/Men/Accessories" ],
If this field currently exists for an unpublished or published offer, it should be provided again in an updateOffer call, even if the eBay categories are not changing.' items: - type: "string" + type: string tax: - description: "This container is only applicable and used if a sales tax\ - \ table, a Value-Added Tax (VAT) rate, or a tax exception category code\ - \ will be applied to the offer. Only Business Sellers can apply VAT to\ - \ their listings. It is possible that the applyTax field\ - \ will be included with a value of true, but a buyer's purchase\ - \ will not involve sales tax. A sales tax rate must be set up in the seller's\ - \ sales tax table for the buyer's state/tax jurisdiction in order for\ - \ that buyer to be subject to sales tax. Sales tax rates for different\ - \ jurisdictions can be added/modified in the Payment Preferences section\ - \ of My eBay, or the seller can use the sales tax calls of the Account\ - \ API.

If tax information currently exists for an unpublished\ - \ or published offer, it should be provided again in an updateOffer\ - \ call, even if none of the tax settings are changing.

See the\ - \ Using a tax table help page for more information\ - \ on setting up and using a sales tax table." - $ref: "#/components/schemas/Tax" - description: "This type provides details of an offer, and is used by the base\ - \ request payload of the updateOffer call. Every field that\ - \ is currently set with the unpublished/published offer must also be passed\ - \ into the updateOffer call, even those fields whose values\ - \ are not changing. Note that for published offers, a successful updateOffer\ - \ call will actually update the active eBay listing with whatever changes\ - \ were made." + description: This container is only applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax. Sales tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the Account API.

If tax information currently exists for an unpublished or published offer, it should be provided again in an updateOffer call, even if none of the tax settings are changing.

See the Using a tax table help page for more information on setting up and using a sales tax table. + $ref: '#/components/schemas/Tax' + description: This type provides details of an offer, and is used by the base request payload of the updateOffer call. Every field that is currently set with the unpublished/published offer must also be passed into the updateOffer call, even those fields whose values are not changing. Note that for published offers, a successful updateOffer call will actually update the active eBay listing with whatever changes were made. EbayOfferDetailsWithKeys: - type: "object" + type: object properties: availableQuantity: - type: "integer" - description: "This integer value sets the quantity of the inventory item\ - \ (specified by the sku value) that will be available\ - \ for purchase by buyers shopping on the eBay site specified in the marketplaceId\ - \ field. Quantity must be set to 1 or more in order for the\ - \ inventory item to be purchasable, but this field is not necessarily\ - \ required, even for published offers, if the general quantity of the\ - \ inventory item has already been set in the inventory item record.

\ - \ For auction listings, this value must be 1." - format: "int32" + type: integer + description: This integer value sets the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field. Quantity must be set to 1 or more in order for the inventory item to be purchasable, but this field is not necessarily required, even for published offers, if the general quantity of the inventory item has already been set in the inventory item record.

For auction listings, this value must be 1. + format: int32 categoryId: - type: "string" - description: "The unique identifier of the eBay category that the product\ - \ will be listed under. This field is not immediately required upon creating\ - \ an offer, but will be required before publishing the offer. Sellers\ - \ can use the getCategorySuggestions method of the Taxonomy\ - \ API to retrieve suggested category ID values. The seller passes in a\ - \ query string like \"iPhone 6\", and category ID values for\ - \ suggested categories are returned in the response." + type: string + description: The unique identifier of the eBay category that the product will be listed under. This field is not immediately required upon creating an offer, but will be required before publishing the offer. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. The seller passes in a query string like "iPhone 6", and category ID values for suggested categories are returned in the response. charity: - description: "This container is used if the seller wishes to select a charitable\ - \ organization that will receive a percentage of sale proceeds for each\ - \ sale generated by the eBay listing. This container consists of the charityId\ - \ field to identify the charitable organization, and the donationPercentage\ - \ field that indicates the percentage of the sales proceeds that will\ - \ be donated to the charitable organization for each sale. Both fields\ - \ in this container are conditionally required for charitable listings." - $ref: "#/components/schemas/Charity" + description: This container is used if the seller wishes to select a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing. This container consists of the charityId field to identify the charitable organization, and the donationPercentage field that indicates the percentage of the sales proceeds that will be donated to the charitable organization for each sale. Both fields in this container are conditionally required for charitable listings. + $ref: '#/components/schemas/Charity' extendedProducerResponsibility: - description: "This container provides IDs for the producer or importer related\ - \ to the new item, packaging, added documentation, or an eco-participation\ - \ fee. In some markets, such as in France, this may be the importer of\ - \ the item. This field is supported by a limited number of sites and specific\ - \ categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell\ - \ Metatdata API to retrieve valid categories for a site." - $ref: "#/components/schemas/ExtendedProducerResponsibility" + description: This container provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. This field is supported by a limited number of sites and specific categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metatdata API to retrieve valid categories for a site. + $ref: '#/components/schemas/ExtendedProducerResponsibility' format: - type: "string" - description: "This enumerated value indicates the listing format of the\ - \ offer.

Supported values are FIXED_PRICE and AUCTION.\ - \ For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumerated value indicates the listing format of the offer.

Supported values are FIXED_PRICE and AUCTION. For implementation help, refer to eBay API documentation hideBuyerDetails: - type: "boolean" - description: "This field is included and set to true if the\ - \ seller wishes to create a private listing.

Sellers may want\ - \ to use this option when they believe that a listing's potential bidders/buyers\ - \ would not want their obfuscated user IDs (and feedback scores) exposed\ - \ to other users." + type: boolean + description: This field is included and set to true if the seller wishes to create a private listing.

Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. includeCatalogProductDetails: - type: "boolean" - description: "This field indicates whether or not eBay product catalog details\ - \ are applied to a listing. A value of true indicates the\ - \ listing corresponds to the eBay product associated with the provided\ - \ product identifier. The product identifier is provided in createOrReplaceInventoryItem.

\ - \ Default: true

Note:\ - \ Though the includeCatalogProductDetails parameter is\ - \ not required to be submitted in the request, the parameter defaults\ - \ to true if omitted.

" + type: boolean + description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Default: true

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted.

listingDescription: - type: "string" - description: "The text in this field is (published offers), or will become\ - \ (unpublished offers) the description of the eBay listing. This field\ - \ is not immediately required for an unpublished offer, but will be required\ - \ before publishing the offer. Note that if the listingDescription\ - \ field was omitted in the createOffer call for the offer,\ - \ the offer entity should have picked up the text provided in the product.description\ - \ field of the inventory item record, or if the inventory item is part\ - \ of a group, the offer entity should have picked up the text provided\ - \ in the description field of the inventory item group\ - \ record.

HTML tags and markup can be used in listing descriptions,\ - \ but each character counts toward the max length limit.

Note: To ensure that their short\ - \ listing description is optimized when viewed on mobile devices, sellers\ - \ should strongly consider using eBay's View Item description summary feature when listing\ - \ their items. Keep in mind that the 'short' listing description is what\ - \ prospective buyers first see when they view the listing on a mobile\ - \ device. The 'full' listing description is also available to mobile users\ - \ when they click on the short listing description, but the full description\ - \ is not automatically optimized for viewing in mobile devices, and many\ - \ users won't even drill down to the full description.

Using HTML\ - \ div and span tag attributes, this feature allows sellers to customize\ - \ and fully control the short listing description that is displayed to\ - \ prospective buyers when viewing the listing on a mobile device. The\ - \ short listing description on mobile devices is limited to 800 characters,\ - \ and whenever the full listing description (provided in this field, in\ - \ UI, or seller tool) exceeds this limit, eBay uses a special algorithm\ - \ to derive the best possible short listing description within the 800-character\ - \ limit. However, due to some short listing description content being\ - \ removed, it is definitely not ideal for the seller, and could lead to\ - \ a bad buyer experience and possibly to a Significantly not as described\ - \ (SNAD) case, since the buyer may not get complete details on the item\ - \ when viewing the short listing description. See the eBay help page for\ - \ more details on using the HTML div and span tags.

Max\ - \ length: 500000 (which includes HTML markup/tags)" + type: string + description: 'The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Note that if the listingDescription field was omitted in the createOffer call for the offer, the offer entity should have picked up the text provided in the product.description field of the inventory item record, or if the inventory item is part of a group, the offer entity should have picked up the text provided in the description field of the inventory item group record.

HTML tags and markup can be used in listing descriptions, but each character counts toward the max length limit.

Note: To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s View Item description summary feature when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.

Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.

Max length: 500000 (which includes HTML markup/tags)' listingDuration: - type: "string" - description: "This field indicates the number of days that the listing will\ - \ be active. For fixed-price listings, this value must be set to GTC,\ - \ but auction listings support different listing durations.

\ - \ The GTC (Good 'Til Cancelled) listings are automatically renewed each\ - \ calendar month until the seller decides to end the listing.
Note: If the listing duration\ - \ expires for an auction offer without a winning bidder, the listing then\ - \ becomes available as a fixed-price offer and listing duration will be\ - \ GTC. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to GTC, but auction listings support different listing durations.

The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.

Note: If the listing duration expires for an auction offer without a winning bidder, the listing then becomes available as a fixed-price offer and listing duration will be GTC. For implementation help, refer to eBay API documentation listingPolicies: - description: "This container sets listing policies that will be used to\ - \ construct the listing. Listing policies include business policies, custom\ - \ listing policies, and fields that override shipping costs, enable eBay\ - \ Plus eligibility, or enable the Best Offer feature. This container is\ - \ not initially required when creating an offer but will become required\ - \ before the offer can be published. Busines policies (payment, return,\ - \ fulfillment policies) will always be required before publishing an offer.\ - \ Other policies, including the seller created compliance policies and\ - \ seller created take-back policy, will be required as needed by the marketplace,\ - \ category, or product.

It is required that the seller be opted\ - \ into Business Policies before being able to create live eBay listings\ - \ through the Inventory API. Sellers can opt-in to Business Policies through\ - \ My eBay or by using the Account API's optInToProgram\ - \ call. Payment, return, and fulfillment listing policies may be created/managed\ - \ in My eBay or by using the listing policy calls of the sell Account\ - \ API. The sell Account API can also be used\ - \ to create and manage custom policies. For more information, see the\ - \ sell Account API." - $ref: "#/components/schemas/ListingPolicies" + description: This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published. Busines policies (payment, return, fulfillment policies) will always be required before publishing an offer. Other policies, including the seller created compliance policies and seller created take-back policy, will be required as needed by the marketplace, category, or product.

It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the sell Account API. The sell Account API can also be used to create and manage custom policies. For more information, see the sell Account API. + $ref: '#/components/schemas/ListingPolicies' listingStartDate: - type: "string" - description: "This field can be used if the seller wants to specify a time\ - \ in the future that the listing will become active on eBay. The timestamp\ - \ supplied in this field should be in UTC format, and it should be far\ - \ enough in the future so that the seller will have enought time to publish\ - \ the listing with the publishOffer method.

This\ - \ field is optional. If this field is not provided, the listing starts\ - \ immediately after a successful publishOffer method." + type: string + description: This field can be used if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enought time to publish the listing with the publishOffer method.

This field is optional. If this field is not provided, the listing starts immediately after a successful publishOffer method. lotSize: - type: "integer" - description: "This field is only applicable if the listing is a lot listing.\ - \ A lot listing is a listing that has multiple quantity of the same item,\ - \ such as four identical tires being sold as a single offer, or it can\ - \ be a mixed lot of similar items, such as used clothing items or an assortment\ - \ of baseball cards. Whether the lot listing involved identical items\ - \ or a mixed lot, the integer value passed into this field is the total\ - \ number of items in the lot. Lots can be used for auction and fixed-price\ - \ listings." - format: "int32" + type: integer + description: This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards. Whether the lot listing involved identical items or a mixed lot, the integer value passed into this field is the total number of items in the lot. Lots can be used for auction and fixed-price listings. + format: int32 marketplaceId: - type: "string" - description: "This enumeration value is the unique identifier of the eBay\ - \ site for which the offer will be made available. See MarketplaceEnum\ - \ for the list of supported enumeration values. This field is required.\ - \ For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for the list of supported enumeration values. This field is required. For implementation help, refer to eBay API documentation merchantLocationKey: - type: "string" - description: "The unique identifier of a merchant's inventory location (where\ - \ the inventory item in the offer is located). A merchantLocationKey\ - \ value is established when the merchant creates an inventory location\ - \ using the createInventoryLocation call. To get more\ - \ information about inventory locations, the getInventoryLocation\ - \ call can be used.

This field is not initially required upon\ - \ first creating an offer, but will become required before an offer can\ - \ be published.

Max length: 36" + type: string + description: 'The unique identifier of a merchant''s inventory location (where the inventory item in the offer is located). A merchantLocationKey value is established when the merchant creates an inventory location using the createInventoryLocation call. To get more information about inventory locations, the getInventoryLocation call can be used.

This field is not initially required upon first creating an offer, but will become required before an offer can be published.

Max length: 36' pricingSummary: - description: "This container shows the listing price for the product offer,\ - \ and if applicable, the settings for the Minimum Advertised Price and\ - \ Strikethrough Pricing features. The Minimum Advertised Price feature\ - \ is only available on the US site. Strikethrough Pricing is available\ - \ on the US, eBay Motors, UK, Germany, Canada (English and French), France,\ - \ Italy, and Spain sites.

This container is not initially required\ - \ upon first creating an offer, but the price of the offer will become\ - \ required before an offer can be published." - $ref: "#/components/schemas/PricingSummary" + description: This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.

This container is not initially required upon first creating an offer, but the price of the offer will become required before an offer can be published. + $ref: '#/components/schemas/PricingSummary' quantityLimitPerBuyer: - type: "integer" - description: "This field is only applicable and set if the seller wishes\ - \ to set a restriction on the purchase quantity per seller. If this field\ - \ is set by the seller for the offer, then each distinct buyer may purchase\ - \ up to, but not exceed the quantity specified for this field. So, if\ - \ this field's value is 5, each buyer may purchase between\ - \ one to five of these products, and the purchases can occur in one multiple-quantity\ - \ purchase, or over multiple transactions. If a buyer attempts to purchase\ - \ one or more of these products, and the cumulative quantity will take\ - \ the buyer beyond the quantity limit, that buyer will be blocked from\ - \ that purchase.
" - format: "int32" + type: integer + description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity specified for this field. So, if this field's value is 5, each buyer may purchase between one to five of these products, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.
+ format: int32 secondaryCategoryId: - type: "string" - description: "The unique identifier for a secondary category. This field\ - \ is applicable if the seller decides to list the item under two categories.\ - \ Sellers can use the getCategorySuggestions method of the Taxonomy\ - \ API to retrieve suggested category ID values. A fee may be charged when\ - \ adding a secondary category to a listing.

Note: You cannot list US eBay Motors\ - \ vehicles in two categories. However, you can list Parts & Accessories\ - \ in two categories." + type: string + description: The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing.

Note: You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. sku: - type: "string" - description: "This is the seller-defined SKU value of the product that will\ - \ be listed on the eBay site (specified in the marketplaceId\ - \ field). Only one offer (in unpublished or published state) may exist\ - \ for each sku/marketplaceId/format\ - \ combination. This field is required.

Max Length:\ - \ 50
" + type: string + description: 'This is the seller-defined SKU value of the product that will be listed on the eBay site (specified in the marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku/marketplaceId/format combination. This field is required.

Max Length: 50
' storeCategoryNames: - type: "array" - description: "This container is used if the seller would like to place the\ - \ inventory item into one or two eBay store categories that the seller\ - \ has set up for their eBay store. The string value(s) passed in to this\ - \ container will be the full path(s) to the eBay store categories, as\ - \ shown below:
\"storeCategoryNames\": [
 \"/Fashion/Men/Shirts\"\
-            , 
 \"/Fashion/Men/Accessories\" ],
" + type: array + description: 'This container is used if the seller would like to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) passed in to this container will be the full path(s) to the eBay store categories, as shown below:
"storeCategoryNames": [
 "/Fashion/Men/Shirts", 
 "/Fashion/Men/Accessories" ],
' items: - type: "string" + type: string tax: - description: "This container is only applicable and used if a sales tax\ - \ table, a Value-Added Tax (VAT) rate, or a tax exception category code\ - \ will be applied to the offer. Only Business Sellers can apply VAT to\ - \ their listings. It is possible that the applyTax field\ - \ will be included with a value of true, but a buyer's purchase\ - \ will not involve sales tax. A sales tax rate must be set up in the seller's\ - \ sales tax table for the buyer's state/tax jurisdiction in order for\ - \ that buyer to be subject to sales tax. Sales tax rates for different\ - \ jurisdictions can be added/modified in the Payment Preferences section\ - \ of My eBay, or the seller can use the sales tax calls of the Account\ - \ API.

See the Using a tax table help page for more information\ - \ on setting up and using a sales tax table." - $ref: "#/components/schemas/Tax" - description: "This type provides details of an offer, and is used by the base\ - \ request payload of the createOffer and bulkCreateOffer\ - \ methods." + description: This container is only applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax. Sales tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the Account API.

See the Using a tax table help page for more information on setting up and using a sales tax table. + $ref: '#/components/schemas/Tax' + description: This type provides details of an offer, and is used by the base request payload of the createOffer and bulkCreateOffer methods. Error: - type: "object" + type: object properties: category: - type: "string" - description: "This string value indicates the error category. There are\ - \ three categories of errors: request errors, application errors, and\ - \ system errors. " + type: string + description: 'This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. ' domain: - type: "string" - description: "The name of the domain in which the error or warning occurred." + type: string + description: The name of the domain in which the error or warning occurred. errorId: - type: "integer" - description: "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." - format: "int32" + type: integer + description: 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. + format: int32 inputRefIds: - type: "array" - description: "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." + type: array + description: 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. items: - type: "string" + type: string longMessage: - type: "string" - description: "A detailed description of the condition that caused the error\ - \ or warning, and information on what to do to correct the problem." + type: string + description: A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. message: - type: "string" - description: "A description of the condition that caused the error or warning." + type: string + description: A description of the condition that caused the error or warning. outputRefIds: - type: "array" - description: "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." + type: array + description: 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. items: - type: "string" + type: string parameters: - type: "array" - description: "Various warning and error messages return one or more variables\ - \ that contain contextual information about the error or waring. This\ - \ is often the field or value that triggered the error or warning." + type: array + description: Various warning and error messages return one or more variables that contain contextual information about the error or waring. This is often the field or value that triggered the error or warning. items: - $ref: "#/components/schemas/ErrorParameter" + $ref: '#/components/schemas/ErrorParameter' subdomain: - type: "string" - description: "The name of the subdomain in which the error or warning occurred." - description: "This type is used to express detailed information on errors and\ - \ warnings that may occur with a call request." + type: string + description: The name of the subdomain in which the error or warning occurred. + description: This type is used to express detailed information on errors and warnings that may occur with a call request. ErrorParameter: - type: "object" + type: object properties: name: - type: "string" - description: "This type contains the name and value of an input parameter\ - \ that contributed to a specific error or warning condition." + type: string + description: This type contains the name and value of an input parameter that contributed to a specific error or warning condition. value: - type: "string" - description: "This is the actual value that was passed in for the element\ - \ specified in the name field." - description: "This type is used to indicate the parameter field/value that caused\ - \ an issue with the call request." + type: string + description: This is the actual value that was passed in for the element specified in the name field. + description: This type is used to indicate the parameter field/value that caused an issue with the call request. ExtendedProducerResponsibility: - type: "object" + type: object properties: producerProductId: - type: "string" - description: "This ID is the Unique Identifier of the producer related to\ - \ the item. For instance, if the seller is selling a cell phone, it is\ - \ the ID related to the cell phone." + type: string + description: This ID is the Unique Identifier of the producer related to the item. For instance, if the seller is selling a cell phone, it is the ID related to the cell phone. productPackageId: - type: "string" - description: "The Unique ID of the producer of any packaging related to\ - \ the product added by the seller. This does not include package in which\ - \ the product is shipped (see ShipmentPackageID). For\ - \ instance, if the seller adds bubble wrap, it is the ID related to the\ - \ bubble wrap. " + type: string + description: 'The Unique ID of the producer of any packaging related to the product added by the seller. This does not include package in which the product is shipped (see ShipmentPackageID). For instance, if the seller adds bubble wrap, it is the ID related to the bubble wrap. ' shipmentPackageId: - type: "string" - description: "This ID is the Unique Identifier of the producer of any packaging\ - \ used by the seller to ship the item. This does not include non-shipping\ - \ packaging added to the product (see ProductPackageID).\ - \ This ID is required when the seller uses packaging to ship the item.\ - \ For instance, if the seller uses a different box to ship the item, it\ - \ is the ID related to the box." + type: string + description: This ID is the Unique Identifier of the producer of any packaging used by the seller to ship the item. This does not include non-shipping packaging added to the product (see ProductPackageID). This ID is required when the seller uses packaging to ship the item. For instance, if the seller uses a different box to ship the item, it is the ID related to the box. productDocumentationId: - type: "string" - description: "This ID is the Unique Identifier of the producer of any paper\ - \ added to the parcel of the item by the seller. For example, this ID\ - \ concerns any notice, leaflet, or paper that the seller adds to a cell\ - \ phone parcel." + type: string + description: This ID is the Unique Identifier of the producer of any paper added to the parcel of the item by the seller. For example, this ID concerns any notice, leaflet, or paper that the seller adds to a cell phone parcel. ecoParticipationFee: - description: "This is the fee paid for new items to the eco-organization\ - \ (for example, \"eco-organisme\" in France). It is a contribution to\ - \ the financing of the elimination of the item responsibly.

Minimum:\ - \ 0.0" - $ref: "#/components/schemas/Amount" - description: "This type provides IDs for the producer or importer related to\ - \ the new item, packaging, added documentation, or an eco-participation fee.\ - \ In some markets, such as in France, this may be the importer of the item." + description: This is the fee paid for new items to the eco-organization (for example, "eco-organisme" in France). It is a contribution to the financing of the elimination of the item responsibly.

Minimum: 0.0 + $ref: '#/components/schemas/Amount' + description: This type provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such as in France, this may be the importer of the item. Fee: - type: "object" + type: object properties: amount: - description: "This dollar value in this container is the actual dollar value\ - \ of the listing fee type specified in the feeType field." - $ref: "#/components/schemas/Amount" + description: This dollar value in this container is the actual dollar value of the listing fee type specified in the feeType field. + $ref: '#/components/schemas/Amount' feeType: - type: "string" - description: "The value returned in this field indicates the type of listing\ - \ fee that the seller may incur if one or more unpublished offers (offers\ - \ are specified in the call request) are published on the marketplace\ - \ specified in the marketplaceId field. Applicable listing\ - \ fees will often include things such as InsertionFee or\ - \ SubtitleFee, but many fee types will get returned even\ - \ when they are 0.0.

See the Standard selling fees help page for more information\ - \ on listing fees." + type: string + description: The value returned in this field indicates the type of listing fee that the seller may incur if one or more unpublished offers (offers are specified in the call request) are published on the marketplace specified in the marketplaceId field. Applicable listing fees will often include things such as InsertionFee or SubtitleFee, but many fee types will get returned even when they are 0.0.

See the Standard selling fees help page for more information on listing fees. promotionalDiscount: - description: "The dollar value in this container indicates any eBay promotional\ - \ discount applied toward the listing fee type specified in the feeType\ - \ field. If there was no discount applied toward the fee, this container\ - \ is still returned but its value is 0.0." - $ref: "#/components/schemas/Amount" - description: "This type is used to express expected listing fees that the seller\ - \ may incur for one or more unpublished offers, as well as any eBay-related\ - \ promotional discounts being applied toward a specific fee. These fees are\ - \ the expected cumulative fees per eBay marketplace (which is indicated in\ - \ the marketplaceId field)." + description: The dollar value in this container indicates any eBay promotional discount applied toward the listing fee type specified in the feeType field. If there was no discount applied toward the fee, this container is still returned but its value is 0.0. + $ref: '#/components/schemas/Amount' + description: This type is used to express expected listing fees that the seller may incur for one or more unpublished offers, as well as any eBay-related promotional discounts being applied toward a specific fee. These fees are the expected cumulative fees per eBay marketplace (which is indicated in the marketplaceId field). FeeSummary: - type: "object" + type: object properties: fees: - type: "array" - description: "This container is an array of listing fees that can be expected\ - \ to be applied to an offer on the specified eBay marketplace (marketplaceId\ - \ value). Many fee types will get returned even when they are 0.0.

See\ - \ the Standard selling fees help page for more information on listing\ - \ fees." + type: array + description: This container is an array of listing fees that can be expected to be applied to an offer on the specified eBay marketplace (marketplaceId value). Many fee types will get returned even when they are 0.0.

See the Standard selling fees help page for more information on listing fees. items: - $ref: "#/components/schemas/Fee" + $ref: '#/components/schemas/Fee' marketplaceId: - type: "string" - description: "This is the unique identifier of the eBay site for which \ - \ listing fees for the offer are applicable. For implementation help,\ - \ refer to eBay\ - \ API documentation" + type: string + description: This is the unique identifier of the eBay site for which listing fees for the offer are applicable. For implementation help, refer to eBay API documentation warnings: - type: "array" - description: "This container will contain an array of errors and/or warnings\ - \ when a call is made, and errors and/or warnings occur." + type: array + description: This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur. items: - $ref: "#/components/schemas/Error" - description: "This type is used to display the expected listing fees for each\ - \ unpublished offer specified in the request of the getListingFees\ - \ call." + $ref: '#/components/schemas/Error' + description: This type is used to display the expected listing fees for each unpublished offer specified in the request of the getListingFees call. FeesSummaryResponse: - type: "object" + type: object properties: feeSummaries: - type: "array" - description: "This container consists of an array of one or more listing\ - \ fees that the seller can expect to pay for unpublished offers specified\ - \ in the call request. Many fee types will get returned even when they\ - \ are 0.0." + type: array + description: This container consists of an array of one or more listing fees that the seller can expect to pay for unpublished offers specified in the call request. Many fee types will get returned even when they are 0.0. items: - $ref: "#/components/schemas/FeeSummary" - description: "This type is used by the base response payload for the getListingFees\ - \ call. " + $ref: '#/components/schemas/FeeSummary' + description: 'This type is used by the base response payload for the getListingFees call. ' FormatAllocation: - type: "object" + type: object properties: auction: - type: "integer" - description: "This integer value indicates the quantity of the inventory\ - \ item that is reserved for the published auction format offers of the\ - \ SKU." - format: "int32" + type: integer + description: This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU. + format: int32 fixedPrice: - type: "integer" - description: "This integer value indicates the quantity of the inventory\ - \ item that is available for the fixed-price offers of the SKU." - format: "int32" - description: "This type is used to indicate the quantities of the inventory\ - \ items that are reserved for the different listing formats of the SKU offers." + type: integer + description: This integer value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU. + format: int32 + description: This type is used to indicate the quantities of the inventory items that are reserved for the different listing formats of the SKU offers. GeoCoordinates: - type: "object" + type: object properties: latitude: - type: "number" - description: "The latitude (North-South) component of the geographic coordinate.\ - \ This field is required if a geoCoordinates container\ - \ is used.

This field is returned if geographical coordinates\ - \ are set for the inventory location." + type: number + description: The latitude (North-South) component of the geographic coordinate. This field is required if a geoCoordinates container is used.

This field is returned if geographical coordinates are set for the inventory location. longitude: - type: "number" - description: "The longitude (East-West) component of the geographic coordinate.\ - \ This field is required if a geoCoordinates container\ - \ is used.

This field is returned if geographical coordinates\ - \ are set for the inventory location." - description: "This type is used to express the Global Positioning System (GPS)\ - \ latitude and longitude coordinates of an inventory location." + type: number + description: The longitude (East-West) component of the geographic coordinate. This field is required if a geoCoordinates container is used.

This field is returned if geographical coordinates are set for the inventory location. + description: This type is used to express the Global Positioning System (GPS) latitude and longitude coordinates of an inventory location. GetInventoryItem: - type: "object" + type: object properties: sku: - type: "string" - description: "An array of SKU values are passed in under the sku\ - \ container to retrieve up to 25 inventory item records." - description: "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." + type: string + description: An array of SKU values are passed in under the sku container to retrieve up to 25 inventory item records. + description: 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. GetInventoryItemResponse: - type: "object" + type: object properties: errors: - type: "array" - description: "This container will be returned if there were one or more\ - \ errors associated with retrieving the inventory item record." + type: array + description: This container will be returned if there were one or more errors associated with retrieving the inventory item record. items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' inventoryItem: - description: "This container consists of detailed information on the inventory\ - \ item specified in the sku field." - $ref: "#/components/schemas/InventoryItemWithSkuLocaleGroupKeys" + description: This container consists of detailed information on the inventory item specified in the sku field. + $ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupKeys' sku: - type: "string" - description: "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." + type: string + description: 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. statusCode: - type: "integer" - description: "The HTTP status code returned in this field indicates the\ - \ success or failure of retrieving the inventory item record for the inventory\ - \ item specified in the sku field. See the HTTP\ - \ status codes table to see which each status code indicates." - format: "int32" + type: integer + description: The HTTP status code returned in this field indicates the success or failure of retrieving the inventory item record for the inventory item specified in the sku field. See the HTTP status codes table to see which each status code indicates. + format: int32 warnings: - type: "array" - description: "This container will be returned if there were one or more\ - \ warnings associated with retrieving the inventory item record." + type: array + description: This container will be returned if there were one or more warnings associated with retrieving the inventory item record. items: - $ref: "#/components/schemas/Error" - description: "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." + $ref: '#/components/schemas/Error' + description: 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. Interval: - type: "object" + type: object properties: close: - type: "string" - description: "The close value is actually the time that\ - \ the store closes. Local time (in Military format) is used. So, if a\ - \ store closed at 8 PM local time, the close time would\ - \ look like the following: 20:00:00. This field is conditionally\ - \ required if the intervals container is used to specify\ - \ working hours or special hours for a store.

This field is returned\ - \ if set for the store location." + type: string + description: 'The close value is actually the time that the store closes. Local time (in Military format) is used. So, if a store closed at 8 PM local time, the close time would look like the following: 20:00:00. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store.

This field is returned if set for the store location.' open: - type: "string" - description: "The open value is actually the time that\ - \ the store opens. Local time (in Military format) is used. So, if a store\ - \ opens at 9 AM local time, the close time would look\ - \ like the following: 09:00:00. This field is conditionally\ - \ required if the intervals container is used to specify\ - \ working hours or special hours for a store.

This field is returned\ - \ if set for the store location." - description: "This type is used by the intervals container\ - \ to define the opening and closing times of a store's working day. Local\ - \ time (in Military format) is used, with the following format: hh:mm:ss." + type: string + description: 'The open value is actually the time that the store opens. Local time (in Military format) is used. So, if a store opens at 9 AM local time, the close time would look like the following: 09:00:00. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store.

This field is returned if set for the store location.' + description: 'This type is used by the intervals container to define the opening and closing times of a store''s working day. Local time (in Military format) is used, with the following format: hh:mm:ss.' InventoryItem: - type: "object" + type: object properties: availability: - description: "This container is used to specify the quantity of the inventory\ - \ item that are available for purchase.

This container is\ - \ optional up until the seller is ready to publish an offer with the SKU,\ - \ at which time it becomes required. Availability data must also be passed\ - \ if an inventory item is being updated and availability data already\ - \ exists for that inventory item.

Since an inventory item\ - \ must have specified quantity before being published in an offer, this\ - \ container is always returned in the 'Get' calls for SKUs that are part\ - \ of a published offer. If a SKU is not part of a published offer, this\ - \ container will only be returned if set for the inventory item." - $ref: "#/components/schemas/Availability" + description: This container is used to specify the quantity of the inventory item that are available for purchase.

This container is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.

Since an inventory item must have specified quantity before being published in an offer, this container is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item. + $ref: '#/components/schemas/Availability' condition: - type: "string" - description: "This enumeration value indicates the condition of the item.\ - \ Supported item condition values will vary by eBay site and category.\ - \ To see which item condition values that a particular eBay category supports,\ - \ use the getItemConditionPolicies method of the Metadata API.\ - \ This method returns condition ID values that map to the enumeration\ - \ values defined in the ConditionEnum type. The Item condition ID and name values topic in the Selling Integration\ - \ Guide has a table that maps condition ID values to ConditionEnum\ - \ values. The getItemConditionPolicies call reference\ - \ page has more information.

A condition value\ - \ is optional up until the seller is ready to publish an offer with the\ - \ SKU, at which time it becomes required for most eBay categories. For\ - \ implementation help, refer to eBay\ - \ API documentation" + type: string + description: 'This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the getItemConditionPolicies method of the Metadata API. This method returns condition ID values that map to the enumeration values defined in the ConditionEnum type. The Item condition ID and name values topic in the Selling Integration Guide has a table that maps condition ID values to ConditionEnum values. The getItemConditionPolicies call reference page has more information.

A condition value is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required for most eBay categories.

Note: The ''Manufacturer Refurbished'' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value is no longer applicable, and should not be used. With Version 1.13.0, the CERTIFIED_REFURBISHED enumeration value has been introduced, and CR-eligible sellers should make a note to start using CERTIFIED_REFURBISHED from this point forward. For the time being, if the MANUFACTURER_REFURBISHED enum is used in a createOrReplaceInventoryItem method, it will be accepted but automatically converted by eBay to CERTIFIED_REFURBISHED. In the future, the MANUFACTURER_REFURBISHED may start triggering an error if used.

As of September 1, 2021, condition ID 2500 (''Seller Refurbished'') can no longer be used in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. The ''Seller Refurbished'' item condition will be replaced by one of three new refurbished values:
  • condition ID 2010 (''Excellent - Refurbished'')
  • condition ID 2020 (''Very Good - Refurbished'')
  • condition ID 2030 (''Good - Refurbished'')
To use any of these new refurbished item conditions in category 9355, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in category 9355 will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Any active listings in category 9355 that had condition ID 2500 (''Seller Refurbished'') as the item condition should have been administratively ended by eBay. Sellers will have to relist these items, and until they are eligible to list with the new refurbished item conditions, they will need to use another item condition supported in category 9355, such as condition ID 3000 (''Used'').

To list an item as ''Certified Refurbished'', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition.

Any seller that is interested in eligibility requirements to list with ''Certified Refurbished'' should see the Certified refurbished program page in Seller Center. For implementation help, refer to eBay API documentation' conditionDescription: - type: "string" - description: "This string field is used by the seller to more clearly describe\ - \ the condition of a used inventory item, or an inventory item whose condition\ - \ value is not NEW, LIKE_NEW, NEW_OTHER,\ - \ or NEW_WITH_DEFECTS.

The conditionDescription\ - \ field is available for all eBay categories. If the conditionDescription\ - \ field is used with an item in one of the new conditions (mentioned in\ - \ previous paragraph), eBay will simply ignore this field if included,\ - \ and eBay will return a warning message to the user.

This\ - \ field should only be used to further clarify the condition of the used\ - \ item. It should not be used for branding, promotions, shipping, returns,\ - \ payment or other information unrelated to the condition of the used\ - \ item. Make sure that the condition value, condition\ - \ description, listing description, and the item's pictures do not contradict\ - \ one another.

This field is not always required, but is\ - \ required if an inventory item is being updated and a condition description\ - \ already exists for that inventory item.

This field is returned\ - \ in the getInventoryItem and getInventoryItems\ - \ calls if a condition description was provided for a used inventory item.

Max\ - \ Length: 1000." + type: string + description: 'This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose condition value is not NEW, LIKE_NEW, NEW_OTHER, or NEW_WITH_DEFECTS.

The conditionDescription field is available for all eBay categories. If the conditionDescription field is used with an item in one of the new conditions (mentioned in previous paragraph), eBay will simply ignore this field if included, and eBay will return a warning message to the user.

This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the used item. Make sure that the condition value, condition description, listing description, and the item''s pictures do not contradict one another.

This field is not always required, but is required if an inventory item is being updated and a condition description already exists for that inventory item.

This field is returned in the getInventoryItem and getInventoryItems calls if a condition description was provided for a used inventory item.

Max Length: 1000.' packageWeightAndSize: - description: "This container is used if the seller is offering one or more\ - \ calculated shipping options for the inventory item, or if the seller\ - \ is offering flat-rate shipping but is including a shipping surcharge\ - \ based on the item's weight. This container is used to specify the dimensions\ - \ and weight of a shipping package.

This container is not\ - \ always required, but is required if an inventory item is being updated\ - \ and shipping package data already exists for that inventory item.
This container is returned in the getInventoryItem\ - \ and getInventoryItems calls if package type, package\ - \ weight, and/or package dimensions are specified for an inventory item.

See\ - \ the Calculated shipping help page for more information\ - \ on calculated shipping." - $ref: "#/components/schemas/PackageWeightAndSize" + description: This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package.

This container is not always required, but is required if an inventory item is being updated and shipping package data already exists for that inventory item.

This container is returned in the getInventoryItem and getInventoryItems calls if package type, package weight, and/or package dimensions are specified for an inventory item.

See the Calculated shipping help page for more information on calculated shipping. + $ref: '#/components/schemas/PackageWeightAndSize' product: - description: "This container is used to define the product details, such\ - \ as product title, product description, product identifiers (eBay Product\ - \ ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product\ - \ images. Note that an eBay Product ID (ePID) or a Global Trade Item Number\ - \ (GTIN) value can be used in an attempt to find a matching product in\ - \ the eBay Catalog. If a product match is found, the inventory item record\ - \ will automatically pick up all product details associated with the eBay\ - \ Catalog product.

Many eBay categories will require at least\ - \ one product identifier (a GTIN or a Brand/MPN pair). To discover which\ - \ product identifier(s) that an eBay category might require or support,\ - \ use the getItemAspectsForCategory method in the Taxonomy API. In the getItemAspectsForCategory\ - \ response, look for product identifier names (brand, mpn,\ - \ upc, ean, isbn) in the localizedAspectName\ - \ fields, and then look for the correspondinng aspectRequired\ - \ boolean fields as well as the corresponding aspectUsage\ - \ field, which will indicate if the aspect is required, recommended, or\ - \ optional. In some cases, a product identifier type may be required,\ - \ but not known/applicable for a product. If this is the case, the seller\ - \ must still include the corresponding field in the inventory item record,\ - \ but pass in a default text string. This text string can vary by site,\ - \ so the seller should use the GeteBayDetails call of\ - \ the Trading API to get this string value. In the GeteBayDetails\ - \ call, the seller should include a DetailName field\ - \ with its value set to ProductDetails. In the response of\ - \ the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText\ - \ field. The seller will use this value in one or more of the product\ - \ identifier fields (ean, isbn, upc,\ - \ or mpn) if a product ID isn't known or applicable.\ - \

This container is not initially required, but it is required\ - \ before an inventory item can be published as an offer, and/or if an\ - \ inventory item is being updated and product data already exists for\ - \ that inventory item.

This container is always returned\ - \ for published offers in the getInventoryItem, bulkGetInventoryItem,\ - \ and getInventoryItems calls since product data must\ - \ be defined for published offers, but for unpublished inventory items,\ - \ this container will only be returned if product details have been defined\ - \ for the inventory item." - $ref: "#/components/schemas/Product" - description: "This type is used to provide detailed information about an inventory\ - \ item." + description: This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog. If a product match is found, the inventory item record will automatically pick up all product details associated with the eBay Catalog product.

Many eBay categories will require at least one product identifier (a GTIN or a Brand/MPN pair). To discover which product identifier(s) that an eBay category might require or support, use the getItemAspectsForCategory method in the Taxonomy API. In the getItemAspectsForCategory response, look for product identifier names (brand, mpn, upc, ean, isbn) in the localizedAspectName fields, and then look for the correspondinng aspectRequired boolean fields as well as the corresponding aspectUsage field, which will indicate if the aspect is required, recommended, or optional. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the GeteBayDetails call of the Trading API to get this string value. In the GeteBayDetails call, the seller should include a DetailName field with its value set to ProductDetails. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText field. The seller will use this value in one or more of the product identifier fields (ean, isbn, upc, or mpn) if a product ID isn't known or applicable.

This container is not initially required, but it is required before an inventory item can be published as an offer, and/or if an inventory item is being updated and product data already exists for that inventory item.

This container is always returned for published offers in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems calls since product data must be defined for published offers, but for unpublished inventory items, this container will only be returned if product details have been defined for the inventory item. + $ref: '#/components/schemas/Product' + description: This type is used to provide detailed information about an inventory item. InventoryItemGroup: - type: "object" + type: object properties: aspects: - type: "string" - description: "This is a collection of item specifics (aka product aspects)\ - \ name-value pairs that are shared by all product variations within the\ - \ inventory item group. Common aspects for the inventory item group are\ - \ not immediately required upon creating an inventory item group, but\ - \ these aspects will be required before the first offer of the group is\ - \ published. Common aspects for a men's t-shirt might be pattern and sleeve\ - \ length. Below is an example of the proper JSON syntax to use when manually\ - \ inputting item specifics. Note that one item specific name, such as\ - \ 'Features', can have more than one value. If an item specific name has\ - \ more than one value, each value is delimited with a comma.
\"\
-            aspects\": {
 \"pattern\": [\"solid\"],
 \"sleeves\": [\"short\"\
-            ]
 }
This container is always returned if one or more\ - \ offers associated with the inventory item group have been published,\ - \ and is only returned if set for an inventory item group if that group\ - \ has yet to have any offers published.
" + type: string + description: 'This is a collection of item specifics (aka product aspects) name-value pairs that are shared by all product variations within the inventory item group. Common aspects for the inventory item group are not immediately required upon creating an inventory item group, but these aspects will be required before the first offer of the group is published. Common aspects for a men''s t-shirt might be pattern and sleeve length. Below is an example of the proper JSON syntax to use when manually inputting item specifics. Note that one item specific name, such as ''Features'', can have more than one value. If an item specific name has more than one value, each value is delimited with a comma.
"aspects": {
 "pattern": ["solid"],
 "sleeves": ["short"]
 }
This container is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.
' description: - type: "string" - description: "The description of the inventory item group. This description\ - \ should fully describe the product and the variations of the product\ - \ that are available in the inventory item group, since this description\ - \ will ultimately become the listing description once the first offer\ - \ of the group is published. This field is not initially required when\ - \ first creating an inventory item group, but will be required before\ - \ the first offer of the group is published.

Note: Since this description will ultimately become\ - \ the listing description in a multiple-variation listing, the seller\ - \ should omit the listingDescription field when creating\ - \ the offers for each variation. If they include the listingDescription\ - \ field for the individual offer(s) in an item group, the text in that\ - \ field for a published offer will overwrite the text provided in this\ - \ description field for the inventory item group.

HTML\ - \ tags and markup can be used in this field, but each character counts\ - \ toward the max length limit.

Note:\ - \ To ensure that their short listing description is optimized when viewed\ - \ on mobile devices, sellers should strongly consider using eBay's View Item description summary feature when listing\ - \ their items. Keep in mind that the 'short' listing description is what\ - \ prospective buyers first see when they view the listing on a mobile\ - \ device. The 'full' listing description is also available to mobile users\ - \ when they click on the short listing description, but the full description\ - \ is not automatically optimized for viewing in mobile devices, and many\ - \ users won't even drill down to the full description.

Using HTML\ - \ div and span tag attributes, this feature allows sellers to customize\ - \ and fully control the short listing description that is displayed to\ - \ prospective buyers when viewing the listing on a mobile device. The\ - \ short listing description on mobile devices is limited to 800 characters,\ - \ and whenever the full listing description (provided in this field, in\ - \ UI, or seller tool) exceeds this limit, eBay uses a special algorithm\ - \ to derive the best possible short listing description within the 800-character\ - \ limit. However, due to some short listing description content being\ - \ removed, it is definitely not ideal for the seller, and could lead to\ - \ a bad buyer experience and possibly to a Significantly not as described\ - \ (SNAD) case, since the buyer may not get complete details on the item\ - \ when viewing the short listing description. See the eBay help page for\ - \ more details on using the HTML div and span tags.

This\ - \ field is always returned if one or more offers associated with the inventory\ - \ item group have been published, and is only returned if set for an inventory\ - \ item group if that group has yet to have any offers published.

Max\ - \ Length: 500000 (which includes HTML markup/tags)
" + type: string + description: 'The description of the inventory item group. This description should fully describe the product and the variations of the product that are available in the inventory item group, since this description will ultimately become the listing description once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published.

Note: Since this description will ultimately become the listing description in a multiple-variation listing, the seller should omit the listingDescription field when creating the offers for each variation. If they include the listingDescription field for the individual offer(s) in an item group, the text in that field for a published offer will overwrite the text provided in this description field for the inventory item group.

HTML tags and markup can be used in this field, but each character counts toward the max length limit.

Note: To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s View Item description summary feature when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.

Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.

This field is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.

Max Length: 500000 (which includes HTML markup/tags)
' imageUrls: - type: "array" - description: "An array of one or more links to images for the inventory\ - \ item group. URLs must use the \"HTTPS\" protocol. Images can be self-hosted\ - \ by the seller, or sellers can use the UploadSiteHostedPictures call of the Trading API\ - \ to upload images to an eBay Picture Server. If successful, the response\ - \ of the UploadSiteHostedPictures call will contain a full\ - \ URL to the image on an eBay Picture Server. This is the URL that will\ - \ be passed in through the imageUrls array.

\ - \ Before any offer can be published, at least one image must exist for\ - \ the offer. Links to images can either be passed in through this imageUrls\ - \ container, or they can be passed in through the product.imageUrls\ - \ container when creating each inventory item in the group. If the variesBy.aspectsImageVariesBy\ - \ field is used to specify the main product aspect where the variations\ - \ vary, the links to the images must be passed in through this imageUrls\ - \ container, and there should be a picture for each variation. So, if\ - \ the variesBy.aspectsImageVariesBy field is set to Color,\ - \ a link should be included to an image demonstrating each available color\ - \ in the group.

Most eBay sites support up to 12 pictures free\ - \ of charge, and eBay Motors listings can have up to 24 pictures.

\ - \ This container will always be returned for an inventory item group that\ - \ has at least one published offer since a published offer will always\ - \ have at least one picture, but this container will only be returned\ - \ if defined for inventory item groups that have yet to have any published\ - \ offers." + type: array + description: An array of one or more links to images for the inventory item group. URLs must use the "HTTPS" protocol. Images can be self-hosted by the seller, or sellers can use the UploadSiteHostedPictures call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the UploadSiteHostedPictures call will contain a full URL to the image on an eBay Picture Server. This is the URL that will be passed in through the imageUrls array.

Before any offer can be published, at least one image must exist for the offer. Links to images can either be passed in through this imageUrls container, or they can be passed in through the product.imageUrls container when creating each inventory item in the group. If the variesBy.aspectsImageVariesBy field is used to specify the main product aspect where the variations vary, the links to the images must be passed in through this imageUrls container, and there should be a picture for each variation. So, if the variesBy.aspectsImageVariesBy field is set to Color, a link should be included to an image demonstrating each available color in the group.

In almost any category at no cost, sellers can include up to 24 pictures in one listing. For inventory items that are a part of an inventory item group/multiple-variation listings, a maximum of 12 pictures may be used per inventory item in the group. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors).

This container will always be returned for an inventory item group that has at least one published offer since a published offer will always have at least one picture, but this container will only be returned if defined for inventory item groups that have yet to have any published offers. items: - type: "string" + type: string inventoryItemGroupKey: - type: "string" - description: "This is the unique identifier of the inventory item group.\ - \ This identifier is created by the seller when an inventory item group\ - \ is created. This field is only applicable to the getInventoryItemGroup\ - \ call and not to the createOrReplaceInventoryItemGroup\ - \ call. In the createOrReplaceInventoryItemGroup call,\ - \ the inventoryItemGroupKey value is passed into the\ - \ end of the call URI instead. " + type: string + description: 'This is the unique identifier of the inventory item group. This identifier is created by the seller when an inventory item group is created. This field is only applicable to the getInventoryItemGroup call and not to the createOrReplaceInventoryItemGroup call. In the createOrReplaceInventoryItemGroup call, the inventoryItemGroupKey value is passed into the end of the call URI instead. ' subtitle: - type: "string" - description: "A subtitle is an optional listing feature that allows the\ - \ seller to provide more information about the product, possibly including\ - \ keywords that may assist with search results. An additional listing\ - \ fee will be charged to the seller if a subtitle is used. For more information\ - \ on using listing subtitles on the US site, see the Adding a subtitle to your listings help page.\ - \

Note: Since this\ - \ subtitle will ultimately become the subtitle in a multiple-variation\ - \ listing, the seller should not include the subtitle\ - \ field when creating the inventory items that are members of the group.\ - \ If they do include the subtitle field in an inventory\ - \ item record, the text in that field will overwrite the text provided\ - \ in this subtitle field for each inventory item in the\ - \ group that is published.

This field will only be returned\ - \ if set for an inventory item.

Max Length:\ - \ 55
" + type: string + description: 'A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the Adding a subtitle to your listings help page.

Note: Since this subtitle will ultimately become the subtitle in a multiple-variation listing, the seller should not include the subtitle field when creating the inventory items that are members of the group. If they do include the subtitle field in an inventory item record, the text in that field will overwrite the text provided in this subtitle field for each inventory item in the group that is published.

This field will only be returned if set for an inventory item.

Max Length: 55
' title: - type: "string" - description: "The title of the inventory item group. This title will ultimately\ - \ become the listing title once the first offer of the group is published.\ - \ This field is not initially required when first creating an inventory\ - \ item group, but will be required before the first offer of the group\ - \ is published.

Note:\ - \ Since this title will ultimately become the listing title in a multiple-variation\ - \ listing, the seller should omit the title field when\ - \ creating the inventory items that are members of the group. If they\ - \ do include the title field in an inventory item record,\ - \ the text in that field will overwrite the text provided in this title\ - \ field for each inventory item in the group that is published.

\ - \ This field is always returned if one or more offers associated with\ - \ the inventory item group have been published, and is only returned if\ - \ set for an inventory item group if that group has yet to have any offers\ - \ published.

Max Length: 80
" + type: string + description: 'The title of the inventory item group. This title will ultimately become the listing title once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published.

Note: Since this title will ultimately become the listing title in a multiple-variation listing, the seller should omit the title field when creating the inventory items that are members of the group. If they do include the title field in an inventory item record, the text in that field will overwrite the text provided in this title field for each inventory item in the group that is published.

This field is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.

Max Length: 80
' variantSKUs: - type: "array" - description: "This required container is used to assign individual inventory\ - \ items to the inventory item group. Multiple SKU values are passed in\ - \ to this container. If updating an existing inventory item group, the\ - \ seller should make sure that all member SKU values are passed in, as\ - \ long as the seller wants that SKU to remain in the group.

It\ - \ is also possible to add or remove SKUs with a createOrReplaceInventoryItemGroup\ - \ call. If the seller wants to remove a SKU from the group, that seller\ - \ will just omit that SKU value from this container to remove that inventory\ - \ item/SKU from the inventory item group and any published, multiple-variation\ - \ listing. However, a variation cannot be removed from the group if that\ - \ variation has one or more sales for that listing. A workaround for this\ - \ is to set that variation's quantity to 0 and it will be\ - \ 'grayed out' in the View Item page.

This container is always\ - \ returned." + type: array + description: This required container is used to assign individual inventory items to the inventory item group. Multiple SKU values are passed in to this container. If updating an existing inventory item group, the seller should make sure that all member SKU values are passed in, as long as the seller wants that SKU to remain in the group.

It is also possible to add or remove SKUs with a createOrReplaceInventoryItemGroup call. If the seller wants to remove a SKU from the group, that seller will just omit that SKU value from this container to remove that inventory item/SKU from the inventory item group and any published, multiple-variation listing. However, a variation cannot be removed from the group if that variation has one or more sales for that listing. A workaround for this is to set that variation's quantity to 0 and it will be 'grayed out' in the View Item page.

This container is always returned. items: - type: "string" + type: string variesBy: - description: "This container is used to specify product aspects for which\ - \ variations within an inventory item group vary, and a complete list\ - \ of all those variances. For example, t-shirts in an inventory item group\ - \ may be available in multiple sizes and colors. If this is the case,\ - \ Color and Size would both be values in the\ - \ specifications.name fields, and the available colors\ - \ and sizes would be values under the corresponding specifications.values\ - \ array. If the seller will be including multiple images in the listing\ - \ that will demonstrate how each variation differs, that seller will also\ - \ include the aspectsImageVariesBy field, and call out\ - \ the product aspect where the listing images differ. In the t-shirts\ - \ example, this product aspect would be Color, and the seller\ - \ could either include URLs to images of the t-shirt (in available colors)\ - \ through the inventory item group entity, or the seller could also included\ - \ URLs to images of the t-shirt through the individual inventory item\ - \ entities of the group.

This container is not initially required\ - \ when first creating an inventory item group, but the variesBy.specifications\ - \ container will be required before the first offer of the group is published.

This\ - \ container is always returned if one or more offers associated with the\ - \ inventory item group have been published, and is only returned if set\ - \ for an inventory item group if that group has yet to have any offers\ - \ published." - $ref: "#/components/schemas/VariesBy" + description: This container is used to specify product aspects for which variations within an inventory item group vary, and a complete list of all those variances. For example, t-shirts in an inventory item group may be available in multiple sizes and colors. If this is the case, Color and Size would both be values in the specifications.name fields, and the available colors and sizes would be values under the corresponding specifications.values array. If the seller will be including multiple images in the listing that will demonstrate how each variation differs, that seller will also include the aspectsImageVariesBy field, and call out the product aspect where the listing images differ. In the t-shirts example, this product aspect would be Color, and the seller could either include URLs to images of the t-shirt (in available colors) through the inventory item group entity, or the seller could also included URLs to images of the t-shirt through the individual inventory item entities of the group.

This container is not initially required when first creating an inventory item group, but the variesBy.specifications container will be required before the first offer of the group is published.

This container is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published. + $ref: '#/components/schemas/VariesBy' videoIds: - type: "array" - description: "An array of one or more VideoId values for the inventory item\ - \ group. A VideoId is a unique identifier that is automatically created\ - \ by eBay when a seller successfully uploads a video to eBay using the\ - \ uploadVideo method of the Media API.

For information on supported\ - \ marketplaces and platforms, as well as other requirements and limitations\ - \ of video support, please refer to Managing videos." + type: array + description: An array of one or more VideoId values for the inventory item group. A VideoId is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API.

For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to Managing videos. items: - type: "string" - description: "This type is used by the base request payload of the createOrReplaceInventoryItemGroup\ - \ call and the base response payload of the getInventoryItemGroup\ - \ call." + type: string + description: This type is used by the base request payload of the createOrReplaceInventoryItemGroup call and the base response payload of the getInventoryItemGroup call. InventoryItemListing: - type: "object" + type: object properties: offerId: - type: "string" - description: "Upon a successful migration of a listing, eBay auto-generates\ - \ this unique identifier, and this offer ID value will be used to retrieve\ - \ and manage the newly-created offer object. This value will only be generated\ - \ and returned if the eBay listing is migrated successfully." + type: string + description: Upon a successful migration of a listing, eBay auto-generates this unique identifier, and this offer ID value will be used to retrieve and manage the newly-created offer object. This value will only be generated and returned if the eBay listing is migrated successfully. sku: - type: "string" - description: "This is the seller-defined SKU value associated with the item(s)\ - \ in a listing. This same SKU value will be used to retrieve and manage\ - \ the newly-created inventory item object if the listing migration is\ - \ successful. This SKU value will get returned even if the migration is\ - \ not successful." - description: "This type is used by the inventoryItems container\ - \ that is returned in the response of the bulkMigrateListing\ - \ call. Up to five sku/offerId pairs may\ - \ be returned under the inventoryItems container, dependent\ - \ on how many eBay listings the seller is attempting to migrate to the inventory\ - \ model." + type: string + description: This is the seller-defined SKU value associated with the item(s) in a listing. This same SKU value will be used to retrieve and manage the newly-created inventory item object if the listing migration is successful. This SKU value will get returned even if the migration is not successful. + description: This type is used by the inventoryItems container that is returned in the response of the bulkMigrateListing call. Up to five sku/offerId pairs may be returned under the inventoryItems container, dependent on how many eBay listings the seller is attempting to migrate to the inventory model. InventoryItemResponse: - type: "object" + type: object properties: errors: - type: "array" - description: "This container will be returned if there were one or more\ - \ errors associated with the creation or update to the inventory item\ - \ record." + type: array + description: This container will be returned if there were one or more errors associated with the creation or update to the inventory item record. items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' locale: - type: "string" - description: "This field is for future use only. For implementation help,\ - \ refer to eBay\ - \ API documentation" + type: string + description: This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to eBay API documentation sku: - type: "string" - description: "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." + type: string + description: 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. statusCode: - type: "integer" - description: "The HTTP status code returned in this field indicates the\ - \ success or failure of creating or updating the inventory item record\ - \ for the inventory item indicated in the sku field.\ - \ See the HTTP status codes table to see which each status\ - \ code indicates." - format: "int32" + type: integer + description: The HTTP status code returned in this field indicates the success or failure of creating or updating the inventory item record for the inventory item indicated in the sku field. See the HTTP status codes table to see which each status code indicates. + format: int32 warnings: - type: "array" - description: "This container will be returned if there were one or more\ - \ warnings associated with the creation or update to the inventory item\ - \ record." + type: array + description: This container will be returned if there were one or more warnings associated with the creation or update to the inventory item record. items: - $ref: "#/components/schemas/Error" - description: "This type is used by the response of the bulkCreateOrReplaceInventoryItem\ - \ method to indicate the success or failure of creating and/or updating each\ - \ inventory item record. The sku value in this type identifies\ - \ each inventory item record." + $ref: '#/components/schemas/Error' + description: This type is used by the response of the bulkCreateOrReplaceInventoryItem method to indicate the success or failure of creating and/or updating each inventory item record. The sku value in this type identifies each inventory item record. InventoryItemWithSkuLocale: - type: "object" + type: object properties: availability: - description: "This container is used to specify the quantity of the inventory\ - \ item that are available for purchase.

This container is\ - \ optional up until the seller is ready to publish an offer with the SKU,\ - \ at which time it becomes required. Availability data must also be passed\ - \ if an inventory item is being updated and availability data already\ - \ exists for that inventory item.

Since an inventory item\ - \ must have specified quantity before being published in an offer, this\ - \ container is always returned in the 'Get' calls for SKUs that are part\ - \ of a published offer. If a SKU is not part of a published offer, this\ - \ container will only be returned if set for the inventory item." - $ref: "#/components/schemas/Availability" + description: This container is used to specify the quantity of the inventory item that are available for purchase.

This container is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.

Since an inventory item must have specified quantity before being published in an offer, this container is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item. + $ref: '#/components/schemas/Availability' condition: - type: "string" - description: "This enumeration value indicates the condition of the item.\ - \ Supported item condition values will vary by eBay site and category.\ - \ To see which item condition values that a particular eBay category supports,\ - \ use the getItemConditionPolicies method of the Metadata API.\ - \ This method returns condition ID values that map to the enumeration\ - \ values defined in the ConditionEnum type. The Item condition ID and name values topic in the Selling Integration\ - \ Guide has a table that maps condition ID values to ConditionEnum\ - \ values. The getItemConditionPolicies call reference\ - \ page has more information.

A condition value\ - \ is optional up until the seller is ready to publish an offer with the\ - \ SKU, at which time it becomes required for most eBay categories. For\ - \ implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category. To see which item condition values that a particular eBay category supports, use the getItemConditionPolicies method of the Metadata API. This method returns condition ID values that map to the enumeration values defined in the ConditionEnum type. The Item condition ID and name values topic in the Selling Integration Guide has a table that maps condition ID values to ConditionEnum values. The getItemConditionPolicies call reference page has more information.

A condition value is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required for most eBay categories.

Note: The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value is no longer applicable, and should not be used. With Version 1.13.0, the CERTIFIED_REFURBISHED enumeration value has been introduced, and CR-eligible sellers should make a note to start using CERTIFIED_REFURBISHED from this point forward. For the time being, if the MANUFACTURER_REFURBISHED enum is used for any of the SKUs in a bulkCreateOrReplaceInventoryItem method, it will be accepted but automatically converted by eBay to CERTIFIED_REFURBISHED.

To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition.

Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center. For implementation help, refer to eBay API documentation conditionDescription: - type: "string" - description: "This string field is used by the seller to more clearly describe\ - \ the condition of a used inventory item, or an inventory item whose condition\ - \ value is not NEW, LIKE_NEW, NEW_OTHER,\ - \ or NEW_WITH_DEFECTS.

The conditionDescription\ - \ field is available for all eBay categories. If the conditionDescription\ - \ field is used with an item in one of the new conditions (mentioned in\ - \ previous paragraph), eBay will simply ignore this field if included,\ - \ and eBay will return a warning message to the user.

This\ - \ field should only be used to further clarify the condition of the used\ - \ item. It should not be used for branding, promotions, shipping, returns,\ - \ payment or other information unrelated to the condition of the used\ - \ item. Make sure that the condition value, condition\ - \ description, listing description, and the item's pictures do not contradict\ - \ one another.

This field is not always required, but is\ - \ required if an inventory item is being updated and a condition description\ - \ already exists for that inventory item.

This field is returned\ - \ in the getInventoryItem, bulkGetInventoryItem,\ - \ and getInventoryItems calls if a condition description\ - \ was provided for a used inventory item.

Max Length:\ - \ 1000." + type: string + description: 'This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose condition value is not NEW, LIKE_NEW, NEW_OTHER, or NEW_WITH_DEFECTS.

The conditionDescription field is available for all eBay categories. If the conditionDescription field is used with an item in one of the new conditions (mentioned in previous paragraph), eBay will simply ignore this field if included, and eBay will return a warning message to the user.

This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the used item. Make sure that the condition value, condition description, listing description, and the item''s pictures do not contradict one another.

This field is not always required, but is required if an inventory item is being updated and a condition description already exists for that inventory item.

This field is returned in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems calls if a condition description was provided for a used inventory item.

Max Length: 1000.' locale: - type: "string" - description: "This field is for future use only. For implementation help,\ - \ refer to eBay\ - \ API documentation" + type: string + description: This request parameter sets the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to eBay API documentation packageWeightAndSize: - description: "This container is used if the seller is offering one or more\ - \ calculated shipping options for the inventory item, or if the seller\ - \ is offering flat-rate shipping but is including a shipping surcharge\ - \ based on the item's weight. This container is used to specify the dimensions\ - \ and weight of a shipping package.

This container is not\ - \ always required, but is required if an inventory item is being updated\ - \ and shipping package data already exists for that inventory item.
This container is returned in the getInventoryItem,\ - \ bulkGetInventoryItem, and getInventoryItems\ - \ calls if package type, package weight, and/or package dimensions are\ - \ specified for an inventory item.

See the Calculated shipping help page for more information\ - \ on calculated shipping." - $ref: "#/components/schemas/PackageWeightAndSize" + description: This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package.

This container is not always required, but is required if an inventory item is being updated and shipping package data already exists for that inventory item.

This container is returned in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems calls if package type, package weight, and/or package dimensions are specified for an inventory item.

See the Calculated shipping help page for more information on calculated shipping. + $ref: '#/components/schemas/PackageWeightAndSize' product: - description: "This container is used to define the product details, such\ - \ as product title, product description, product identifiers (eBay Product\ - \ ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product\ - \ images. Note that an eBay Product ID (ePID) or a Global Trade Item Number\ - \ (GTIN) value can be used in an attempt to find a matching product in\ - \ the eBay Catalog. If a product match is found, the inventory item record\ - \ will automatically pick up all product details associated with the eBay\ - \ Catalog product.

Many eBay categories will require at least\ - \ one product identifier (a GTIN or a Brand/MPN pair). To discover which\ - \ product identifier(s) that an eBay category might require or support,\ - \ use the getItemAspectsForCategory method in the Taxonomy API. In the getItemAspectsForCategory\ - \ response, look for product identifier names (brand, mpn,\ - \ upc, ean, isbn) in the localizedAspectName\ - \ fields, and then look for the correspondinng aspectRequired\ - \ boolean fields as well as the corresponding aspectUsage\ - \ field, which will indicate if the aspect is required, recommended, or\ - \ optional. In some cases, a product identifier type may be required,\ - \ but not known/applicable for a product. If this is the case, the seller\ - \ must still include the corresponding field in the inventory item record,\ - \ but pass in a default text string. This text string can vary by site,\ - \ so the seller should use the GeteBayDetails call of\ - \ the Trading API to get this string value. In the GeteBayDetails\ - \ call, the seller should include a DetailName field\ - \ with its value set to ProductDetails. In the response of\ - \ the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText\ - \ field. The seller will use this value in one or more of the product\ - \ identifier fields (ean, isbn, upc,\ - \ or mpn) if a product ID isn't known or applicable.\ - \

This container is not initially required, but it is required\ - \ before an inventory item can be published as an offer, and/or if an\ - \ inventory item is being updated and product data already exists for\ - \ that inventory item.

This container is always returned\ - \ for published offers in the getInventoryItem, bulkGetInventoryItem,\ - \ and getInventoryItems calls since product data must\ - \ be defined for published offers, but for unpublished inventory items,\ - \ this container will only be returned if product details have been defined\ - \ for the inventory item." - $ref: "#/components/schemas/Product" + description: This container is used to define the product details, such as product title, product description, product identifiers (eBay Product ID, GTIN, or Brand/MPN pair), product aspects/item specifics, and product images. Note that an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) value can be used in an attempt to find a matching product in the eBay Catalog. If a product match is found, the inventory item record will automatically pick up all product details associated with the eBay Catalog product.

Many eBay categories will require at least one product identifier (a GTIN or a Brand/MPN pair). To discover which product identifier(s) that an eBay category might require or support, use the getItemAspectsForCategory method in the Taxonomy API. In the getItemAspectsForCategory response, look for product identifier names (brand, mpn, upc, ean, isbn) in the localizedAspectName fields, and then look for the correspondinng aspectRequired boolean fields as well as the corresponding aspectUsage field, which will indicate if the aspect is required, recommended, or optional. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the GeteBayDetails call of the Trading API to get this string value. In the GeteBayDetails call, the seller should include a DetailName field with its value set to ProductDetails. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText field. The seller will use this value in one or more of the product identifier fields (ean, isbn, upc, or mpn) if a product ID isn't known or applicable.

This container is not initially required, but it is required before an inventory item can be published as an offer, and/or if an inventory item is being updated and product data already exists for that inventory item.

This container is always returned for published offers in the getInventoryItem, bulkGetInventoryItem, and getInventoryItems calls since product data must be defined for published offers, but for unpublished inventory items, this container will only be returned if product details have been defined for the inventory item. + $ref: '#/components/schemas/Product' sku: - type: "string" - description: "This is the seller-defined SKU value of the product that will\ - \ be listed on the eBay site (specified in the marketplaceId\ - \ field). Only one offer (in unpublished or published state) may exist\ - \ for each sku/marketplaceId/format\ - \ combination. This field is required.

Max Length:\ - \ 50
" - description: "This type is used to define/modify each inventory item record\ - \ that is being created and/or updated with the bulkCreateOrReplaceInventoryItem\ - \ method. Up to 25 inventory item records can be created and/or updated with\ - \ one call." + type: string + description: 'This is the seller-defined SKU value of the product that will be listed on the eBay site (specified in the marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku/marketplaceId/format combination. This field is required.

Max Length: 50
' + description: This type is used to define/modify each inventory item record that is being created and/or updated with the bulkCreateOrReplaceInventoryItem method. Up to 25 inventory item records can be created and/or updated with one call. InventoryItemWithSkuLocaleGroupKeys: - type: "object" + type: object properties: availability: - description: "This container shows the quantity of the inventory item that\ - \ is available for purchase if the item will be shipped to the buyer,\ - \ and/or the quantity of the inventory item that is available for In-Store\ - \ Pickup at one or more of the merchant's physical stores." - $ref: "#/components/schemas/AvailabilityWithAll" + description: This container shows the quantity of the inventory item that is available for purchase if the item will be shipped to the buyer, and/or the quantity of the inventory item that is available for In-Store Pickup at one or more of the merchant's physical stores. + $ref: '#/components/schemas/AvailabilityWithAll' condition: - type: "string" - description: "This enumeration value indicates the condition of the item.\ - \ Supported item condition values will vary by eBay site and category.\ - \

Since the condition of an inventory item must be specified\ - \ before being published in an offer, this field is always returned in\ - \ the 'Get' calls for SKUs that are part of a published offer. If a SKU\ - \ is not part of a published offer, this field will only be returned if\ - \ set for the inventory item. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category.

Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this field will only be returned if set for the inventory item.

Note: The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value has essentially been replaced with the CERTIFIED_REFURBISHED enumeration value with Version 1.13.0. For any existing inventory items that have MANUFACTURER_REFURBISHED set as their condition value, eBay will automatically convert the condition of these inventory items to CERTIFIED_REFURBISHED, so it is not necessary for the developer to update these inventory items with a 'create or replace' call.

To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition.

Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center. For implementation help, refer to eBay API documentation conditionDescription: - type: "string" - description: "This string field is used by the seller to more clearly describe\ - \ the condition of used items, or items that are not 'Brand New', 'New\ - \ with tags', or 'New in box'. The ConditionDescription field is available\ - \ for all categories. If the ConditionDescription field is used with an\ - \ item in a new condition (Condition IDs 1000-1499), eBay will simply\ - \ ignore this field if included, and eBay will return a warning message\ - \ to the user. This field should only be used to further clarify the condition\ - \ of the used item. It should not be used for branding, promotions, shipping,\ - \ returns, payment or other information unrelated to the condition of\ - \ the item. Make sure that the condition value, condition description,\ - \ listing description, and the item's pictures do not contradict one another.Max\ - \ length: 1000." + type: string + description: 'This string field is used by the seller to more clearly describe the condition of used items, or items that are not ''Brand New'', ''New with tags'', or ''New in box''. The ConditionDescription field is available for all categories. If the ConditionDescription field is used with an item in a new condition (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user. This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition value, condition description, listing description, and the item''s pictures do not contradict one another.Max length: 1000.' inventoryItemGroupKeys: - type: "array" - description: "This array is returned if the inventory item is associated\ - \ with any inventory item group(s). The value(s) returned in this array\ - \ are the unique identifier(s) of the inventory item's variation in a\ - \ multiple-variation listing. This array is not returned if the inventory\ - \ item is not associated with any inventory item groups." + type: array + description: This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item's variation in a multiple-variation listing. This array is not returned if the inventory item is not associated with any inventory item groups. items: - type: "string" + type: string locale: - type: "string" - description: "This field is for future use only. For implementation help,\ - \ refer to eBay\ - \ API documentation" + type: string + description: This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to eBay API documentation packageWeightAndSize: - description: "This container is used to specify the dimensions and weight\ - \ of a shipping package." - $ref: "#/components/schemas/PackageWeightAndSize" + description: This container is used to specify the dimensions and weight of a shipping package. + $ref: '#/components/schemas/PackageWeightAndSize' product: - description: "This container is used in a createOrReplaceInventoryItem\ - \ call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer\ - \ Part Number (MPN) pair to identify a product to be matched with a product\ - \ in the eBay catalog. If a match is found in the eBay product catalog,\ - \ the inventory item is automatically populated with available product\ - \ details such as a title, a subtitle, a product description, item specifics,\ - \ and links to stock images for the product." - $ref: "#/components/schemas/Product" + description: This container is used in a createOrReplaceInventoryItem call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog. If a match is found in the eBay product catalog, the inventory item is automatically populated with available product details such as a title, a subtitle, a product description, item specifics, and links to stock images for the product. + $ref: '#/components/schemas/Product' sku: - type: "string" - description: "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." - description: "This type is used to provide details about each retrieved inventory\ - \ item record." + type: string + description: 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. + description: This type is used to provide details about each retrieved inventory item record. InventoryItemWithSkuLocaleGroupid: - type: "object" + type: object properties: availability: - description: "This container is used to specify the quantity of the inventory\ - \ item that are available for purchase if the item will be shipped to\ - \ the buyer, and the quantity of the inventory item that are available\ - \ for In-Store Pickup at one or more of the merchant's physical stores" - $ref: "#/components/schemas/AvailabilityWithAll" + description: This container is used to specify the quantity of the inventory item that are available for purchase if the item will be shipped to the buyer, and the quantity of the inventory item that are available for In-Store Pickup at one or more of the merchant's physical stores + $ref: '#/components/schemas/AvailabilityWithAll' condition: - type: "string" - description: "This enumeration value indicates the condition of the item.\ - \ Supported item condition values will vary by eBay site and category.\ - \

Since the condition of an inventory item must be specified\ - \ before being published in an offer, this field is always returned in\ - \ the 'Get' calls for SKUs that are part of a published offer. If a SKU\ - \ is not part of a published offer, this field will only be returned if\ - \ set for the inventory item. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value indicates the condition of the item. Supported item condition values will vary by eBay site and category.

Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this field will only be returned if set for the inventory item.

Note: The 'Manufacturer Refurbished' item condition is no longer a valid item condition on any eBay marketplace, and to reflect this change, the MANUFACTURER_REFURBISHED value has essentially been replaced with the CERTIFIED_REFURBISHED enumeration value with Version 1.13.0. For any existing inventory items that have MANUFACTURER_REFURBISHED set as their condition value, eBay will automatically convert the condition of these inventory items to CERTIFIED_REFURBISHED, so it is not necessary for the developer to update these inventory items with a 'create or replace' call.

To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition.

Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center. For implementation help, refer to eBay API documentation conditionDescription: - type: "string" - description: "This string field is used by the seller to more clearly describe\ - \ the condition of used items, or items that are not 'Brand New', 'New\ - \ with tags', or 'New in box'. The ConditionDescription field is available\ - \ for all categories. If the ConditionDescription field is used with an\ - \ item in a new condition (Condition IDs 1000-1499), eBay will simply\ - \ ignore this field if included, and eBay will return a warning message\ - \ to the user. This field should only be used to further clarify the condition\ - \ of the used item. It should not be used for branding, promotions, shipping,\ - \ returns, payment or other information unrelated to the condition of\ - \ the item. Make sure that the condition value, condition description,\ - \ listing description, and the item's pictures do not contradict one another.
Max length/: 1000." + type: string + description: 'This string field is used by the seller to more clearly describe the condition of used items, or items that are not ''Brand New'', ''New with tags'', or ''New in box''. The ConditionDescription field is available for all categories. If the ConditionDescription field is used with an item in a new condition (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user. This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition value, condition description, listing description, and the item''s pictures do not contradict one another.

Max length/: 1000.' groupIds: - type: "array" - description: "This array is returned if the inventory item is associated\ - \ with any inventory item group(s). The value(s) returned in this array\ - \ are the unique identifier(s) of the inventory item group(s). This array\ - \ is not returned if the inventory item is not associated with any inventory\ - \ item groups." + type: array + description: This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item group(s). This array is not returned if the inventory item is not associated with any inventory item groups. items: - type: "string" + type: string inventoryItemGroupKeys: - type: "array" - description: "This array is returned if the inventory item is associated\ - \ with any inventory item group(s). The value(s) returned in this array\ - \ are the unique identifier(s) of the inventory item's variation in a\ - \ multiple-variation listing. This array is not returned if the inventory\ - \ item is not associated with any inventory item groups." + type: array + description: This array is returned if the inventory item is associated with any inventory item group(s). The value(s) returned in this array are the unique identifier(s) of the inventory item's variation in a multiple-variation listing. This array is not returned if the inventory item is not associated with any inventory item groups. items: - type: "string" + type: string locale: - type: "string" - description: "This field is for future use only. For implementation help,\ - \ refer to eBay\ - \ API documentation" + type: string + description: This field returns the natural language that was provided in the field values of the request payload (i.e., en_AU, en_GB or de_DE). For implementation help, refer to eBay API documentation packageWeightAndSize: - description: "This container is used to specify the dimensions and weight\ - \ of a shipping package." - $ref: "#/components/schemas/PackageWeightAndSize" + description: This container is used to specify the dimensions and weight of a shipping package. + $ref: '#/components/schemas/PackageWeightAndSize' product: - description: "This container is used in a createOrReplaceInventoryItem\ - \ call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer\ - \ Part Number (MPN) pair to identify a product to be matched with a product\ - \ in the eBay catalog. If a match is found in the eBay product catalog,\ - \ the inventory item is automatically populated with available product\ - \ details such as a title, a subtitle, a product description, item specifics,\ - \ and links to stock images for the product." - $ref: "#/components/schemas/Product" + description: This container is used in a createOrReplaceInventoryItem call to pass in a Global Trade Item Number (GTIN) or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog. If a match is found in the eBay product catalog, the inventory item is automatically populated with available product details such as a title, a subtitle, a product description, item specifics, and links to stock images for the product. + $ref: '#/components/schemas/Product' sku: - type: "string" - description: "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." + type: string + description: 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. InventoryItems: - type: "object" + type: object properties: href: - type: "string" - description: "This is the URL to the current page of inventory items." + type: string + description: This is the URL to the current page of inventory items. inventoryItems: - type: "array" - description: "This container is an array of one or more inventory items,\ - \ with detailed information on each inventory item." + type: array + description: This container is an array of one or more inventory items, with detailed information on each inventory item. items: - $ref: "#/components/schemas/InventoryItemWithSkuLocaleGroupid" + $ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupid' limit: - type: "integer" - description: "This integer value is the number of inventory items that will\ - \ be displayed on each results page." - format: "int32" + type: integer + description: This integer value is the number of inventory items that will be displayed on each results page. + format: int32 next: - type: "string" - description: "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." + type: string + description: 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. prev: - type: "string" - description: "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." + type: string + description: 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. size: - type: "integer" - description: "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." - format: "int32" + type: integer + description: 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. + format: int32 total: - type: "integer" - description: "This integer value is the total number of inventory items\ - \ that exist for the seller's account. Based on this number and on the\ - \ limit value, the seller may have to toggle through\ - \ multiple pages to view all inventory items." - format: "int32" - description: "This type is used by the base response payload of getInventoryItems\ - \ call. " + type: integer + description: This integer value is the total number of inventory items that exist for the seller's account. Based on this number and on the limit value, the seller may have to toggle through multiple pages to view all inventory items. + format: int32 + description: 'This type is used by the base response payload of getInventoryItems call. ' InventoryLocation: - type: "object" + type: object properties: locationAdditionalInformation: - type: "string" - description: "This text field is used by the merchant to provide/update\ - \ additional information about an inventory location. Whatever text is\ - \ passed in this field will replace the current text string defined for\ - \ this field. If the text will not change, the same text should be passed\ - \ in once again.

Max length: 256" + type: string + description: 'This text field is used by the merchant to provide/update additional information about an inventory location. Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again.

Max length: 256' locationInstructions: - type: "string" - description: "This text field is generally used by the merchant to provide/update\ - \ special pickup instructions for a store inventory location. Although\ - \ this field is optional, it is recommended that merchants provide this\ - \ field to create a pleasant and easy pickup experience for In-Store Pickup\ - \ and Click and Collect orders. If this field is not included in the call\ - \ request payload, eBay will use the default pickup instructions contained\ - \ in the merchant's profile (if available). Whatever text is passed in\ - \ this field will replace the current text string defined for this field.\ - \ If the text will not change, the same text should be passed in once\ - \ again.

Max length: 1000" + type: string + description: 'This text field is generally used by the merchant to provide/update special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field is not included in the call request payload, eBay will use the default pickup instructions contained in the merchant''s profile (if available). Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again.

Max length: 1000' locationWebUrl: - type: "string" - description: "This text field is used by the merchant to provide/update\ - \ the Website address (URL) associated with the inventory location. The\ - \ URL that is passed in this field will replace any other URL that may\ - \ be defined for this field.

Max length: 512" + type: string + description: 'This text field is used by the merchant to provide/update the Website address (URL) associated with the inventory location. The URL that is passed in this field will replace any other URL that may be defined for this field.

Max length: 512' name: - type: "string" - description: "This text field is used by the merchant to update the name\ - \ of the inventory location. This name should be a human-friendly name\ - \ as it will be in In-Store Pickup and Click and Collect listings. A name\ - \ is not required for warehouse inventory locations. For store inventory\ - \ locations, this field is not immediately required, but will be required\ - \ before an offer enabled with the In-Store Pickup or Click and Collect\ - \ capability can be published. So, if the seller omitted this field in\ - \ the createInventoryLocation call, it is required for\ - \ an updateInventoryLocation call. The name that is passed\ - \ in this field will replace any other name that may be defined for this\ - \ field." + type: string + description: This text field is used by the merchant to update the name of the inventory location. This name should be a human-friendly name as it will be in In-Store Pickup and Click and Collect listings. A name is not required for warehouse inventory locations. For store inventory locations, this field is not immediately required, but will be required before an offer enabled with the In-Store Pickup or Click and Collect capability can be published. So, if the seller omitted this field in the createInventoryLocation call, it is required for an updateInventoryLocation call. The name that is passed in this field will replace any other name that may be defined for this field. operatingHours: - type: "array" - description: "This container is used to provide/update the regular operating\ - \ hours for a store location during the days of the week. A dayOfWeekEnum\ - \ field and an intervals container will be needed for\ - \ each day of the week that the store location is open. Note that if operating\ - \ hours are already set for an inventory location for a specific day of\ - \ the week, whatever is set through an updateInventoryLocation\ - \ call will override those existing hours." + type: array + description: This container is used to provide/update the regular operating hours for a store location during the days of the week. A dayOfWeekEnum field and an intervals container will be needed for each day of the week that the store location is open. Note that if operating hours are already set for an inventory location for a specific day of the week, whatever is set through an updateInventoryLocation call will override those existing hours. items: - $ref: "#/components/schemas/OperatingHours" + $ref: '#/components/schemas/OperatingHours' phone: - type: "string" - description: "This text field is used by the merchant to provide/update\ - \ the phone number for the inventory location. The phone number that is\ - \ passed in this field will replace any other phone number that may be\ - \ defined for this field.

Max length: 36" + type: string + description: 'This text field is used by the merchant to provide/update the phone number for the inventory location. The phone number that is passed in this field will replace any other phone number that may be defined for this field.

Max length: 36' specialHours: - type: "array" - description: "This container is used to provide/update the special operating\ - \ hours for a store location on a specific date, such as a holiday. The\ - \ special hours specified for the specific date will override the normal\ - \ operating hours for that particular day of the week. If special hours\ - \ have already been set up for an inventory location, specifying special\ - \ hours through an updateInventoryLocation call will\ - \ only add to the list, unless the date(s) used are the same special date(s)\ - \ already set up, in which case, the special hours set up through the\ - \ updateInventoryLocation call will override the existing\ - \ special hours." + type: array + description: This container is used to provide/update the special operating hours for a store location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week. If special hours have already been set up for an inventory location, specifying special hours through an updateInventoryLocation call will only add to the list, unless the date(s) used are the same special date(s) already set up, in which case, the special hours set up through the updateInventoryLocation call will override the existing special hours. items: - $ref: "#/components/schemas/SpecialHours" - description: "This type is used by the updateInventoryLocation\ - \ call to update operating hours, special hours, phone number, and other minor\ - \ details of an inventory location." + $ref: '#/components/schemas/SpecialHours' + description: This type is used by the updateInventoryLocation call to update operating hours, special hours, phone number, and other minor details of an inventory location. InventoryLocationFull: - type: "object" + type: object properties: location: - description: "This required container is used to set the physical address\ - \ and geographical coordinates (optional) of a warehouse or store inventory\ - \ location. A warehouse inventory location only requires the city, province/state,\ - \ and country, and does not require a full street address. However, the\ - \ seller may still supply a full street address for a warehouse location.\ - \ The physical location/address for an inventory location cannot be modified\ - \ once set with a createInventoryLocation call. All other\ - \ details of an inventory location (e.g. phone or operating hours) can\ - \ be changed with an updateInventoryLocation call." - $ref: "#/components/schemas/LocationDetails" + description: This required container is used to set the physical address and geographical coordinates (optional) of a warehouse or store inventory location. A warehouse inventory location only requires the city, province/state, and country, and does not require a full street address. However, the seller may still supply a full street address for a warehouse location. The physical location/address for an inventory location cannot be modified once set with a createInventoryLocation call. All other details of an inventory location (e.g. phone or operating hours) can be changed with an updateInventoryLocation call. + $ref: '#/components/schemas/LocationDetails' locationAdditionalInformation: - type: "string" - description: "This text field is used by the merchant to provide additional\ - \ information about an inventory location.

Max length:\ - \ 256" + type: string + description: 'This text field is used by the merchant to provide additional information about an inventory location.

Max length: 256' locationInstructions: - type: "string" - description: "This text field is generally used by the merchant to provide\ - \ special pickup instructions for a store inventory location. Although\ - \ this field is optional, it is recommended that merchants provide this\ - \ field to create a pleasant and easy pickup experience for In-Store Pickup\ - \ and Click and Collect orders. If this field is not included in the call\ - \ request payload, eBay will use the default pickup instructions contained\ - \ in the merchant's profile (if available).

" + type: string + description: This text field is generally used by the merchant to provide special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field is not included in the call request payload, eBay will use the default pickup instructions contained in the merchant's profile (if available).

locationTypes: - type: "array" - description: "This container is used to define the function of the inventory\ - \ location. Typically, an inventory location will serve as a store or\ - \ a warehouse, but in some cases, an inventory location may be both.

\ - \ If this container is omitted, the location type of the inventory location\ - \ will default to WAREHOUSE. See StoreTypeEnum for the supported values.

Default:\ - \ WAREHOUSE" + type: array + description: 'This container is used to define the function of the inventory location. Typically, an inventory location will serve as a store or a warehouse, but in some cases, an inventory location may be both.

If this container is omitted, the location type of the inventory location will default to WAREHOUSE. See StoreTypeEnum for the supported values.

Default: WAREHOUSE' items: - type: "string" - description: " For implementation help, refer to eBay\ - \ API documentation" + type: string + description: ' For implementation help, refer to eBay API documentation' locationWebUrl: - type: "string" - description: "This text field is used by the merchant to provide the Website\ - \ address (URL) associated with the inventory location.

Max\ - \ length: 512" + type: string + description: 'This text field is used by the merchant to provide the Website address (URL) associated with the inventory location.

Max length: 512' merchantLocationStatus: - type: "string" - description: "This field is used to indicate whether the inventory location\ - \ will be enabled (inventory can be loaded to location) or disabled (inventory\ - \ can not be loaded to location). If this field is omitted, a successful\ - \ createInventoryLocation call will automatically enable\ - \ the inventory location. A merchant may want to create a new inventory\ - \ location but leave it as disabled if the inventory location is not yet\ - \ ready for active inventory. Once the inventory location is ready, the\ - \ merchant can use the enableInventoryLocation call to\ - \ enable an inventory location that is in a disabled state. See StatusEnum for the\ - \ supported values.

Default: ENABLED For implementation\ - \ help, refer to eBay\ - \ API documentation" + type: string + description: 'This field is used to indicate whether the inventory location will be enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). If this field is omitted, a successful createInventoryLocation call will automatically enable the inventory location. A merchant may want to create a new inventory location but leave it as disabled if the inventory location is not yet ready for active inventory. Once the inventory location is ready, the merchant can use the enableInventoryLocation call to enable an inventory location that is in a disabled state. See StatusEnum for the supported values.

Default: ENABLED For implementation help, refer to eBay API documentation' name: - type: "string" - description: "The name of the inventory location. This name should be a\ - \ human-friendly name as it will be displayed in In-Store Pickup and Click\ - \ and Collect listings. A name is not required for warehouse inventory\ - \ locations. For store inventory locations, this field is not immediately\ - \ required, but will be required before an offer enabled with the In-Store\ - \ Pickup or Click and Collect capability can be published. So, if the\ - \ seller omits this field in a createInventoryLocation\ - \ call, it becomes required for an updateInventoryLocation\ - \ call.

Max length: 1000" + type: string + description: 'The name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. A name is not required for warehouse inventory locations. For store inventory locations, this field is not immediately required, but will be required before an offer enabled with the In-Store Pickup or Click and Collect capability can be published. So, if the seller omits this field in a createInventoryLocation call, it becomes required for an updateInventoryLocation call.

Max length: 1000' operatingHours: - type: "array" - description: "Although not technically required, this container is highly\ - \ recommended to be used to specify operating hours for a store inventory\ - \ location. This container is used to express the regular operating hours\ - \ for a store location during each day of the week. A dayOfWeekEnum\ - \ field and an intervals container will be needed for\ - \ each day of the week that the store location is open." + type: array + description: Although not technically required, this container is highly recommended to be used to specify operating hours for a store inventory location. This container is used to express the regular operating hours for a store location during each day of the week. A dayOfWeekEnum field and an intervals container will be needed for each day of the week that the store location is open. items: - $ref: "#/components/schemas/OperatingHours" + $ref: '#/components/schemas/OperatingHours' phone: - type: "string" - description: "Although not technically required, this field is highly recommended\ - \ to be used to specify the phone number for a store inventory location.\ - \

Max length: 36" + type: string + description: 'Although not technically required, this field is highly recommended to be used to specify the phone number for a store inventory location.

Max length: 36' specialHours: - type: "array" - description: "This container is used to express the special operating hours\ - \ for a store inventory location on a specific date, such as a holiday.\ - \ The special hours specified for the specific date will override the\ - \ normal operating hours for that particular day of the week." + type: array + description: This container is used to express the special operating hours for a store inventory location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week. items: - $ref: "#/components/schemas/SpecialHours" - description: "This type is used by the createInventoryLocation\ - \ call to provide details on the inventory location, including the location's\ - \ name, physical address, operating hours, special hours, phone number and\ - \ other details of an inventory location." + $ref: '#/components/schemas/SpecialHours' + description: This type is used by the createInventoryLocation call to provide details on the inventory location, including the location's name, physical address, operating hours, special hours, phone number and other details of an inventory location. InventoryLocationResponse: - type: "object" + type: object properties: location: - description: "This container provides location details of an inventory location.\ - \ The address container will always be returned, but\ - \ it will not always have a complete street address. Except in the case\ - \ of an inventory location that supports In-Store Pickup inventory, a\ - \ full address is not a requirement when setting up an inventory location.\ - \ The geoCoordinates container will only be returned\ - \ if the merchant provided geographical coordinates. The locationId\ - \ field is always returned, but this value is only used internally by\ - \ eBay." - $ref: "#/components/schemas/Location" + description: This container provides location details of an inventory location. The address container will always be returned, but it will not always have a complete street address. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location. The geoCoordinates container will only be returned if the merchant provided geographical coordinates. The locationId field is always returned, but this value is only used internally by eBay. + $ref: '#/components/schemas/Location' locationAdditionalInformation: - type: "string" - description: "This text field provides additional information about an inventory\ - \ location. This field is returned if it is set for the inventory location.\ - \

Max length: 256" + type: string + description: 'This text field provides additional information about an inventory location. This field is returned if it is set for the inventory location.

Max length: 256' locationInstructions: - type: "string" - description: "This text field is used by the merchant to provide special\ - \ pickup instructions for the store location. This field can help create\ - \ a pleasant and easy pickup experience for In-Store Pickup and Click\ - \ and Collect orders. If this field was not set up through a createInventoryLocation\ - \ or a updateInventoryLocation call, eBay will use the\ - \ default pickup instructions contained in the merchant's profile.

Max\ - \ length: 1000" + type: string + description: 'This text field is used by the merchant to provide special pickup instructions for the store location. This field can help create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field was not set up through a createInventoryLocation or a updateInventoryLocation call, eBay will use the default pickup instructions contained in the merchant''s profile.

Max length: 1000' locationTypes: - type: "array" - description: "This container defines the function of the inventory location.\ - \ Typically, an inventory location will serve as a store or a warehouse,\ - \ but in some cases, an inventory location may be both.

The location\ - \ type of an inventory location defaults to WAREHOUSE if\ - \ a location type is not specified when a merchant creates an inventory\ - \ location." + type: array + description: This container defines the function of the inventory location. Typically, an inventory location will serve as a store or a warehouse, but in some cases, an inventory location may be both.

The location type of an inventory location defaults to WAREHOUSE if a location type is not specified when a merchant creates an inventory location. items: - type: "string" - description: " For implementation help, refer to eBay\ - \ API documentation" + type: string + description: ' For implementation help, refer to eBay API documentation' locationWebUrl: - type: "string" - description: "This text field shows the Website address (URL) associated\ - \ with the inventory location. This field is returned if defined for the\ - \ inventory location.

Max length: 512" + type: string + description: 'This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the inventory location.

Max length: 512' merchantLocationKey: - type: "string" - description: "The unique identifier of the inventory location. This identifier\ - \ is set up by the merchant when the inventory location is first created\ - \ with the createInventoryLocation call. Once this value\ - \ is set for an inventory location, it cannot be modified.

Max\ - \ length: 36" + type: string + description: 'The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the createInventoryLocation call. Once this value is set for an inventory location, it cannot be modified.

Max length: 36' merchantLocationStatus: - type: "string" - description: "This field indicates whether the inventory location is enabled\ - \ (inventory can be loaded to location) or disabled (inventory can not\ - \ be loaded to location). The merchant can use the enableInventoryLocation\ - \ call to enable an inventory location in disabled status, or the disableInventoryLocation\ - \ call to disable an inventory location in enabled status. For implementation\ - \ help, refer to eBay\ - \ API documentation" + type: string + description: This field indicates whether the inventory location is enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). The merchant can use the enableInventoryLocation call to enable an inventory location in disabled status, or the disableInventoryLocation call to disable an inventory location in enabled status. For implementation help, refer to eBay API documentation name: - type: "string" - description: "The name of the inventory location. This name should be a\ - \ human-friendly name as it will be displayed in In-Store Pickup and Click\ - \ and Collect listings. For store inventory locations, this field is not\ - \ required for the createInventoryLocation call, but\ - \ a store inventory location must have a defined name\ - \ value before an In-Store Pickup and Click and Collect enabled offer\ - \ is published. So, if the seller omits this field in the createInventoryLocation\ - \ call, it will have to be added later through a updateInventoryLocation\ - \ call.

Max length: 1000" + type: string + description: 'The name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. For store inventory locations, this field is not required for the createInventoryLocation call, but a store inventory location must have a defined name value before an In-Store Pickup and Click and Collect enabled offer is published. So, if the seller omits this field in the createInventoryLocation call, it will have to be added later through a updateInventoryLocation call.

Max length: 1000' operatingHours: - type: "array" - description: "This container shows the regular operating hours for a store\ - \ location during the days of the week. A dayOfWeekEnum\ - \ field and an intervals container is shown for each\ - \ day of the week that the store location is open." + type: array + description: This container shows the regular operating hours for a store location during the days of the week. A dayOfWeekEnum field and an intervals container is shown for each day of the week that the store location is open. items: - $ref: "#/components/schemas/OperatingHours" + $ref: '#/components/schemas/OperatingHours' phone: - type: "string" - description: "The phone number for an inventory location. This field will\ - \ typically only be set and returned for store locations.

Max\ - \ length: 36" + type: string + description: 'The phone number for an inventory location. This field will typically only be set and returned for store locations.

Max length: 36' specialHours: - type: "array" - description: "This container shows the special operating hours for a store\ - \ location on a specific date or dates." + type: array + description: This container shows the special operating hours for a store location on a specific date or dates. items: - $ref: "#/components/schemas/SpecialHours" - description: "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." + $ref: '#/components/schemas/SpecialHours' + description: 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. ListingDetails: - type: "object" + type: object properties: listingId: - type: "string" - description: "The unique identifier of the eBay listing that is associated\ - \ with the published offer. " + type: string + description: 'The unique identifier of the eBay listing that is associated with the published offer. ' listingStatus: - type: "string" - description: "The enumeration value returned in this field indicates the\ - \ status of the listing that is associated with the published offer. For\ - \ implementation help, refer to eBay\ - \ API documentation" + type: string + description: The enumeration value returned in this field indicates the status of the listing that is associated with the published offer. For implementation help, refer to eBay API documentation soldQuantity: - type: "integer" - description: "This integer value indicates the quantity of the product that\ - \ has been sold for the published offer." - format: "int32" - description: "This type is used by the listing container in\ - \ the getOffer and getOffers calls to provide\ - \ the eBay listing ID, the listing status, and quantity sold for the offer.\ - \ The listing container is only returned for published offers,\ - \ and is not returned for unpublished offers." + type: integer + description: This integer value indicates the quantity of the product that has been sold for the published offer. + format: int32 + description: This type is used by the listing container in the getOffer and getOffers calls to provide the eBay listing ID, the listing status, and quantity sold for the offer. The listing container is only returned for published offers, and is not returned for unpublished offers. ListingPolicies: - type: "object" + type: object properties: bestOfferTerms: - description: "This container is used if the seller would like to support\ - \ the Best Offer feature on their listing. To enable the Best Offer feature,\ - \ the seller will have to set the bestOfferEnabled field\ - \ to true, and the seller also has the option of setting\ - \ 'auto-accept' and 'auto-decline' price thresholds.

This container\ - \ is only returned if Best Offer is enabled on listing." - $ref: "#/components/schemas/BestOffer" + description: This container is used if the seller would like to support the Best Offer feature on their listing. To enable the Best Offer feature, the seller will have to set the bestOfferEnabled field to true, and the seller also has the option of setting 'auto-accept' and 'auto-decline' price thresholds.

This container is only returned if Best Offer is enabled on listing. + $ref: '#/components/schemas/BestOffer' eBayPlusIfEligible: - type: "boolean" - description: "This field is included in an offer and set to true\ - \ if a Top-Rated seller is opted in to the eBay Plus program. With the\ - \ eBay Plus program, qualified sellers must commit to next-day delivery\ - \ of the item, and the buyers must have an eBay Plus subscription to be\ - \ eligible to receive the benefits of this program, which are free, next-day\ - \ delivery, as well as free returns.

Currently, this program is\ - \ only available on the Germany and Australian sites.

This field\ - \ will be returned in the getOffer and getOffers\ - \ calls if set for the offer." + type: boolean + description: This field is included in an offer and set to true if a Top-Rated seller is opted in to the eBay Plus program. With the eBay Plus program, qualified sellers must commit to next-day delivery of the item, and the buyers must have an eBay Plus subscription to be eligible to receive the benefits of this program, which are free, next-day delivery, as well as free returns.

Currently, this program is only available on the Germany and Australian sites.

This field will be returned in the getOffer and getOffers calls if set for the offer. fulfillmentPolicyId: - type: "string" - description: "This unique identifier indicates the fulfillment business\ - \ policy that will be used once an offer is published and converted to\ - \ an eBay listing. This fulfillment business policy will set all fulfillment-related\ - \ settings for the eBay listing.

Business policies are not immediately\ - \ required for offers, but are required before an offer can be published.\ - \ The seller should review the fulfillment business policy before assigning\ - \ it to the offer to make sure it is compatible with the inventory item\ - \ and the offer settings. The seller may also want to review the shipping\ - \ service costs in the fulfillment policy, and that seller might decide\ - \ to override the shipping costs for one or more shipping service options\ - \ by using the shippingCostOverrides container.

Business\ - \ policies can be created and managed in My eBay or with the Account\ - \ API. To get a list of all return policies associated with a\ - \ seller's account on a specific eBay Marketplace, use the Account API's\ - \ getFulfillmentPolicies call. There are also calls in\ - \ the Account API to retrieve a fulfillment policy by\ - \ policy ID or policy name.

This field will be returned in the\ - \ getOffer and getOffers calls if set\ - \ for the offer." + type: string + description: This unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing. This fulfillment business policy will set all fulfillment-related settings for the eBay listing.

Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the fulfillment business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings. The seller may also want to review the shipping service costs in the fulfillment policy, and that seller might decide to override the shipping costs for one or more shipping service options by using the shippingCostOverrides container.

Business policies can be created and managed in My eBay or with the Account API. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's getFulfillmentPolicies call. There are also calls in the Account API to retrieve a fulfillment policy by policy ID or policy name.

This field will be returned in the getOffer and getOffers calls if set for the offer. paymentPolicyId: - type: "string" - description: "This unique identifier indicates the payment business policy\ - \ that will be used once an offer is published and converted to an eBay\ - \ listing. This payment business policy will set all payment-related settings\ - \ for the eBay listing.

Business policies are not immediately\ - \ required for offers, but are required before an offer can be published.\ - \ The seller should review the payment business policy to make sure that\ - \ it is compatible with the marketplace and listing category before assigning\ - \ it to the offer.

Business policies can be created and managed\ - \ in My eBay or with the Account API. To get a list of\ - \ all payment policies associated with a seller's account on a specific\ - \ eBay Marketplace, use the Account API's getPaymentPolicies\ - \ call. There are also calls in the Account API to retrieve\ - \ a payment policy by policy ID or policy name.

This field will\ - \ be returned in the getOffer and getOffers\ - \ calls if set for the offer." + type: string + description: This unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing. This payment business policy will set all payment-related settings for the eBay listing.

Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the payment business policy to make sure that it is compatible with the marketplace and listing category before assigning it to the offer.

Business policies can be created and managed in My eBay or with the Account API. To get a list of all payment policies associated with a seller's account on a specific eBay Marketplace, use the Account API's getPaymentPolicies call. There are also calls in the Account API to retrieve a payment policy by policy ID or policy name.

This field will be returned in the getOffer and getOffers calls if set for the offer. productCompliancePolicyIds: - type: "array" - description: "This field contains an array of up to five IDs specifying\ - \ the seller created compliance policies for the listing. Custom policies\ - \ provide buyers with important information and disclosures about products.\ - \ For example, if you sell batteries and specific disclosures are required,\ - \ your compliance policy could contain the required disclosures. See Custom Policies for more information. Up to five\ - \ different compliance policies can be applied to each listing. Refer\ - \ to the custom_policy resource (in the Sell Account API)\ - \ to create and manage custom policies." + type: array + description: This field contains an array of up to five IDs specifying the seller created compliance policies for the listing. Custom policies provide buyers with important information and disclosures about products. For example, if you sell batteries and specific disclosures are required, your compliance policy could contain the required disclosures. See Custom Policies for more information. Up to five different compliance policies can be applied to each listing. Refer to the custom_policy resource (in the Sell Account API) to create and manage custom policies. items: - type: "string" + type: string returnPolicyId: - type: "string" - description: "This unique identifier indicates the return business policy\ - \ that will be used once an offer is published and converted to an eBay\ - \ listing. This return business policy will set all return policy settings\ - \ for the eBay listing.

Business policies are not immediately\ - \ required for offers, but are required before an offer can be published.\ - \ The seller should review the return business policy before assigning\ - \ it to the offer to make sure it is compatible with the inventory item\ - \ and the offer settings.

Business policies can be created and\ - \ managed in My eBay or with the Account API. To get\ - \ a list of all return policies associated with a seller's account on\ - \ a specific eBay Marketplace, use the Account API's getReturnPolicies\ - \ call. There are also calls in the Account API to retrieve\ - \ a return policy by policy ID or policy name.

This field will\ - \ be returned in the getOffer and getOffers\ - \ calls if set for the offer." + type: string + description: This unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing. This return business policy will set all return policy settings for the eBay listing.

Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the return business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings.

Business policies can be created and managed in My eBay or with the Account API. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's getReturnPolicies call. There are also calls in the Account API to retrieve a return policy by policy ID or policy name.

This field will be returned in the getOffer and getOffers calls if set for the offer. shippingCostOverrides: - type: "array" - description: "This container is used if the seller wishes to override the\ - \ shipping costs or surcharge for one or more domestic or international\ - \ shipping service options defined in the fulfillment listing policy.\ - \ To override the costs of a specific domestic or international shipping\ - \ service option, the seller must know the priority/order of that shipping\ - \ service in the fulfillment listing policy. The name of a shipping service\ - \ option can be found in the shippingOptions.shippingServices.shippingServiceCode\ - \ field of the fulfillment policy, and the priority/order of that shipping\ - \ service option is found in the shippingOptions.shippingServices.sortOrderId\ - \ field. Both of these values can be retrieved by searching for that fulfillment\ - \ policy with the getFulfillmentPolicies or getFulfillmentPolicyByName\ - \ calls of the Account API. The shippingCostOverrides.priority\ - \ value should match the shippingOptions.shippingServices.sortOrderId\ - \ in order to override the shipping costs for that shipping service option.\ - \ The seller must also ensure that the shippingServiceType\ - \ value is set to DOMESTIC to override a domestic shipping\ - \ service option, or to INTERNATIONAL to override an international\ - \ shipping service option.

A separate ShippingCostOverrides\ - \ node is needed for each shipping service option whose costs are being\ - \ overridden. All defined fields of the shippingCostOverrides\ - \ container should be included, even if the shipping costs and surcharge\ - \ values are not changing.

The shippingCostOverrides\ - \ container is returned in the getOffer and getOffers\ - \ calls if one or more shipping cost overrides are being applied to the\ - \ fulfillment policy." + type: array + description: This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy. To override the costs of a specific domestic or international shipping service option, the seller must know the priority/order of that shipping service in the fulfillment listing policy. The name of a shipping service option can be found in the shippingOptions.shippingServices.shippingServiceCode field of the fulfillment policy, and the priority/order of that shipping service option is found in the shippingOptions.shippingServices.sortOrderId field. Both of these values can be retrieved by searching for that fulfillment policy with the getFulfillmentPolicies or getFulfillmentPolicyByName calls of the Account API. The shippingCostOverrides.priority value should match the shippingOptions.shippingServices.sortOrderId in order to override the shipping costs for that shipping service option. The seller must also ensure that the shippingServiceType value is set to DOMESTIC to override a domestic shipping service option, or to INTERNATIONAL to override an international shipping service option.

A separate ShippingCostOverrides node is needed for each shipping service option whose costs are being overridden. All defined fields of the shippingCostOverrides container should be included, even if the shipping costs and surcharge values are not changing.

The shippingCostOverrides container is returned in the getOffer and getOffers calls if one or more shipping cost overrides are being applied to the fulfillment policy. items: - $ref: "#/components/schemas/ShippingCostOverride" + $ref: '#/components/schemas/ShippingCostOverride' takeBackPolicyId: - type: "string" - description: "This field specifies the ID of the seller created take-back\ - \ policy. The law in some countries may require sellers to take back a\ - \ used product when the buyer buys a new product. See Custom Policies for more information. One take-back\ - \ policy ID can be specified for each listing. Refer to the custom_policy\ - \ resource (in the Sell Account API) to create and manage\ - \ takeback policies." - description: "This type is used to identify business policies including payment,\ - \ return, and fulfillment policies, and also to identify custom policies.\ - \ These policies are, or will be, associated with the listing. Every published\ - \ offer must have a payment, return, and fulfillment business policy associated\ - \ with it. This type is also used to override the shipping costs of one or\ - \ more shipping service options that are associated with the fulfillment policy,\ - \ to enable eBay Plus eligibility for a listing, or to enable the Best Offer\ - \ feature on the listing." + type: string + description: This field specifies the ID of the seller created take-back policy. The law in some countries may require sellers to take back a used product when the buyer buys a new product. See Custom Policies for more information. One take-back policy ID can be specified for each listing. Refer to the custom_policy resource (in the Sell Account API) to create and manage takeback policies. + description: This type is used to identify business policies including payment, return, and fulfillment policies, and also to identify custom policies. These policies are, or will be, associated with the listing. Every published offer must have a payment, return, and fulfillment business policy associated with it. This type is also used to override the shipping costs of one or more shipping service options that are associated with the fulfillment policy, to enable eBay Plus eligibility for a listing, or to enable the Best Offer feature on the listing. Location: - type: "object" + type: object properties: address: - description: "The address container is always returned\ - \ in getInventoryLocation/getInventoryLocations\ - \ calls. Except in the case of an inventory location that supports In-Store\ - \ Pickup inventory, a full address is not a requirement when setting\ - \ up an inventory location." - $ref: "#/components/schemas/Address" + description: The address container is always returned in getInventoryLocation/getInventoryLocations calls. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location. + $ref: '#/components/schemas/Address' geoCoordinates: - description: "This container displays the Global Positioning System (GPS)\ - \ latitude and longitude coordinates for the inventory location. This\ - \ container is only returned if the geo-coordinates are set for an inventory\ - \ location." - $ref: "#/components/schemas/GeoCoordinates" + description: This container displays the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location. This container is only returned if the geo-coordinates are set for an inventory location. + $ref: '#/components/schemas/GeoCoordinates' locationId: - type: "string" - description: "A unique eBay-assigned ID for the location.

Note: This field should not be\ - \ confused with the seller-defined merchantLocationKey value. It\ - \ is the merchantLocationKey value which is used to identify an\ - \ inventory location when working with inventory location API calls. The\ - \ locationId value is only used internally by eBay." - description: "A complex type that is used to provide the physical address of\ - \ a location, and it geo-coordinates." + type: string + description: A unique eBay-assigned ID for the location.

Note: This field should not be confused with the seller-defined merchantLocationKey value. It is the merchantLocationKey value which is used to identify an inventory location when working with inventory location API calls. The locationId value is only used internally by eBay. + description: A complex type that is used to provide the physical address of a location, and it geo-coordinates. LocationDetails: - type: "object" + type: object properties: address: - description: "The address container is required for a createInventoryLocation\ - \ call. Except in the case of an inventory location that supports In-Store\ - \ Pickup inventory, a full address is not a requirement when setting up\ - \ an inventory location." - $ref: "#/components/schemas/Address" + description: The address container is required for a createInventoryLocation call. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location. + $ref: '#/components/schemas/Address' geoCoordinates: - description: "This container is used to set the Global Positioning System\ - \ (GPS) latitude and longitude coordinates for the inventory location." - $ref: "#/components/schemas/GeoCoordinates" - description: "This type is used by the createInventoryLocation call to\ - \ provide an full or partial address of an inventory location." + description: This container is used to set the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location. + $ref: '#/components/schemas/GeoCoordinates' + description: This type is used by the createInventoryLocation call to provide an full or partial address of an inventory location. LocationResponse: - type: "object" + type: object properties: href: - type: "string" - description: "The URI of the current page of results from the result set." + type: string + description: The URI of the current page of results from the result set. limit: - type: "integer" - description: "The number of items returned on a single page from the result\ - \ set." - format: "int32" + type: integer + description: The number of items returned on a single page from the result set. + format: int32 next: - type: "string" - description: "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.

Max length: 2048" + type: string + description: '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.

Max length: 2048' offset: - type: "integer" - description: "The number of results skipped in the result set before listing\ - \ the first returned result. This value is set in the request with the\ - \ offset query parameter.

Note:\ - \ The items in a paginated result set use a zero-based list where\ - \ the first item in the list has an offset of 0.

" - format: "int32" + type: integer + description: 'The number of results skipped in the result set before listing the first returned result. This value is set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

' + format: int32 prev: - type: "string" - description: "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.

Max length: 2048" + type: string + description: '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.

Max length: 2048' total: - type: "integer" - description: "The total number of items retrieved in the result set.

If\ - \ no items are found, this field is returned with a value of 0." - format: "int32" + type: integer + description: The total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0. + format: int32 locations: - type: "array" - description: "An array of one or more of the merchant's inventory locations." + type: array + description: An array of one or more of the merchant's inventory locations. items: - $ref: "#/components/schemas/InventoryLocationResponse" - description: "This type is used by the base response payload for the getInventoryLocations\ - \ call." + $ref: '#/components/schemas/InventoryLocationResponse' + description: This type is used by the base response payload for the getInventoryLocations call. MigrateListing: - type: "object" + type: object properties: listingId: - type: "string" - description: "The unique identifier of the eBay listing to migrate to the\ - \ new Inventory model. In the Trading API, this field is known as the\ - \ ItemID. Up to five unique eBay listings may be specified\ - \ here in separate listingId fields. The seller should\ - \ make sure that each of these listings meet the requirements that are\ - \ stated at the top of this Call Reference page." - description: "This type is used to specify one to five eBay listings that will\ - \ be migrated to the new Inventory model." + type: string + description: The unique identifier of the eBay listing to migrate to the new Inventory model. In the Trading API, this field is known as the ItemID. Up to five unique eBay listings may be specified here in separate listingId fields. The seller should make sure that each of these listings meet the requirements that are stated at the top of this Call Reference page. + description: This type is used to specify one to five eBay listings that will be migrated to the new Inventory model. MigrateListingResponse: - type: "object" + type: object properties: errors: - type: "array" - description: "If one or more errors occur with the attempt to migrate the\ - \ listing, this container will be returned with detailed information on\ - \ each error." + type: array + description: If one or more errors occur with the attempt to migrate the listing, this container will be returned with detailed information on each error. items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' inventoryItemGroupKey: - type: "string" - description: "This field will only be returned for a multiple-variation\ - \ listing that the seller attempted to migrate. Its value is auto-generated\ - \ by eBay. For a multiple-variation listing that is successfully migrated\ - \ to the new Inventory model, eBay automatically creates an inventory\ - \ item group object for the listing, and the seller will be able to retrieve\ - \ and manage that new inventory item group object by using the value in\ - \ this field." + type: string + description: This field will only be returned for a multiple-variation listing that the seller attempted to migrate. Its value is auto-generated by eBay. For a multiple-variation listing that is successfully migrated to the new Inventory model, eBay automatically creates an inventory item group object for the listing, and the seller will be able to retrieve and manage that new inventory item group object by using the value in this field. inventoryItems: - type: "array" - description: "This container exists of an array of SKU values and offer\ - \ IDs. For single-variation listings, this will only be one SKU value\ - \ and one offer ID (if listing was successfully migrated), but multiple\ - \ SKU values and offer IDs will be returned for multiple-variation listings." + type: array + description: This container exists of an array of SKU values and offer IDs. For single-variation listings, this will only be one SKU value and one offer ID (if listing was successfully migrated), but multiple SKU values and offer IDs will be returned for multiple-variation listings. items: - $ref: "#/components/schemas/InventoryItemListing" + $ref: '#/components/schemas/InventoryItemListing' listingId: - type: "string" - description: "The unique identifier of the eBay listing that the seller\ - \ attempted to migrate." + type: string + description: The unique identifier of the eBay listing that the seller attempted to migrate. marketplaceId: - type: "string" - description: "This is the unique identifier of the eBay Marketplace where\ - \ the listing resides. The value fo the eBay US site will be EBAY_US.\ - \ For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This is the unique identifier of the eBay Marketplace where the listing resides. The value fo the eBay US site will be EBAY_US. For implementation help, refer to eBay API documentation statusCode: - type: "integer" - description: "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." - format: "int32" + type: integer + description: 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. + format: int32 warnings: - type: "array" - description: "If one or more warnings occur with the attempt to migrate\ - \ the listing, this container will be returned with detailed information\ - \ on each warning. It is possible that a listing can be successfully migrated\ - \ even if a warning occurs." + type: array + description: If one or more warnings occur with the attempt to migrate the listing, this container will be returned with detailed information on each warning. It is possible that a listing can be successfully migrated even if a warning occurs. items: - $ref: "#/components/schemas/Error" - description: "This type is used to display the results of each listing that\ - \ the seller attempted to migrate." + $ref: '#/components/schemas/Error' + description: This type is used to display the results of each listing that the seller attempted to migrate. NameValueList: - type: "object" + type: object properties: name: - type: "string" - description: "This string value identifies the motor vehicle aspect, such\ - \ as 'make', 'model', 'year', 'trim', and 'engine'. Typically, the make,\ - \ model, and year of the motor vehicle are always required, with the trim\ - \ and engine being necessary sometimes, but it will be dependent on the\ - \ part or accessory, and on the vehicle class." + type: string + description: This string value identifies the motor vehicle aspect, such as 'make', 'model', 'year', 'trim', and 'engine'. Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class. value: - type: "string" - description: "This string value identifies the motor vehicle aspect specified\ - \ in the corresponding name field. For example, if the\ - \ name field is 'make', this field may be 'Toyota', or\ - \ if the name field is 'model', this field may be 'Camry'." - description: "This type is used by the compatibilityProperties\ - \ container to identify a motor vehicle using name/value pairs." + type: string + description: This string value identifies the motor vehicle aspect specified in the corresponding name field. For example, if the name field is 'make', this field may be 'Toyota', or if the name field is 'model', this field may be 'Camry'. + description: This type is used by the compatibilityProperties container to identify a motor vehicle using name/value pairs. OfferKeyWithId: - type: "object" + type: object properties: offerId: - type: "string" - description: "The unique identifier of an unpublished offer for which expected\ - \ listing fees will be retrieved. One to 250 offerId\ - \ values can be passed in to the offers container for\ - \ one getListingFees call. Errors will occur if offerId\ - \ values representing published offers are passed in." - description: "This type is used by the getListingFees call\ - \ to indicate the unpublished offer(s) for which expected listing fees will\ - \ be retrieved. The user passes in one or more offerId values\ - \ (a maximum of 250). See the Standard selling fees help page for more information\ - \ on listing fees." + type: string + description: The unique identifier of an unpublished offer for which expected listing fees will be retrieved. One to 250 offerId values can be passed in to the offers container for one getListingFees call. Errors will occur if offerId values representing published offers are passed in. + description: This type is used by the getListingFees call to indicate the unpublished offer(s) for which expected listing fees will be retrieved. The user passes in one or more offerId values (a maximum of 250). See the Standard selling fees help page for more information on listing fees. OfferKeysWithId: - type: "object" + type: object properties: offers: - type: "array" - description: "This container is used to identify one or more (up to 250)unpublished\ - \ offers for which expected listing fees will be retrieved. The user passes\ - \ one or more offerId values (maximum of 250) in to this\ - \ container to identify the unpublished offers in which to retrieve expected\ - \ listing fees. This call is only applicable for offers in the unpublished\ - \ state.

The call response gives aggregate fee amounts per\ - \ eBay marketplace, and does not give fee information at the individual\ - \ offer level." + type: array + description: This container is used to identify one or more (up to 250)unpublished offers for which expected listing fees will be retrieved. The user passes one or more offerId values (maximum of 250) in to this container to identify the unpublished offers in which to retrieve expected listing fees. This call is only applicable for offers in the unpublished state.

The call response gives aggregate fee amounts per eBay marketplace, and does not give fee information at the individual offer level. items: - $ref: "#/components/schemas/OfferKeyWithId" - description: "This type is used by the base request payload of the getListingFees\ - \ call." + $ref: '#/components/schemas/OfferKeyWithId' + description: This type is used by the base request payload of the getListingFees call. OfferPriceQuantity: - type: "object" + type: object properties: availableQuantity: - type: "integer" - description: "This field is used if the seller wants to modify the current\ - \ quantity of the inventory item that will be available for purchase in\ - \ the offer (identified by the corresponding offerId\ - \ value). Either the availableQuantity field or the price\ - \ container is required, but not necessarily both." - format: "int32" + type: integer + description: This field is used if the seller wants to modify the current quantity of the inventory item that will be available for purchase in the offer (identified by the corresponding offerId value). Either the availableQuantity field or the price container is required, but not necessarily both. + format: int32 offerId: - type: "string" - description: "This field is the unique identifier of the offer. If an offers\ - \ container is used to update one or more offers associated to a specific\ - \ inventory item, the offerId value is required in order\ - \ to identify the offer to update with a modified price and/or quantity.

The\ - \ seller can run a getOffers call (passing in the correct\ - \ SKU value as a query parameter) to retrieve offerId\ - \ values for offers associated with the SKU." + type: string + description: This field is the unique identifier of the offer. If an offers container is used to update one or more offers associated to a specific inventory item, the offerId value is required in order to identify the offer to update with a modified price and/or quantity.

The seller can run a getOffers call (passing in the correct SKU value as a query parameter) to retrieve offerId values for offers associated with the SKU. price: - description: "This container is used if the seller wants to modify the current\ - \ price of the inventory item. The dollar value set here will be the new\ - \ price of the inventory item in the offer (identified by the corresponding\ - \ offerId value). Either the availableQuantity\ - \ field or the price container is required, but not necessarily\ - \ both." - $ref: "#/components/schemas/Amount" - description: "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." + description: This container is used if the seller wants to modify the current price of the inventory item. The dollar value set here will be the new price of the inventory item in the offer (identified by the corresponding offerId value). Either the availableQuantity field or the price container is required, but not necessarily both. + $ref: '#/components/schemas/Amount' + description: 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. OfferResponse: - type: "object" + type: object properties: offerId: - type: "string" - description: "The unique identifier of the offer that was just created with\ - \ a createOffer call. It is not returned if the createOffer\ - \ call fails to create an offer. This identifier will be needed for many\ - \ offer-related calls.

Note:\ - \ The offerId value is only returned with a successful\ - \ createOffer call. This field will not be returned in\ - \ the updateOffer response.

" + type: string + description: The unique identifier of the offer that was just created with a createOffer call. It is not returned if the createOffer call fails to create an offer. This identifier will be needed for many offer-related calls.

Note: The offerId value is only returned with a successful createOffer call. This field will not be returned in the updateOffer response.

warnings: - type: "array" - description: "This container will contain an array of errors and/or warnings\ - \ when a call is made, and errors and/or warnings occur." + type: array + description: This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur. items: - $ref: "#/components/schemas/Error" - description: "This type is used by the response payload of the createOffer\ - \ and updateOffer calls. The offerId field\ - \ contains the unique identifier for the offer if the offer is successfully\ - \ created by the createOffer call. The warnings\ - \ field contains any errors and/or warnings that may have been triggered by\ - \ the call.

Note: The offerId\ - \ value is only returned with a successful createOffer call.\ - \ This field will not be returned in the updateOffer response.

" + $ref: '#/components/schemas/Error' + description: This type is used by the response payload of the createOffer and updateOffer calls. The offerId field contains the unique identifier for the offer if the offer is successfully created by the createOffer call. The warnings field contains any errors and/or warnings that may have been triggered by the call.

Note: The offerId value is only returned with a successful createOffer call. This field will not be returned in the updateOffer response.

OfferResponseWithListingId: - type: "object" + type: object properties: errors: - type: "array" - description: "This container will be returned if there were one or more\ - \ errors associated with publishing the offer." + type: array + description: This container will be returned if there were one or more errors associated with publishing the offer. items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' listingId: - type: "string" - description: "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." + type: string + description: 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. offerId: - type: "string" - description: "The unique identifier of the offer that the seller published\ - \ (or attempted to publish)." + type: string + description: The unique identifier of the offer that the seller published (or attempted to publish). statusCode: - type: "integer" - description: "The HTTP status code returned in this field indicates the\ - \ success or failure of publishing the offer specified in the offerId\ - \ field. See the HTTP status codes table to see which\ - \ each status code indicates." - format: "int32" + type: integer + description: The HTTP status code returned in this field indicates the success or failure of publishing the offer specified in the offerId field. See the HTTP status codes table to see which each status code indicates. + format: int32 warnings: - type: "array" - description: "This container will be returned if there were one or more\ - \ warnings associated with publishing the offer." + type: array + description: This container will be returned if there were one or more warnings associated with publishing the offer. items: - $ref: "#/components/schemas/Error" - description: "This type is used to indicate the status of each offer that the\ - \ user attempted to publish. If an offer is successfully published, an eBay\ - \ listing ID (also known as an Item ID) is returned. If there is an issue\ - \ publishing the offer and creating the new eBay listing, the information\ - \ about why the listing failed should be returned in the errors\ - \ and/or warnings containers." + $ref: '#/components/schemas/Error' + description: This type is used to indicate the status of each offer that the user attempted to publish. If an offer is successfully published, an eBay listing ID (also known as an Item ID) is returned. If there is an issue publishing the offer and creating the new eBay listing, the information about why the listing failed should be returned in the errors and/or warnings containers. OfferSkuResponse: - type: "object" + type: object properties: errors: - type: "array" - description: "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." + type: array + description: 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. items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' format: - type: "string" - description: "This enumeration value indicates the listing format of the\ - \ offer. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value indicates the listing format of the offer. For implementation help, refer to eBay API documentation marketplaceId: - type: "string" - description: "This enumeration value is the unique identifier of the eBay\ - \ marketplace for which the offer will be made available. This enumeration\ - \ value should be the same for all offers since the bulkCreateOffer\ - \ method can only be used to create offers for one eBay marketplace at\ - \ a time. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value is the unique identifier of the eBay marketplace for which the offer will be made available. This enumeration value should be the same for all offers since the bulkCreateOffer method can only be used to create offers for one eBay marketplace at a time. For implementation help, refer to eBay API documentation offerId: - type: "string" - description: "The unique identifier of the newly-created offer. This identifier\ - \ should be automatically created by eBay if the creation of the offer\ - \ was successful. It is not returned if the creation of the offer was\ - \ not successful. In which case, the user may want to scan the corresponding\ - \ errors and/or warnings container to\ - \ see what the issue may be." + type: string + description: The unique identifier of the newly-created offer. This identifier should be automatically created by eBay if the creation of the offer was successful. It is not returned if the creation of the offer was not successful. In which case, the user may want to scan the corresponding errors and/or warnings container to see what the issue may be. sku: - type: "string" - description: "The seller-defined Stock-Keeping Unit (SKU) of the inventory\ - \ item. The sku value is required for each product offer\ - \ that the seller is trying to create, and it is always returned to identified\ - \ the product that is associated with the offer." + type: string + description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The sku value is required for each product offer that the seller is trying to create, and it is always returned to identified the product that is associated with the offer. statusCode: - type: "integer" - description: "The integer value returned in this field is the http status\ - \ code. If an offer is created successfully, the value returned in this\ - \ field should be 200. A user can view the HTTP status\ - \ codes section for information on other status codes that may\ - \ be returned with the bulkCreateOffer method." - format: "int32" + type: integer + description: The integer value returned in this field is the http status code. If an offer is created successfully, the value returned in this field should be 200. A user can view the HTTP status codes section for information on other status codes that may be returned with the bulkCreateOffer method. + format: int32 warnings: - type: "array" - description: "This container will be returned at the offer level, and will\ - \ contain one or more warnings if any occurred with the attempted creation\ - \ of the corresponding offer. Note that it is possible that an offer can\ - \ be created successfully even if one or more warnings are triggered." + type: array + description: This container will be returned at the offer level, and will contain one or more warnings if any occurred with the attempted creation of the corresponding offer. Note that it is possible that an offer can be created successfully even if one or more warnings are triggered. items: - $ref: "#/components/schemas/Error" - description: "This type is used by the bulkCreateOffer response\ - \ to show the status of each offer that the seller attempted to create with\ - \ the bulkCreateOffer method. For each offer that is created\ - \ successfully, the returned statusCode value should be 200,\ - \ and a unique offerId should be created for each offer.\ - \ If any issues occur with the creation of any offers, errors\ - \ and/or warnings containers will be returned." + $ref: '#/components/schemas/Error' + description: This type is used by the bulkCreateOffer response to show the status of each offer that the seller attempted to create with the bulkCreateOffer method. For each offer that is created successfully, the returned statusCode value should be 200, and a unique offerId should be created for each offer. If any issues occur with the creation of any offers, errors and/or warnings containers will be returned. Offers: - type: "object" + type: object properties: href: - type: "string" - description: "This is the URL to the current page of offers." + type: string + description: This is the URL to the current page of offers. limit: - type: "integer" - description: "This integer value is the number of offers that will be displayed\ - \ on each results page." - format: "int32" + type: integer + description: This integer value is the number of offers that will be displayed on each results page. + format: int32 next: - type: "string" - description: "This is the URL to the next page of offers. This field will\ - \ only be returned if there are additional offers to view." + type: string + description: This is the URL to the next page of offers. This field will only be returned if there are additional offers to view. offers: - type: "array" - description: "This container is an array of one or more of the seller's\ - \ offers for the SKU value that is passed in through the required sku\ - \ query parameter.

Note:\ - \ Currently, the Inventory API does not support the same SKU across multiple\ - \ eBay marketplaces, so the getOffers call will only\ - \ return one offer.

Max Occurs: 25" + type: array + description: This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required sku query parameter.

Note: Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the getOffers call will only return one offer.

Max Occurs: 25 items: - $ref: "#/components/schemas/EbayOfferDetailsWithAll" + $ref: '#/components/schemas/EbayOfferDetailsWithAll' prev: - type: "string" - description: "This is the URL to the previous page of offers. This field\ - \ will only be returned if there are previous offers to view." + type: string + description: This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view. size: - type: "integer" - description: "This integer value indicates the number of offers being displayed\ - \ on the current page of results. This number will generally be the same\ - \ as the limit value if there are additional pages of\ - \ results to view.

Note:\ - \ Currently, the Inventory API does not support the same SKU across multiple\ - \ eBay marketplaces, so the Get Offers call will only\ - \ return one offer, so this value should always be 1." - format: "int32" + type: integer + description: This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the limit value if there are additional pages of results to view.

Note: Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the Get Offers call will only return one offer, so this value should always be 1. + format: int32 total: - type: "integer" - description: "This integer value is the total number of offers that exist\ - \ for the specified SKU value. Based on this number and on the limit\ - \ value, the seller may have to toggle through multiple pages to view\ - \ all offers.

Note:\ - \ Currently, the Inventory API does not support the same SKU across multiple\ - \ eBay marketplaces, so the Get Offers call will only\ - \ return one offer, so this value should always be 1." - format: "int32" - description: "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." + type: integer + description: This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the limit value, the seller may have to toggle through multiple pages to view all offers.

Note: Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the Get Offers call will only return one offer, so this value should always be 1. + format: int32 + description: 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. OperatingHours: - type: "object" + type: object properties: dayOfWeekEnum: - type: "string" - description: "A dayOfWeekEnum value is required for each\ - \ day of the week that the store location has regular operating hours.\ - \

This field is returned if operating hours are defined for the\ - \ store location. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: A dayOfWeekEnum value is required for each day of the week that the store location has regular operating hours.

This field is returned if operating hours are defined for the store location. For implementation help, refer to eBay API documentation intervals: - type: "array" - description: "This container is used to define the opening and closing times\ - \ of a store's working day (defined in the dayOfWeekEnum\ - \ field). An intervals container is needed for each day\ - \ of the week that the store location is open. If a store location closes\ - \ for lunch (or any other period during the day) and then reopens, multiple\ - \ open and close pairs are needed

This\ - \ container is returned if operating hours are defined for the store location." + type: array + description: This container is used to define the opening and closing times of a store's working day (defined in the dayOfWeekEnum field). An intervals container is needed for each day of the week that the store location is open. If a store location closes for lunch (or any other period during the day) and then reopens, multiple open and close pairs are needed

This container is returned if operating hours are defined for the store location. items: - $ref: "#/components/schemas/Interval" - description: "This type is used to express the regular operating hours of a\ - \ merchant's store during the days of the week." + $ref: '#/components/schemas/Interval' + description: This type is used to express the regular operating hours of a merchant's store during the days of the week. PackageWeightAndSize: - type: "object" + type: object properties: dimensions: - description: "This container is used to indicate the length, width, and\ - \ height of the shipping package that will be used to ship the inventory\ - \ item. The dimensions of a shipping package are needed when calculated\ - \ shipping is used.

This container will be returned if package\ - \ dimensions are set for the inventory item." - $ref: "#/components/schemas/Dimension" + description: This container is used to indicate the length, width, and height of the shipping package that will be used to ship the inventory item. The dimensions of a shipping package are needed when calculated shipping is used.

This container will be returned if package dimensions are set for the inventory item. + $ref: '#/components/schemas/Dimension' packageType: - type: "string" - description: "This enumeration value indicates the type of shipping package\ - \ used to ship the inventory item. The supported values for this field\ - \ can be found in the PackageTypeEnum type.

This field will be returned if the\ - \ package type is set for the inventory item.

Note: You can use the GeteBayDetails Trading API call to retrieve a list of supported package\ - \ types for a specific marketplace. For implementation help, refer\ - \ to eBay\ - \ API documentation" + type: string + description: This enumeration value indicates the type of shipping package used to ship the inventory item. The supported values for this field can be found in the PackageTypeEnum type.

This field will be returned if the package type is set for the inventory item.

Note: You can use the GeteBayDetails Trading API call to retrieve a list of supported package types for a specific marketplace. For implementation help, refer to eBay API documentation weight: - description: "This container is used to specify the weight of the shipping\ - \ package that will be used to ship the inventory item. The weight of\ - \ a shipping package are needed when calculated shipping is used, or if\ - \ flat-rate shipping rates are used, but with a weight surcharge.

This\ - \ field will be returned if package weight is set for the inventory item." - $ref: "#/components/schemas/Weight" - description: "This type is used to indicate the package type, weight, and dimensions\ - \ of the shipping package. Package weight and dimensions are required when\ - \ calculated shipping rates are used, and weight alone is required when flat-rate\ - \ shipping is used, but with a weight surcharge. See the Calculated shipping help page for more information\ - \ on calculated shipping." + description: This container is used to specify the weight of the shipping package that will be used to ship the inventory item. The weight of a shipping package are needed when calculated shipping is used, or if flat-rate shipping rates are used, but with a weight surcharge.

This field will be returned if package weight is set for the inventory item. + $ref: '#/components/schemas/Weight' + description: This type is used to indicate the package type, weight, and dimensions of the shipping package. Package weight and dimensions are required when calculated shipping rates are used, and weight alone is required when flat-rate shipping is used, but with a weight surcharge. See the Calculated shipping help page for more information on calculated shipping. PickupAtLocationAvailability: - type: "object" + type: object properties: availabilityType: - type: "string" - description: "The enumeration value in this field indicates the availability\ - \ status of the inventory item at the merchant's physical store specified\ - \ by the pickupAtLocationAvailability.merchantLocationKey\ - \ field. This field is required if the pickupAtLocationAvailability\ - \ container is used, and is always returned with the pickupAtLocationAvailability\ - \ container.

See AvailabilityTypeEnum for more information about how/when you use\ - \ each enumeration value. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: The enumeration value in this field indicates the availability status of the inventory item at the merchant's physical store specified by the pickupAtLocationAvailability.merchantLocationKey field. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

See AvailabilityTypeEnum for more information about how/when you use each enumeration value. For implementation help, refer to eBay API documentation fulfillmentTime: - description: "This container is used to indicate how soon an In-Store Pickup\ - \ order will be available for pickup by the buyer after the order takes\ - \ place. This container is required if the pickupAtLocationAvailability\ - \ container is used, and is always returned with the pickupAtLocationAvailability\ - \ container." - $ref: "#/components/schemas/TimeDuration" + description: This container is used to indicate how soon an In-Store Pickup order will be available for pickup by the buyer after the order takes place. This container is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container. + $ref: '#/components/schemas/TimeDuration' merchantLocationKey: - type: "string" - description: "The unique identifier of a merchant's store where the In-Store\ - \ Pickup inventory item is currently located, or where inventory will\ - \ be sent to. If the merchant's store is currently awaiting for inventory,\ - \ the availabilityType value should be SHIP_TO_STORE.\ - \ This field is required if the pickupAtLocationAvailability\ - \ container is used, and is always returned with the pickupAtLocationAvailability\ - \ container.

Max length: 36" + type: string + description: 'The unique identifier of a merchant''s store where the In-Store Pickup inventory item is currently located, or where inventory will be sent to. If the merchant''s store is currently awaiting for inventory, the availabilityType value should be SHIP_TO_STORE. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

Max length: 36' quantity: - type: "integer" - description: "This integer value indicates the quantity of the inventory\ - \ item that is available for In-Store Pickup at the store identified by\ - \ the merchantLocationKey value. The value of quantity\ - \ should be an integer value greater than 0, unless the inventory\ - \ item is out of stock. This field is required if the pickupAtLocationAvailability\ - \ container is used, and is always returned with the pickupAtLocationAvailability\ - \ container." - format: "int32" - description: "This type is used to specify/indicate the quantity of the inventory\ - \ item that is available for an In-Store Pickup order at the merchant's physical\ - \ store (specified by the merchantLocationKey field)." + type: integer + description: This integer value indicates the quantity of the inventory item that is available for In-Store Pickup at the store identified by the merchantLocationKey value. The value of quantity should be an integer value greater than 0, unless the inventory item is out of stock. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container. + format: int32 + description: This type is used to specify/indicate the quantity of the inventory item that is available for an In-Store Pickup order at the merchant's physical store (specified by the merchantLocationKey field). PriceQuantity: - type: "object" + type: object properties: offers: - type: "array" - description: "This container is needed if the seller is updating the price\ - \ and/or quantity of one or more published offers, and a successful call\ - \ will actually update the active eBay listing with the revised price\ - \ and/or available quantity.

This call is not designed to work\ - \ with unpublished offers. For unpublished offers, the seller should use\ - \ the updateOffer call to update the available quantity\ - \ and/or price.

If the seller is also using the shipToLocationAvailability\ - \ container and sku field to update the total 'ship-to-home'\ - \ quantity of the inventory item, the SKU value associated with the corresponding\ - \ offerId value(s) must be the same as the corresponding\ - \ sku value that is passed in, or an error will occur.

A\ - \ separate (OfferPriceQuantity) node is required for\ - \ each offer being updated." + type: array + description: This container is needed if the seller is updating the price and/or quantity of one or more published offers, and a successful call will actually update the active eBay listing with the revised price and/or available quantity.

This call is not designed to work with unpublished offers. For unpublished offers, the seller should use the updateOffer call to update the available quantity and/or price.

If the seller is also using the shipToLocationAvailability container and sku field to update the total 'ship-to-home' quantity of the inventory item, the SKU value associated with the corresponding offerId value(s) must be the same as the corresponding sku value that is passed in, or an error will occur.

A separate (OfferPriceQuantity) node is required for each offer being updated. items: - $ref: "#/components/schemas/OfferPriceQuantity" + $ref: '#/components/schemas/OfferPriceQuantity' shipToLocationAvailability: - description: "This container is needed if the seller is updating the total\ - \ 'ship-to-home' quantity for the corresponding inventory item (specified\ - \ in the sku field. A successful call will update the\ - \ inventory item record associated with the sku value." - $ref: "#/components/schemas/ShipToLocationAvailability" + description: This container is needed if the seller is updating the total 'ship-to-home' quantity for the corresponding inventory item (specified in the sku field. A successful call will update the inventory item record associated with the sku value. + $ref: '#/components/schemas/ShipToLocationAvailability' sku: - type: "string" - description: "This is the seller-defined SKU value of the inventory item\ - \ whose total 'ship-to-home' quantity will be updated. This field is only\ - \ required when the seller is updating the total quantity of an inventory\ - \ item using the shipToLocationAvailability container.\ - \ If the seller is updating the price and/or quantity of one or more specific\ - \ offers, one or more offerId values are used instead,\ - \ and the sku value is not needed.

If the seller\ - \ wants to update the price and/or quantity of one or more offers, and\ - \ also wants to update the total 'ship-to-home' quantity of the corresponding\ - \ inventory item, the SKU value associated with the offerId\ - \ value(s) must be the same as the corresponding sku\ - \ value that is passed in, or an error will occur.

Max\ - \ Length: 50
" - description: "This type is used to update the total \"ship-to-home\" quantity\ - \ for one or more inventory items and/or to update the price and/or quantity\ - \ of one or more specific offers associated with one or more inventory items." + type: string + description: 'This is the seller-defined SKU value of the inventory item whose total ''ship-to-home'' quantity will be updated. This field is only required when the seller is updating the total quantity of an inventory item using the shipToLocationAvailability container. If the seller is updating the price and/or quantity of one or more specific offers, one or more offerId values are used instead, and the sku value is not needed.

If the seller wants to update the price and/or quantity of one or more offers, and also wants to update the total ''ship-to-home'' quantity of the corresponding inventory item, the SKU value associated with the offerId value(s) must be the same as the corresponding sku value that is passed in, or an error will occur.

Max Length: 50
' + description: This type is used to update the total "ship-to-home" quantity for one or more inventory items and/or to update the price and/or quantity of one or more specific offers associated with one or more inventory items. PriceQuantityResponse: - type: "object" + type: object properties: errors: - type: "array" - description: "This array will be returned if there were one or more errors\ - \ associated with the update to the offer or inventory item record." + type: array + description: This array will be returned if there were one or more errors associated with the update to the offer or inventory item record. items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' offerId: - type: "string" - description: "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." + type: string + description: 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: - type: "string" - description: "This is the seller-defined SKU value of the product. This\ - \ field is returned whether the seller attempted to update an offer with\ - \ the SKU value or just attempted to update the total 'ship-to-home' quantity\ - \ of an inventory item record.

Max Length: 50
" + type: string + description: 'This is the seller-defined SKU value of the product. This field is returned whether the seller attempted to update an offer with the SKU value or just attempted to update the total ''ship-to-home'' quantity of an inventory item record.

Max Length: 50
' statusCode: - type: "integer" - description: "The value returned in this container will indicate the status\ - \ of the attempt to update the price and/or quantity of the offer (specified\ - \ in the corresponding offerId field) or the attempt\ - \ to update the total 'ship-to-home' quantity of an inventory item (specified\ - \ in the corresponding sku field). For a completely successful\ - \ update of an offer or inventory item record, a value of 200\ - \ will appear in this field. A user can view the HTTP status\ - \ codes section for information on other status codes that may\ - \ be returned with the bulkUpdatePriceQuantity method." - format: "int32" + type: integer + description: The value returned in this container will indicate the status of the attempt to update the price and/or quantity of the offer (specified in the corresponding offerId field) or the attempt to update the total 'ship-to-home' quantity of an inventory item (specified in the corresponding sku field). For a completely successful update of an offer or inventory item record, a value of 200 will appear in this field. A user can view the HTTP status codes section for information on other status codes that may be returned with the bulkUpdatePriceQuantity method. + format: int32 warnings: - type: "array" - description: "This array will be returned if there were one or more warnings\ - \ associated with the update to the offer or inventory item record." + type: array + description: This array will be returned if there were one or more warnings associated with the update to the offer or inventory item record. items: - $ref: "#/components/schemas/Error" - description: "This type is used to display the result for each offer and/or\ - \ inventory item that the seller attempted to update with a bulkUpdatePriceQuantity\ - \ call. If any errors or warnings occur, the error/warning data is returned\ - \ at the offer/inventory item level." + $ref: '#/components/schemas/Error' + description: This type is used to display the result for each offer and/or inventory item that the seller attempted to update with a bulkUpdatePriceQuantity call. If any errors or warnings occur, the error/warning data is returned at the offer/inventory item level. PricingSummary: - type: "object" + type: object properties: auctionReservePrice: - description: "This field indicates the lowest price at which the seller\ - \ is willing to sell an item through an auction listing. Note that setting\ - \ a Reserve Price will incur a listing fee of $5 or 7.5% of the Reserve\ - \ Price, whichever is greater. The minimum fee is $5.

Important: This fee is charged regardless\ - \ of whether or not the item is sold." - $ref: "#/components/schemas/Amount" + description: This field indicates the lowest price at which the seller is willing to sell an item through an auction listing. Note that setting a Reserve Price will incur a listing fee of $5 or 7.5% of the Reserve Price, whichever is greater. The minimum fee is $5.

Important: This fee is charged regardless of whether or not the item is sold. + $ref: '#/components/schemas/Amount' auctionStartPrice: - description: "This field indicates the minimum bidding price for the auction.\ - \ The bidding starts at this price.

Note: If the auctionReservePrice is also specified, the\ - \ value of auctionStartPrice must be lower than the value of auctionReservePrice." - $ref: "#/components/schemas/Amount" + description: This field indicates the minimum bidding price for the auction. The bidding starts at this price.

Note: If the auctionReservePrice is also specified, the value of auctionStartPrice must be lower than the value of auctionReservePrice. + $ref: '#/components/schemas/Amount' minimumAdvertisedPrice: - description: "This container is needed if the Minimum Advertised Price (MAP)\ - \ feature will be used in the offer. Minimum Advertised Price (MAP) is\ - \ an agreement between suppliers (or manufacturers (OEM)) and the retailers\ - \ (sellers) stipulating the lowest price an item is allowed to be advertised\ - \ at. Sellers can only offer prices below this price through the use of\ - \ other discounts. The MAP feature is only available to eligible US sellers.\ - \ This field will be ignored if the seller and or the listing is not eligible\ - \ for the MAP feature.

This container will be returned if set\ - \ for the offer." - $ref: "#/components/schemas/Amount" + description: This container is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can only offer prices below this price through the use of other discounts. The MAP feature is only available to eligible US sellers. This field will be ignored if the seller and or the listing is not eligible for the MAP feature.

This container will be returned if set for the offer. + $ref: '#/components/schemas/Amount' originallySoldForRetailPriceOn: - type: "string" - description: "This field is needed if the Strikethrough Pricing (STP) feature\ - \ will be used in the offer. This field indicates that the product was\ - \ sold for the price in the originalRetailPrice field\ - \ on an eBay site, or sold for that price by a third-party retailer. When\ - \ using the createOffer or updateOffer\ - \ calls, the seller will pass in a value of ON_EBAY to indicate\ - \ that the product was sold for the originalRetailPrice\ - \ on an eBay site, or the seller will pass in a value of OFF_EBAY\ - \ to indicate that the product was sold for the originalRetailPrice\ - \ through a third-party retailer. This field and the originalRetailPrice\ - \ field are only applicable if the seller and listing are eligible to\ - \ use the Strikethrough Pricing feature, a feature which is limited to\ - \ the US (core site and Motors), UK, Germany, Canada (English and French\ - \ versions), France, Italy, and Spain sites.

This field will\ - \ be returned if set for the offer. For implementation help, refer to\ - \ eBay\ - \ API documentation" + type: string + description: This field is needed if the Strikethrough Pricing (STP) feature will be used in the offer. This field indicates that the product was sold for the price in the originalRetailPrice field on an eBay site, or sold for that price by a third-party retailer. When using the createOffer or updateOffer calls, the seller will pass in a value of ON_EBAY to indicate that the product was sold for the originalRetailPrice on an eBay site, or the seller will pass in a value of OFF_EBAY to indicate that the product was sold for the originalRetailPrice through a third-party retailer. This field and the originalRetailPrice field are only applicable if the seller and listing are eligible to use the Strikethrough Pricing feature, a feature which is limited to the US (core site and Motors), UK, Germany, Canada (English and French versions), France, Italy, and Spain sites.

This field will be returned if set for the offer. For implementation help, refer to eBay API documentation originalRetailPrice: - description: "This container is needed if the Strikethrough Pricing (STP)\ - \ feature will be used in the offer. The dollar value passed into this\ - \ field indicates the original retail price set by the manufacturer (OEM).\ - \ eBay does not maintain or validate the value supplied here by the seller.\ - \ The dollar value in this field should always be more than the dollar\ - \ value in the price container. This field and the originallySoldForRetailPriceOn\ - \ field are only applicable if the seller and listing are eligible to\ - \ use the Strikethrough Pricing feature, a feature which is limited to\ - \ the US (core site and Motors), UK, Germany, Canada (English and French\ - \ versions), France, Italy, and Spain sites. Compare the originalRetailPrice\ - \ and the dollar value in the price field to determine\ - \ the amount of savings to the buyer. This Original Retail Price will\ - \ have a strikethrough line through for a marketing affect.

This\ - \ container will be returned if set for the offer." - $ref: "#/components/schemas/Amount" + description: This container is needed if the Strikethrough Pricing (STP) feature will be used in the offer. The dollar value passed into this field indicates the original retail price set by the manufacturer (OEM). eBay does not maintain or validate the value supplied here by the seller. The dollar value in this field should always be more than the dollar value in the price container. This field and the originallySoldForRetailPriceOn field are only applicable if the seller and listing are eligible to use the Strikethrough Pricing feature, a feature which is limited to the US (core site and Motors), UK, Germany, Canada (English and French versions), France, Italy, and Spain sites. Compare the originalRetailPrice and the dollar value in the price field to determine the amount of savings to the buyer. This Original Retail Price will have a strikethrough line through for a marketing affect.

This container will be returned if set for the offer. + $ref: '#/components/schemas/Amount' price: - description: "This is the listing price of the product. A listing price\ - \ must be specified before publishing an offer, but it is possible to\ - \ create an offer without a price.

For published offers, this\ - \ container will always be returned, but for unpublished offers, this\ - \ container will only be returned if set for the offer." - $ref: "#/components/schemas/Amount" + description: This is the listing price of the product. A listing price must be specified before publishing an offer, but it is possible to create an offer without a price.

For published offers, this container will always be returned, but for unpublished offers, this container will only be returned if set for the offer. + $ref: '#/components/schemas/Amount' pricingVisibility: - type: "string" - description: "This field is needed if the Minimum Advertised Price (MAP)\ - \ feature will be used in the offer. This field is only applicable if\ - \ an eligible US seller is using the Minimum Advertised Price (MAP) feature\ - \ and a minimumAdvertisedPrice has been specified. The\ - \ value set in this field will determine whether the MAP price is shown\ - \ to a prospective buyer prior to checkout through a pop-up window accessed\ - \ from the View Item page, or if the MAP price is not shown until the\ - \ checkout flow after the buyer has already committed to buying the item.\ - \ To show the MAP price prior to checkout, the seller will set this value\ - \ to PRE_CHECKOUT. To show the MAP price after the buyer\ - \ already commits to buy the item, the seller will set this value to DURING_CHECKOUT.\ - \ This field will be ignored if the seller and/or the listing is not eligible\ - \ for the MAP feature.

This field will be returned if set for\ - \ the offer. For implementation help, refer to eBay\ - \ API documentation" - description: "This type is used to specify the listing price for the product\ - \ and settings for the Minimum Advertised Price and Strikethrough Pricing\ - \ features. The price field must be supplied before an offer\ - \ is published, but a seller may create an offer without supplying a price\ - \ initially. The Minimum Advertised Price feature is only available on the\ - \ US site. Strikethrough Pricing is available on the US, eBay Motors, UK,\ - \ Germany, Canada (English and French), France, Italy, and Spain sites." + type: string + description: This field is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. This field is only applicable if an eligible US seller is using the Minimum Advertised Price (MAP) feature and a minimumAdvertisedPrice has been specified. The value set in this field will determine whether the MAP price is shown to a prospective buyer prior to checkout through a pop-up window accessed from the View Item page, or if the MAP price is not shown until the checkout flow after the buyer has already committed to buying the item. To show the MAP price prior to checkout, the seller will set this value to PRE_CHECKOUT. To show the MAP price after the buyer already commits to buy the item, the seller will set this value to DURING_CHECKOUT. This field will be ignored if the seller and/or the listing is not eligible for the MAP feature.

This field will be returned if set for the offer. For implementation help, refer to eBay API documentation + description: This type is used to specify the listing price for the product and settings for the Minimum Advertised Price and Strikethrough Pricing features. The price field must be supplied before an offer is published, but a seller may create an offer without supplying a price initially. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites. Product: - type: "object" + type: object properties: aspects: - type: "string" - description: "This is a collection of item specifics (aka product aspects)\ - \ name-value pairs that provide more information about the product and\ - \ might make it easier for buyers to find. To view required/recommended\ - \ product aspects/item specifics names (and corresponding values) for\ - \ a specific eBay category, sellers can use the GetCategorySpecifics call of the Trading API.\ - \ Alternatively, sellers can view similar items on eBay.com in the same\ - \ category to get an idea of what other sellers are using for product\ - \ aspects/item specifics.

Sellers also have the option of specifying\ - \ an eBay Product ID (ePID) or optionally, a Global Trade Item Number\ - \ (GTIN) through the corresponding fields in the product\ - \ container in an attempt to find a product match in the eBay Catalog.\ - \ If a match is found based on the ePID or GTIN value, the product aspects\ - \ that are defined for the eBay Catalog product will automatically get\ - \ picked up by the newly created/updated inventory item.

Below\ - \ is an example of the proper JSON syntax to use when manually inputting\ - \ item specifics. Note that one item specific name, such as 'Features',\ - \ can have more than one value. If an item specific name has more than\ - \ one value, each value is delimited with a comma.

\"\
-            aspects\": {
 \"Brand\": [\"GoPro\"],
 \"Storage Type\": [\"Removable\"\
-            ]
 }

Note that inventory items that will become part\ - \ of an inventory item group and multiple-variation listing should have\ - \ the same attributes that are defined for the inventory item group.

This\ - \ container will be returned if one or more item specific pairs are defined\ - \ for the inventory item.

Max Length for Aspect Name:\ - \ 40

Max Length for Aspect Value: 50" + type: string + description: 'This is a collection of item specifics (aka product aspects) name-value pairs that provide more information about the product and might make it easier for buyers to find. To view required/recommended product aspects/item specifics names (and corresponding values) for a specific eBay category, sellers can use the getItemAspectsForCategory method of the Taxonomy API. Alternatively, sellers can view similar items on eBay.com in the same category to get an idea of what other sellers are using for product aspects/item specifics.

Sellers also have the option of specifying an eBay Product ID (ePID) or optionally, a Global Trade Item Number (GTIN) through the corresponding fields in the product container in an attempt to find a product match in the eBay Catalog. If a match is found based on the ePID or GTIN value, the product aspects that are defined for the eBay Catalog product will automatically get picked up by the newly created/updated inventory item.

Below is an example of the proper JSON syntax to use when manually inputting item specifics. Note that one item specific name, such as ''Features'', can have more than one value. If an item specific name has more than one value, each value is delimited with a comma.

"aspects": {
 "Brand": ["GoPro"],
 "Storage Type": ["Removable"]
 }

Note that inventory items that will become part of an inventory item group and multiple-variation listing should have the same attributes that are defined for the inventory item group.

This container will be returned if one or more item specific pairs are defined for the inventory item.

Max Length for Aspect Name: 40

Max Length for Aspect Value: 50' brand: - type: "string" - description: "The brand of the product. This field is often paired with\ - \ the mpn field to identify a specific product by Manufacture\ - \ Part Number. This field is conditionally required if the eBay category\ - \ requires a Manufacturer Part Number (MPN) value. If eBay is able to\ - \ find a product match in the eBay Catalog when an eBay Product ID (ePID)\ - \ or GTIN value (UPC, ISBN, or EAN) is supplied, all product details of\ - \ that eBay Catalog product is picked up by the inventory item record\ - \ (including brand) if the createOrReplaceInventoryItem\ - \ call is successful.

This field is returned if defined for\ - \ an inventory item. If a brand was passed in as an item specific name-value\ - \ pair through the aspects array in a createOrReplaceInventoryItem\ - \ call, this value is also picked up by the brand field.

Max\ - \ Length: 65" + type: string + description: 'The brand of the product. This field is often paired with the mpn field to identify a specific product by Manufacture Part Number. This field is conditionally required if the eBay category requires a Manufacturer Part Number (MPN) value. If eBay is able to find a product match in the eBay Catalog when an eBay Product ID (ePID) or GTIN value (UPC, ISBN, or EAN) is supplied, all product details of that eBay Catalog product is picked up by the inventory item record (including brand) if the createOrReplaceInventoryItem call is successful.

This field is returned if defined for an inventory item. If a brand was passed in as an item specific name-value pair through the aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the brand field.

Max Length: 65' description: - type: "string" - description: "The description of the product. The description of an existing\ - \ inventory item can be added or modified with a createOrReplaceInventoryItem\ - \ call. The description of an inventory item is automatically populated\ - \ if the seller specifies an eBay Product ID (ePID) or a Global Trade\ - \ Item Number (GTIN) and eBay is able to find a matching product in the\ - \ eBay Catalog.

Note that this field is optional but recommended.\ - \ If a listingDescription field is omitted when creating\ - \ and publishing a single-variation offer, the text in this field will\ - \ be used instead. If neither the product.description\ - \ field for the inventory item nor the listingDescription\ - \ field for the offer exist, the publishOffer call will\ - \ fail. If the inventory item will be part of an inventory item group/multiple-variation\ - \ listing, this field should definitely be used to specify how the corresponding\ - \ product variation is different (e.g. This is the green, extra-large\ - \ version of the shirt). However, in the case of an inventory item\ - \ group, the text in the description field of the inventory\ - \ item group will become the listing description of the actual eBay listing\ - \ instead of the text in this field.

Basic HTML tags are supported,\ - \ including the following tags:
  • <b>
  • <strong>
  • <br>
  • <ol>
  • <ul>
  • <li>
  • Table\ - \ tags including <table>, <tr>, <td>, <th>, <thead>,\ - \ <tfoot>, <tbody>, <caption>, <colgroup>, and\ - \ <col>
A seller can not use any active content in their\ - \ listing description. Active content includes animation or video via\ - \ JavaScript, Flash, plug-ins, or form actions.

This field is\ - \ returned if defined for an inventory item. If one of the GTIN types\ - \ (e.g. UPC) was passed in when the inventory item was created/modified\ - \ and a product match was found in the eBay catalog, product description\ - \ is one of the details that gets picked up from the catalog product.

Max\ - \ Length: 4000" + type: string + description: 'The description of the product. The description of an existing inventory item can be added or modified with a createOrReplaceInventoryItem call. The description of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.

Note that this field is optional but recommended. If a listingDescription field is omitted when creating and publishing a single-variation offer, the text in this field will be used instead. If neither the product.description field for the inventory item nor the listingDescription field for the offer exist, the publishOffer call will fail. If the inventory item will be part of an inventory item group/multiple-variation listing, this field should definitely be used to specify how the corresponding product variation is different (e.g. This is the green, extra-large version of the shirt). However, in the case of an inventory item group, the text in the description field of the inventory item group will become the listing description of the actual eBay listing instead of the text in this field.

Basic HTML tags are supported, including the following tags:
  • <b>
  • <strong>
  • <br>
  • <ol>
  • <ul>
  • <li>
  • Table tags including <table>, <tr>, <td>, <th>, <thead>, <tfoot>, <tbody>, <caption>, <colgroup>, and <col>
A seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions.

This field is returned if defined for an inventory item. If one of the GTIN types (e.g. UPC) was passed in when the inventory item was created/modified and a product match was found in the eBay catalog, product description is one of the details that gets picked up from the catalog product.

Max Length: 4000' ean: - type: "array" - description: "The European Article Number/International Article Number (EAN)\ - \ for the product. Although an ePID value is preferred when trying to\ - \ find a product match in the eBay Catalog, this field can also be used\ - \ in an attempt to find a product match in the eBay Catalog. If a product\ - \ match is found in the eBay Catalog, the inventory item is automatically\ - \ populated with available product details such as a title, a product\ - \ description, product aspects (including the specified EAN value), and\ - \ a link to any stock image that exists for the catalog product.

This\ - \ field is returned if defined for an inventory item. If an EAN was passed\ - \ in as an item specific name-value pair through the aspects\ - \ array in a createOrReplaceInventoryItem call, this\ - \ value is also picked up by the ean field." + type: array + description: The European Article Number/International Article Number (EAN) for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified EAN value), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If an EAN was passed in as an item specific name-value pair through the aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the ean field. items: - type: "string" + type: string epid: - type: "string" - description: "The eBay Product Identifier (ePID) for the product. This field\ - \ can be used to directly identify an eBay Catalog product. Based on its\ - \ specified ePID value, eBay will search for the product in the eBay Catalog,\ - \ and if a match is found, the inventory item is automatically populated\ - \ with available product details such as product title, product description,\ - \ product aspects, and a link to any stock image that exists for the catalog\ - \ product.

In an attempt to find a eBay Catalog product match,\ - \ an ePID value is always preferred over the other product identifiers,\ - \ since it is possible that one GTIN value can be associated with multiple\ - \ eBay Catalog products, and if multiple products are found, product details\ - \ will not be picked up by the Inventory Item object.

This field\ - \ is returned if defined for an inventory item." + type: string + description: The eBay Product Identifier (ePID) for the product. This field can be used to directly identify an eBay Catalog product. Based on its specified ePID value, eBay will search for the product in the eBay Catalog, and if a match is found, the inventory item is automatically populated with available product details such as product title, product description, product aspects, and a link to any stock image that exists for the catalog product.

In an attempt to find a eBay Catalog product match, an ePID value is always preferred over the other product identifiers, since it is possible that one GTIN value can be associated with multiple eBay Catalog products, and if multiple products are found, product details will not be picked up by the Inventory Item object.

This field is returned if defined for an inventory item. imageUrls: - type: "array" - description: "An array of one or more links to images for the product. URLs\ - \ must use the \"HTTPS\" protocol. Images can be self-hosted by the seller,\ - \ or sellers can use the UploadSiteHostedPictures call of the Trading\ - \ API to upload images to an eBay Picture Server. If successful, the response\ - \ of the UploadSiteHostedPictures call will contain a full\ - \ URL to the image on an eBay Picture Server. This is the URL that will\ - \ be passed in through the imageUrls array. Before an\ - \ offer can be published, at least one image must exist for the inventory\ - \ item. Most eBay sites support up to 12 pictures free of charge, and\ - \ eBay Motors listings can have up to 24 pictures.

A link to\ - \ a stock image for a product may automatically be populated for an inventory\ - \ item if the seller specifies an eBay Product ID (ePID) or a Global Trade\ - \ Item Number (GTIN) and eBay is able to find a matching product in the\ - \ eBay Catalog.

This container will always be returned for an\ - \ inventory item that is part of a published offer since a published offer\ - \ will always have at least one picture, but this container will only\ - \ be returned if defined for inventory items that are not a part of a\ - \ published offer." + type: array + description: An array of one or more links to images for the product. URLs must use the "HTTPS" protocol. Images can be self-hosted by the seller, or sellers can use the UploadSiteHostedPictures call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the UploadSiteHostedPictures call will contain a full URL to the image on an eBay Picture Server. This is the URL that will be passed in through the imageUrls array. Before an offer can be published, at least one image must exist for the inventory item. In almost any category at no cost, sellers can include up to 24 pictures in one listing. For inventory items that are a part of an inventory item group/multiple-variation listings, a maximum of 12 pictures may be used per inventory item in the group. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors).

A link to a stock image for a product may automatically be populated for an inventory item if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.

This container will always be returned for an inventory item that is part of a published offer since a published offer will always have at least one picture, but this container will only be returned if defined for inventory items that are not a part of a published offer. items: - type: "string" + type: string isbn: - type: "array" - description: "The International Standard Book Number (ISBN) value for the\ - \ product. Although an ePID value is preferred when trying to find a product\ - \ match in the eBay Catalog, this field can also be used in an attempt\ - \ to find a product match in the eBay Catalog. If a product match is found\ - \ in the eBay Catalog, the inventory item is automatically populated with\ - \ available product details such as a title, a product description, product\ - \ aspects (including the specified ISBN value), and a link to any stock\ - \ image that exists for the catalog product.

This field is returned\ - \ if defined for an inventory item. If an ISBN was passed in as an item\ - \ specific name-value pair through the aspects array\ - \ in a createOrReplaceInventoryItem call, this value\ - \ is also picked up by the isbn field." + type: array + description: The International Standard Book Number (ISBN) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified ISBN value), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If an ISBN was passed in as an item specific name-value pair through the aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the isbn field. items: - type: "string" + type: string mpn: - type: "string" - description: "The Manufacturer Part Number (MPN) of a product. This field\ - \ is paired with the brand field to identify a product.\ - \ Some eBay categories require MPN values. The GetCategorySpecifics call of the Trading API\ - \ can be used to see if a category requires an MPN. The MPN value for\ - \ a product may automatically be populated for an inventory item if the\ - \ seller specifies an eBay Product ID (ePID) or a Global Trade Item Number\ - \ (GTIN) and eBay is able to find a matching product in the eBay Catalog.\ - \

This field is returned if defined for an inventory item. If\ - \ an MPN was passed in as an item specific name-value pair through the\ - \ aspects array in a createOrReplaceInventoryItem\ - \ call, this value is also picked up by the mpn field.

Max\ - \ Length: 65" + type: string + description: 'The Manufacturer Part Number (MPN) of a product. This field is paired with the brand field to identify a product. Some eBay categories require MPN values. The getItemAspectsForCategory method in the Taxonomy API can be used to see if a category requires an MPN. The MPN value for a product may automatically be populated for an inventory item if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog.

This field is returned if defined for an inventory item. If an MPN was passed in as an item specific name-value pair through the aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the mpn field.

Max Length: 65' subtitle: - type: "string" - description: "A subtitle is an optional listing feature that allows the\ - \ seller to provide more information about the product, possibly including\ - \ keywords that may assist with search results. An additional listing\ - \ fee will be charged to the seller if a subtitle is used. For more information\ - \ on using listing subtitles on the US site, see the Adding a subtitle to your listings help page.\ - \ The subtitle of an existing inventory item can added, modified, or removed\ - \ with a createOrReplaceInventoryItem call.

Note\ - \ that the same subtitle text should be used for each\ - \ inventory item that will be part of an inventory item group, and ultimately\ - \ become one product variation within a multiple-variation listing.

This\ - \ field will only be returned if set for an inventory item.

Max\ - \ Length: 55" + type: string + description: 'A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the Adding a subtitle to your listings help page. The subtitle of an existing inventory item can added, modified, or removed with a createOrReplaceInventoryItem call.

Note that the same subtitle text should be used for each inventory item that will be part of an inventory item group, and ultimately become one product variation within a multiple-variation listing.

This field will only be returned if set for an inventory item.

Max Length: 55' title: - type: "string" - description: "The title of an inventory item can be added or modified with\ - \ a createOrReplaceInventoryItem call. Although not immediately\ - \ required, a title will be needed before an offer with the inventory\ - \ item is published. The title of an inventory item is automatically populated\ - \ if the seller specifies an eBay Product ID (ePID) or a Global Trade\ - \ Item Number (GTIN) and eBay is able to find a matching product in the\ - \ eBay Catalog. If the inventory item will become part of a single-variation\ - \ offer, and the listing is not a product-based listing, the text in this\ - \ field will become the actual listing title for the published offer.\ - \ However, if the inventory item will become part of a multiple-variation\ - \ offer, the text in title field of the inventory item\ - \ group entity will actually become the listing title for the published\ - \ offer instead, although a title can still be provided for the inventory\ - \ item, and it will actually become the title of the variation.

This\ - \ field will always be returned for an inventory item that is part of\ - \ a published offer since a published offer will always have a listing\ - \ title, but this field will only be returned if defined for inventory\ - \ items that are not a part of a published offer.

Max\ - \ Length: 80" + type: string + description: 'The title of an inventory item can be added or modified with a createOrReplaceInventoryItem call. Although not immediately required, a title will be needed before an offer with the inventory item is published. The title of an inventory item is automatically populated if the seller specifies an eBay Product ID (ePID) or a Global Trade Item Number (GTIN) and eBay is able to find a matching product in the eBay Catalog. If the inventory item will become part of a single-variation offer, and the listing is not a product-based listing, the text in this field will become the actual listing title for the published offer. However, if the inventory item will become part of a multiple-variation offer, the text in title field of the inventory item group entity will actually become the listing title for the published offer instead, although a title can still be provided for the inventory item, and it will actually become the title of the variation.

This field will always be returned for an inventory item that is part of a published offer since a published offer will always have a listing title, but this field will only be returned if defined for inventory items that are not a part of a published offer.

Max Length: 80' upc: - type: "array" - description: "The Universal Product Code (UPC) value for the product. Although\ - \ an ePID value is preferred when trying to find a product match in the\ - \ eBay Catalog, this field can also be used in an attempt to find a product\ - \ match in the eBay Catalog. If a product match is found in the eBay Catalog,\ - \ the inventory item is automatically populated with available product\ - \ details such as a title, a product description, product aspects (including\ - \ the specified UPC value), and a link to any stock image that exists\ - \ for the catalog product.

This field is returned if defined\ - \ for an inventory item. If a UPC was passed in as an item specific name-value\ - \ pair through the aspects array in a createOrReplaceInventoryItem\ - \ call, this value is also picked up by the upc field." + type: array + description: The Universal Product Code (UPC) value for the product. Although an ePID value is preferred when trying to find a product match in the eBay Catalog, this field can also be used in an attempt to find a product match in the eBay Catalog. If a product match is found in the eBay Catalog, the inventory item is automatically populated with available product details such as a title, a product description, product aspects (including the specified UPC value), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If a UPC was passed in as an item specific name-value pair through the aspects array in a createOrReplaceInventoryItem call, this value is also picked up by the upc field. items: - type: "string" + type: string videoIds: - type: "array" - description: "An array of one or more VideoId values for the product. A\ - \ VideoId is a unique identifier that is automatically created by eBay\ - \ when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API.

For information on supported\ - \ marketplaces and platforms, as well as other requirements and limitations\ - \ of video support, please refer to Managing videos." + type: array + description: An array of one or more VideoId values for the product. A VideoId is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API.

For information on supported marketplaces and platforms, as well as other requirements and limitations of video support, please refer to Managing videos. items: - type: "string" - description: "This type is used to define the product details, such as a title,\ - \ a product description, product aspects/item specifics, and links to images\ - \ for the product. Optionally, in a createOrReplaceInventoryItem\ - \ call, a seller can pass in an eBay Product Identifier (ePID) or a Global\ - \ Trade Item Number (GTIN) value, such as an EAN, an ISBN, a UPC, to identify\ - \ a product to be matched with a product in the eBay Catalog. The information\ - \ in this type is also returned in the getInventoryItem,\ - \ getInventoryItems, and bulkGetInventoryItem\ - \ calls if defined." + type: string + description: This type is used to define the product details, such as a title, a product description, product aspects/item specifics, and links to images for the product. Optionally, in a createOrReplaceInventoryItem call, a seller can pass in an eBay Product Identifier (ePID) or a Global Trade Item Number (GTIN) value, such as an EAN, an ISBN, a UPC, to identify a product to be matched with a product in the eBay Catalog. The information in this type is also returned in the getInventoryItem, getInventoryItems, and bulkGetInventoryItem calls if defined. ProductFamilyProperties: - type: "object" + type: object properties: engine: - type: "string" - description: "This field indicates the specifications of the engine, including\ - \ its size, block type, and fuel type. An example is 2.7L V6 gas\ - \ DOHC naturally aspirated. This field is conditionally required,\ - \ but should be supplied if known/applicable." + type: string + description: This field indicates the specifications of the engine, including its size, block type, and fuel type. An example is 2.7L V6 gas DOHC naturally aspirated. This field is conditionally required, but should be supplied if known/applicable. make: - type: "string" - description: "This field indicates the make of the vehicle (e.g. Toyota).\ - \ This field is always required to identify a motor vehicle." + type: string + description: This field indicates the make of the vehicle (e.g. Toyota). This field is always required to identify a motor vehicle. model: - type: "string" - description: "This field indicates the model of the vehicle (e.g. Camry).\ - \ This field is always required to identify a motor vehicle." + type: string + description: This field indicates the model of the vehicle (e.g. Camry). This field is always required to identify a motor vehicle. trim: - type: "string" - description: "This field indicates the trim of the vehicle (e.g. 2-door\ - \ Coupe). This field is conditionally required, but should be supplied\ - \ if known/applicable." + type: string + description: This field indicates the trim of the vehicle (e.g. 2-door Coupe). This field is conditionally required, but should be supplied if known/applicable. year: - type: "string" - description: "This field indicates the year of the vehicle (e.g. 2016).\ - \ This field is always required to identify a motor vehicle." - description: "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." + type: string + description: This field indicates the year of the vehicle (e.g. 2016). This field is always required to identify a motor vehicle. + description: 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. ProductIdentifier: - type: "object" + type: object properties: epid: - type: "string" - description: "This field can be used if the seller already knows the eBay\ - \ catalog product ID (ePID) associated with the motor vehicle that is\ - \ to be added to the compatible product list. If this eBay catalog product\ - \ ID is found in the eBay product catalog, the motor vehicle properties\ - \ (e.g. make, model, year, engine, and trim) will automatically get picked\ - \ up for that motor vehicle." + type: string + description: This field can be used if the seller already knows the eBay catalog product ID (ePID) associated with the motor vehicle that is to be added to the compatible product list. If this eBay catalog product ID is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim) will automatically get picked up for that motor vehicle. gtin: - type: "string" - description: "This field can be used if the seller knows the Global Trade\ - \ Item Number for the motor vehicle that is to be added to the compatible\ - \ product list. If this GTIN value is found in the eBay product catalog,\ - \ the motor vehicle properties (e.g. make, model, year, engine, and trim\ - \ will automatically get picked up for that motor vehicle.

Note: This field is for future\ - \ use." + type: string + description: This field can be used if the seller knows the Global Trade Item Number for the motor vehicle that is to be added to the compatible product list. If this GTIN value is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim will automatically get picked up for that motor vehicle.

Note: This field is for future use. ktype: - type: "string" - description: "This field can be used if the seller knows the K Type Number\ - \ for the motor vehicle that is to be added to the compatible product\ - \ list. If this K Type value is found in the eBay product catalog, the\ - \ motor vehicle properties (e.g. make, model, year, engine, and trim)\ - \ will automatically get picked up for that motor vehicle.

Only\ - \ the AU, DE, ES, FR, IT, and UK marketplaces support the use of K Type\ - \ Numbers." - description: "This type is used to identify a motor vehicle that is compatible\ - \ with the corresponding inventory item (the SKU that is passed in as part\ - \ of the call URI). The motor vehicle can be identified through an eBay Product\ - \ ID or a K-Type value. The gtin field (for inputting Global\ - \ Trade Item Numbers) is for future use only. If a motor vehicle is found\ - \ in the eBay product catalog, the motor vehicle properties (engine, make,\ - \ model, trim, and year) will automatically get picked up for that motor vehicle.

Note: Currently, parts compatibility\ - \ is only applicable for motor vehicles, but it is possible that the Product\ - \ Compatibility feature is expanded to other (non-vehicle) products in the\ - \ future." + type: string + description: This field can be used if the seller knows the K Type Number for the motor vehicle that is to be added to the compatible product list. If this K Type value is found in the eBay product catalog, the motor vehicle properties (e.g. make, model, year, engine, and trim) will automatically get picked up for that motor vehicle.

Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K Type Numbers. + description: This type is used to identify a motor vehicle that is compatible with the corresponding inventory item (the SKU that is passed in as part of the call URI). The motor vehicle can be identified through an eBay Product ID or a K-Type value. The gtin field (for inputting Global Trade Item Numbers) is for future use only. If a motor vehicle is found in the eBay product catalog, the motor vehicle properties (engine, make, model, trim, and year) will automatically get picked up for that motor vehicle.

Note: Currently, parts compatibility is only applicable for motor vehicles, but it is possible that the Product Compatibility feature is expanded to other (non-vehicle) products in the future. PublishByInventoryItemGroupRequest: - type: "object" + type: object properties: inventoryItemGroupKey: - type: "string" - description: "This is the unique identifier of the inventory item group.\ - \ All unpublished offers associated with this inventory item group will\ - \ be published as a multiple-variation listing if the publishByInventoryItemGroup\ - \ call is successful. The inventoryItemGroupKey identifier\ - \ is automatically generated by eBay once an inventory item group is created.

To\ - \ retrieve an inventoryItemGroupKey value, you can use\ - \ the getInventoryItem call to retrieve an inventory\ - \ item that is known to be in the inventory item group to publish, and\ - \ then look for the inventory item group identifier under the groupIds\ - \ container in the response of that call." + type: string + description: This is the unique identifier of the inventory item group. All unpublished offers associated with this inventory item group will be published as a multiple-variation listing if the publishByInventoryItemGroup call is successful. The inventoryItemGroupKey identifier is automatically generated by eBay once an inventory item group is created.

To retrieve an inventoryItemGroupKey value, you can use the getInventoryItem call to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the groupIds container in the response of that call. marketplaceId: - type: "string" - description: "This is the unique identifier of the eBay site on which the\ - \ multiple-variation listing will be published. The marketPlaceId\ - \ enumeration values are found in MarketplaceIdEnum.\ - \ For implementation help, refer to eBay\ - \ API documentation" - description: "This type is used by the request payload of the publishByInventoryItemGroup\ - \ call. 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." + type: string + description: This is the unique identifier of the eBay site on which the multiple-variation listing will be published. The marketPlaceId enumeration values are found in MarketplaceIdEnum. For implementation help, refer to eBay API documentation + description: This type is used by the request payload of the publishByInventoryItemGroup call. 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. PublishResponse: - type: "object" + type: object properties: listingId: - type: "string" - description: "The unique identifier of the newly created eBay listing. This\ - \ field is returned if the single offer (if publishOffer\ - \ call was used) or group of offers in an inventory item group (if publishOfferByInventoryItemGroup\ - \ call was used) was successfully converted into an eBay listing." + type: string + description: The unique identifier of the newly created eBay listing. This field is returned if the single offer (if publishOffer call was used) or group of offers in an inventory item group (if publishOfferByInventoryItemGroup call was used) was successfully converted into an eBay listing. warnings: - type: "array" - description: "This container will contain an array of errors and/or warnings\ - \ if any occur when a publishOffer or publishOfferByInventoryItemGroup\ - \ call is made." + type: array + description: This container will contain an array of errors and/or warnings if any occur when a publishOffer or publishOfferByInventoryItemGroup call is made. items: - $ref: "#/components/schemas/Error" - description: "This type is used by the base response payload of the publishOffer\ - \ and publishOfferByInventoryItemGroup calls." + $ref: '#/components/schemas/Error' + description: This type is used by the base response payload of the publishOffer and publishOfferByInventoryItemGroup calls. ShipToLocationAvailability: - type: "object" + type: object properties: availabilityDistributions: - type: "array" - description: "This container is used to set the available quantity of the\ - \ inventory item at one or more warehouse locations.

This container\ - \ will be returned if available quantity is set for one or more inventory\ - \ locations." + type: array + description: This container is used to set the available quantity of the inventory item at one or more warehouse locations.

This container will be returned if available quantity is set for one or more inventory locations. items: - $ref: "#/components/schemas/AvailabilityDistribution" + $ref: '#/components/schemas/AvailabilityDistribution' quantity: - type: "integer" - description: "This container is used to set the total 'ship-to-home' quantity\ - \ of the inventory item that will be available for purchase through one\ - \ or more published offers. This container is not immediately required,\ - \ but 'ship-to-home' quantity must be set before an offer of the inventory\ - \ item can be published.

If an existing inventory item is being\ - \ updated, and the 'ship-to-home' quantity already exists for the inventory\ - \ item record, this container should be included again, even if the value\ - \ is not changing, or the available quantity data will be lost." - format: "int32" - description: "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." + type: integer + description: This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers. This container is not immediately required, but 'ship-to-home' quantity must be set before an offer of the inventory item can be published.

If an existing inventory item is being updated, and the 'ship-to-home' quantity already exists for the inventory item record, this container should be included again, even if the value is not changing, or the available quantity data will be lost. + format: int32 + description: 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. ShipToLocationAvailabilityWithAll: - type: "object" + type: object properties: allocationByFormat: - description: "This container is used to specify the quantity of the inventory\ - \ item that is available for purchase, allocated by the offer types." - $ref: "#/components/schemas/FormatAllocation" + description: This container is used to specify the quantity of the inventory item that is available for purchase, allocated by the offer types. + $ref: '#/components/schemas/FormatAllocation' availabilityDistributions: - type: "array" - description: "This container is used to set the available quantity of the\ - \ inventory item at one or more warehouse locations.

This\ - \ container will be returned if the available quantity is set for one\ - \ or more inventory locations." + type: array + description: This container is used to set the available quantity of the inventory item at one or more warehouse locations.

This container will be returned if the available quantity is set for one or more inventory locations. items: - $ref: "#/components/schemas/AvailabilityDistribution" + $ref: '#/components/schemas/AvailabilityDistribution' quantity: - type: "integer" - description: "This container is used to set the total 'ship-to-home' quantity\ - \ of the inventory item that will be available for purchase through one\ - \ or more published offers. This container is not immediately required,\ - \ but 'ship-to-home' quantity must be set before an offer of the inventory\ - \ item can be published.

If an existing inventory item is being\ - \ updated, and the 'ship-to-home' quantity already exists for the inventory\ - \ item record, this container should be included again, even if the value\ - \ is not changing, or the available quantity data will be lost." - format: "int32" - description: "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." + type: integer + description: This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers. This container is not immediately required, but 'ship-to-home' quantity must be set before an offer of the inventory item can be published.

If an existing inventory item is being updated, and the 'ship-to-home' quantity already exists for the inventory item record, this container should be included again, even if the value is not changing, or the available quantity data will be lost. + format: int32 + description: 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. ShippingCostOverride: - type: "object" + type: object properties: additionalShippingCost: - description: "The dollar value passed into this field will override the\ - \ additional shipping cost that is currently set for the applicable shipping\ - \ service option. The \"Additional shipping cost\" is the cost to ship\ - \ each additional identical product to the buyer using the corresponding\ - \ shipping service. The shipping service option in the fulfillment policy\ - \ to override is controlled by the shippingServiceType\ - \ and priority values.

If using an updateOffer\ - \ call, and this field is defined for the offer being updated, this field\ - \ must be supplied again, even if its value is not changing.

This\ - \ field is returned in the getOffer and getOffers\ - \ calls if defined." - $ref: "#/components/schemas/Amount" + description: The dollar value passed into this field will override the additional shipping cost that is currently set for the applicable shipping service option. The "Additional shipping cost" is the cost to ship each additional identical product to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values.

If using an updateOffer call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.

This field is returned in the getOffer and getOffers calls if defined. + $ref: '#/components/schemas/Amount' priority: - type: "integer" - description: "The integer value input into this field, along with the shippingServiceType\ - \ value, sets which domestic or international shipping service option\ - \ in the fulfillment policy will be modified with updated shipping costs.\ - \ Specifically, the shippingCostOverrides.shippingServiceType\ - \ value in a createOffer or updateOffer\ - \ call must match the shippingOptions.optionType value\ - \ in a fulfillment listing policy, and the shippingCostOverrides.priority\ - \ value in a createOffer or updateOffer\ - \ call must match the shippingOptions.shippingServices.sortOrderId\ - \ value in a fulfillment listing policy.

This field is always required\ - \ when overriding the shipping costs of a shipping service option, and\ - \ will be always be returned for each shipping service option whose costs\ - \ are being overridden." - format: "int32" + type: integer + description: The integer value input into this field, along with the shippingServiceType value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs. Specifically, the shippingCostOverrides.shippingServiceType value in a createOffer or updateOffer call must match the shippingOptions.optionType value in a fulfillment listing policy, and the shippingCostOverrides.priority value in a createOffer or updateOffer call must match the shippingOptions.shippingServices.sortOrderId value in a fulfillment listing policy.

This field is always required when overriding the shipping costs of a shipping service option, and will be always be returned for each shipping service option whose costs are being overridden. + format: int32 shippingCost: - description: "The dollar value passed into this field will override the\ - \ shipping cost that is currently set for the applicable shipping service\ - \ option. This value will be the cost to ship one item to the buyer using\ - \ the corresponding shipping service. The shipping service option in\ - \ the fulfillment policy to override is controlled by the shippingServiceType\ - \ and priority values.

If using an updateOffer\ - \ call, and this field is defined for the offer being updated, this field\ - \ must be supplied again, even if its value is not changing.

This\ - \ field is returned in the getOffer and getOffers\ - \ calls if defined." - $ref: "#/components/schemas/Amount" + description: The dollar value passed into this field will override the shipping cost that is currently set for the applicable shipping service option. This value will be the cost to ship one item to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values.

If using an updateOffer call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.

This field is returned in the getOffer and getOffers calls if defined. + $ref: '#/components/schemas/Amount' shippingServiceType: - type: "string" - description: "This enumerated value indicates whether the shipping service\ - \ specified in the priority field is a domestic or an\ - \ international shipping service option. To override the shipping costs\ - \ for a specific domestic shipping service in the fulfillment listing\ - \ policy, this field should be set to DOMESTIC, and to override\ - \ the shipping costs for each international shipping service, this field\ - \ should be set to INTERNATIONAL. This value, along with\ - \ priority value, sets which domestic or international\ - \ shipping service option in the fulfillment policy that will be modified\ - \ with updated shipping costs. Specifically, the shippingCostOverrides.shippingServiceType\ - \ value in a createOffer or updateOffer\ - \ call must match the shippingOptions.optionType value\ - \ in a fulfillment listing policy, and the shippingCostOverrides.priority\ - \ value in a createOffer or updateOffer\ - \ call must match the shippingOptions.shippingServices.sortOrderId\ - \ value in a fulfillment listing policy.

This field is always required\ - \ when overriding the shipping costs of a shipping service option, and\ - \ will be always be returned for each shipping service option whose costs\ - \ are being overridden. For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumerated value indicates whether the shipping service specified in the priority field is a domestic or an international shipping service option. To override the shipping costs for a specific domestic shipping service in the fulfillment listing policy, this field should be set to DOMESTIC, and to override the shipping costs for each international shipping service, this field should be set to INTERNATIONAL. This value, along with priority value, sets which domestic or international shipping service option in the fulfillment policy that will be modified with updated shipping costs. Specifically, the shippingCostOverrides.shippingServiceType value in a createOffer or updateOffer call must match the shippingOptions.optionType value in a fulfillment listing policy, and the shippingCostOverrides.priority value in a createOffer or updateOffer call must match the shippingOptions.shippingServices.sortOrderId value in a fulfillment listing policy.

This field is always required when overriding the shipping costs of a shipping service option, and will be always be returned for each shipping service option whose costs are being overridden. For implementation help, refer to eBay API documentation surcharge: - description: " Note: DO NOT USE\ - \ THIS FIELD. Shipping surcharges for shipping service options can no\ - \ longer be set with fulfillment business policies. To set a shipping\ - \ surcharge for a shipping service option, only the Shipping rate tables\ - \ tool in My eBay can be used.

The dollar value passed\ - \ into this field will override the shipping surcharge that is currently\ - \ set for the applicable shipping service option. The shipping service\ - \ option in the fulfillment policy to override is controlled by the shippingServiceType\ - \ and priority values.

If using an updateOffer\ - \ call, and this field is defined for the offer being updated, this field\ - \ must be supplied again, even if its value is not changing.

This\ - \ field is returned in the getOffer and getOffers\ - \ calls if defined." - $ref: "#/components/schemas/Amount" - description: "This type is used if the seller wants to override the shipping\ - \ costs or surcharge associated with a specific domestic or international\ - \ shipping service option defined in the fulfillment listing policy that is\ - \ being applied toward the offer. The shipping-related costs that can be overridden\ - \ include the shipping cost to ship one item, the shipping cost to ship each\ - \ additional item (if multiple quantity are purchased), and the shipping surcharge\ - \ applied to the shipping service option." + description: Note: DO NOT USE THIS FIELD. Shipping surcharges for shipping service options can no longer be set with fulfillment business policies. To set a shipping surcharge for a shipping service option, only the Shipping rate tables tool in My eBay can be used.

The dollar value passed into this field will override the shipping surcharge that is currently set for the applicable shipping service option. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values.

If using an updateOffer call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.

This field is returned in the getOffer and getOffers calls if defined. + $ref: '#/components/schemas/Amount' + description: This type is used if the seller wants to override the shipping costs or surcharge associated with a specific domestic or international shipping service option defined in the fulfillment listing policy that is being applied toward the offer. The shipping-related costs that can be overridden include the shipping cost to ship one item, the shipping cost to ship each additional item (if multiple quantity are purchased), and the shipping surcharge applied to the shipping service option. SpecialHours: - type: "object" + type: object properties: date: - type: "string" - description: "A date value is required for each specific\ - \ date that the store location has special operating hours.

The\ - \ timestamp is formatted as an ISO 8601 string,\ - \ which is based on the 24-hour Coordinated Universal Time (UTC) clock.\ - \

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z\ - \
Example: 2018-08-04T07:09:00.000Z

This\ - \ field is returned if set for the store location." + type: string + description: A date value is required for each specific date that the store location has special operating hours.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-04T07:09:00.000Z

This field is returned if set for the store location. intervals: - type: "array" - description: "This container is used to define the opening and closing times\ - \ of a store on a specific date (defined in the date\ - \ field). An intervals container is needed for each specific\ - \ date that the store has special operating hours. These special operating\ - \ hours on the specific date override the normal operating hours for the\ - \ specific day of the week. If a store location closes for lunch (or any\ - \ other period during the day) and then reopens, multiple open\ - \ and close pairs are needed.

This container\ - \ is returned if set for the store location." + type: array + description: This container is used to define the opening and closing times of a store on a specific date (defined in the date field). An intervals container is needed for each specific date that the store has special operating hours. These special operating hours on the specific date override the normal operating hours for the specific day of the week. If a store location closes for lunch (or any other period during the day) and then reopens, multiple open and close pairs are needed.

This container is returned if set for the store location. items: - $ref: "#/components/schemas/Interval" - description: "This type is used to express the special operating hours of a\ - \ store location on a specific date. A specialHours container\ - \ is needed when the store's opening hours on a specific date are different\ - \ than the normal operating hours on that particular day of the week." + $ref: '#/components/schemas/Interval' + description: This type is used to express the special operating hours of a store location on a specific date. A specialHours container is needed when the store's opening hours on a specific date are different than the normal operating hours on that particular day of the week. Specification: - type: "object" + type: object properties: name: - type: "string" - description: "This is the name of product variation aspect. Typically, for\ - \ clothing, typical aspect names are \"Size\" and \"\ - Color\". Product variation aspects are not required immediately\ - \ upon creating an inventory item group, but these aspects will be required\ - \ before a multiple-variation listing containing this inventory item group\ - \ is published. For each product variation aspect that is specified through\ - \ the specifications container, one name\ - \ value is required and two or more variations of this aspect are required\ - \ through the values array.

Note: Each member of the inventory item\ - \ group should have these same aspect names specified through the product.aspects\ - \ container when the inventory item is created with the createOrReplaceInventoryItem\ - \ or bulkCreateOrReplaceInventoryItem call.
Max\ - \ Length: 40" + type: string + description: 'This is the name of product variation aspect. Typically, for clothing, typical aspect names are "Size" and "Color". Product variation aspects are not required immediately upon creating an inventory item group, but these aspects will be required before a multiple-variation listing containing this inventory item group is published. For each product variation aspect that is specified through the specifications container, one name value is required and two or more variations of this aspect are required through the values array.

Note: Each member of the inventory item group should have these same aspect names specified through the product.aspects container when the inventory item is created with the createOrReplaceInventoryItem or bulkCreateOrReplaceInventoryItem call.
Max Length: 40' values: - type: "array" - description: "This is an array of values pertaining to the corresponding\ - \ product variation aspect (specified in the name field).\ - \ Below is a sample of how these values will appear under a specifications\ - \ container: 
\"specifications\": [{
 \"name\": \"\
-            Size\",
 \"values\": [\"Small\",
 \"Medium\",
 \"Large\"]
\
-            \ },
 { 
 \"name\": \"Color\",
 \"values\": [\"Blue\",
\
-            \ \"White\",
 \"Red\"] 
 }]
Note: Each member of the inventory item group should\ - \ have these same aspect names, and each individual inventory item should\ - \ have each variation of the product aspect values specified through the\ - \ product.aspects container when the inventory item is\ - \ created with the createOrReplaceInventoryItem or bulkCreateOrReplaceInventoryItem\ - \ call.
Max Length: 50" + type: array + description: 'This is an array of values pertaining to the corresponding product variation aspect (specified in the name field). Below is a sample of how these values will appear under a specifications container: 
"specifications": [{
 "name": "Size",
 "values": ["Small",
 "Medium",
 "Large"]
 },
 { 
 "name": "Color",
 "values": ["Blue",
 "White",
 "Red"] 
 }]
Note: Each member of the inventory item group should have these same aspect names, and each individual inventory item should have each variation of the product aspect values specified through the product.aspects container when the inventory item is created with the createOrReplaceInventoryItem or bulkCreateOrReplaceInventoryItem call.
Max Length: 50' items: - type: "string" - description: "This type is used to specify product aspects for which variations\ - \ within an inventory item group vary, and the order in which they appear\ - \ in the listing. For example, t-shirts in an inventory item group may be\ - \ available in multiple sizes and colors." + type: string + description: This type is used to specify product aspects for which variations within an inventory item group vary, and the order in which they appear in the listing. For example, t-shirts in an inventory item group may be available in multiple sizes and colors. Tax: - type: "object" + type: object properties: applyTax: - type: "boolean" - description: "This field will be included and set to true if\ - \ the seller would like to reference their account-level Sales Tax Table\ - \ to calculate sales tax for an order. A seller's Sales Tax Table can\ - \ be created and managed manually in My eBay's Payment Preferences. This\ - \ Sales Tax Table contains all tax jurisdictions for the seller's country\ - \ (individual states and territories in US), and the seller can set the\ - \ sales tax rate for these individual tax jurisdictions.

The\ - \ Trading API has a SetTaxTable call to add/modify sales tax rates\ - \ for one or more tax jurisdictions, and a GetTaxTable call that will retrieve all tax jurisdictions\ - \ and related data, such as the sales tax rate (if defined) and a boolean\ - \ field to indicate if sales tax is applied to shipping and handling costs.

\ - \ The Account API has a getSalesTaxTable call to retrieve\ - \ all tax jurisdictions that have a defined sales tax rate, a getSalesTaxTableEntry\ - \ call to retrieve a sales tax rate for a specific tax jurisdiction, a\ - \ createSalesTaxTableEntry call to set/modify a sales\ - \ tax rate for a specific tax jurisdiction, and a deleteSalesTaxTableEntry\ - \ call to remove a sales tax rate from a specific tax jurisdiction.

Note\ - \ that a seller can enable the use of a sales tax table, but if a sales\ - \ tax rate is not specified for the buyer's state/tax jurisdiction, sales\ - \ tax will not be applied to the order. If a thirdPartyTaxCategory\ - \ value is used, the applyTax field must also be used\ - \ and set to true

This field will be returned if\ - \ set for the offer.

See the Using a tax table help page for more information\ - \ on setting up and using a sales tax table." + type: boolean + description: This field will be included and set to true if the seller would like to reference their account-level Sales Tax Table to calculate sales tax for an order. A seller's Sales Tax Table can be created and managed manually in My eBay's Payment Preferences. This Sales Tax Table contains all tax jurisdictions for the seller's country (individual states and territories in US), and the seller can set the sales tax rate for these individual tax jurisdictions.

The Trading API has a SetTaxTable call to add/modify sales tax rates for one or more tax jurisdictions, and a GetTaxTable call that will retrieve all tax jurisdictions and related data, such as the sales tax rate (if defined) and a boolean field to indicate if sales tax is applied to shipping and handling costs.

The Account API has a getSalesTaxTable call to retrieve all tax jurisdictions that have a defined sales tax rate, a getSalesTaxTableEntry call to retrieve a sales tax rate for a specific tax jurisdiction, a createSalesTaxTableEntry call to set/modify a sales tax rate for a specific tax jurisdiction, and a deleteSalesTaxTableEntry call to remove a sales tax rate from a specific tax jurisdiction.

Note that a seller can enable the use of a sales tax table, but if a sales tax rate is not specified for the buyer's state/tax jurisdiction, sales tax will not be applied to the order. If a thirdPartyTaxCategory value is used, the applyTax field must also be used and set to true

This field will be returned if set for the offer.

See the Using a tax table help page for more information on setting up and using a sales tax table. thirdPartyTaxCategory: - type: "string" - description: "The tax exception category code. If this field is used, sales\ - \ tax will also apply to a service/fee, and not just the item price. This\ - \ is to be used only by sellers who have opted into sales tax being calculated\ - \ by a sales tax calculation vendor. If you are interested in becoming\ - \ a tax calculation vendor partner with eBay, contact developer-relations@ebay.com. One supported value for this field\ - \ is WASTE_RECYCLING_FEE. If this field is used, the applyTax\ - \ field must also be used and set to true

This field\ - \ will be returned if set for the offer." + type: string + description: The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact developer-relations@ebay.com. One supported value for this field is WASTE_RECYCLING_FEE. If this field is used, the applyTax field must also be used and set to true

This field will be returned if set for the offer. vatPercentage: - type: "number" - description: "This value is the Value Add Tax (VAT) rate for the item, if\ - \ any. When a VAT percentage is specified, the item's VAT information\ - \ appears on the listing's View Item page. In addition, the seller can\ - \ choose to print an invoice that includes the item's net price, VAT percent,\ - \ VAT amount, and total price. Since VAT rates vary depending on the item\ - \ and on the user's country of residence, a seller is responsible for\ - \ entering the correct VAT rate; it is not calculated by eBay.

\ - \ To use VAT, a seller must be a business seller with a VAT-ID registered\ - \ with eBay, and must be listing the item on a VAT-enabled site. Max applicable\ - \ length is 6 characters, including the decimal (e.g., 12.345). The scale\ - \ is 3 decimal places. (If you pass in 12.3456, eBay may round up the\ - \ value to 12.346).

This field will be returned if set for the\ - \ offer." - description: "This type is used to enable the use of a sales tax table, to pass\ - \ in a tax exception category code, or to specify a VAT percentage." + type: number + description: This value is the Value Add Tax (VAT) rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay.

To use VAT, a seller must be a business seller with a VAT-ID registered with eBay, and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346).

This field will be returned if set for the offer. + description: This type is used to enable the use of a sales tax table, to pass in a tax exception category code, or to specify a VAT percentage. TimeDuration: - type: "object" + type: object properties: unit: - type: "string" - description: "This enumeration value indicates the time unit used to specify\ - \ the fulfillment time, such as HOUR or BUSINESS_DAY.\ - \ For implementation help, refer to eBay\ - \ API documentation" + type: string + description: This enumeration value indicates the time unit used to specify the fulfillment time, such as HOUR or BUSINESS_DAY. For implementation help, refer to eBay API documentation value: - type: "integer" - description: "The integer value in this field, along with the time unit\ - \ in the unit field, will indicate the fulfillment time.

\ - \ For In-Store Pickup orders, this value will indicate how soon after\ - \ an In-Store Pickup purchase can the buyer pick up the item at the designated\ - \ store location. If the value of this field is 4, and the\ - \ value of the unit field is HOUR, then\ - \ the fulfillment time for the In-Store Pickup order is four hours, which\ - \ means that the buyer will be able to pick up the item at the store four\ - \ hours after the transaction took place.

For standard orders\ - \ that will be shipped, this value will indicate the expected fulfillment\ - \ time if the inventory item is shipped from the inventory location. If\ - \ the value of this field is 4, and the value of the unit\ - \ field is BUSINESS_DAY, then the estimated delivery date\ - \ after purchase is 4 business days." - format: "int32" - description: "This type is used to indicate the fulfillment time for an In-Store\ - \ Pickup order, or for an order than will be shipped to the buyer." + type: integer + description: The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time.

For In-Store Pickup orders, this value will indicate how soon after an In-Store Pickup purchase can the buyer pick up the item at the designated store location. If the value of this field is 4, and the value of the unit field is HOUR, then the fulfillment time for the In-Store Pickup order is four hours, which means that the buyer will be able to pick up the item at the store four hours after the transaction took place.

For standard orders that will be shipped, this value will indicate the expected fulfillment time if the inventory item is shipped from the inventory location. If the value of this field is 4, and the value of the unit field is BUSINESS_DAY, then the estimated delivery date after purchase is 4 business days. + format: int32 + description: This type is used to indicate the fulfillment time for an In-Store Pickup order, or for an order than will be shipped to the buyer. VariesBy: - type: "object" + type: object properties: aspectsImageVariesBy: - type: "array" - description: "This container is used if the seller wants to include multiple\ - \ images to demonstrate how variations within a multiple-variation listing\ - \ differ. In this string field, the seller will specify the product aspect\ - \ where the variations of the inventory item group vary, such as color.\ - \ If Color is specified in this field, Color\ - \ must also be one of the specifications.name values,\ - \ and all available colors must appear in the corresponding specifications.values\ - \ array.

If the aspectsImageVariesBy container\ - \ is used, links to images of each variation should be specified through\ - \ the imageUrls container of the inventory item group,\ - \ or the seller can choose to include those links to images in each inventory\ - \ item record for the inventory items in the group." + type: array + description: This container is used if the seller wants to include multiple images to demonstrate how variations within a multiple-variation listing differ. In this string field, the seller will specify the product aspect where the variations of the inventory item group vary, such as color. If Color is specified in this field, Color must also be one of the specifications.name values, and all available colors must appear in the corresponding specifications.values array.

If the aspectsImageVariesBy container is used, links to images of each variation should be specified through the imageUrls container of the inventory item group, or the seller can choose to include those links to images in each inventory item record for the inventory items in the group. items: - type: "string" + type: string specifications: - type: "array" - description: "This container consists of an array of one or more product\ - \ aspects where each variation differs, and values for each of those product\ - \ aspects. This container is not immediately required, but will be required\ - \ before the first offer of the inventory item group is published.

If\ - \ a product aspect is specified in the aspectsImageVariesBy\ - \ container, this product aspect (along with all variations of that product\ - \ aspect) must be included in the specifications container.\ - \ Before offers related to the inventory item group are published, the\ - \ product aspects and values specified through the specifications\ - \ container should be in synch with the name-value pairs specified through\ - \ the product.aspects containers of the inventory items\ - \ contained in the group. For example, if Color and Size\ - \ are in this specifications container, each inventory\ - \ item of the group should also have Color and Size\ - \ as aspect names in their inventory item records.

This container\ - \ is always returned if one or more offers associated with the inventory\ - \ item group have been published. For inventory item groups that have\ - \ yet to have any published offers, this container is only returned if\ - \ set." + type: array + description: This container consists of an array of one or more product aspects where each variation differs, and values for each of those product aspects. This container is not immediately required, but will be required before the first offer of the inventory item group is published.

If a product aspect is specified in the aspectsImageVariesBy container, this product aspect (along with all variations of that product aspect) must be included in the specifications container. Before offers related to the inventory item group are published, the product aspects and values specified through the specifications container should be in synch with the name-value pairs specified through the product.aspects containers of the inventory items contained in the group. For example, if Color and Size are in this specifications container, each inventory item of the group should also have Color and Size as aspect names in their inventory item records.

This container is always returned if one or more offers associated with the inventory item group have been published. For inventory item groups that have yet to have any published offers, this container is only returned if set. items: - $ref: "#/components/schemas/Specification" - description: "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." + $ref: '#/components/schemas/Specification' + description: 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. Version: - type: "object" + type: object properties: instance: - description: "The instance of the version." - $ref: "#/components/schemas/Version" + description: The instance of the version. + $ref: '#/components/schemas/Version' version: - type: "string" - description: "The version number of the service or API." - description: "This type is used to show the version number and instance of the\ - \ service or API." + type: string + description: The version number of the service or API. + description: This type is used to show the version number and instance of the service or API. Weight: - type: "object" + type: object properties: unit: - type: "string" - description: "The unit of measurement used to specify the weight of a shipping\ - \ package. Both the unit and value fields\ - \ are required if the weight container is used. If the\ - \ English system of measurement is being used, the applicable values for\ - \ weight units are POUND and OUNCE. If the metric\ - \ system of measurement is being used, the applicable values for weight\ - \ units are KILOGRAM and GRAM. The metric system\ - \ is used by most countries outside of the US. For implementation help,\ - \ refer to eBay\ - \ API documentation" + type: string + description: The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are POUND and OUNCE. If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM and GRAM. The metric system is used by most countries outside of the US. For implementation help, refer to eBay API documentation value: - type: "number" - description: "The actual weight (in the measurement unit specified in the\ - \ unit field) of the shipping package. Both the unit\ - \ and value fields are required if the weight\ - \ container is used. If a shipping package weighed 20.5 ounces, the container\ - \ would look as follows: 
\"weight\": {
 \"value\": 20.5,
\
-            \ \"unit\": \"OUNCE\"
 }
" - description: "This type is used to specify the weight (and the unit used to\ - \ measure that weight) of a shipping package. The weight\ - \ container is conditionally required if the seller will be offering calculated\ - \ shipping rates to determine shipping cost, or is using flat-rate costs,\ - \ but charging a weight surcharge. See the Calculated shipping help page for more information\ - \ on calculated shipping." + type: number + description: 'The actual weight (in the measurement unit specified in the unit field) of the shipping package. Both the unit and value fields are required if the weight container is used. If a shipping package weighed 20.5 ounces, the container would look as follows: 
"weight": {
 "value": 20.5,
 "unit": "OUNCE"
 }
' + description: This type is used to specify the weight (and the unit used to measure that weight) of a shipping package. The weight container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost, or is using flat-rate costs, but charging a weight surcharge. See the Calculated shipping help page for more information on calculated shipping. WithdrawByInventoryItemGroupRequest: - type: "object" + type: object properties: inventoryItemGroupKey: - type: "string" - description: "This is the unique identifier of the inventory item group.\ - \ This identifier is automatically generated by eBay once an inventory\ - \ item group is created. This field is required." + type: string + description: This is the unique identifier of the inventory item group. This identifier is automatically generated by eBay once an inventory item group is created. This field is required. marketplaceId: - type: "string" - description: "This is the unique identifier of the eBay site for which the\ - \ offer will be made available. The marketPlaceId enumeration values are\ - \ found in MarketplaceIdEnum. This field is required. For implementation\ - \ help, refer to eBay\ - \ API documentation" - description: "This type is used by the base request of the WithdrawByInventoryItemGroup\ - \ method, which is used to end a multiple-variation listing." + type: string + description: This is the unique identifier of the eBay site for which the offer will be made available. The marketPlaceId enumeration values are found in MarketplaceIdEnum. This field is required. For implementation help, refer to eBay API documentation + description: This type is used by the base request of the WithdrawByInventoryItemGroup method, which is used to end a multiple-variation listing. WithdrawResponse: - type: "object" + type: object properties: listingId: - type: "string" - description: "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." + type: string + description: 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. warnings: - type: "array" - description: "This container will be returned if there were one or more\ - \ warnings associated with the attempt to withdraw the offer." + type: array + description: This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer. items: - $ref: "#/components/schemas/Error" - description: "The base response of the withdrawOffer call." + $ref: '#/components/schemas/Error' + description: The base response of the withdrawOffer call. securitySchemes: api_auth: - type: "oauth2" - description: "The security definitions for this API. Please check individual\ - \ operations for applicable scopes." + type: oauth2 + description: The security definitions for this API. Please check individual operations for applicable scopes. flows: authorizationCode: - authorizationUrl: "https://auth.ebay.com/oauth2/authorize" - tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token" + authorizationUrl: https://auth.ebay.com/oauth2/authorize + tokenUrl: https://api.ebay.com/identity/v1/oauth2/token 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" + 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 diff --git a/api-specs/sell_marketing_v1_oas3.yaml b/api-specs/sell_marketing_v1_oas3.yaml index 8c2101aa..09e12bf3 100644 --- a/api-specs/sell_marketing_v1_oas3.yaml +++ b/api-specs/sell_marketing_v1_oas3.yaml @@ -7,7 +7,7 @@ info: license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement - version: v1.13.0 + version: v1.14.0 servers: - url: https://api.ebay.com{basePath} description: Production @@ -291,7 +291,7 @@ paths: category: BUSINESS description: You have exceeded the maximum number of ads supported in a ad group with this request. Only {maxItemsLimit} ads are allowed per ad group. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -604,7 +604,7 @@ paths: '404': description: Not Found '409': - description: Business error + description: Conflict x-response-codes: errors: '35061': @@ -779,7 +779,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -797,7 +797,7 @@ paths: post: tags: - ad - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method works with listings created with either the Trading API or the Inventory API.

This method updates the status of ads in bulk.

Specify the campaign_id you want to update as a URI parameter, and configure the adGroupStatus in the request payload. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method works with listings created with either the Trading API or the Inventory API.

This method updates the status of ads in bulk.

Specify the campaign_id you want to update as a URI parameter, and configure the adGroupStatus in the request payload. operationId: bulkUpdateAdsStatus parameters: - name: campaign_id @@ -908,7 +908,7 @@ paths: post: tags: - ad - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method works with listings created with either the Trading API or the Inventory API.

The method updates the status of ads in bulk, based on listing ID values.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their updated adStatus values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to retrieve a list of seller inventory reference IDs. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method works with listings created with either the Trading API or the Inventory API.

The method updates the status of ads in bulk, based on listing ID values.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their updated adStatus values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to retrieve a list of seller inventory reference IDs. operationId: bulkUpdateAdsStatusByListingId parameters: - name: campaign_id @@ -1037,7 +1037,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1148,7 +1148,7 @@ paths: category: BUSINESS description: To use promoted listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1387,7 +1387,7 @@ paths: '404': description: Not Found '409': - description: Business error + description: Conflict x-response-codes: errors: '35061': @@ -1480,7 +1480,7 @@ paths: '409': description: Business error '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1567,7 +1567,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1753,7 +1753,7 @@ paths: category: BUSINESS description: To use promoted listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1873,7 +1873,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1891,7 +1891,7 @@ paths: get: tags: - ad_group - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method retrieves ad groups for the specified campaigns.

Each campaign can only have one ad group.

In the request, supply the campaign_ids as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method retrieves ad groups for the specified campaigns.

Each campaign can only have one ad group.

In the request, supply the campaign_ids as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller. operationId: getAdGroups parameters: - name: ad_group_status @@ -1946,7 +1946,7 @@ paths: '409': description: Business error '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -1964,7 +1964,7 @@ paths: post: tags: - ad_group - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method adds an ad group to an existing PLA campaign that uses the Cost Per Click (CPC) funding model.

To create an ad group for a campaign, specify the defaultBid for the ad group in the payload of the request. Then specify the campaign to which the ad group should be associated using the campaign_id path parameter.

Each campaign can have one or more associated ad groups. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds an ad group to an existing PLA campaign that uses the Cost Per Click (CPC) funding model.

To create an ad group for a campaign, specify the defaultBid for the ad group in the payload of the request. Then specify the campaign to which the ad group should be associated using the campaign_id path parameter.

Each campaign can have one or more associated ad groups. operationId: createAdGroup parameters: - name: campaign_id @@ -2056,7 +2056,7 @@ paths: '404': description: Not Found '409': - description: Business error + description: Conflict x-response-codes: errors: '35089': @@ -2068,7 +2068,7 @@ paths: category: BUSINESS description: The campaign funding model should be CPC. Please check funding model for provided campaign id. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -2086,7 +2086,7 @@ paths: get: tags: - ad_group - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method retrieves the details of a specified ad group, such as the ad group’s default bid and status.

In the request, specify the campaign_id and ad_group_id as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller and call getAdGroups for the ad group ID of the ad group you wish to retrieve. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method retrieves the details of a specified ad group, such as the ad group’s default bid and status.

In the request, specify the campaign_id and ad_group_id as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller and call getAdGroups for the ad group ID of the ad group you wish to retrieve. operationId: getAdGroup parameters: - name: ad_group_id @@ -2149,7 +2149,7 @@ paths: put: tags: - ad_group - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method updates the ad group associated with a campaign.

With this method, you can modify the default bid for the ad group, change the state of the ad group, or change the name of the ad group. Pass the ad_group_id you want to update as a URI parameter, and configure the adGroupStatus and defaultBid in the request payload.

Call getAdGroup to retrieve the current default bid and status of the ad group that you would like to update. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method updates the ad group associated with a campaign.

With this method, you can modify the default bid for the ad group, change the state of the ad group, or change the name of the ad group. Pass the ad_group_id you want to update as a URI parameter, and configure the adGroupStatus and defaultBid in the request payload.

Call getAdGroup to retrieve the current default bid and status of the ad group that you would like to update. operationId: updateAdGroup parameters: - name: ad_group_id @@ -2254,7 +2254,7 @@ paths: category: BUSINESS description: The campaign funding model should be CPC. Please check funding model for provided campaign id. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -2272,7 +2272,7 @@ paths: post: tags: - ad_group - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method allows sellers to retrieve the suggested bids for input keywords and match type. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method allows sellers to retrieve the suggested bids for input keywords and match type. operationId: suggestBids parameters: - name: ad_group_id @@ -2353,7 +2353,7 @@ paths: category: BUSINESS description: The keywordText {keywordText} cannot have total number of words more than {maxWordsInKeyword} words '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -2367,7 +2367,7 @@ paths: post: tags: - ad_group - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns. operationId: suggestKeywords parameters: - name: ad_group_id @@ -2452,7 +2452,7 @@ paths: category: BUSINESS description: You have exceeded the maximum number of listing Ids. Only {maxSupportedNumber} listings are supported per call. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -2984,7 +2984,7 @@ paths: category: BUSINESS description: '''marketplaceId'' {marketPlaceId} is not supported. Promoted Listings with CPC funding model is supported only on these marketplaces: {supportedMarketplaces}.' '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3092,7 +3092,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3296,7 +3296,7 @@ paths: '409': description: Business error '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3370,7 +3370,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3443,7 +3443,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3461,7 +3461,7 @@ paths: get: tags: - campaign - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method allows sellers to obtain ideas for listings, which can be targeted for Promoted Listings campaigns. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method allows sellers to obtain ideas for listings, which can be targeted for Promoted Listings campaigns. operationId: suggestItems parameters: - name: campaign_id @@ -3526,7 +3526,7 @@ paths: '404': description: Not Found '409': - description: Conflict + description: Business error x-response-codes: errors: '35051': @@ -3665,7 +3665,7 @@ paths: post: tags: - campaign - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method updates the daily budget for a PLA campaign that uses the Cost Per Click (CPC) funding model.

A click occurs when an eBay user finds and clicks on the seller’s listing (within the search results) after using a keyword that the seller has created for the campaign. For each ad in an ad group in the campaign, each click triggers a cost, which gets subtracted from the campaign’s daily budget. If the cost of the clicks exceeds the daily budget, the Promoted Listings campaign will be paused until the next day.

Specify the campaign_id as a path parameter. You can retrieve the campaign IDs for a seller by calling the getCampaigns method. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method updates the daily budget for a PLA campaign that uses the Cost Per Click (CPC) funding model.

A click occurs when an eBay user finds and clicks on the seller’s listing (within the search results) after using a keyword that the seller has created for the campaign. For each ad in an ad group in the campaign, each click triggers a cost, which gets subtracted from the campaign’s daily budget. If the cost of the clicks exceeds the daily budget, the Promoted Listings campaign will be paused until the next day.

Specify the campaign_id as a path parameter. You can retrieve the campaign IDs for a seller by calling the getCampaigns method. operationId: updateCampaignBudget parameters: - name: campaign_id @@ -3744,7 +3744,7 @@ paths: category: BUSINESS description: The daily budget value format {dailyBudgetValue} cannot have more than 2 decimal places. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3825,7 +3825,7 @@ paths: '404': description: Not Found '409': - description: Business error + description: Conflict x-response-codes: errors: '35055': @@ -3853,7 +3853,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -3871,7 +3871,7 @@ paths: post: tags: - keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method adds keywords, in bulk, to an existing PLA ad group in a campaign that uses the Cost Per Click (CPC) funding model.

This method also sets the CPC rate for each keyword.

In the request, supply the campaign_id as a path parameter.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds keywords, in bulk, to an existing PLA ad group in a campaign that uses the Cost Per Click (CPC) funding model.

This method also sets the CPC rate for each keyword.

In the request, supply the campaign_id as a path parameter.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. operationId: bulkCreateKeyword parameters: - name: campaign_id @@ -3996,7 +3996,7 @@ paths: category: BUSINESS description: Total keyword requests exceed the current AdGroup keyword capacity, which is {maxSupportedRequestNumber}. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4014,7 +4014,7 @@ paths: post: tags: - keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method updates the bids and statuses of keywords, in bulk, for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method updates the bids and statuses of keywords, in bulk, for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. operationId: bulkUpdateKeyword parameters: - name: campaign_id @@ -4099,7 +4099,7 @@ paths: category: BUSINESS description: You have exceeded the maximum number of Keyword requests in a bulk. Only {maxSupportedNumberInBulk} Ids are supported per call. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4117,7 +4117,7 @@ paths: get: tags: - keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method can be used to retrieve all of the keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id as a path parameter. If one or more ad_group_ids are passed in the request body, the keywords for those ad groups will be returned. If ad_group_ids are not passed in the response body, the call will return all the keywords in the campaign.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method can be used to retrieve all of the keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id as a path parameter. If one or more ad_group_ids are passed in the request body, the keywords for those ad groups will be returned. If ad_group_ids are not passed in the response body, the call will return all the keywords in the campaign.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller. operationId: getKeywords parameters: - name: ad_group_ids @@ -4182,7 +4182,7 @@ paths: '409': description: Business error '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4200,7 +4200,7 @@ paths: post: tags: - keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method creates keywords using a specified campaign ID for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the suggestKeywords method to retrieve a list of keyword ideas to be targeted for PLA campaigns, and call the getCampaigns method to retrieve a list of current campaign IDs for a seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method creates keywords using a specified campaign ID for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the suggestKeywords method to retrieve a list of keyword ideas to be targeted for PLA campaigns, and call the getCampaigns method to retrieve a list of current campaign IDs for a seller. operationId: createKeyword parameters: - name: campaign_id @@ -4296,7 +4296,7 @@ paths: '404': description: Not Found '409': - description: Business error + description: Conflict x-response-codes: errors: '35089': @@ -4312,7 +4312,7 @@ paths: category: BUSINESS description: The keywordText {keywordText} cannot have total number of words more than {maxWordsInKeyword} words. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4330,7 +4330,7 @@ paths: get: tags: - keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method retrieves details on a specific keyword from an ad group within a PLA campaign that uses the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method retrieves details on a specific keyword from an ad group within a PLA campaign that uses the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs. operationId: getKeyword parameters: - name: campaign_id @@ -4387,7 +4387,7 @@ paths: put: tags: - keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method updates keywords using a campaign ID and keyword ID for an existing PLA campaign.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method updates keywords using a campaign ID and keyword ID for an existing PLA campaign.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs. operationId: updateKeyword parameters: - name: campaign_id @@ -4490,7 +4490,7 @@ paths: post: tags: - negative_keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method adds negative keywords, in bulk, to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.

Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds negative keywords, in bulk, to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.

Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. operationId: bulkCreateNegativeKeyword requestBody: description: A type that defines the fields for the bulk request to create negative keywords. @@ -4596,7 +4596,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4610,7 +4610,7 @@ paths: post: tags: - negative_keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method updates the statuses of existing negative keywords, in bulk.

Specify the negativeKeywordId and negativeKeywordStatus in the request body. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method updates the statuses of existing negative keywords, in bulk.

Specify the negativeKeywordId and negativeKeywordStatus in the request body. operationId: bulkUpdateNegativeKeyword requestBody: description: A type that defines the fields for the bulk request to update negative keyword statuses. @@ -4672,7 +4672,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4686,7 +4686,7 @@ paths: get: tags: - negative_keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method can be used to retrieve all of the negative keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

The results can be filtered using the campaign_ids, ad_group_ids, and negative_keyword_status query parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method can be used to retrieve all of the negative keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

The results can be filtered using the campaign_ids, ad_group_ids, and negative_keyword_status query parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller. operationId: getNegativeKeywords parameters: - name: ad_group_ids @@ -4763,7 +4763,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4777,7 +4777,7 @@ paths: post: tags: - negative_keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method adds a negative keyword to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.

Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds a negative keyword to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.

Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.

Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller. operationId: createNegativeKeyword requestBody: description: A type that defines the fields for the request to create a negative keyword. @@ -4884,7 +4884,7 @@ paths: get: tags: - negative_keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method retrieves details on a specific negative keyword.

In the request, specify the negative_keyword_id as a path parameter. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method retrieves details on a specific negative keyword.

In the request, specify the negative_keyword_id as a path parameter. operationId: getNegativeKeyword parameters: - name: negative_keyword_id @@ -4921,7 +4921,7 @@ paths: category: BUSINESS description: We are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -4935,7 +4935,7 @@ paths: put: tags: - negative_keyword - description: Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method updates the status of an existing negative keyword.

Specify the negative_keyword_id as a path parameter, and specify the negativeKeywordStatus in the request body. + description: Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method updates the status of an existing negative keyword.

Specify the negative_keyword_id as a path parameter, and specify the negativeKeywordStatus in the request body. operationId: updateNegativeKeyword parameters: - name: negative_keyword_id @@ -5025,7 +5025,7 @@ paths: '404': description: Not Found '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -5098,7 +5098,7 @@ paths: '404': description: Not Found '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -5170,7 +5170,7 @@ paths: post: tags: - ad_report_task - description: This method creates a report task, which generates a Promoted Listings report based on the values specified in the call.

The report is generated based on the criteria you specify, including the report type, the report's dimensions and metrics, the report's start and end dates, the listings to include in the report, and more. Metrics are the quantitative measurements in the report while dimensions specify the attributes of the data included in the reports.

When creating a report task, you can specify the items you want included in the report. The items you specify, using either listingId or inventoryReference values, must be in a Promoted Listings campaign for them to be included in the report.

For details on the required and optional fields for each report type, see Promoted Listings reporting.

This call returns the URL to the report task in the Location response header, and the URL includes the report-task ID.

Reports often take time to generate and it's common for this call to return an HTTP status of 202, which indicates the report is being generated. Call getReportTasks (or getReportTask with the report-task ID) to determine the status of a Promoted Listings report. When a report is complete, eBay sets its status to SUCCESS and you can download it using the URL returned in the reportHref field of the getReportTask call. Report files are tab-separated value gzip files with a file extension of .tsv.gz.

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.

Note: This call fails if you don't submit all the required fields for the specified report type. Fields not supported by the specified report type are ignored. Call getReportMetadata to retrieve a list of the fields you need to configure for each Promoted Listings report type. + description: Note: Using multiple funding models in one report is deprecated. If multiple funding models are used, a Warning will be returned in a header. This functionality will be decommissioned on April 3, 2023. See API Deprecation Status for details.

This method creates a report task, which generates a Promoted Listings report based on the values specified in the call.

The report is generated based on the criteria you specify, including the report type, the report's dimensions and metrics, the report's start and end dates, the listings to include in the report, and more. Metrics are the quantitative measurements in the report while dimensions specify the attributes of the data included in the reports.

When creating a report task, you can specify the items you want included in the report. The items you specify, using either listingId or inventoryReference values, must be in a Promoted Listings campaign for them to be included in the report.

For details on the required and optional fields for each report type, see Promoted Listings reporting.

This call returns the URL to the report task in the Location response header, and the URL includes the report-task ID.

Reports often take time to generate and it's common for this call to return an HTTP status of 202, which indicates the report is being generated. Call getReportTasks (or getReportTask with the report-task ID) to determine the status of a Promoted Listings report. When a report is complete, eBay sets its status to SUCCESS and you can download it using the URL returned in the reportHref field of the getReportTask call. Report files are tab-separated value gzip files with a file extension of .tsv.gz.

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.

Note: This call fails if you don't submit all the required fields for the specified report type. Fields not supported by the specified report type are ignored. Call getReportMetadata to retrieve a list of the fields you need to configure for each Promoted Listings report type. operationId: createReportTask requestBody: description: The container for the fields that define the report task. @@ -5279,6 +5279,10 @@ paths: domain: API_MARKETING category: REQUEST description: The metric key is not supported for the funding model. + '35123': + domain: API_MARKETING + category: REQUEST + description: The 'dimensionKey' {dimensionKey} is not valid for the 'fundingModel' {fundingModel} '403': description: Forbidden x-response-codes: @@ -5312,7 +5316,7 @@ paths: category: BUSINESS description: The maximum number {maxSupportedInventoryReferences} of inventory references has been exceeded. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -5353,7 +5357,7 @@ paths: '404': description: Not found '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -5397,7 +5401,7 @@ paths: category: BUSINESS description: The Report Task with 'report_task_id' {report_task_id} is being modified. Please wait a few minutes and try the call again. '500': - description: Internal Server Error + description: Internal Server error x-response-codes: errors: '35001': @@ -5612,7 +5616,7 @@ paths: category: REQUEST description: You cannot specify a child Store Category ID when the parent Store Category ID is already specified. Please refer to the API documentation to source allowed values. '409': - description: Business error + description: Business Error x-response-codes: errors: '38248': @@ -5929,7 +5933,7 @@ paths: '404': description: Not Found '409': - description: Business error + description: Business Error x-response-codes: errors: '38248': @@ -6344,7 +6348,7 @@ paths: category: REQUEST description: The 'discountBenefit' value cannot exceed the 'maxDiscountAmount' value. '409': - description: Business error + description: Business Error x-response-codes: errors: '38243': @@ -8140,7 +8144,7 @@ components: description: Input the keyword into this field. matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation description: A type that defines the fields for the CreateKeyword request. CreateNegativeKeywordRequest: type: object @@ -8185,7 +8189,7 @@ components: $ref: '#/components/schemas/Dimension' fundingModels: type: array - description: The funding model for the campaign that shall be included in the report.

Note: The default funding model for Promoted Listings reports is COST_PER_SALE.

Valid Values:
  • COST_PER_SALE
  • COST_PER_CLICK
Required if the campaign funding model is Cost Per Click (CPC). + description: The funding model for the campaign that shall be included in the report.

Note: The default funding model for Promoted Listings reports is COST_PER_SALE.

Note: Multiple value support for the fundingModels array has been deprecated. See API Deprecation Status for information.

Valid Values:
  • COST_PER_SALE
  • COST_PER_CLICK
Required if the campaign funding model is Cost Per Click (CPC). items: type: string description: ' For implementation help, refer to eBay API documentation' @@ -8699,7 +8703,7 @@ components: description: The text of the keyword. matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation description: A type that contains the details for keywords that are associated with an ad group.

Note: This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model. KeywordPagedCollectionResponse: type: object @@ -8739,7 +8743,7 @@ components: description: 'The text of the keyword. Keywords are not case sensitive and compound words can be used without additional encoding (for example, tennis ball).

Maximum number of characters: 100

Maximum number of words: 10 ' matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation description: A type that defines the fields used by the Keyword method. KeywordResponse: type: object @@ -8763,7 +8767,7 @@ components: description: The text of the keyword. matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation statusCode: type: integer description: An HTTP status code is returned for each keyword to indicate the success or failure of adding that keyword to the ad group. @@ -8783,7 +8787,7 @@ components: description: The seller's inventory reference ID for a listing. Also known as the "SKU" or "custom label," an inventory reference ID is either the ID of the listing or, if the listing has variations (such as a shirt that's available in multiple sizes and colors), the ID of the parent listing. inventoryReferenceType: type: string - description: Indicates the type of the inventoryReferenceId, which can be either an individual item or a multi-SKU item (INVENTORY_ITEM and INVENTORY_ITEM_GROUP, respectively).

Note: This value is not currently returned in the response. + description: Indicates the type of the inventoryReferenceId, which can be either a single-SKU or a multi-SKU listing (INVENTORY_ITEM and INVENTORY_ITEM_GROUP, respectively).

Note: This value is not currently returned in the response. listingCategoryId: type: string description: The ID of the category that listing belongs to. The ID is a numeric and unique identifier for the category that is assigned by eBay. @@ -9280,7 +9284,7 @@ components: type: string categoryScope: type: string - description: The enumeration values returned in this field indicate if the category IDs in the corresponding categoryIds array are identifiers for eBay categories or for a seller's eBay store categories. This field is always returned if one or more category IDs are used as a filter. For implementation help, refer to eBay API documentation + description: The enumeration values returned in this field indicate if the category IDs in the corresponding categoryIds array are identifiers for eBay categories or for a seller's eBay store categories. This field is always returned if one or more category IDs are used as a filter. For implementation help, refer to eBay API documentation listingConditionIds: type: array description: A comma-separated list of unique identifiers for the conditions of listings to be included in the campaign. Up to four IDs can be specified.

This array is only returned if one or more item condition values are used as a filter.

Note: Multiple listing condition IDs are mapped to the four valid values listed below. Refer to Promoted Listings Standard campaign flow for more details.

Valid Values:
  • 1000 = New
  • 2000 = Certified Refurbished
  • 2500 = Seller Refurbished
  • 3000 = Used
@@ -9301,7 +9305,7 @@ components: description: The text for the keyword. matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation proposedBid: description: 'The suggested bid associated with the keyword. ' $ref: '#/components/schemas/ProposedBid' @@ -9319,7 +9323,7 @@ components: description: The text for the keyword. matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation description: The suggested keywords for the item. SummaryReportResponse: type: object @@ -9410,7 +9414,7 @@ components: type: string matchType: type: string - description: A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation + description: A field that defines the match type for the keyword.

Valid Values:
  • BROAD
  • EXACT
  • PHRASE
For implementation help, refer to eBay API documentation description: A type that provides details for the targeted keywords. TargetedKeywordsPagedCollection: type: object diff --git a/composer.json b/composer.json index b3bfa2cd..6f19d4f1 100644 --- a/composer.json +++ b/composer.json @@ -40,11 +40,11 @@ "analyze:stats": "composer run-script analyze -- --stats", "lint:phpcs:check": [ "Composer\\Config::disableProcessTimeout", - "phpcs --cache=.phpcs.cache --parallel=2 ./" + "phpcs --cache=.phpcs.cache --parallel=8 ./" ], "lint:phpcs:fix": [ "Composer\\Config::disableProcessTimeout", - "phpcbf --parallel=2 ./" + "phpcbf --parallel=8 ./" ], "lint:phpmd": "phpmd ./ text ./phpmd.dist.xml", "lint:php-cs-fixer:fix": [ diff --git a/generate.sh b/generate.sh index 27758970..ef9afae4 100644 --- a/generate.sh +++ b/generate.sh @@ -35,7 +35,7 @@ BASE_PACKAGE_DIR="./src" BASE_INVOKER_PACKAGE="TNT\\Ebay" BASE_PACKAGE_NAME="ebay" GITHUB_NAME="brandon14" -SDK_VERSION=0.2.1 +SDK_VERSION=0.2.2 SDK_USER_AGENT="$GITHUB_NAME/ebay-sdk-php/$SDK_VERSION/php" # Set JOB_MAX default if not supplied. diff --git a/src/Buy/Browse/V1/Api/ItemApi.php b/src/Buy/Browse/V1/Api/ItemApi.php index a5fd400d..6b24bc2e 100644 --- a/src/Buy/Browse/V1/Api/ItemApi.php +++ b/src/Buy/Browse/V1/Api/ItemApi.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Api/ItemSummaryApi.php b/src/Buy/Browse/V1/Api/ItemSummaryApi.php index d6005abb..eb5e7a3d 100644 --- a/src/Buy/Browse/V1/Api/ItemSummaryApi.php +++ b/src/Buy/Browse/V1/Api/ItemSummaryApi.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ @@ -152,7 +152,7 @@ public function getConfiguration() /** * Operation search. * - * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) + * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspect pairs and the category, which is returned in the <b>dominantCategoryId</b> field, set <b>fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><span class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter. <br /><br />The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:<br /><br /><code>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü|Nike}</code></span><br /><br /><b>Required:</b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) * @param string $auto_correct A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> (optional) * @param string $category_ids <a name=\"category_ids\"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class=\"tablenote\"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html \" target=\"_blank\">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class=\"tablenote\"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) (optional) * @param string $charity_ids The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\". <ul><li>To find the charities eBay supports, you can search for a charity at <a href=\"https://charity.ebay.com/search \" target=\"_blank\">Charity Search </a> or go to <a href=\"https://www.ebay.com/b/Charity/bn_7114598164 \" target=\"_blank\">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"_blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID (optional) @@ -181,7 +181,7 @@ public function search($aspect_filter = null, $auto_correct = null, $category_id /** * Operation searchWithHttpInfo. * - * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) + * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspect pairs and the category, which is returned in the <b>dominantCategoryId</b> field, set <b>fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><span class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter. <br /><br />The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:<br /><br /><code>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü|Nike}</code></span><br /><br /><b>Required:</b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) * @param string $auto_correct A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> (optional) * @param string $category_ids <a name=\"category_ids\"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class=\"tablenote\"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html \" target=\"_blank\">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class=\"tablenote\"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) (optional) * @param string $charity_ids The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\". <ul><li>To find the charities eBay supports, you can search for a charity at <a href=\"https://charity.ebay.com/search \" target=\"_blank\">Charity Search </a> or go to <a href=\"https://www.ebay.com/b/Charity/bn_7114598164 \" target=\"_blank\">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"_blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID (optional) @@ -270,7 +270,7 @@ public function searchWithHttpInfo($aspect_filter = null, $auto_correct = null, /** * Operation searchAsync. * - * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) + * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspect pairs and the category, which is returned in the <b>dominantCategoryId</b> field, set <b>fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><span class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter. <br /><br />The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:<br /><br /><code>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü|Nike}</code></span><br /><br /><b>Required:</b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) * @param string $auto_correct A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> (optional) * @param string $category_ids <a name=\"category_ids\"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class=\"tablenote\"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html \" target=\"_blank\">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class=\"tablenote\"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) (optional) * @param string $charity_ids The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\". <ul><li>To find the charities eBay supports, you can search for a charity at <a href=\"https://charity.ebay.com/search \" target=\"_blank\">Charity Search </a> or go to <a href=\"https://www.ebay.com/b/Charity/bn_7114598164 \" target=\"_blank\">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"_blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID (optional) @@ -301,7 +301,7 @@ function ($response) { /** * Operation searchAsyncWithHttpInfo. * - * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) + * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspect pairs and the category, which is returned in the <b>dominantCategoryId</b> field, set <b>fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><span class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter. <br /><br />The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:<br /><br /><code>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü|Nike}</code></span><br /><br /><b>Required:</b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) * @param string $auto_correct A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> (optional) * @param string $category_ids <a name=\"category_ids\"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class=\"tablenote\"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html \" target=\"_blank\">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class=\"tablenote\"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) (optional) * @param string $charity_ids The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\". <ul><li>To find the charities eBay supports, you can search for a charity at <a href=\"https://charity.ebay.com/search \" target=\"_blank\">Charity Search </a> or go to <a href=\"https://www.ebay.com/b/Charity/bn_7114598164 \" target=\"_blank\">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"_blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID (optional) @@ -352,7 +352,7 @@ function ($exception) { /** * Create request for operation 'search'. * - * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) + * @param string $aspect_filter This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspect pairs and the category, which is returned in the <b>dominantCategoryId</b> field, set <b>fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><span class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter. <br /><br />The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:<br /><br /><code>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü|Nike}</code></span><br /><br /><b>Required:</b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter (optional) * @param string $auto_correct A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> (optional) * @param string $category_ids <a name=\"category_ids\"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class=\"tablenote\"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html \" target=\"_blank\">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class=\"tablenote\"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) (optional) * @param string $charity_ids The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\". <ul><li>To find the charities eBay supports, you can search for a charity at <a href=\"https://charity.ebay.com/search \" target=\"_blank\">Charity Search </a> or go to <a href=\"https://www.ebay.com/b/Charity/bn_7114598164 \" target=\"_blank\">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"_blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID (optional) diff --git a/src/Buy/Browse/V1/Api/SearchByImageApi.php b/src/Buy/Browse/V1/Api/SearchByImageApi.php index 8a06f662..ecc9b67d 100644 --- a/src/Buy/Browse/V1/Api/SearchByImageApi.php +++ b/src/Buy/Browse/V1/Api/SearchByImageApi.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Api/ShoppingCartApi.php b/src/Buy/Browse/V1/Api/ShoppingCartApi.php index 2de387bc..b8218499 100644 --- a/src/Buy/Browse/V1/Api/ShoppingCartApi.php +++ b/src/Buy/Browse/V1/Api/ShoppingCartApi.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/ApiException.php b/src/Buy/Browse/V1/ApiException.php index 668abf86..93782242 100644 --- a/src/Buy/Browse/V1/ApiException.php +++ b/src/Buy/Browse/V1/ApiException.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Configuration.php b/src/Buy/Browse/V1/Configuration.php index cbacedd6..cbb19f2e 100644 --- a/src/Buy/Browse/V1/Configuration.php +++ b/src/Buy/Browse/V1/Configuration.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). @@ -441,7 +441,7 @@ public static function toDebugReport() $report = 'PHP SDK (TNT\Ebay\Buy\Browse\V1) Debug Report:'.PHP_EOL; $report .= ' OS: '.php_uname().PHP_EOL; $report .= ' PHP Version: '.PHP_VERSION.PHP_EOL; - $report .= ' The version of the OpenAPI document: v1.16.0'.PHP_EOL; + $report .= ' The version of the OpenAPI document: v1.18.0'.PHP_EOL; $report .= ' Temp Folder Path: '.self::getDefaultConfiguration()->getTempFolderPath().PHP_EOL; return $report; diff --git a/src/Buy/Browse/V1/HeaderSelector.php b/src/Buy/Browse/V1/HeaderSelector.php index a9c7da09..fc768366 100644 --- a/src/Buy/Browse/V1/HeaderSelector.php +++ b/src/Buy/Browse/V1/HeaderSelector.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AddCartItemInput.php b/src/Buy/Browse/V1/Model/AddCartItemInput.php index 85d18f84..d85a5309 100644 --- a/src/Buy/Browse/V1/Model/AddCartItemInput.php +++ b/src/Buy/Browse/V1/Model/AddCartItemInput.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AdditionalProductIdentity.php b/src/Buy/Browse/V1/Model/AdditionalProductIdentity.php index 77b61351..d59768a0 100644 --- a/src/Buy/Browse/V1/Model/AdditionalProductIdentity.php +++ b/src/Buy/Browse/V1/Model/AdditionalProductIdentity.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AddonService.php b/src/Buy/Browse/V1/Model/AddonService.php index 03b9389e..11fd3104 100644 --- a/src/Buy/Browse/V1/Model/AddonService.php +++ b/src/Buy/Browse/V1/Model/AddonService.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Address.php b/src/Buy/Browse/V1/Model/Address.php index e56655c2..fbc8afce 100644 --- a/src/Buy/Browse/V1/Model/Address.php +++ b/src/Buy/Browse/V1/Model/Address.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Amount.php b/src/Buy/Browse/V1/Model/Amount.php index 4ab44439..50abe548 100644 --- a/src/Buy/Browse/V1/Model/Amount.php +++ b/src/Buy/Browse/V1/Model/Amount.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Aspect.php b/src/Buy/Browse/V1/Model/Aspect.php index dcfc4752..389cb498 100644 --- a/src/Buy/Browse/V1/Model/Aspect.php +++ b/src/Buy/Browse/V1/Model/Aspect.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AspectDistribution.php b/src/Buy/Browse/V1/Model/AspectDistribution.php index cd56b5ff..3b11ff49 100644 --- a/src/Buy/Browse/V1/Model/AspectDistribution.php +++ b/src/Buy/Browse/V1/Model/AspectDistribution.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AspectGroup.php b/src/Buy/Browse/V1/Model/AspectGroup.php index 52810b88..2106bf44 100644 --- a/src/Buy/Browse/V1/Model/AspectGroup.php +++ b/src/Buy/Browse/V1/Model/AspectGroup.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AspectValueDistribution.php b/src/Buy/Browse/V1/Model/AspectValueDistribution.php index 33afc39f..36c1a097 100644 --- a/src/Buy/Browse/V1/Model/AspectValueDistribution.php +++ b/src/Buy/Browse/V1/Model/AspectValueDistribution.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AttributeNameValue.php b/src/Buy/Browse/V1/Model/AttributeNameValue.php index f3d9d787..785e4f15 100644 --- a/src/Buy/Browse/V1/Model/AttributeNameValue.php +++ b/src/Buy/Browse/V1/Model/AttributeNameValue.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AuthenticityGuaranteeProgram.php b/src/Buy/Browse/V1/Model/AuthenticityGuaranteeProgram.php index 204ba431..d22a6106 100644 --- a/src/Buy/Browse/V1/Model/AuthenticityGuaranteeProgram.php +++ b/src/Buy/Browse/V1/Model/AuthenticityGuaranteeProgram.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AuthenticityVerificationProgram.php b/src/Buy/Browse/V1/Model/AuthenticityVerificationProgram.php index fa4e21ef..f03d45de 100644 --- a/src/Buy/Browse/V1/Model/AuthenticityVerificationProgram.php +++ b/src/Buy/Browse/V1/Model/AuthenticityVerificationProgram.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AutoCorrections.php b/src/Buy/Browse/V1/Model/AutoCorrections.php index 135eed4c..7d69f4a4 100644 --- a/src/Buy/Browse/V1/Model/AutoCorrections.php +++ b/src/Buy/Browse/V1/Model/AutoCorrections.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/AvailableCoupon.php b/src/Buy/Browse/V1/Model/AvailableCoupon.php index 5715018e..e3988686 100644 --- a/src/Buy/Browse/V1/Model/AvailableCoupon.php +++ b/src/Buy/Browse/V1/Model/AvailableCoupon.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/BuyingOptionDistribution.php b/src/Buy/Browse/V1/Model/BuyingOptionDistribution.php index 585c386e..7689c784 100644 --- a/src/Buy/Browse/V1/Model/BuyingOptionDistribution.php +++ b/src/Buy/Browse/V1/Model/BuyingOptionDistribution.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CartItem.php b/src/Buy/Browse/V1/Model/CartItem.php index 1c9dca47..bdeda716 100644 --- a/src/Buy/Browse/V1/Model/CartItem.php +++ b/src/Buy/Browse/V1/Model/CartItem.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Category.php b/src/Buy/Browse/V1/Model/Category.php index 966218d2..8aa7eb07 100644 --- a/src/Buy/Browse/V1/Model/Category.php +++ b/src/Buy/Browse/V1/Model/Category.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ @@ -66,7 +66,7 @@ * Category Class Doc Comment. * * @category Class - * @description This type is used by the <b> categories</b> container in the response of the <b> search</b> method, and contains the primary item category ID of the item, as well as the secondary item category if the item was listed in two categories. + * @description This type is used by the <b>categories</b> container in the response of the <b>search</b> method, and contains the name and ID of the item category. * * @author OpenAPI Generator team * @@ -93,6 +93,7 @@ class Category implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'category_id' => 'string', + 'category_name' => 'string', ]; /** @@ -104,6 +105,7 @@ class Category implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'category_id' => null, + 'category_name' => null, ]; /** @@ -134,6 +136,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'category_id' => 'categoryId', + 'category_name' => 'categoryName', ]; /** @@ -143,6 +146,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'category_id' => 'setCategoryId', + 'category_name' => 'setCategoryName', ]; /** @@ -152,6 +156,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'category_id' => 'getCategoryId', + 'category_name' => 'getCategoryName', ]; /** @@ -211,6 +216,7 @@ public function getModelName() public function __construct(array $data = null) { $this->container['category_id'] = $data['category_id'] ?? null; + $this->container['category_name'] = $data['category_name'] ?? null; } /** @@ -249,7 +255,7 @@ public function getCategoryId() /** * Sets category_id. * - * @param string|null $category_id the unique identifier of the primary item category of the item, as well as the secondary item category if item was listed in two categories + * @param string|null $category_id the unique identifier of the category * * @return self */ @@ -260,6 +266,30 @@ public function setCategoryId($category_id) return $this; } + /** + * Gets category_name. + * + * @return string|null + */ + public function getCategoryName() + { + return $this->container['category_name']; + } + + /** + * Sets category_name. + * + * @param string|null $category_name the name of the category + * + * @return self + */ + public function setCategoryName($category_name) + { + $this->container['category_name'] = $category_name; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/src/Buy/Browse/V1/Model/CategoryDistribution.php b/src/Buy/Browse/V1/Model/CategoryDistribution.php index 1dade2b6..dde1ed4d 100644 --- a/src/Buy/Browse/V1/Model/CategoryDistribution.php +++ b/src/Buy/Browse/V1/Model/CategoryDistribution.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CommonDescriptions.php b/src/Buy/Browse/V1/Model/CommonDescriptions.php index fb66f91b..401eaaeb 100644 --- a/src/Buy/Browse/V1/Model/CommonDescriptions.php +++ b/src/Buy/Browse/V1/Model/CommonDescriptions.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CompatibilityPayload.php b/src/Buy/Browse/V1/Model/CompatibilityPayload.php index 146fe766..7a2dc4e7 100644 --- a/src/Buy/Browse/V1/Model/CompatibilityPayload.php +++ b/src/Buy/Browse/V1/Model/CompatibilityPayload.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CompatibilityProperty.php b/src/Buy/Browse/V1/Model/CompatibilityProperty.php index bcd8df91..5421a795 100644 --- a/src/Buy/Browse/V1/Model/CompatibilityProperty.php +++ b/src/Buy/Browse/V1/Model/CompatibilityProperty.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CompatibilityResponse.php b/src/Buy/Browse/V1/Model/CompatibilityResponse.php index e61cd253..c013da46 100644 --- a/src/Buy/Browse/V1/Model/CompatibilityResponse.php +++ b/src/Buy/Browse/V1/Model/CompatibilityResponse.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ConditionDistribution.php b/src/Buy/Browse/V1/Model/ConditionDistribution.php index 7f102ca1..33546197 100644 --- a/src/Buy/Browse/V1/Model/ConditionDistribution.php +++ b/src/Buy/Browse/V1/Model/ConditionDistribution.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ConvertedAmount.php b/src/Buy/Browse/V1/Model/ConvertedAmount.php index f43fd3c3..74ef2375 100644 --- a/src/Buy/Browse/V1/Model/ConvertedAmount.php +++ b/src/Buy/Browse/V1/Model/ConvertedAmount.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CoreItem.php b/src/Buy/Browse/V1/Model/CoreItem.php index df1d93cd..89d9dc0f 100644 --- a/src/Buy/Browse/V1/Model/CoreItem.php +++ b/src/Buy/Browse/V1/Model/CoreItem.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/CouponConstraint.php b/src/Buy/Browse/V1/Model/CouponConstraint.php index e315e2d9..9be88402 100644 --- a/src/Buy/Browse/V1/Model/CouponConstraint.php +++ b/src/Buy/Browse/V1/Model/CouponConstraint.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Error.php b/src/Buy/Browse/V1/Model/Error.php index e93bb975..289168e5 100644 --- a/src/Buy/Browse/V1/Model/Error.php +++ b/src/Buy/Browse/V1/Model/Error.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ErrorParameter.php b/src/Buy/Browse/V1/Model/ErrorParameter.php index e0f7b9a1..747368c6 100644 --- a/src/Buy/Browse/V1/Model/ErrorParameter.php +++ b/src/Buy/Browse/V1/Model/ErrorParameter.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/EstimatedAvailability.php b/src/Buy/Browse/V1/Model/EstimatedAvailability.php index b557477b..cf3a057f 100644 --- a/src/Buy/Browse/V1/Model/EstimatedAvailability.php +++ b/src/Buy/Browse/V1/Model/EstimatedAvailability.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Image.php b/src/Buy/Browse/V1/Model/Image.php index 0b7799f4..ccf2be48 100644 --- a/src/Buy/Browse/V1/Model/Image.php +++ b/src/Buy/Browse/V1/Model/Image.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Item.php b/src/Buy/Browse/V1/Model/Item.php index 20da543b..b6b2fc9c 100644 --- a/src/Buy/Browse/V1/Model/Item.php +++ b/src/Buy/Browse/V1/Model/Item.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ItemGroup.php b/src/Buy/Browse/V1/Model/ItemGroup.php index ff78df7e..ce4a17af 100644 --- a/src/Buy/Browse/V1/Model/ItemGroup.php +++ b/src/Buy/Browse/V1/Model/ItemGroup.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ItemGroupSummary.php b/src/Buy/Browse/V1/Model/ItemGroupSummary.php index c8d673d4..b6fb591a 100644 --- a/src/Buy/Browse/V1/Model/ItemGroupSummary.php +++ b/src/Buy/Browse/V1/Model/ItemGroupSummary.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ItemLocationImpl.php b/src/Buy/Browse/V1/Model/ItemLocationImpl.php index 3a051453..5cf093c0 100644 --- a/src/Buy/Browse/V1/Model/ItemLocationImpl.php +++ b/src/Buy/Browse/V1/Model/ItemLocationImpl.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ItemReturnTerms.php b/src/Buy/Browse/V1/Model/ItemReturnTerms.php index b54713c5..f447f860 100644 --- a/src/Buy/Browse/V1/Model/ItemReturnTerms.php +++ b/src/Buy/Browse/V1/Model/ItemReturnTerms.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ItemSummary.php b/src/Buy/Browse/V1/Model/ItemSummary.php index 8b3260fd..9f4eceb2 100644 --- a/src/Buy/Browse/V1/Model/ItemSummary.php +++ b/src/Buy/Browse/V1/Model/ItemSummary.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ @@ -116,6 +116,7 @@ class ItemSummary implements ModelInterface, ArrayAccess, \JsonSerializable 'item_id' => 'string', 'item_location' => '\TNT\Ebay\Buy\Browse\V1\Model\ItemLocationImpl', 'item_web_url' => 'string', + 'leaf_category_ids' => 'string[]', 'legacy_item_id' => 'string', 'listing_marketplace_id' => 'string', 'marketing_price' => '\TNT\Ebay\Buy\Browse\V1\Model\MarketingPrice', @@ -168,6 +169,7 @@ class ItemSummary implements ModelInterface, ArrayAccess, \JsonSerializable 'item_id' => null, 'item_location' => null, 'item_web_url' => null, + 'leaf_category_ids' => null, 'legacy_item_id' => null, 'listing_marketplace_id' => null, 'marketing_price' => null, @@ -239,6 +241,7 @@ public static function openAPIFormats() 'item_id' => 'itemId', 'item_location' => 'itemLocation', 'item_web_url' => 'itemWebUrl', + 'leaf_category_ids' => 'leafCategoryIds', 'legacy_item_id' => 'legacyItemId', 'listing_marketplace_id' => 'listingMarketplaceId', 'marketing_price' => 'marketingPrice', @@ -289,6 +292,7 @@ public static function openAPIFormats() 'item_id' => 'setItemId', 'item_location' => 'setItemLocation', 'item_web_url' => 'setItemWebUrl', + 'leaf_category_ids' => 'setLeafCategoryIds', 'legacy_item_id' => 'setLegacyItemId', 'listing_marketplace_id' => 'setListingMarketplaceId', 'marketing_price' => 'setMarketingPrice', @@ -339,6 +343,7 @@ public static function openAPIFormats() 'item_id' => 'getItemId', 'item_location' => 'getItemLocation', 'item_web_url' => 'getItemWebUrl', + 'leaf_category_ids' => 'getLeafCategoryIds', 'legacy_item_id' => 'getLegacyItemId', 'listing_marketplace_id' => 'getListingMarketplaceId', 'marketing_price' => 'getMarketingPrice', @@ -439,6 +444,7 @@ public function __construct(array $data = null) $this->container['item_id'] = $data['item_id'] ?? null; $this->container['item_location'] = $data['item_location'] ?? null; $this->container['item_web_url'] = $data['item_web_url'] ?? null; + $this->container['leaf_category_ids'] = $data['leaf_category_ids'] ?? null; $this->container['legacy_item_id'] = $data['legacy_item_id'] ?? null; $this->container['listing_marketplace_id'] = $data['listing_marketplace_id'] ?? null; $this->container['marketing_price'] = $data['marketing_price'] ?? null; @@ -615,7 +621,7 @@ public function getCategories() /** * Sets categories. * - * @param \TNT\Ebay\Buy\Browse\V1\Model\Category[]|null $categories this container returns the primary category ID of the item (as well as the secondary category if the item was listed in two categories) + * @param \TNT\Ebay\Buy\Browse\V1\Model\Category[]|null $categories this array returns the name and ID of each category associated with the item, including top level, branch, and leaf categories * * @return self */ @@ -1058,6 +1064,30 @@ public function setItemWebUrl($item_web_url) return $this; } + /** + * Gets leaf_category_ids. + * + * @return string[]|null + */ + public function getLeafCategoryIds() + { + return $this->container['leaf_category_ids']; + } + + /** + * Sets leaf_category_ids. + * + * @param string[]|null $leaf_category_ids The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary. + * + * @return self + */ + public function setLeafCategoryIds($leaf_category_ids) + { + $this->container['leaf_category_ids'] = $leaf_category_ids; + + return $this; + } + /** * Gets legacy_item_id. * diff --git a/src/Buy/Browse/V1/Model/Items.php b/src/Buy/Browse/V1/Model/Items.php index 525c7555..f8f9c311 100644 --- a/src/Buy/Browse/V1/Model/Items.php +++ b/src/Buy/Browse/V1/Model/Items.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/LegalAddress.php b/src/Buy/Browse/V1/Model/LegalAddress.php index 53082b2c..f5ac4ad7 100644 --- a/src/Buy/Browse/V1/Model/LegalAddress.php +++ b/src/Buy/Browse/V1/Model/LegalAddress.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/MarketingPrice.php b/src/Buy/Browse/V1/Model/MarketingPrice.php index 360e5044..bbfa38a5 100644 --- a/src/Buy/Browse/V1/Model/MarketingPrice.php +++ b/src/Buy/Browse/V1/Model/MarketingPrice.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ModelInterface.php b/src/Buy/Browse/V1/Model/ModelInterface.php index 0ddc5943..4a3915a7 100644 --- a/src/Buy/Browse/V1/Model/ModelInterface.php +++ b/src/Buy/Browse/V1/Model/ModelInterface.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/PaymentMethod.php b/src/Buy/Browse/V1/Model/PaymentMethod.php index 3895ee01..fd1a9243 100644 --- a/src/Buy/Browse/V1/Model/PaymentMethod.php +++ b/src/Buy/Browse/V1/Model/PaymentMethod.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/PaymentMethodBrand.php b/src/Buy/Browse/V1/Model/PaymentMethodBrand.php index 689bfd08..a6109411 100644 --- a/src/Buy/Browse/V1/Model/PaymentMethodBrand.php +++ b/src/Buy/Browse/V1/Model/PaymentMethodBrand.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/PickupOptionSummary.php b/src/Buy/Browse/V1/Model/PickupOptionSummary.php index 8f54936b..39bbb1c3 100644 --- a/src/Buy/Browse/V1/Model/PickupOptionSummary.php +++ b/src/Buy/Browse/V1/Model/PickupOptionSummary.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Price.php b/src/Buy/Browse/V1/Model/Price.php index 3b8b7c61..2d73d1d5 100644 --- a/src/Buy/Browse/V1/Model/Price.php +++ b/src/Buy/Browse/V1/Model/Price.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Product.php b/src/Buy/Browse/V1/Model/Product.php index 2ecded20..65f510a5 100644 --- a/src/Buy/Browse/V1/Model/Product.php +++ b/src/Buy/Browse/V1/Model/Product.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ProductIdentity.php b/src/Buy/Browse/V1/Model/ProductIdentity.php index 801e1d58..da9d15d9 100644 --- a/src/Buy/Browse/V1/Model/ProductIdentity.php +++ b/src/Buy/Browse/V1/Model/ProductIdentity.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/RatingHistogram.php b/src/Buy/Browse/V1/Model/RatingHistogram.php index 6477d183..8b7b36cb 100644 --- a/src/Buy/Browse/V1/Model/RatingHistogram.php +++ b/src/Buy/Browse/V1/Model/RatingHistogram.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Refinement.php b/src/Buy/Browse/V1/Model/Refinement.php index 325f29b6..5df79a3d 100644 --- a/src/Buy/Browse/V1/Model/Refinement.php +++ b/src/Buy/Browse/V1/Model/Refinement.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Region.php b/src/Buy/Browse/V1/Model/Region.php index 2d7154e3..f69ace42 100644 --- a/src/Buy/Browse/V1/Model/Region.php +++ b/src/Buy/Browse/V1/Model/Region.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/RemoteShopcartResponse.php b/src/Buy/Browse/V1/Model/RemoteShopcartResponse.php index 86ceb7b9..9750effa 100644 --- a/src/Buy/Browse/V1/Model/RemoteShopcartResponse.php +++ b/src/Buy/Browse/V1/Model/RemoteShopcartResponse.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/RemoveCartItemInput.php b/src/Buy/Browse/V1/Model/RemoveCartItemInput.php index e81ffb5a..91ab8382 100644 --- a/src/Buy/Browse/V1/Model/RemoveCartItemInput.php +++ b/src/Buy/Browse/V1/Model/RemoveCartItemInput.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ReviewRating.php b/src/Buy/Browse/V1/Model/ReviewRating.php index 5648275c..18fbc38f 100644 --- a/src/Buy/Browse/V1/Model/ReviewRating.php +++ b/src/Buy/Browse/V1/Model/ReviewRating.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/SearchByImageRequest.php b/src/Buy/Browse/V1/Model/SearchByImageRequest.php index dc4d0bde..3447aff8 100644 --- a/src/Buy/Browse/V1/Model/SearchByImageRequest.php +++ b/src/Buy/Browse/V1/Model/SearchByImageRequest.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/SearchPagedCollection.php b/src/Buy/Browse/V1/Model/SearchPagedCollection.php index c44af0a0..0799c576 100644 --- a/src/Buy/Browse/V1/Model/SearchPagedCollection.php +++ b/src/Buy/Browse/V1/Model/SearchPagedCollection.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Seller.php b/src/Buy/Browse/V1/Model/Seller.php index 4c98774c..dc26023d 100644 --- a/src/Buy/Browse/V1/Model/Seller.php +++ b/src/Buy/Browse/V1/Model/Seller.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/SellerCustomPolicy.php b/src/Buy/Browse/V1/Model/SellerCustomPolicy.php index 1472c6d2..d725435d 100644 --- a/src/Buy/Browse/V1/Model/SellerCustomPolicy.php +++ b/src/Buy/Browse/V1/Model/SellerCustomPolicy.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/SellerDetail.php b/src/Buy/Browse/V1/Model/SellerDetail.php index 4e3761a6..520ebbe0 100644 --- a/src/Buy/Browse/V1/Model/SellerDetail.php +++ b/src/Buy/Browse/V1/Model/SellerDetail.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/SellerLegalInfo.php b/src/Buy/Browse/V1/Model/SellerLegalInfo.php index ab575e68..366f8953 100644 --- a/src/Buy/Browse/V1/Model/SellerLegalInfo.php +++ b/src/Buy/Browse/V1/Model/SellerLegalInfo.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ShipToLocation.php b/src/Buy/Browse/V1/Model/ShipToLocation.php index 2ff09c4d..0feca2cb 100644 --- a/src/Buy/Browse/V1/Model/ShipToLocation.php +++ b/src/Buy/Browse/V1/Model/ShipToLocation.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ShipToLocations.php b/src/Buy/Browse/V1/Model/ShipToLocations.php index 0f1f0203..67941247 100644 --- a/src/Buy/Browse/V1/Model/ShipToLocations.php +++ b/src/Buy/Browse/V1/Model/ShipToLocations.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ShipToRegion.php b/src/Buy/Browse/V1/Model/ShipToRegion.php index acb6bcaf..805f7fbd 100644 --- a/src/Buy/Browse/V1/Model/ShipToRegion.php +++ b/src/Buy/Browse/V1/Model/ShipToRegion.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/ShippingOption.php b/src/Buy/Browse/V1/Model/ShippingOption.php index fe8f3c56..b19b29bc 100644 --- a/src/Buy/Browse/V1/Model/ShippingOption.php +++ b/src/Buy/Browse/V1/Model/ShippingOption.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ @@ -381,7 +381,7 @@ public function getFulfilledThrough() /** * Sets fulfilled_through. * - * @param string|null $fulfilled_through If the item is being shipped by eBay's Global Shipping Program, this field returns GLOBAL_SHIPPING. Otherwise this field is null. For implementation help, refer to eBay API documentation + * @param string|null $fulfilled_through If the item is being shipped by the eBay Global Shipping program, this field returns GLOBAL_SHIPPING.

If the item is being shipped using the eBay International Shipping program, this field returns INTERNATIONAL_SHIPPING.

Otherwise, this field is null. For implementation help, refer to eBay API documentation * * @return self */ diff --git a/src/Buy/Browse/V1/Model/ShippingOptionSummary.php b/src/Buy/Browse/V1/Model/ShippingOptionSummary.php index ed7ad59b..f4baa4f8 100644 --- a/src/Buy/Browse/V1/Model/ShippingOptionSummary.php +++ b/src/Buy/Browse/V1/Model/ShippingOptionSummary.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/TargetLocation.php b/src/Buy/Browse/V1/Model/TargetLocation.php index 5534efae..8ea529bc 100644 --- a/src/Buy/Browse/V1/Model/TargetLocation.php +++ b/src/Buy/Browse/V1/Model/TargetLocation.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/TaxJurisdiction.php b/src/Buy/Browse/V1/Model/TaxJurisdiction.php index 72946579..76366829 100644 --- a/src/Buy/Browse/V1/Model/TaxJurisdiction.php +++ b/src/Buy/Browse/V1/Model/TaxJurisdiction.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/Taxes.php b/src/Buy/Browse/V1/Model/Taxes.php index 047385c7..4af27b77 100644 --- a/src/Buy/Browse/V1/Model/Taxes.php +++ b/src/Buy/Browse/V1/Model/Taxes.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/TimeDuration.php b/src/Buy/Browse/V1/Model/TimeDuration.php index 6f846400..31a1506b 100644 --- a/src/Buy/Browse/V1/Model/TimeDuration.php +++ b/src/Buy/Browse/V1/Model/TimeDuration.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/TypedNameValue.php b/src/Buy/Browse/V1/Model/TypedNameValue.php index 7ed53224..7db4b250 100644 --- a/src/Buy/Browse/V1/Model/TypedNameValue.php +++ b/src/Buy/Browse/V1/Model/TypedNameValue.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/UpdateCartItemInput.php b/src/Buy/Browse/V1/Model/UpdateCartItemInput.php index ee68b471..1c5f41bf 100644 --- a/src/Buy/Browse/V1/Model/UpdateCartItemInput.php +++ b/src/Buy/Browse/V1/Model/UpdateCartItemInput.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/Model/VatDetail.php b/src/Buy/Browse/V1/Model/VatDetail.php index dea173bc..af39ceb2 100644 --- a/src/Buy/Browse/V1/Model/VatDetail.php +++ b/src/Buy/Browse/V1/Model/VatDetail.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/ObjectSerializer.php b/src/Buy/Browse/V1/ObjectSerializer.php index 2d174754..8b538045 100644 --- a/src/Buy/Browse/V1/ObjectSerializer.php +++ b/src/Buy/Browse/V1/ObjectSerializer.php @@ -46,7 +46,7 @@ * *

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: \"Experimental (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: \"Experimental (Experimental) \"Limited(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

* - * The version of the OpenAPI document: v1.16.0 + * The version of the OpenAPI document: v1.18.0 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Browse/V1/README.md b/src/Buy/Browse/V1/README.md index 415c4dd5..f1240da1 100644 --- a/src/Buy/Browse/V1/README.md +++ b/src/Buy/Browse/V1/README.md @@ -202,5 +202,5 @@ vendor/bin/phpunit This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: `v1.16.0` +- API version: `v1.18.0` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/src/Buy/Browse/V1/docs/Api/ItemSummaryApi.md b/src/Buy/Browse/V1/docs/Api/ItemSummaryApi.md index f69a9511..0382630b 100644 --- a/src/Buy/Browse/V1/docs/Api/ItemSummaryApi.md +++ b/src/Buy/Browse/V1/docs/Api/ItemSummaryApi.md @@ -37,7 +37,7 @@ $apiInstance = new TNT\Ebay\Buy\Browse\V1\Api\ItemSummaryApi( new GuzzleHttp\Client(), $config ); -$aspect_filter = 'aspect_filter_example'; // string | This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.

/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}

To get a list of the aspects pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS.

/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTS

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter +$aspect_filter = 'aspect_filter_example'; // string | This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.

/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}

To get a list of the aspect pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS.

/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTS

Note: The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter.

The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:

/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed\|Stü|Nike}

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter $auto_correct = 'auto_correct_example'; // string | A query parameter that enables auto correction.

Valid Values: KEYWORD $category_ids = 'category_ids_example'; // string | The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.

For example:
/buy/browse/v1/item_summary/search?category_ids=29792

Note: Currently, you can pass in only one category ID per request.

You can also use any combination of the category_Ids, epid, and q fields. This gives you additional control over the result set.

For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted.

For example:
/buy/browse/v1/item_summary/search?q=phone&category_ids=220

The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site:
  • Use the Category Changes page.
  • Use the Taxonomy API. For details see Get Categories for Buy APIs.
  • Submit the following method to get the dominantCategoryId for an item.

    /buy/browse/v1/item_summary/search?q= keyword&fieldgroups=ASPECT_REFINEMENTS
Note: If a top-level (L1) category is specified, you must also include the q query parameter.

Required: The method must have category_ids, epid, gtin, or q (or any combination of these) $charity_ids = 'charity_ids_example'; // string | The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.

For example:
/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469

The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\".
  • To find the charities eBay supports, you can search for a charity at Charity Search or go to Charity Shop.
  • To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for American Red Cross, is 530196605.
You can also use any combination of the category_Ids and q fields with a charity_Ids to filter the result set. This gives you additional control over the result set.

Restriction: This is supported only on the US and GB marketplaces.

Maximum: 20 IDs

Required: One ID @@ -63,7 +63,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **aspect_filter** | **string**| This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspects pairs and the category, which is returned in the <b> dominantCategoryId</b> field, set <b> fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><b>Required: </b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter | [optional] + **aspect_filter** | **string**| This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red. <br /><br />For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.<br /><br /><code>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</code> <br /><br />To get a list of the aspect pairs and the category, which is returned in the <b>dominantCategoryId</b> field, set <b>fieldgroups</b> to <code>ASPECT_REFINEMENTS</code>. <br /><br /> <code>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</code> <br /><br /><span class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter. <br /><br />The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:<br /><br /><code>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü|Nike}</code></span><br /><br /><b>Required:</b> The category ID is required <i>twice</i>; once as a URI parameter and as part of the <b> aspect_filter</b>. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter | [optional] **auto_correct** | **string**| A query parameter that enables auto correction.<br /><br /><b>Valid Values:</b> <code>KEYWORD</code> | [optional] **category_ids** | **string**| <a name=\"category_ids\"></a>The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.<br /><br /><b> For example: </b><br/><code>/buy/browse/v1/item_summary/search?category_ids=29792</code> <br /><br /><span class=\"tablenote\"><b> Note: </b>Currently, you can pass in only one category ID per request.</span> <br /> <br />You can also use any combination of the <b> category_Ids</b>, <b> epid</b>, and <b> q</b> fields. This gives you additional control over the result set. <br /><br />For example, let's say you are looking of a toy phone. If you search for \"phone\", the result set will be mobile phones because this is the \"Best Match\" for this search. But if you also include the toy category ID, the results will be what you wanted. <br /><br /><b> For example: </b><br /><code>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</code><br /> <br />The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site: <ul> <li>Use the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html \" target=\"_blank\">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> <li>Submit the following method to get the <b> dominantCategoryId</b> for an item. <br /><br /><code>/buy/browse/v1/item_summary/search?q=<em> keyword</em>&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> <span class=\"tablenote\"> <b> Note:</b> If a top-level (L1) category is specified, you <b> must</b> also include the <b> q</b> query parameter.</span> <br /><br /><b> Required: </b> The method must have <b> category_ids</b>, <b> epid</b>, <b> gtin</b>, or <b> q</b> (or any combination of these) | [optional] **charity_ids** | **string**| The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.<br /><br /> <b>For example:</b><br /><code>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</code><br /><br />The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called \"Charity Number\". <ul><li>To find the charities eBay supports, you can search for a charity at <a href=\"https://charity.ebay.com/search \" target=\"_blank\">Charity Search </a> or go to <a href=\"https://www.ebay.com/b/Charity/bn_7114598164 \" target=\"_blank\">Charity Shop</a>.</li> <li>To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for <a href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"_blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul> You can also use any combination of the <code>category_Ids</code> and <code>q</code> fields with a <code>charity_Ids</code> to filter the result set. This gives you additional control over the result set. <br /><br /><b>Restriction: </b> This is supported only on the US and GB marketplaces.<br /><br /><b>Maximum: </b> 20 IDs <br /><br /><b>Required:</b> One ID | [optional] diff --git a/src/Buy/Browse/V1/docs/Model/Category.md b/src/Buy/Browse/V1/docs/Model/Category.md index 3162743e..374e79ea 100644 --- a/src/Buy/Browse/V1/docs/Model/Category.md +++ b/src/Buy/Browse/V1/docs/Model/Category.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category_id** | **string** | The unique identifier of the primary item category of the item, as well as the secondary item category if item was listed in two categories. | [optional] +**category_id** | **string** | The unique identifier of the category. | [optional] +**category_name** | **string** | The name of the category. | [optional] [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/src/Buy/Browse/V1/docs/Model/ItemSummary.md b/src/Buy/Browse/V1/docs/Model/ItemSummary.md index fad46790..bed55d2a 100644 --- a/src/Buy/Browse/V1/docs/Model/ItemSummary.md +++ b/src/Buy/Browse/V1/docs/Model/ItemSummary.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **available_coupons** | **bool** | This boolean attribute indicates if coupons are available for the item. | [optional] **bid_count** | **int** | This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items. | [optional] **buying_options** | **string[]** | A comma separated list of all the purchase options available for the item. <br><br><b> Values Returned:</b><ul><li><b>FIXED_PRICE</b> - Indicates the buyer can purchase the item for a set price using the Buy It Now button. </li> <li><b> AUCTION</b> - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.</li> <li><b> BEST_OFFER</b> - Items where the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For details about Best Offer, see <a href=\"https://www.ebay.com/help/selling/listings/selling-buy-now/adding-best-offer-listing?id=4144 \" target=\"_blank\">Best Offer</a>.</li><li><b>CLASSIFIED_AD</b> - Indicates that the final sales transaction is to be completed outside of the eBay environment.</li></ul> Code so that your app gracefully handles any future changes to this list. | [optional] -**categories** | [**\TNT\Ebay\Buy\Browse\V1\Model\Category[]**](Category.md) | This container returns the primary category ID of the item (as well as the secondary category if the item was listed in two categories). | [optional] +**categories** | [**\TNT\Ebay\Buy\Browse\V1\Model\Category[]**](Category.md) | This array returns the name and ID of each category associated with the item, including top level, branch, and leaf categories. | [optional] **compatibility_match** | **string** | This indicates how well the item matches the <b>compatibility_filter</b> product attributes. <br><br><b> Valid Values: </b> EXACT or POSSIBLE <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityMatchEnum'>eBay API documentation</a> | [optional] **compatibility_properties** | [**\TNT\Ebay\Buy\Browse\V1\Model\CompatibilityProperty[]**](CompatibilityProperty.md) | This container returns only the product attributes that are compatible with the item. These attributes were specified in the <b>compatibility_filter</b> in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned. | [optional] **condition** | **string** | The text describing the condition of the item, such as New or Used. For a list of condition names, see <a href=\"https://developer.ebay.com/devzone/finding/callref/enums/conditionIdList.html \" target=\"_blank\">Item Condition IDs and Names</a>. <br /><br />Code so that your app gracefully handles any future changes to this list.</span> | [optional] @@ -28,6 +28,7 @@ Name | Type | Description | Notes **item_id** | **string** | The unique RESTful identifier of the item. | [optional] **item_location** | [**\TNT\Ebay\Buy\Browse\V1\Model\ItemLocationImpl**](ItemLocationImpl.md) | | [optional] **item_web_url** | **string** | The URL to the View Item page of the item. This enables you to include a \"Report Item on eBay\" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. | [optional] +**leaf_category_ids** | **string[]** | The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary. | [optional] **legacy_item_id** | **string** | The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page. | [optional] **listing_marketplace_id** | **string** | The ID of the eBay marketplace where the item is listed. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:MarketplaceIdEnum'>eBay API documentation</a> | [optional] **marketing_price** | [**\TNT\Ebay\Buy\Browse\V1\Model\MarketingPrice**](MarketingPrice.md) | | [optional] diff --git a/src/Buy/Browse/V1/docs/Model/ShippingOption.md b/src/Buy/Browse/V1/docs/Model/ShippingOption.md index 11c989cb..a76fbafb 100644 --- a/src/Buy/Browse/V1/docs/Model/ShippingOption.md +++ b/src/Buy/Browse/V1/docs/Model/ShippingOption.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **additional_shipping_cost_per_unit** | [**\TNT\Ebay\Buy\Browse\V1\Model\ConvertedAmount**](ConvertedAmount.md) | | [optional] **cut_off_date_used_for_estimate** | **string** | The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window (<b> maxEstimatedDeliveryDate</b> and <b> minEstimatedDeliveryDate</b> fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the <b> Delivery</b> line on the View Item page. <br /><br />This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. | [optional] -**fulfilled_through** | **string** | If the item is being shipped by eBay's <a href=\"https://pages.ebay.com/seller-center/shipping/global-shipping-program.html \">Global Shipping Program</a>, this field returns <code>GLOBAL_SHIPPING</code>. Otherwise this field is null. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:FulfilledThroughEnum'>eBay API documentation</a> | [optional] +**fulfilled_through** | **string** | If the item is being shipped by the eBay <a href=\"https://pages.ebay.com/seller-center/shipping/global-shipping-program.html \">Global Shipping program</a>, this field returns <code>GLOBAL_SHIPPING</code>.<br /><br />If the item is being shipped using the eBay International Shipping program, this field returns <code>INTERNATIONAL_SHIPPING</code>. <br /><br />Otherwise, this field is null. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:FulfilledThroughEnum'>eBay API documentation</a> | [optional] **guaranteed_delivery** | **bool** | Indicates if the seller has committed to shipping the item with eBay Guaranteed Delivery. With eBay Guaranteed Delivery, the seller is committed to getting the line item to the buyer within 4 business days or less. See the <a href=\"https://www.ebay.com/help/buying/shipping-delivery/buying-items-ebay-guaranteed-delivery?id=4641 \">Buying items with eBay Guaranteed Delivery</a> help topic for more details about eBay Guaranteed Delivery. | [optional] **import_charges** | [**\TNT\Ebay\Buy\Browse\V1\Model\ConvertedAmount**](ConvertedAmount.md) | | [optional] **max_estimated_delivery_date** | **string** | The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. <br /> <br /> <span class=\"tablenote\"> <b> Note: </b> For the best accuracy, always include the location of where the item is be shipped in the <code> contextualLocation</code> values of the <a href=\"/api-docs/buy/static/api-browse.html#Headers\"> <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span> | [optional] diff --git a/src/Buy/Deal/V1/Configuration.php b/src/Buy/Deal/V1/Configuration.php index 876e0acb..c313547f 100644 --- a/src/Buy/Deal/V1/Configuration.php +++ b/src/Buy/Deal/V1/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Buy/Feed/V1/Api/AccessApi.php b/src/Buy/Feed/V1/Api/AccessApi.php index 07703f1c..70266019 100644 --- a/src/Buy/Feed/V1/Api/AccessApi.php +++ b/src/Buy/Feed/V1/Api/AccessApi.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Api/FeedTypeApi.php b/src/Buy/Feed/V1/Api/FeedTypeApi.php index 2f57aa6f..d5f8037a 100644 --- a/src/Buy/Feed/V1/Api/FeedTypeApi.php +++ b/src/Buy/Feed/V1/Api/FeedTypeApi.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Api/FileApi.php b/src/Buy/Feed/V1/Api/FileApi.php index ef69f22d..26150786 100644 --- a/src/Buy/Feed/V1/Api/FileApi.php +++ b/src/Buy/Feed/V1/Api/FileApi.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/ApiException.php b/src/Buy/Feed/V1/ApiException.php index 7ec0caf3..a2c8c7c4 100644 --- a/src/Buy/Feed/V1/ApiException.php +++ b/src/Buy/Feed/V1/ApiException.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Configuration.php b/src/Buy/Feed/V1/Configuration.php index 2499c2c3..a772d2a6 100644 --- a/src/Buy/Feed/V1/Configuration.php +++ b/src/Buy/Feed/V1/Configuration.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). @@ -441,7 +441,7 @@ public static function toDebugReport() $report = 'PHP SDK (TNT\Ebay\Buy\Feed\V1) Debug Report:'.PHP_EOL; $report .= ' OS: '.php_uname().PHP_EOL; $report .= ' PHP Version: '.PHP_VERSION.PHP_EOL; - $report .= ' The version of the OpenAPI document: v1.0.1'.PHP_EOL; + $report .= ' The version of the OpenAPI document: v1.0.2'.PHP_EOL; $report .= ' Temp Folder Path: '.self::getDefaultConfiguration()->getTempFolderPath().PHP_EOL; return $report; diff --git a/src/Buy/Feed/V1/HeaderSelector.php b/src/Buy/Feed/V1/HeaderSelector.php index e9b926d7..7c4f2dea 100644 --- a/src/Buy/Feed/V1/HeaderSelector.php +++ b/src/Buy/Feed/V1/HeaderSelector.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/Access.php b/src/Buy/Feed/V1/Model/Access.php index f6b5ceb1..3c604458 100644 --- a/src/Buy/Feed/V1/Model/Access.php +++ b/src/Buy/Feed/V1/Model/Access.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/ApplicationAccess.php b/src/Buy/Feed/V1/Model/ApplicationAccess.php index 825e1af4..d496fe17 100644 --- a/src/Buy/Feed/V1/Model/ApplicationAccess.php +++ b/src/Buy/Feed/V1/Model/ApplicationAccess.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/Constraint.php b/src/Buy/Feed/V1/Model/Constraint.php index edb4835d..e3d6f37b 100644 --- a/src/Buy/Feed/V1/Model/Constraint.php +++ b/src/Buy/Feed/V1/Model/Constraint.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/Dimension.php b/src/Buy/Feed/V1/Model/Dimension.php index 421ce9d9..2f112526 100644 --- a/src/Buy/Feed/V1/Model/Dimension.php +++ b/src/Buy/Feed/V1/Model/Dimension.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/Error.php b/src/Buy/Feed/V1/Model/Error.php index ca212843..732c4c82 100644 --- a/src/Buy/Feed/V1/Model/Error.php +++ b/src/Buy/Feed/V1/Model/Error.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/ErrorParameter.php b/src/Buy/Feed/V1/Model/ErrorParameter.php index 552df151..1a2c3dae 100644 --- a/src/Buy/Feed/V1/Model/ErrorParameter.php +++ b/src/Buy/Feed/V1/Model/ErrorParameter.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/FeedType.php b/src/Buy/Feed/V1/Model/FeedType.php index 5b055843..da6d488a 100644 --- a/src/Buy/Feed/V1/Model/FeedType.php +++ b/src/Buy/Feed/V1/Model/FeedType.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/FeedTypeConstraint.php b/src/Buy/Feed/V1/Model/FeedTypeConstraint.php index 4031ca55..6d6803e3 100644 --- a/src/Buy/Feed/V1/Model/FeedTypeConstraint.php +++ b/src/Buy/Feed/V1/Model/FeedTypeConstraint.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/FeedTypeSearchResponse.php b/src/Buy/Feed/V1/Model/FeedTypeSearchResponse.php index 27b60fb6..f34be90f 100644 --- a/src/Buy/Feed/V1/Model/FeedTypeSearchResponse.php +++ b/src/Buy/Feed/V1/Model/FeedTypeSearchResponse.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/FileMetadata.php b/src/Buy/Feed/V1/Model/FileMetadata.php index c48a3f71..ab200d30 100644 --- a/src/Buy/Feed/V1/Model/FileMetadata.php +++ b/src/Buy/Feed/V1/Model/FileMetadata.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/FileMetadataSearchResponse.php b/src/Buy/Feed/V1/Model/FileMetadataSearchResponse.php index 89fa7fd1..7223e8b1 100644 --- a/src/Buy/Feed/V1/Model/FileMetadataSearchResponse.php +++ b/src/Buy/Feed/V1/Model/FileMetadataSearchResponse.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/ModelInterface.php b/src/Buy/Feed/V1/Model/ModelInterface.php index 2bb0e2a0..5ce9f941 100644 --- a/src/Buy/Feed/V1/Model/ModelInterface.php +++ b/src/Buy/Feed/V1/Model/ModelInterface.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/SupportedFeed.php b/src/Buy/Feed/V1/Model/SupportedFeed.php index 2c207c36..fef9e4d1 100644 --- a/src/Buy/Feed/V1/Model/SupportedFeed.php +++ b/src/Buy/Feed/V1/Model/SupportedFeed.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/SupportedSchema.php b/src/Buy/Feed/V1/Model/SupportedSchema.php index 5034fd3c..032c1da4 100644 --- a/src/Buy/Feed/V1/Model/SupportedSchema.php +++ b/src/Buy/Feed/V1/Model/SupportedSchema.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/Model/TimeDuration.php b/src/Buy/Feed/V1/Model/TimeDuration.php index cee26122..832f21f9 100644 --- a/src/Buy/Feed/V1/Model/TimeDuration.php +++ b/src/Buy/Feed/V1/Model/TimeDuration.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/ObjectSerializer.php b/src/Buy/Feed/V1/ObjectSerializer.php index 884c389c..b86f09b7 100644 --- a/src/Buy/Feed/V1/ObjectSerializer.php +++ b/src/Buy/Feed/V1/ObjectSerializer.php @@ -46,7 +46,7 @@ * * The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file for a specific category, date, and marketplace.

In addition to the API, there is an open-source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. * - * The version of the OpenAPI document: v1.0.1 + * The version of the OpenAPI document: v1.0.2 * Generated by: https://openapi-generator.tech * OpenAPI Generator version: 5.4.0 */ diff --git a/src/Buy/Feed/V1/README.md b/src/Buy/Feed/V1/README.md index ad92827f..05187f09 100644 --- a/src/Buy/Feed/V1/README.md +++ b/src/Buy/Feed/V1/README.md @@ -126,5 +126,5 @@ vendor/bin/phpunit This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: `v1.0.1` +- API version: `v1.0.2` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/src/Buy/FeedBeta/V1/Configuration.php b/src/Buy/FeedBeta/V1/Configuration.php index aba20d3b..55692b4d 100644 --- a/src/Buy/FeedBeta/V1/Configuration.php +++ b/src/Buy/FeedBeta/V1/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Buy/FeedBeta/V1/docs/Api/ItemApi.md b/src/Buy/FeedBeta/V1/docs/Api/ItemApi.md index 98d321cb..171e2055 100644 --- a/src/Buy/FeedBeta/V1/docs/Api/ItemApi.md +++ b/src/Buy/FeedBeta/V1/docs/Api/ItemApi.md @@ -15,7 +15,7 @@ getItemFeed($accept, $x_ebay_c_marketplace_id, $range, $feed_scope, $category_id -

This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.

There are two types of item feed files generated:

  • A daily Item feed file containing all the newly listed items for a specific category, date, and marketplace (feed_scope = NEWLY_LISTED)
  • A weekly Item Bootstrap feed file containing all the items in a specific category and marketplace (feed_scope = ALL_ACTIVE)

Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future.

URLs for this method

  • Production URL: https://api.ebay.com/buy/feed/v1_beta/item?
  • Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/item?

Downloading feed files

Item feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file.

In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.

Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

+

This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.

There are two types of item feed files generated:

  • A daily Item feed file containing all the newly listed items for a specific category, date, and marketplace (feed_scope = NEWLY_LISTED)
  • A weekly Item Bootstrap feed file containing all the items in a specific category and marketplace (feed_scope = ALL_ACTIVE)

Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future.

URLs for this method

  • Production URL: https://api.ebay.com/buy/feed/v1_beta/item?
  • Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/item?

Downloading feed files

Item feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file.

In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.

Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

### Example diff --git a/src/Buy/MarketingBeta/V1/Configuration.php b/src/Buy/MarketingBeta/V1/Configuration.php index 6fce860b..9088d96d 100644 --- a/src/Buy/MarketingBeta/V1/Configuration.php +++ b/src/Buy/MarketingBeta/V1/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Buy/MarketplaceInsightsBeta/V1/Configuration.php b/src/Buy/MarketplaceInsightsBeta/V1/Configuration.php index 4463b8f0..983bb302 100644 --- a/src/Buy/MarketplaceInsightsBeta/V1/Configuration.php +++ b/src/Buy/MarketplaceInsightsBeta/V1/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Buy/OfferBeta/V1/Configuration.php b/src/Buy/OfferBeta/V1/Configuration.php index 877652dd..4877dd23 100644 --- a/src/Buy/OfferBeta/V1/Configuration.php +++ b/src/Buy/OfferBeta/V1/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Buy/Order/V2/Configuration.php b/src/Buy/Order/V2/Configuration.php index d34c80c8..a06dc85f 100644 --- a/src/Buy/Order/V2/Configuration.php +++ b/src/Buy/Order/V2/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Commerce/CatalogBeta/V1/Api/ProductApi.php b/src/Commerce/CatalogBeta/V1/Api/ProductApi.php index ac968990..afec4beb 100644 --- a/src/Commerce/CatalogBeta/V1/Api/ProductApi.php +++ b/src/Commerce/CatalogBeta/V1/Api/ProductApi.php @@ -152,16 +152,17 @@ public function getConfiguration() /** * Operation getProduct. * - * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary. (required) + * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the <b>search</b> method and examining the value of the <b>productSummaries.epid</b> field for the desired returned product summary. (required) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) * * @throws \TNT\Ebay\Commerce\CatalogBeta\V1\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return \TNT\Ebay\Commerce\CatalogBeta\V1\Model\Product */ - public function getProduct($epid) + public function getProduct($epid, $x_ebay_c_marketplace_id = null) { - [$response] = $this->getProductWithHttpInfo($epid); + [$response] = $this->getProductWithHttpInfo($epid, $x_ebay_c_marketplace_id); return $response; } @@ -169,16 +170,17 @@ public function getProduct($epid) /** * Operation getProductWithHttpInfo. * - * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary. (required) + * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the <b>search</b> method and examining the value of the <b>productSummaries.epid</b> field for the desired returned product summary. (required) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) * * @throws \TNT\Ebay\Commerce\CatalogBeta\V1\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return array of \TNT\Ebay\Commerce\CatalogBeta\V1\Model\Product, HTTP status code, HTTP response headers (array of strings) */ - public function getProductWithHttpInfo($epid) + public function getProductWithHttpInfo($epid, $x_ebay_c_marketplace_id = null) { - $request = $this->getProductRequest($epid); + $request = $this->getProductRequest($epid, $x_ebay_c_marketplace_id); try { $options = $this->createHttpClientOption(); @@ -246,15 +248,16 @@ public function getProductWithHttpInfo($epid) /** * Operation getProductAsync. * - * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary. (required) + * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the <b>search</b> method and examining the value of the <b>productSummaries.epid</b> field for the desired returned product summary. (required) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) * * @throws \InvalidArgumentException * * @return \GuzzleHttp\Promise\PromiseInterface */ - public function getProductAsync($epid) + public function getProductAsync($epid, $x_ebay_c_marketplace_id = null) { - return $this->getProductAsyncWithHttpInfo($epid) + return $this->getProductAsyncWithHttpInfo($epid, $x_ebay_c_marketplace_id) ->then( function ($response) { return $response[0]; @@ -265,16 +268,17 @@ function ($response) { /** * Operation getProductAsyncWithHttpInfo. * - * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary. (required) + * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the <b>search</b> method and examining the value of the <b>productSummaries.epid</b> field for the desired returned product summary. (required) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) * * @throws \InvalidArgumentException * * @return \GuzzleHttp\Promise\PromiseInterface */ - public function getProductAsyncWithHttpInfo($epid) + public function getProductAsyncWithHttpInfo($epid, $x_ebay_c_marketplace_id = null) { $returnType = '\TNT\Ebay\Commerce\CatalogBeta\V1\Model\Product'; - $request = $this->getProductRequest($epid); + $request = $this->getProductRequest($epid, $x_ebay_c_marketplace_id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) @@ -304,13 +308,14 @@ function ($exception) { /** * Create request for operation 'getProduct'. * - * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary. (required) + * @param string $epid The ePID of the product being requested. This value can be discovered by issuing the <b>search</b> method and examining the value of the <b>productSummaries.epid</b> field for the desired returned product summary. (required) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) * * @throws \InvalidArgumentException * * @return \GuzzleHttp\Psr7\Request */ - public function getProductRequest($epid) + public function getProductRequest($epid, $x_ebay_c_marketplace_id = null) { // Verify the required parameter 'epid' is set. if ($epid === null || (\is_array($epid) && count($epid) === 0)) { @@ -324,6 +329,11 @@ public function getProductRequest($epid) $httpBody = ''; $multipart = false; + // header params + if ($x_ebay_c_marketplace_id !== null) { + $headerParams['X-EBAY-C-MARKETPLACE-ID'] = ObjectSerializer::toHeaderValue($x_ebay_c_marketplace_id); + } + // path params if ($epid !== null) { $resourcePath = str_replace( diff --git a/src/Commerce/CatalogBeta/V1/Api/ProductSummaryApi.php b/src/Commerce/CatalogBeta/V1/Api/ProductSummaryApi.php index f7c9313f..b120c9b9 100644 --- a/src/Commerce/CatalogBeta/V1/Api/ProductSummaryApi.php +++ b/src/Commerce/CatalogBeta/V1/Api/ProductSummaryApi.php @@ -152,23 +152,24 @@ public function getConfiguration() /** * Operation search. * - * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. You can determine appropriate values for the aspects by first submitting this call without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. Note: You can also use the Taxonomy API's getItemAspectsForCategory call to retrieve detailed information about aspects and their values that are appropriate for your selected category. The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required): aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...}, aspect2:{valueC|valueD|...},... A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. Note: Aspect names and values are case sensitive. Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black} Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D, Storage%20Capacity:%128GB%7C256GB%7D Note: You cannot use the aspect_filter parameter in the same call with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) - * @param string $category_ids Important: Currently, only the first category_id value is accepted. One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. Note: This parameter requires a valid category ID value. You can use the Taxonomy API's getCategorySuggestions call to retrieve appropriate category IDs for your product based on keywords. The syntax for this parameter is as follows: category_ids=category_id1,category_id2,... Here is an example of a call with the category_ids parameter: GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893 Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide only the category_ids parameter, you cannot specify a top-level (L1) category. (optional) - * @param string $fieldgroups The type of information to return in the response. Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination. Valid Values: ASPECT_REFINEMENTS &mdash; This returns the refinement container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for Ford Mustang, some of the category aspects might be Model Year, Exterior Color, Vehicle Mileage, and so on. Note: Aspects are category specific. FULL &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored. MATCHING_PRODUCTS &mdash; This returns summaries for all products that match the values you provide for the q and category_ids parameters. This does not affect your use of the ASPECT_REFINEMENTS value, which you can use in the same call. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_PRODUCTS (optional) - * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the gtin parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $limit The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. Maximum: 200 Default: 50 (optional) - * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This call will return all products that have one of the specified MPNs. MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the mpn parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $offset This parameter is reserved for internal or future use. (optional) - * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. Note: This call searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed. The keywords are handled as follows: If the keywords are separated by a comma (e.g. iPhone,256GB), the query returns products that have iPhone AND 256GB. If the keywords are separated by a space (e.g. &quot;iPhone&nbsp;ipad&quot; or &quot;iPhone,&nbsp;ipad&quot;), the query ignores any commas and returns products that have iPhone OR iPad. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the q parameter in the same call with either the gtin parameter or the mpn parameter. (optional) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) + * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. <br /><br /> Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. <br /><br /> You can determine appropriate values for the aspects by first submitting this method without this parameter. It will return either the <b>productSummaries.aspects</b> container, the <b>refinement.aspectDistributions</b> container, or both, depending on the value of the <b>fieldgroups</b> parameter in the request. The <b>productSummaries.aspects</b> container provides the category aspects and their values that are associated with each returned product. The <b>refinement.aspectDistributions</b> container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You can also use the Taxonomy API's <b>getItemAspectsForCategory</b> method to retrieve detailed information about aspects and their values that are appropriate for your selected category. </span> <br /><br /> The syntax for the <b>aspect_filter</b> parameter is as follows (on several lines for readability; <b>categoryId</b> is required): <br /><br /> <code>aspect_filter=categoryId:<i>category_id</i>,<br /> <i>aspect1</i>:{<i>valueA</i>|<i>valueB</i>|...},<br /> <i>aspect2</i>:{<i>valueC</i>|<i>valueD</i>|...},.</code> <br /><br /> A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Aspect names and values are case sensitive. </span> <br /><br /> Here is an example of an <b>aspect_filter</b> parameter in which <code>9355</code> is the category ID, <code>Color</code> is an aspect of that category, and <code>Black</code> and <code>White</code> are possible values of that aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:{White|Black}</code> <br /><br /> Here is the <b>aspect_filter</b> with required URL encoding and a second aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,<br /> Storage%20Capacity:%128GB%7C256GB%7D</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You cannot use the <b>aspect_filter</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) + * @param string $category_ids <span class=\"tablenote\"> <strong>Important:</strong> Currently, only the first <b>category_id</b> value is accepted. </span> <br /><br /> One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This parameter requires a valid category ID value. You can use the Taxonomy API's <b>getCategorySuggestions</b> method to retrieve appropriate category IDs for your product based on keywords. </span> <br /><br /> The syntax for this parameter is as follows: <br /><br /> <code>category_ids=<i>category_id1</i>,<i>category_id2</i>,.</code> <br /><br /> Here is an example of a method with the <b>category_ids</b> parameter: br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> category_ids=178893</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> If you provide only the <b>category_ids</b> parameter, you cannot specify a top-level (L1) category. </span> (optional) + * @param string $fieldgroups The type of information to return in the response. <br /><br /> <span class=\"tablenote\"> <strong>Important:</strong> This parameter may not produce valid results if you also provide more than one value for the <b>category_ids</b> parameter. It is recommended that you avoid using this combination. </span> <br /><br /> <b> Valid Values: </b> <ul> <li><code>ASPECT_REFINEMENTS</code> &mdash; This returns the <b>refinement</b> container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for <code>Ford Mustang</code>, some of the category aspects might be <b>Model Year</b>, <b>Exterior Color</b>, <b>Vehicle Mileage</b>, and so on. <br /> <br /> <span class=\"tablenote\"> <b>Note: </b>Aspects are category specific.</span> </li> <li><code>FULL</code> &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored.</li> <li><code>MATCHING_PRODUCTS</code> &mdash; This returns summaries for all products that match the values you provide for the <b>q</b> and <b>category_ids</b> parameters. This does not affect your use of the <code>ASPECT_REFINEMENTS</code> value, which you can use in the same call.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> <code>MATCHING_PRODUCTS</code> (optional) + * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>gtin</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $limit The number of product summaries to return. This is the <i>result set</i>, a subset of the full collection of products that match the search or filter criteria of this call. <br /><br /> <b>Maximum:</b> <code>200</code> <br /> <b>Default:</b> <code>50</code> (optional) + * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This method will return all products that have one of the specified MPNs. <br /><br /> MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>mpn</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $offset This parameter is reserved for internal or future use. (optional) + * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This method searches the following product record fields: <b>title</b>, <b>description</b>, <b>brand</b>, and <b>aspects.localizedName</b>, which do not include product IDs. Wildcard characters (e.g. <code>*</code>) are not allowed. </span> <br /><br /> The keywords are handled as follows: <ul> <li>If the keywords are separated by a comma (e.g. <code>iPhone,256GB</code>), the query returns products that have <code>iPhone</code> <b>AND</b> <code>256GB</code>.</li> <li>If the keywords are separated by a space (e.g. <code>\"iPhone&nbsp;ipad\"</code> or <code>\"iPhone,&nbsp;ipad\"</code>), the query ignores any commas and returns products that have <code>iPhone</code> <b>OR</b> <code>iPad</code>.</li> </ul> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>q</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> (optional) * * @throws \TNT\Ebay\Commerce\CatalogBeta\V1\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return \TNT\Ebay\Commerce\CatalogBeta\V1\Model\ProductSearchResponse */ - public function search($aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) + public function search($x_ebay_c_marketplace_id = null, $aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) { - [$response] = $this->searchWithHttpInfo($aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q); + [$response] = $this->searchWithHttpInfo($x_ebay_c_marketplace_id, $aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q); return $response; } @@ -176,23 +177,24 @@ public function search($aspect_filter = null, $category_ids = null, $fieldgroups /** * Operation searchWithHttpInfo. * - * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. You can determine appropriate values for the aspects by first submitting this call without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. Note: You can also use the Taxonomy API's getItemAspectsForCategory call to retrieve detailed information about aspects and their values that are appropriate for your selected category. The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required): aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...}, aspect2:{valueC|valueD|...},... A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. Note: Aspect names and values are case sensitive. Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black} Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D, Storage%20Capacity:%128GB%7C256GB%7D Note: You cannot use the aspect_filter parameter in the same call with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) - * @param string $category_ids Important: Currently, only the first category_id value is accepted. One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. Note: This parameter requires a valid category ID value. You can use the Taxonomy API's getCategorySuggestions call to retrieve appropriate category IDs for your product based on keywords. The syntax for this parameter is as follows: category_ids=category_id1,category_id2,... Here is an example of a call with the category_ids parameter: GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893 Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide only the category_ids parameter, you cannot specify a top-level (L1) category. (optional) - * @param string $fieldgroups The type of information to return in the response. Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination. Valid Values: ASPECT_REFINEMENTS &mdash; This returns the refinement container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for Ford Mustang, some of the category aspects might be Model Year, Exterior Color, Vehicle Mileage, and so on. Note: Aspects are category specific. FULL &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored. MATCHING_PRODUCTS &mdash; This returns summaries for all products that match the values you provide for the q and category_ids parameters. This does not affect your use of the ASPECT_REFINEMENTS value, which you can use in the same call. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_PRODUCTS (optional) - * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the gtin parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $limit The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. Maximum: 200 Default: 50 (optional) - * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This call will return all products that have one of the specified MPNs. MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the mpn parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $offset This parameter is reserved for internal or future use. (optional) - * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. Note: This call searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed. The keywords are handled as follows: If the keywords are separated by a comma (e.g. iPhone,256GB), the query returns products that have iPhone AND 256GB. If the keywords are separated by a space (e.g. &quot;iPhone&nbsp;ipad&quot; or &quot;iPhone,&nbsp;ipad&quot;), the query ignores any commas and returns products that have iPhone OR iPad. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the q parameter in the same call with either the gtin parameter or the mpn parameter. (optional) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) + * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. <br /><br /> Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. <br /><br /> You can determine appropriate values for the aspects by first submitting this method without this parameter. It will return either the <b>productSummaries.aspects</b> container, the <b>refinement.aspectDistributions</b> container, or both, depending on the value of the <b>fieldgroups</b> parameter in the request. The <b>productSummaries.aspects</b> container provides the category aspects and their values that are associated with each returned product. The <b>refinement.aspectDistributions</b> container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You can also use the Taxonomy API's <b>getItemAspectsForCategory</b> method to retrieve detailed information about aspects and their values that are appropriate for your selected category. </span> <br /><br /> The syntax for the <b>aspect_filter</b> parameter is as follows (on several lines for readability; <b>categoryId</b> is required): <br /><br /> <code>aspect_filter=categoryId:<i>category_id</i>,<br /> <i>aspect1</i>:{<i>valueA</i>|<i>valueB</i>|...},<br /> <i>aspect2</i>:{<i>valueC</i>|<i>valueD</i>|...},.</code> <br /><br /> A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Aspect names and values are case sensitive. </span> <br /><br /> Here is an example of an <b>aspect_filter</b> parameter in which <code>9355</code> is the category ID, <code>Color</code> is an aspect of that category, and <code>Black</code> and <code>White</code> are possible values of that aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:{White|Black}</code> <br /><br /> Here is the <b>aspect_filter</b> with required URL encoding and a second aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,<br /> Storage%20Capacity:%128GB%7C256GB%7D</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You cannot use the <b>aspect_filter</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) + * @param string $category_ids <span class=\"tablenote\"> <strong>Important:</strong> Currently, only the first <b>category_id</b> value is accepted. </span> <br /><br /> One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This parameter requires a valid category ID value. You can use the Taxonomy API's <b>getCategorySuggestions</b> method to retrieve appropriate category IDs for your product based on keywords. </span> <br /><br /> The syntax for this parameter is as follows: <br /><br /> <code>category_ids=<i>category_id1</i>,<i>category_id2</i>,.</code> <br /><br /> Here is an example of a method with the <b>category_ids</b> parameter: br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> category_ids=178893</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> If you provide only the <b>category_ids</b> parameter, you cannot specify a top-level (L1) category. </span> (optional) + * @param string $fieldgroups The type of information to return in the response. <br /><br /> <span class=\"tablenote\"> <strong>Important:</strong> This parameter may not produce valid results if you also provide more than one value for the <b>category_ids</b> parameter. It is recommended that you avoid using this combination. </span> <br /><br /> <b> Valid Values: </b> <ul> <li><code>ASPECT_REFINEMENTS</code> &mdash; This returns the <b>refinement</b> container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for <code>Ford Mustang</code>, some of the category aspects might be <b>Model Year</b>, <b>Exterior Color</b>, <b>Vehicle Mileage</b>, and so on. <br /> <br /> <span class=\"tablenote\"> <b>Note: </b>Aspects are category specific.</span> </li> <li><code>FULL</code> &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored.</li> <li><code>MATCHING_PRODUCTS</code> &mdash; This returns summaries for all products that match the values you provide for the <b>q</b> and <b>category_ids</b> parameters. This does not affect your use of the <code>ASPECT_REFINEMENTS</code> value, which you can use in the same call.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> <code>MATCHING_PRODUCTS</code> (optional) + * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>gtin</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $limit The number of product summaries to return. This is the <i>result set</i>, a subset of the full collection of products that match the search or filter criteria of this call. <br /><br /> <b>Maximum:</b> <code>200</code> <br /> <b>Default:</b> <code>50</code> (optional) + * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This method will return all products that have one of the specified MPNs. <br /><br /> MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>mpn</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $offset This parameter is reserved for internal or future use. (optional) + * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This method searches the following product record fields: <b>title</b>, <b>description</b>, <b>brand</b>, and <b>aspects.localizedName</b>, which do not include product IDs. Wildcard characters (e.g. <code>*</code>) are not allowed. </span> <br /><br /> The keywords are handled as follows: <ul> <li>If the keywords are separated by a comma (e.g. <code>iPhone,256GB</code>), the query returns products that have <code>iPhone</code> <b>AND</b> <code>256GB</code>.</li> <li>If the keywords are separated by a space (e.g. <code>\"iPhone&nbsp;ipad\"</code> or <code>\"iPhone,&nbsp;ipad\"</code>), the query ignores any commas and returns products that have <code>iPhone</code> <b>OR</b> <code>iPad</code>.</li> </ul> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>q</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> (optional) * * @throws \TNT\Ebay\Commerce\CatalogBeta\V1\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return array of \TNT\Ebay\Commerce\CatalogBeta\V1\Model\ProductSearchResponse, HTTP status code, HTTP response headers (array of strings) */ - public function searchWithHttpInfo($aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) + public function searchWithHttpInfo($x_ebay_c_marketplace_id = null, $aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) { - $request = $this->searchRequest($aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q); + $request = $this->searchRequest($x_ebay_c_marketplace_id, $aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q); try { $options = $this->createHttpClientOption(); @@ -260,22 +262,23 @@ public function searchWithHttpInfo($aspect_filter = null, $category_ids = null, /** * Operation searchAsync. * - * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. You can determine appropriate values for the aspects by first submitting this call without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. Note: You can also use the Taxonomy API's getItemAspectsForCategory call to retrieve detailed information about aspects and their values that are appropriate for your selected category. The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required): aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...}, aspect2:{valueC|valueD|...},... A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. Note: Aspect names and values are case sensitive. Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black} Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D, Storage%20Capacity:%128GB%7C256GB%7D Note: You cannot use the aspect_filter parameter in the same call with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) - * @param string $category_ids Important: Currently, only the first category_id value is accepted. One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. Note: This parameter requires a valid category ID value. You can use the Taxonomy API's getCategorySuggestions call to retrieve appropriate category IDs for your product based on keywords. The syntax for this parameter is as follows: category_ids=category_id1,category_id2,... Here is an example of a call with the category_ids parameter: GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893 Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide only the category_ids parameter, you cannot specify a top-level (L1) category. (optional) - * @param string $fieldgroups The type of information to return in the response. Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination. Valid Values: ASPECT_REFINEMENTS &mdash; This returns the refinement container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for Ford Mustang, some of the category aspects might be Model Year, Exterior Color, Vehicle Mileage, and so on. Note: Aspects are category specific. FULL &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored. MATCHING_PRODUCTS &mdash; This returns summaries for all products that match the values you provide for the q and category_ids parameters. This does not affect your use of the ASPECT_REFINEMENTS value, which you can use in the same call. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_PRODUCTS (optional) - * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the gtin parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $limit The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. Maximum: 200 Default: 50 (optional) - * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This call will return all products that have one of the specified MPNs. MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the mpn parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $offset This parameter is reserved for internal or future use. (optional) - * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. Note: This call searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed. The keywords are handled as follows: If the keywords are separated by a comma (e.g. iPhone,256GB), the query returns products that have iPhone AND 256GB. If the keywords are separated by a space (e.g. &quot;iPhone&nbsp;ipad&quot; or &quot;iPhone,&nbsp;ipad&quot;), the query ignores any commas and returns products that have iPhone OR iPad. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the q parameter in the same call with either the gtin parameter or the mpn parameter. (optional) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) + * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. <br /><br /> Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. <br /><br /> You can determine appropriate values for the aspects by first submitting this method without this parameter. It will return either the <b>productSummaries.aspects</b> container, the <b>refinement.aspectDistributions</b> container, or both, depending on the value of the <b>fieldgroups</b> parameter in the request. The <b>productSummaries.aspects</b> container provides the category aspects and their values that are associated with each returned product. The <b>refinement.aspectDistributions</b> container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You can also use the Taxonomy API's <b>getItemAspectsForCategory</b> method to retrieve detailed information about aspects and their values that are appropriate for your selected category. </span> <br /><br /> The syntax for the <b>aspect_filter</b> parameter is as follows (on several lines for readability; <b>categoryId</b> is required): <br /><br /> <code>aspect_filter=categoryId:<i>category_id</i>,<br /> <i>aspect1</i>:{<i>valueA</i>|<i>valueB</i>|...},<br /> <i>aspect2</i>:{<i>valueC</i>|<i>valueD</i>|...},.</code> <br /><br /> A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Aspect names and values are case sensitive. </span> <br /><br /> Here is an example of an <b>aspect_filter</b> parameter in which <code>9355</code> is the category ID, <code>Color</code> is an aspect of that category, and <code>Black</code> and <code>White</code> are possible values of that aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:{White|Black}</code> <br /><br /> Here is the <b>aspect_filter</b> with required URL encoding and a second aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,<br /> Storage%20Capacity:%128GB%7C256GB%7D</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You cannot use the <b>aspect_filter</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) + * @param string $category_ids <span class=\"tablenote\"> <strong>Important:</strong> Currently, only the first <b>category_id</b> value is accepted. </span> <br /><br /> One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This parameter requires a valid category ID value. You can use the Taxonomy API's <b>getCategorySuggestions</b> method to retrieve appropriate category IDs for your product based on keywords. </span> <br /><br /> The syntax for this parameter is as follows: <br /><br /> <code>category_ids=<i>category_id1</i>,<i>category_id2</i>,.</code> <br /><br /> Here is an example of a method with the <b>category_ids</b> parameter: br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> category_ids=178893</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> If you provide only the <b>category_ids</b> parameter, you cannot specify a top-level (L1) category. </span> (optional) + * @param string $fieldgroups The type of information to return in the response. <br /><br /> <span class=\"tablenote\"> <strong>Important:</strong> This parameter may not produce valid results if you also provide more than one value for the <b>category_ids</b> parameter. It is recommended that you avoid using this combination. </span> <br /><br /> <b> Valid Values: </b> <ul> <li><code>ASPECT_REFINEMENTS</code> &mdash; This returns the <b>refinement</b> container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for <code>Ford Mustang</code>, some of the category aspects might be <b>Model Year</b>, <b>Exterior Color</b>, <b>Vehicle Mileage</b>, and so on. <br /> <br /> <span class=\"tablenote\"> <b>Note: </b>Aspects are category specific.</span> </li> <li><code>FULL</code> &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored.</li> <li><code>MATCHING_PRODUCTS</code> &mdash; This returns summaries for all products that match the values you provide for the <b>q</b> and <b>category_ids</b> parameters. This does not affect your use of the <code>ASPECT_REFINEMENTS</code> value, which you can use in the same call.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> <code>MATCHING_PRODUCTS</code> (optional) + * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>gtin</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $limit The number of product summaries to return. This is the <i>result set</i>, a subset of the full collection of products that match the search or filter criteria of this call. <br /><br /> <b>Maximum:</b> <code>200</code> <br /> <b>Default:</b> <code>50</code> (optional) + * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This method will return all products that have one of the specified MPNs. <br /><br /> MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>mpn</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $offset This parameter is reserved for internal or future use. (optional) + * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This method searches the following product record fields: <b>title</b>, <b>description</b>, <b>brand</b>, and <b>aspects.localizedName</b>, which do not include product IDs. Wildcard characters (e.g. <code>*</code>) are not allowed. </span> <br /><br /> The keywords are handled as follows: <ul> <li>If the keywords are separated by a comma (e.g. <code>iPhone,256GB</code>), the query returns products that have <code>iPhone</code> <b>AND</b> <code>256GB</code>.</li> <li>If the keywords are separated by a space (e.g. <code>\"iPhone&nbsp;ipad\"</code> or <code>\"iPhone,&nbsp;ipad\"</code>), the query ignores any commas and returns products that have <code>iPhone</code> <b>OR</b> <code>iPad</code>.</li> </ul> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>q</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> (optional) * * @throws \InvalidArgumentException * * @return \GuzzleHttp\Promise\PromiseInterface */ - public function searchAsync($aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) + public function searchAsync($x_ebay_c_marketplace_id = null, $aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) { - return $this->searchAsyncWithHttpInfo($aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q) + return $this->searchAsyncWithHttpInfo($x_ebay_c_marketplace_id, $aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q) ->then( function ($response) { return $response[0]; @@ -286,23 +289,24 @@ function ($response) { /** * Operation searchAsyncWithHttpInfo. * - * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. You can determine appropriate values for the aspects by first submitting this call without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. Note: You can also use the Taxonomy API's getItemAspectsForCategory call to retrieve detailed information about aspects and their values that are appropriate for your selected category. The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required): aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...}, aspect2:{valueC|valueD|...},... A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. Note: Aspect names and values are case sensitive. Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black} Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D, Storage%20Capacity:%128GB%7C256GB%7D Note: You cannot use the aspect_filter parameter in the same call with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) - * @param string $category_ids Important: Currently, only the first category_id value is accepted. One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. Note: This parameter requires a valid category ID value. You can use the Taxonomy API's getCategorySuggestions call to retrieve appropriate category IDs for your product based on keywords. The syntax for this parameter is as follows: category_ids=category_id1,category_id2,... Here is an example of a call with the category_ids parameter: GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893 Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide only the category_ids parameter, you cannot specify a top-level (L1) category. (optional) - * @param string $fieldgroups The type of information to return in the response. Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination. Valid Values: ASPECT_REFINEMENTS &mdash; This returns the refinement container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for Ford Mustang, some of the category aspects might be Model Year, Exterior Color, Vehicle Mileage, and so on. Note: Aspects are category specific. FULL &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored. MATCHING_PRODUCTS &mdash; This returns summaries for all products that match the values you provide for the q and category_ids parameters. This does not affect your use of the ASPECT_REFINEMENTS value, which you can use in the same call. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_PRODUCTS (optional) - * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the gtin parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $limit The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. Maximum: 200 Default: 50 (optional) - * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This call will return all products that have one of the specified MPNs. MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the mpn parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $offset This parameter is reserved for internal or future use. (optional) - * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. Note: This call searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed. The keywords are handled as follows: If the keywords are separated by a comma (e.g. iPhone,256GB), the query returns products that have iPhone AND 256GB. If the keywords are separated by a space (e.g. &quot;iPhone&nbsp;ipad&quot; or &quot;iPhone,&nbsp;ipad&quot;), the query ignores any commas and returns products that have iPhone OR iPad. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the q parameter in the same call with either the gtin parameter or the mpn parameter. (optional) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) + * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. <br /><br /> Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. <br /><br /> You can determine appropriate values for the aspects by first submitting this method without this parameter. It will return either the <b>productSummaries.aspects</b> container, the <b>refinement.aspectDistributions</b> container, or both, depending on the value of the <b>fieldgroups</b> parameter in the request. The <b>productSummaries.aspects</b> container provides the category aspects and their values that are associated with each returned product. The <b>refinement.aspectDistributions</b> container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You can also use the Taxonomy API's <b>getItemAspectsForCategory</b> method to retrieve detailed information about aspects and their values that are appropriate for your selected category. </span> <br /><br /> The syntax for the <b>aspect_filter</b> parameter is as follows (on several lines for readability; <b>categoryId</b> is required): <br /><br /> <code>aspect_filter=categoryId:<i>category_id</i>,<br /> <i>aspect1</i>:{<i>valueA</i>|<i>valueB</i>|...},<br /> <i>aspect2</i>:{<i>valueC</i>|<i>valueD</i>|...},.</code> <br /><br /> A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Aspect names and values are case sensitive. </span> <br /><br /> Here is an example of an <b>aspect_filter</b> parameter in which <code>9355</code> is the category ID, <code>Color</code> is an aspect of that category, and <code>Black</code> and <code>White</code> are possible values of that aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:{White|Black}</code> <br /><br /> Here is the <b>aspect_filter</b> with required URL encoding and a second aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,<br /> Storage%20Capacity:%128GB%7C256GB%7D</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You cannot use the <b>aspect_filter</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) + * @param string $category_ids <span class=\"tablenote\"> <strong>Important:</strong> Currently, only the first <b>category_id</b> value is accepted. </span> <br /><br /> One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This parameter requires a valid category ID value. You can use the Taxonomy API's <b>getCategorySuggestions</b> method to retrieve appropriate category IDs for your product based on keywords. </span> <br /><br /> The syntax for this parameter is as follows: <br /><br /> <code>category_ids=<i>category_id1</i>,<i>category_id2</i>,.</code> <br /><br /> Here is an example of a method with the <b>category_ids</b> parameter: br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> category_ids=178893</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> If you provide only the <b>category_ids</b> parameter, you cannot specify a top-level (L1) category. </span> (optional) + * @param string $fieldgroups The type of information to return in the response. <br /><br /> <span class=\"tablenote\"> <strong>Important:</strong> This parameter may not produce valid results if you also provide more than one value for the <b>category_ids</b> parameter. It is recommended that you avoid using this combination. </span> <br /><br /> <b> Valid Values: </b> <ul> <li><code>ASPECT_REFINEMENTS</code> &mdash; This returns the <b>refinement</b> container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for <code>Ford Mustang</code>, some of the category aspects might be <b>Model Year</b>, <b>Exterior Color</b>, <b>Vehicle Mileage</b>, and so on. <br /> <br /> <span class=\"tablenote\"> <b>Note: </b>Aspects are category specific.</span> </li> <li><code>FULL</code> &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored.</li> <li><code>MATCHING_PRODUCTS</code> &mdash; This returns summaries for all products that match the values you provide for the <b>q</b> and <b>category_ids</b> parameters. This does not affect your use of the <code>ASPECT_REFINEMENTS</code> value, which you can use in the same call.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> <code>MATCHING_PRODUCTS</code> (optional) + * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>gtin</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $limit The number of product summaries to return. This is the <i>result set</i>, a subset of the full collection of products that match the search or filter criteria of this call. <br /><br /> <b>Maximum:</b> <code>200</code> <br /> <b>Default:</b> <code>50</code> (optional) + * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This method will return all products that have one of the specified MPNs. <br /><br /> MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>mpn</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $offset This parameter is reserved for internal or future use. (optional) + * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This method searches the following product record fields: <b>title</b>, <b>description</b>, <b>brand</b>, and <b>aspects.localizedName</b>, which do not include product IDs. Wildcard characters (e.g. <code>*</code>) are not allowed. </span> <br /><br /> The keywords are handled as follows: <ul> <li>If the keywords are separated by a comma (e.g. <code>iPhone,256GB</code>), the query returns products that have <code>iPhone</code> <b>AND</b> <code>256GB</code>.</li> <li>If the keywords are separated by a space (e.g. <code>\"iPhone&nbsp;ipad\"</code> or <code>\"iPhone,&nbsp;ipad\"</code>), the query ignores any commas and returns products that have <code>iPhone</code> <b>OR</b> <code>iPad</code>.</li> </ul> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>q</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> (optional) * * @throws \InvalidArgumentException * * @return \GuzzleHttp\Promise\PromiseInterface */ - public function searchAsyncWithHttpInfo($aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) + public function searchAsyncWithHttpInfo($x_ebay_c_marketplace_id = null, $aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) { $returnType = '\TNT\Ebay\Commerce\CatalogBeta\V1\Model\ProductSearchResponse'; - $request = $this->searchRequest($aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q); + $request = $this->searchRequest($x_ebay_c_marketplace_id, $aspect_filter, $category_ids, $fieldgroups, $gtin, $limit, $mpn, $offset, $q); return $this->client ->sendAsync($request, $this->createHttpClientOption()) @@ -332,20 +336,21 @@ function ($exception) { /** * Create request for operation 'search'. * - * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. You can determine appropriate values for the aspects by first submitting this call without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. Note: You can also use the Taxonomy API's getItemAspectsForCategory call to retrieve detailed information about aspects and their values that are appropriate for your selected category. The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required): aspect_filter=categoryId:category_id, aspect1:{valueA|valueB|...}, aspect2:{valueC|valueD|...},... A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. Note: Aspect names and values are case sensitive. Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:{White|Black} Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability): GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D, Storage%20Capacity:%128GB%7C256GB%7D Note: You cannot use the aspect_filter parameter in the same call with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) - * @param string $category_ids Important: Currently, only the first category_id value is accepted. One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. Note: This parameter requires a valid category ID value. You can use the Taxonomy API's getCategorySuggestions call to retrieve appropriate category IDs for your product based on keywords. The syntax for this parameter is as follows: category_ids=category_id1,category_id2,... Here is an example of a call with the category_ids parameter: GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search? category_ids=178893 Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. If you provide only the category_ids parameter, you cannot specify a top-level (L1) category. (optional) - * @param string $fieldgroups The type of information to return in the response. Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination. Valid Values: ASPECT_REFINEMENTS &mdash; This returns the refinement container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for Ford Mustang, some of the category aspects might be Model Year, Exterior Color, Vehicle Mileage, and so on. Note: Aspects are category specific. FULL &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored. MATCHING_PRODUCTS &mdash; This returns summaries for all products that match the values you provide for the q and category_ids parameters. This does not affect your use of the ASPECT_REFINEMENTS value, which you can use in the same call. Code so that your app gracefully handles any future changes to this list. Default: MATCHING_PRODUCTS (optional) - * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the gtin parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $limit The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. Maximum: 200 Default: 50 (optional) - * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This call will return all products that have one of the specified MPNs. MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the mpn parameter in the same call with either the q parameter or the aspect_filter parameter. (optional) - * @param string $offset This parameter is reserved for internal or future use. (optional) - * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. Note: This call searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed. The keywords are handled as follows: If the keywords are separated by a comma (e.g. iPhone,256GB), the query returns products that have iPhone AND 256GB. If the keywords are separated by a space (e.g. &quot;iPhone&nbsp;ipad&quot; or &quot;iPhone,&nbsp;ipad&quot;), the query ignores any commas and returns products that have iPhone OR iPad. Note: Although all query parameters are optional, this call must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value. You cannot use the q parameter in the same call with either the gtin parameter or the mpn parameter. (optional) + * @param string $x_ebay_c_marketplace_id This method also uses the <code>X-EBAY-C-MARKETPLACE-ID</code> header to identify the seller's eBay marketplace. It is required for all marketplaces except EBAY_US, which is the default. <b>Note:</b> This method is limited to <code>EBAY_US</code>, <code>EBAY_AU</code>, <code>EBAY_CA</code>, and <code>EBAY_GB</code> values. (optional) + * @param string $aspect_filter An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call. <br /><br /> Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects. <br /><br /> You can determine appropriate values for the aspects by first submitting this method without this parameter. It will return either the <b>productSummaries.aspects</b> container, the <b>refinement.aspectDistributions</b> container, or both, depending on the value of the <b>fieldgroups</b> parameter in the request. The <b>productSummaries.aspects</b> container provides the category aspects and their values that are associated with each returned product. The <b>refinement.aspectDistributions</b> container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You can also use the Taxonomy API's <b>getItemAspectsForCategory</b> method to retrieve detailed information about aspects and their values that are appropriate for your selected category. </span> <br /><br /> The syntax for the <b>aspect_filter</b> parameter is as follows (on several lines for readability; <b>categoryId</b> is required): <br /><br /> <code>aspect_filter=categoryId:<i>category_id</i>,<br /> <i>aspect1</i>:{<i>valueA</i>|<i>valueB</i>|...},<br /> <i>aspect2</i>:{<i>valueC</i>|<i>valueD</i>|...},.</code> <br /><br /> A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Aspect names and values are case sensitive. </span> <br /><br /> Here is an example of an <b>aspect_filter</b> parameter in which <code>9355</code> is the category ID, <code>Color</code> is an aspect of that category, and <code>Black</code> and <code>White</code> are possible values of that aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:{White|Black}</code> <br /><br /> Here is the <b>aspect_filter</b> with required URL encoding and a second aspect (on several lines for readability): <br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,<br /> Storage%20Capacity:%128GB%7C256GB%7D</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> You cannot use the <b>aspect_filter</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter (optional) + * @param string $category_ids <span class=\"tablenote\"> <strong>Important:</strong> Currently, only the first <b>category_id</b> value is accepted. </span> <br /><br /> One or more comma-separated category identifiers for narrowing down the collection of products returned by this call. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This parameter requires a valid category ID value. You can use the Taxonomy API's <b>getCategorySuggestions</b> method to retrieve appropriate category IDs for your product based on keywords. </span> <br /><br /> The syntax for this parameter is as follows: <br /><br /> <code>category_ids=<i>category_id1</i>,<i>category_id2</i>,.</code> <br /><br /> Here is an example of a method with the <b>category_ids</b> parameter: br /><br /> <code>GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?<br /> category_ids=178893</code> <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> If you provide only the <b>category_ids</b> parameter, you cannot specify a top-level (L1) category. </span> (optional) + * @param string $fieldgroups The type of information to return in the response. <br /><br /> <span class=\"tablenote\"> <strong>Important:</strong> This parameter may not produce valid results if you also provide more than one value for the <b>category_ids</b> parameter. It is recommended that you avoid using this combination. </span> <br /><br /> <b> Valid Values: </b> <ul> <li><code>ASPECT_REFINEMENTS</code> &mdash; This returns the <b>refinement</b> container, which includes the category aspect and aspect value distributions that apply to the returned products. For example, if you searched for <code>Ford Mustang</code>, some of the category aspects might be <b>Model Year</b>, <b>Exterior Color</b>, <b>Vehicle Mileage</b>, and so on. <br /> <br /> <span class=\"tablenote\"> <b>Note: </b>Aspects are category specific.</span> </li> <li><code>FULL</code> &mdash; This returns all the refinement containers and all the matching products. This value overrides the other values, which will be ignored.</li> <li><code>MATCHING_PRODUCTS</code> &mdash; This returns summaries for all products that match the values you provide for the <b>q</b> and <b>category_ids</b> parameters. This does not affect your use of the <code>ASPECT_REFINEMENTS</code> value, which you can use in the same call.</li> </ul> Code so that your app gracefully handles any future changes to this list. <br /><br /><b>Default: </b> <code>MATCHING_PRODUCTS</code> (optional) + * @param string $gtin A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>gtin</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $limit The number of product summaries to return. This is the <i>result set</i>, a subset of the full collection of products that match the search or filter criteria of this call. <br /><br /> <b>Maximum:</b> <code>200</code> <br /> <b>Default:</b> <code>50</code> (optional) + * @param string $mpn A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This method will return all products that have one of the specified MPNs. <br /><br /> MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>mpn</b> parameter in the same method with either the <b>q</b> parameter or the <b>aspect_filter</b> parameter. </span> (optional) + * @param string $offset This parameter is reserved for internal or future use. (optional) + * @param string $q A string consisting of one or more keywords to use to search for products in the eBay catalog. <br /><br /> <span class=\"tablenote\"> <strong>Note:</strong> This method searches the following product record fields: <b>title</b>, <b>description</b>, <b>brand</b>, and <b>aspects.localizedName</b>, which do not include product IDs. Wildcard characters (e.g. <code>*</code>) are not allowed. </span> <br /><br /> The keywords are handled as follows: <ul> <li>If the keywords are separated by a comma (e.g. <code>iPhone,256GB</code>), the query returns products that have <code>iPhone</code> <b>AND</b> <code>256GB</code>.</li> <li>If the keywords are separated by a space (e.g. <code>\"iPhone&nbsp;ipad\"</code> or <code>\"iPhone,&nbsp;ipad\"</code>), the query ignores any commas and returns products that have <code>iPhone</code> <b>OR</b> <code>iPad</code>.</li> </ul> <span class=\"tablenote\"> <strong>Note:</strong> Although all query parameters are optional, this method must include at least the <b>q</b> parameter, or the <b>category_ids</b>, <b>gtin</b>, or <b>mpn</b> parameter with a valid value. <br /><br /> You cannot use the <b>q</b> parameter in the same method with either the <b>gtin</b> parameter or the <b>mpn</b> parameter. </span> (optional) * * @throws \InvalidArgumentException * * @return \GuzzleHttp\Psr7\Request */ - public function searchRequest($aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) + public function searchRequest($x_ebay_c_marketplace_id = null, $aspect_filter = null, $category_ids = null, $fieldgroups = null, $gtin = null, $limit = null, $mpn = null, $offset = null, $q = null) { $resourcePath = '/product_summary/search'; $formParams = []; @@ -419,6 +424,11 @@ public function searchRequest($aspect_filter = null, $category_ids = null, $fiel true // explode ) ?? []); + // header params + if ($x_ebay_c_marketplace_id !== null) { + $headerParams['X-EBAY-C-MARKETPLACE-ID'] = ObjectSerializer::toHeaderValue($x_ebay_c_marketplace_id); + } + if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] diff --git a/src/Commerce/CatalogBeta/V1/Configuration.php b/src/Commerce/CatalogBeta/V1/Configuration.php index a8a1e8f0..704e733a 100644 --- a/src/Commerce/CatalogBeta/V1/Configuration.php +++ b/src/Commerce/CatalogBeta/V1/Configuration.php @@ -122,7 +122,7 @@ class Configuration * * @var string */ - protected $userAgent = 'brandon14/ebay-sdk-php/0.2.1/php'; + protected $userAgent = 'brandon14/ebay-sdk-php/0.2.2/php'; /** * Debug switch (default set to false). diff --git a/src/Commerce/CatalogBeta/V1/Model/AspectDistribution.php b/src/Commerce/CatalogBeta/V1/Model/AspectDistribution.php index 4bb63228..035d9c36 100644 --- a/src/Commerce/CatalogBeta/V1/Model/AspectDistribution.php +++ b/src/Commerce/CatalogBeta/V1/Model/AspectDistribution.php @@ -255,7 +255,7 @@ public function getAspectValueDistributions() /** * Sets aspect_value_distributions. * - * @param \TNT\Ebay\Commerce\CatalogBeta\V1\Model\AspectValueDistribution[]|null $aspect_value_distributions contains information about one or more values of the category aspect identified by localizedAspectName + * @param \TNT\Ebay\Commerce\CatalogBeta\V1\Model\AspectValueDistribution[]|null $aspect_value_distributions contains information about one or more values of the category aspect identified by localizedAspectName * * @return self */ @@ -279,7 +279,7 @@ public function getLocalizedAspectName() /** * Sets localized_aspect_name. * - * @param string|null $localized_aspect_name the localized name of an aspect that is associated with the category identified by dominantCategoryId + * @param string|null $localized_aspect_name the localized name of an aspect that is associated with the category identified by dominantCategoryId * * @return self */ diff --git a/src/Commerce/CatalogBeta/V1/Model/AspectValueDistribution.php b/src/Commerce/CatalogBeta/V1/Model/AspectValueDistribution.php index 67ab9967..4ef09c73 100644 --- a/src/Commerce/CatalogBeta/V1/Model/AspectValueDistribution.php +++ b/src/Commerce/CatalogBeta/V1/Model/AspectValueDistribution.php @@ -261,7 +261,7 @@ public function getLocalizedAspectValue() /** * Sets localized_aspect_value. * - * @param string|null $localized_aspect_value The localized value of the category aspect identified by refinement.aspectDistributions.localizedAspectName. + * @param string|null $localized_aspect_value The localized value of the category aspect identified by refinement.aspectDistributions.localizedAspectName. * * @return self */ @@ -285,7 +285,7 @@ public function getMatchCount() /** * Sets match_count. * - * @param int|null $match_count The number of times the value of localizedAspectValue has been used for eBay product listings. By comparing this quantity to the matchCount for other values of the same aspect, you can present a histogram of the values to sellers, who can use that information to select which aspect value is most appropriate for their product. You can then include the user-selected value in the the search call's aspect_filter parameter to refine your search. + * @param int|null $match_count The number of times the value of localizedAspectValue has been used for eBay product listings. By comparing this quantity to the matchCount for other values of the same aspect, you can present a histogram of the values to sellers, who can use that information to select which aspect value is most appropriate for their product. You can then include the user-selected value in the the search call's aspect_filter parameter to refine your search. * * @return self */ @@ -309,7 +309,7 @@ public function getRefinementHref() /** * Sets refinement_href. * - * @param string|null $refinement_href a HATEOAS reference that further refines the search with this particular localizedAspectValue + * @param string|null $refinement_href a HATEOAS reference that further refines the search with this particular localizedAspectValue * * @return self */ diff --git a/src/Commerce/CatalogBeta/V1/Model/Product.php b/src/Commerce/CatalogBeta/V1/Model/Product.php index db208aa5..13e8aebe 100644 --- a/src/Commerce/CatalogBeta/V1/Model/Product.php +++ b/src/Commerce/CatalogBeta/V1/Model/Product.php @@ -339,7 +339,7 @@ public function getAdditionalImages() /** * Sets additional_images. * - * @param \TNT\Ebay\Commerce\CatalogBeta\V1\Model\Image[]|null $additional_images Contains information about additional images associated with this product. For the primary image, see the image container. + * @param \TNT\Ebay\Commerce\CatalogBeta\V1\Model\Image[]|null $additional_images Contains information about additional images associated with this product. For the primary image, see the image container. * * @return self */ @@ -579,7 +579,7 @@ public function getOtherApplicableCategoryIds() /** * Sets other_applicable_category_ids. * - * @param string[]|null $other_applicable_category_ids a list of category IDs (other than the value of primaryCategoryId) for all the leaf categories to which this product might belong + * @param string[]|null $other_applicable_category_ids a list of category IDs (other than the value of primaryCategoryId) for all the leaf categories to which this product might belong * * @return self */ @@ -603,7 +603,7 @@ public function getPrimaryCategoryId() /** * Sets primary_category_id. * - * @param string|null $primary_category_id The identifier of the leaf category that eBay recommends using to list this product, based on previous listings of similar products. Products in the eBay catalog are not automatically associated with any particular category, but using an inappropriate category can make it difficult for prospective buyers to find the product. For other possible categories that might be used, see otherApplicableCategoryIds. + * @param string|null $primary_category_id The identifier of the leaf category that eBay recommends using to list this product, based on previous listings of similar products. Products in the eBay catalog are not automatically associated with any particular category, but using an inappropriate category can make it difficult for prospective buyers to find the product. For other possible categories that might be used, see otherApplicableCategoryIds. * * @return self */ diff --git a/src/Commerce/CatalogBeta/V1/Model/ProductSearchResponse.php b/src/Commerce/CatalogBeta/V1/Model/ProductSearchResponse.php index d33c2fe5..cd2f9a51 100644 --- a/src/Commerce/CatalogBeta/V1/Model/ProductSearchResponse.php +++ b/src/Commerce/CatalogBeta/V1/Model/ProductSearchResponse.php @@ -66,7 +66,7 @@ * ProductSearchResponse Class Doc Comment. * * @category Class - * @description This type contains the specifications for the collection of products that match the search or filter criteria of a search call. A maximum of 200 product summaries is returned (the result set), fewer if you include the limit query parameter in the request. + * @description This type contains the specifications for the collection of products that match the search or filter criteria of a <b>search</b> call. A maximum of 200 product summaries is returned (the result set), fewer if you include the <b>limit</b> query parameter in the request. * * @author OpenAPI Generator team * @@ -291,7 +291,7 @@ public function getHref() /** * Sets href. * - * @param string|null $href this field is reserved for internal or future use + * @param string|null $href This field is reserved for internal or future use. * * @return self */ @@ -315,7 +315,7 @@ public function getLimit() /** * Sets limit. * - * @param int|null $limit The number of product summaries returned in the response. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. If the limit query parameter was included in the request, this field will have the same value. Default: 50 + * @param int|null $limit The number of product summaries returned in the response. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call. If the limit query parameter was included in the request, this field will have the same value.

Default: 50 * * @return self */ @@ -339,7 +339,7 @@ public function getNext() /** * Sets next. * - * @param string|null $next this field is reserved for internal or future use + * @param string|null $next This field is reserved for internal or future use. * * @return self */ @@ -363,7 +363,7 @@ public function getOffset() /** * Sets offset. * - * @param int|null $offset this field is reserved for internal or future use + * @param int|null $offset This field is reserved for internal or future use. * * @return self */ @@ -387,7 +387,7 @@ public function getPrev() /** * Sets prev. * - * @param string|null $prev this field is reserved for internal or future use + * @param string|null $prev This field is reserved for internal or future use. !-- Not returned if the currently returned result set is the first set of product records from the current collection of matching products. This field contains the search call URI for the previous result set. For example, the following URI returns products 21 thru 30 from the collection of products:

path/product_summary/search?limit=10&offset=20

Note: This feature employs a zero-based list, where the first product in the list has an offset of 0. > * * @return self */ @@ -411,7 +411,7 @@ public function getProductSummaries() /** * Sets product_summaries. * - * @param \TNT\Ebay\Commerce\CatalogBeta\V1\Model\ProductSummary[]|null $product_summaries Returned if the fieldGroups query parameter was omitted from the request, or if it was included with a value of MATCHING_PRODUCTS or FULL. This container provides an array of product summaries in the current result set for products that match the combination of the q, category_ids, and aspect_filter parameters that were provided in the request. Each product summary includes information about the product's identifiers, product images, aspects, the product page URL, and the getProduct URL for retrieving the product details. + * @param \TNT\Ebay\Commerce\CatalogBeta\V1\Model\ProductSummary[]|null $product_summaries Returned if the fieldGroups query parameter was omitted from the request, or if it was included with a value of MATCHING_PRODUCTS or FULL. This container provides an array of product summaries in the current result set for products that match the combination of the q, category_ids, and aspect_filter parameters that were provided in the request. Each product summary includes information about the product's identifiers, product images, aspects, the product page URL, and the getProduct URL for retrieving the product details. * * @return self */ @@ -459,7 +459,7 @@ public function getTotal() /** * Sets total. * - * @param int|null $total this field is reserved for internal or future use + * @param int|null $total This field is reserved for internal or future use.