Amazon Selling Partner API Configuration Examples

Generic Input Configuration

Generic ASP api input

{
    "input": {
        "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": "https://sellingpartnerapi-na.amazon.com",
        "params": {
            "interval": "2020-01-01T00:00:00-00:00--2020-12-31T00:00:00-00:00",
            "granularity": "Day",
            "marketplaceIds": "ATVPDKIKX0DER"
        },
        "path": "/sales/v1/orderMetrics",
        "use": "amazon_selling_partner_api.io#AmazonSPApiInput"
    },
    "output": {
        "path": "/app/mitto/data/report.json",
        "use": "call:mitto.iov2.tojson#tojson"
    },
    "steps": [
        {
            "transforms": [
                {
                    "include_empty_columns": true,
                    "rename_columns": false,
                    "use": "mitto.iov2.transform#ExtraColumnsTransform"
                }
            ],
            "use": "mitto.iov2.steps#Input"
        },
        {
            "transforms": [
                {
                    "use": "mitto.iov2.transform#FlattenTransform"
                }
            ],
            "use": "mitto.iov2.steps#Output"
        }
    ]
}

Report Input job

Input to retrieve data from reports

{
    "input": {
        "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": "https: //sellingpartnerapi-na.amazon.com",
        "report_spec": {
            "reportType": "GET_SALES_AND_TRAFFIC_REPORT",
            "dataStartTime": "2022-01-01",
            "dataEndTime": "2022-04-30",
            "marketplaceIds": [
                "ATVPDKIKX0DER"
            ]
        },
        "file_format": "CSV",
        "use": "amazon_selling_partner_api.io#AmazonSPApiReportInput"
    },
    "output": {
        "path": "/var/mitto/data/amazon_sp_sales_us.json",
        "use": "call:mitto.iov2.tojson#tojson"
    },
    "steps": [
        {
            "transforms": [
                {
                    "include_empty_columns": true,
                    "rename_columns": false,
                    "use": "mitto.iov2.transform#ExtraColumnsTransform"
                }
            ],
            "use": "mitto.iov2.steps#Input"
        },
        {
            "transforms": [
                {
                    "use": "mitto.iov2.transform#FlattenTransform"
                }
            ],
            "use": "mitto.iov2.steps#Output"
        }
    ]
}

Download report job type

Download report job asp_report

{
    "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": "https://sellingpartnerapi-na.amazon.com",
    "report_spec": {
      "reportType": "GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL",
      "dataStartTime": "2020-12-30",
      "dataEndTime": "2020-12-31",
      "marketplaceIds": [
        "ATVPDKIKX0DER"
      ]
    },
    "file_format": "CSV",
    "filename": "report_csv"
}