KeyError: 'includedData'

[rigelethan]

Hello everyone! I am very new to Python and coding in general and I'm trying to wrap my head around this program I am trying to make. I did not write the bulk of the code myself and instead got the majority of the code from a youtube video. However, I have put some time in trying to understand it and work through the problem before coming here.

I was able to get the sample code from the video working and was able to populate a google sheet with my past orders. After trying to alter the code for my intended use, (which is to pull Amazon Catalog data) I can not get it to work. When attempting to compile the code i get:"KeyError: 'includedData'" on this line: res.get_catalog_item(asin='B0CBQXFK42').payload. I am confused because includedData appears to be an optional parameters and I'm not including it so I don't quite know what is causing this error. My googling and poking around the CatalogItems.py file has lead me stumped so I would love if someone could explain what is causing the issue so I could attempt to fix it.

Thank you and here is the code:

from dataclasses import dataclass, asdict
from datetime import date
from typing import List

import gspread
from oauth2client.service_account import ServiceAccountCredentials
from sp_api.api import CatalogItems
from sp_api.base import SellingApiException, Marketplaces

import const

class GoogleSheets:
    def __init__(self, credentials_file: str, sheet_key: str, worksheet_name: str):
        self.credentials_file = credentials_file
        self.sheet_key = sheet_key
        self.worksheet_name = worksheet_name
        self.scope = [
            "https://spreadsheets.google.com/feeds",
        ]
        self.sheet_object = self._get_sheet_object()

    def _get_sheet_object(self) -> gspread.worksheet.Worksheet:
        credentials = ServiceAccountCredentials.from_json_keyfile_name(
            self.credentials_file, self.scope
        )
        client = gspread.authorize(credentials)
        return client.open_by_key(self.sheet_key).worksheet(self.worksheet_name)

    def write_header_if_doesnt_exist(self, columns: List[str]) -> None:
        data = self.sheet_object.get_all_values()
        if not data:
            self.sheet_object.insert_row(columns)

    def append_rows(self, rows: List[List]) -> None:
        last_row_number = len(self.sheet_object.col_values(1)) + 1
        self.sheet_object.insert_rows(rows, last_row_number)

@dataclass
class AmazonCatalog:
    item_asin: str
    


HEADER = [
    "ItemAsin",
]

class AmazonScript:
    def __init__(self):
        google_sheets = GoogleSheets(
            "keys.json", const.GOOGLE_SHEETS_ID, const.GOOGLE_WORKSHEET_NAME
        )
        google_sheets.write_header_if_doesnt_exist(HEADER)
        self.get_catalog_data_and_append_to_gs(google_sheets)

    def get_catalog_data_and_append_to_gs(self, google_sheets: GoogleSheets) -> None:
        try:
            catalog_data = self.get_catalog_from_sp_api()
            ready_rows = [list(asdict(row).values()) for row in catalog_data]
            google_sheets.append_rows(ready_rows)
        except SellingApiException as e:
            print(f"Error: {e}")

    def get_catalog_from_sp_api(self) -> List[AmazonCatalog]:
        client_config = dict(
            refresh_token=const.REFRESH_TOKEN,
            lwa_app_id=const.LWA_APP_ID,
            lwa_client_secret=const.CLIENT_SECRET,
            aws_secret_key=const.AWS_SECRET_KEY,
            aws_access_key=const.AWS_ACCESS_KEY,
            role_arn=const.ROLE_ARN,
        )
        res = CatalogItems(credentials=client_config, marketplace=Marketplaces.US)
        return self.convert_response_to_amazon_catalog_list(
            res.get_catalog_item(asin='B0CBQXFK42').payload
        )

    @staticmethod
    def convert_response_to_amazon_catalog_list(
            response_payload: dict
    ) -> List[AmazonCatalog]:
        amazon_catalog_list = []
        for item in response_payload.get(""):
            amazon_catalog_list.append(
                AmazonCatalog(
                    item_asin=item.get("ItemAsin"),
                )
            )
        return amazon_catalog_list


if __name__ == '__main__':
    print("Start script.")
    am = AmazonScript()
    print("Done.")

[saleweaver]

It seems like the error may be originating from the AmazonCatalog class. I couldn’t find anything that would likely cause this issue in the code here. Let me know if there’s anything else I can help with!

[raduv]

@rigelethan This issue should hopefully be fixed on the master branch.

@saleweaver It would be really useful if there was a pypi release with this fix.

[saleweaver]

Sorry , just released

[raduv]

Thank you!

[CesarCavalcanti]

I also had the same problem, luckily I found a solution
Declare includedData kwargs

catalog.get_catalog_item(asin=asin, includedData="summaries")

[rigelethan]

Thank you that was the issue!