python-amazon-sp-api 2.0.15__py3-none-any.whl → 2.1.3__py3-none-any.whl

sp_api/api/vendor_invoices/vendor_invoices.py

@@ -15,278 +15,29 @@ class VendorInvoices(Client):
     def submit_invoices(self, data, **kwargs) -> ApiResponse:
         """
         submit_invoices(self, data, **kwargs) -> ApiResponse
-
+        
         Submit new invoices to Amazon.
-
-        **Usage Plans:**
-
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         10                                      10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorInvoices().submit_invoices("value")
+        
         Args:
-            data:
-            {
-              "invoices": [
-                {
-                  "invoiceType": "Invoice",
-                  "id": "string",
-                  "referenceNumber": "string",
-                  "date": "2019-08-24T14:15:22Z",
-                  "remitToParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalOrZipCode": "string",
-                      "countryCode": "st",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string"
-                      }
-                    ]
-                  },
-                  "shipToParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalOrZipCode": "string",
-                      "countryCode": "st",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string"
-                      }
-                    ]
-                  },
-                  "shipFromParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalOrZipCode": "string",
-                      "countryCode": "st",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string"
-                      }
-                    ]
-                  },
-                  "billToParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalOrZipCode": "string",
-                      "countryCode": "st",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string"
-                      }
-                    ]
-                  },
-                  "paymentTerms": {
-                    "type": "Basic",
-                    "discountPercent": "string",
-                    "discountDueDays": 0,
-                    "netDueDays": 0
-                  },
-                  "invoiceTotal": {
-                    "currencyCode": "string",
-                    "amount": "string"
-                  },
-                  "taxDetails": [
-                    {
-                      "taxType": "CGST",
-                      "taxRate": "string",
-                      "taxAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "taxableAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      }
-                    }
-                  ],
-                  "additionalDetails": [
-                    {
-                      "type": "SUR",
-                      "detail": "string",
-                      "languageCode": "string"
-                    }
-                  ],
-                  "chargeDetails": [
-                    {
-                      "type": "Freight",
-                      "description": "string",
-                      "chargeAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "taxDetails": [
-                        {
-                          "taxType": "CGST",
-                          "taxRate": "string",
-                          "taxAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxableAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          }
-                        }
-                      ]
-                    }
-                  ],
-                  "allowanceDetails": [
-                    {
-                      "type": "Discount",
-                      "description": "string",
-                      "allowanceAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "taxDetails": [
-                        {
-                          "taxType": "CGST",
-                          "taxRate": "string",
-                          "taxAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxableAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          }
-                        }
-                      ]
-                    }
-                  ],
-                  "items": [
-                    {
-                      "itemSequenceNumber": 0,
-                      "amazonProductIdentifier": "string",
-                      "vendorProductIdentifier": "string",
-                      "invoicedQuantity": {
-                        "amount": 0,
-                        "unitOfMeasure": "Cases",
-                        "unitSize": 0
-                      },
-                      "netCost": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "purchaseOrderNumber": "string",
-                      "hsnCode": "string",
-                      "creditNoteDetails": {
-                        "referenceInvoiceNumber": "string",
-                        "debitNoteNumber": "string",
-                        "returnsReferenceNumber": "string",
-                        "goodsReturnDate": "2019-08-24T14:15:22Z",
-                        "rmaId": "string",
-                        "coopReferenceNumber": "string",
-                        "consignorsReferenceNumber": "string"
-                      },
-                      "taxDetails": [
-                        {
-                          "taxType": "CGST",
-                          "taxRate": "string",
-                          "taxAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxableAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          }
-                        }
-                      ],
-                      "chargeDetails": [
-                        {
-                          "type": "Freight",
-                          "description": "string",
-                          "chargeAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxDetails": [
-                            {
-                              "taxType": "CGST",
-                              "taxRate": "string",
-                              "taxAmount": {},
-                              "taxableAmount": {}
-                            }
-                          ]
-                        }
-                      ],
-                      "allowanceDetails": [
-                        {
-                          "type": "Discount",
-                          "description": "string",
-                          "allowanceAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxDetails": [
-                            {
-                              "taxType": "CGST",
-                              "taxRate": "string",
-                              "taxAmount": {},
-                              "taxableAmount": {}
-                            }
-                          ]
-                        }
-                      ]
-                    }
-                  ]
-                }
-              ]
-            }
-
+            body: SubmitInvoicesRequest | required The request body containing the invoice data to submit.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(

sp_api/api/vendor_orders/vendor_orders.py

@@ -15,35 +15,40 @@ class VendorOrders(Client):
     def get_purchase_orders(self, **kwargs) -> ApiResponse:
         """
         get_purchase_orders(self, **kwargs) -> ApiResponse
-
-        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.
-
-        **Usage Plans:**
-
+        
+        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.
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         10                                      10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorOrders().get_purchase_orders()
+        
         Args:
