peddler 5.0.0 → 5.1.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 +6 -6
- data/lib/peddler/acronyms.rb +1 -0
- data/lib/peddler/api.rb +35 -62
- data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb +11 -11
- data/lib/peddler/apis/aplus_content_2020_11_01.rb +10 -10
- data/lib/peddler/apis/application_integrations_2024_04_01.rb +3 -3
- data/lib/peddler/apis/application_management_2023_11_30.rb +1 -1
- data/lib/peddler/apis/catalog_items_2020_12_01.rb +2 -2
- data/lib/peddler/apis/catalog_items_2022_04_01.rb +2 -2
- data/lib/peddler/apis/catalog_items_v0.rb +1 -1
- data/lib/peddler/apis/data_kiosk_2023_11_15.rb +5 -5
- data/lib/peddler/apis/delivery_by_amazon_2022_07_01/error.rb +23 -0
- data/lib/peddler/apis/delivery_by_amazon_2022_07_01/error_list.rb +18 -0
- data/lib/peddler/apis/delivery_by_amazon_2022_07_01/get_invoice_status_response.rb +26 -0
- data/lib/peddler/apis/delivery_by_amazon_2022_07_01/submit_invoice_request.rb +31 -0
- data/lib/peddler/apis/delivery_by_amazon_2022_07_01/submit_invoice_response.rb +17 -0
- data/lib/peddler/apis/delivery_by_amazon_2022_07_01.rb +59 -0
- data/lib/peddler/apis/easy_ship_2022_03_23.rb +5 -5
- data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/shipment.rb +3 -0
- data/lib/peddler/apis/fba_inbound_eligibility_v1.rb +1 -1
- data/lib/peddler/apis/fba_inventory_v1.rb +1 -1
- data/lib/peddler/apis/feeds_2021_06_30.rb +6 -6
- data/lib/peddler/apis/finances_2024_06_19/amazon_pay_context.rb +2 -2
- data/lib/peddler/apis/finances_2024_06_19/breakdown.rb +3 -4
- data/lib/peddler/apis/finances_2024_06_19/context.rb +11 -11
- data/lib/peddler/apis/finances_2024_06_19/contexts.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/deferred_context.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/error.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/error_list.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/item.rb +3 -3
- data/lib/peddler/apis/finances_2024_06_19/item_related_identifier.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/item_related_identifiers.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/items.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/marketplace_details.rb +2 -3
- data/lib/peddler/apis/finances_2024_06_19/payments_context.rb +5 -5
- data/lib/peddler/apis/finances_2024_06_19/product_context.rb +4 -4
- data/lib/peddler/apis/finances_2024_06_19/related_identifier.rb +2 -2
- data/lib/peddler/apis/finances_2024_06_19/selling_partner_metadata.rb +3 -3
- data/lib/peddler/apis/finances_2024_06_19/time_range_context.rb +3 -3
- data/lib/peddler/apis/finances_2024_06_19/transaction.rb +8 -10
- data/lib/peddler/apis/finances_2024_06_19/transactions.rb +1 -1
- data/lib/peddler/apis/finances_2024_06_19/transactions_payload.rb +4 -2
- data/lib/peddler/apis/finances_2024_06_19.rb +24 -13
- data/lib/peddler/apis/finances_v0/adhoc_disbursement_event.rb +1 -3
- data/lib/peddler/apis/finances_v0/adjustment_event.rb +11 -18
- data/lib/peddler/apis/finances_v0/adjustment_item.rb +3 -3
- data/lib/peddler/apis/finances_v0/affordability_expense_event.rb +6 -7
- data/lib/peddler/apis/finances_v0/capacity_reservation_billing_event.rb +1 -1
- data/lib/peddler/apis/finances_v0/charge_component.rb +37 -35
- data/lib/peddler/apis/finances_v0/charge_refund_event.rb +2 -6
- data/lib/peddler/apis/finances_v0/coupon_payment_event.rb +1 -1
- data/lib/peddler/apis/finances_v0/debt_recovery_event.rb +1 -5
- data/lib/peddler/apis/finances_v0/debt_recovery_item.rb +4 -4
- data/lib/peddler/apis/finances_v0/direct_payment.rb +7 -7
- data/lib/peddler/apis/finances_v0/ebt_refund_reimbursement_only_event.rb +23 -0
- data/lib/peddler/apis/finances_v0/ebt_refund_reimbursement_only_event_list.rb +18 -0
- data/lib/peddler/apis/finances_v0/failed_adhoc_disbursement_event.rb +3 -9
- data/lib/peddler/apis/finances_v0/failed_adhoc_disbursement_event_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/fba_liquidation_event.rb +1 -1
- data/lib/peddler/apis/finances_v0/financial_event_group.rb +5 -7
- data/lib/peddler/apis/finances_v0/financial_events.rb +4 -1
- data/lib/peddler/apis/finances_v0/list_financial_event_groups_payload.rb +1 -1
- data/lib/peddler/apis/finances_v0/list_financial_event_groups_response.rb +3 -3
- data/lib/peddler/apis/finances_v0/list_financial_events_payload.rb +1 -1
- data/lib/peddler/apis/finances_v0/list_financial_events_response.rb +3 -3
- data/lib/peddler/apis/finances_v0/loan_servicing_event.rb +3 -3
- data/lib/peddler/apis/finances_v0/network_commingling_transaction_event.rb +3 -3
- data/lib/peddler/apis/finances_v0/pay_with_amazon_event.rb +5 -5
- data/lib/peddler/apis/finances_v0/product_ads_payment_event.rb +4 -4
- data/lib/peddler/apis/finances_v0/removal_shipment_adjustment_event.rb +2 -2
- data/lib/peddler/apis/finances_v0/removal_shipment_adjustment_event_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/removal_shipment_event.rb +2 -2
- data/lib/peddler/apis/finances_v0/removal_shipment_item.rb +5 -6
- data/lib/peddler/apis/finances_v0/removal_shipment_item_adjustment.rb +8 -9
- data/lib/peddler/apis/finances_v0/removal_shipment_item_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/rental_transaction_event.rb +17 -16
- data/lib/peddler/apis/finances_v0/retrocharge_event.rb +2 -2
- data/lib/peddler/apis/finances_v0/retrocharge_event_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/safet_reimbursement_event_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/safet_reimbursement_item_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/seller_deal_payment_event.rb +2 -2
- data/lib/peddler/apis/finances_v0/seller_review_enrollment_payment_event.rb +1 -1
- data/lib/peddler/apis/finances_v0/solution_provider_credit_event.rb +1 -1
- data/lib/peddler/apis/finances_v0/solution_provider_credit_event_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/tax_withheld_component.rb +2 -3
- data/lib/peddler/apis/finances_v0/tax_withholding_event.rb +1 -1
- data/lib/peddler/apis/finances_v0/tax_withholding_event_list.rb +1 -1
- data/lib/peddler/apis/finances_v0/tax_withholding_period.rb +1 -1
- data/lib/peddler/apis/finances_v0/value_added_service_charge_event.rb +1 -3
- data/lib/peddler/apis/finances_v0.rb +60 -47
- data/lib/peddler/apis/fulfillment_inbound_2024_03_20/delivery_window_option.rb +2 -1
- data/lib/peddler/apis/fulfillment_inbound_2024_03_20/selected_delivery_window.rb +2 -1
- data/lib/peddler/apis/fulfillment_inbound_2024_03_20.rb +90 -142
- data/lib/peddler/apis/fulfillment_inbound_v0.rb +6 -6
- data/lib/peddler/apis/fulfillment_outbound_2020_07_01.rb +14 -17
- data/lib/peddler/apis/invoices_2024_06_19.rb +7 -7
- data/lib/peddler/apis/listings_items_2020_09_01.rb +3 -3
- data/lib/peddler/apis/listings_items_2021_08_01.rb +5 -5
- data/lib/peddler/apis/listings_restrictions_2021_08_01.rb +1 -1
- data/lib/peddler/apis/merchant_fulfillment_v0.rb +5 -5
- data/lib/peddler/apis/messaging_v1.rb +11 -11
- data/lib/peddler/apis/notifications_v1.rb +8 -8
- data/lib/peddler/apis/orders_v0/buyer_info.rb +0 -3
- data/lib/peddler/apis/orders_v0/order_buyer_info.rb +0 -3
- data/lib/peddler/apis/orders_v0.rb +12 -15
- data/lib/peddler/apis/product_fees_v0.rb +3 -3
- data/lib/peddler/apis/product_pricing_2022_05_01.rb +2 -2
- data/lib/peddler/apis/product_pricing_v0.rb +6 -6
- data/lib/peddler/apis/product_type_definitions_2020_09_01.rb +2 -2
- data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response_metric.rb +66 -22
- data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb +13 -13
- data/lib/peddler/apis/replenishment_2022_11_07.rb +3 -3
- data/lib/peddler/apis/reports_2021_06_30.rb +9 -9
- data/lib/peddler/apis/sales_v1.rb +1 -1
- data/lib/peddler/apis/seller_wallet_2024_03_01/bank_account.rb +23 -18
- data/lib/peddler/apis/seller_wallet_2024_03_01/payee_contact_information.rb +54 -0
- data/lib/peddler/apis/seller_wallet_2024_03_01/transaction.rb +7 -3
- data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_initiation_request.rb +3 -3
- data/lib/peddler/apis/seller_wallet_2024_03_01.rb +7 -2
- data/lib/peddler/apis/sellers_v1.rb +2 -2
- data/lib/peddler/apis/services_v1.rb +17 -17
- data/lib/peddler/apis/shipment_invoicing_v0.rb +3 -3
- data/lib/peddler/apis/shipping_v1.rb +9 -9
- data/lib/peddler/apis/shipping_v2.rb +19 -19
- data/lib/peddler/apis/solicitations_v1.rb +2 -2
- data/lib/peddler/apis/tokens_2021_03_01.rb +1 -1
- data/lib/peddler/apis/transfers_2024_06_01.rb +2 -2
- data/lib/peddler/apis/uploads_2020_11_01.rb +1 -1
- data/lib/peddler/apis/vendor_direct_fulfillment_inventory_v1.rb +1 -1
- data/lib/peddler/apis/vendor_direct_fulfillment_orders_2021_12_28.rb +3 -3
- data/lib/peddler/apis/vendor_direct_fulfillment_orders_v1.rb +3 -3
- data/lib/peddler/apis/vendor_direct_fulfillment_payments_v1.rb +1 -1
- data/lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb +11 -11
- data/lib/peddler/apis/vendor_direct_fulfillment_shipping_v1.rb +9 -9
- data/lib/peddler/apis/vendor_direct_fulfillment_transactions_2021_12_28.rb +1 -1
- data/lib/peddler/apis/vendor_direct_fulfillment_transactions_v1.rb +1 -1
- data/lib/peddler/apis/vendor_invoices_v1.rb +1 -1
- data/lib/peddler/apis/vendor_orders_v1.rb +4 -4
- data/lib/peddler/apis/vendor_shipments_v1/package_item_details.rb +16 -0
- data/lib/peddler/apis/vendor_shipments_v1/regulation_references.rb +32 -0
- data/lib/peddler/apis/vendor_shipments_v1.rb +5 -5
- data/lib/peddler/apis/vendor_transaction_status_v1.rb +1 -1
- data/lib/peddler/data_kiosk/economics20240315/analytics_economics20240315.rb +5 -0
- data/lib/peddler/data_kiosk/economics20240315.json +340 -7
- data/lib/peddler/data_kiosk/vendor_analytics20240930/traffic.rb +5 -0
- data/lib/peddler/data_kiosk/vendor_analytics20240930.json +12 -0
- data/lib/peddler/response.rb +1 -1
- data/lib/peddler/version.rb +1 -1
- data/lib/peddler.rb +2 -0
- data/sig/peddler/api.rbs +13 -23
- data/sig/peddler/apis/delivery_by_amazon_2022_07_01.rbs +85 -0
- data/sig/peddler/apis/external_fulfillment_shipments_2024_09_11.rbs +8 -7
- data/sig/peddler/apis/finances_2024_06_19.rbs +1 -1
- data/sig/peddler/apis/finances_v0.rbs +30 -7
- data/sig/peddler/apis/fulfillment_inbound_2024_03_20.rbs +45 -45
- data/sig/peddler/apis/fulfillment_outbound_2020_07_01.rbs +1 -1
- data/sig/peddler/apis/orders_v0.rbs +15 -17
- data/sig/peddler/apis/replenishment_2022_11_07.rbs +18 -7
- data/sig/peddler/apis/seller_wallet_2024_03_01.rbs +49 -42
- data/sig/peddler/apis/vendor_shipments_v1.rbs +30 -41
- data/sig/peddler/data_kiosk/economics20240315.rbs +8 -7
- data/sig/peddler/data_kiosk/vendor_analytics20240930.rbs +8 -7
- data/sig/peddler.rbs +4 -0
- metadata +13 -5
- data/lib/peddler/apis/seller_wallet_2024_03_01/account_holder_address.rb +0 -36
- data/lib/peddler/apis/vendor_shipments_v1/packed_quantity.rb +0 -25
- data/lib/peddler/apis/vendor_shipments_v1/purchase_order_item_details.rb +0 -18
|
@@ -22,10 +22,8 @@ module Peddler
|
|
|
22
22
|
# @param status [String] The status of an inbound plan.
|
|
23
23
|
# @param sort_by [String] Sort by field.
|
|
24
24
|
# @param sort_order [String] The sort order.
|
|
25
|
-
# @param rate_limit [Float] Requests per second
|
|
26
25
|
# @return [Peddler::Response] The API response
|
|
27
|
-
def list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil
|
|
28
|
-
rate_limit: 2.0)
|
|
26
|
+
def list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil)
|
|
29
27
|
path = "/inbound/fba/2024-03-20/inboundPlans"
|
|
30
28
|
params = {
|
|
31
29
|
"pageSize" => page_size,
|
|
@@ -35,7 +33,7 @@ module Peddler
|
|
|
35
33
|
"sortOrder" => sort_order,
|
|
36
34
|
}.compact
|
|
37
35
|
parser = -> { ListInboundPlansResponse }
|
|
38
|
-
|
|
36
|
+
get(path, params:, parser:)
|
|
39
37
|
end
|
|
40
38
|
|
|
41
39
|
# Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's
|
|
@@ -43,24 +41,22 @@ module Peddler
|
|
|
43
41
|
#
|
|
44
42
|
# @note This operation can make a static sandbox call.
|
|
45
43
|
# @param body [Hash] The body of the request to `createInboundPlan`.
|
|
46
|
-
# @param rate_limit [Float] Requests per second
|
|
47
44
|
# @return [Peddler::Response] The API response
|
|
48
|
-
def create_inbound_plan(body
|
|
45
|
+
def create_inbound_plan(body)
|
|
49
46
|
path = "/inbound/fba/2024-03-20/inboundPlans"
|
|
50
47
|
parser = -> { CreateInboundPlanResponse }
|
|
51
|
-
|
|
48
|
+
post(path, body:, parser:)
|
|
52
49
|
end
|
|
53
50
|
|
|
54
51
|
# Fetches the top level information about an inbound plan.
|
|
55
52
|
#
|
|
56
53
|
# @note This operation can make a static sandbox call.
|
|
57
54
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
58
|
-
# @param rate_limit [Float] Requests per second
|
|
59
55
|
# @return [Peddler::Response] The API response
|
|
60
|
-
def get_inbound_plan(inbound_plan_id
|
|
56
|
+
def get_inbound_plan(inbound_plan_id)
|
|
61
57
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}"
|
|
62
58
|
parser = -> { InboundPlan }
|
|
63
|
-
|
|
59
|
+
get(path, parser:)
|
|
64
60
|
end
|
|
65
61
|
|
|
66
62
|
# Provides a paginated list of box packages in an inbound plan.
|
|
@@ -71,16 +67,15 @@ module Peddler
|
|
|
71
67
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
72
68
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
73
69
|
# token value from the query parameter the API returns the first page of the result.
|
|
74
|
-
# @param rate_limit [Float] Requests per second
|
|
75
70
|
# @return [Peddler::Response] The API response
|
|
76
|
-
def list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil
|
|
71
|
+
def list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil)
|
|
77
72
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/boxes"
|
|
78
73
|
params = {
|
|
79
74
|
"pageSize" => page_size,
|
|
80
75
|
"paginationToken" => pagination_token,
|
|
81
76
|
}.compact
|
|
82
77
|
parser = -> { ListInboundPlanBoxesResponse }
|
|
83
|
-
|
|
78
|
+
get(path, params:, parser:)
|
|
84
79
|
end
|
|
85
80
|
|
|
86
81
|
# Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
|
|
@@ -89,12 +84,11 @@ module Peddler
|
|
|
89
84
|
#
|
|
90
85
|
# @note This operation can make a static sandbox call.
|
|
91
86
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
92
|
-
# @param rate_limit [Float] Requests per second
|
|
93
87
|
# @return [Peddler::Response] The API response
|
|
94
|
-
def cancel_inbound_plan(inbound_plan_id
|
|
88
|
+
def cancel_inbound_plan(inbound_plan_id)
|
|
95
89
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/cancellation"
|
|
96
90
|
parser = -> { CancelInboundPlanResponse }
|
|
97
|
-
|
|
91
|
+
put(path, parser:)
|
|
98
92
|
end
|
|
99
93
|
|
|
100
94
|
# Provides a paginated list of item packages in an inbound plan.
|
|
@@ -105,16 +99,15 @@ module Peddler
|
|
|
105
99
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
106
100
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
107
101
|
# token value from the query parameter the API returns the first page of the result.
|
|
108
|
-
# @param rate_limit [Float] Requests per second
|
|
109
102
|
# @return [Peddler::Response] The API response
|
|
110
|
-
def list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil
|
|
103
|
+
def list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil)
|
|
111
104
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/items"
|
|
112
105
|
params = {
|
|
113
106
|
"pageSize" => page_size,
|
|
114
107
|
"paginationToken" => pagination_token,
|
|
115
108
|
}.compact
|
|
116
109
|
parser = -> { ListInboundPlanItemsResponse }
|
|
117
|
-
|
|
110
|
+
get(path, params:, parser:)
|
|
118
111
|
end
|
|
119
112
|
|
|
120
113
|
# Updates the name of an existing inbound plan.
|
|
@@ -122,11 +115,10 @@ module Peddler
|
|
|
122
115
|
# @note This operation can make a static sandbox call.
|
|
123
116
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
124
117
|
# @param body [Hash] The body of the request to `updateInboundPlanName`.
|
|
125
|
-
# @param rate_limit [Float] Requests per second
|
|
126
118
|
# @return [Peddler::Response] The API response
|
|
127
|
-
def update_inbound_plan_name(inbound_plan_id, body
|
|
119
|
+
def update_inbound_plan_name(inbound_plan_id, body)
|
|
128
120
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/name"
|
|
129
|
-
|
|
121
|
+
put(path, body:)
|
|
130
122
|
end
|
|
131
123
|
|
|
132
124
|
# Retrieves a page of boxes from a given packing group. These boxes were previously provided through the
|
|
@@ -140,17 +132,15 @@ module Peddler
|
|
|
140
132
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
141
133
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
142
134
|
# token value from the query parameter the API returns the first page of the result.
|
|
143
|
-
# @param rate_limit [Float] Requests per second
|
|
144
135
|
# @return [Peddler::Response] The API response
|
|
145
|
-
def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil
|
|
146
|
-
rate_limit: 2.0)
|
|
136
|
+
def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil)
|
|
147
137
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingGroups/#{percent_encode(packing_group_id)}/boxes"
|
|
148
138
|
params = {
|
|
149
139
|
"pageSize" => page_size,
|
|
150
140
|
"paginationToken" => pagination_token,
|
|
151
141
|
}.compact
|
|
152
142
|
parser = -> { ListPackingGroupBoxesResponse }
|
|
153
|
-
|
|
143
|
+
get(path, params:, parser:)
|
|
154
144
|
end
|
|
155
145
|
|
|
156
146
|
# Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding
|
|
@@ -163,17 +153,15 @@ module Peddler
|
|
|
163
153
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
164
154
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
165
155
|
# token value from the query parameter the API returns the first page of the result.
|
|
166
|
-
# @param rate_limit [Float] Requests per second
|
|
167
156
|
# @return [Peddler::Response] The API response
|
|
168
|
-
def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil
|
|
169
|
-
rate_limit: 2.0)
|
|
157
|
+
def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil)
|
|
170
158
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingGroups/#{percent_encode(packing_group_id)}/items"
|
|
171
159
|
params = {
|
|
172
160
|
"pageSize" => page_size,
|
|
173
161
|
"paginationToken" => pagination_token,
|
|
174
162
|
}.compact
|
|
175
163
|
parser = -> { ListPackingGroupItemsResponse }
|
|
176
|
-
|
|
164
|
+
get(path, params:, parser:)
|
|
177
165
|
end
|
|
178
166
|
|
|
179
167
|
# Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
|
|
@@ -182,12 +170,11 @@ module Peddler
|
|
|
182
170
|
# @note This operation can make a static sandbox call.
|
|
183
171
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
184
172
|
# @param body [Hash] The body of the request to `setPackingInformation`.
|
|
185
|
-
# @param rate_limit [Float] Requests per second
|
|
186
173
|
# @return [Peddler::Response] The API response
|
|
187
|
-
def set_packing_information(inbound_plan_id, body
|
|
174
|
+
def set_packing_information(inbound_plan_id, body)
|
|
188
175
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingInformation"
|
|
189
176
|
parser = -> { SetPackingInformationResponse }
|
|
190
|
-
|
|
177
|
+
post(path, body:, parser:)
|
|
191
178
|
end
|
|
192
179
|
|
|
193
180
|
# Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the
|
|
@@ -199,28 +186,26 @@ module Peddler
|
|
|
199
186
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
200
187
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
201
188
|
# token value from the query parameter the API returns the first page of the result.
|
|
202
|
-
# @param rate_limit [Float] Requests per second
|
|
203
189
|
# @return [Peddler::Response] The API response
|
|
204
|
-
def list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil
|
|
190
|
+
def list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil)
|
|
205
191
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions"
|
|
206
192
|
params = {
|
|
207
193
|
"pageSize" => page_size,
|
|
208
194
|
"paginationToken" => pagination_token,
|
|
209
195
|
}.compact
|
|
210
196
|
parser = -> { ListPackingOptionsResponse }
|
|
211
|
-
|
|
197
|
+
get(path, params:, parser:)
|
|
212
198
|
end
|
|
213
199
|
|
|
214
200
|
# Generates available packing options for the inbound plan.
|
|
215
201
|
#
|
|
216
202
|
# @note This operation can make a static sandbox call.
|
|
217
203
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
218
|
-
# @param rate_limit [Float] Requests per second
|
|
219
204
|
# @return [Peddler::Response] The API response
|
|
220
|
-
def generate_packing_options(inbound_plan_id
|
|
205
|
+
def generate_packing_options(inbound_plan_id)
|
|
221
206
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions"
|
|
222
207
|
parser = -> { GeneratePackingOptionsResponse }
|
|
223
|
-
|
|
208
|
+
post(path, parser:)
|
|
224
209
|
end
|
|
225
210
|
|
|
226
211
|
# Confirms the packing option for an inbound plan.
|
|
@@ -228,12 +213,11 @@ module Peddler
|
|
|
228
213
|
# @note This operation can make a static sandbox call.
|
|
229
214
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
230
215
|
# @param packing_option_id [String] Identifier of a packing option.
|
|
231
|
-
# @param rate_limit [Float] Requests per second
|
|
232
216
|
# @return [Peddler::Response] The API response
|
|
233
|
-
def confirm_packing_option(inbound_plan_id, packing_option_id
|
|
217
|
+
def confirm_packing_option(inbound_plan_id, packing_option_id)
|
|
234
218
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions/#{percent_encode(packing_option_id)}/confirmation"
|
|
235
219
|
parser = -> { ConfirmPackingOptionResponse }
|
|
236
|
-
|
|
220
|
+
post(path, parser:)
|
|
237
221
|
end
|
|
238
222
|
|
|
239
223
|
# Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the
|
|
@@ -245,16 +229,15 @@ module Peddler
|
|
|
245
229
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
246
230
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
247
231
|
# token value from the query parameter the API returns the first page of the result.
|
|
248
|
-
# @param rate_limit [Float] Requests per second
|
|
249
232
|
# @return [Peddler::Response] The API response
|
|
250
|
-
def list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil
|
|
233
|
+
def list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil)
|
|
251
234
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/pallets"
|
|
252
235
|
params = {
|
|
253
236
|
"pageSize" => page_size,
|
|
254
237
|
"paginationToken" => pagination_token,
|
|
255
238
|
}.compact
|
|
256
239
|
parser = -> { ListInboundPlanPalletsResponse }
|
|
257
|
-
|
|
240
|
+
get(path, params:, parser:)
|
|
258
241
|
end
|
|
259
242
|
|
|
260
243
|
# Provides a list of all placement options for an inbound plan. Placement options must first be generated by the
|
|
@@ -266,16 +249,15 @@ module Peddler
|
|
|
266
249
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
267
250
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
268
251
|
# token value from the query parameter the API returns the first page of the result.
|
|
269
|
-
# @param rate_limit [Float] Requests per second
|
|
270
252
|
# @return [Peddler::Response] The API response
|
|
271
|
-
def list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil
|
|
253
|
+
def list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil)
|
|
272
254
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions"
|
|
273
255
|
params = {
|
|
274
256
|
"pageSize" => page_size,
|
|
275
257
|
"paginationToken" => pagination_token,
|
|
276
258
|
}.compact
|
|
277
259
|
parser = -> { ListPlacementOptionsResponse }
|
|
278
|
-
|
|
260
|
+
get(path, params:, parser:)
|
|
279
261
|
end
|
|
280
262
|
|
|
281
263
|
# Generates placement options for the inbound plan.
|
|
@@ -283,12 +265,11 @@ module Peddler
|
|
|
283
265
|
# @note This operation can make a static sandbox call.
|
|
284
266
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
285
267
|
# @param body [Hash] The body of the request to `generatePlacementOptions`.
|
|
286
|
-
# @param rate_limit [Float] Requests per second
|
|
287
268
|
# @return [Peddler::Response] The API response
|
|
288
|
-
def generate_placement_options(inbound_plan_id, body
|
|
269
|
+
def generate_placement_options(inbound_plan_id, body)
|
|
289
270
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions"
|
|
290
271
|
parser = -> { GeneratePlacementOptionsResponse }
|
|
291
|
-
|
|
272
|
+
post(path, body:, parser:)
|
|
292
273
|
end
|
|
293
274
|
|
|
294
275
|
# Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
|
|
@@ -297,12 +278,11 @@ module Peddler
|
|
|
297
278
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
298
279
|
# @param placement_option_id [String] The identifier of a placement option. A placement option represents the
|
|
299
280
|
# shipment splits and destinations of SKUs.
|
|
300
|
-
# @param rate_limit [Float] Requests per second
|
|
301
281
|
# @return [Peddler::Response] The API response
|
|
302
|
-
def confirm_placement_option(inbound_plan_id, placement_option_id
|
|
282
|
+
def confirm_placement_option(inbound_plan_id, placement_option_id)
|
|
303
283
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions/#{percent_encode(placement_option_id)}/confirmation"
|
|
304
284
|
parser = -> { ConfirmPlacementOptionResponse }
|
|
305
|
-
|
|
285
|
+
post(path, parser:)
|
|
306
286
|
end
|
|
307
287
|
|
|
308
288
|
# Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside
|
|
@@ -311,12 +291,11 @@ module Peddler
|
|
|
311
291
|
# @note This operation can make a static sandbox call.
|
|
312
292
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
313
293
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
314
|
-
# @param rate_limit [Float] Requests per second
|
|
315
294
|
# @return [Peddler::Response] The API response
|
|
316
|
-
def get_shipment(inbound_plan_id, shipment_id
|
|
295
|
+
def get_shipment(inbound_plan_id, shipment_id)
|
|
317
296
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}"
|
|
318
297
|
parser = -> { Shipment }
|
|
319
|
-
|
|
298
|
+
get(path, parser:)
|
|
320
299
|
end
|
|
321
300
|
|
|
322
301
|
# Provides a paginated list of box packages in a shipment.
|
|
@@ -328,16 +307,15 @@ module Peddler
|
|
|
328
307
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
329
308
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
330
309
|
# token value from the query parameter the API returns the first page of the result.
|
|
331
|
-
# @param rate_limit [Float] Requests per second
|
|
332
310
|
# @return [Peddler::Response] The API response
|
|
333
|
-
def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil
|
|
311
|
+
def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
|
|
334
312
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/boxes"
|
|
335
313
|
params = {
|
|
336
314
|
"pageSize" => page_size,
|
|
337
315
|
"paginationToken" => pagination_token,
|
|
338
316
|
}.compact
|
|
339
317
|
parser = -> { ListShipmentBoxesResponse }
|
|
340
|
-
|
|
318
|
+
get(path, params:, parser:)
|
|
341
319
|
end
|
|
342
320
|
|
|
343
321
|
# Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update
|
|
@@ -351,17 +329,15 @@ module Peddler
|
|
|
351
329
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
352
330
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
353
331
|
# token value from the query parameter the API returns the first page of the result.
|
|
354
|
-
# @param rate_limit [Float] Requests per second
|
|
355
332
|
# @return [Peddler::Response] The API response
|
|
356
|
-
def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil
|
|
357
|
-
rate_limit: 2.0)
|
|
333
|
+
def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
|
|
358
334
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews"
|
|
359
335
|
params = {
|
|
360
336
|
"pageSize" => page_size,
|
|
361
337
|
"paginationToken" => pagination_token,
|
|
362
338
|
}.compact
|
|
363
339
|
parser = -> { ListShipmentContentUpdatePreviewsResponse }
|
|
364
|
-
|
|
340
|
+
get(path, params:, parser:)
|
|
365
341
|
end
|
|
366
342
|
|
|
367
343
|
# Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a
|
|
@@ -372,12 +348,11 @@ module Peddler
|
|
|
372
348
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
373
349
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
374
350
|
# @param body [Hash] The body of the request to `generateShipmentContentUpdatePreviews`.
|
|
375
|
-
# @param rate_limit [Float] Requests per second
|
|
376
351
|
# @return [Peddler::Response] The API response
|
|
377
|
-
def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body
|
|
352
|
+
def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body)
|
|
378
353
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews"
|
|
379
354
|
parser = -> { GenerateShipmentContentUpdatePreviewsResponse }
|
|
380
|
-
|
|
355
|
+
post(path, body:, parser:)
|
|
381
356
|
end
|
|
382
357
|
|
|
383
358
|
# Retrieve a shipment content update preview which provides a summary of the requested shipment content changes
|
|
@@ -388,12 +363,11 @@ module Peddler
|
|
|
388
363
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
389
364
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
390
365
|
# @param content_update_preview_id [String] Identifier of a content update preview.
|
|
391
|
-
# @param rate_limit [Float] Requests per second
|
|
392
366
|
# @return [Peddler::Response] The API response
|
|
393
|
-
def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id
|
|
367
|
+
def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id)
|
|
394
368
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews/#{percent_encode(content_update_preview_id)}"
|
|
395
369
|
parser = -> { ContentUpdatePreview }
|
|
396
|
-
|
|
370
|
+
get(path, parser:)
|
|
397
371
|
end
|
|
398
372
|
|
|
399
373
|
# Confirm a shipment content update preview and accept the changes in transportation cost.
|
|
@@ -402,13 +376,11 @@ module Peddler
|
|
|
402
376
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
403
377
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
404
378
|
# @param content_update_preview_id [String] Identifier of a content update preview.
|
|
405
|
-
# @param rate_limit [Float] Requests per second
|
|
406
379
|
# @return [Peddler::Response] The API response
|
|
407
|
-
def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id
|
|
408
|
-
rate_limit: 2.0)
|
|
380
|
+
def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id)
|
|
409
381
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews/#{percent_encode(content_update_preview_id)}/confirmation"
|
|
410
382
|
parser = -> { ConfirmShipmentContentUpdatePreviewResponse }
|
|
411
|
-
|
|
383
|
+
post(path, parser:)
|
|
412
384
|
end
|
|
413
385
|
|
|
414
386
|
# Provide delivery challan document for PCP transportation in IN marketplace.
|
|
@@ -416,12 +388,11 @@ module Peddler
|
|
|
416
388
|
# @note This operation can make a static sandbox call.
|
|
417
389
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
418
390
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
419
|
-
# @param rate_limit [Float] Requests per second
|
|
420
391
|
# @return [Peddler::Response] The API response
|
|
421
|
-
def get_delivery_challan_document(inbound_plan_id, shipment_id
|
|
392
|
+
def get_delivery_challan_document(inbound_plan_id, shipment_id)
|
|
422
393
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryChallanDocument"
|
|
423
394
|
parser = -> { GetDeliveryChallanDocumentResponse }
|
|
424
|
-
|
|
395
|
+
get(path, parser:)
|
|
425
396
|
end
|
|
426
397
|
|
|
427
398
|
# Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the
|
|
@@ -435,17 +406,15 @@ module Peddler
|
|
|
435
406
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
436
407
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
437
408
|
# token value from the query parameter the API returns the first page of the result.
|
|
438
|
-
# @param rate_limit [Float] Requests per second
|
|
439
409
|
# @return [Peddler::Response] The API response
|
|
440
|
-
def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil
|
|
441
|
-
rate_limit: 2.0)
|
|
410
|
+
def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
|
|
442
411
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions"
|
|
443
412
|
params = {
|
|
444
413
|
"pageSize" => page_size,
|
|
445
414
|
"paginationToken" => pagination_token,
|
|
446
415
|
}.compact
|
|
447
416
|
parser = -> { ListDeliveryWindowOptionsResponse }
|
|
448
|
-
|
|
417
|
+
get(path, params:, parser:)
|
|
449
418
|
end
|
|
450
419
|
|
|
451
420
|
# Generates available delivery window options for a given shipment.
|
|
@@ -453,12 +422,11 @@ module Peddler
|
|
|
453
422
|
# @note This operation can make a static sandbox call.
|
|
454
423
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
455
424
|
# @param shipment_id [String] The shipment to generate delivery window options for.
|
|
456
|
-
# @param rate_limit [Float] Requests per second
|
|
457
425
|
# @return [Peddler::Response] The API response
|
|
458
|
-
def generate_delivery_window_options(inbound_plan_id, shipment_id
|
|
426
|
+
def generate_delivery_window_options(inbound_plan_id, shipment_id)
|
|
459
427
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions"
|
|
460
428
|
parser = -> { GenerateDeliveryWindowOptionsResponse }
|
|
461
|
-
|
|
429
|
+
post(path, parser:)
|
|
462
430
|
end
|
|
463
431
|
|
|
464
432
|
# Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be
|
|
@@ -472,12 +440,11 @@ module Peddler
|
|
|
472
440
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
473
441
|
# @param shipment_id [String] The shipment to confirm the delivery window option for.
|
|
474
442
|
# @param delivery_window_option_id [String] The id of the delivery window option to be confirmed.
|
|
475
|
-
# @param rate_limit [Float] Requests per second
|
|
476
443
|
# @return [Peddler::Response] The API response
|
|
477
|
-
def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id
|
|
444
|
+
def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id)
|
|
478
445
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions/#{percent_encode(delivery_window_option_id)}/confirmation"
|
|
479
446
|
parser = -> { ConfirmDeliveryWindowOptionsResponse }
|
|
480
|
-
|
|
447
|
+
post(path, parser:)
|
|
481
448
|
end
|
|
482
449
|
|
|
483
450
|
# Provides a paginated list of item packages in a shipment.
|
|
@@ -489,16 +456,15 @@ module Peddler
|
|
|
489
456
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
490
457
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
491
458
|
# token value from the query parameter the API returns the first page of the result.
|
|
492
|
-
# @param rate_limit [Float] Requests per second
|
|
493
459
|
# @return [Peddler::Response] The API response
|
|
494
|
-
def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil
|
|
460
|
+
def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
|
|
495
461
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/items"
|
|
496
462
|
params = {
|
|
497
463
|
"pageSize" => page_size,
|
|
498
464
|
"paginationToken" => pagination_token,
|
|
499
465
|
}.compact
|
|
500
466
|
parser = -> { ListShipmentItemsResponse }
|
|
501
|
-
|
|
467
|
+
get(path, params:, parser:)
|
|
502
468
|
end
|
|
503
469
|
|
|
504
470
|
# Updates the name of an existing shipment.
|
|
@@ -507,11 +473,10 @@ module Peddler
|
|
|
507
473
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
508
474
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
509
475
|
# @param body [Hash] The body of the request to `updateShipmentName`.
|
|
510
|
-
# @param rate_limit [Float] Requests per second
|
|
511
476
|
# @return [Peddler::Response] The API response
|
|
512
|
-
def update_shipment_name(inbound_plan_id, shipment_id, body
|
|
477
|
+
def update_shipment_name(inbound_plan_id, shipment_id, body)
|
|
513
478
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/name"
|
|
514
|
-
|
|
479
|
+
put(path, body:)
|
|
515
480
|
end
|
|
516
481
|
|
|
517
482
|
# Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the
|
|
@@ -524,16 +489,15 @@ module Peddler
|
|
|
524
489
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
525
490
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
526
491
|
# token value from the query parameter the API returns the first page of the result.
|
|
527
|
-
# @param rate_limit [Float] Requests per second
|
|
528
492
|
# @return [Peddler::Response] The API response
|
|
529
|
-
def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil
|
|
493
|
+
def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
|
|
530
494
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/pallets"
|
|
531
495
|
params = {
|
|
532
496
|
"pageSize" => page_size,
|
|
533
497
|
"paginationToken" => pagination_token,
|
|
534
498
|
}.compact
|
|
535
499
|
parser = -> { ListShipmentPalletsResponse }
|
|
536
|
-
|
|
500
|
+
get(path, params:, parser:)
|
|
537
501
|
end
|
|
538
502
|
|
|
539
503
|
# Cancels a self-ship appointment slot against a shipment. Only available in the following
|
|
@@ -543,12 +507,11 @@ module Peddler
|
|
|
543
507
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
544
508
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
545
509
|
# @param body [Hash] The body of the request to `cancelSelfShipAppointment`.
|
|
546
|
-
# @param rate_limit [Float] Requests per second
|
|
547
510
|
# @return [Peddler::Response] The API response
|
|
548
|
-
def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body
|
|
511
|
+
def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body)
|
|
549
512
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentCancellation"
|
|
550
513
|
parser = -> { CancelSelfShipAppointmentResponse }
|
|
551
|
-
|
|
514
|
+
put(path, body:, parser:)
|
|
552
515
|
end
|
|
553
516
|
|
|
554
517
|
# Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only
|
|
@@ -563,17 +526,15 @@ module Peddler
|
|
|
563
526
|
# @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results.
|
|
564
527
|
# The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
|
|
565
528
|
# token value from the query parameter the API returns the first page of the result.
|
|
566
|
-
# @param rate_limit [Float] Requests per second
|
|
567
529
|
# @return [Peddler::Response] The API response
|
|
568
|
-
def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil
|
|
569
|
-
rate_limit: nil)
|
|
530
|
+
def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
|
|
570
531
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots"
|
|
571
532
|
params = {
|
|
572
533
|
"pageSize" => page_size,
|
|
573
534
|
"paginationToken" => pagination_token,
|
|
574
535
|
}.compact
|
|
575
536
|
parser = -> { GetSelfShipAppointmentSlotsResponse }
|
|
576
|
-
|
|
537
|
+
get(path, params:, parser:)
|
|
577
538
|
end
|
|
578
539
|
|
|
579
540
|
# Initiates the process of generating the appointment slots list. Only available in the following
|
|
@@ -583,12 +544,11 @@ module Peddler
|
|
|
583
544
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
584
545
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
585
546
|
# @param body [Hash] The body of the request to `generateSelfShipAppointmentSlots`.
|
|
586
|
-
# @param rate_limit [Float] Requests per second
|
|
587
547
|
# @return [Peddler::Response] The API response
|
|
588
|
-
def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body
|
|
548
|
+
def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body)
|
|
589
549
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots"
|
|
590
550
|
parser = -> { GenerateSelfShipAppointmentSlotsResponse }
|
|
591
|
-
|
|
551
|
+
post(path, body:, parser:)
|
|
592
552
|
end
|
|
593
553
|
|
|
594
554
|
# Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following
|
|
@@ -599,12 +559,11 @@ module Peddler
|
|
|
599
559
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
600
560
|
# @param slot_id [String] An identifier to a self-ship appointment slot.
|
|
601
561
|
# @param body [Hash] The body of the request to `scheduleSelfShipAppointment`.
|
|
602
|
-
# @param rate_limit [Float] Requests per second
|
|
603
562
|
# @return [Peddler::Response] The API response
|
|
604
|
-
def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body
|
|
563
|
+
def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body)
|
|
605
564
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots/#{percent_encode(slot_id)}/schedule"
|
|
606
565
|
parser = -> { ScheduleSelfShipAppointmentResponse }
|
|
607
|
-
|
|
566
|
+
post(path, body:, parser:)
|
|
608
567
|
end
|
|
609
568
|
|
|
610
569
|
# Updates the source address of an existing shipment. The shipment source address can only be updated prior to the
|
|
@@ -616,12 +575,11 @@ module Peddler
|
|
|
616
575
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
617
576
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
618
577
|
# @param body [Hash] The body of the request to `updateShipmentSourceAddress`.
|
|
619
|
-
# @param rate_limit [Float] Requests per second
|
|
620
578
|
# @return [Peddler::Response] The API response
|
|
621
|
-
def update_shipment_source_address(inbound_plan_id, shipment_id, body
|
|
579
|
+
def update_shipment_source_address(inbound_plan_id, shipment_id, body)
|
|
622
580
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/sourceAddress"
|
|
623
581
|
parser = -> { UpdateShipmentSourceAddressResponse }
|
|
624
|
-
|
|
582
|
+
put(path, body:, parser:)
|
|
625
583
|
end
|
|
626
584
|
|
|
627
585
|
# Updates a shipment's tracking details.
|
|
@@ -630,12 +588,11 @@ module Peddler
|
|
|
630
588
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
631
589
|
# @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
632
590
|
# @param body [Hash] The body of the request to `updateShipmentTrackingDetails`.
|
|
633
|
-
# @param rate_limit [Float] Requests per second
|
|
634
591
|
# @return [Peddler::Response] The API response
|
|
635
|
-
def update_shipment_tracking_details(inbound_plan_id, shipment_id, body
|
|
592
|
+
def update_shipment_tracking_details(inbound_plan_id, shipment_id, body)
|
|
636
593
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/trackingDetails"
|
|
637
594
|
parser = -> { UpdateShipmentTrackingDetailsResponse }
|
|
638
|
-
|
|
595
|
+
put(path, body:, parser:)
|
|
639
596
|
end
|
|
640
597
|
|
|
641
598
|
# Retrieves all transportation options for a shipment. Transportation options must first be generated by the
|
|
@@ -652,10 +609,9 @@ module Peddler
|
|
|
652
609
|
# `placementOptionId` or `shipmentId` must be specified.
|
|
653
610
|
# @param shipment_id [String] The shipment to get transportation options for. Either `placementOptionId` or
|
|
654
611
|
# `shipmentId` must be specified.
|
|
655
|
-
# @param rate_limit [Float] Requests per second
|
|
656
612
|
# @return [Peddler::Response] The API response
|
|
657
613
|
def list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil,
|
|
658
|
-
shipment_id: nil
|
|
614
|
+
shipment_id: nil)
|
|
659
615
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions"
|
|
660
616
|
params = {
|
|
661
617
|
"pageSize" => page_size,
|
|
@@ -664,7 +620,7 @@ module Peddler
|
|
|
664
620
|
"shipmentId" => shipment_id,
|
|
665
621
|
}.compact
|
|
666
622
|
parser = -> { ListTransportationOptionsResponse }
|
|
667
|
-
|
|
623
|
+
get(path, params:, parser:)
|
|
668
624
|
end
|
|
669
625
|
|
|
670
626
|
# Generates available transportation options for a given placement option.
|
|
@@ -672,12 +628,11 @@ module Peddler
|
|
|
672
628
|
# @note This operation can make a static sandbox call.
|
|
673
629
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
674
630
|
# @param body [Hash] The body of the request to `generateTransportationOptions`.
|
|
675
|
-
# @param rate_limit [Float] Requests per second
|
|
676
631
|
# @return [Peddler::Response] The API response
|
|
677
|
-
def generate_transportation_options(inbound_plan_id, body
|
|
632
|
+
def generate_transportation_options(inbound_plan_id, body)
|
|
678
633
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions"
|
|
679
634
|
parser = -> { GenerateTransportationOptionsResponse }
|
|
680
|
-
|
|
635
|
+
post(path, body:, parser:)
|
|
681
636
|
end
|
|
682
637
|
|
|
683
638
|
# Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use
|
|
@@ -686,12 +641,11 @@ module Peddler
|
|
|
686
641
|
# @note This operation can make a static sandbox call.
|
|
687
642
|
# @param inbound_plan_id [String] Identifier of an inbound plan.
|
|
688
643
|
# @param body [Hash] The body of the request to `confirmTransportationOptions`.
|
|
689
|
-
# @param rate_limit [Float] Requests per second
|
|
690
644
|
# @return [Peddler::Response] The API response
|
|
691
|
-
def confirm_transportation_options(inbound_plan_id, body
|
|
645
|
+
def confirm_transportation_options(inbound_plan_id, body)
|
|
692
646
|
path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions/confirmation"
|
|
693
647
|
parser = -> { ConfirmTransportationOptionsResponse }
|
|
694
|
-
|
|
648
|
+
post(path, body:, parser:)
|
|
695
649
|
end
|
|
696
650
|
|
|
697
651
|
# List the inbound compliance details for MSKUs in a given marketplace.
|
|
@@ -710,16 +664,15 @@ module Peddler
|
|
|
710
664
|
# @param mskus [Array<String>] A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
711
665
|
# @param marketplace_id [String] The Marketplace ID. For a list of possible values, refer to [Marketplace
|
|
712
666
|
# IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
713
|
-
# @param rate_limit [Float] Requests per second
|
|
714
667
|
# @return [Peddler::Response] The API response
|
|
715
|
-
def list_item_compliance_details(mskus, marketplace_id
|
|
668
|
+
def list_item_compliance_details(mskus, marketplace_id)
|
|
716
669
|
path = "/inbound/fba/2024-03-20/items/compliance"
|
|
717
670
|
params = {
|
|
718
671
|
"mskus" => stringify_array(mskus),
|
|
719
672
|
"marketplaceId" => marketplace_id,
|
|
720
673
|
}.compact
|
|
721
674
|
parser = -> { ListItemComplianceDetailsResponse }
|
|
722
|
-
|
|
675
|
+
get(path, params:, parser:)
|
|
723
676
|
end
|
|
724
677
|
|
|
725
678
|
# Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN -
|
|
@@ -729,27 +682,25 @@ module Peddler
|
|
|
729
682
|
# @param marketplace_id [String] The Marketplace ID. For a list of possible values, refer to [Marketplace
|
|
730
683
|
# IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
731
684
|
# @param body [Hash] The body of the request to `updateItemComplianceDetails`.
|
|
732
|
-
# @param rate_limit [Float] Requests per second
|
|
733
685
|
# @return [Peddler::Response] The API response
|
|
734
|
-
def update_item_compliance_details(marketplace_id, body
|
|
686
|
+
def update_item_compliance_details(marketplace_id, body)
|
|
735
687
|
path = "/inbound/fba/2024-03-20/items/compliance"
|
|
736
688
|
params = {
|
|
737
689
|
"marketplaceId" => marketplace_id,
|
|
738
690
|
}.compact
|
|
739
691
|
parser = -> { UpdateItemComplianceDetailsResponse }
|
|
740
|
-
|
|
692
|
+
put(path, body:, params:, parser:)
|
|
741
693
|
end
|
|
742
694
|
|
|
743
695
|
# For a given marketplace - creates labels for a list of MSKUs.
|
|
744
696
|
#
|
|
745
697
|
# @note This operation can make a static sandbox call.
|
|
746
698
|
# @param body [Hash] The body of the request to `createMarketplaceItemLabels`.
|
|
747
|
-
# @param rate_limit [Float] Requests per second
|
|
748
699
|
# @return [Peddler::Response] The API response
|
|
749
|
-
def create_marketplace_item_labels(body
|
|
700
|
+
def create_marketplace_item_labels(body)
|
|
750
701
|
path = "/inbound/fba/2024-03-20/items/labels"
|
|
751
702
|
parser = -> { CreateMarketplaceItemLabelsResponse }
|
|
752
|
-
|
|
703
|
+
post(path, body:, parser:)
|
|
753
704
|
end
|
|
754
705
|
|
|
755
706
|
# Get preparation details for a list of MSKUs in a specified marketplace.
|
|
@@ -768,40 +719,37 @@ module Peddler
|
|
|
768
719
|
# @param marketplace_id [String] The marketplace ID. For a list of possible values, refer to [Marketplace
|
|
769
720
|
# IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
770
721
|
# @param mskus [Array<String>] A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
771
|
-
# @param rate_limit [Float] Requests per second
|
|
772
722
|
# @return [Peddler::Response] The API response
|
|
773
|
-
def list_prep_details(marketplace_id, mskus
|
|
723
|
+
def list_prep_details(marketplace_id, mskus)
|
|
774
724
|
path = "/inbound/fba/2024-03-20/items/prepDetails"
|
|
775
725
|
params = {
|
|
776
726
|
"marketplaceId" => marketplace_id,
|
|
777
727
|
"mskus" => stringify_array(mskus),
|
|
778
728
|
}.compact
|
|
779
729
|
parser = -> { ListPrepDetailsResponse }
|
|
780
|
-
|
|
730
|
+
get(path, params:, parser:)
|
|
781
731
|
end
|
|
782
732
|
|
|
783
733
|
# Set the preparation details for a list of MSKUs in a specified marketplace.
|
|
784
734
|
#
|
|
785
735
|
# @note This operation can make a static sandbox call.
|
|
786
736
|
# @param body [Hash] The body of the request to `setPrepDetails`.
|
|
787
|
-
# @param rate_limit [Float] Requests per second
|
|
788
737
|
# @return [Peddler::Response] The API response
|
|
789
|
-
def set_prep_details(body
|
|
738
|
+
def set_prep_details(body)
|
|
790
739
|
path = "/inbound/fba/2024-03-20/items/prepDetails"
|
|
791
740
|
parser = -> { SetPrepDetailsResponse }
|
|
792
|
-
|
|
741
|
+
post(path, body:, parser:)
|
|
793
742
|
end
|
|
794
743
|
|
|
795
744
|
# Gets the status of the processing of an asynchronous API call.
|
|
796
745
|
#
|
|
797
746
|
# @note This operation can make a static sandbox call.
|
|
798
747
|
# @param operation_id [String] Identifier of an asynchronous operation.
|
|
799
|
-
# @param rate_limit [Float] Requests per second
|
|
800
748
|
# @return [Peddler::Response] The API response
|
|
801
|
-
def get_inbound_operation_status(operation_id
|
|
749
|
+
def get_inbound_operation_status(operation_id)
|
|
802
750
|
path = "/inbound/fba/2024-03-20/operations/#{percent_encode(operation_id)}"
|
|
803
751
|
parser = -> { InboundOperationStatus }
|
|
804
|
-
|
|
752
|
+
get(path, parser:)
|
|
805
753
|
end
|
|
806
754
|
end
|
|
807
755
|
end
|