peddler 5.3.1 → 5.5.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 (169) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +74 -11
  3. data/lib/peddler/api.rb +30 -6
  4. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/order_attribute.rb +20 -0
  5. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_execution_error.rb +24 -0
  6. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_listing.rb +24 -0
  7. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order.rb +60 -0
  8. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order_creation_data.rb +23 -0
  9. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order_reference.rb +18 -0
  10. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_shipment.rb +43 -0
  11. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/shipment_label_page_types.rb +20 -0
  12. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb +100 -0
  13. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/address.rb +4 -1
  14. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/distance.rb +20 -0
  15. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/geocodes.rb +23 -0
  16. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/handover_location.rb +23 -0
  17. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/ship_label_metadata.rb +4 -0
  18. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/shipment_info.rb +3 -0
  19. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/shipping_options.rb +4 -0
  20. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11.rb +1 -1
  21. data/lib/peddler/apis/feeds_2021_06_30.rb +8 -2
  22. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/amount.rb +2 -2
  23. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_document.rb +2 -2
  24. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_information.rb +2 -1
  25. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_preferences.rb +1 -1
  26. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_window.rb +3 -4
  27. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/drop_off_location.rb +9 -7
  28. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/feature_settings.rb +5 -1
  29. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/feature_sku.rb +1 -1
  30. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_order.rb +2 -2
  31. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_shipment.rb +6 -6
  32. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_package.rb +3 -4
  33. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_inventory_response.rb +1 -1
  34. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_sku_result.rb +12 -3
  35. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/origin.rb +2 -1
  36. data/lib/peddler/apis/fulfillment_outbound_2020_07_01/tracking_event.rb +1 -2
  37. data/lib/peddler/apis/listings_restrictions_2021_08_01/restriction_list.rb +1 -1
  38. data/lib/peddler/apis/listings_restrictions_2021_08_01.rb +4 -1
  39. data/lib/peddler/apis/notifications_v1/aggregation_filter.rb +2 -2
  40. data/lib/peddler/apis/notifications_v1/destination.rb +1 -1
  41. data/lib/peddler/apis/notifications_v1/event_bridge_resource.rb +2 -2
  42. data/lib/peddler/apis/notifications_v1/event_filter.rb +6 -6
  43. data/lib/peddler/apis/notifications_v1/marketplace_filter.rb +1 -1
  44. data/lib/peddler/apis/notifications_v1/marketplace_ids.rb +2 -2
  45. data/lib/peddler/apis/notifications_v1/order_change_type_filter.rb +2 -1
  46. data/lib/peddler/apis/notifications_v1/order_change_types.rb +2 -2
  47. data/lib/peddler/apis/notifications_v1/processing_directive.rb +18 -7
  48. data/lib/peddler/apis/notifications_v1/send_test_notification_request.rb +20 -0
  49. data/lib/peddler/apis/notifications_v1/send_test_notification_response.rb +20 -0
  50. data/lib/peddler/apis/notifications_v1/test_notification.rb +22 -0
  51. data/lib/peddler/apis/notifications_v1.rb +45 -17
  52. data/lib/peddler/apis/orders_2026_01_01/associated_order_item.rb +27 -0
  53. data/lib/peddler/apis/orders_2026_01_01/fulfillment_order.rb +19 -0
  54. data/lib/peddler/apis/orders_2026_01_01/item_packing.rb +3 -0
  55. data/lib/peddler/apis/orders_2026_01_01/item_picking.rb +1 -1
  56. data/lib/peddler/apis/orders_2026_01_01/item_proceeds_breakdown.rb +5 -5
  57. data/lib/peddler/apis/orders_2026_01_01/item_proceeds_detailed_breakdown.rb +1 -1
  58. data/lib/peddler/apis/orders_2026_01_01/item_tax.rb +20 -0
  59. data/lib/peddler/apis/orders_2026_01_01/item_tax_calculation_breakdown.rb +21 -0
  60. data/lib/peddler/apis/orders_2026_01_01/item_tax_collection.rb +24 -0
  61. data/lib/peddler/apis/orders_2026_01_01/order.rb +13 -1
  62. data/lib/peddler/apis/orders_2026_01_01/order_item.rb +7 -0
  63. data/lib/peddler/apis/orders_2026_01_01/order_payment.rb +17 -0
  64. data/lib/peddler/apis/orders_2026_01_01/order_proceeds.rb +5 -0
  65. data/lib/peddler/apis/orders_2026_01_01/order_proceeds_breakdown.rb +30 -0
  66. data/lib/peddler/apis/orders_2026_01_01/order_tax.rb +20 -0
  67. data/lib/peddler/apis/orders_2026_01_01/order_tax_invoicing.rb +34 -0
  68. data/lib/peddler/apis/orders_2026_01_01/order_tax_registration.rb +39 -0
  69. data/lib/peddler/apis/orders_2026_01_01/package_status.rb +4 -3
  70. data/lib/peddler/apis/orders_2026_01_01/pagination.rb +5 -5
  71. data/lib/peddler/apis/orders_2026_01_01/payment_execution.rb +39 -0
  72. data/lib/peddler/apis/orders_2026_01_01/search_orders_response.rb +10 -11
  73. data/lib/peddler/apis/orders_2026_01_01/serial_number_requirement.rb +19 -0
  74. data/lib/peddler/apis/orders_2026_01_01/tax_registration_attribute.rb +22 -0
  75. data/lib/peddler/apis/orders_2026_01_01.rb +15 -13
  76. data/lib/peddler/apis/orders_v0/address.rb +3 -3
  77. data/lib/peddler/apis/orders_v0/address_extended_fields.rb +9 -2
  78. data/lib/peddler/apis/orders_v0/approved_alternative_details.rb +20 -0
  79. data/lib/peddler/apis/orders_v0/approved_attribute.rb +23 -0
  80. data/lib/peddler/apis/orders_v0/buyer_info.rb +3 -0
  81. data/lib/peddler/apis/orders_v0/geo_coordinates.rb +20 -0
  82. data/lib/peddler/apis/orders_v0/interim_status_detail.rb +24 -0
  83. data/lib/peddler/apis/orders_v0/order_buyer_info.rb +3 -0
  84. data/lib/peddler/apis/orders_v0/regulated_order_verification_status.rb +5 -0
  85. data/lib/peddler/apis/orders_v0/valid_interim_status_code.rb +21 -0
  86. data/lib/peddler/apis/orders_v0/valid_verification_detail.rb +2 -1
  87. data/lib/peddler/apis/orders_v0/verification_details.rb +8 -0
  88. data/lib/peddler/apis/orders_v0.rb +6 -2
  89. data/lib/peddler/apis/product_pricing_2022_05_01/competitive_summary_response_body.rb +3 -0
  90. data/lib/peddler/apis/product_pricing_2022_05_01/item.rb +17 -0
  91. data/lib/peddler/apis/product_pricing_2022_05_01/points.rb +1 -1
  92. data/lib/peddler/apis/product_pricing_2022_05_01/similar_items.rb +17 -0
  93. data/lib/peddler/apis/product_type_definitions_2020_09_01/error_list.rb +1 -1
  94. data/lib/peddler/apis/product_type_definitions_2020_09_01/product_type.rb +1 -1
  95. data/lib/peddler/apis/product_type_definitions_2020_09_01/product_type_list.rb +1 -1
  96. data/lib/peddler/apis/product_type_definitions_2020_09_01/schema_link.rb +2 -1
  97. data/lib/peddler/apis/product_type_definitions_2020_09_01.rb +12 -8
  98. data/lib/peddler/apis/replenishment_2022_11_07/deliveries_condition.rb +22 -0
  99. data/lib/peddler/apis/replenishment_2022_11_07/forecast_deliveries.rb +26 -0
  100. data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_request.rb +8 -3
  101. data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_request_filters.rb +48 -0
  102. data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response_metric.rb +14 -10
  103. data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request.rb +2 -2
  104. data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_filters.rb +17 -4
  105. data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb +37 -23
  106. data/lib/peddler/apis/replenishment_2022_11_07/list_offers_request.rb +2 -2
  107. data/lib/peddler/apis/replenishment_2022_11_07/list_offers_request_filters.rb +7 -3
  108. data/lib/peddler/apis/replenishment_2022_11_07/list_offers_response_offer.rb +27 -1
  109. data/lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration.rb +1 -1
  110. data/lib/peddler/apis/replenishment_2022_11_07/time_interval.rb +10 -6
  111. data/lib/peddler/apis/reports_2021_06_30.rb +8 -2
  112. data/lib/peddler/apis/seller_wallet_2024_03_01/balance.rb +6 -6
  113. data/lib/peddler/apis/seller_wallet_2024_03_01/balance_listing.rb +2 -2
  114. data/lib/peddler/apis/seller_wallet_2024_03_01/bank_account.rb +5 -5
  115. data/lib/peddler/apis/seller_wallet_2024_03_01/bank_account_listing.rb +2 -2
  116. data/lib/peddler/apis/seller_wallet_2024_03_01/delete_transfer_schedule.rb +3 -2
  117. data/lib/peddler/apis/seller_wallet_2024_03_01/fee.rb +4 -7
  118. data/lib/peddler/apis/seller_wallet_2024_03_01/fx_rate_details.rb +6 -6
  119. data/lib/peddler/apis/seller_wallet_2024_03_01/payee_contact_information.rb +5 -5
  120. data/lib/peddler/apis/seller_wallet_2024_03_01/payment_preference.rb +2 -3
  121. data/lib/peddler/apis/seller_wallet_2024_03_01/schedule_expression.rb +4 -5
  122. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction.rb +13 -14
  123. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_account.rb +8 -8
  124. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_initiation_request.rb +8 -7
  125. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_instrument_details.rb +6 -7
  126. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_listing.rb +6 -5
  127. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_rate_preview.rb +4 -3
  128. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule.rb +11 -12
  129. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_failures.rb +3 -3
  130. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_information.rb +5 -6
  131. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_listing.rb +6 -5
  132. data/lib/peddler/apis/seller_wallet_2024_03_01/transfer_schedule_request.rb +11 -13
  133. data/lib/peddler/apis/seller_wallet_2024_03_01.rb +30 -28
  134. data/lib/peddler/apis/services_v1/associated_item.rb +3 -0
  135. data/lib/peddler/apis/services_v1/linked_asset.rb +24 -0
  136. data/lib/peddler/apis/services_v1/money_amount.rb +20 -0
  137. data/lib/peddler/apis/services_v1/payment.rb +20 -0
  138. data/lib/peddler/apis/services_v1/service_job.rb +9 -0
  139. data/lib/peddler/apis/services_v1.rb +11 -5
  140. data/lib/peddler/apis/shipment_invoicing_v0/payment_information.rb +6 -6
  141. data/lib/peddler/apis/shipment_invoicing_v0/payment_information_list.rb +1 -1
  142. data/lib/peddler/apis/uploads_2020_11_01.rb +1 -1
  143. data/lib/peddler/data_kiosk/economics20240315.json +6 -6
  144. data/lib/peddler/data_kiosk/sales_and_traffic20231115.json +6 -6
  145. data/lib/peddler/data_kiosk/sales_and_traffic20240424.json +6 -6
  146. data/lib/peddler/data_kiosk/vendor_analytics20240930.json +6 -6
  147. data/lib/peddler/errors.rb +1 -0
  148. data/lib/peddler/notifications/order_change/notification.rb +4 -3
  149. data/lib/peddler/notifications/order_change/order_change_notification.rb +2 -2
  150. data/lib/peddler/notifications/order_change/order_change_trigger.rb +4 -4
  151. data/lib/peddler/notifications/order_change/order_item.rb +7 -7
  152. data/lib/peddler/notifications/order_change/summary.rb +17 -17
  153. data/lib/peddler/version.rb +1 -1
  154. data/sig/peddler/api.rbs +3 -1
  155. data/sig/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rbs +167 -0
  156. data/sig/peddler/apis/external_fulfillment_shipments_2024_09_11.rbs +85 -28
  157. data/sig/peddler/apis/feeds_2021_06_30.rbs +1 -1
  158. data/sig/peddler/apis/fulfillment_outbound_2020_07_01.rbs +11 -8
  159. data/sig/peddler/apis/listings_restrictions_2021_08_01.rbs +1 -1
  160. data/sig/peddler/apis/notifications_v1.rbs +61 -7
  161. data/sig/peddler/apis/orders_2026_01_01.rbs +272 -39
  162. data/sig/peddler/apis/orders_v0.rbs +115 -36
  163. data/sig/peddler/apis/product_pricing_2022_05_01.rbs +40 -7
  164. data/sig/peddler/apis/product_type_definitions_2020_09_01.rbs +1 -1
  165. data/sig/peddler/apis/replenishment_2022_11_07.rbs +117 -42
  166. data/sig/peddler/apis/reports_2021_06_30.rbs +1 -1
  167. data/sig/peddler/apis/services_v1.rbs +71 -15
  168. data/sig/peddler/errors.rbs +3 -0
  169. metadata +51 -5
