peddler 5.1.0 → 5.3.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/README.md +2 -3
- 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/fulfillment_inbound_2024_03_20/item.rb +2 -1
- data/lib/peddler/apis/fulfillment_outbound_2020_07_01/drop_off_location.rb +2 -0
- 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/messaging_v1.rb +0 -20
- 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.rb +2 -2
- data/lib/peddler/apis/product_pricing_v0/get_offers_result.rb +3 -3
- 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/regulation_references.rb +9 -11
- data/lib/peddler/data_kiosk/sales_and_traffic20240424/by_asin_sales.rb +37 -0
- data/lib/peddler/data_kiosk/sales_and_traffic20240424/by_date_sales.rb +40 -8
- data/lib/peddler/data_kiosk/sales_and_traffic20240424/by_date_traffic.rb +19 -6
- data/lib/peddler/data_kiosk/sales_and_traffic20240424.json +273 -13
- data/lib/peddler/notifications/any_offer_changed/notification.rb +3 -3
- data/lib/peddler/notifications/b2b_any_offer_changed/b2b_any_offer_changed_notification.rb +6 -6
- data/lib/peddler/notifications/b2b_any_offer_changed/buy_box_price.rb +12 -9
- data/lib/peddler/notifications/b2b_any_offer_changed/lowest_price.rb +11 -8
- data/lib/peddler/notifications/b2b_any_offer_changed/notification.rb +10 -13
- data/lib/peddler/notifications/b2b_any_offer_changed/notification_metadata.rb +8 -8
- data/lib/peddler/notifications/b2b_any_offer_changed/offer.rb +25 -23
- data/lib/peddler/notifications/b2b_any_offer_changed/offer_change_trigger.rb +9 -9
- data/lib/peddler/notifications/b2b_any_offer_changed/offer_count.rb +4 -4
- data/lib/peddler/notifications/b2b_any_offer_changed/payload.rb +2 -2
- data/lib/peddler/notifications/b2b_any_offer_changed/points.rb +16 -0
- data/lib/peddler/notifications/b2b_any_offer_changed/prime_information.rb +4 -4
- data/lib/peddler/notifications/b2b_any_offer_changed/quantity_discount_price_type.rb +3 -3
- data/lib/peddler/notifications/b2b_any_offer_changed/seller_feedback_rating.rb +4 -4
- data/lib/peddler/notifications/b2b_any_offer_changed/shipping_time.rb +9 -9
- data/lib/peddler/notifications/b2b_any_offer_changed/ships_from.rb +4 -1
- data/lib/peddler/notifications/b2b_any_offer_changed/summary.rb +8 -8
- 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/messaging_v1.rbs +0 -34
- data/sig/peddler/apis/orders_2026_01_01.rbs +940 -0
- data/sig/peddler/apis/product_pricing_v0.rbs +7 -7
- data/sig/peddler/apis/vendor_shipments_v1.rbs +18 -18
- data/sig/peddler/data_kiosk/sales_and_traffic20240424.rbs +41 -21
- data/sig/peddler/notifications/any_offer_changed.rbs +7 -7
- data/sig/peddler/notifications/b2b_any_offer_changed.rbs +58 -38
- data/sig/peddler.rbs +3 -1
- metadata +69 -12
- data/lib/peddler/apis/messaging_v1/create_amazon_motors_request.rb +0 -19
- data/lib/peddler/apis/messaging_v1/create_amazon_motors_response.rb +0 -17
- 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
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is generated. Do not edit.
|
|
4
|
+
|
|
5
|
+
require "structure"
|
|
6
|
+
require "time"
|
|
7
|
+
|
|
8
|
+
module Peddler
|
|
9
|
+
module APIs
|
|
10
|
+
class Orders20260101
|
|
11
|
+
# A list of orders.
|
|
12
|
+
SearchOrdersResponse = Structure.new do
|
|
13
|
+
# @return [Array<Order>] An array containing all orders that match the search criteria.
|
|
14
|
+
attribute(:orders, [Order])
|
|
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.
|
|
18
|
+
attribute?(:created_before, Time, from: "createdBefore")
|
|
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.
|
|
22
|
+
attribute?(:last_updated_before, Time, from: "lastUpdatedBefore")
|
|
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.
|
|
31
|
+
attribute?(:pagination, Pagination)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
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
|
+
# Specific time interval defining the start and end times.
|
|
11
|
+
TimeWindow = Structure.new do
|
|
12
|
+
# @return [HourMinute] The end of the time window.
|
|
13
|
+
attribute?(:end_time, HourMinute, from: "endTime")
|
|
14
|
+
|
|
15
|
+
# @return [HourMinute] The beginning of the time window.
|
|
16
|
+
attribute?(:start_time, HourMinute, from: "startTime")
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is generated. Do not edit.
|
|
4
|
+
|
|
5
|
+
module Peddler
|
|
6
|
+
module APIs
|
|
7
|
+
# The Selling Partner API for Orders
|
|
8
|
+
#
|
|
9
|
+
# The Selling Partner API for Orders returns orders information. This API supports the following types of orders:
|
|
10
|
+
#
|
|
11
|
+
# - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh
|
|
12
|
+
#
|
|
13
|
+
# This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces,
|
|
14
|
+
# for which data from 2016 and after is available.
|
|
15
|
+
#
|
|
16
|
+
# @see https://github.com/amzn/selling-partner-api-models/blob/main/models/orders-api-model/orders_2026-01-01.json
|
|
17
|
+
class Orders20260101 < API
|
|
18
|
+
# Returns orders that are created or updated during the time period that you specify. You can filter the response
|
|
19
|
+
# for specific types of orders.
|
|
20
|
+
#
|
|
21
|
+
# @note This operation can make a static sandbox call.
|
|
22
|
+
# @param created_after [String] The response includes orders created at or after this time. The date must be in
|
|
23
|
+
# [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: You must provide exactly
|
|
24
|
+
# one of `createdAfter` and `lastUpdatedAfter` in your request. If `createdAfter` is provided, neither
|
|
25
|
+
# `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.
|
|
26
|
+
# @param created_before [String] The response includes orders created at or before this time. The date must be in
|
|
27
|
+
# [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: If you include
|
|
28
|
+
# `createdAfter` in the request, `createdBefore` is optional, and if provided must be equal to or after the
|
|
29
|
+
# `createdAfter` date and at least two minutes before the time of the request. If `createdBefore` is provided,
|
|
30
|
+
# neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.
|
|
31
|
+
# @param last_updated_after [String] The response includes orders updated at or after this time. An update is
|
|
32
|
+
# defined as any change made by Amazon or by the seller, including an update to the order status. The date must
|
|
33
|
+
# be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: You must provide
|
|
34
|
+
# exactly one of `createdAfter` and `lastUpdatedAfter`. If `lastUpdatedAfter` is provided, neither
|
|
35
|
+
# `createdAfter` nor `createdBefore` may be provided.
|
|
36
|
+
# @param last_updated_before [String] The response includes orders updated at or before this time. An update is
|
|
37
|
+
# defined as any change made by Amazon or by the seller, including an update to the order status. The date must
|
|
38
|
+
# be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: If you include
|
|
39
|
+
# `lastUpdatedAfter` in the request, `lastUpdatedBefore` is optional, and if provided must be equal to or after
|
|
40
|
+
# the `lastUpdatedAfter` date and at least two minutes before the time of the request. If `lastUpdatedBefore` is
|
|
41
|
+
# provided, neither `createdAfter` nor `createdBefore` may be provided.
|
|
42
|
+
# @param fulfillment_statuses [Array<String>] A list of `FulfillmentStatus` values you can use to filter the
|
|
43
|
+
# results.
|
|
44
|
+
# @param marketplace_ids [Array<String>] The response includes orders that were placed in marketplaces you include
|
|
45
|
+
# in this list. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a
|
|
46
|
+
# complete list of `marketplaceId` values.
|
|
47
|
+
# @param fulfilled_by [Array<String>] The response includes orders that are fulfilled by the parties that you
|
|
48
|
+
# include in this list.
|
|
49
|
+
# @param max_results_per_page [Integer] The maximum number of orders that can be returned per page. The value must
|
|
50
|
+
# be between 1 and 100. **Default:** 100.
|
|
51
|
+
# @param pagination_token [String] Pagination occurs when a request produces a response that exceeds the
|
|
52
|
+
# `maxResultsPerPage`. This means that the response is divided into individual pages. To retrieve the next page,
|
|
53
|
+
# you must pass the `nextToken` value as the `paginationToken` query parameter in the next request. You will not
|
|
54
|
+
# receive a `nextToken` value on the last page.
|
|
55
|
+
# @param included_data [Array<String>] A list of datasets to include in the response.
|
|
56
|
+
# @return [Peddler::Response] The API response
|
|
57
|
+
def search_orders(created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil,
|
|
58
|
+
fulfillment_statuses: nil, marketplace_ids: nil, fulfilled_by: nil, max_results_per_page: nil,
|
|
59
|
+
pagination_token: nil, included_data: nil)
|
|
60
|
+
path = "/orders/2026-01-01/orders"
|
|
61
|
+
params = {
|
|
62
|
+
"createdAfter" => created_after,
|
|
63
|
+
"createdBefore" => created_before,
|
|
64
|
+
"lastUpdatedAfter" => last_updated_after,
|
|
65
|
+
"lastUpdatedBefore" => last_updated_before,
|
|
66
|
+
"fulfillmentStatuses" => stringify_array(fulfillment_statuses),
|
|
67
|
+
"marketplaceIds" => stringify_array(marketplace_ids),
|
|
68
|
+
"fulfilledBy" => stringify_array(fulfilled_by),
|
|
69
|
+
"maxResultsPerPage" => max_results_per_page,
|
|
70
|
+
"paginationToken" => pagination_token,
|
|
71
|
+
"includedData" => stringify_array(included_data),
|
|
72
|
+
}.compact
|
|
73
|
+
parser = -> { SearchOrdersResponse }
|
|
74
|
+
get(path, params:, parser:)
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# Returns the order that you specify.
|
|
78
|
+
#
|
|
79
|
+
# @note This operation can make a static sandbox call.
|
|
80
|
+
# @param order_id [String] An Amazon-defined order identifier.
|
|
81
|
+
# @param included_data [Array<String>] A list of datasets to include in the response.
|
|
82
|
+
# @return [Peddler::Response] The API response
|
|
83
|
+
def get_order(order_id, included_data: nil)
|
|
84
|
+
path = "/orders/2026-01-01/orders/#{percent_encode(order_id)}"
|
|
85
|
+
params = {
|
|
86
|
+
"includedData" => stringify_array(included_data),
|
|
87
|
+
}.compact
|
|
88
|
+
parser = -> { GetOrderResponse }
|
|
89
|
+
get(path, params:, parser:)
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
@@ -93,10 +93,10 @@ module Peddler
|
|
|
93
93
|
# @param is_ispu [Boolean] When true, this order is marked to be picked up from a store rather than delivered.
|
|
94
94
|
# @param store_chain_store_id [String] The store chain store identifier. Linked to a specific store in a store
|
|
95
95
|
# chain.
|
|
96
|
-
# @param earliest_delivery_date_before [String] Use this date to select orders with
|
|
96
|
+
# @param earliest_delivery_date_before [String] Use this date to select orders with an earliest delivery date
|
|
97
97
|
# before (or at) a specified time. The date must be in [ISO
|
|
98
98
|
# 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
99
|
-
# @param earliest_delivery_date_after [String] Use this date to select orders with
|
|
99
|
+
# @param earliest_delivery_date_after [String] Use this date to select orders with an earliest delivery date after
|
|
100
100
|
# (or at) a specified time. The date must be in [ISO
|
|
101
101
|
# 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
102
102
|
# @param latest_delivery_date_before [String] Use this date to select orders with a latest delivery date before
|
|
@@ -15,9 +15,6 @@ module Peddler
|
|
|
15
15
|
# @return [String] The condition of the item.
|
|
16
16
|
attribute(:item_condition, String, from: "ItemCondition")
|
|
17
17
|
|
|
18
|
-
# @return [String] A marketplace identifier.
|
|
19
|
-
attribute(:marketplace_id, String, from: "MarketplaceID")
|
|
20
|
-
|
|
21
18
|
# @return [Array<OfferDetail>] A list of offer details. The list is the same length as the TotalOfferCount in
|
|
22
19
|
# the Summary or 20, whichever is less.
|
|
23
20
|
attribute(:offers, [OfferDetail], from: "Offers")
|
|
@@ -25,6 +22,9 @@ module Peddler
|
|
|
25
22
|
# @return [Summary] Pricing information about the item.
|
|
26
23
|
attribute(:summary, Summary, from: "Summary")
|
|
27
24
|
|
|
25
|
+
# @return [String] A marketplace identifier.
|
|
26
|
+
attribute(:marketplace_id, String, from: "marketplaceId")
|
|
27
|
+
|
|
28
28
|
# @return [String] The status of the operation.
|
|
29
29
|
attribute(:status, String)
|
|
30
30
|
|
|
@@ -10,6 +10,10 @@ module Peddler
|
|
|
10
10
|
# Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever
|
|
11
11
|
# is appropriate.
|
|
12
12
|
ItemDetails = Structure.new do
|
|
13
|
+
# @return [String] The two-character country code for the country where the product was manufactured or
|
|
14
|
+
# originates. Use ISO 3166-1 alpha-2 format.
|
|
15
|
+
attribute?(:country_of_origin, String, from: "countryOfOrigin")
|
|
16
|
+
|
|
13
17
|
# @return [Expiry] Expiry refers to the collection of dates required for certain items. These could be either
|
|
14
18
|
# expiryDate or mfgDate and expiryAfterDuration. These are mandatory for perishable items.
|
|
15
19
|
attribute?(:expiry, Expiry)
|
|
@@ -22,6 +26,15 @@ module Peddler
|
|
|
22
26
|
# the trade item itself or to items contained. This field is mandatory for all perishable items.
|
|
23
27
|
attribute?(:lot_number, String, from: "lotNumber")
|
|
24
28
|
|
|
29
|
+
# @return [String] The location identifier where the product receives a traceability lot number. Provide this
|
|
30
|
+
# field for products subject to the FDA Food Safety Modernization Act (FSMA) Section 204. When you provide
|
|
31
|
+
# `lotNumberSourceReference`, you must also specify the corresponding `lotNumberSourceType` field.
|
|
32
|
+
attribute?(:lot_number_source_reference, String, from: "lotNumberSourceReference")
|
|
33
|
+
|
|
34
|
+
# @return [String] The identifier type used for the lot number source. Provide this field when you specify
|
|
35
|
+
# `lotNumberSourceReference`.
|
|
36
|
+
attribute?(:lot_number_source_type, String, from: "lotNumberSourceType")
|
|
37
|
+
|
|
25
38
|
# @return [Money] Maximum retail price of the item being shipped.
|
|
26
39
|
attribute?(:maximum_retail_price, Money, from: "maximumRetailPrice")
|
|
27
40
|
|
|
@@ -30,6 +43,9 @@ module Peddler
|
|
|
30
43
|
# provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character
|
|
31
44
|
# alpha-numeric code.
|
|
32
45
|
attribute?(:purchase_order_number, String, from: "purchaseOrderNumber")
|
|
46
|
+
|
|
47
|
+
# @return [RegulationReferences] Regulatory requirements and compliance information for the item.
|
|
48
|
+
attribute?(:regulation_references, RegulationReferences, from: "regulationReferences")
|
|
33
49
|
end
|
|
34
50
|
end
|
|
35
51
|
end
|
|
@@ -10,10 +10,6 @@ module Peddler
|
|
|
10
10
|
# Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever
|
|
11
11
|
# is appropriate.
|
|
12
12
|
PackageItemDetails = Structure.new do
|
|
13
|
-
# @return [String] The two digit country code in ISO 3166-1 alpha-2 format representing the country where the
|
|
14
|
-
# product was manufactured or originated.
|
|
15
|
-
attribute?(:country_of_origin, String, from: "countryOfOrigin")
|
|
16
|
-
|
|
17
13
|
# @return [Expiry] Either expiryDate or mfgDate and expiryAfterDuration are mandatory for perishable items.
|
|
18
14
|
attribute?(:expiry, Expiry)
|
|
19
15
|
|
|
@@ -22,23 +18,11 @@ module Peddler
|
|
|
22
18
|
# the trade item itself or to items contained. This field is mandatory for all perishable items.
|
|
23
19
|
attribute?(:lot_number, String, from: "lotNumber")
|
|
24
20
|
|
|
25
|
-
# @return [String] This is a reference to the lot number source location meaning the place where the product was
|
|
26
|
-
# assigned a traceability lot number. This is mandatory for goods in scope of the FDA Food Safety
|
|
27
|
-
# Modernization Act (FSMA 204). If provided, lotNumberSourceType must also be specified.
|
|
28
|
-
attribute?(:lot_number_source_reference, String, from: "lotNumberSourceReference")
|
|
29
|
-
|
|
30
|
-
# @return [String] The type of reference for the lot number source. Must be provided when
|
|
31
|
-
# lotNumberSourceReference is specified.
|
|
32
|
-
attribute?(:lot_number_source_type, String, from: "lotNumberSourceType")
|
|
33
|
-
|
|
34
21
|
# @return [String] The purchase order number for the shipment being confirmed. If the items in this shipment
|
|
35
22
|
# belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then
|
|
36
23
|
# provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character
|
|
37
24
|
# alpha-numeric code.
|
|
38
25
|
attribute?(:purchase_order_number, String, from: "purchaseOrderNumber")
|
|
39
|
-
|
|
40
|
-
# @return [RegulationReferences] References to regulatory requirements and compliance information for the item.
|
|
41
|
-
attribute?(:regulation_references, RegulationReferences, from: "regulationReferences")
|
|
42
26
|
end
|
|
43
27
|
end
|
|
44
28
|
end
|
|
@@ -7,24 +7,22 @@ require "structure"
|
|
|
7
7
|
module Peddler
|
|
8
8
|
module APIs
|
|
9
9
|
class VendorShipmentsV1
|
|
10
|
-
#
|
|
11
|
-
#
|
|
12
|
-
#
|
|
10
|
+
# Regulatory requirements and compliance information for the item, including reference numbers, verification
|
|
11
|
+
# codes, and exemption codes. Use this field to specify applicable regulations such as EU Deforestation Regulation
|
|
12
|
+
# (EUDR).
|
|
13
13
|
RegulationReferences = Structure.new do
|
|
14
|
-
# @return [String] The
|
|
15
|
-
# diligence requirements.
|
|
14
|
+
# @return [String] The exemption code for EUDR products exempt from due diligence requirements.
|
|
16
15
|
attribute?(:due_diligence_exemption_code, String, from: "dueDiligenceExemptionCode")
|
|
17
16
|
|
|
18
|
-
# @return [String] The EUDR Due Diligence
|
|
19
|
-
# within Amazon compliance collection experience.
|
|
17
|
+
# @return [String] The EUDR Due Diligence information pre-loaded in Vendor Central.
|
|
20
18
|
attribute?(:due_diligence_information, String, from: "dueDiligenceInformation")
|
|
21
19
|
|
|
22
|
-
# @return [String] The
|
|
23
|
-
#
|
|
20
|
+
# @return [String] The reference number from the vendor's EUDR Due Diligence Statement (DDS) submitted to the EU
|
|
21
|
+
# Commission portal or provided to Amazon through ONIX feed.
|
|
24
22
|
attribute?(:due_diligence_reference, String, from: "dueDiligenceReference")
|
|
25
23
|
|
|
26
|
-
# @return [String] The EUDR Due Diligence
|
|
27
|
-
#
|
|
24
|
+
# @return [String] The EUDR Due Diligence verification number provided by the EU Commission for the submitted
|
|
25
|
+
# DDS.
|
|
28
26
|
attribute?(:due_diligence_verification, String, from: "dueDiligenceVerification")
|
|
29
27
|
end
|
|
30
28
|
end
|
|
@@ -18,6 +18,29 @@ module Peddler
|
|
|
18
18
|
# populated when the seller is a B2B seller.
|
|
19
19
|
attribute?(:ordered_product_sales_b2b, Amount, from: "orderedProductSalesB2B")
|
|
20
20
|
|
|
21
|
+
# @return [String] The number of orders shipped for the selected time period.
|
|
22
|
+
attribute?(:orders_shipped, String, null: false, from: "ordersShipped")
|
|
23
|
+
|
|
24
|
+
# @return [String] The number of orders shipped to Amazon Business customers for the selected time period. Note:
|
|
25
|
+
# This field is only populated when the seller is a B2B seller.
|
|
26
|
+
attribute?(:orders_shipped_b2b, String, from: "ordersShippedB2B")
|
|
27
|
+
|
|
28
|
+
# @return [Float] The percentage conversion metric indicating how many orders were refunded, calculated by
|
|
29
|
+
# dividing unitsRefunded by unitsOrdered for the selected time period.
|
|
30
|
+
attribute?(:refund_rate, Float, null: false, from: "refundRate")
|
|
31
|
+
|
|
32
|
+
# @return [Float] The percentage conversion metric indicating how many orders were refunded by Amazon Business
|
|
33
|
+
# customers, calculated by dividing unitsRefundedB2B by unitsOrderedB2B for the selected time period. Note:
|
|
34
|
+
# This field is only populated when the seller is a B2B seller.
|
|
35
|
+
attribute?(:refund_rate_b2b, Float, from: "refundRateB2B")
|
|
36
|
+
|
|
37
|
+
# @return [Amount] The amount of ordered product sales shipped for the selected time period.
|
|
38
|
+
attribute?(:shipped_product_sales, Amount, null: false, from: "shippedProductSales")
|
|
39
|
+
|
|
40
|
+
# @return [Amount] The amount of ordered product sales shipped to Amazon Business customers for the selected
|
|
41
|
+
# time period. Note: This field is only populated when the seller is a B2B seller.
|
|
42
|
+
attribute?(:shipped_product_sales_b2b, Amount, from: "shippedProductSalesB2B")
|
|
43
|
+
|
|
21
44
|
# @return [String] The number of items that were ordered for the selected time period.
|
|
22
45
|
attribute?(:total_order_items, String, null: false, from: "totalOrderItems")
|
|
23
46
|
|
|
@@ -31,6 +54,20 @@ module Peddler
|
|
|
31
54
|
# @return [String] The number of units ordered by Amazon Business customers. Note: This field is only populated
|
|
32
55
|
# when the seller is a B2B seller.
|
|
33
56
|
attribute?(:units_ordered_b2b, String, from: "unitsOrderedB2B")
|
|
57
|
+
|
|
58
|
+
# @return [String] The number of units refunded for the selected time period.
|
|
59
|
+
attribute?(:units_refunded, String, null: false, from: "unitsRefunded")
|
|
60
|
+
|
|
61
|
+
# @return [String] The number of units refunded by Amazon Business customers for the selected time period. Note:
|
|
62
|
+
# This field is only populated when the seller is a B2B seller.
|
|
63
|
+
attribute?(:units_refunded_b2b, String, from: "unitsRefundedB2B")
|
|
64
|
+
|
|
65
|
+
# @return [String] The number of units shipped for the selected time period.
|
|
66
|
+
attribute?(:units_shipped, String, null: false, from: "unitsShipped")
|
|
67
|
+
|
|
68
|
+
# @return [String] The number of units shipped to Amazon Business customers for the selected time period. Note:
|
|
69
|
+
# This field is only populated when the seller is a B2B seller.
|
|
70
|
+
attribute?(:units_shipped_b2b, String, from: "unitsShippedB2B")
|
|
34
71
|
end
|
|
35
72
|
end
|
|
36
73
|
end
|
|
@@ -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,27 +37,49 @@ 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
|
|
|
63
|
+
# @return [String] The number of orders shipped to Amazon Business customers for the selected time period. Note:
|
|
64
|
+
# This field is only populated when the seller is a B2B seller.
|
|
65
|
+
attribute?(:orders_shipped_b2b, String, from: "ordersShippedB2B")
|
|
66
|
+
|
|
54
67
|
# @return [Float] The percentage conversion metric indicating how many orders were refunded by the seller,
|
|
55
|
-
# calculated by dividing
|
|
68
|
+
# calculated by dividing unitsRefunded by unitsOrdered for the selected time period.
|
|
56
69
|
attribute?(:refund_rate, Float, null: false, from: "refundRate")
|
|
57
70
|
|
|
71
|
+
# @return [Float] The percentage conversion metric indicating how many orders were refunded by Amazon Business
|
|
72
|
+
# customers, calculated by dividing unitsRefundedB2B by unitsOrderedB2B for the selected time period. Note:
|
|
73
|
+
# This field is only populated when the seller is a B2B seller.
|
|
74
|
+
attribute?(:refund_rate_b2b, Float, from: "refundRateB2B")
|
|
75
|
+
|
|
58
76
|
# @return [Amount] The amount of ordered product sales shipped for the selected time period.
|
|
59
77
|
attribute?(:shipped_product_sales, Amount, null: false, from: "shippedProductSales")
|
|
60
78
|
|
|
79
|
+
# @return [Amount] The amount of ordered product sales shipped to Amazon Business customers for the selected
|
|
80
|
+
# time period. Note: This field is only populated when the seller is a B2B seller.
|
|
81
|
+
attribute?(:shipped_product_sales_b2b, Amount, from: "shippedProductSalesB2B")
|
|
82
|
+
|
|
61
83
|
# @return [String] The number of items that were ordered for the selected time period. Example:
|
|
62
84
|
# For an order containing 2 copies of book A and 3 copies of book B, the number of orders is 1, the number of
|
|
63
85
|
# order items is 2 (book A and book B), and the number of units is 5 (2 + 3).
|
|
@@ -65,7 +87,8 @@ module Peddler
|
|
|
65
87
|
|
|
66
88
|
# @return [String] The number of items that were ordered by Amazon Business customers for the selected time
|
|
67
89
|
# 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).
|
|
90
|
+
# 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3). Note: This
|
|
91
|
+
# field is only populated when the seller is a B2B seller.
|
|
69
92
|
attribute?(:total_order_items_b2b, String, from: "totalOrderItemsB2B")
|
|
70
93
|
|
|
71
94
|
# @return [String] The number of units ordered for the selected time period. Example: For an order containing 2
|
|
@@ -75,14 +98,23 @@ module Peddler
|
|
|
75
98
|
|
|
76
99
|
# @return [String] The number of units ordered by Amazon Business customers for the selected time period.
|
|
77
100
|
# 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).
|
|
101
|
+
# number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3). Note: This field is
|
|
102
|
+
# only populated when the seller is a B2B seller.
|
|
79
103
|
attribute?(:units_ordered_b2b, String, from: "unitsOrderedB2B")
|
|
80
104
|
|
|
81
|
-
# @return [String] The number of units refunded
|
|
105
|
+
# @return [String] The number of units refunded for the selected time period.
|
|
82
106
|
attribute?(:units_refunded, String, null: false, from: "unitsRefunded")
|
|
83
107
|
|
|
84
|
-
# @return [String] The number of units
|
|
108
|
+
# @return [String] The number of units refunded by Amazon Business customers for the selected time period. Note:
|
|
109
|
+
# This field is only populated when the seller is a B2B seller.
|
|
110
|
+
attribute?(:units_refunded_b2b, String, from: "unitsRefundedB2B")
|
|
111
|
+
|
|
112
|
+
# @return [String] The number of units shipped for the selected time period.
|
|
85
113
|
attribute?(:units_shipped, String, null: false, from: "unitsShipped")
|
|
114
|
+
|
|
115
|
+
# @return [String] The number of units shipped to Amazon Business customers for the selected time period. Note:
|
|
116
|
+
# This field is only populated when the seller is a B2B seller.
|
|
117
|
+
attribute?(:units_shipped_b2b, String, from: "unitsShippedB2B")
|
|
86
118
|
end
|
|
87
119
|
end
|
|
88
120
|
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.
|