peddler 5.1.0 → 5.2.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.
- checksums.yaml +4 -4
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/distribution_ineligible_reason.rb +24 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/distribution_product.rb +24 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_shipment_summary.rb +30 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/replenishment_order.rb +48 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/replenishment_order_creation_data.rb +21 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/replenishment_order_listing.rb +24 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/replenishment_order_reference.rb +18 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/replenishment_preferences.rb +17 -0
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb +70 -0
- data/lib/peddler/apis/finances_2024_06_19.rb +4 -4
- data/lib/peddler/apis/invoices_2024_06_19/carrier_details_context.rb +38 -0
- data/lib/peddler/apis/invoices_2024_06_19/government_invoice_request.rb +36 -0
- data/lib/peddler/apis/invoices_2024_06_19/government_invoice_status_response.rb +23 -0
- data/lib/peddler/apis/invoices_2024_06_19/govt_invoice_document_response.rb +17 -0
- data/lib/peddler/apis/invoices_2024_06_19/invoice_document.rb +18 -0
- data/lib/peddler/apis/invoices_2024_06_19/invoice_error.rb +20 -0
- data/lib/peddler/apis/invoices_2024_06_19.rb +66 -0
- data/lib/peddler/apis/orders_2026_01_01/address_extended_fields.rb +29 -0
- data/lib/peddler/apis/orders_2026_01_01/alias.rb +22 -0
- data/lib/peddler/apis/orders_2026_01_01/associated_order.rb +22 -0
- data/lib/peddler/apis/orders_2026_01_01/business_hour.rb +22 -0
- data/lib/peddler/apis/orders_2026_01_01/buyer.rb +28 -0
- data/lib/peddler/apis/orders_2026_01_01/customer_address.rb +66 -0
- data/lib/peddler/apis/orders_2026_01_01/date_time_range.rb +23 -0
- data/lib/peddler/apis/orders_2026_01_01/delivery_preference.rb +28 -0
- data/lib/peddler/apis/orders_2026_01_01/error.rb +23 -0
- data/lib/peddler/apis/orders_2026_01_01/error_list.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/exception_date.rb +25 -0
- data/lib/peddler/apis/orders_2026_01_01/get_order_response.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/gift_option.rb +20 -0
- data/lib/peddler/apis/orders_2026_01_01/hour_minute.rb +20 -0
- data/lib/peddler/apis/orders_2026_01_01/item_cancellation.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/item_cancellation_request.rb +22 -0
- data/lib/peddler/apis/orders_2026_01_01/item_condition.rb +30 -0
- data/lib/peddler/apis/orders_2026_01_01/item_customization.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/item_expense.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/item_fulfillment.rb +29 -0
- data/lib/peddler/apis/orders_2026_01_01/item_international_shipping.rb +19 -0
- data/lib/peddler/apis/orders_2026_01_01/item_packing.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/item_picking.rb +18 -0
- data/lib/peddler/apis/orders_2026_01_01/item_points_cost.rb +18 -0
- data/lib/peddler/apis/orders_2026_01_01/item_price.rb +24 -0
- data/lib/peddler/apis/orders_2026_01_01/item_proceeds.rb +20 -0
- data/lib/peddler/apis/orders_2026_01_01/item_proceeds_breakdown.rb +25 -0
- data/lib/peddler/apis/orders_2026_01_01/item_proceeds_detailed_breakdown.rb +23 -0
- data/lib/peddler/apis/orders_2026_01_01/item_product.rb +36 -0
- data/lib/peddler/apis/orders_2026_01_01/item_promotion.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/item_promotion_breakdown.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/item_shipping.rb +24 -0
- data/lib/peddler/apis/orders_2026_01_01/item_shipping_constraints.rb +30 -0
- data/lib/peddler/apis/orders_2026_01_01/item_substitution_option.rb +30 -0
- data/lib/peddler/apis/orders_2026_01_01/item_substitution_preference.rb +21 -0
- data/lib/peddler/apis/orders_2026_01_01/measurement.rb +21 -0
- data/lib/peddler/apis/orders_2026_01_01/merchant_address.rb +44 -0
- data/lib/peddler/apis/orders_2026_01_01/order.rb +63 -0
- data/lib/peddler/apis/orders_2026_01_01/order_fulfillment.rb +37 -0
- data/lib/peddler/apis/orders_2026_01_01/order_item.rb +48 -0
- data/lib/peddler/apis/orders_2026_01_01/order_package.rb +47 -0
- data/lib/peddler/apis/orders_2026_01_01/order_proceeds.rb +17 -0
- data/lib/peddler/apis/orders_2026_01_01/package_item.rb +23 -0
- data/lib/peddler/apis/orders_2026_01_01/package_status.rb +32 -0
- data/lib/peddler/apis/orders_2026_01_01/pagination.rb +22 -0
- data/lib/peddler/apis/orders_2026_01_01/points_granted.rb +20 -0
- data/lib/peddler/apis/orders_2026_01_01/preferred_delivery_time.rb +21 -0
- data/lib/peddler/apis/orders_2026_01_01/recipient.rb +21 -0
- data/lib/peddler/apis/orders_2026_01_01/sales_channel.rb +26 -0
- data/lib/peddler/apis/orders_2026_01_01/search_orders_response.rb +35 -0
- data/lib/peddler/apis/orders_2026_01_01/time_window.rb +20 -0
- data/lib/peddler/apis/orders_2026_01_01.rb +93 -0
- data/lib/peddler/apis/orders_v0/export_info.rb +23 -0
- data/lib/peddler/apis/orders_v0/fulfillment_instructions.rb +20 -0
- data/lib/peddler/apis/orders_v0/fulfillment_location.rb +17 -0
- data/lib/peddler/apis/orders_v0/fulfillment_plan.rb +41 -0
- data/lib/peddler/apis/orders_v0/fulfillment_plan_item.rb +20 -0
- data/lib/peddler/apis/orders_v0/fulfillment_plan_shipping_constraints.rb +20 -0
- data/lib/peddler/apis/orders_v0/get_order_fulfillment_instructions_response.rb +21 -0
- data/lib/peddler/apis/orders_v0/order_item.rb +3 -0
- data/lib/peddler/apis/orders_v0/shipping_instructions.rb +23 -0
- data/lib/peddler/apis/orders_v0.rb +14 -2
- data/lib/peddler/apis/vendor_shipments_v1/item_details.rb +16 -0
- data/lib/peddler/apis/vendor_shipments_v1/package_item_details.rb +0 -16
- data/lib/peddler/apis/vendor_shipments_v1/packed_quantity.rb +25 -0
- data/lib/peddler/apis/vendor_shipments_v1/purchase_order_item_details.rb +18 -0
- data/lib/peddler/apis/vendor_shipments_v1/regulation_references.rb +9 -11
- data/lib/peddler/apis/vendor_shipments_v1/submit_shipment_confirmation_request.rb +17 -0
- data/lib/peddler/apis/vendor_shipments_v1/submit_shipment_confirmation_response.rb +20 -0
- data/lib/peddler/apis/vendor_shipments_v1/submit_shipment_confirmation_result.rb +17 -0
- data/lib/peddler/apis/vendor_shipments_v1.rb +12 -0
- data/lib/peddler/data_kiosk/sales_and_traffic20240424/by_asin_sales.rb +16 -0
- data/lib/peddler/data_kiosk/sales_and_traffic20240424/by_date_sales.rb +28 -8
- data/lib/peddler/data_kiosk/sales_and_traffic20240424/by_date_traffic.rb +19 -6
- data/lib/peddler/data_kiosk/sales_and_traffic20240424.json +153 -13
- data/lib/peddler/notifications/any_offer_changed/notification.rb +3 -3
- data/lib/peddler/version.rb +1 -1
- data/lib/peddler.rb +2 -1
- data/sig/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rbs +153 -0
- data/sig/peddler/apis/invoices_2024_06_19.rbs +115 -0
- data/sig/peddler/apis/orders_2026_01_01.rbs +940 -0
- data/sig/peddler/apis/orders_v0.rbs +151 -7
- data/sig/peddler/apis/vendor_shipments_v1.rbs +103 -18
- data/sig/peddler/data_kiosk/sales_and_traffic20240424.rbs +32 -21
- data/sig/peddler/notifications/any_offer_changed.rbs +7 -7
- data/sig/peddler.rbs +3 -1
- metadata +81 -10
- data/lib/peddler/notifications/mfn_order_status_change/notification.rb +0 -32
- data/lib/peddler/notifications/mfn_order_status_change/payload.rb +0 -17
- data/lib/peddler/notifications/mfn_order_status_change.rb +0 -18
- data/lib/peddler/notifications/order_status_change/notification.rb +0 -32
- data/lib/peddler/notifications/order_status_change/order_status_change_notification.rb +0 -48
- data/lib/peddler/notifications/order_status_change/payload.rb +0 -17
- data/lib/peddler/notifications/order_status_change.rb +0 -18
- data/sig/peddler/notifications/mfn_order_status_change.rbs +0 -44
- data/sig/peddler/notifications/order_status_change.rbs +0 -70
|
@@ -18,7 +18,7 @@ module Peddler
|
|
|
18
18
|
# populated when the seller is a B2B seller.
|
|
19
19
|
attribute?(:average_sales_per_order_item_b2b, Amount, from: "averageSalesPerOrderItemB2B")
|
|
20
20
|
|
|
21
|
-
# @return [Amount] The average price of the units sold
|
|
21
|
+
# @return [Amount] The average price of the units sold for the selected time period, calculated by dividing the
|
|
22
22
|
# orderedProductSales by unitsOrdered for the selected time period.
|
|
23
23
|
attribute?(:average_selling_price, Amount, null: false, from: "averageSellingPrice")
|
|
24
24
|
|
|
@@ -37,24 +37,38 @@ module Peddler
|
|
|
37
37
|
# @return [Amount] Monetary amount of filed A-to-z guarantee claims.
|
|
38
38
|
attribute?(:claims_amount, Amount, null: false, from: "claimsAmount")
|
|
39
39
|
|
|
40
|
+
# @return [Amount] Monetary amount of filed A-to-z guarantee claims for Amazon Business customers. Note: This
|
|
41
|
+
# field is only populated when the seller is a B2B seller.
|
|
42
|
+
attribute?(:claims_amount_b2b, Amount, from: "claimsAmountB2B")
|
|
43
|
+
|
|
40
44
|
# @return [String] The number of A-to-z guarantee claims granted.
|
|
41
45
|
attribute?(:claims_granted, String, null: false, from: "claimsGranted")
|
|
42
46
|
|
|
47
|
+
# @return [String] The number of A-to-z guarantee claims granted for Amazon Business customers.
|
|
48
|
+
# Note: This field is only populated when the seller is a B2B seller.
|
|
49
|
+
attribute?(:claims_granted_b2b, String, from: "claimsGrantedB2B")
|
|
50
|
+
|
|
43
51
|
# @return [Amount] The amount of ordered product sales, calculated by multiplying the price of products and the
|
|
44
52
|
# number of units sold for the selected time period.
|
|
45
53
|
attribute?(:ordered_product_sales, Amount, null: false, from: "orderedProductSales")
|
|
46
54
|
|
|
47
55
|
# @return [Amount] The amount of ordered product sales to Amazon Business customers, calculated by multiplying
|
|
48
|
-
# the price of products and the number of units sold for the selected time period.
|
|
56
|
+
# the price of products and the number of units sold for the selected time period. Note: This field is only
|
|
57
|
+
# populated when the seller is a B2B seller.
|
|
49
58
|
attribute?(:ordered_product_sales_b2b, Amount, from: "orderedProductSalesB2B")
|
|
50
59
|
|
|
51
|
-
# @return [String] The number of orders shipped
|
|
60
|
+
# @return [String] The number of orders shipped for the selected time period.
|
|
52
61
|
attribute?(:orders_shipped, String, null: false, from: "ordersShipped")
|
|
53
62
|
|
|
54
63
|
# @return [Float] The percentage conversion metric indicating how many orders were refunded by the seller,
|
|
55
|
-
# calculated by dividing
|
|
64
|
+
# calculated by dividing unitsRefunded by unitsOrdered for the selected time period.
|
|
56
65
|
attribute?(:refund_rate, Float, null: false, from: "refundRate")
|
|
57
66
|
|
|
67
|
+
# @return [Float] The percentage conversion metric indicating how many orders were refunded by Amazon Business
|
|
68
|
+
# customers, calculated by dividing unitsRefundedB2B by unitsOrderedB2B for the selected time period. Note:
|
|
69
|
+
# This field is only populated when the seller is a B2B seller.
|
|
70
|
+
attribute?(:refund_rate_b2b, Float, from: "refundRateB2B")
|
|
71
|
+
|
|
58
72
|
# @return [Amount] The amount of ordered product sales shipped for the selected time period.
|
|
59
73
|
attribute?(:shipped_product_sales, Amount, null: false, from: "shippedProductSales")
|
|
60
74
|
|
|
@@ -65,7 +79,8 @@ module Peddler
|
|
|
65
79
|
|
|
66
80
|
# @return [String] The number of items that were ordered by Amazon Business customers for the selected time
|
|
67
81
|
# period. Example: For an order containing 2 copies of book A and 3 copies of book B, the number of orders is
|
|
68
|
-
# 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3).
|
|
82
|
+
# 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3). Note: This
|
|
83
|
+
# field is only populated when the seller is a B2B seller.
|
|
69
84
|
attribute?(:total_order_items_b2b, String, from: "totalOrderItemsB2B")
|
|
70
85
|
|
|
71
86
|
# @return [String] The number of units ordered for the selected time period. Example: For an order containing 2
|
|
@@ -75,13 +90,18 @@ module Peddler
|
|
|
75
90
|
|
|
76
91
|
# @return [String] The number of units ordered by Amazon Business customers for the selected time period.
|
|
77
92
|
# Example: For an order containing 2 copies of book A and 3 copies of book B, the number of orders is 1, the
|
|
78
|
-
# number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3).
|
|
93
|
+
# number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3). Note: This field is
|
|
94
|
+
# only populated when the seller is a B2B seller.
|
|
79
95
|
attribute?(:units_ordered_b2b, String, from: "unitsOrderedB2B")
|
|
80
96
|
|
|
81
|
-
# @return [String] The number of units refunded
|
|
97
|
+
# @return [String] The number of units refunded for the selected time period.
|
|
82
98
|
attribute?(:units_refunded, String, null: false, from: "unitsRefunded")
|
|
83
99
|
|
|
84
|
-
# @return [String] The number of units
|
|
100
|
+
# @return [String] The number of units refunded by Amazon Business customers for the selected time period. Note:
|
|
101
|
+
# This field is only populated when the seller is a B2B seller.
|
|
102
|
+
attribute?(:units_refunded_b2b, String, from: "unitsRefundedB2B")
|
|
103
|
+
|
|
104
|
+
# @return [String] The number of units shipped for the selected time period.
|
|
85
105
|
attribute?(:units_shipped, String, null: false, from: "unitsShipped")
|
|
86
106
|
end
|
|
87
107
|
end
|
|
@@ -9,11 +9,11 @@ module Peddler
|
|
|
9
9
|
module SalesAndTraffic20240424
|
|
10
10
|
# The traffic data for the seller's account aggregated by date.
|
|
11
11
|
ByDateTraffic = Structure.new do
|
|
12
|
-
# @return [String] The average number of offers listed for sale
|
|
13
|
-
# from the total number of offers and the total number of days
|
|
12
|
+
# @return [String] The average number of offers listed for sale for the selected time period. It is calculated
|
|
13
|
+
# from the total number of offers and the total number of days for the selected time period.
|
|
14
14
|
attribute?(:average_offer_count, String, null: false, from: "averageOfferCount")
|
|
15
15
|
|
|
16
|
-
# @return [String] The average number of parent items listed for sale
|
|
16
|
+
# @return [String] The average number of parent items listed for sale for the selected time period.
|
|
17
17
|
attribute?(:average_parent_items, String, null: false, from: "averageParentItems")
|
|
18
18
|
|
|
19
19
|
# @return [String] Browser page views are the number of times a user visited your Amazon.com browser pages for
|
|
@@ -45,9 +45,13 @@ module Peddler
|
|
|
45
45
|
# is only populated when the seller is a B2B seller.
|
|
46
46
|
attribute?(:buy_box_percentage_b2b, Float, from: "buyBoxPercentageB2B")
|
|
47
47
|
|
|
48
|
-
# @return [String] The number of times customers left feedback
|
|
48
|
+
# @return [String] The number of times customers left feedback for the selected time period.
|
|
49
49
|
attribute?(:feedback_received, String, null: false, from: "feedbackReceived")
|
|
50
50
|
|
|
51
|
+
# @return [String] The number of times Amazon Business customers left feedback for the selected time period.
|
|
52
|
+
# Note: This field is only populated when the seller is a B2B seller.
|
|
53
|
+
attribute?(:feedback_received_b2b, String, from: "feedbackReceivedB2B")
|
|
54
|
+
|
|
51
55
|
# @return [String] Mobile app page views are the number of times a user visited your Amazon.com mobile app pages
|
|
52
56
|
# for the selected time period.
|
|
53
57
|
attribute?(:mobile_app_page_views, String, null: false, from: "mobileAppPageViews")
|
|
@@ -69,9 +73,13 @@ module Peddler
|
|
|
69
73
|
# a single session. Note: This field is only populated when the seller is a B2B seller.
|
|
70
74
|
attribute?(:mobile_app_sessions_b2b, String, from: "mobileAppSessionsB2B")
|
|
71
75
|
|
|
72
|
-
# @return [String] The number of times customers left negative feedback
|
|
76
|
+
# @return [String] The number of times customers left negative feedback for the selected time period.
|
|
73
77
|
attribute?(:negative_feedback_received, String, null: false, from: "negativeFeedbackReceived")
|
|
74
78
|
|
|
79
|
+
# @return [String] The number of times Amazon Business customers left negative feedback for the selected time
|
|
80
|
+
# period. Note: This field is only populated when the seller is a B2B seller.
|
|
81
|
+
attribute?(:negative_feedback_received_b2b, String, from: "negativeFeedbackReceivedB2B")
|
|
82
|
+
|
|
75
83
|
# @return [Float] The percentage conversion metric indicating how many order items were generated relative to
|
|
76
84
|
# the number of people who viewed the products.
|
|
77
85
|
attribute?(:order_item_session_percentage, Float, null: false, from: "orderItemSessionPercentage")
|
|
@@ -91,9 +99,14 @@ module Peddler
|
|
|
91
99
|
attribute?(:page_views_b2b, String, from: "pageViewsB2B")
|
|
92
100
|
|
|
93
101
|
# @return [Float] The negative feedback rate is the number of orders that have received negative feedback
|
|
94
|
-
# divided by the number of orders
|
|
102
|
+
# divided by the number of orders for the selected time period.
|
|
95
103
|
attribute?(:received_negative_feedback_rate, Float, null: false, from: "receivedNegativeFeedbackRate")
|
|
96
104
|
|
|
105
|
+
# @return [Float] The negative feedback rate for Amazon Business customers is the number of orders that have
|
|
106
|
+
# received negative feedback divided by the number of orders for the selected time period. Note: This field is
|
|
107
|
+
# only populated when the seller is a B2B seller.
|
|
108
|
+
attribute?(:received_negative_feedback_rate_b2b, Float, from: "receivedNegativeFeedbackRateB2B")
|
|
109
|
+
|
|
97
110
|
# @return [String] Sessions are visits to your Amazon.com browser or mobile app pages by a user.
|
|
98
111
|
# All browser and mobile app activity within a 24-hour period is considered a session. It is calculated as the
|
|
99
112
|
# sum of browserSessions and mobileAppSessions.
|
|
@@ -390,6 +390,34 @@
|
|
|
390
390
|
"isDeprecated": false,
|
|
391
391
|
"deprecationReason": null
|
|
392
392
|
},
|
|
393
|
+
{
|
|
394
|
+
"name": "refundRate",
|
|
395
|
+
"description": "The percentage conversion metric indicating how many orders were refunded,\ncalculated by dividing unitsRefunded by unitsOrdered for the selected time period.",
|
|
396
|
+
"args": [],
|
|
397
|
+
"type": {
|
|
398
|
+
"kind": "NON_NULL",
|
|
399
|
+
"name": null,
|
|
400
|
+
"ofType": {
|
|
401
|
+
"kind": "SCALAR",
|
|
402
|
+
"name": "Float",
|
|
403
|
+
"ofType": null
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
"isDeprecated": false,
|
|
407
|
+
"deprecationReason": null
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "refundRateB2B",
|
|
411
|
+
"description": "The percentage conversion metric indicating how many orders were refunded by\nAmazon Business customers, calculated by dividing unitsRefundedB2B by\nunitsOrderedB2B for the selected time period. Note: This field is only\npopulated when the seller is a B2B seller.",
|
|
412
|
+
"args": [],
|
|
413
|
+
"type": {
|
|
414
|
+
"kind": "SCALAR",
|
|
415
|
+
"name": "Float",
|
|
416
|
+
"ofType": null
|
|
417
|
+
},
|
|
418
|
+
"isDeprecated": false,
|
|
419
|
+
"deprecationReason": null
|
|
420
|
+
},
|
|
393
421
|
{
|
|
394
422
|
"name": "totalOrderItems",
|
|
395
423
|
"description": "The number of items that were ordered for the selected time period.",
|
|
@@ -445,6 +473,34 @@
|
|
|
445
473
|
},
|
|
446
474
|
"isDeprecated": false,
|
|
447
475
|
"deprecationReason": null
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"name": "unitsRefunded",
|
|
479
|
+
"description": "The number of units refunded for the selected time period.",
|
|
480
|
+
"args": [],
|
|
481
|
+
"type": {
|
|
482
|
+
"kind": "NON_NULL",
|
|
483
|
+
"name": null,
|
|
484
|
+
"ofType": {
|
|
485
|
+
"kind": "SCALAR",
|
|
486
|
+
"name": "Long",
|
|
487
|
+
"ofType": null
|
|
488
|
+
}
|
|
489
|
+
},
|
|
490
|
+
"isDeprecated": false,
|
|
491
|
+
"deprecationReason": null
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"name": "unitsRefundedB2B",
|
|
495
|
+
"description": "The number of units refunded by Amazon Business customers for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
|
|
496
|
+
"args": [],
|
|
497
|
+
"type": {
|
|
498
|
+
"kind": "SCALAR",
|
|
499
|
+
"name": "Long",
|
|
500
|
+
"ofType": null
|
|
501
|
+
},
|
|
502
|
+
"isDeprecated": false,
|
|
503
|
+
"deprecationReason": null
|
|
448
504
|
}
|
|
449
505
|
],
|
|
450
506
|
"inputFields": null,
|
|
@@ -890,7 +946,7 @@
|
|
|
890
946
|
},
|
|
891
947
|
{
|
|
892
948
|
"name": "averageSellingPrice",
|
|
893
|
-
"description": "The average price of the units sold
|
|
949
|
+
"description": "The average price of the units sold for the selected time period, calculated\nby dividing the orderedProductSales by unitsOrdered for the selected time period.",
|
|
894
950
|
"args": [],
|
|
895
951
|
"type": {
|
|
896
952
|
"kind": "NON_NULL",
|
|
@@ -960,6 +1016,18 @@
|
|
|
960
1016
|
"isDeprecated": false,
|
|
961
1017
|
"deprecationReason": null
|
|
962
1018
|
},
|
|
1019
|
+
{
|
|
1020
|
+
"name": "claimsAmountB2B",
|
|
1021
|
+
"description": "Monetary amount of filed A-to-z guarantee claims for Amazon Business\ncustomers. Note: This field is only populated when the seller is a B2B seller.",
|
|
1022
|
+
"args": [],
|
|
1023
|
+
"type": {
|
|
1024
|
+
"kind": "OBJECT",
|
|
1025
|
+
"name": "Amount",
|
|
1026
|
+
"ofType": null
|
|
1027
|
+
},
|
|
1028
|
+
"isDeprecated": false,
|
|
1029
|
+
"deprecationReason": null
|
|
1030
|
+
},
|
|
963
1031
|
{
|
|
964
1032
|
"name": "claimsGranted",
|
|
965
1033
|
"description": "The number of A-to-z guarantee claims granted.",
|
|
@@ -976,6 +1044,18 @@
|
|
|
976
1044
|
"isDeprecated": false,
|
|
977
1045
|
"deprecationReason": null
|
|
978
1046
|
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "claimsGrantedB2B",
|
|
1049
|
+
"description": "The number of A-to-z guarantee claims granted for Amazon Business customers.\nNote: This field is only populated when the seller is a B2B seller.",
|
|
1050
|
+
"args": [],
|
|
1051
|
+
"type": {
|
|
1052
|
+
"kind": "SCALAR",
|
|
1053
|
+
"name": "Long",
|
|
1054
|
+
"ofType": null
|
|
1055
|
+
},
|
|
1056
|
+
"isDeprecated": false,
|
|
1057
|
+
"deprecationReason": null
|
|
1058
|
+
},
|
|
979
1059
|
{
|
|
980
1060
|
"name": "orderedProductSales",
|
|
981
1061
|
"description": "The amount of ordered product sales, calculated by multiplying the price of\nproducts and the number of units sold for the selected time period.",
|
|
@@ -994,7 +1074,7 @@
|
|
|
994
1074
|
},
|
|
995
1075
|
{
|
|
996
1076
|
"name": "orderedProductSalesB2B",
|
|
997
|
-
"description": "The amount of ordered product sales to Amazon Business customers, calculated\nby multiplying the price of products and the number of units sold for the\nselected time period.",
|
|
1077
|
+
"description": "The amount of ordered product sales to Amazon Business customers, calculated\nby multiplying the price of products and the number of units sold for the\nselected time period. Note: This field is only populated when the seller is a B2B seller.",
|
|
998
1078
|
"args": [],
|
|
999
1079
|
"type": {
|
|
1000
1080
|
"kind": "OBJECT",
|
|
@@ -1006,7 +1086,7 @@
|
|
|
1006
1086
|
},
|
|
1007
1087
|
{
|
|
1008
1088
|
"name": "ordersShipped",
|
|
1009
|
-
"description": "The number of orders shipped
|
|
1089
|
+
"description": "The number of orders shipped for the selected time period.",
|
|
1010
1090
|
"args": [],
|
|
1011
1091
|
"type": {
|
|
1012
1092
|
"kind": "NON_NULL",
|
|
@@ -1022,7 +1102,7 @@
|
|
|
1022
1102
|
},
|
|
1023
1103
|
{
|
|
1024
1104
|
"name": "refundRate",
|
|
1025
|
-
"description": "The percentage conversion metric indicating how many orders were refunded by\nthe seller, calculated by dividing
|
|
1105
|
+
"description": "The percentage conversion metric indicating how many orders were refunded by\nthe seller, calculated by dividing unitsRefunded by unitsOrdered for the\nselected time period.",
|
|
1026
1106
|
"args": [],
|
|
1027
1107
|
"type": {
|
|
1028
1108
|
"kind": "NON_NULL",
|
|
@@ -1036,6 +1116,18 @@
|
|
|
1036
1116
|
"isDeprecated": false,
|
|
1037
1117
|
"deprecationReason": null
|
|
1038
1118
|
},
|
|
1119
|
+
{
|
|
1120
|
+
"name": "refundRateB2B",
|
|
1121
|
+
"description": "The percentage conversion metric indicating how many orders were refunded by\nAmazon Business customers, calculated by dividing unitsRefundedB2B by\nunitsOrderedB2B for the selected time period. Note: This field is only\npopulated when the seller is a B2B seller.",
|
|
1122
|
+
"args": [],
|
|
1123
|
+
"type": {
|
|
1124
|
+
"kind": "SCALAR",
|
|
1125
|
+
"name": "Float",
|
|
1126
|
+
"ofType": null
|
|
1127
|
+
},
|
|
1128
|
+
"isDeprecated": false,
|
|
1129
|
+
"deprecationReason": null
|
|
1130
|
+
},
|
|
1039
1131
|
{
|
|
1040
1132
|
"name": "shippedProductSales",
|
|
1041
1133
|
"description": "The amount of ordered product sales shipped for the selected time period.",
|
|
@@ -1070,7 +1162,7 @@
|
|
|
1070
1162
|
},
|
|
1071
1163
|
{
|
|
1072
1164
|
"name": "totalOrderItemsB2B",
|
|
1073
|
-
"description": "The number of items that were ordered by Amazon Business customers for the\nselected time period. Example: For an order containing 2 copies of book A and\n3 copies of book B, the number of orders is 1, the number of order items is 2\n(book A and book B), and the number of units is 5 (2 + 3).",
|
|
1165
|
+
"description": "The number of items that were ordered by Amazon Business customers for the\nselected time period. Example: For an order containing 2 copies of book A and\n3 copies of book B, the number of orders is 1, the number of order items is 2\n(book A and book B), and the number of units is 5 (2 + 3). Note: This field is\nonly populated when the seller is a B2B seller.",
|
|
1074
1166
|
"args": [],
|
|
1075
1167
|
"type": {
|
|
1076
1168
|
"kind": "SCALAR",
|
|
@@ -1098,7 +1190,7 @@
|
|
|
1098
1190
|
},
|
|
1099
1191
|
{
|
|
1100
1192
|
"name": "unitsOrderedB2B",
|
|
1101
|
-
"description": "The number of units ordered by Amazon Business customers for the selected time\nperiod. Example: For an order containing 2 copies of book A and 3 copies of\nbook B, the number of orders is 1, the number of order items is 2 (book A and\nbook B), and the number of units is 5 (2 + 3).",
|
|
1193
|
+
"description": "The number of units ordered by Amazon Business customers for the selected time\nperiod. Example: For an order containing 2 copies of book A and 3 copies of\nbook B, the number of orders is 1, the number of order items is 2 (book A and\nbook B), and the number of units is 5 (2 + 3). Note: This field is only\npopulated when the seller is a B2B seller.",
|
|
1102
1194
|
"args": [],
|
|
1103
1195
|
"type": {
|
|
1104
1196
|
"kind": "SCALAR",
|
|
@@ -1110,7 +1202,7 @@
|
|
|
1110
1202
|
},
|
|
1111
1203
|
{
|
|
1112
1204
|
"name": "unitsRefunded",
|
|
1113
|
-
"description": "The number of units refunded
|
|
1205
|
+
"description": "The number of units refunded for the selected time period.",
|
|
1114
1206
|
"args": [],
|
|
1115
1207
|
"type": {
|
|
1116
1208
|
"kind": "NON_NULL",
|
|
@@ -1124,9 +1216,21 @@
|
|
|
1124
1216
|
"isDeprecated": false,
|
|
1125
1217
|
"deprecationReason": null
|
|
1126
1218
|
},
|
|
1219
|
+
{
|
|
1220
|
+
"name": "unitsRefundedB2B",
|
|
1221
|
+
"description": "The number of units refunded by Amazon Business customers for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
|
|
1222
|
+
"args": [],
|
|
1223
|
+
"type": {
|
|
1224
|
+
"kind": "SCALAR",
|
|
1225
|
+
"name": "Long",
|
|
1226
|
+
"ofType": null
|
|
1227
|
+
},
|
|
1228
|
+
"isDeprecated": false,
|
|
1229
|
+
"deprecationReason": null
|
|
1230
|
+
},
|
|
1127
1231
|
{
|
|
1128
1232
|
"name": "unitsShipped",
|
|
1129
|
-
"description": "The number of units shipped
|
|
1233
|
+
"description": "The number of units shipped for the selected time period.",
|
|
1130
1234
|
"args": [],
|
|
1131
1235
|
"type": {
|
|
1132
1236
|
"kind": "NON_NULL",
|
|
@@ -1153,7 +1257,7 @@
|
|
|
1153
1257
|
"fields": [
|
|
1154
1258
|
{
|
|
1155
1259
|
"name": "averageOfferCount",
|
|
1156
|
-
"description": "The average number of offers listed for sale
|
|
1260
|
+
"description": "The average number of offers listed for sale for the selected time period. It\nis calculated from the total number of offers and the total number of days for\nthe selected time period.",
|
|
1157
1261
|
"args": [],
|
|
1158
1262
|
"type": {
|
|
1159
1263
|
"kind": "NON_NULL",
|
|
@@ -1169,7 +1273,7 @@
|
|
|
1169
1273
|
},
|
|
1170
1274
|
{
|
|
1171
1275
|
"name": "averageParentItems",
|
|
1172
|
-
"description": "The average number of parent items listed for sale
|
|
1276
|
+
"description": "The average number of parent items listed for sale for the selected time period.",
|
|
1173
1277
|
"args": [],
|
|
1174
1278
|
"type": {
|
|
1175
1279
|
"kind": "NON_NULL",
|
|
@@ -1269,7 +1373,7 @@
|
|
|
1269
1373
|
},
|
|
1270
1374
|
{
|
|
1271
1375
|
"name": "feedbackReceived",
|
|
1272
|
-
"description": "The number of times customers left feedback
|
|
1376
|
+
"description": "The number of times customers left feedback for the selected time period.",
|
|
1273
1377
|
"args": [],
|
|
1274
1378
|
"type": {
|
|
1275
1379
|
"kind": "NON_NULL",
|
|
@@ -1283,6 +1387,18 @@
|
|
|
1283
1387
|
"isDeprecated": false,
|
|
1284
1388
|
"deprecationReason": null
|
|
1285
1389
|
},
|
|
1390
|
+
{
|
|
1391
|
+
"name": "feedbackReceivedB2B",
|
|
1392
|
+
"description": "The number of times Amazon Business customers left feedback for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
|
|
1393
|
+
"args": [],
|
|
1394
|
+
"type": {
|
|
1395
|
+
"kind": "SCALAR",
|
|
1396
|
+
"name": "Long",
|
|
1397
|
+
"ofType": null
|
|
1398
|
+
},
|
|
1399
|
+
"isDeprecated": false,
|
|
1400
|
+
"deprecationReason": null
|
|
1401
|
+
},
|
|
1286
1402
|
{
|
|
1287
1403
|
"name": "mobileAppPageViews",
|
|
1288
1404
|
"description": "Mobile app page views are the number of times a user visited your Amazon.com\nmobile app pages for the selected time period.",
|
|
@@ -1341,7 +1457,7 @@
|
|
|
1341
1457
|
},
|
|
1342
1458
|
{
|
|
1343
1459
|
"name": "negativeFeedbackReceived",
|
|
1344
|
-
"description": "The number of times customers left negative feedback
|
|
1460
|
+
"description": "The number of times customers left negative feedback for the selected time period.",
|
|
1345
1461
|
"args": [],
|
|
1346
1462
|
"type": {
|
|
1347
1463
|
"kind": "NON_NULL",
|
|
@@ -1355,6 +1471,18 @@
|
|
|
1355
1471
|
"isDeprecated": false,
|
|
1356
1472
|
"deprecationReason": null
|
|
1357
1473
|
},
|
|
1474
|
+
{
|
|
1475
|
+
"name": "negativeFeedbackReceivedB2B",
|
|
1476
|
+
"description": "The number of times Amazon Business customers left negative feedback for the\nselected time period. Note: This field is only populated when the seller is a B2B seller.",
|
|
1477
|
+
"args": [],
|
|
1478
|
+
"type": {
|
|
1479
|
+
"kind": "SCALAR",
|
|
1480
|
+
"name": "Long",
|
|
1481
|
+
"ofType": null
|
|
1482
|
+
},
|
|
1483
|
+
"isDeprecated": false,
|
|
1484
|
+
"deprecationReason": null
|
|
1485
|
+
},
|
|
1358
1486
|
{
|
|
1359
1487
|
"name": "orderItemSessionPercentage",
|
|
1360
1488
|
"description": "The percentage conversion metric indicating how many order items were\ngenerated relative to the number of people who viewed the products.",
|
|
@@ -1413,7 +1541,7 @@
|
|
|
1413
1541
|
},
|
|
1414
1542
|
{
|
|
1415
1543
|
"name": "receivedNegativeFeedbackRate",
|
|
1416
|
-
"description": "The negative feedback rate is the number of orders that have received negative\nfeedback divided by the number of orders
|
|
1544
|
+
"description": "The negative feedback rate is the number of orders that have received negative\nfeedback divided by the number of orders for the selected time period.",
|
|
1417
1545
|
"args": [],
|
|
1418
1546
|
"type": {
|
|
1419
1547
|
"kind": "NON_NULL",
|
|
@@ -1427,6 +1555,18 @@
|
|
|
1427
1555
|
"isDeprecated": false,
|
|
1428
1556
|
"deprecationReason": null
|
|
1429
1557
|
},
|
|
1558
|
+
{
|
|
1559
|
+
"name": "receivedNegativeFeedbackRateB2B",
|
|
1560
|
+
"description": "The negative feedback rate for Amazon Business customers is the number of\norders that have received negative feedback divided by the number of orders\nfor the selected time period. Note: This field is only populated when the\nseller is a B2B seller.",
|
|
1561
|
+
"args": [],
|
|
1562
|
+
"type": {
|
|
1563
|
+
"kind": "SCALAR",
|
|
1564
|
+
"name": "Float",
|
|
1565
|
+
"ofType": null
|
|
1566
|
+
},
|
|
1567
|
+
"isDeprecated": false,
|
|
1568
|
+
"deprecationReason": null
|
|
1569
|
+
},
|
|
1430
1570
|
{
|
|
1431
1571
|
"name": "sessions",
|
|
1432
1572
|
"description": "Sessions are visits to your Amazon.com browser or mobile app pages by a user.\nAll browser and mobile app activity within a 24-hour period is considered a\nsession. It is calculated as the sum of browserSessions and mobileAppSessions.",
|
|
@@ -18,14 +18,14 @@ module Peddler
|
|
|
18
18
|
# @return [String]
|
|
19
19
|
attribute(:notification_type, String, from: "NotificationType")
|
|
20
20
|
|
|
21
|
+
# @return [String]
|
|
22
|
+
attribute(:notification_version, String, from: "NotificationVersion")
|
|
23
|
+
|
|
21
24
|
# @return [Payload]
|
|
22
25
|
attribute(:payload, Payload, from: "Payload")
|
|
23
26
|
|
|
24
27
|
# @return [String]
|
|
25
28
|
attribute(:payload_version, String, from: "PayloadVersion")
|
|
26
|
-
|
|
27
|
-
# @return [String]
|
|
28
|
-
attribute?(:notification_version, String, from: "NotificationVersion")
|
|
29
29
|
end
|
|
30
30
|
end
|
|
31
31
|
end
|
data/lib/peddler/version.rb
CHANGED
data/lib/peddler.rb
CHANGED
|
@@ -45,6 +45,7 @@ module Peddler
|
|
|
45
45
|
def messaging_v1 = APIs::MessagingV1
|
|
46
46
|
def notifications_v1 = APIs::NotificationsV1
|
|
47
47
|
def orders_v0 = APIs::OrdersV0
|
|
48
|
+
def orders_2026_01_01 = APIs::Orders20260101
|
|
48
49
|
def product_fees_v0 = APIs::ProductFeesV0
|
|
49
50
|
def product_pricing_v0 = APIs::ProductPricingV0
|
|
50
51
|
def product_pricing_2022_05_01 = APIs::ProductPricing20220501
|
|
@@ -102,7 +103,7 @@ module Peddler
|
|
|
102
103
|
alias_method :merchant_fulfillment, :merchant_fulfillment_v0
|
|
103
104
|
alias_method :messaging, :messaging_v1
|
|
104
105
|
alias_method :notifications, :notifications_v1
|
|
105
|
-
alias_method :orders, :
|
|
106
|
+
alias_method :orders, :orders_2026_01_01
|
|
106
107
|
alias_method :product_fees, :product_fees_v0
|
|
107
108
|
alias_method :product_pricing, :product_pricing_2022_05_01
|
|
108
109
|
alias_method :product_type_definitions, :product_type_definitions_2020_09_01
|