Skip to content

Commit

Permalink
Merge pull request #3 from brandon14/release/0.2.2
Browse files Browse the repository at this point in the history 
Release 0.2.2
  • Loading branch information
@brandon14
brandon14 committed Dec 12, 2022
2 parents 572615f + d98bd09 commit 8645ba5
Show file tree
Hide file tree
Showing 1,112 changed files with 37,931 additions and 17,220 deletions.
20 changes: 14 additions & 6 deletions api-specs/buy_browse_v1_oas3.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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. <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'
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. <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
required: false
schema:
type: string
Expand Down Expand Up @@ -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 <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: The unique identifier of the category.
categoryName:
type: string
description: The name of the category.
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.
CategoryDistribution:
type: object
properties:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 (<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.
fulfilledThrough:
type: string
description: 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>
description: 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>
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 <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.
Expand Down
16 changes: 8 additions & 8 deletions api-specs/buy_feed_v1_beta_oas3.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ paths:
get:
tags:
- item
description: '<p>This method lets you download a TSV_GZIP (tab separated value gzip) <b> Item</b> feed file. The feed file contains all the items from <b> all</b> 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 <a href="/api-docs/buy/feed/resources/item/methods/getItemFeed#h3-response-fields">Response fields</a> section. </p> <p> There are two types of item feed files generated: <ul> <li>A daily <b>Item</b> feed file containing all the newly listed items for a specific category, date, and marketplace (<b>feed_scope</b> = <code>NEWLY_LISTED</code>)</li> <li>A weekly <b>Item Bootstrap</b> feed file containing <i> all</i> the items in a specific category and marketplace (<b>feed_scope</b> = <code>ALL_ACTIVE</code>)</li> </ul> </p> <p><span class="tablenote"><b>Note: </b> Filters are applied to the feed files. For details, see <a href="/api-docs/buy/static/api-feed.html#feed-filters">Feed File Filters</a>. 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.</span></p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/feed/v1_beta/item?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/feed/v1_beta/item?</code></li> </ul> </p> <h3><b>Downloading feed files </b></h3> <p>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 <a href="#range-header">Range</a> request header. The <a href="#content-range">Content-range</a> 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 <a href="/api-docs/buy/static/api-feed.html#retrv-gzip">Retrieving a gzip feed file</a>. </p> <p>In addition to the API, there is an open source <a href="https://github.com/eBay/FeedSDK" target="_blank">Feed SDK</a> 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.</p> <p><span class="tablenote"> <b> Note:</b> 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.</span> </p> <h3><b>Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/feed/overview.html#API">API Restrictions</a>.</p>'
description: '<p>This method lets you download a TSV_GZIP (tab separated value gzip) <b> Item</b> feed file. The feed file contains all the items from <b> all</b> 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 <a href="/api-docs/buy/feed/resources/item/methods/getItemFeed#h3-response-fields">Response fields</a> section. </p> <p> There are two types of item feed files generated: <ul> <li>A daily <b>Item</b> feed file containing all the newly listed items for a specific category, date, and marketplace (<b>feed_scope</b> = <code>NEWLY_LISTED</code>)</li> <li>A weekly <b>Item Bootstrap</b> feed file containing <i> all</i> the items in a specific category and marketplace (<b>feed_scope</b> = <code>ALL_ACTIVE</code>)</li> </ul> </p> <p><span class="tablenote"><b>Note: </b> Filters are applied to the feed files. For details, see <a href="/api-docs/buy/static/api-feed_beta.html#Feed2">Feed File Filters</a>. 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.</span></p> <h3><b>URLs for this method</b></h3> <p><ul> <li><b> Production URL: </b> <code>https://api.ebay.com/buy/feed/v1_beta/item?</code></li> <li><b> Sandbox URL: </b><code>https://api.sandbox.ebay.com/buy/feed/v1_beta/item?</code></li> </ul> </p> <h3><b>Downloading feed files </b></h3> <p>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 <a href="#range-header">Range</a> request header. The <a href="#content-range">Content-range</a> 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 <a href="/api-docs/buy/static/api-feed.html#retrv-gzip">Retrieving a gzip feed file</a>. </p> <p>In addition to the API, there is an open source <a href="https://github.com/eBay/FeedSDK" target="_blank">Feed SDK</a> 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.</p> <p><span class="tablenote"> <b> Note:</b> 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.</span> </p> <h3><b>Restrictions </b></h3> <p>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/feed/overview.html#API">API Restrictions</a>.</p>'
operationId: getItemFeed
parameters:
- name: Accept
Expand Down Expand Up @@ -92,7 +92,7 @@ paths:
schema:
$ref: '#/components/schemas/ItemResponse'
'400':
description: Bad Request
description: Bad request
x-response-codes:
errors:
'13000':
Expand Down Expand Up @@ -269,7 +269,7 @@ paths:
schema:
$ref: '#/components/schemas/ItemGroupResponse'
'400':
description: Bad Request
description: Bad request
x-response-codes:
errors:
'13000':
Expand Down Expand Up @@ -359,7 +359,7 @@ paths:
'416':
description: Range not satisfiable
'500':
description: Internal Server Error
description: Internal server error
x-response-codes:
errors:
'13006':
Expand Down Expand Up @@ -440,7 +440,7 @@ paths:
schema:
$ref: '#/components/schemas/ItemSnapshotResponse'
'400':
description: Bad Request
description: Bad request
x-response-codes:
errors:
'13000':
Expand Down Expand Up @@ -522,7 +522,7 @@ paths:
'416':
description: Range not satisfiable
'500':
description: Internal Server Error
description: Internal server error
x-response-codes:
errors:
'13006':
Expand Down Expand Up @@ -603,7 +603,7 @@ paths:
schema:
$ref: '#/components/schemas/ItemPriorityResponse'
'400':
description: Bad Request
description: Bad request
x-response-codes:
errors:
'13000':
Expand Down Expand Up @@ -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':
Expand Down
2 changes: 1 addition & 1 deletion api-specs/buy_feed_v1_oas3.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8645ba5

Please sign in to comment.