{ "uuid": "2c730050-761d-4e94-8d7e-2ac89f202e7e", "lastMigration": 29, "name": "Browse API", "endpointPrefix": "buy/browse/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "f1a331f5-4590-42e8-a65b-400e66a9fab1", "documentation": "This method retrieves the details of specific items that the buyer needs to make a purchasing decision. Note: This is a (Limited Release) available only to select Partners. For this method, only the following fields are returned: eligibleForInlineCheckout, estimatedAvailabilities, itemAffiliateWebURL, itemID, ItemWebURL, legacyItemID, price, sellerItemRevision, and topRatedBuyingExperience. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "method": "get", "endpoint": "item/", "responses": [ { "uuid": "8572a074-9fed-4e37-9c0d-a31e093bc591", "body": "{\n \"items\": [\n {\n \"additionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"adultOnly\": {{faker 'datatype.boolean'}},\n \"ageGroup\": \"\",\n \"availableCoupons\": [\n {\n \"constraint\": \"\",\n \"discountAmount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"discountType\": \"\",\n \"message\": \"\",\n \"redemptionCode\": \"\",\n \"termsWebUrl\": \"\"\n }\n ],\n \"bidCount\": {{faker 'number.int' max=99999}},\n \"brand\": \"\",\n \"buyingOptions\": [\n \"\"\n ],\n \"categoryId\": \"\",\n \"categoryPath\": \"\",\n \"color\": \"\",\n \"condition\": \"\",\n \"conditionDescription\": \"\",\n \"conditionId\": \"\",\n \"currentBidPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\",\n \"eligibleForInlineCheckout\": {{faker 'datatype.boolean'}},\n \"enabledForGuestCheckout\": {{faker 'datatype.boolean'}},\n \"energyEfficiencyClass\": \"\",\n \"epid\": \"\",\n \"estimatedAvailabilities\": [\n {\n \"availabilityThreshold\": {{faker 'number.int' max=99999}},\n \"availabilityThresholdType\": \"\",\n \"deliveryOptions\": [\n \"\"\n ],\n \"estimatedAvailabilityStatus\": \"\",\n \"estimatedAvailableQuantity\": {{faker 'number.int' max=99999}},\n \"estimatedSoldQuantity\": {{faker 'number.int' max=99999}}\n }\n ],\n \"gender\": \"\",\n \"gtin\": \"\",\n \"image\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"inferredEpid\": \"\",\n \"itemAffiliateWebUrl\": \"\",\n \"itemEndDate\": \"\",\n \"itemId\": \"\",\n \"itemLocation\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\"\n },\n \"itemWebUrl\": \"\",\n \"legacyItemId\": \"\",\n \"localizedAspects\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"lotSize\": {{faker 'number.int' max=99999}},\n \"marketingPrice\": {\n \"discountAmount\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"discountPercentage\": \"\",\n \"originalPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"priceTreatment\": \"\"\n },\n \"material\": \"\",\n \"minimumPriceToBid\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"mpn\": \"\",\n \"pattern\": \"\",\n \"paymentMethods\": [\n {\n \"paymentInstructions\": [\n \"\"\n ],\n \"paymentMethodBrands\": [\n {\n \"logoImage\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"paymentMethodBrandType\": \"\"\n }\n ],\n \"paymentMethodType\": \"\",\n \"sellerInstructions\": [\n \"\"\n ]\n }\n ],\n \"price\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"priceDisplayCondition\": \"\",\n \"primaryItemGroup\": {\n \"itemGroupAdditionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"itemGroupHref\": \"\",\n \"itemGroupId\": \"\",\n \"itemGroupImage\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"itemGroupTitle\": \"\",\n \"itemGroupType\": \"\"\n },\n \"primaryProductReviewRating\": {\n \"averageRating\": \"\",\n \"ratingHistograms\": [\n {\n \"count\": {{faker 'number.int' max=99999}},\n \"rating\": \"\"\n }\n ],\n \"reviewCount\": {{faker 'number.int' max=99999}}\n },\n \"product\": {\n \"additionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"additionalProductIdentities\": [\n {\n \"productIdentity\": [\n {\n \"identifierType\": \"\",\n \"identifierValue\": \"\"\n }\n ]\n }\n ],\n \"aspectGroups\": [\n {\n \"aspects\": [\n {\n \"localizedName\": \"\",\n \"localizedValues\": [\n \"\"\n ]\n }\n ],\n \"localizedGroupName\": \"\"\n }\n ],\n \"brand\": \"\",\n \"description\": \"\",\n \"gtins\": [\n \"\"\n ],\n \"image\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"mpns\": [\n \"\"\n ],\n \"title\": \"\"\n },\n \"productFicheWebUrl\": \"\",\n \"qualifiedPrograms\": [\n \"\"\n ],\n \"quantityLimitPerBuyer\": {{faker 'number.int' max=99999}},\n \"reservePriceMet\": {{faker 'datatype.boolean'}},\n \"returnTerms\": {\n \"extendedHolidayReturnsOffered\": {{faker 'datatype.boolean'}},\n \"refundMethod\": \"\",\n \"restockingFeePercentage\": \"\",\n \"returnInstructions\": \"\",\n \"returnMethod\": \"\",\n \"returnPeriod\": {\n \"unit\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"returnShippingCostPayer\": \"\",\n \"returnsAccepted\": {{faker 'datatype.boolean'}}\n },\n \"seller\": {\n \"feedbackPercentage\": \"\",\n \"feedbackScore\": {{faker 'number.int' max=99999}},\n \"sellerAccountType\": \"\",\n \"sellerLegalInfo\": {\n \"email\": \"\",\n \"fax\": \"\",\n \"imprint\": \"\",\n \"legalContactFirstName\": \"\",\n \"legalContactLastName\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"registrationNumber\": \"\",\n \"sellerProvidedLegalAddress\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\"\n },\n \"termsOfService\": \"\",\n \"vatDetails\": [\n {\n \"issuingCountry\": \"\",\n \"vatId\": \"\"\n }\n ]\n },\n \"username\": \"\"\n },\n \"sellerItemRevision\": \"\",\n \"shipToLocations\": {\n \"regionExcluded\": [\n {\n \"regionId\": \"\",\n \"regionName\": \"\",\n \"regionType\": \"\"\n }\n ],\n \"regionIncluded\": [\n {\n \"regionId\": \"\",\n \"regionName\": \"\",\n \"regionType\": \"\"\n }\n ]\n },\n \"shippingOptions\": [\n {\n \"additionalShippingCostPerUnit\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"cutOffDateUsedForEstimate\": \"\",\n \"fulfilledThrough\": \"\",\n \"guaranteedDelivery\": {{faker 'datatype.boolean'}},\n \"importCharges\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"maxEstimatedDeliveryDate\": \"\",\n \"minEstimatedDeliveryDate\": \"\",\n \"quantityUsedForEstimate\": {{faker 'number.int' max=99999}},\n \"shipToLocationUsedForEstimate\": {\n \"country\": \"\",\n \"postalCode\": \"\"\n },\n \"shippingCarrierCode\": \"\",\n \"shippingCost\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"shippingCostType\": \"\",\n \"shippingServiceCode\": \"\",\n \"trademarkSymbol\": \"\",\n \"type\": \"\"\n }\n ],\n \"shortDescription\": \"\",\n \"size\": \"\",\n \"sizeSystem\": \"\",\n \"sizeType\": \"\",\n \"subtitle\": \"\",\n \"taxes\": [\n {\n \"ebayCollectAndRemitTax\": {{faker 'datatype.boolean'}},\n \"includedInPrice\": {{faker 'datatype.boolean'}},\n \"shippingAndHandlingTaxed\": {{faker 'datatype.boolean'}},\n \"taxJurisdiction\": {\n \"region\": {\n \"regionName\": \"\",\n \"regionType\": \"\"\n },\n \"taxJurisdictionId\": \"\"\n },\n \"taxPercentage\": \"\",\n \"taxType\": \"\"\n }\n ],\n \"title\": \"\",\n \"topRatedBuyingExperience\": {{faker 'datatype.boolean'}},\n \"uniqueBidderCount\": {{faker 'number.int' max=99999}},\n \"unitPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"unitPricingMeasure\": \"\"\n }\n ],\n \"total\": {{faker 'number.int' max=99999}},\n \"warnings\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7273057b-c7dd-40ff-a40d-62e7329eb9b1", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dce13e4b-922e-4381-95a3-8d6e95f476d1", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "18104f12-e1b3-4f58-9b73-3c7603f5aa8c", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "11897ab3-11a5-4077-ab28-7816b7d98ab2", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5aece3df-e85d-4bc1-bfab-0f2ca14aef07", "documentation": "This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item" and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods. For more information about how to use legacy ids with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child of an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. The fieldgroups URI parameter lets you control what is returned in the response. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. For more information, see fieldgroups. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "method": "get", "endpoint": "item/get_item_by_legacy_id", "responses": [ { "uuid": "076b2bbb-79f2-48ac-800f-bc7291c16243", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "130cf26c-d042-46c9-9808-1843e8533c0c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "63779a9a-a901-446b-92cd-d64fdd478df3", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1f2a6ef9-2572-43b0-aaf5-c04a59489eaa", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2cdc6db3-df49-44f3-b9ef-fc81e6218a48", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5070d0d-640e-407f-a6ec-69354b0a92f1", "documentation": "This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. This method returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in the group. The commonDescriptions container has an array of containers for a description and the item ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_items_by_item_group/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "method": "get", "endpoint": "item/get_items_by_item_group", "responses": [ { "uuid": "68db83d4-8828-44b7-99b7-48d8906b9d70", "body": "{\n \"commonDescriptions\": [\n {\n \"description\": \"\",\n \"itemIds\": [\n \"\"\n ]\n }\n ],\n \"items\": [\n {\n \"additionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"adultOnly\": {{faker 'datatype.boolean'}},\n \"ageGroup\": \"\",\n \"availableCoupons\": [\n {\n \"constraint\": \"\",\n \"discountAmount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"discountType\": \"\",\n \"message\": \"\",\n \"redemptionCode\": \"\",\n \"termsWebUrl\": \"\"\n }\n ],\n \"bidCount\": {{faker 'number.int' max=99999}},\n \"brand\": \"\",\n \"buyingOptions\": [\n \"\"\n ],\n \"categoryId\": \"\",\n \"categoryPath\": \"\",\n \"color\": \"\",\n \"condition\": \"\",\n \"conditionDescription\": \"\",\n \"conditionId\": \"\",\n \"currentBidPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\",\n \"eligibleForInlineCheckout\": {{faker 'datatype.boolean'}},\n \"enabledForGuestCheckout\": {{faker 'datatype.boolean'}},\n \"energyEfficiencyClass\": \"\",\n \"epid\": \"\",\n \"estimatedAvailabilities\": [\n {\n \"availabilityThreshold\": {{faker 'number.int' max=99999}},\n \"availabilityThresholdType\": \"\",\n \"deliveryOptions\": [\n \"\"\n ],\n \"estimatedAvailabilityStatus\": \"\",\n \"estimatedAvailableQuantity\": {{faker 'number.int' max=99999}},\n \"estimatedSoldQuantity\": {{faker 'number.int' max=99999}}\n }\n ],\n \"gender\": \"\",\n \"gtin\": \"\",\n \"image\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"inferredEpid\": \"\",\n \"itemAffiliateWebUrl\": \"\",\n \"itemEndDate\": \"\",\n \"itemId\": \"\",\n \"itemLocation\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\"\n },\n \"itemWebUrl\": \"\",\n \"legacyItemId\": \"\",\n \"localizedAspects\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"lotSize\": {{faker 'number.int' max=99999}},\n \"marketingPrice\": {\n \"discountAmount\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"discountPercentage\": \"\",\n \"originalPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"priceTreatment\": \"\"\n },\n \"material\": \"\",\n \"minimumPriceToBid\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"mpn\": \"\",\n \"pattern\": \"\",\n \"paymentMethods\": [\n {\n \"paymentInstructions\": [\n \"\"\n ],\n \"paymentMethodBrands\": [\n {\n \"logoImage\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"paymentMethodBrandType\": \"\"\n }\n ],\n \"paymentMethodType\": \"\",\n \"sellerInstructions\": [\n \"\"\n ]\n }\n ],\n \"price\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"priceDisplayCondition\": \"\",\n \"primaryItemGroup\": {\n \"itemGroupAdditionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"itemGroupHref\": \"\",\n \"itemGroupId\": \"\",\n \"itemGroupImage\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"itemGroupTitle\": \"\",\n \"itemGroupType\": \"\"\n },\n \"primaryProductReviewRating\": {\n \"averageRating\": \"\",\n \"ratingHistograms\": [\n {\n \"count\": {{faker 'number.int' max=99999}},\n \"rating\": \"\"\n }\n ],\n \"reviewCount\": {{faker 'number.int' max=99999}}\n },\n \"product\": {\n \"additionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"additionalProductIdentities\": [\n {\n \"productIdentity\": [\n {\n \"identifierType\": \"\",\n \"identifierValue\": \"\"\n }\n ]\n }\n ],\n \"aspectGroups\": [\n {\n \"aspects\": [\n {\n \"localizedName\": \"\",\n \"localizedValues\": [\n \"\"\n ]\n }\n ],\n \"localizedGroupName\": \"\"\n }\n ],\n \"brand\": \"\",\n \"description\": \"\",\n \"gtins\": [\n \"\"\n ],\n \"image\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"mpns\": [\n \"\"\n ],\n \"title\": \"\"\n },\n \"productFicheWebUrl\": \"\",\n \"qualifiedPrograms\": [\n \"\"\n ],\n \"quantityLimitPerBuyer\": {{faker 'number.int' max=99999}},\n \"reservePriceMet\": {{faker 'datatype.boolean'}},\n \"returnTerms\": {\n \"extendedHolidayReturnsOffered\": {{faker 'datatype.boolean'}},\n \"refundMethod\": \"\",\n \"restockingFeePercentage\": \"\",\n \"returnInstructions\": \"\",\n \"returnMethod\": \"\",\n \"returnPeriod\": {\n \"unit\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"returnShippingCostPayer\": \"\",\n \"returnsAccepted\": {{faker 'datatype.boolean'}}\n },\n \"seller\": {\n \"feedbackPercentage\": \"\",\n \"feedbackScore\": {{faker 'number.int' max=99999}},\n \"sellerAccountType\": \"\",\n \"sellerLegalInfo\": {\n \"email\": \"\",\n \"fax\": \"\",\n \"imprint\": \"\",\n \"legalContactFirstName\": \"\",\n \"legalContactLastName\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"registrationNumber\": \"\",\n \"sellerProvidedLegalAddress\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"countryName\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\"\n },\n \"termsOfService\": \"\",\n \"vatDetails\": [\n {\n \"issuingCountry\": \"\",\n \"vatId\": \"\"\n }\n ]\n },\n \"username\": \"\"\n },\n \"sellerItemRevision\": \"\",\n \"shipToLocations\": {\n \"regionExcluded\": [\n {\n \"regionId\": \"\",\n \"regionName\": \"\",\n \"regionType\": \"\"\n }\n ],\n \"regionIncluded\": [\n {\n \"regionId\": \"\",\n \"regionName\": \"\",\n \"regionType\": \"\"\n }\n ]\n },\n \"shippingOptions\": [\n {\n \"additionalShippingCostPerUnit\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"cutOffDateUsedForEstimate\": \"\",\n \"fulfilledThrough\": \"\",\n \"guaranteedDelivery\": {{faker 'datatype.boolean'}},\n \"importCharges\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"maxEstimatedDeliveryDate\": \"\",\n \"minEstimatedDeliveryDate\": \"\",\n \"quantityUsedForEstimate\": {{faker 'number.int' max=99999}},\n \"shipToLocationUsedForEstimate\": {\n \"country\": \"\",\n \"postalCode\": \"\"\n },\n \"shippingCarrierCode\": \"\",\n \"shippingCost\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"shippingCostType\": \"\",\n \"shippingServiceCode\": \"\",\n \"trademarkSymbol\": \"\",\n \"type\": \"\"\n }\n ],\n \"shortDescription\": \"\",\n \"size\": \"\",\n \"sizeSystem\": \"\",\n \"sizeType\": \"\",\n \"subtitle\": \"\",\n \"taxes\": [\n {\n \"ebayCollectAndRemitTax\": {{faker 'datatype.boolean'}},\n \"includedInPrice\": {{faker 'datatype.boolean'}},\n \"shippingAndHandlingTaxed\": {{faker 'datatype.boolean'}},\n \"taxJurisdiction\": {\n \"region\": {\n \"regionName\": \"\",\n \"regionType\": \"\"\n },\n \"taxJurisdictionId\": \"\"\n },\n \"taxPercentage\": \"\",\n \"taxType\": \"\"\n }\n ],\n \"title\": \"\",\n \"topRatedBuyingExperience\": {{faker 'datatype.boolean'}},\n \"uniqueBidderCount\": {{faker 'number.int' max=99999}},\n \"unitPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"unitPricingMeasure\": \"\",\n \"warnings\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n }\n ],\n \"warnings\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "70ad0b64-c7b1-4954-9a67-d35ba0259bfe", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d436d9f4-6d7a-4f21-a15c-fab3a235410d", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b57ad518-185e-47e2-9ce1-4356cf8e5900", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "da5e1ba9-1284-4595-a4aa-7d150959859a", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "16827699-4546-4128-9a4a-99bc13c98db9", "documentation": "This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision. The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the fieldgroups URI parameter. This parameter lets you control what is returned in the response. Setting fieldgroups to COMPACT reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. You can use either COMPACT or PRODUCT but not both. For more information, see fieldgroups. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "method": "get", "endpoint": "item/:item_id", "responses": [ { "uuid": "b24cc0dd-fe5f-44ee-8f84-cada185dadbb", "body": "", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0c6bf492-7da8-4590-958f-5886bfc560e7", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c8a0f720-6b5c-4aae-abd3-f609344be74b", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "785a7d3f-9239-46fa-a203-465ece8b6ce2", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4ab66e3b-0460-4a2e-81a0-147ed32f91a5", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "76d4c5b6-0650-4da6-84ed-ceb33bc05e0f", "documentation": "This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. For example, to check the compatibility of a part, you pass in the item ID of the part as a URI parameter and specify all the attributes used to define a specific car in the compatibilityProperties container. If the call is successful, the response will be COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED. See compatibilityStatus for details. Note: The only products supported are cars, trucks, and motorcycles. To find the attributes and values for a specific marketplace, you can use the compatibility methods in the Taxonomy API. You can use this data to create menus to help buyers specify the product, such as their car. For more details and a list of the required attributes for the US marketplace that describe motor vehicles, see Check compatibility in the Buy Integration Guide. For an example, see the Samples section. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Note: This method is supported only on Production. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "method": "post", "endpoint": "item/:item_id/check_compatibility", "responses": [ { "uuid": "636dbecf-26bd-4f54-9efb-85e813c66cd8", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e4f91743-4af7-47aa-9032-1e2ba3a83bb3", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "04c4177c-d443-42e5-86f6-0c40e2863141", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8432eadf-23c4-4d62-8512-6fabfc774afb", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f48ae2a1-c96a-4883-a0d5-f7c827242269", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c20f54fa-4e77-4dc0-8fcf-76f848215077", "documentation": "This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. Note: Only FIXED_PRICE (Buy It Now) items are returned by default. However, this method does return items where both FIXED_PRICE and AUCTION are available as a buying option. After a bid has been placed, items become active auction items and are no longer returned by default, but they remain accessible by filtering for the AUCTION buying option. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the fieldgroups parameter. Filtering by item aspects and other refinements using the aspect_filter parameter. Filtering for items that are compatible with a specific product, using the compatibility_filter parameter. Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by "Best Match". For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item_summary/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item_summary/ Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "method": "get", "endpoint": "item_summary/search", "responses": [ { "uuid": "65c618df-5a83-47cf-9aa9-a68dd2cacce0", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fe7fd326-a6d2-4f26-87d7-4fb222072eaa", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b446153d-9155-4ac7-bbfb-1cd338975899", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "11ae9a42-30ee-4c1b-b0d9-eb1b3ba8076d", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "030d4766-6750-4a99-8bc0-0cf40712cae3", "documentation": "This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or eBay product ID (ePID), or a combination of these using URI parameters. To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter. This method also supports the following: Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter. Filtering by item aspects using the aspect_filter parameter. For details and examples of these capabilities, see Browse API in the Buying Integration Guide. Pagination and sort controls There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by "Best Match". For more information about Best Match, see the eBay help page Best Match. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item_summary/search_by_image/ Sandbox URL: Due to the data available, this method is not supported in the eBay Sandbox. To test your integration, use the Production URL. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. URL Encoding for Parameters Query parameter values need to be URL encoded. For details, see URL encoding query parameter values. For readability, code examples in this document have not been URL encoded. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "method": "post", "endpoint": "item_summary/search_by_image", "responses": [ { "uuid": "e8bc2a93-0c8f-451a-839d-76427e0e8e4a", "body": "{\n \"autoCorrections\": {\n \"q\": \"\"\n },\n \"href\": \"\",\n \"itemSummaries\": [\n {\n \"additionalImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"adultOnly\": {{faker 'datatype.boolean'}},\n \"availableCoupons\": {{faker 'datatype.boolean'}},\n \"bidCount\": {{faker 'number.int' max=99999}},\n \"buyingOptions\": [\n \"\"\n ],\n \"categories\": [\n {\n \"categoryId\": \"\"\n }\n ],\n \"compatibilityMatch\": \"\",\n \"compatibilityProperties\": [\n {\n \"localizedName\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"condition\": \"\",\n \"conditionId\": \"\",\n \"currentBidPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"distanceFromPickupLocation\": {\n \"unitOfMeasure\": \"\",\n \"value\": \"\"\n },\n \"energyEfficiencyClass\": \"\",\n \"epid\": \"\",\n \"image\": {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"itemAffiliateWebUrl\": \"\",\n \"itemGroupHref\": \"\",\n \"itemGroupType\": \"\",\n \"itemHref\": \"\",\n \"itemId\": \"\",\n \"itemLocation\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\"\n },\n \"itemWebUrl\": \"\",\n \"legacyItemId\": \"\",\n \"marketingPrice\": {\n \"discountAmount\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"discountPercentage\": \"\",\n \"originalPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"priceTreatment\": \"\"\n },\n \"pickupOptions\": [\n {\n \"pickupLocationType\": \"\"\n }\n ],\n \"price\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"priceDisplayCondition\": \"\",\n \"qualifiedPrograms\": [\n \"\"\n ],\n \"seller\": {\n \"feedbackPercentage\": \"\",\n \"feedbackScore\": {{faker 'number.int' max=99999}},\n \"sellerAccountType\": \"\",\n \"username\": \"\"\n },\n \"shippingOptions\": [\n {\n \"guaranteedDelivery\": {{faker 'datatype.boolean'}},\n \"maxEstimatedDeliveryDate\": \"\",\n \"minEstimatedDeliveryDate\": \"\",\n \"shippingCost\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"shippingCostType\": \"\"\n }\n ],\n \"shortDescription\": \"\",\n \"thumbnailImages\": [\n {\n \"height\": {{faker 'number.int' max=99999}},\n \"imageUrl\": \"\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"title\": \"\",\n \"unitPrice\": {\n \"convertedFromCurrency\": \"\",\n \"convertedFromValue\": \"\",\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"unitPricingMeasure\": \"\"\n }\n ],\n \"limit\": {{faker 'number.int' max=99999}},\n \"next\": \"\",\n \"offset\": {{faker 'number.int' max=99999}},\n \"prev\": \"\",\n \"refinement\": {\n \"aspectDistributions\": [\n {\n \"aspectValueDistributions\": [\n {\n \"localizedAspectValue\": \"\",\n \"matchCount\": {{faker 'number.int' max=99999}},\n \"refinementHref\": \"\"\n }\n ],\n \"localizedAspectName\": \"\"\n }\n ],\n \"buyingOptionDistributions\": [\n {\n \"buyingOption\": \"\",\n \"matchCount\": {{faker 'number.int' max=99999}},\n \"refinementHref\": \"\"\n }\n ],\n \"categoryDistributions\": [\n {\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"matchCount\": {{faker 'number.int' max=99999}},\n \"refinementHref\": \"\"\n }\n ],\n \"conditionDistributions\": [\n {\n \"condition\": \"\",\n \"conditionId\": \"\",\n \"matchCount\": {{faker 'number.int' max=99999}},\n \"refinementHref\": \"\"\n }\n ],\n \"dominantCategoryId\": \"\"\n },\n \"total\": {{faker 'number.int' max=99999}},\n \"warnings\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "16693d76-cc21-4cbd-a1ca-31e09d65ef34", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "288eb4cd-705b-417c-8931-f5bf3d81f800", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3166715e-a2cd-4cb9-ba6f-b1dd6cefd5f0", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "097a0e7c-5049-4760-a3c2-aa09f979c375", "documentation": "This is an experimental method. This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. There are no URI parameters or request payload. The response returns the summary details of all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If the cart is empty, the response is HTTP 204. The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.", "method": "get", "endpoint": "shopping_cart/", "responses": [ { "uuid": "eaabea04-1dc7-4fc5-9e7b-b1b18bd6ffe2", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "05e06414-96df-48f3-8dcb-0d283f2ed2f2", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d70b7ce-3ed8-49d0-8eaa-98535fdef545", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b3333e61-620e-496e-a898-65d30931b9ce", "body": "", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4ccf0368-ea7b-4ada-a97c-b3087c683779", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bea7b987-de95-45f2-bd4e-67d245670936", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b52f6783-4fac-419d-b937-dd7409f67c87", "documentation": "This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never expires, any item added to the cart will remain in the cart until it is removed. To use this method, you must submit a RESTful item ID and the quantity of the item. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, whether it has just been added to the cart or has been in the cart for some time, the item will be returned in the unavailableCartItems container. Note: There are differences between how legacy APIs, such as Finding, and RESTful APIs, such as Browse, return the identifier of an "item" and what the item ID represents. If you have an item ID from one of the legacy APIs, you can use the legacy item ID with the getItemByLegacyId method to retrieve the RESTful ID for that item. For more information about how to use legacy IDs with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. You can add only items with a FIXED_PRICE that accept PayPal as a payment. For a list of supported sites and other restrictions, see API Restrictions.", "method": "post", "endpoint": "shopping_cart/add_item", "responses": [ { "uuid": "cbf2c9fd-3a69-4711-9e58-cc55a49364bd", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5a9bf1d4-69b8-482f-aa41-c03fe087832a", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "891faae5-cdd7-4617-95ab-d37e6069fc5b", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1088eed2-bc53-418c-ae2d-44bbf88331eb", "body": "", "latency": 0, "statusCode": 403, "label": "Insufficient permissions to fulfill the request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8b667a76-b8d8-4d66-b09e-ee4fcaf633e0", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b1f484c-d5d8-4ff8-b044-53c21b328810", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e6f21e31-d13f-4834-9179-6a0ea674dda2", "documentation": "This is an experimental method. This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (cartItemId) that you want to remove. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If you remove the last item in the cart, the response is HTTP 204. The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.", "method": "post", "endpoint": "shopping_cart/remove_item", "responses": [ { "uuid": "ba8deaf0-7936-4ac5-8d6c-43c1b4f94276", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b25db504-e02b-4e3c-aae6-8ef9e52b65f6", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "20c572b6-c742-4bf7-ae9c-aca474e30031", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e952896c-7f64-411f-b0b8-84ee53f2f4be", "body": "", "latency": 0, "statusCode": 403, "label": "Insufficient permissions to fulfill the request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8cb26216-e40d-4a67-9efb-9f24f55c2cac", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cf0b11bd-6394-4e3c-b34e-c8db93a916b1", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "af42f797-dd19-499f-a77b-01f99e7ffa92", "documentation": "This is an experimental method. This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the cart (cartItemId) and the new value for the quantity. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15. The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container. Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/shopping_cart/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/shopping_cart/ Note: This method is not available in the eBay API Explorer. Restrictions This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.", "method": "post", "endpoint": "shopping_cart/update_quantity", "responses": [ { "uuid": "28f8f284-1287-4dd9-915f-8a5698568d7b", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1b1d465d-b30c-45d2-93cf-24053aa4f7a1", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "48ab453c-a43e-435d-8f16-382ea677bb00", "body": "", "latency": 0, "statusCode": 403, "label": "Insufficient permissions to fulfill the request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a41655d2-de7a-440c-96cd-42b6ce5db979", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "591f5722-69f6-4546-9709-ad2d9fceac06", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "f1a331f5-4590-42e8-a65b-400e66a9fab1" }, { "type": "route", "uuid": "5aece3df-e85d-4bc1-bfab-0f2ca14aef07" }, { "type": "route", "uuid": "e5070d0d-640e-407f-a6ec-69354b0a92f1" }, { "type": "route", "uuid": "16827699-4546-4128-9a4a-99bc13c98db9" }, { "type": "route", "uuid": "76d4c5b6-0650-4da6-84ed-ceb33bc05e0f" }, { "type": "route", "uuid": "c20f54fa-4e77-4dc0-8fcf-76f848215077" }, { "type": "route", "uuid": "030d4766-6750-4a99-8bc0-0cf40712cae3" }, { "type": "route", "uuid": "097a0e7c-5049-4760-a3c2-aa09f979c375" }, { "type": "route", "uuid": "b52f6783-4fac-419d-b937-dd7409f67c87" }, { "type": "route", "uuid": "e6f21e31-d13f-4834-9179-6a0ea674dda2" }, { "type": "route", "uuid": "af42f797-dd19-499f-a77b-01f99e7ffa92" } ] }