sp_api_clients 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +161 -0
  3. data/LICENSE +21 -0
  4. data/README.md +284 -0
  5. data/lib/amazon_sp_clients/adapter_loader.rb +28 -0
  6. data/lib/amazon_sp_clients/api_client.rb +309 -0
  7. data/lib/amazon_sp_clients/api_error.rb +37 -0
  8. data/lib/amazon_sp_clients/api_response.rb +54 -0
  9. data/lib/amazon_sp_clients/configuration.rb +144 -0
  10. data/lib/amazon_sp_clients/marketplaces.rb +63 -0
  11. data/lib/amazon_sp_clients/middlewares/raise_error.rb +166 -0
  12. data/lib/amazon_sp_clients/session.rb +124 -0
  13. data/lib/amazon_sp_clients/sp_fba_inventory.rb +8 -0
  14. data/lib/amazon_sp_clients/sp_feeds_2021.rb +8 -0
  15. data/lib/amazon_sp_clients/sp_fulfillment_outbound_2020.rb +8 -0
  16. data/lib/amazon_sp_clients/sp_listings_items_2021.rb +8 -0
  17. data/lib/amazon_sp_clients/sp_orders_v0.rb +8 -0
  18. data/lib/amazon_sp_clients/sp_reports_2021.rb +8 -0
  19. data/lib/amazon_sp_clients/sp_tokens_2021.rb +8 -0
  20. data/lib/amazon_sp_clients/sp_vdf_inventory_v1.rb +8 -0
  21. data/lib/amazon_sp_clients/sp_vdf_orders_v1.rb +8 -0
  22. data/lib/amazon_sp_clients/sp_vdf_shipping_v1.rb +8 -0
  23. data/lib/amazon_sp_clients/sp_vendor_invoices.rb +8 -0
  24. data/lib/amazon_sp_clients/sp_vendor_orders.rb +8 -0
  25. data/lib/amazon_sp_clients/sp_vendor_transaction_status.rb +8 -0
  26. data/lib/amazon_sp_clients/sp_vendors_shipments.rb +8 -0
  27. data/lib/amazon_sp_clients/token_exchange_auth.rb +82 -0
  28. data/lib/amazon_sp_clients/uploader.rb +77 -0
  29. data/lib/amazon_sp_clients/v2/api.rb +43 -0
  30. data/lib/amazon_sp_clients/v2/apis/fba_inventory.rb +80 -0
  31. data/lib/amazon_sp_clients/v2/apis/feeds_2021.rb +86 -0
  32. data/lib/amazon_sp_clients/v2/apis/fulfillment_outbound_2020.rb +184 -0
  33. data/lib/amazon_sp_clients/v2/apis/listings_items_2021.rb +144 -0
  34. data/lib/amazon_sp_clients/v2/apis/orders_v0.rb +165 -0
  35. data/lib/amazon_sp_clients/v2/apis/reports_2021.rb +117 -0
  36. data/lib/amazon_sp_clients/v2/apis/tokens_2021.rb +25 -0
  37. data/lib/amazon_sp_clients/v2/apis/vdf_inventory_v1.rb +26 -0
  38. data/lib/amazon_sp_clients/v2/apis/vdf_orders_v1.rb +61 -0
  39. data/lib/amazon_sp_clients/v2/apis/vdf_shipping_v1.rb +139 -0
  40. data/lib/amazon_sp_clients/v2/apis/vendor_invoices.rb +25 -0
  41. data/lib/amazon_sp_clients/v2/apis/vendor_orders.rb +106 -0
  42. data/lib/amazon_sp_clients/v2/apis/vendor_transaction_status.rb +25 -0
  43. data/lib/amazon_sp_clients/v2/apis/vendors_shipments.rb +120 -0
  44. data/lib/amazon_sp_clients/v2/apis.rb +82 -0
  45. data/lib/amazon_sp_clients/v2/client.rb +198 -0
  46. data/lib/amazon_sp_clients/v2/config.rb +85 -0
  47. data/lib/amazon_sp_clients/v2/credentials.rb +91 -0
  48. data/lib/amazon_sp_clients/v2/documents.rb +115 -0
  49. data/lib/amazon_sp_clients/v2/error_mapper.rb +235 -0
  50. data/lib/amazon_sp_clients/v2/errors.rb +117 -0
  51. data/lib/amazon_sp_clients/v2/lwa.rb +100 -0
  52. data/lib/amazon_sp_clients/v2/rdt.rb +104 -0
  53. data/lib/amazon_sp_clients/v2/token.rb +39 -0
  54. data/lib/amazon_sp_clients/v2.rb +33 -0
  55. data/lib/amazon_sp_clients/version.rb +3 -0
  56. data/lib/amazon_sp_clients.rb +69 -0
  57. data/lib/sp_api_clients.rb +6 -0
  58. data/sp_api_clients.gemspec +53 -0
  59. data/vendor/fba_inventory/lib/sp_fba_inventory/api/fba_inventory_api.rb +289 -0
  60. data/vendor/fba_inventory/lib/sp_fba_inventory.rb +12 -0
  61. data/vendor/feeds_2021/lib/sp_feeds_2021/api/feeds_api.rb +367 -0
  62. data/vendor/feeds_2021/lib/sp_feeds_2021.rb +12 -0
  63. data/vendor/fulfillment_outbound_2020/lib/sp_fulfillment_outbound_2020/api/fba_outbound_api.rb +845 -0
  64. data/vendor/fulfillment_outbound_2020/lib/sp_fulfillment_outbound_2020.rb +12 -0
  65. data/vendor/listings_items_2021/lib/sp_listings_items_2021/api/listings_api.rb +480 -0
  66. data/vendor/listings_items_2021/lib/sp_listings_items_2021.rb +12 -0
  67. data/vendor/orders_v0/lib/sp_orders_v0/api/orders_v0_api.rb +593 -0
  68. data/vendor/orders_v0/lib/sp_orders_v0/api/shipment_api.rb +83 -0
  69. data/vendor/orders_v0/lib/sp_orders_v0.rb +13 -0
  70. data/vendor/reports_2021/lib/sp_reports_2021/api/reports_api.rb +530 -0
  71. data/vendor/reports_2021/lib/sp_reports_2021.rb +12 -0
  72. data/vendor/tokens_2021/lib/sp_tokens_2021/api/tokens_api.rb +77 -0
  73. data/vendor/tokens_2021/lib/sp_tokens_2021.rb +12 -0
  74. data/vendor/vdf_inventory_v1/lib/sp_vdf_inventory_v1/api/update_inventory_api.rb +83 -0
  75. data/vendor/vdf_inventory_v1/lib/sp_vdf_inventory_v1.rb +12 -0
  76. data/vendor/vdf_orders_v1/lib/sp_vdf_orders_v1/api/vendor_orders_api.rb +217 -0
  77. data/vendor/vdf_orders_v1/lib/sp_vdf_orders_v1.rb +12 -0
  78. data/vendor/vdf_shipping_v1/lib/sp_vdf_shipping_v1/api/customer_invoices_api.rb +152 -0
  79. data/vendor/vdf_shipping_v1/lib/sp_vdf_shipping_v1/api/vendor_shipping_api.rb +264 -0
  80. data/vendor/vdf_shipping_v1/lib/sp_vdf_shipping_v1/api/vendor_shipping_labels_api.rb +208 -0
  81. data/vendor/vdf_shipping_v1/lib/sp_vdf_shipping_v1.rb +14 -0
  82. data/vendor/vendor_invoices/lib/sp_vendor_invoices/api/vendor_payments_api.rb +77 -0
  83. data/vendor/vendor_invoices/lib/sp_vendor_invoices.rb +12 -0
  84. data/vendor/vendor_orders/lib/sp_vendor_orders/api/vendor_orders_api.rb +323 -0
  85. data/vendor/vendor_orders/lib/sp_vendor_orders.rb +12 -0
  86. data/vendor/vendor_transaction_status/lib/sp_vendor_transaction_status/api/vendor_transaction_api.rb +75 -0
  87. data/vendor/vendor_transaction_status/lib/sp_vendor_transaction_status.rb +12 -0
  88. data/vendor/vendors_shipments/lib/sp_vendors_shipments/api/vendor_shipping_api.rb +337 -0
  89. data/vendor/vendors_shipments/lib/sp_vendors_shipments.rb +12 -0
  90. metadata +321 -0
