Endpoints
On this page you will see possible API actions you can perform with Amazon Selling Partner (SP-API) connector. We will refer this as API EndPoint or just EndPoint.
| Label | Name | Description |
|---|---|---|
| Download Report File to Local Disk | download_report | Returns data from the specified report type. You can check following link for various available reports (list updated frequently), you can access report based on API Key role / permission, participation (e.g. Vendor/Seller), seller market place etc http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html. Depending on which Report you choose, it can take upto 30 minutes to generate report. Also some reports have strict limits on how many times you can access per hour (e.g. 2 times per 30 minutes). Check documentation for call limits. |
| Get FBA Inventory Summaries (Fulfilled By Amazon) | get_inventory_summaries | Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters. [API reference] |
| Get Market Place Participations | get_marketplaceparticipations | |
| Get Order (Single) | get_order | Returns the order information for a specified OrderId [API reference] |
| Get Order Items (For Single Order) | get_order_items | Returns the order items information for a specified OrderId [API reference] |
| Get Orders | get_orders | Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. |
| Get Orders Items (For All Orders **Slow**) | get_order_items_all | Returns the order items information for a specified order search criterial (All orders by Create/Update date, status etc) |
| Get Report Data - Comma Separated File (CSV) | get_report_csv | Returns data from the specified report type. You can check following link for various available reports (list updated frequently), you can access report based on API Key role / permission, participation (e.g. Vendor/Seller), seller market place etc http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html. Depending on which Report you choose, it can take upto 30 minutes to generate report. Also some reports have strict limits on how many times you can access per hour (e.g. 2 times per 30 minutes). Check documentation for call limits. |
| Get Report Data - JSON File | get_report_json | Returns data from the specified report type. You can check following link for various available reports (list updated frequently), you can access report based on API Key role / permission, participation (e.g. Vendor/Seller), seller market place etc http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html. Depending on which Report you choose, it can take upto 30 minutes to generate report. Also some reports have strict limits on how many times you can access per hour (e.g. 2 times per 30 minutes). Check documentation for call limits. |
| Get Report Data - Tab Separated File (TSV) | get_report_tsv | Returns data from the specified report type. You can check following link for various available reports (list updated frequently), you can access report based on API Key role / permission, participation (e.g. Vendor/Seller), seller market place etc http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html. Depending on which Report you choose, it can take upto 30 minutes to generate report. Also some reports have strict limits on how many times you can access per hour (e.g. 2 times per 30 minutes). Check documentation for call limits. |
| Get Report Data - XML File | get_report_xml | Returns data from the specified report type. You can check following link for various available reports (list updated frequently), you can access report based on API Key role / permission, participation (e.g. Vendor/Seller), seller market place etc http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html. Depending on which Report you choose, it can take upto 30 minutes to generate report. Also some reports have strict limits on how many times you can access per hour (e.g. 2 times per 30 minutes). Check documentation for call limits. |
| Get Report Filters | get_report_filters | |
| Get Report Options | get_report_options | |
| Get Report Types | get_report_types | |
| Get Vendor PurchaseOrder Items | get_vendor_purchaseorder_items | Returns a list of purchase order items created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order. [API reference] |
| Get Vendor PurchaseOrders | get_vendor_purchaseorders | Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order. [API reference] |
| Search Catalog Items | search_catalog_items | Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. [API reference] |
| Make Generic REST API Request | generic_request | This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. |
| Make Generic REST API Request (Bulk Write) | generic_request_bulk_write | This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. |