ebay-api 8.5.1 → 8.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/api/apiFactory.d.ts +0 -3
- package/dist/api/apiFactory.js +0 -4
- package/dist/api/base.d.ts +0 -3
- package/dist/api/base.js +0 -3
- package/dist/api/digitalSignature.d.ts +0 -33
- package/dist/api/digitalSignature.js +1 -41
- package/dist/api/index.d.ts +0 -3
- package/dist/api/index.js +0 -3
- package/dist/api/restful/buy/browse/index.d.ts +0 -66
- package/dist/api/restful/buy/browse/index.js +0 -73
- package/dist/api/restful/buy/deal/index.d.ts +0 -32
- package/dist/api/restful/buy/deal/index.js +0 -32
- package/dist/api/restful/buy/feed/index.d.ts +0 -33
- package/dist/api/restful/buy/feed/index.js +0 -33
- package/dist/api/restful/buy/marketing/index.d.ts +0 -18
- package/dist/api/restful/buy/marketing/index.js +0 -22
- package/dist/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
- package/dist/api/restful/buy/marketplaceInsights/index.js +0 -21
- package/dist/api/restful/buy/offer/index.d.ts +0 -15
- package/dist/api/restful/buy/offer/index.js +0 -15
- package/dist/api/restful/buy/order/index.d.ts +0 -227
- package/dist/api/restful/buy/order/index.js +0 -227
- package/dist/api/restful/commerce/catalog/index.d.ts +0 -54
- package/dist/api/restful/commerce/catalog/index.js +0 -54
- package/dist/api/restful/commerce/charity/index.d.ts +0 -21
- package/dist/api/restful/commerce/charity/index.js +0 -21
- package/dist/api/restful/commerce/identity/index.d.ts +0 -7
- package/dist/api/restful/commerce/identity/index.js +0 -7
- package/dist/api/restful/commerce/notification/index.d.ts +0 -93
- package/dist/api/restful/commerce/notification/index.js +0 -93
- package/dist/api/restful/commerce/taxonomy/index.d.ts +0 -64
- package/dist/api/restful/commerce/taxonomy/index.js +0 -64
- package/dist/api/restful/commerce/translation/index.d.ts +0 -8
- package/dist/api/restful/commerce/translation/index.js +0 -8
- package/dist/api/restful/developer/analytics/index.d.ts +0 -15
- package/dist/api/restful/developer/analytics/index.js +0 -15
- package/dist/api/restful/developer/keyManagement/index.d.ts +0 -15
- package/dist/api/restful/developer/keyManagement/index.js +0 -15
- package/dist/api/restful/index.d.ts +0 -16
- package/dist/api/restful/index.js +1 -23
- package/dist/api/restful/postOrder/cancellation/index.d.ts +0 -43
- package/dist/api/restful/postOrder/cancellation/index.js +1 -46
- package/dist/api/restful/postOrder/case/index.d.ts +0 -46
- package/dist/api/restful/postOrder/case/index.js +0 -46
- package/dist/api/restful/postOrder/inquiry/index.d.ts +0 -64
- package/dist/api/restful/postOrder/inquiry/index.js +0 -64
- package/dist/api/restful/postOrder/return/index.d.ts +0 -190
- package/dist/api/restful/postOrder/return/index.js +0 -190
- package/dist/api/restful/sell/account/index.d.ts +0 -241
- package/dist/api/restful/sell/account/index.js +0 -241
- package/dist/api/restful/sell/analytics/index.d.ts +0 -26
- package/dist/api/restful/sell/analytics/index.js +0 -26
- package/dist/api/restful/sell/compliance/index.d.ts +0 -23
- package/dist/api/restful/sell/compliance/index.js +0 -23
- package/dist/api/restful/sell/feed/index.d.ts +0 -135
- package/dist/api/restful/sell/feed/index.js +0 -135
- package/dist/api/restful/sell/finances/index.d.ts +0 -51
- package/dist/api/restful/sell/finances/index.js +0 -51
- package/dist/api/restful/sell/fulfillment/index.d.ts +0 -108
- package/dist/api/restful/sell/fulfillment/index.js +0 -108
- package/dist/api/restful/sell/inventory/index.d.ts +0 -197
- package/dist/api/restful/sell/inventory/index.js +0 -197
- package/dist/api/restful/sell/listing/index.d.ts +0 -8
- package/dist/api/restful/sell/listing/index.js +0 -8
- package/dist/api/restful/sell/logistics/index.d.ts +0 -33
- package/dist/api/restful/sell/logistics/index.js +0 -33
- package/dist/api/restful/sell/marketing/index.d.ts +16 -495
- package/dist/api/restful/sell/marketing/index.js +48 -494
- package/dist/api/restful/sell/metadata/index.d.ts +0 -65
- package/dist/api/restful/sell/metadata/index.js +0 -65
- package/dist/api/restful/sell/negotiation/index.d.ts +0 -14
- package/dist/api/restful/sell/negotiation/index.js +0 -14
- package/dist/api/restful/sell/recommendation/index.d.ts +0 -15
- package/dist/api/restful/sell/recommendation/index.js +0 -15
- package/dist/api/traditional/XMLRequest.d.ts +0 -44
- package/dist/api/traditional/XMLRequest.js +0 -46
- package/dist/api/traditional/clientAlerts/index.js +0 -1
- package/dist/api/traditional/index.d.ts +0 -3
- package/dist/api/traditional/index.js +0 -5
- package/dist/api/traditional/shopping/index.js +0 -1
- package/dist/auth/authNAuth.d.ts +0 -5
- package/dist/auth/authNAuth.js +0 -5
- package/dist/auth/index.d.ts +0 -3
- package/dist/auth/index.js +0 -3
- package/dist/auth/oAuth2.d.ts +0 -52
- package/dist/auth/oAuth2.js +0 -53
- package/dist/eBayApi.d.ts +0 -11
- package/dist/eBayApi.js +0 -14
- package/dist/ebay-api.min.mjs +1 -1
- package/dist/enums/restfulEnums.d.ts +0 -5
- package/dist/enums/restfulEnums.js +0 -5
- package/dist/errors/index.d.ts +0 -19
- package/dist/errors/index.js +1 -21
- package/dist/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
- package/dist/types/restful/specs/buy_browse_v1_oas3.js +0 -4
- package/dist/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
- package/dist/types/restful/specs/buy_deal_v1_oas3.js +0 -4
- package/dist/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
- package/dist/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
- package/dist/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
- package/dist/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
- package/dist/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
- package/dist/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/cancellation_oas3.d.ts +0 -29
- package/dist/types/restful/specs/cancellation_oas3.js +0 -4
- package/dist/types/restful/specs/case_oas3.d.ts +0 -31
- package/dist/types/restful/specs/case_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
- package/dist/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
- package/dist/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
- package/dist/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
- package/dist/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
- package/dist/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
- package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
- package/dist/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
- package/dist/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
- package/dist/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
- package/dist/types/restful/specs/inquiry_oas3.d.ts +0 -45
- package/dist/types/restful/specs/inquiry_oas3.js +0 -4
- package/dist/types/restful/specs/return_oas3.d.ts +0 -130
- package/dist/types/restful/specs/return_oas3.js +0 -4
- package/dist/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
- package/dist/types/restful/specs/sell_account_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
- package/dist/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
- package/dist/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
- package/dist/types/restful/specs/sell_feed_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
- package/dist/types/restful/specs/sell_finances_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
- package/dist/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
- package/dist/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
- package/dist/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
- package/dist/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
- package/dist/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
- package/dist/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
- package/dist/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
- package/dist/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
- package/dist/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
- package/dist/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
- package/dist/types/restfulTypes.d.ts +3 -0
- package/lib/api/apiFactory.d.ts +0 -3
- package/lib/api/apiFactory.js +0 -4
- package/lib/api/base.d.ts +0 -3
- package/lib/api/base.js +0 -3
- package/lib/api/digitalSignature.d.ts +0 -33
- package/lib/api/digitalSignature.js +1 -41
- package/lib/api/index.d.ts +0 -3
- package/lib/api/index.js +0 -3
- package/lib/api/restful/buy/browse/index.d.ts +0 -66
- package/lib/api/restful/buy/browse/index.js +0 -73
- package/lib/api/restful/buy/deal/index.d.ts +0 -32
- package/lib/api/restful/buy/deal/index.js +0 -32
- package/lib/api/restful/buy/feed/index.d.ts +0 -33
- package/lib/api/restful/buy/feed/index.js +0 -33
- package/lib/api/restful/buy/marketing/index.d.ts +0 -18
- package/lib/api/restful/buy/marketing/index.js +0 -22
- package/lib/api/restful/buy/marketplaceInsights/index.d.ts +0 -21
- package/lib/api/restful/buy/marketplaceInsights/index.js +0 -21
- package/lib/api/restful/buy/offer/index.d.ts +0 -15
- package/lib/api/restful/buy/offer/index.js +0 -15
- package/lib/api/restful/buy/order/index.d.ts +0 -227
- package/lib/api/restful/buy/order/index.js +0 -227
- package/lib/api/restful/commerce/catalog/index.d.ts +0 -54
- package/lib/api/restful/commerce/catalog/index.js +0 -54
- package/lib/api/restful/commerce/charity/index.d.ts +0 -21
- package/lib/api/restful/commerce/charity/index.js +0 -21
- package/lib/api/restful/commerce/identity/index.d.ts +0 -7
- package/lib/api/restful/commerce/identity/index.js +0 -7
- package/lib/api/restful/commerce/notification/index.d.ts +0 -93
- package/lib/api/restful/commerce/notification/index.js +0 -93
- package/lib/api/restful/commerce/taxonomy/index.d.ts +0 -64
- package/lib/api/restful/commerce/taxonomy/index.js +0 -64
- package/lib/api/restful/commerce/translation/index.d.ts +0 -8
- package/lib/api/restful/commerce/translation/index.js +0 -8
- package/lib/api/restful/developer/analytics/index.d.ts +0 -15
- package/lib/api/restful/developer/analytics/index.js +0 -15
- package/lib/api/restful/developer/keyManagement/index.d.ts +0 -15
- package/lib/api/restful/developer/keyManagement/index.js +0 -15
- package/lib/api/restful/index.d.ts +0 -16
- package/lib/api/restful/index.js +1 -23
- package/lib/api/restful/postOrder/cancellation/index.d.ts +0 -43
- package/lib/api/restful/postOrder/cancellation/index.js +1 -46
- package/lib/api/restful/postOrder/case/index.d.ts +0 -46
- package/lib/api/restful/postOrder/case/index.js +0 -46
- package/lib/api/restful/postOrder/inquiry/index.d.ts +0 -64
- package/lib/api/restful/postOrder/inquiry/index.js +0 -64
- package/lib/api/restful/postOrder/return/index.d.ts +0 -190
- package/lib/api/restful/postOrder/return/index.js +0 -190
- package/lib/api/restful/sell/account/index.d.ts +0 -241
- package/lib/api/restful/sell/account/index.js +0 -241
- package/lib/api/restful/sell/analytics/index.d.ts +0 -26
- package/lib/api/restful/sell/analytics/index.js +0 -26
- package/lib/api/restful/sell/compliance/index.d.ts +0 -23
- package/lib/api/restful/sell/compliance/index.js +0 -23
- package/lib/api/restful/sell/feed/index.d.ts +0 -135
- package/lib/api/restful/sell/feed/index.js +0 -135
- package/lib/api/restful/sell/finances/index.d.ts +0 -51
- package/lib/api/restful/sell/finances/index.js +0 -51
- package/lib/api/restful/sell/fulfillment/index.d.ts +0 -108
- package/lib/api/restful/sell/fulfillment/index.js +0 -108
- package/lib/api/restful/sell/inventory/index.d.ts +0 -197
- package/lib/api/restful/sell/inventory/index.js +0 -197
- package/lib/api/restful/sell/listing/index.d.ts +0 -8
- package/lib/api/restful/sell/listing/index.js +0 -8
- package/lib/api/restful/sell/logistics/index.d.ts +0 -33
- package/lib/api/restful/sell/logistics/index.js +0 -33
- package/lib/api/restful/sell/marketing/index.d.ts +16 -495
- package/lib/api/restful/sell/marketing/index.js +48 -494
- package/lib/api/restful/sell/metadata/index.d.ts +0 -65
- package/lib/api/restful/sell/metadata/index.js +0 -65
- package/lib/api/restful/sell/negotiation/index.d.ts +0 -14
- package/lib/api/restful/sell/negotiation/index.js +0 -14
- package/lib/api/restful/sell/recommendation/index.d.ts +0 -15
- package/lib/api/restful/sell/recommendation/index.js +0 -15
- package/lib/api/traditional/XMLRequest.d.ts +0 -44
- package/lib/api/traditional/XMLRequest.js +0 -46
- package/lib/api/traditional/clientAlerts/index.js +0 -1
- package/lib/api/traditional/index.d.ts +0 -3
- package/lib/api/traditional/index.js +0 -5
- package/lib/api/traditional/shopping/index.js +0 -1
- package/lib/auth/authNAuth.d.ts +0 -5
- package/lib/auth/authNAuth.js +0 -5
- package/lib/auth/index.d.ts +0 -3
- package/lib/auth/index.js +0 -3
- package/lib/auth/oAuth2.d.ts +0 -52
- package/lib/auth/oAuth2.js +0 -53
- package/lib/eBayApi.d.ts +0 -11
- package/lib/eBayApi.js +0 -14
- package/lib/ebay-api.min.js +1 -1
- package/lib/enums/restfulEnums.d.ts +0 -5
- package/lib/enums/restfulEnums.js +0 -5
- package/lib/errors/index.d.ts +0 -19
- package/lib/errors/index.js +1 -21
- package/lib/types/restful/specs/buy_browse_v1_oas3.d.ts +0 -697
- package/lib/types/restful/specs/buy_browse_v1_oas3.js +0 -4
- package/lib/types/restful/specs/buy_deal_v1_oas3.d.ts +0 -189
- package/lib/types/restful/specs/buy_deal_v1_oas3.js +0 -4
- package/lib/types/restful/specs/buy_feed_v1_beta_oas3.d.ts +0 -229
- package/lib/types/restful/specs/buy_feed_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.d.ts +0 -101
- package/lib/types/restful/specs/buy_marketing_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.d.ts +0 -150
- package/lib/types/restful/specs/buy_marketplace_insights_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_offer_v1_beta_oas3.d.ts +0 -62
- package/lib/types/restful/specs/buy_offer_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/buy_order_v1_beta_oas3.d.ts +0 -600
- package/lib/types/restful/specs/buy_order_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/cancellation_oas3.d.ts +0 -29
- package/lib/types/restful/specs/cancellation_oas3.js +0 -4
- package/lib/types/restful/specs/case_oas3.d.ts +0 -31
- package/lib/types/restful/specs/case_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.d.ts +0 -331
- package/lib/types/restful/specs/commerce_catalog_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_charity_v1_oas3.d.ts +0 -85
- package/lib/types/restful/specs/commerce_charity_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_identity_v1_oas3.d.ts +0 -63
- package/lib/types/restful/specs/commerce_identity_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_notification_v1_oas3.d.ts +0 -236
- package/lib/types/restful/specs/commerce_notification_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.d.ts +0 -219
- package/lib/types/restful/specs/commerce_taxonomy_v1_oas3.js +0 -4
- package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.d.ts +0 -36
- package/lib/types/restful/specs/commerce_translation_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.d.ts +0 -57
- package/lib/types/restful/specs/developer_analytics_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/developer_key_management_v1_oas3.d.ts +0 -60
- package/lib/types/restful/specs/developer_key_management_v1_oas3.js +0 -4
- package/lib/types/restful/specs/inquiry_oas3.d.ts +0 -45
- package/lib/types/restful/specs/inquiry_oas3.js +0 -4
- package/lib/types/restful/specs/return_oas3.d.ts +0 -130
- package/lib/types/restful/specs/return_oas3.js +0 -4
- package/lib/types/restful/specs/sell_account_v1_oas3.d.ts +0 -751
- package/lib/types/restful/specs/sell_account_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_analytics_v1_oas3.d.ts +0 -130
- package/lib/types/restful/specs/sell_analytics_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_compliance_v1_oas3.d.ts +0 -102
- package/lib/types/restful/specs/sell_compliance_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_feed_v1_oas3.d.ts +0 -461
- package/lib/types/restful/specs/sell_feed_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_finances_v1_oas3.d.ts +0 -255
- package/lib/types/restful/specs/sell_finances_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_fulfillment_v1_oas3.d.ts +0 -595
- package/lib/types/restful/specs/sell_fulfillment_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_inventory_v1_oas3.d.ts +0 -844
- package/lib/types/restful/specs/sell_inventory_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_listing_v1_beta_oas3.d.ts +0 -57
- package/lib/types/restful/specs/sell_listing_v1_beta_oas3.js +0 -4
- package/lib/types/restful/specs/sell_logistics_v1_oas3.d.ts +0 -173
- package/lib/types/restful/specs/sell_logistics_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_marketing_v1_oas3.d.ts +454 -1411
- package/lib/types/restful/specs/sell_marketing_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_metadata_v1_oas3.d.ts +0 -147
- package/lib/types/restful/specs/sell_metadata_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_negotiation_v1_oas3.d.ts +0 -94
- package/lib/types/restful/specs/sell_negotiation_v1_oas3.js +0 -4
- package/lib/types/restful/specs/sell_recommendation_v1_oas3.d.ts +0 -60
- package/lib/types/restful/specs/sell_recommendation_v1_oas3.js +0 -4
- package/lib/types/restfulTypes.d.ts +3 -0
- package/package.json +2 -2
|
@@ -1,350 +1,172 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by openapi-typescript.
|
|
3
|
-
* Do not make direct changes to the file.
|
|
4
|
-
*/
|
|
5
1
|
export interface paths {
|
|
6
2
|
"/item": {
|
|
7
|
-
/** @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: 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/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ 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: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
8
3
|
get: operations["getItemFeed"];
|
|
9
4
|
};
|
|
10
5
|
"/item_group": {
|
|
11
|
-
/** @description This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. There are two types of item group feed files generated: A daily Item Group feed file containing the item group variation information associated with items returned in the Item feed file for a specific day, category, and marketplace. (feed_scope = NEWLY_LISTED) A weekly Item Group Bootstrap feed file containing all the item group variation information associated with items returned in the Item Bootstrap feed file for all the items in a specific category. (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. The contents of these feed files are based on the contents of the corresponding daily Item or Item Bootstrap feed file. When a new Item or Item Bootstrap feed file is generated, the service reads the file and if an item in the file has a primaryItemGroupId value, which indicates the item is part of an item group, it uses that value to return the item group (parent item) information for that item in the corresponding Item Group or Item Group Bootstrap feed file. This information includes the name/value pair of the aspects of the items in this group returned in the variesByLocalizedAspects column. For example, if the item was a shirt some of the variation names could be Size, Color, etc. Also the images for the various aspects are returned in the additionalImageUrls column. The first line in any feed 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. Combining the Item Group and Item feed files The Item Group or Item Group Bootstrap feed file contains details about the item group (parent item), including the item group ID itemGroupId. You match the value of itemGroupId from the Item Group feed file with the value of primaryItemGroupId from the corresponding daily Item or Item Bootstrap feed file. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Item Group 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. Note: The response is always only a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
12
6
|
get: operations["getItemGroupFeed"];
|
|
13
7
|
};
|
|
14
8
|
"/item_snapshot": {
|
|
15
|
-
/** @description The Hourly Snapshot feed file is generated each hour every day for all categories. This method lets you download an Hourly Snapshot TSV_GZIP (tab separated value gzip) feed file containing the details of all the items that have changed within the specified day and hour for a specific category. This means to generate the 8AM file of items that have changed from 8AM and 8:59AM, the service starts at 9AM. You can retrieve the 8AM snapshot file at 10AM. 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. You can use the response from this method to update the item details of items stored in your database. By comparing the value of itemSnapshotDate for the same item you will be able to tell which information is the latest. Important: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Hourly snapshot 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. Note: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
16
9
|
get: operations["getItemSnapshotFeed"];
|
|
17
10
|
};
|
|
18
11
|
"/product": {
|
|
19
|
-
/** @description Each day an Item feed file is generated for every top-level (L1) category. This file contains all the newly listed items for that day that are in the category including all its child categories. 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. The service reads this Item feed file and if an item in the Item feed file has an epid (eBay Product Id) value, the service uses that value to return the product information for that item in the Product feed file for that day and category. This method lets you download the Product TSV_GZIP (tab separated value gzip) feed file containing the product information for items in the Item feed file that were associated with a product. 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. To store all the item details provided by the Feed API, you would use the getItemFeed, getItemDescriptionFeed, getItemGroupFeed, and getProductFeed methods using the same parameters. For example: /item?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item_description?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item-group?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /product?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 Combining the Product and Item feed files The Product feed file contains details about the product, including the product epid. You match the value of epid from the Product feed file with the value of epid from the Item feed file for the same day and category. Downloading feed files Product 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. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Note: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
20
12
|
get: operations["getProductFeed"];
|
|
21
13
|
};
|
|
22
14
|
}
|
|
23
15
|
export type webhooks = Record<string, never>;
|
|
24
16
|
export interface components {
|
|
25
17
|
schemas: {
|
|
26
|
-
/** @description This type defines the fields that can be returned in an error. */
|
|
27
18
|
Error: {
|
|
28
|
-
/** @description Identifies the type of erro. */
|
|
29
19
|
category?: string;
|
|
30
|
-
/** @description Name for the primary system where the error occurred. This is relevant for application errors. */
|
|
31
20
|
domain?: string;
|
|
32
|
-
/**
|
|
33
|
-
* Format: int32
|
|
34
|
-
* @description A unique number to identify the error.
|
|
35
|
-
*/
|
|
36
21
|
errorId?: number;
|
|
37
|
-
/** @description An array of request elements most closely associated to the error. */
|
|
38
22
|
inputRefIds?: (string)[];
|
|
39
|
-
/** @description A more detailed explanation of the error. */
|
|
40
23
|
longMessage?: string;
|
|
41
|
-
/** @description Information on how to correct the problem, in the end user's terms and language where applicable. */
|
|
42
24
|
message?: string;
|
|
43
|
-
/** @description An array of request elements most closely associated to the error. */
|
|
44
25
|
outputRefIds?: (string)[];
|
|
45
|
-
/** @description An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. */
|
|
46
26
|
parameters?: (components["schemas"]["ErrorParameter"])[];
|
|
47
|
-
/** @description Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc. */
|
|
48
27
|
subdomain?: string;
|
|
49
28
|
};
|
|
50
29
|
ErrorParameter: {
|
|
51
|
-
/** @description The object of the error. */
|
|
52
30
|
name?: string;
|
|
53
|
-
/** @description The value of the object. */
|
|
54
31
|
value?: string;
|
|
55
32
|
};
|
|
56
|
-
/** @description The type that defines the columns returned in the Item feed file. */
|
|
57
33
|
Item: {
|
|
58
|
-
/** @description The unique identifier of the eBay item. */
|
|
59
34
|
itemId?: string;
|
|
60
|
-
/** @description The seller created title of the item. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes. For example Before: Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series After: "Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\Tracking" "Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series" */
|
|
61
35
|
title?: string;
|
|
62
|
-
/** @description The URL to the primary image of the item. This is the URL of the largest image available based on what the seller submitted. */
|
|
63
36
|
imageUrl?: string;
|
|
64
|
-
/** @description The label of the category. For example: Toys & Hobbies|Action Figures|Comic Book Heroes */
|
|
65
37
|
category?: string;
|
|
66
|
-
/** @description The ID of the category of the item. For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671. */
|
|
67
38
|
categoryId?: string;
|
|
68
|
-
/** @description A comma separated list of the purchase options available for the item, such as FIXED_PRICE, AUCTION. FIXED_PRICE - Returned for fixed-price items (non-auction) AUCTION - Returned for auction items without Buy It Now feature FIXED_PRICE and AUCTION - Returned for auction items enabled with the Buy It Now feature Code so that your app gracefully handles any future changes to this list. */
|
|
69
39
|
buyingOptions?: string;
|
|
70
|
-
/** @description The seller's eBay user name. */
|
|
71
40
|
sellerUsername?: string;
|
|
72
|
-
/** @description The percentage of the seller's total positive feedback. */
|
|
73
41
|
sellerFeedbackPercentage?: string;
|
|
74
|
-
/** @description The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. */
|
|
75
42
|
sellerFeedbackScore?: string;
|
|
76
|
-
/** @description The unique Global Trade Item Number of the item as defined by http://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. */
|
|
77
43
|
gtin?: string;
|
|
78
|
-
/** @description The name brand of the item, such as Nike, Apple, etc. */
|
|
79
44
|
brand?: string;
|
|
80
|
-
/** @description The manufacturer part number, which is a number that is used in combination with brand to identify a product. */
|
|
81
45
|
mpn?: string;
|
|
82
|
-
/** @description The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling. */
|
|
83
46
|
epid?: string;
|
|
84
|
-
/** @description The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. */
|
|
85
47
|
conditionId?: string;
|
|
86
|
-
/** @description The text describing the condition of the item. For a list of condition names, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. */
|
|
87
48
|
condition?: string;
|
|
88
|
-
/** @description The price of the item. This price can be a discounted price. If it is discounted, information about the discount is returned in the originalPriceValue, originalPriceCurrency, discountAmount, and discountPercentage columns. */
|
|
89
49
|
priceValue?: string;
|
|
90
|
-
/** @description The currency used for the price of the item. Generally, this is the currency used by the country of the eBay site offering the item. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/CurrencyCodeEnum.html'>eBay API documentation</a> */
|
|
91
50
|
priceCurrency?: string;
|
|
92
|
-
/** @description The unique identifier for the item group that contains this item. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. */
|
|
93
51
|
primaryItemGroupId?: string;
|
|
94
|
-
/** @description The item group type. Supported value: SELLER_DEFINED_VARIATIONS, indicates that the item group was created by the seller. Code so that your app gracefully handles any future changes to this list. */
|
|
95
52
|
primaryItemGroupType?: string;
|
|
96
|
-
/** @description A timestamp indicating when the item's sale period will end based on its start date and duration. For Good 'Til Cancelled' items, no value is returned in this column. Format: UTC (yyyy-MM-ddThh:mm:ss.sssZ). */
|
|
97
53
|
itemEndDate?: string;
|
|
98
|
-
/** @description An identifier generated/incremented when a seller revises the item. There are two types of item revisions; seller changes, such as changing the title and eBay system changes, such as changing the quantity when an item is purchased. This ID is changed only when the seller makes a change to the item. */
|
|
99
54
|
sellerItemRevision?: string;
|
|
100
|
-
/** @description The country where the item is physically located. */
|
|
101
55
|
itemLocationCountry?: string;
|
|
102
|
-
/** @description A semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;). Example without Label Encoded Format: encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue Encoded Example (The delimiters are empathized): U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw== Decoded: Size:XL;Color:Red;Sleeves:Long Example with Label Encoded Format: encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel| Encoded Example (The delimiters are empathized): UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc= Decoded: Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7 Note: The separators ( | : ; ) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string. For more information, see Encoded Aspects in the Buying Integration Guide. */
|
|
103
56
|
localizedAspects?: string;
|
|
104
|
-
/** @description An enumeration value representing the eBay status of the seller. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/SellerTrustLevelEnum.html'>eBay API documentation</a> */
|
|
105
57
|
sellerTrustLevel?: string;
|
|
106
|
-
/** @description An enumeration value representing the item's availability (possibility of being purchased). Values: AVAILABLE TEMPORARILY_UNAVAILABLE UNAVAILABLE Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/AvailabilityEnum.html'>eBay API documentation</a> */
|
|
107
58
|
availability?: string;
|
|
108
|
-
/** @description A boolean that indicates whether the images can be altered. If the value is true, you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only. */
|
|
109
59
|
imageAlteringProhibited?: boolean;
|
|
110
|
-
/**
|
|
111
|
-
* Format: int32
|
|
112
|
-
* @description The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.
|
|
113
|
-
*/
|
|
114
60
|
estimatedAvailableQuantity?: number;
|
|
115
|
-
/** @description This column has a value only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be MORE_THAN. This indicates that the seller has more than the 'Display Item Quantity', which is 10, in stock for this item. The following are the Display Item Quantity preferences the seller can set. Display "More than 10 available" in your listing (if applicable) If the seller enables this preference, this column will have a value as long as there are more than 10 of this item in inventory. If the quantity is equal to 10 or drops below 10, this column will be null and the estimated quantity of the item is returned in the estimatedAvailableQuantity column. Display the exact quantity in your items If the seller enables this preference, the availabilityThresholdType and availabilityThreshold columns will be null and the estimated quantity of the item is returned in the estimatedAvailableQuantity column. Note: Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/AvailabilityThresholdEnum.html'>eBay API documentation</a> */
|
|
116
61
|
availabilityThresholdType?: string;
|
|
117
|
-
/**
|
|
118
|
-
* Format: int32
|
|
119
|
-
* @description This column has a value only when the seller sets their 'display item quantity' preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be "10", which is the threshold value. Code so that your app gracefully handles any future changes to this value.
|
|
120
|
-
*/
|
|
121
62
|
availabilityThreshold?: number;
|
|
122
|
-
/** @description Indicates whether the seller accepts returns for the item. */
|
|
123
63
|
returnsAccepted?: boolean;
|
|
124
|
-
/**
|
|
125
|
-
* Format: int32
|
|
126
|
-
* @description The amount of time the buyer has to return the item after the purchase date. This can be the number of years, months, or days depending on returnPeriodUnit. For example, if this value is '30', and the returnPeriodUnit value is 'DAY', the return period is 30 days.
|
|
127
|
-
*/
|
|
128
64
|
returnPeriodValue?: number;
|
|
129
|
-
/** @description An enumeration value that indicates the period of time being used to measure the duration, such as business days or months, or years. See the TimeDurationUnitEnum type for a list of possible time-measuring units. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/TimeDurationUnitEnum.html'>eBay API documentation</a> */
|
|
130
65
|
returnPeriodUnit?: string;
|
|
131
|
-
/** @description An enumeration value that indicates how a buyer is refunded when an item is returned. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/RefundMethodEnum.html'>eBay API documentation</a> */
|
|
132
66
|
refundMethod?: string;
|
|
133
|
-
/** @description An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/ReturnMethodEnum.html'>eBay API documentation</a> */
|
|
134
67
|
returnMethod?: string;
|
|
135
|
-
/** @description The party responsible for the return shipping costs when an item is returned. Valid Values: BUYER or SELLER Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/ReturnShippingCostPayerEnum.html'>eBay API documentation</a> */
|
|
136
68
|
returnShippingCostPayer?: string;
|
|
137
|
-
/** @description Indicates the credit card service that will be used to process the transaction. If this column contains PAYPAL, you can use the Buy Order API to checkout and purchase the item. If this column is empty, you must use another method for checkout. */
|
|
138
69
|
acceptedPaymentMethods?: string;
|
|
139
|
-
/** @description A comma separated list of delivery options for the item, such as SHIP_TO_HOME and SELLER_ARRANGED_LOCAL_PICKUP. This column lets you filter out items that cannot be shipped to the buyer. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/DeliveryOptionsEnum.html'>eBay API documentation</a> */
|
|
140
70
|
deliveryOptions?: string;
|
|
141
|
-
/** @description A pipe (|) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship. The COUNTRY: list is separated from the REGION: list with a semicolon (;). Format Example: COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA; Country Values: The two-letter ISO 3166 standard code of the country. Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE Code so that your app gracefully handles any future changes to this list. */
|
|
142
71
|
shipToIncludedRegions?: string;
|
|
143
|
-
/** @description A pipe (|) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon (;). Format Example: COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA; Country Values: The two-letter ISO 3166 standard code of the country. Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE Code so that your app gracefully handles any future changes to this list. */
|
|
144
72
|
shipToExcludedRegions?: string;
|
|
145
|
-
/** @description The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid column. */
|
|
146
73
|
inferredEpid?: string;
|
|
147
|
-
/** @description The GTIN (Global Trade Item Number) of the product as defined by http://www.gtin.info, which as been programmatically determined by eBay. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. If the seller provided a GTIN for the item, the seller's value is returned in the gtin column. */
|
|
148
74
|
inferredGtin?: string;
|
|
149
|
-
/** @description The name brand for the item, such as Nike or Apple, which has been programmatically determined by eBay. To identify the product, this is always used along with MPN. If the seller provided a brand for the item, the seller's value is returned in the brand column. */
|
|
150
75
|
inferredBrand?: string;
|
|
151
|
-
/** @description The MPN (Manufacturer's Part Number) for the item, which has been programmatically determined by eBay. To identify the product, this is always used along with brand. If the seller provided a MPN for the item, the seller's value is returned in the mpn column. */
|
|
152
76
|
inferredMpn?: string;
|
|
153
|
-
/** @description A semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. These aspects have been programmatically determined by eBay. If the seller provided aspects for the item, the seller's values are returned in the localizedAspects column. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;). Example without Label Encoded Format: encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue Encoded Example (The delimiters are empathized): U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw== Decoded: Size:XL;Color:Red;Sleeves:Long Example with Label Encoded Format: encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel| Encoded Example (The delimiters are empathized): UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc= Decoded: Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7 Note: The separators ( | : ; ) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string. For more information, see Encoded Aspects in the Buying Integration Guide. */
|
|
154
77
|
inferredLocalizedAspects?: string;
|
|
155
|
-
/** @description A pipe separated (|) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values. */
|
|
156
78
|
additionalImageUrls?: string;
|
|
157
|
-
/** @description The original selling price of the item. This lets you surface a strikethrough price for the item. */
|
|
158
79
|
originalPriceValue?: string;
|
|
159
|
-
/** @description The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/CurrencyCodeEnum.html'>eBay API documentation</a> */
|
|
160
80
|
originalPriceCurrency?: string;
|
|
161
|
-
/** @description The calculated amount of the discount (originalPriceValue - priceValue). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14. Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency. */
|
|
162
81
|
discountAmount?: string;
|
|
163
|
-
/** @description The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20. */
|
|
164
82
|
discountPercentage?: string;
|
|
165
|
-
/** @description Indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models. To retrieve the manufacturer's specifications for this item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field. */
|
|
166
83
|
energyEfficiencyClass?: string;
|
|
167
|
-
/** @description A pipe separated list of the qualified programs available for the item. Currently, the only qualified program returned is EBAY_PLUS. Note: The EBAY_PLUS program is supported only on the EBAY_DE and EBAY_AU marketplaces. This means the qualifiedPrograms column will be populated only in feed files for these marketplaces. Program Values: EBAY_PLUS */
|
|
168
84
|
qualifiedPrograms?: string;
|
|
169
|
-
/**
|
|
170
|
-
* Format: int32
|
|
171
|
-
* @description The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below. For example: Item Lot Definition Lot Size A package of 24 AA batteries A box of 10 packages 10 A P235/75-15 Goodyear tire 4 tires 4 Fashion Jewelry Rings Package of 100 assorted rings 100 Note: Lots are not supported in all categories.
|
|
172
|
-
*/
|
|
173
85
|
lotSize?: number;
|
|
174
|
-
/** @description The unit of measurement used for the package dimensions, such as INCH, FEET, CENTIMETER, or METER. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/LengthUnitOfMeasureEnum.html'>eBay API documentation</a> */
|
|
175
86
|
lengthUnitOfMeasure?: string;
|
|
176
|
-
/** @description The width of the shipping package that contains the item. */
|
|
177
87
|
packageWidth?: string;
|
|
178
|
-
/** @description The height of the shipping package that contains the item. */
|
|
179
88
|
packageHeight?: string;
|
|
180
|
-
/** @description The length of the shipping package that contains the item. */
|
|
181
89
|
packageLength?: string;
|
|
182
|
-
/** @description The unit of measurement used for the package weight, such as POUND, KILOGRAM, OUNCE, or GRAM. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/WeightUnitOfMeasureEnum.html'>eBay API documentation</a> */
|
|
183
90
|
weightUnitOfMeasure?: string;
|
|
184
|
-
/** @description The weight of the package that contains the item. */
|
|
185
91
|
packageWeight?: string;
|
|
186
92
|
};
|
|
187
|
-
/** @description The type that defines the columns returned in the Item Group feed file. */
|
|
188
93
|
ItemGroup: {
|
|
189
|
-
/** @description The unique identifier for the item group. This ID is returned in the primaryItemGroupId column of the Item Feed file. */
|
|
190
94
|
itemGroupId?: string;
|
|
191
|
-
/** @description The item group type. For example: SELLER_DEFINED_VARIATIONS, indicates that the item group was created by the seller. Code so that your app gracefully handles any future changes to this list. */
|
|
192
95
|
itemGroupType?: string;
|
|
193
|
-
/** @description The seller created title of the item group. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes. For example Before: Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series After: "Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\Tracking" "Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series" */
|
|
194
96
|
title?: string;
|
|
195
|
-
/** @description A pipe separated (|) list of the aspect (variation) names for this item group. The aspect name is BASE64 encoded. Note: This column can contain multiple values. Encoded Format: aspectName|aspectName Encoded Example (The delimiters are empathized): Q29sb3I=|U2l6ZQ== Decoded: Color|Size */
|
|
196
97
|
variesByLocalizedAspects?: string;
|
|
197
|
-
/** @description The URL to the primary image of the item. The other images of the item group are returned in the additionalImageUrls column. */
|
|
198
98
|
imageUrl?: string;
|
|
199
|
-
/** @description A pipe separated (|) list of URLs for the additional images for the item group. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values. */
|
|
200
99
|
additionalImageUrls?: string;
|
|
201
|
-
/** @description A boolean that indicates whether the images can be altered. If the value is true, you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only. */
|
|
202
100
|
imageAlteringProhibited?: boolean;
|
|
203
101
|
};
|
|
204
|
-
/** @description The type that defines the array for the items returned in the Item Group feed file. */
|
|
205
102
|
ItemGroupResponse: {
|
|
206
|
-
/** @description The container for the array of items groups returned by the getItemGroupFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values for each item. The header labels match the fields that are described in the Response fields section. */
|
|
207
103
|
itemGroups?: (components["schemas"]["ItemGroup"])[];
|
|
208
104
|
};
|
|
209
|
-
/** @description The type that defines the array for the items returned in the Item feed file. */
|
|
210
105
|
ItemResponse: {
|
|
211
|
-
/** @description The container for the array of items returned by the getItemFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the Response fields section. */
|
|
212
106
|
items?: (components["schemas"]["Item"])[];
|
|
213
107
|
};
|
|
214
|
-
/** @description The type that defines the columns returned in the Hourly Snapshot feed file. Note: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated. */
|
|
215
108
|
ItemSnapshot: {
|
|
216
|
-
/** @description The unique identifier of the eBay item. */
|
|
217
109
|
itemId?: string;
|
|
218
|
-
/** @description An enumeration value representing the item's availability (possibility of being purchased). Values: AVAILABLE TEMPORARILY_UNAVAILABLE UNAVAILABLE Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/AvailabilityEnum.html'>eBay API documentation</a> */
|
|
219
110
|
availability?: string;
|
|
220
|
-
/** @description The seller created title of the item. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes. For example Before: Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series After: "Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\Tracking" "Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series" */
|
|
221
111
|
title?: string;
|
|
222
|
-
/** @description The URL to the primary image of the item. This is the URL of the largest image available based on what the seller submitted. */
|
|
223
112
|
imageUrl?: string;
|
|
224
|
-
/** @description The label of the category of the item. For example: Toys & Hobbies|Action Figures|Comic Book Heroes . */
|
|
225
113
|
category?: string;
|
|
226
|
-
/** @description The ID of the category of the item. For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671. */
|
|
227
114
|
categoryId?: string;
|
|
228
|
-
/** @description A comma separated list of the purchase options available for the item, such as FIXED_PRICE, AUCTION. Code so that your app gracefully handles any future changes to this list. Note: This column can contain multiple values. */
|
|
229
115
|
buyingOptions?: string;
|
|
230
|
-
/** @description The seller's eBay user name. */
|
|
231
116
|
sellerUsername?: string;
|
|
232
|
-
/** @description The percentage of the seller's total positive feedback. */
|
|
233
117
|
sellerFeedbackPercentage?: string;
|
|
234
|
-
/** @description The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. */
|
|
235
118
|
sellerFeedbackScore?: string;
|
|
236
|
-
/** @description The unique Global Trade Item Number of the item as defined by http://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. */
|
|
237
119
|
gtin?: string;
|
|
238
|
-
/** @description The name brand of the item, such as Nike, Apple, etc. */
|
|
239
120
|
brand?: string;
|
|
240
|
-
/** @description The manufacturer part number, which is a number that is used in combination with brand to identify a product. */
|
|
241
121
|
mpn?: string;
|
|
242
|
-
/** @description The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling. */
|
|
243
122
|
epid?: string;
|
|
244
|
-
/** @description The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. */
|
|
245
123
|
conditionId?: string;
|
|
246
|
-
/** @description The text describing the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. */
|
|
247
124
|
condition?: string;
|
|
248
|
-
/** @description The price of the item. Note: This price can be a discounted price. */
|
|
249
125
|
priceValue?: string;
|
|
250
|
-
/** @description The currency used for the price of the item. Generally, this is the currency used by the country of the eBay site offering the item. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/CurrencyCodeEnum.html'>eBay API documentation</a> */
|
|
251
126
|
priceCurrency?: string;
|
|
252
|
-
/** @description The unique identifier for the item group that contains this item. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. */
|
|
253
127
|
primaryItemGroupId?: string;
|
|
254
|
-
/** @description The item group type. Supported value: SELLER_DEFINED_VARIATIONS, indicates that the item group was created by the seller. Code so that your app gracefully handles any future changes to this list. */
|
|
255
128
|
primaryItemGroupType?: string;
|
|
256
|
-
/** @description A timestamp indicating when the item's sale period will end based on its start date and duration. For Good 'Til Cancelled' items, no value is returned in this column. Format: UTC (yyyy-MM-ddThh:mm:ss.sssZ). */
|
|
257
129
|
itemEndDate?: string;
|
|
258
|
-
/** @description An identifier generated/incremented when a seller revises the item. There are two types of item revisions; seller changes, such as changing the title and eBay system changes, such as changing the quantity when an item is purchased. This ID is changed only when the seller makes a change to the item. */
|
|
259
130
|
sellerItemRevision?: string;
|
|
260
|
-
/** @description The country where the item is physically located. */
|
|
261
131
|
itemLocationCountry?: string;
|
|
262
|
-
/** @description A semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;). Example without Label Encoded Format: encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue Encoded Example (The delimiters are empathized): U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw== Decoded: Size:XL;Color:Red;Sleeves:Long Example with Label Encoded Format: encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel| Encoded Example (The delimiters are empathized): UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc= Decoded: Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7 Note: The separators ( | : ; ) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string. For more information, see Encoded Aspects in the Buying Integration Guide. */
|
|
263
132
|
localizedAspects?: string;
|
|
264
|
-
/** @description An enumeration value representing the eBay status of the seller. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/SellerTrustLevelEnum.html'>eBay API documentation</a> */
|
|
265
133
|
sellerTrustLevel?: string;
|
|
266
|
-
/** @description A boolean that indicates whether the images can be altered. If the value is true, you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only. */
|
|
267
134
|
imageAlteringProhibited?: boolean;
|
|
268
|
-
/**
|
|
269
|
-
* Format: int32
|
|
270
|
-
* @description The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.
|
|
271
|
-
*/
|
|
272
135
|
estimatedAvailableQuantity?: number;
|
|
273
|
-
/** @description This column has a value only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be MORE_THAN. This indicates that the seller has more than the 'Display Item Quantity', which is 10, in stock for this item. The following are the Display Item Quantity preferences the seller can set. Display "More than 10 available" in your listing (if applicable) If the seller enables this preference, this column will have a value as long as there are more than 10 of this item in inventory. If the quantity is equal to 10 or drops below 10, this column will be null and the estimated quantity of the item is returned in the estimatedAvailableQuantity column. Display the exact quantity in your items If the seller enables this preference, the availabilityThresholdType and availabilityThreshold columns will be null and the estimated quantity of the item is returned in the estimatedAvailableQuantity column. Note: Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/AvailabilityThresholdEnum.html'>eBay API documentation</a> */
|
|
274
136
|
availabilityThresholdType?: string;
|
|
275
|
-
/**
|
|
276
|
-
* Format: int32
|
|
277
|
-
* @description This column has a value only when the seller sets their 'display item quantity' preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be "10", which is the threshold value. Code so that your app gracefully handles any future changes to this value.
|
|
278
|
-
*/
|
|
279
137
|
availabilityThreshold?: number;
|
|
280
|
-
/** @description This timestamp denotes the date and time the changes for that item were picked up and added to the snapshot feed file. For example, let's say you have a snapshot feed file and also ran the getItem method. When you compare the same item information from the two sources, you see that the price in the getItem method response is different from the price in the snapshot feed file. By knowing the date and time you submitted the getItem method, you can use the itemSnapshotDate data to determine which price is the most current for this item. */
|
|
281
138
|
itemSnapshotDate?: string;
|
|
282
|
-
/** @description The original selling price of the item. This lets you surface a strikethrough price for the item. */
|
|
283
139
|
originalPriceValue?: string;
|
|
284
|
-
/** @description The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/CurrencyCodeEnum.html'>eBay API documentation</a> */
|
|
285
140
|
originalPriceCurrency?: string;
|
|
286
|
-
/** @description The calculated amount of the discount (originalPriceValue - priceValue). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14. Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency. */
|
|
287
141
|
discountAmount?: string;
|
|
288
|
-
/** @description The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20. */
|
|
289
142
|
discountPercentage?: string;
|
|
290
|
-
/** @description Indicates whether the seller accepts returns for the item. */
|
|
291
143
|
returnsAccepted?: boolean;
|
|
292
|
-
/**
|
|
293
|
-
* Format: int32
|
|
294
|
-
* @description The amount of time the buyer has to return the item after the purchase date. This can be the number of years, months, or days depending on returnPeriodUnit. For example, if this value is '30', and the returnPeriodUnit value is 'DAY', the return period is 30 days.
|
|
295
|
-
*/
|
|
296
144
|
returnPeriodValue?: number;
|
|
297
|
-
/** @description An enumeration value representing the period of time being used to measure the duration, such as business days or months, or years. See the TimeDurationUnitEnum type for a list of possible time-measuring units. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/TimeDurationUnitEnum.html'>eBay API documentation</a> */
|
|
298
145
|
returnPeriodUnit?: string;
|
|
299
|
-
/** @description An enumeration value representing how a buyer is refunded when an item is returned. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/RefundMethodEnum.html'>eBay API documentation</a> */
|
|
300
146
|
refundMethod?: string;
|
|
301
|
-
/** @description An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/ReturnMethodEnum.html'>eBay API documentation</a> */
|
|
302
147
|
returnMethod?: string;
|
|
303
|
-
/** @description An enumeration value that indicates the party responsible for the return shipping costs when an item is returned. Valid Values: BUYER or SELLER Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/ReturnShippingCostPayerEnum.html'>eBay API documentation</a> */
|
|
304
148
|
returnShippingCostPayer?: string;
|
|
305
|
-
/** @description Indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models. To retrieve the manufacturer's specifications for this item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field. */
|
|
306
149
|
energyEfficiencyClass?: string;
|
|
307
|
-
/** @description A pipe separated (|) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values. */
|
|
308
150
|
additionalImageUrls?: string;
|
|
309
|
-
/** @description A comma separated list of delivery options for the item, such as SHIP_TO_HOME and SELLER_ARRANGED_LOCAL_PICKUP. This column lets you filter out items that cannot be shipped to the buyer. Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/devzone/rest/api-ref/feed/types/DeliveryOptionsEnum.html'>eBay API documentation</a> */
|
|
310
151
|
deliveryOptions?: string;
|
|
311
|
-
/** @description A pipe (|) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship. The COUNTRY: list is separated from the REGION: list with a semicolon (;). Format Example: COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA; Country Values: The two-letter ISO 3166 standard code of the country. Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE Code so that your app gracefully handles any future changes to this list. */
|
|
312
152
|
shipToIncludedRegions?: string;
|
|
313
|
-
/** @description A pipe (|) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon (;). Format Example: COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA; Country Values: The two-letter ISO 3166 standard code of the country. Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE Code so that your app gracefully handles any future changes to this list. */
|
|
314
153
|
shipToExcludedRegions?: string;
|
|
315
|
-
/** @description Indicates the credit card service that will be used to process the transaction. If this column contains PAYPAL, you can use the Buy Order API to checkout and purchase the item. If this column is empty, you must use another method for checkout. */
|
|
316
154
|
acceptedPaymentMethods?: string;
|
|
317
|
-
/** @description A pipe separated list of the qualified programs available for the item, such as EBAY_PLUS */
|
|
318
155
|
qualifiedPrograms?: string;
|
|
319
|
-
/**
|
|
320
|
-
* Format: int32
|
|
321
|
-
* @description The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below. For example: Item Lot Definition Lot Size A package of 24 AA batteries A box of 10 packages 10 A P235/75-15 Goodyear tire 4 tires 4 Fashion Jewelry Rings Package of 100 assorted rings 100 Note: Lots are not supported in all categories.
|
|
322
|
-
*/
|
|
323
156
|
lotSize?: number;
|
|
324
157
|
};
|
|
325
|
-
/** @description The type that defines the array for the items returned in the Hourly Snapshot feed file. */
|
|
326
158
|
ItemSnapshotResponse: {
|
|
327
|
-
/** @description The container for the array of items returned by the getItemSnapshotFeed method. Note: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated. */
|
|
328
159
|
items?: (components["schemas"]["ItemSnapshot"])[];
|
|
329
160
|
};
|
|
330
|
-
/** @description The type that defines the columns returned in the getProductFeed feed file. */
|
|
331
161
|
Product: {
|
|
332
|
-
/** @description The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling. */
|
|
333
162
|
epid?: string;
|
|
334
|
-
/** @description The title of the product. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes. For example Before: Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series After: "Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\Tracking" "Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series" */
|
|
335
163
|
title?: string;
|
|
336
|
-
/** @description The description of the product, which is BASE64 encoded. */
|
|
337
164
|
description?: string;
|
|
338
|
-
/** @description The URL to the primary product image. This is the URL of the largest image available based on what the seller submitted. */
|
|
339
165
|
imageUrl?: string;
|
|
340
|
-
/** @description A pipe separated (|) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values. */
|
|
341
166
|
additionalImageUrls?: string;
|
|
342
|
-
/** @description A list of the name/value pairs for the aspects of the product, which are BASE64 encoded. The aspect label, is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;). Example without Label Encoded: encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue Decoded: Size:XL;Color:Red;Sleeves:Long Example with Label Encoded: encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel|encodedName:encodedValue Decoded: Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7 Note: The separators ( | : ; ) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string. For more information, see Encoded Aspects in the Buying Integration Guide. */
|
|
343
167
|
localizedProductAspects?: string;
|
|
344
168
|
};
|
|
345
|
-
/** @description The type that defines the array for the products returned in the Product feed file. */
|
|
346
169
|
ProductResponse: {
|
|
347
|
-
/** @description The container for the array of products returned by the getProdutFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the Response fields section. */
|
|
348
170
|
products?: (components["schemas"]["Product"])[];
|
|
349
171
|
};
|
|
350
172
|
};
|
|
@@ -356,26 +178,19 @@ export interface components {
|
|
|
356
178
|
}
|
|
357
179
|
export type external = Record<string, never>;
|
|
358
180
|
export interface operations {
|
|
359
|
-
/** @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: 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/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ 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: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
360
181
|
getItemFeed: {
|
|
361
182
|
parameters: {
|
|
362
183
|
query: {
|
|
363
|
-
/** @description Specifies the type of feed file to return. Valid Values: NEWLY_LISTED - Returns the daily Item feed file containing all items that were listed on the day specified by the date parameter in the category specified by the category_id parameter. The items are Good 'Til Cancelled and non-Good 'Til Cancelled items. If the item is a non-Good 'Til Cancelled item, the item's end date will be returned in the itemEndDate column. /item?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925 ALL_ACTIVE - Returns the weekly Item Bootstrap feed file containing all the 'Good 'Til Cancelled' items in the category specified by the category_id parameter. Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The items in the file are the items that were in the specified category on Sunday. /item?feed_scope=ALL_ACTIVE&category_id=15032 */
|
|
364
184
|
feed_scope: string;
|
|
365
|
-
/** @description An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplaces, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example: "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level (L1) category */
|
|
366
185
|
category_id: string;
|
|
367
|
-
/** @description The date of the daily Item feed file (feed_scope=NEWLY_LISTED) you want. The date is required only for the daily Item feed file. If you specify a date for the Item Bootstrap file (feed_scope=ALL_ACTIVE), the date is ignored and the latest file is returned. The date the Item Bootstrap feed file was generated is returned in the Last-Modified response header. The Item feed files are generated every day and there are always 14 files available. The daily Item feed files are available each day after 9AM MST (US Mountain Standard Time), which is -7 hours UTC time. There is a 48 hour latency when generating the Item feed files. This means you can download the file for July 10th on July 12 after 9AM MST. Note: For categories with a large number of items, the latency can be up to 72 hours. Format: yyyyMMdd Requirements: Required when feed_scope=NEWLY_LISTED Must be within 3-14 days in the past */
|
|
368
186
|
date?: string;
|
|
369
187
|
};
|
|
370
188
|
header: {
|
|
371
|
-
/** @description The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example: X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions. */
|
|
372
189
|
"X-EBAY-C-MARKETPLACE-ID": string;
|
|
373
|
-
/** @description This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file. Range bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB (10MB in the Sandbox) */
|
|
374
190
|
Range: string;
|
|
375
191
|
};
|
|
376
192
|
};
|
|
377
193
|
responses: {
|
|
378
|
-
/** @description Success */
|
|
379
194
|
200: {
|
|
380
195
|
headers: {
|
|
381
196
|
"Content-range"?: string;
|
|
@@ -385,9 +200,7 @@ export interface operations {
|
|
|
385
200
|
"text/tab-separated-values": components["schemas"]["ItemResponse"];
|
|
386
201
|
};
|
|
387
202
|
};
|
|
388
|
-
/** @description No Content <br />This code is returned when there are no items that meet the criteria for this feed file. See <a href="/api-docs/buy/static/api-feed.html#feed-filters">Feed File Filters</a> for details. */
|
|
389
203
|
204: never;
|
|
390
|
-
/** @description Partial Content */
|
|
391
204
|
206: {
|
|
392
205
|
headers: {
|
|
393
206
|
"Content-range"?: string;
|
|
@@ -397,36 +210,25 @@ export interface operations {
|
|
|
397
210
|
"text/tab-separated-values": components["schemas"]["ItemResponse"];
|
|
398
211
|
};
|
|
399
212
|
};
|
|
400
|
-
/** @description Bad request */
|
|
401
213
|
400: never;
|
|
402
|
-
/** @description Not found */
|
|
403
214
|
404: never;
|
|
404
|
-
/** @description Range not satisfiable */
|
|
405
215
|
416: never;
|
|
406
|
-
/** @description Internal Server Error */
|
|
407
216
|
500: never;
|
|
408
217
|
};
|
|
409
218
|
};
|
|
410
|
-
/** @description This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. There are two types of item group feed files generated: A daily Item Group feed file containing the item group variation information associated with items returned in the Item feed file for a specific day, category, and marketplace. (feed_scope = NEWLY_LISTED) A weekly Item Group Bootstrap feed file containing all the item group variation information associated with items returned in the Item Bootstrap feed file for all the items in a specific category. (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. The contents of these feed files are based on the contents of the corresponding daily Item or Item Bootstrap feed file. When a new Item or Item Bootstrap feed file is generated, the service reads the file and if an item in the file has a primaryItemGroupId value, which indicates the item is part of an item group, it uses that value to return the item group (parent item) information for that item in the corresponding Item Group or Item Group Bootstrap feed file. This information includes the name/value pair of the aspects of the items in this group returned in the variesByLocalizedAspects column. For example, if the item was a shirt some of the variation names could be Size, Color, etc. Also the images for the various aspects are returned in the additionalImageUrls column. The first line in any feed 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. Combining the Item Group and Item feed files The Item Group or Item Group Bootstrap feed file contains details about the item group (parent item), including the item group ID itemGroupId. You match the value of itemGroupId from the Item Group feed file with the value of primaryItemGroupId from the corresponding daily Item or Item Bootstrap feed file. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Item Group 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. Note: The response is always only a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
411
219
|
getItemGroupFeed: {
|
|
412
220
|
parameters: {
|
|
413
221
|
query: {
|
|
414
|
-
/** @description Specifies the type of file to return. Valid Values: NEWLY_LISTED - Returns the Item Group feed file containing the item group variation information for items in the daily Item feed file that were associated with an item group. The items in this type of Item feed file are items that were listed on the day specified by the date parameter in the category specified by the category_id parameter. The items will be Good 'Til Cancelled and non-Good 'Til Cancelled items. If the item is a non-Good 'Til Cancelled item, the item's end date will be returned in the itemEndDate column. /item_group?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925 ALL_ACTIVE - Returns the weekly Item Group Bootstrap file containing the item group variation information for items in the weekly Item Bootstrap feed file that were associated with an item group. The items are 'Good 'Til Cancelled' items in the category specified by the category_id parameter. Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The item groups in the file are for the items that were in the specified category on Sunday. /item_group?feed_scope=ALL_ACTIVE&category_id=15032 */
|
|
415
222
|
feed_scope: string;
|
|
416
|
-
/** @description An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplaces, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example: "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level category */
|
|
417
223
|
category_id: string;
|
|
418
|
-
/** @description The date of the daily Item Group feed file (feed_scope=NEWLY_LISTED) you want. The date is required only for the daily Item Group feed file. If you specify a date for the Item Group Bootstrap file (feed_scope=ALL_ACTIVE), the date is ignored and the latest file is returned. The date the Item Group Bootstrap feed file was generated is returned in the Last-Modified response header. The Item Group feed files are generated every day and there are always 14 files available. There is a 48 hour latency when generating the files. This means on July 10, the latest feed file you can download is July 8. Note: The generated files are stored using MST (US Mountain Standard Time), which is -7 hours UTC time. Format: yyyyMMdd Requirement: Requirements: Required only when feed_scope=NEWLY_LISTED Must be within 3-14 days in the past */
|
|
419
224
|
date?: string;
|
|
420
225
|
};
|
|
421
226
|
header: {
|
|
422
|
-
/** @description The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example: X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions. */
|
|
423
227
|
"X-EBAY-C-MARKETPLACE-ID": string;
|
|
424
|
-
/** @description This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file. Range bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB (10MB in the Sandbox) */
|
|
425
228
|
Range?: string;
|
|
426
229
|
};
|
|
427
230
|
};
|
|
428
231
|
responses: {
|
|
429
|
-
/** @description Success */
|
|
430
232
|
200: {
|
|
431
233
|
headers: {
|
|
432
234
|
"Content-range"?: string;
|
|
@@ -436,9 +238,7 @@ export interface operations {
|
|
|
436
238
|
"text/tab-separated-values": components["schemas"]["ItemGroupResponse"];
|
|
437
239
|
};
|
|
438
240
|
};
|
|
439
|
-
/** @description No Content <br />This code is returned when there are no items that meet the criteria for this feed file. See <a href="/api-docs/buy/static/api-feed.html#feed-filters">Feed File Filters</a> for details. */
|
|
440
241
|
204: never;
|
|
441
|
-
/** @description Partial Content */
|
|
442
242
|
206: {
|
|
443
243
|
headers: {
|
|
444
244
|
"Content-range"?: string;
|
|
@@ -448,34 +248,24 @@ export interface operations {
|
|
|
448
248
|
"text/tab-separated-values": components["schemas"]["ItemGroupResponse"];
|
|
449
249
|
};
|
|
450
250
|
};
|
|
451
|
-
/** @description Bad request */
|
|
452
251
|
400: never;
|
|
453
|
-
/** @description Not found */
|
|
454
252
|
404: never;
|
|
455
|
-
/** @description Range not satisfiable */
|
|
456
253
|
416: never;
|
|
457
|
-
/** @description Internal Server Error */
|
|
458
254
|
500: never;
|
|
459
255
|
};
|
|
460
256
|
};
|
|
461
|
-
/** @description The Hourly Snapshot feed file is generated each hour every day for all categories. This method lets you download an Hourly Snapshot TSV_GZIP (tab separated value gzip) feed file containing the details of all the items that have changed within the specified day and hour for a specific category. This means to generate the 8AM file of items that have changed from 8AM and 8:59AM, the service starts at 9AM. You can retrieve the 8AM snapshot file at 10AM. 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. You can use the response from this method to update the item details of items stored in your database. By comparing the value of itemSnapshotDate for the same item you will be able to tell which information is the latest. Important: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Hourly snapshot 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. Note: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
462
257
|
getItemSnapshotFeed: {
|
|
463
258
|
parameters: {
|
|
464
259
|
query: {
|
|
465
|
-
/** @description An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplace, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example: "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level category */
|
|
466
260
|
category_id: string;
|
|
467
|
-
/** @description The hour of the incremental feed file you want, for a particular day. There are always 14 days of Hourly Snapshot feed files available. If you specify that you want the 9AM file for July 15, 2017 (2017-07-15T09:00:00.000Z), the data in the feed file will be items that changed after 9AM on July 15, 2017. Restrictions: Files are generated on the hour, so minutes and seconds are always zeros. (2017-07-12T09:00:00.000Z) Format: UTC format (yyyy-MM-ddThh:00:00.000Z) */
|
|
468
261
|
snapshot_date: string;
|
|
469
262
|
};
|
|
470
263
|
header: {
|
|
471
|
-
/** @description The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example: X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions. */
|
|
472
264
|
"X-EBAY-C-MARKETPLACE-ID": string;
|
|
473
|
-
/** @description This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file. Range bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB (10MB in the Sandbox) */
|
|
474
265
|
Range: string;
|
|
475
266
|
};
|
|
476
267
|
};
|
|
477
268
|
responses: {
|
|
478
|
-
/** @description Success */
|
|
479
269
|
200: {
|
|
480
270
|
headers: {
|
|
481
271
|
"Content-range"?: string;
|
|
@@ -485,9 +275,7 @@ export interface operations {
|
|
|
485
275
|
"text/tab-separated-values": components["schemas"]["ItemSnapshotResponse"];
|
|
486
276
|
};
|
|
487
277
|
};
|
|
488
|
-
/** @description No Content <br />This code is returned when there are no items that meet the criteria for this feed file. See <a href="/api-docs/buy/static/api-feed.html#feed-filters">Feed File Filters</a> for details. */
|
|
489
278
|
204: never;
|
|
490
|
-
/** @description Partial Content */
|
|
491
279
|
206: {
|
|
492
280
|
headers: {
|
|
493
281
|
"Content-range"?: string;
|
|
@@ -497,36 +285,25 @@ export interface operations {
|
|
|
497
285
|
"text/tab-separated-values": components["schemas"]["ItemSnapshotResponse"];
|
|
498
286
|
};
|
|
499
287
|
};
|
|
500
|
-
/** @description Bad request */
|
|
501
288
|
400: never;
|
|
502
|
-
/** @description Not found */
|
|
503
289
|
404: never;
|
|
504
|
-
/** @description Range not satisfiable */
|
|
505
290
|
416: never;
|
|
506
|
-
/** @description Internal server error */
|
|
507
291
|
500: never;
|
|
508
292
|
};
|
|
509
293
|
};
|
|
510
|
-
/** @description Each day an Item feed file is generated for every top-level (L1) category. This file contains all the newly listed items for that day that are in the category including all its child categories. 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. The service reads this Item feed file and if an item in the Item feed file has an epid (eBay Product Id) value, the service uses that value to return the product information for that item in the Product feed file for that day and category. This method lets you download the Product TSV_GZIP (tab separated value gzip) feed file containing the product information for items in the Item feed file that were associated with a product. 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. To store all the item details provided by the Feed API, you would use the getItemFeed, getItemDescriptionFeed, getItemGroupFeed, and getProductFeed methods using the same parameters. For example: /item?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item_description?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item-group?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /product?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 Combining the Product and Item feed files The Product feed file contains details about the product, including the product epid. You match the value of epid from the Product feed file with the value of epid from the Item feed file for the same day and category. Downloading feed files Product 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. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Note: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions. */
|
|
511
294
|
getProductFeed: {
|
|
512
295
|
parameters: {
|
|
513
296
|
query: {
|
|
514
|
-
/** @description Specifies the type of product feed file to return. Valid Values: NEWLY_LISTED - Returns the file containing the product information for items in the NEWLY_LISTED Item feed file that were associated with a product. The items in this type of Item feed file are items that were listed on the day specified by the date parameter in the category specified by the category_id parameter. The items will be Good 'Til Cancelled and non-Good 'Til Cancelled items. If the item is a non-Good 'Til Cancelled item, the item's end date will be returned in the itemEndDate column. /product?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925 ALL_ACTIVE (bootstrap) - Returns the file containing the product information for items in the ALL_ACTIVE Item feed file that were associated with a product. The items in this type of Item feed file are all the 'Good 'Til Cancelled' items in the category specified by the category_id parameter. Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The products in the file are the products that were in the specified category on Sunday. /product?feed_scope=ALL_ACTIVE&category_id=15032 */
|
|
515
297
|
feed_scope: string;
|
|
516
|
-
/** @description An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplaces, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example: "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level category */
|
|
517
298
|
category_id: string;
|
|
518
|
-
/** @description The date of the feed file you want. This is needed only when feed_scope=NEWLY_LISTED. If you specify a date and feed_scope=ALL_ACTIVE, the date is ignored and the latest file is returned. The date of the file is returned in the Last-Modified response header. The Product feed files are generated every day and there are always 14 daily feed files available. There is a 48 hour latency when generating the files. This means on July 10, the latest feed file you can download is July 8. In other words, if you wanted the file generated on July 10th, you would need to wait until July 12th. Note: The generated files are stored using MST (US Mountain Standard Time), which is -7 hours UTC time. Format: yyyyMMdd Requirements: Must be within 3-14 days in the past Required when feed_scope=NEWLY_LISTED */
|
|
519
299
|
date?: string;
|
|
520
300
|
};
|
|
521
301
|
header: {
|
|
522
|
-
/** @description The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example: X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions. */
|
|
523
302
|
"X-EBAY-C-MARKETPLACE-ID": string;
|
|
524
|
-
/** @description This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, this retrieves the first 10 MBs of the feed file: bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB (10MB in the Sandbox) */
|
|
525
303
|
Range: string;
|
|
526
304
|
};
|
|
527
305
|
};
|
|
528
306
|
responses: {
|
|
529
|
-
/** @description Success */
|
|
530
307
|
200: {
|
|
531
308
|
headers: {
|
|
532
309
|
"Content-range"?: string;
|
|
@@ -536,9 +313,7 @@ export interface operations {
|
|
|
536
313
|
"text/tab-separated-values": components["schemas"]["ProductResponse"];
|
|
537
314
|
};
|
|
538
315
|
};
|
|
539
|
-
/** @description No Content <br />This code is returned when there are no products that meet the criteria for this feed file. See <a href="/api-docs/buy/static/api-feed.html#feed-filters">Feed File Filters</a> for details. */
|
|
540
316
|
204: never;
|
|
541
|
-
/** @description Partial Content */
|
|
542
317
|
206: {
|
|
543
318
|
headers: {
|
|
544
319
|
"Content-range"?: string;
|
|
@@ -548,13 +323,9 @@ export interface operations {
|
|
|
548
323
|
"text/tab-separated-values": components["schemas"]["ProductResponse"];
|
|
549
324
|
};
|
|
550
325
|
};
|
|
551
|
-
/** @description Bad request */
|
|
552
326
|
400: never;
|
|
553
|
-
/** @description Not found */
|
|
554
327
|
404: never;
|
|
555
|
-
/** @description Range not satisfiable */
|
|
556
328
|
416: never;
|
|
557
|
-
/** @description Internal Server Error */
|
|
558
329
|
500: never;
|
|
559
330
|
};
|
|
560
331
|
};
|