@@ -0,0 +1,165 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Orders
10
+ #
11
+ # Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don't show up in the response).
12
+ #
13
+ # OpenAPI spec version: v0
14
+ class OrdersV0 < Api
15
+ # Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param body [Hash] Request body of `confirmShipment`. (ConfirmShipmentRequest)
18
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
19
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
20
+ # @return [AmazonSpClients::ApiResponse]
21
+ def confirm_shipment(body, order_id, rdt: nil)
22
+ request(:post, "/orders/v0/orders/#{encode(order_id)}/shipmentConfirmation", body: body, rdt: rdt)
23
+ end
24
+
25
+ # Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
26
+ #
27
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
28
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
29
+ # @return [AmazonSpClients::ApiResponse]
30
+ def get_order(order_id, rdt: nil)
31
+ request(:get, "/orders/v0/orders/#{encode(order_id)}", rdt: rdt)
32
+ end
33
+
34
+ # Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
35
+ #
36
+ # @param order_id [String] An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
37
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
38
+ # @return [AmazonSpClients::ApiResponse]
39
+ def get_order_address(order_id, rdt: nil)
40
+ request(:get, "/orders/v0/orders/#{encode(order_id)}/address", rdt: rdt)
41
+ end
42
+
43
+ # Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
44
+ #
45
+ # @param order_id [String] An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
46
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
47
+ # @return [AmazonSpClients::ApiResponse]
48
+ def get_order_buyer_info(order_id, rdt: nil)
49
+ request(:get, "/orders/v0/orders/#{encode(order_id)}/buyerInfo", rdt: rdt)
50
+ end
51
+
52
+ # Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
53
+ #
54
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
55
+ # @param next_token [String, nil] A string token returned in the response of your previous request.
56
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
57
+ # @return [AmazonSpClients::ApiResponse]
58
+ def get_order_items(order_id, next_token: nil, rdt: nil)
59
+ query = {
60
+ 'NextToken' => next_token
61
+ }
62
+
63
+ request(:get, "/orders/v0/orders/#{encode(order_id)}/orderItems", query: query, rdt: rdt)
64
+ end
65
+
66
+ # Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
67
+ #
68
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
69
+ # @param next_token [String, nil] A string token returned in the response of your previous request.
70
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
71
+ # @return [AmazonSpClients::ApiResponse]
72
+ def get_order_items_buyer_info(order_id, next_token: nil, rdt: nil)
73
+ query = {
74
+ 'NextToken' => next_token
75
+ }
76
+
77
+ request(:get, "/orders/v0/orders/#{encode(order_id)}/orderItems/buyerInfo", query: query, rdt: rdt)
78
+ end
79
+
80
+ # Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
81
+ #
82
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
83
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
84
+ # @return [AmazonSpClients::ApiResponse]
85
+ def get_order_regulated_info(order_id, rdt: nil)
86
+ request(:get, "/orders/v0/orders/#{encode(order_id)}/regulatedInfo", rdt: rdt)
87
+ end
88
+
89
+ # Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
90
+ #
91
+ # @param marketplace_ids [Array<String>] A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
92
+ # @param created_after [String, nil] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
93
+ # @param created_before [String, nil] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
94
+ # @param last_updated_after [String, nil] Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.
95
+ # @param last_updated_before [String, nil] Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.
96
+ # @param order_statuses [Array<String>, nil] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
97
+ # @param fulfillment_channels [Array<String>, nil] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
98
+ # @param payment_methods [Array<String>, nil] A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
99
+ # @param buyer_email [String, nil] The email address of a buyer. Used to select orders that contain the specified email address.
100
+ # @param seller_order_id [String, nil] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.
101
+ # @param max_results_per_page [Integer, nil] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
102
+ # @param easy_ship_shipment_statuses [Array<String>, nil] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
103
+ # @param electronic_invoice_statuses [Array<String>, nil] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
104
+ # @param next_token [String, nil] A string token returned in the response of your previous request.
105
+ # @param amazon_order_ids [Array<String>, nil] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
106
+ # @param actual_fulfillment_supply_source_id [String, nil] The `sourceId` of the location from where you want the order fulfilled.
107
+ # @param is_ispu [Boolean, nil] When true, this order is marked to be picked up from a store rather than delivered.
108
+ # @param store_chain_store_id [String, nil] The store chain store identifier. Linked to a specific store in a store chain.
109
+ # @param earliest_delivery_date_before [String, nil] Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
110
+ # @param earliest_delivery_date_after [String, nil] Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
111
+ # @param latest_delivery_date_before [String, nil] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
112
+ # @param latest_delivery_date_after [String, nil] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
113
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
114
+ # @return [AmazonSpClients::ApiResponse]
115
+ def get_orders(marketplace_ids, created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil, order_statuses: nil, fulfillment_channels: nil, payment_methods: nil, buyer_email: nil, seller_order_id: nil, max_results_per_page: nil, easy_ship_shipment_statuses: nil, electronic_invoice_statuses: nil, next_token: nil, amazon_order_ids: nil, actual_fulfillment_supply_source_id: nil, is_ispu: nil, store_chain_store_id: nil, earliest_delivery_date_before: nil, earliest_delivery_date_after: nil, latest_delivery_date_before: nil, latest_delivery_date_after: nil, rdt: nil)
116
+ query = {
117
+ 'CreatedAfter' => created_after,
118
+ 'CreatedBefore' => created_before,
119
+ 'LastUpdatedAfter' => last_updated_after,
120
+ 'LastUpdatedBefore' => last_updated_before,
121
+ 'OrderStatuses' => csv(order_statuses),
122
+ 'MarketplaceIds' => csv(marketplace_ids),
123
+ 'FulfillmentChannels' => csv(fulfillment_channels),
124
+ 'PaymentMethods' => csv(payment_methods),
125
+ 'BuyerEmail' => buyer_email,
126
+ 'SellerOrderId' => seller_order_id,
127
+ 'MaxResultsPerPage' => max_results_per_page,
128
+ 'EasyShipShipmentStatuses' => csv(easy_ship_shipment_statuses),
129
+ 'ElectronicInvoiceStatuses' => csv(electronic_invoice_statuses),
130
+ 'NextToken' => next_token,
131
+ 'AmazonOrderIds' => csv(amazon_order_ids),
132
+ 'ActualFulfillmentSupplySourceId' => actual_fulfillment_supply_source_id,
133
+ 'IsISPU' => is_ispu,
134
+ 'StoreChainStoreId' => store_chain_store_id,
135
+ 'EarliestDeliveryDateBefore' => earliest_delivery_date_before,
136
+ 'EarliestDeliveryDateAfter' => earliest_delivery_date_after,
137
+ 'LatestDeliveryDateBefore' => latest_delivery_date_before,
138
+ 'LatestDeliveryDateAfter' => latest_delivery_date_after
139
+ }
140
+
141
+ request(:get, '/orders/v0/orders', query: query, rdt: rdt)
142
+ end
143
+
144
+ # Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
145
+ #
146
+ # @param body [Hash] The request body for the `updateShipmentStatus` operation. (UpdateShipmentStatusRequest)
147
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
148
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
149
+ # @return [AmazonSpClients::ApiResponse]
150
+ def update_shipment_status(body, order_id, rdt: nil)
151
+ request(:post, "/orders/v0/orders/#{encode(order_id)}/shipment", body: body, rdt: rdt)
152
+ end
153
+
154
+ # Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
155
+ #
156
+ # @param body [Hash] The request body for the `updateVerificationStatus` operation. (UpdateVerificationStatusRequest)
157
+ # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
158
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
159
+ # @return [AmazonSpClients::ApiResponse]
160
+ def update_verification_status(body, order_id, rdt: nil)
161
+ request(:patch, "/orders/v0/orders/#{encode(order_id)}/regulatedInfo", body: body, rdt: rdt)
162
+ end
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,117 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Reports
10
+ #
11
+ # The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses.
12
+ #
13
+ # OpenAPI spec version: 2021-06-30
14
+ class Reports2021 < Api
15
+ # Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled reports are returned in subsequent calls to the `getReport` and `getReports` operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a seller ID.
18
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
19
+ # @return [AmazonSpClients::ApiResponse]
20
+ def cancel_report(report_id, rdt: nil)
21
+ request(:delete, "/reports/2021-06-30/reports/#{encode(report_id)}", rdt: rdt)
22
+ end
23
+
24
+ # Cancels the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
+ #
26
+ # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in combination with a seller ID.
27
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
28
+ # @return [AmazonSpClients::ApiResponse]
29
+ def cancel_report_schedule(report_schedule_id, rdt: nil)
30
+ request(:delete, "/reports/2021-06-30/schedules/#{encode(report_schedule_id)}", rdt: rdt)
31
+ end
32
+
33
+ # Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
34
+ #
35
+ # @param body [Hash] Information required to create the report. (CreateReportSpecification)
36
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
37
+ # @return [AmazonSpClients::ApiResponse]
38
+ def create_report(body, rdt: nil)
39
+ request(:post, '/reports/2021-06-30/reports', body: body, rdt: rdt)
40
+ end
41
+
42
+ # Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
43
+ #
44
+ # @param body [Hash] Information required to create the report schedule. (CreateReportScheduleSpecification)
45
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
46
+ # @return [AmazonSpClients::ApiResponse]
47
+ def create_report_schedule(body, rdt: nil)
48
+ request(:post, '/reports/2021-06-30/schedules', body: body, rdt: rdt)
49
+ end
50
+
51
+ # Returns report details (including the `reportDocumentId`, if available) for the report that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
52
+ #
53
+ # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a seller ID.
54
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
55
+ # @return [AmazonSpClients::ApiResponse]
56
+ def get_report(report_id, rdt: nil)
57
+ request(:get, "/reports/2021-06-30/reports/#{encode(report_id)}", rdt: rdt)
58
+ end
59
+
60
+ # Returns the information required for retrieving a report document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
61
+ #
62
+ # @param report_document_id [String] The identifier for the report document.
63
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
64
+ # @return [AmazonSpClients::ApiResponse]
65
+ def get_report_document(report_document_id, rdt: nil)
66
+ request(:get, "/reports/2021-06-30/documents/#{encode(report_document_id)}", rdt: rdt)
67
+ end
68
+
69
+ # Returns report schedule details for the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
70
+ #
71
+ # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in combination with a seller ID.
72
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
73
+ # @return [AmazonSpClients::ApiResponse]
74
+ def get_report_schedule(report_schedule_id, rdt: nil)
75
+ request(:get, "/reports/2021-06-30/schedules/#{encode(report_schedule_id)}", rdt: rdt)
76
+ end
77
+
78
+ # Returns report schedule details that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
79
+ #
80
+ # @param report_types [Array<String>] A list of report types used to filter report schedules. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
81
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
82
+ # @return [AmazonSpClients::ApiResponse]
83
+ def get_report_schedules(report_types, rdt: nil)
84
+ query = {
85
+ 'reportTypes' => csv(report_types)
86
+ }
87
+
88
+ request(:get, '/reports/2021-06-30/schedules', query: query, rdt: rdt)
89
+ end
90
+
91
+ # Returns report details for the reports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
92
+ #
93
+ # @param report_types [Array<String>, nil] A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.
94
+ # @param processing_statuses [Array<String>, nil] A list of processing statuses used to filter reports.
95
+ # @param marketplace_ids [Array<String>, nil] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.
96
+ # @param page_size [Integer, nil] The maximum number of reports to return in a single call.
97
+ # @param created_since [String, nil] The earliest report creation date and time for reports to include in the response, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.
98
+ # @param created_until [String, nil] The latest report creation date and time for reports to include in the response, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format. The default is now.
99
+ # @param next_token [String, nil] A string token returned in the response to your previous request. `nextToken` is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getReports` operation and include this token as the only parameter. Specifying `nextToken` with any other parameters will cause the request to fail.
100
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
101
+ # @return [AmazonSpClients::ApiResponse]
102
+ def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: nil, created_since: nil, created_until: nil, next_token: nil, rdt: nil)
103
+ query = {
104
+ 'reportTypes' => csv(report_types),
105
+ 'processingStatuses' => csv(processing_statuses),
106
+ 'marketplaceIds' => csv(marketplace_ids),
107
+ 'pageSize' => page_size,
108
+ 'createdSince' => created_since,
109
+ 'createdUntil' => created_until,
110
+ 'nextToken' => next_token
111
+ }
112
+
113
+ request(:get, '/reports/2021-06-30/reports', query: query, rdt: rdt)
114
+ end
115
+ end
116
+ end
117
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Tokens
10
+ #
11
+ # The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the restricted resources that you specified. For more information, see the [Tokens API Use Case Guide](doc:tokens-api-use-case-guide).
12
+ #
13
+ # OpenAPI spec version: 2021-03-01
14
+ class Tokens2021 < Api
15
+ # Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param body [Hash] The restricted data token request details. (CreateRestrictedDataTokenRequest)
18
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
19
+ # @return [AmazonSpClients::ApiResponse]
20
+ def create_restricted_data_token(body, rdt: nil)
21
+ request(:post, '/tokens/2021-03-01/restrictedDataToken', body: body, rdt: rdt)
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Direct Fulfillment Inventory Updates
10
+ #
11
+ # The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor's inventory updates.
12
+ #
13
+ # OpenAPI spec version: v1
14
+ class VdfInventoryV1 < Api
15
+ # Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param body [Hash] The request body containing the inventory update data to submit. (SubmitInventoryUpdateRequest)
18
+ # @param warehouse_id [String] Identifier for the warehouse for which to update inventory.
19
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
20
+ # @return [AmazonSpClients::ApiResponse]
21
+ def submit_inventory_update(body, warehouse_id, rdt: nil)
22
+ request(:post, "/vendor/directFulfillment/inventory/v1/warehouses/#{encode(warehouse_id)}/items", body: body, rdt: rdt)
23
+ end
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,61 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Direct Fulfillment Orders
10
+ #
11
+ # The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.
12
+ #
13
+ # OpenAPI spec version: v1
14
+ class VdfOrdersV1 < Api
15
+ # Returns purchase order information for the purchaseOrderNumber 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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
18
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
19
+ # @return [AmazonSpClients::ApiResponse]
20
+ def get_order(purchase_order_number, rdt: nil)
21
+ request(:get, "/vendor/directFulfillment/orders/v1/purchaseOrders/#{encode(purchase_order_number)}", rdt: rdt)
22
+ end
23
+
24
+ # Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific 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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
+ #
26
+ # @param created_after [String] Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
27
+ # @param created_before [String] Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
28
+ # @param ship_from_party_id [String, nil] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
29
+ # @param status [String, nil] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
30
+ # @param limit [Integer, nil] The limit to the number of purchase orders returned.
31
+ # @param sort_order [String, nil] Sort the list in ascending or descending order by order creation date.
32
+ # @param next_token [String, nil] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
33
+ # @param include_details [String, nil] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
34
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
35
+ # @return [AmazonSpClients::ApiResponse]
36
+ def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil, next_token: nil, include_details: nil, rdt: nil)
37
+ query = {
38
+ 'shipFromPartyId' => ship_from_party_id,
39
+ 'status' => status,
40
+ 'limit' => limit,
41
+ 'createdAfter' => created_after,
42
+ 'createdBefore' => created_before,
43
+ 'sortOrder' => sort_order,
44
+ 'nextToken' => next_token,
45
+ 'includeDetails' => include_details
46
+ }
47
+
48
+ request(:get, '/vendor/directFulfillment/orders/v1/purchaseOrders', query: query, rdt: rdt)
49
+ end
50
+
51
+ # Submits acknowledgements for one or more purchase orders. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
52
+ #
53
+ # @param body [Hash] The request body containing the acknowledgement to an order. (SubmitAcknowledgementRequest)
54
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
55
+ # @return [AmazonSpClients::ApiResponse]
56
+ def submit_acknowledgement(body, rdt: nil)
57
+ request(:post, '/vendor/directFulfillment/orders/v1/acknowledgements', body: body, rdt: rdt)
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,139 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Direct Fulfillment Shipping
10
+ #
11
+ # The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.
12
+ #
13
+ # OpenAPI spec version: v1
14
+ class VdfShippingV1 < Api
15
+ # Returns a customer invoice based on the purchaseOrderNumber 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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param purchase_order_number [String] Purchase order number of the shipment for which to return the invoice.
18
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
19
+ # @return [AmazonSpClients::ApiResponse]
20
+ def get_customer_invoice(purchase_order_number, rdt: nil)
21
+ request(:get, "/vendor/directFulfillment/shipping/v1/customerInvoices/#{encode(purchase_order_number)}", rdt: rdt)
22
+ end
23
+
24
+ # Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
+ #
26
+ # @param created_after [String] Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
27
+ # @param created_before [String] Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
28
+ # @param ship_from_party_id [String, nil] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
29
+ # @param limit [Integer, nil] The limit to the number of records returned
30
+ # @param sort_order [String, nil] Sort ASC or DESC by order creation date.
31
+ # @param next_token [String, nil] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
32
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
33
+ # @return [AmazonSpClients::ApiResponse]
34
+ def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil, next_token: nil, rdt: nil)
35
+ query = {
36
+ 'shipFromPartyId' => ship_from_party_id,
37
+ 'limit' => limit,
38
+ 'createdAfter' => created_after,
39
+ 'createdBefore' => created_before,
40
+ 'sortOrder' => sort_order,
41
+ 'nextToken' => next_token
42
+ }
43
+
44
+ request(:get, '/vendor/directFulfillment/shipping/v1/customerInvoices', query: query, rdt: rdt)
45
+ end
46
+
47
+ # Returns a packing slip based on the purchaseOrderNumber 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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
48
+ #
49
+ # @param purchase_order_number [String] The purchaseOrderNumber for the packing slip you want.
50
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
51
+ # @return [AmazonSpClients::ApiResponse]
52
+ def get_packing_slip(purchase_order_number, rdt: nil)
53
+ request(:get, "/vendor/directFulfillment/shipping/v1/packingSlips/#{encode(purchase_order_number)}", rdt: rdt)
54
+ end
55
+
56
+ # Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
57
+ #
58
+ # @param created_after [String] Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
59
+ # @param created_before [String] Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
60
+ # @param ship_from_party_id [String, nil] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
61
+ # @param limit [Integer, nil] The limit to the number of records returned
62
+ # @param sort_order [String, nil] Sort ASC or DESC by packing slip creation date.
63
+ # @param next_token [String, nil] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
64
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
65
+ # @return [AmazonSpClients::ApiResponse]
66
+ def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil, next_token: nil, rdt: nil)
67
+ query = {
68
+ 'shipFromPartyId' => ship_from_party_id,
69
+ 'limit' => limit,
70
+ 'createdAfter' => created_after,
71
+ 'createdBefore' => created_before,
72
+ 'sortOrder' => sort_order,
73
+ 'nextToken' => next_token
74
+ }
75
+
76
+ request(:get, '/vendor/directFulfillment/shipping/v1/packingSlips', query: query, rdt: rdt)
77
+ end
78
+
79
+ # Returns a shipping label for the purchaseOrderNumber 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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
80
+ #
81
+ # @param purchase_order_number [String] The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
82
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
83
+ # @return [AmazonSpClients::ApiResponse]
84
+ def get_shipping_label(purchase_order_number, rdt: nil)
85
+ request(:get, "/vendor/directFulfillment/shipping/v1/shippingLabels/#{encode(purchase_order_number)}", rdt: rdt)
86
+ end
87
+
88
+ # Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
89
+ #
90
+ # @param created_after [String] Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
91
+ # @param created_before [String] Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
92
+ # @param ship_from_party_id [String, nil] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
93
+ # @param limit [Integer, nil] The limit to the number of records returned.
94
+ # @param sort_order [String, nil] Sort ASC or DESC by order creation date.
95
+ # @param next_token [String, nil] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
96
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
97
+ # @return [AmazonSpClients::ApiResponse]
98
+ def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil, next_token: nil, rdt: nil)
99
+ query = {
100
+ 'shipFromPartyId' => ship_from_party_id,
101
+ 'limit' => limit,
102
+ 'createdAfter' => created_after,
103
+ 'createdBefore' => created_before,
104
+ 'sortOrder' => sort_order,
105
+ 'nextToken' => next_token
106
+ }
107
+
108
+ request(:get, '/vendor/directFulfillment/shipping/v1/shippingLabels', query: query, rdt: rdt)
109
+ end
110
+
111
+ # Submits one or more shipment confirmations for vendor orders. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
112
+ #
113
+ # @param body [Hash] Request body containing the shipment confirmations data. (SubmitShipmentConfirmationsRequest)
114
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
115
+ # @return [AmazonSpClients::ApiResponse]
116
+ def submit_shipment_confirmations(body, rdt: nil)
117
+ request(:post, '/vendor/directFulfillment/shipping/v1/shipmentConfirmations', body: body, rdt: rdt)
118
+ end
119
+
120
+ # This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
121
+ #
122
+ # @param body [Hash] Request body containing the shipment status update data. (SubmitShipmentStatusUpdatesRequest)
123
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
124
+ # @return [AmazonSpClients::ApiResponse]
125
+ def submit_shipment_status_updates(body, rdt: nil)
126
+ request(:post, '/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates', body: body, rdt: rdt)
127
+ end
128
+
129
+ # Creates a shipping label for a purchase order and returns a transactionId for reference. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
130
+ #
131
+ # @param body [Hash] Request body containing one or more shipping labels data. (SubmitShippingLabelsRequest)
132
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
133
+ # @return [AmazonSpClients::ApiResponse]
134
+ def submit_shipping_label_request(body, rdt: nil)
135
+ request(:post, '/vendor/directFulfillment/shipping/v1/shippingLabels', body: body, rdt: rdt)
136
+ end
137
+ end
138
+ end
139
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated by lib/generator (bundle exec rake generate). Do not edit.
4
+
5
+ require 'amazon_sp_clients/v2/api'
6
+
7
+ module AmazonSpClients
8
+ module V2
9
+ # Selling Partner API for Retail Procurement Payments
10
+ #
11
+ # The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data.
12
+ #
13
+ # OpenAPI spec version: v1
14
+ class VendorInvoices < Api
15
+ # Submit new invoices to Amazon. **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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
16
+ #
17
+ # @param body [Hash] The request body containing the invoice data to submit. (SubmitInvoicesRequest)
18
+ # @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
19
+ # @return [AmazonSpClients::ApiResponse]
20
+ def submit_invoices(body, rdt: nil)
21
+ request(:post, '/vendor/payments/v1/invoices', body: body, rdt: rdt)
22
+ end
23
+ end
24
+ end
25
+ end