@@ -16,14 +16,15 @@ module Peddler
16
16
  # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/notifications-api-model/notifications.json
17
17
  class NotificationsV1 < API
18
18
  # Returns information about subscription of the specified notification type and payload version. `payloadVersion`
19
- # is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version
20
- # subscription's information. You can use this API to get subscription information when you do not have a
19
+ # is an optional parameter. When you do not provide `payloadVersion`, the operation returns the latest payload
20
+ # version subscription's information. You can use this API to get subscription information when you do not have a
21
21
  # subscription identifier.
22
22
  #
23
23
  # @note This operation can make a static sandbox call.
24
- # @param payload_version [String] The version of the payload object to be used in the notification.
25
24
  # @param notification_type [String] The type of notification. For more information about notification types, refer
26
- # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
25
+ # to the [Notifications API v1 Use Case
26
+ # Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
27
+ # @param payload_version [String] The version of the payload object to be used in the notification.
27
28
  # @param rate_limit [Float] Requests per second
28
29
  # @return [Peddler::Response] The API response
29
30
  def get_subscription(notification_type, payload_version: nil, rate_limit: 1.0)
@@ -36,14 +37,15 @@ module Peddler
36
37
  end
37
38
 
38
39
  # Creates a subscription for the specified notification type to be delivered to the specified destination. Before