-            key limit:integer |  The limit to the number of records returned. Default value is 100 records.
-            key createdAfter:string |  Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
-            key createdBefore:string |  Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
-            key sortOrder:string |  Sort in ascending or descending order by purchase order creation date.
-            key nextToken:string |  Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call
-            key includeDetails:string |  When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
-            key changedAfter:string |  Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
-            key changedBefore:string |  Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
-            key poItemState:string |  Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
-            key isPOChanged:string |  When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
-            key purchaseOrderState:string |  Filters purchase orders based on the purchase order state.
-            key orderingVendorCode:string |  Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
-
+            key limit: object |  The limit to the number of records returned. Default value is 100 records.
+            key createdAfter: object |  Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
+            key createdBefore: object |  Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
+            key sortOrder: object |  Sort in ascending or descending order by purchase order creation date.
+            key nextToken: object |  Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call
+            key includeDetails: object |  When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
+            key changedAfter: object |  Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
+            key changedBefore: object |  Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
+            key poItemState: object |  Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
+            key isPOChanged: object |  When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
+            key purchaseOrderState: object |  Filters purchase orders based on the purchase order state.
+            key orderingVendorCode: object |  Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), params=kwargs)
@@ -52,25 +57,29 @@ class VendorOrders(Client):
     def get_purchase_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
         """
         get_purchase_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse
-
-        Returns a purchase order based on the purchaseOrderNumber value that you specify.
-
-        **Usage Plans:**
-
-
+        
+        Returns a purchase order based on the `purchaseOrderNumber` value that you specify.
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         10                                      10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorOrders().get_purchase_order("value")
+        
         Args:
-            purchaseOrderNumber:string | * REQUIRED The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
-
+            purchaseOrderNumber: object | required The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -81,91 +90,29 @@ class VendorOrders(Client):
     def submit_acknowledgement(self, **kwargs) -> ApiResponse:
         """
         submit_acknowledgement(self, **kwargs) -> ApiResponse
-
+        
         Submits acknowledgements for one or more purchase orders.
-
-        **Usage Plans:**
-
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         10                                      10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
         Examples:
             literal blocks::
-
-                {
-                    "acknowledgements": [
-                        {
-                            "purchaseOrderNumber": "string",
-                            "sellingParty": {
-                                "partyId": "string",
-                                "address": {
-                                    "name": "string",
-                                    "addressLine1": "string",
-                                    "addressLine2": "string",
-                                    "addressLine3": "string",
-                                    "city": "string",
-                                    "county": "string",
-                                    "district": "string",
-                                    "stateOrRegion": "string",
-                                    "postalCode": "string",
-                                    "countryCode": "st",
-                                    "phone": "string"
-                                },
-                                "taxInfo": {
-                                    "taxRegistrationType": "VAT",
-                                    "taxRegistrationNumber": "string"
-                                }
-                            },
-                            "acknowledgementDate": "2019-08-24T14:15:22Z",
-                            "items": [
-                                {
-                                    "itemSequenceNumber": "string",
-                                    "amazonProductIdentifier": "string",
-                                    "vendorProductIdentifier": "string",
-                                    "orderedQuantity": {
-                                        "amount": 0,
-                                        "unitOfMeasure": "Cases",
-                                        "unitSize": 0
-                                    },
-                                    "netCost": {
-                                        "currencyCode": "str",
-                                        "amount": "string"
-                                    },
-                                    "listPrice": {
-                                        "currencyCode": "str",
-                                        "amount": "string"
-                                    },
-                                    "discountMultiplier": "string",
-                                    "itemAcknowledgements": [
-                                        {
-                                            "acknowledgementCode": "Accepted",
-                                            "acknowledgedQuantity": {
-                                                "amount": 0,
-                                                "unitOfMeasure": "Cases",
-                                                "unitSize": 0
-                                            },
-                                            "scheduledShipDate": "2019-08-24T14:15:22Z",
-                                            "scheduledDeliveryDate": "2019-08-24T14:15:22Z",
-                                            "rejectionReason": "TemporarilyUnavailable"
-                                        }
-                                    ]
-                                }
-                            ]
-                        }
-                    ]
-                }
-
-
+            
+                VendorOrders().submit_acknowledgement()
+        
         Args:
-            kwargs: acknowledgements | See Example
-
+            body: SubmitAcknowledgementRequest | required Submits acknowledgements for one or more purchase orders from a vendor.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
@@ -174,36 +121,41 @@ class VendorOrders(Client):
     def get_purchase_orders_status(self, **kwargs) -> ApiResponse:
         """
         get_purchase_orders_status(self, **kwargs) -> ApiResponse
-
+        
         Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.
-
-        **Usage Plans:**
-
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         10                                      10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorOrders().get_purchase_orders_status()
+        
         Args:
-            key limit:integer |  The limit to the number of records returned. Default value is 100 records.
-            key sortOrder:string |  Sort in ascending or descending order by purchase order creation date.
-            key nextToken:string |  Used for pagination when there are more purchase orders than the specified result size limit.
-            key createdAfter:string |  Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
-            key createdBefore:string |  Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
-            key updatedAfter:string |  Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
-            key updatedBefore:string |  Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
-            key purchaseOrderNumber:string |  Provides purchase order status for the specified purchase order number.
-            key purchaseOrderStatus:string |  Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
-            key itemConfirmationStatus:string |  Filters purchase orders based on the specified purchase order item status. If not included in filter, purchase orders for all statuses are included.
-            key orderingVendorCode:string |  Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.
-            key shipToPartyId:string |  Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders.
-
-
+            key limit: object |  The limit to the number of records returned. Default value is 100 records.
+            key sortOrder: object |  Sort in ascending or descending order by purchase order creation date.
+            key nextToken: object |  Used for pagination when there are more purchase orders than the specified result size limit.
+            key createdAfter: object |  Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
+            key createdBefore: object |  Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
+            key updatedAfter: object |  Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
+            key updatedBefore: object |  Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
+            key purchaseOrderNumber: object |  Provides purchase order status for the specified purchase order number.
+            key purchaseOrderStatus: object |  Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
+            key itemConfirmationStatus: object |  Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.
+            key itemReceiveStatus: object |  Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included.
+            key orderingVendorCode: object |  Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.
+            key shipToPartyId: object |  Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), params=kwargs)