{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:ebay-buy-browse/get-items":{"get":{"operationId":"ecommerce_ebay_buy_browse_get_items","summary":"This method retrieves the details of specific items that the buyer needs to make a purchasing decision.…","description":"GET /item/","tags":["ecommerce"],"parameters":[{"name":"item_ids","in":"query","required":false,"description":"A list of item IDs. Item IDs are the eBay RESTful identifier of items. RESTful Item ID Format: v1|#|# For example: v1|272394640372|0 or…","schema":{"type":"string","description":"A list of item IDs. Item IDs are the eBay RESTful identifier of items. RESTful Item ID Format: v1|#|# For example: v1|272394640372|0 or…"}},{"name":"item_group_ids","in":"query","required":false,"description":"A list of item group IDs. Item group IDs are the eBay RESTful identifier of item groups. RESTful Group Item ID Format: ############ For…","schema":{"type":"string","description":"A list of item group IDs. Item group IDs are the eBay RESTful identifier of item groups. RESTful Group Item ID Format: ############ For…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/get-item-by-legacy-id":{"get":{"operationId":"ecommerce_ebay_buy_browse_get_item_by_legacy_id","summary":"This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs.…","description":"GET /item/get_item_by_legacy_id","tags":["ecommerce"],"parameters":[{"name":"fieldgroups","in":"query","required":false,"description":"This field lets you control what is returned in the response. If you do not set this field, the method returns all the details of the…","schema":{"type":"string","description":"This field lets you control what is returned in the response. If you do not set this field, the method returns all the details of the…"}},{"name":"legacy_item_id","in":"query","required":true,"description":"Specifies either: The legacy item ID of an item that is not part of a group. The legacy item ID of a group, which is the ID of the…","schema":{"type":"string","description":"Specifies either: The legacy item ID of an item that is not part of a group. The legacy item ID of a group, which is the ID of the…"}},{"name":"legacy_variation_id","in":"query","required":false,"description":"Specifies the legacy item ID of a specific item in an item group, such as the red shirt size L. Legacy ids are returned by APIs, such as…","schema":{"type":"string","description":"Specifies the legacy item ID of a specific item in an item group, such as the red shirt size L. Legacy ids are returned by APIs, such as…"}},{"name":"legacy_variation_sku","in":"query","required":false,"description":"Specifics the legacy SKU of the item. SKU are item ids created by the seller. Legacy SKUs are returned by eBay the Shopping API. The…","schema":{"type":"string","description":"Specifics the legacy SKU of the item. SKU are item ids created by the seller. Legacy SKUs are returned by eBay the Shopping API. The…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/get-items-by-item-group":{"get":{"operationId":"ecommerce_ebay_buy_browse_get_items_by_item_group","summary":"This method retrieves the details of the individual items in an item group. An item group is an item that…","description":"GET /item/get_items_by_item_group","tags":["ecommerce"],"parameters":[{"name":"item_group_id","in":"query","required":true,"description":"Identifier of the item group to return. An item group is an item that has various aspect differences, such as color, size, storage…","schema":{"type":"string","description":"Identifier of the item group to return. An item group is an item that has various aspect differences, such as color, size, storage…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/get-item":{"get":{"operationId":"ecommerce_ebay_buy_browse_get_item","summary":"This method retrieves the details of a specific item, such as description, price, category, all item…","description":"GET /item/{item_id}","tags":["ecommerce"],"parameters":[{"name":"fieldgroups","in":"query","required":false,"description":"This parameter lets you control what is returned in the response. If you do not set this field, the method returns all the details of the…","schema":{"type":"string","description":"This parameter lets you control what is returned in the response. If you do not set this field, the method returns all the details of the…"}},{"name":"item_id","in":"query","required":true,"description":"The eBay RESTful identifier of an item. This ID is returned by the Browse and Feed API methods. RESTful Item ID Format: v1|#|# For…","schema":{"type":"string","description":"The eBay RESTful identifier of an item. This ID is returned by the Browse and Feed API methods. RESTful Item ID Format: v1|#|# For…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/check-compatibility":{"post":{"operationId":"ecommerce_ebay_buy_browse_check_compatibility","summary":"This method checks if a product is compatible with the specified item. You can use this method to check the…","description":"POST /item/{item_id}/check_compatibility","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["item_id","X-EBAY-C-MARKETPLACE-ID"],"properties":{"item_id":{"type":"string","description":"The eBay RESTful identifier of an item (such as a part you want to check). This ID is returned by the Browse and Feed API methods. RESTful…"},"X-EBAY-C-MARKETPLACE-ID":{"type":"string","description":"The ID of the eBay marketplace you want to use. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID =…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/search":{"get":{"operationId":"ecommerce_ebay_buy_browse_search","summary":"This method searches for eBay items by various query parameters and retrieves summaries of the items. You…","description":"GET /item_summary/search","tags":["ecommerce"],"parameters":[{"name":"aspect_filter","in":"query","required":false,"description":"This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to…","schema":{"type":"string","description":"This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to…"}},{"name":"auto_correct","in":"query","required":false,"description":"A query parameter that enables auto correction. Valid Values: KEYWORD","schema":{"type":"string","description":"A query parameter that enables auto correction. Valid Values: KEYWORD"}},{"name":"category_ids","in":"query","required":false,"description":"The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs. For example:…","schema":{"type":"string","description":"The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs. For example:…"}},{"name":"charity_ids","in":"query","required":false,"description":"The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a…","schema":{"type":"string","description":"The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a…"}},{"name":"compatibility_filter","in":"query","required":false,"description":"This field specifies the attributes used to define a specific product. The service searches for items matching the keyword or matching the…","schema":{"type":"string","description":"This field specifies the attributes used to define a specific product. The service searches for items matching the keyword or matching the…"}},{"name":"epid","in":"query","required":false,"description":"The ePID is the eBay product identifier of a product from the eBay product catalog. This field limits the results to only items in the…","schema":{"type":"string","description":"The ePID is the eBay product identifier of a product from the eBay product catalog. This field limits the results to only items in the…"}},{"name":"fieldgroups","in":"query","required":false,"description":"This field is a comma separated list of values that lets you control what is returned in the response. The default is MATCHING_ITEMS,…","schema":{"type":"string","description":"This field is a comma separated list of values that lets you control what is returned in the response. The default is MATCHING_ITEMS,…"}},{"name":"filter","in":"query","required":false,"description":"This field supports multiple field filters that can be used to limit/customize the result set. For example:…","schema":{"type":"string","description":"This field supports multiple field filters that can be used to limit/customize the result set. For example:…"}},{"name":"gtin","in":"query","required":false,"description":"This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info. You can search only by UPC…","schema":{"type":"string","description":"This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info. You can search only by UPC…"}},{"name":"limit","in":"query","required":false,"description":"The number of items, from the result set, returned in a single page. Default: 50 Maximum number of items per page (limit): 200 Maximum…","schema":{"type":"string","description":"The number of items, from the result set, returned in a single page. Default: 50 Maximum number of items per page (limit): 200 Maximum…"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of items to skip in the result set. This is used with the limit field to control the pagination of the output. If…","schema":{"type":"string","description":"Specifies the number of items to skip in the result set. This is used with the limit field to control the pagination of the output. If…"}},{"name":"q","in":"query","required":false,"description":"A string consisting of one or more keywords that are used to search for items on eBay. The keywords are handled as follows: If the…","schema":{"type":"string","description":"A string consisting of one or more keywords that are used to search for items on eBay. The keywords are handled as follows: If the…"}},{"name":"sort","in":"query","required":false,"description":"Specifies the order and the field name to use to sort the items. You can sort items by price (in ascending or descending order) or by…","schema":{"type":"string","description":"Specifies the order and the field name to use to sort the items. You can sort items by price (in ascending or descending order) or by…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/search-by-image":{"post":{"operationId":"ecommerce_ebay_buy_browse_search_by_image","summary":"This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries…","description":"POST /item_summary/search_by_image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"aspect_filter":{"type":"string","description":"This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to…"},"category_ids":{"type":"string","description":"The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs. Note: Currently, you…"},"charity_ids":{"type":"string","description":"The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a…"},"fieldgroups":{"type":"string","description":"This field is a comma separated list of values that lets you control what is returned in the response. The default is MATCHING_ITEMS,…"},"filter":{"type":"string","description":"This field supports multiple field filters that can be used to limit/customize the result set. For example:…"},"limit":{"type":"string","description":"The number of items, from the result set, returned in a single page. Default: 50 Maximum number of items per page (limit): 200 Maximum…"},"offset":{"type":"string","description":"The number of items to skip in the result set. This is used with the limit field to control the pagination of the output. If offset is 0…"},"sort":{"type":"string","description":"Specifies the order and the field name to use to sort the items. You can sort items by price (in ascending or descending order) or by…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/get-shopping-cart":{"get":{"operationId":"ecommerce_ebay_buy_browse_get_shopping_cart","summary":"This is an experimental method. This method retrieves all the items in the eBay member's cart; items added…","description":"GET /shopping_cart/","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/add-item":{"post":{"operationId":"ecommerce_ebay_buy_browse_add_item","summary":"This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist,…","description":"POST /shopping_cart/add_item","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/remove-item":{"post":{"operationId":"ecommerce_ebay_buy_browse_remove_item","summary":"This is an experimental method. This method removes a specific item from the eBay member's cart. You specify…","description":"POST /shopping_cart/remove_item","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-buy-browse/update-quantity":{"post":{"operationId":"ecommerce_ebay_buy_browse_update_quantity","summary":"This is an experimental method. This method updates the quantity value of a specific item in the eBay…","description":"POST /shopping_cart/update_quantity","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}