39
- # you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases
40
- # where the specified notification type supports multiple payload versions, you can utilize this API to subscribe
40
+ # you can subscribe, you must first create the destination by calling the `createDestination` operation. If the
41
+ # notification type that you specify supports multiple payload versions, you can use this operation to subscribe
41
42
  # to a different payload version if you already have an existing subscription for a different payload version.
42
43
  #
43
44
  # @note This operation can make a static sandbox call.
44
- # @param body [Hash]
45
+ # @param body [Hash] The request schema for the `createSubscription` operation.
45
46
  # @param notification_type [String] The type of notification. For more information about notification types, refer
46
- # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
47
+ # to the [Notifications API v1 Use Case
48
+ # Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
47
49
  # @param rate_limit [Float] Requests per second
48
50
  # @return [Peddler::Response] The API response
49
51
  def create_subscription(body, notification_type, rate_limit: 1.0)
@@ -54,12 +56,14 @@ module Peddler
54
56
 
55
57
  # Returns information about a subscription for the specified notification type. The `getSubscriptionById`
56
58
  # operation is grantless. For more information, refer to [Grantless
57
- # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
59
+ # Operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API
60
+ # Developer Guide.
58
61
  #
59
62
  # @note This operation can make a static sandbox call.
60
63
  # @param subscription_id [String] The identifier for the subscription that you want to get.
