Amazon Selling Partner API job configuration¶
AmazonSPApiInput¶
"input": {
"use": "amazon_selling_partner_api.io#AmazonSPApiInput"
}
Credentials¶
Could be a string and represent on of Mitto’s named credentials or explicitly pointed object of values
"credentials": {
"region": "<region>",
"role_arn": "<role_arn>",
"aws_access_key_id": "<aws_access_key_id>",
"aws_secret_access_key": "<aws_secret_access_key>",
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"refresh_token": "<refresh_token>"
}
Endpoint¶
Different regions has they own ASP API endpoint.
"endpoint": "https://sellingpartnerapi-na.amazon.com"
Path¶
URL path of API to be requested.
For example to hit Orders API with requests the path value will be next according to documentation
"path": "/orders/v0/orders"
Check ASP API documentation for more details.
Params¶
Request parameters specific for each API endpoint
"params": {
"LastUpdatedAfter": "2022-02-22",
"MarketplaceIds": "ATVPDKIKX0DER",
"MaxResultsPerPage": "100"
}
Check specific API endpoint documentation page
Results key¶
Helps to specify location within response to retrieve data
"results_key": "Orders"
Check response schema
Updated at param¶
Defines property name to be set in request params with last run timestamp
"updated_at_param": "LastUpdatedAfter"
Record config¶
Allows to point property names to be used as record’s ID and last modified value
"record_config": {
"id_field": "AmazonOrderId",
"last_modified_field": "LastUpdateDate",
}
Extend resources¶
Allows to specify additional requests with using data from the main request
"extend_resources": [
{
"new_field_name": "OrderItems",
"path": "/orders/v0/orders/{}/orderItems",
"path_variable_name": "AmazonOrderId",
"results_key": "OrderItems"
}
]
Check examples page to get see example of usage.
AmazonSPApiReportInput¶
Request and use report data as input for job.
"input": {
"use": "amazon_selling_partner_api.io#AmazonSPApiReportInput"
}
Credentials¶
Could be a string and represent on of Mitto’s named credentials or explicitly pointed object of values
"credentials": {
"region": "<region>",
"role_arn": "<role_arn>",
"aws_access_key_id": "<aws_access_key_id>",
"aws_secret_access_key": "<aws_secret_access_key>",
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"refresh_token": "<refresh_token>"
}
Endpoint¶
Different regions has they own ASP API endpoint.
"endpoint": "https://sellingpartnerapi-na.amazon.com"
Report spec¶
Each report has own report type and additional parameters that might be added here
"report_spec": {
"reportType": "GET_SALES_AND_TRAFFIC_REPORT",
"dataStartTime": "2022-01-01",
"dataEndTime": "2022-04-30",
"marketplaceIds": ["ATVPDKIKX0DER"]
}
File Format¶
File format of requested report
"file_format": "CSV"
Version¶
Amazon Selling Partner reports API version
"version": "2021-06-30"
Check documentations:
Asp_ReportJobType¶
Job of asp_report type request and download report as a file.
Credentials¶
Could be a string and represent on of Mitto’s named credentials or explicitly pointed object of values
"credentials": {
"region": "<region>",
"role_arn": "<role_arn>",
"aws_access_key_id": "<aws_access_key_id>",
"aws_secret_access_key": "<aws_secret_access_key>",
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"refresh_token": "<refresh_token>"
}
Endpoint¶
Different regions has they own ASP API endpoint.
"endpoint": "https://sellingpartnerapi-na.amazon.com"
Report spec¶
Each report has own report type and additional parameters that might be added here
"report_spec": {
"reportType": "GET_SALES_AND_TRAFFIC_REPORT",
"dataStartTime": "2022-01-01",
"dataEndTime": "2022-04-30",
"marketplaceIds": ["ATVPDKIKX0DER"]
}
File Format¶
File format of requested report
"file_format": "JSON"
Output¶
Report will be saved in a file under this name or path
"file_format": "JSON"
Version¶
Amazon Selling Partner reports API version
"version": "2021-06-30"
Check documentations: