Codecov Report

Merging #166 into develop will decrease coverage by 0.09%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop     #166      +/-   ##
===========================================
- Coverage    76.25%   76.15%   -0.10%     
===========================================
  Files           19       19              
  Lines          998      994       -4     
  Branches        95       92       -3     
===========================================
- Hits           761      757       -4     
  Misses         232      232              
  Partials         5        5              

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 721b20c...b53a4af. Read the comment docs.

FeedOptions doesn't appear to be part of this request, according to the docs.

Are you seeing something different on your end?

Edit: I see this relates to _UPLOAD_VAT_INVOICE_ feed type, which so far is only mentioned here (PDF). Seems legit, then.

Can we do a bit of verification on the keys in the FeedOptions dict being passed, as well?

bump

Some changes will be made to the submit_feed function signature by #169 . Going to merge that first, and will handle the merge conflict myself when that's completed.

As for this pull, I dug into the C# client library a bit to confirm how Amazon uses the FeedOptions param. Unlike other params we've used, this one isn't a set of keyed params to add separately, but a single string param expected with a particular format. Per the example in Amazon's developer PDF (linked previously), we would expect a value like this:

feed_options = "metadata:shippingid=283845474;metadata:totalAmount=3.25;metadata:totalvatamount = 1.23;metadata:invoicenumber = INT-3431-XJE3;metadata:documenttype=CreditNote;metadata:transactionid=amzn:crow:429491192ksjfhe39s"

# formatted for readability:

feed_options = (
    "metadata:shippingid=283845474;"
    "metadata:totalAmount=3.25;"
    "metadata:totalvatamount = 1.23;"
    "metadata:invoicenumber = INT-3431-XJE3;"
    "metadata:documenttype=CreditNote;"
    "metadata:transactionid=amzn:crow:429491192ksjfhe39s"
)

The PDF says the following about these key-value pairs:

• "The key value pairs should be separated by a semicolon ‘;’. The keys should be prefixed with the word ‘metadata’, followed by a colon ‘:’ and the key name. Keys can be upper case or lower case. Amazon will trim any spaces in between. The format should be ‘key1=value1;key2=value2’."
  • "keys can be upper case or lower case", I'm taking that to mean "case-insensitive".
• "Any spaces between “=” or keys and values will be trimmed by Amazon" (don't need spaces, but they don't hurt).
• "Do not provide quotation marks around keys or values. Amazon will only accept the following characters in any of the inputs":
  • Commas, slashes, spaces, - (dash), _ (underscore), ; (semi colon), : (colon), /, \, 0-9, A-Z, a-z, #

That all said, I can accept this PR as-is, but I would like for the feed_options argument to accept a dict with keys and string values for this metadata, i.e. {"transactionid": "abc", "documenttype": "CreditNote"}, etc. We can then pass this through a helper method that serializes that input to the format Amazon is expecting.

We can keep what's here and expect the input as a string, then add the ability to accept a dict optionally later (if isinstance(feed_options, dict):, etc.).