61
64
  # @param notification_type [String] The type of notification. For more information about notification types, refer
62
- # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
65
+ # to the [Notifications API v1 Use Case
66
+ # Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
63
67
  # @param rate_limit [Float] Requests per second
64
68
  # @return [Peddler::Response] The API response
65
69
  def get_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0)
@@ -72,12 +76,14 @@ module Peddler
72
76
  # subscription identifier can be for any subscription associated with your application. After you successfully
73
77
  # call this operation, notifications will stop being sent for the associated subscription. The
74
78
  # `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless
75
- # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
79
+ # Operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API
80
+ # Developer Guide.
76
81
  #
77
82
  # @note This operation can make a static sandbox call.
78
83
  # @param subscription_id [String] The identifier for the subscription that you want to delete.
79
84
  # @param notification_type [String] The type of notification. For more information about notification types, refer
80
- # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
85
+ # to the [Notifications API v1 Use Case
86
+ # Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
81
87
  # @param rate_limit [Float] Requests per second
82
88
  # @return [Peddler::Response] The API response
83
89
  def delete_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0)
@@ -86,8 +92,27 @@ module Peddler
86
92
  delete(path, rate_limit:, parser:)
87
93
  end
88
94
 
95
+ # Sends a mock notification of the specified type to your SQS. The `sendTestNotification` API is grantless. For
96
+ # more information, see "Grantless operations" in the Selling Partner API Developer Guide.
97
+ #
98
+ # @note This operation can make a dynamic sandbox call.
99
+ # @param body [Hash] The request schema for the `sendTestNotification` operation.
100
+ # @param notification_type [String] The type of notification. For more information about notification types, refer
101
+ # to the [Notifications API v1 Use Case
102
+ # Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
103
+ # @param rate_limit [Float] Requests per second
104
+ # @return [Peddler::Response] The API response
105
+ def send_test_notification(body, notification_type, rate_limit: 1.0)
106
+ must_sandbox!
107
+
108
+ path = "/notifications/v1/subscriptions/#{percent_encode(notification_type)}/testNotification"
109
+ parser = -> { SendTestNotificationResponse }
110
+ post(path, body:, rate_limit:, parser:)
111
+ end
112
+
89
113
  # Returns information about all destinations. The `getDestinations` operation is grantless. For more information,
90
- # refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
114
+ # refer to [Grantless Operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the
115
+ # Selling Partner API Developer Guide.
91
116
  #
92
117
  # @note This operation can make a static sandbox call.
93
118
  # @param rate_limit [Float] Requests per second
@@ -100,10 +125,11 @@ module Peddler
100
125
 
101
126
  # Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For
102
127
  # more information, refer to [Grantless
103
- # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
128
+ # Operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API
129
+ # Developer Guide.
104
130
  #
105
131
  # @note This operation can make a static sandbox call.
106
- # @param body [Hash]
132
+ # @param body [Hash] The request schema for the `createDestination` operation.
107
133
  # @param rate_limit [Float] Requests per second
108
134
  # @return [Peddler::Response] The API response
109
135
  def create_destination(body, rate_limit: 1.0)
@@ -114,7 +140,8 @@ module Peddler
114
140
 
115
141
  # Returns information about the destination that you specify. The `getDestination` operation is grantless. For
116
142
  # more information, refer to [Grantless
117
- # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
143
+ # Operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API
144
+ # Developer Guide.
118
145
  #
119
146
  # @note This operation can make a static sandbox call.
120
147
  # @param destination_id [String] The identifier generated when you created the destination.
@@ -127,7 +154,8 @@ module Peddler
127
154
  end
128
155
 
129
156
  # Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information,
130
- # refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
157
+ # refer to [Grantless Operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the
158
+ # Selling Partner API Developer Guide.
131
159
  #
132
160
  # @note This operation can make a static sandbox call.
133
161
  # @param destination_id [String] The identifier for the destination that you want to delete.
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # An associated order item that a customer has purchased with the product. For example, a tire installation
11
+ # service purchased with tires.
12
+ AssociatedOrderItem = Structure.new do
13
+ # @return [String] The type of association between the order items.
14
+ #
15
+ # **Possible values**:
16
+ # - `VALUE_ADD_SERVICE` (The associated item is a service order)
17
+ attribute?(:association_type, String, from: "associationType")
18
+
19
+ # @return [String] The order identifier of the associated order item.
20
+ attribute?(:order_id, String, from: "orderId")
21
+
22
+ # @return [String] The order item identifier of the associated order item.
23
+ attribute?(:order_item_id, String, from: "orderItemId")
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Information about a fulfillment order associated with a customer order. A fulfillment order represents a unit of
11
+ # fulfillment created by Amazon for the order. **Note:** Only available for EasyShip orders at present.
12
+ FulfillmentOrder = Structure.new do
13
+ # @return [String] The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is
14
+ # identical to the Shipment ID required by External Fulfillment APIs.
15
+ attribute(:fulfillment_order_id, String, null: false, from: "fulfillmentOrderId")
16
+ end
17
+ end
18
+ end
19
+ end
@@ -11,6 +11,9 @@ module Peddler
11
11
  ItemPacking = Structure.new do
12
12
  # @return [GiftOption] Gift wrapping and messaging specified for this item.
13
13
  attribute?(:gift_option, GiftOption, from: "giftOption")
14
+
15
+ # @return [SerialNumberRequirement] Whether serial numbers must be provided for this line item.
16
+ attribute?(:serial_number_requirement, SerialNumberRequirement, from: "serialNumberRequirement")
14
17
  end
15
18
  end
16
19
  end
@@ -10,7 +10,7 @@ module Peddler
10
10
  # Information related to the warehouse picking process for an order item.
11
11
  ItemPicking = Structure.new do
12
12
  # @return [ItemSubstitutionPreference] Substitution preference for an order item when it becomes unavailable
13
- # during fulfillment
13
+ # during fulfillment.
14
14
  attribute?(:substitution_preference, ItemSubstitutionPreference, from: "substitutionPreference")
15
15
  end
16
16
  end
@@ -9,16 +9,16 @@ module Peddler
9
9
  class Orders20260101
10
10
  # Detailed proceeds breakdown for a specific order item.
11
11
  ItemProceedsBreakdown = Structure.new do
12
- # @return [Array<ItemProceedsDetailedBreakdown>] Further granular breakdown of the subtotal.
13
- attribute?(:detailed_breakdowns, [ItemProceedsDetailedBreakdown], from: "detailedBreakdowns")
14
-
15
12
  # @return [Money] Monetary amount for the proceeds breakdown.
16
- attribute?(:subtotal, Money)
13
+ attribute(:subtotal, Money, null: false)
17
14
 
18
15
  # @return [String] Category classification of the proceeds breakdown.
19
16
  #
20
17
  # **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`
21
- attribute?(:type, String)
18
+ attribute(:type, String, null: false)
19
+
20
+ # @return [Array<ItemProceedsDetailedBreakdown>] Further granular breakdown of the subtotal.
21
+ attribute?(:detailed_breakdowns, [ItemProceedsDetailedBreakdown], from: "detailedBreakdowns")
22
22
  end
23
23
  end
24
24
  end
@@ -8,7 +8,7 @@ module Peddler
8
8
  module APIs
9
9
  class Orders20260101
10
10
  # Further granular breakdown of the subtotal of the proceeds breakdown, only available for TAX and DISCOUNT
11
- # proceeds type.
11
+ # proceeds types.
12
12
  ItemProceedsDetailedBreakdown = Structure.new do
13
13
  # @return [String] Specific classification of the further granular breakdown.
14
14
  #
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Tax information for an order item.
11
+ ItemTax = Structure.new do
12
+ # @return [Array<ItemTaxCalculationBreakdown>] A list of tax calculation breakdowns for the order item.
13
+ attribute?(:tax_calculation_breakdowns, [ItemTaxCalculationBreakdown], from: "taxCalculationBreakdowns")
14
+
15
+ # @return [Array<ItemTaxCollection>] A list of tax collections for the order item.
16
+ attribute?(:tax_collections, [ItemTaxCollection], from: "taxCollections")
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Tax calculation breakdowns for an order item.
11
+ ItemTaxCalculationBreakdown = Structure.new do
12
+ # @return [String] The tax reporting scheme applied to this order item.
13
+ #
14
+ # **Possible values**:
15
+ # - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one
16
+ # stop shop. The item being purchased is not held in the EU for shipment)
17
+ attribute?(:reporting_scheme, String, from: "reportingScheme")
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Tax collection information for an order item.
11
+ ItemTaxCollection = Structure.new do
12
+ # @return [String] The tax collection model applied to the item.
13
+ #
14
+ # **Possible values**:
15
+ # - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the
16
+ # seller)
17
+ attribute?(:model, String)
18
+
19
+ # @return [String] The party responsible for withholding the taxes and remitting them to the taxing authority.
20
+ attribute?(:responsible_party, String, from: "responsibleParty")
21
+ end
22
+ end
23
+ end
24
+ end
@@ -37,6 +37,11 @@ module Peddler
37
37
  # @return [OrderFulfillment] Information about how this order is being processed and shipped.
38
38
  attribute?(:fulfillment, OrderFulfillment)
39
39
 
40
+ # @return [Array<FulfillmentOrder>] The list of fulfillment orders associated with this customer order. Each
41
+ # entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for
42
+ # EasyShip orders at present.
43
+ attribute?(:fulfillment_orders, [FulfillmentOrder], from: "fulfillmentOrders")
44
+
40
45
  # @return [Array<Alias>] Alternative identifiers that can be used to reference this order, such as
41
46
  # seller-defined order numbers.
42
47
  attribute?(:order_aliases, [Alias], from: "orderAliases")
@@ -45,6 +50,9 @@ module Peddler
45
50
  # **Note:** Only available for merchant-fulfilled (FBM) orders.
46
51
  attribute?(:packages, [OrderPackage])
47
52
 
53
+ # @return [OrderPayment] Payment information for the order.
54
+ attribute?(:payment, OrderPayment)
55
+
48
56
  # @return [OrderProceeds] Financial information about this order.
49
57
  attribute?(:proceeds, OrderProceeds)
50
58
 
@@ -52,11 +60,15 @@ module Peddler
52
60
  # experience.
53
61
  #
54
62
  # **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`,
55
- # `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`
63
+ # `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`,
64
+ # `PRIME`
56
65
  attribute?(:programs, [String])
57
66
 
58
67
  # @return [Recipient] Information about the person or location where this order should be delivered.
59
68
  attribute?(:recipient, Recipient)
69
+
70
+ # @return [OrderTax] Tax-related information for the order.
71
+ attribute?(:tax, OrderTax)
60
72
  end
61
73
  end
62
74
  end
@@ -18,6 +18,10 @@ module Peddler
18
18
  # @return [Integer] The number of units of this item that the customer ordered.
19
19
  attribute(:quantity_ordered, Integer, null: false, from: "quantityOrdered")
20
20
 
21
+ # @return [Array<AssociatedOrderItem>] A list of order items associated with this item. For example, a value-add
22
+ # service purchased with the product.
23
+ attribute?(:associated_order_items, [AssociatedOrderItem], from: "associatedOrderItems")
24
+
21
25
  # @return [ItemCancellation] The cancellation information of the order item.
22
26
  attribute?(:cancellation, ItemCancellation)
23
27
 
@@ -42,6 +46,9 @@ module Peddler
42
46
 
43
47
  # @return [ItemPromotion] Details about any discounts, coupons, or promotional offers applied to this item.
44
48
  attribute?(:promotion, ItemPromotion)
49
+
50
+ # @return [ItemTax] Tax-related information for this order item.
51
+ attribute?(:tax, ItemTax)
45
52
  end
46
53
  end
47
54
  end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Payment information about the order.
11
+ OrderPayment = Structure.new do
12
+ # @return [Array<PaymentExecution>] A list of payment executions for the order.
13
+ attribute?(:payment_executions, [PaymentExecution], from: "paymentExecutions")
14
+ end
15
+ end
16
+ end
17
+ end
@@ -9,6 +9,11 @@ module Peddler
9
9
  class Orders20260101
10
10
  # The money that the seller receives from the sale of the order.
11
11
  OrderProceeds = Structure.new do
12
+ # @return [Array<OrderProceedsBreakdown>] Categorized proceeds for the order. Proceed categories are either
13
+ # aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level
14
+ # (such as `DELIVERY_TIP`).
15
+ attribute?(:breakdowns, [OrderProceedsBreakdown])
16
+
12
17
  # @return [Money] The total amount that the seller receives from the sale of the order.
13
18
  attribute?(:grand_total, Money, from: "grandTotal")
14
19
  end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # An entry detailing proceeds information.
11
+ OrderProceedsBreakdown = Structure.new do
12
+ # @return [Money] The monetary amount for the proceeds category.
13
+ attribute(:subtotal, Money, null: false)
14
+
15
+ # @return [String] The proceeds category.
16
+ #
17
+ # **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`.
18
+ # **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining
19
+ # categories are aggregated across all order items.
20
+ attribute(:type, String, null: false)
21
+
22
+ # @return [String] The processing status of the charge. Only present for categories processed separately after
23
+ # checkout, such as `DELIVERY_TIP`.
24
+ #
25
+ # **Possible values**: `PENDING`, `FINALIZED`.
26
+ attribute?(:status, String)
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Tax information about the order.
11
+ OrderTax = Structure.new do
12
+ # @return [OrderTaxInvoicing] Tax invoicing information for the order.
13
+ attribute?(:tax_invoicing, OrderTaxInvoicing, from: "taxInvoicing")
14
+
15
+ # @return [Array<OrderTaxRegistration>] A list of tax registrations associated with the order.
16
+ attribute?(:tax_registrations, [OrderTaxRegistration], from: "taxRegistrations")
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Tax invoicing information for the order.
11
+ OrderTaxInvoicing = Structure.new do
12
+ # @return [String] The buyer's invoicing preference, which indicates whether the seller should issue an
13
+ # individual or a business invoice to the buyer.
14
+ #
15
+ # **Note**: This attribute is only available in the Turkey marketplace.
16
+ #
17
+ # **Possible values**:
18
+ # - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the
19
+ # buyer)
20
+ attribute?(:buyer_invoice_preference, String, from: "buyerInvoicePreference")
21
+
22
+ # @return [String] The status of the invoice. Only available for Easy Ship orders and orders in the Brazil
23
+ # marketplace.
24
+ #
25
+ # **Possible values**:
26
+ # - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order
27
+ # requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was
28
+ # uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The
29
+ # uploaded electronic invoice was accepted)
30
+ attribute?(:invoice_status, String, from: "invoiceStatus")
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Tax registration information for an entity associated with the order.
11
+ OrderTaxRegistration = Structure.new do
12
+ # @return [String] The type of entity that the tax registration belongs to.
13
+ #
14
+ # **Possible values**:
15
+ # - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this
16
+ # is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's
17
+ # tax registration information)
18
+ attribute?(:entity_type, String, from: "entityType")
19
+
20
+ # @return [String] The legal name associated with the tax registration.
21
+ attribute?(:legal_name, String, from: "legalName")
22
+
23
+ # @return [CustomerAddress] The address associated with the tax registration.
24
+ attribute?(:tax_registration_address, CustomerAddress, from: "taxRegistrationAddress")
25
+
26
+ # @return [Array<TaxRegistrationAttribute>] Additional attributes related to the tax registration.
27
+ attribute?(:tax_registration_attributes, [TaxRegistrationAttribute], from: "taxRegistrationAttributes")
28
+
29
+ # @return [String] The tax registration number that identifies the entity for tax purposes.
30
+ attribute?(:tax_registration_number, String, from: "taxRegistrationNumber")
31
+
32
+ # @return [String] The type of the tax registration number.
33
+ #
34
+ # **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`
35
+ attribute?(:tax_registration_type, String, from: "taxRegistrationType")
36
+ end
37
+ end
38
+ end
39
+ end
@@ -15,9 +15,10 @@ module Peddler
15
15
  # @return [String] Granular status information providing specific details about the package's current location
16
16
  # and handling stage.
17
17
  #
18
- # **Possible values:** - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package
19
- # ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier)
20
- # - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from
18
+ # **Possible values**:
19
+ # - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier
20
+ # collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) -
21
+ # `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from
21
22
  # seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at
22
23
  # originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) -
23
24
  # `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended
@@ -7,11 +7,11 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class Orders20260101
10
- # When a request has results that are not included in the response, pagination occurs. This means the results are
11
- # divided into individual pages. To retrieve a different page, you must pass the token value as the
12
- # `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same
13
- # values that were provided with the request that generated this token, with the exception of `maxResultsPerPage`
14
- # and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no
10
+ # Pagination occurs when a request has results that exceed the response limit. This means the results are divided
11
+ # into individual pages. To retrieve a different page, you must pass the token value as the `paginationToken`
12
+ # query parameter in the subsequent request. All other parameters must be provided with the same values that were
13
+ # provided with the request that generated this token, with the exception of `maxResultsPerPage` and
14
+ # `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no
15
15
  # other pages to fetch, the `pagination` field will be absent from the response.
16
16
  Pagination = Structure.new do
17
17
  # @return [String] A token that can be used to fetch the next page of results.
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class Orders20260101
10
+ # Payment execution details for an order.
11
+ PaymentExecution = Structure.new do
12
+ # @return [String] The unique identifier of the payment processor or acquiring bank that authorizes the payment.
13
+ #
14
+ # **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod`
15
+ # is `CreditCard` or `Pix`.
16
+ attribute?(:acquirer_id, String, from: "acquirerId")
17
+
18
+ # @return [String] The unique code that confirms the payment authorization.
19
+ #
20
+ # **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod`
21
+ # is `CreditCard` or `Pix`.
22
+ attribute?(:authorization_code, String, from: "authorizationCode")
23
+
24
+ # @return [String] The card network or brand used in the payment transaction (for example, Visa or Mastercard).
25
+ #
26
+ # **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod`
27
+ # is `CreditCard`.
28
+ attribute?(:card_brand, String, from: "cardBrand")
29
+
30
+ # @return [Money] The monetary value of the payment execution.
31
+ attribute?(:payment_amount, Money, from: "paymentAmount")
32
+
33
+ # @return [String] The payment method used for this payment execution (for example, CashOnDelivery,
34
+ # ConvenienceStore, CreditCard, Invoice, Pix, and so on).
35
+ attribute?(:payment_method, String, from: "paymentMethod")
36
+ end
37
+ end
38
+ end
39
+ end
@@ -13,21 +13,20 @@ module Peddler
13
13
  # @return [Array<Order>] An array containing all orders that match the search criteria.
14
14
  attribute(:orders, [Order], null: false)
15
15
 
16
- # @return [Time] Only orders placed before the specified time are returned. The date must be in
17
- # {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
16
+ # @return [Time] Only orders placed before the specified time are returned. The date must be in [ISO
17
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
18
18
  attribute?(:created_before, Time, from: "createdBefore")
19
19
 
20
- # @return [Time] Only orders updated before the specified time are returned. The date must be in
21
- # {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
20
+ # @return [Time] Only orders updated before the specified time are returned. The date must be in [ISO
21
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
22
22
  attribute?(:last_updated_before, Time, from: "lastUpdatedBefore")
23
23
 
24
- # @return [Pagination] When a request has results that are not included in the response, pagination occurs. This
25
- # means the results are divided into individual pages. To retrieve a different page, you must pass the token
26
- # value as the `paginationToken` query parameter in the subsequent request. All other parameters must be
27
- # provided with the same values that were provided with the request that generated this token, with the
28
- # exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will
29
- # expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from
30
- # the response.
24
+ # @return [Pagination] Pagination occurs when a request has results that exceed the response limit. This means
25
+ # the results are divided into individual pages. To retrieve a different page, you must pass the token value
26
+ # as the `paginationToken` query parameter in the subsequent request. All other parameters must be provided
27
+ # with the same values that were provided with the request that generated this token, with the exception of
28
+ # `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will expire after 24
29
+ # hours. When there are no other pages to fetch, the `pagination` field will be absent from the response.
31
30
  attribute?(:pagination, Pagination)
32
31
  end
33
32
  end